- 
-
{{ site.description | default: site.github.project_tagline }}
- -
- - - {% if site.show_downloads %} - - {% endif %} - - -Star -
This project is maintained by {{ site.github.owner_name }}
- {% endif %} -
+
1. You can switch between different versions of terraform by typing the command `tfswitch` on your terminal.
2. Select the version of terraform you require by using the up and down arrow.
@@ -51,22 +57,22 @@ Alternatively, you can install the binary from source [here](https://github.com/
The most recently selected versions are presented at the top of the dropdown.
### Supply version on command line
-
+
1. You can also supply the desired version as an argument on the command line.
2. For example, `tfswitch 0.10.5` for version 0.10.5 of terraform.
3. Hit **Enter** to switch.
### See all versions including beta, alpha and release candidates(rc)
-
+
1. Display all versions including beta, alpha and release candidates(rc).
2. For example, `tfswitch -l` or `tfswitch --list-all` to see all versions.
3. Hit **Enter** to select the desired version.
### Use version.tf file
-If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to version `0.12.24`:
-```
+If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to the lastest version:
+```ruby
terraform {
required_version = ">= 0.12.9"
@@ -76,28 +82,29 @@ terraform {
}
}
```
-
+
### Use .tfswitch.toml file (For non-admin - users with limited privilege on their computers)
This is similiar to using a .tfswitchrc file, but you can specify a custom binary path for your terraform installation
-
-
+
+
+
1. Create a custom binary path. Ex: `mkdir /Users/warrenveerasingam/bin` (replace warrenveerasingam with your username)
2. Add the path to your PATH. Ex: `export PATH=$PATH:/Users/warrenveerasingam/bin` (add this to your bash profile or zsh profile)
3. Pass -b or --bin parameter with your custom path to install terraform. Ex: `tfswitch -b /Users/warrenveerasingam/bin/terraform 0.10.8 `
-4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory.
+4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory(current directory) OR in your home directory(~/.tfswitch.toml). The toml file in the current directory has a higher precedence than toml file in the home directory
5. Your `.tfswitch.toml` file should look like this:
-```
+```ruby
bin = "/Users/warrenveerasingam/bin/terraform"
version = "0.11.3"
```
4. Run `tfswitch` and it should automatically install the required terraform version in the specified binary path
### Use .tfswitchrc file
-
+
1. Create a `.tfswitchrc` file containing the desired version
2. For example, `echo "0.10.5" >> .tfswitchrc` for version 0.10.5 of terraform
@@ -110,7 +117,7 @@ version = "0.11.3"
Add the following to the end of your `~/.bashrc` file:
(Use either `.tfswitchrc` or `.tfswitch.toml` or `.terraform-version`)
-```
+```sh
cdtfswitch(){
builtin cd "$@";
cdir=$PWD;
@@ -125,7 +132,7 @@ alias cd='cdtfswitch'
Add the following to the end of your `~/.zshrc` file:
-```
+```sh
load-tfswitch() {
local tfswitchrc_path=".tfswitchrc"
@@ -142,7 +149,7 @@ load-tfswitch
> ```
*older version of zsh*
-```
+```sh
cd(){
builtin cd "$@";
cdir=$PWD;
@@ -152,23 +159,101 @@ cd(){
}
```
+**Automatically switch with fish shell**
+
+Add the following to the end of your `~/.config/fish/config.fish` file:
+
+```sh
+function switch_terraform --on-event fish_postexec
+ string match --regex '^cd\s' "$argv" > /dev/null
+ set --local is_command_cd $status
+
+ if test $is_command_cd -eq 0
+ if count *.tf > /dev/null
+
+ grep -c "required_version" *.tf > /dev/null
+ set --local tf_contains_version $status
+
+ if test $tf_contains_version -eq 0
+ command tfswitch
+ end
+ end
+ end
+end
+```
+
### Jenkins setup
-```
+```sh
#!/bin/bash
echo "Installing tfswitch locally"
-wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh
-chmod 755 install.sh
-./install.sh -b bin-directory
+wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
+
+chmod 755 install.sh #Make installer executable
+
+./install.sh -b `pwd`/.bin #Install tfswitch in a location you have permission
+
+CUSTOMBIN=`pwd`/.bin #set custom bin path
+
+export PATH=$PATH:$CUSTOMBIN #Add custom bin path to PATH environment
+
+$CUSTOMBIN/tfswitch -b $CUSTOMBIN/terraform 0.11.7 #or simply tfswitch -b $CUSTOMBIN/terraform 0.11.7
-./bin-directory/tfswitch
+terraform -v #testing version
```
+### Circle CI setup
+
+
+
+
+Example config yaml
+```yaml
+version: 2
+jobs:
+ build:
+ docker:
+ - image: ubuntu
+
+ working_directory: /go/src/github.com/warrensbox/terraform-switcher
+
+ steps:
+ - checkout
+ - run:
+ command: |
+ set +e
+ apt-get update
+ apt-get install -y wget
+ rm -rf /var/lib/apt/lists/*
+
+ echo "Installing tfswitch locally"
+
+ wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
+
+ chmod 755 install.sh #Make installer executable
+
+ ./install.sh -b `pwd`/.bin #Install tfswitch in a location you have permission
+
+ CUSTOMBIN=`pwd`/.bin #set custom bin path
+
+ export PATH=$PATH:$CUSTOMBIN #Add custom bin path to PATH environment
+
+ $CUSTOMBIN/tfswitch -b $CUSTOMBIN/terraform 0.11.7 #or simply tfswitch -b $CUSTOMBIN/terraform 0.11.7
+
+ terraform -v #testing version
+```
+
+## How to contribute
+An open source project becomes meaningful when people collaborate to improve the code.
+Feel free to look at the code, critique and make suggestions. Lets make `tfswitch` better!
+
+See step-by-step instructions on how to contribute here: [Contribute](https://tfswitch.warrensbox.com/How-to-Contribute/)
+
## Additional Info
-See how to *upgrade*, *uninstall*, *troubleshoot* here: [More info](https://warrensbox.github.io/terraform-switcher/additional)
+See how to *upgrade*, *uninstall*, *troubleshoot* here: [More info](https://tfswitch.warrensbox.com/Upgrade-or-Uninstall/)
## Issues
diff --git a/docs/Gemfile b/docs/Gemfile
deleted file mode 100644
index 8215629a..00000000
--- a/docs/Gemfile
+++ /dev/null
@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-gem 'github-pages', group: :jekyll_plugins
-gem "minima"
-
-gem "commonmarker"
-
-gem "ffi", ">= 1.9.24"
-gem "rubyzip", ">= 1.2.2"
-gem "jekyll", ">= 3.7.4"
-gem "nokogiri", ">= 1.8.5"
\ No newline at end of file
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
deleted file mode 100644
index c604714a..00000000
--- a/docs/Gemfile.lock
+++ /dev/null
@@ -1,254 +0,0 @@
-GEM
- remote: https://rubygems.org/
- specs:
- activesupport (4.2.10)
- i18n (~> 0.7)
- minitest (~> 5.1)
- thread_safe (~> 0.3, >= 0.3.4)
- tzinfo (~> 1.1)
- addressable (2.5.2)
- public_suffix (>= 2.0.2, < 4.0)
- coffee-script (2.4.1)
- coffee-script-source
- execjs
- coffee-script-source (1.11.1)
- colorator (1.1.0)
- commonmarker (0.17.13)
- ruby-enum (~> 0.5)
- concurrent-ruby (1.1.4)
- dnsruby (1.61.2)
- addressable (~> 2.5)
- em-websocket (0.5.1)
- eventmachine (>= 0.12.9)
- http_parser.rb (~> 0.6.0)
- ethon (0.12.0)
- ffi (>= 1.3.0)
- eventmachine (1.2.7)
- execjs (2.7.0)
- faraday (0.15.4)
- multipart-post (>= 1.2, < 3)
- ffi (1.10.0)
- forwardable-extended (2.6.0)
- gemoji (3.0.0)
- github-pages (193)
- activesupport (= 4.2.10)
- github-pages-health-check (= 1.8.1)
- jekyll (= 3.7.4)
- jekyll-avatar (= 0.6.0)
- jekyll-coffeescript (= 1.1.1)
- jekyll-commonmark-ghpages (= 0.1.5)
- jekyll-default-layout (= 0.1.4)
- jekyll-feed (= 0.11.0)
- jekyll-gist (= 1.5.0)
- jekyll-github-metadata (= 2.9.4)
- jekyll-mentions (= 1.4.1)
- jekyll-optional-front-matter (= 0.3.0)
- jekyll-paginate (= 1.1.0)
- jekyll-readme-index (= 0.2.0)
- jekyll-redirect-from (= 0.14.0)
- jekyll-relative-links (= 0.5.3)
- jekyll-remote-theme (= 0.3.1)
- jekyll-sass-converter (= 1.5.2)
- jekyll-seo-tag (= 2.5.0)
- jekyll-sitemap (= 1.2.0)
- jekyll-swiss (= 0.4.0)
- jekyll-theme-architect (= 0.1.1)
- jekyll-theme-cayman (= 0.1.1)
- jekyll-theme-dinky (= 0.1.1)
- jekyll-theme-hacker (= 0.1.1)
- jekyll-theme-leap-day (= 0.1.1)
- jekyll-theme-merlot (= 0.1.1)
- jekyll-theme-midnight (= 0.1.1)
- jekyll-theme-minimal (= 0.1.1)
- jekyll-theme-modernist (= 0.1.1)
- jekyll-theme-primer (= 0.5.3)
- jekyll-theme-slate (= 0.1.1)
- jekyll-theme-tactile (= 0.1.1)
- jekyll-theme-time-machine (= 0.1.1)
- jekyll-titles-from-headings (= 0.5.1)
- jemoji (= 0.10.1)
- kramdown (= 1.17.0)
- liquid (= 4.0.0)
- listen (= 3.1.5)
- mercenary (~> 0.3)
- minima (= 2.5.0)
- nokogiri (>= 1.8.2, < 2.0)
- rouge (= 2.2.1)
- terminal-table (~> 1.4)
- github-pages-health-check (1.8.1)
- addressable (~> 2.3)
- dnsruby (~> 1.60)
- octokit (~> 4.0)
- public_suffix (~> 2.0)
- typhoeus (~> 1.3)
- html-pipeline (2.10.0)
- activesupport (>= 2)
- nokogiri (>= 1.4)
- http_parser.rb (0.6.0)
- i18n (0.9.5)
- concurrent-ruby (~> 1.0)
- jekyll (3.7.4)
- addressable (~> 2.4)
- colorator (~> 1.0)
- em-websocket (~> 0.5)
- i18n (~> 0.7)
- jekyll-sass-converter (~> 1.0)
- jekyll-watch (~> 2.0)
- kramdown (~> 1.14)
- liquid (~> 4.0)
- mercenary (~> 0.3.3)
- pathutil (~> 0.9)
- rouge (>= 1.7, < 4)
- safe_yaml (~> 1.0)
- jekyll-avatar (0.6.0)
- jekyll (~> 3.0)
- jekyll-coffeescript (1.1.1)
- coffee-script (~> 2.2)
- coffee-script-source (~> 1.11.1)
- jekyll-commonmark (1.2.0)
- commonmarker (~> 0.14)
- jekyll (>= 3.0, < 4.0)
- jekyll-commonmark-ghpages (0.1.5)
- commonmarker (~> 0.17.6)
- jekyll-commonmark (~> 1)
- rouge (~> 2)
- jekyll-default-layout (0.1.4)
- jekyll (~> 3.0)
- jekyll-feed (0.11.0)
- jekyll (~> 3.3)
- jekyll-gist (1.5.0)
- octokit (~> 4.2)
- jekyll-github-metadata (2.9.4)
- jekyll (~> 3.1)
- octokit (~> 4.0, != 4.4.0)
- jekyll-mentions (1.4.1)
- html-pipeline (~> 2.3)
- jekyll (~> 3.0)
- jekyll-optional-front-matter (0.3.0)
- jekyll (~> 3.0)
- jekyll-paginate (1.1.0)
- jekyll-readme-index (0.2.0)
- jekyll (~> 3.0)
- jekyll-redirect-from (0.14.0)
- jekyll (~> 3.3)
- jekyll-relative-links (0.5.3)
- jekyll (~> 3.3)
- jekyll-remote-theme (0.3.1)
- jekyll (~> 3.5)
- rubyzip (>= 1.2.1, < 3.0)
- jekyll-sass-converter (1.5.2)
- sass (~> 3.4)
- jekyll-seo-tag (2.5.0)
- jekyll (~> 3.3)
- jekyll-sitemap (1.2.0)
- jekyll (~> 3.3)
- jekyll-swiss (0.4.0)
- jekyll-theme-architect (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-cayman (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-dinky (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-hacker (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-leap-day (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-merlot (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-midnight (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-minimal (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-modernist (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-primer (0.5.3)
- jekyll (~> 3.5)
- jekyll-github-metadata (~> 2.9)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-slate (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-tactile (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-time-machine (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-titles-from-headings (0.5.1)
- jekyll (~> 3.3)
- jekyll-watch (2.1.2)
- listen (~> 3.0)
- jemoji (0.10.1)
- gemoji (~> 3.0)
- html-pipeline (~> 2.2)
- jekyll (~> 3.0)
- kramdown (1.17.0)
- liquid (4.0.0)
- listen (3.1.5)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- ruby_dep (~> 1.2)
- mercenary (0.3.6)
- mini_portile2 (2.4.0)
- minima (2.5.0)
- jekyll (~> 3.5)
- jekyll-feed (~> 0.9)
- jekyll-seo-tag (~> 2.1)
- minitest (5.11.3)
- multipart-post (2.0.0)
- nokogiri (1.10.8)
- mini_portile2 (~> 2.4.0)
- octokit (4.13.0)
- sawyer (~> 0.8.0, >= 0.5.3)
- pathutil (0.16.2)
- forwardable-extended (~> 2.6)
- public_suffix (2.0.5)
- rb-fsevent (0.10.3)
- rb-inotify (0.10.0)
- ffi (~> 1.0)
- rouge (2.2.1)
- ruby-enum (0.7.2)
- i18n
- ruby_dep (1.5.0)
- rubyzip (1.3.0)
- safe_yaml (1.0.4)
- sass (3.7.3)
- sass-listen (~> 4.0.0)
- sass-listen (4.0.0)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- sawyer (0.8.1)
- addressable (>= 2.3.5, < 2.6)
- faraday (~> 0.8, < 1.0)
- terminal-table (1.8.0)
- unicode-display_width (~> 1.1, >= 1.1.1)
- thread_safe (0.3.6)
- typhoeus (1.3.1)
- ethon (>= 0.9.0)
- tzinfo (1.2.5)
- thread_safe (~> 0.1)
- unicode-display_width (1.4.1)
-
-PLATFORMS
- ruby
-
-DEPENDENCIES
- commonmarker
- ffi (>= 1.9.24)
- github-pages
- jekyll (>= 3.7.4)
- minima
- nokogiri (>= 1.8.5)
- rubyzip (>= 1.2.2)
-
-BUNDLED WITH
- 1.16.2
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index 11dd5e3e..00000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,11 +0,0 @@
-theme: jekyll-theme-minimal
-#github: [metadata]
-repository: warrensbox/terraform-switcher
-logo: /assets/img/logo.png
-title: tfswitch
-
-show_downloads: true
-
-exclude: [vendor]
-
-#github: [metadata]
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
deleted file mode 100644
index 9ba0968e..00000000
--- a/docs/_layouts/default.html
+++ /dev/null
@@ -1,87 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-{% seo %}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
{{ site.description | default: site.github.project_tagline }}
- -
- This project is maintained by {{ site.github.owner_name }}
- {% endif %} -
-
-
A command line tool to switch between different versions of terraform (with homebrew and more)
- -
- brew upgrade warrensbox/tap/tfswitch
-Rerun:
- -curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
-brew uninstall warrensbox/tap/tfswitch
-Rerun:
- -rm /usr/local/bin/tfswitch
-Common issues:
-install: can't change permissions of /usr/local/bin: Operation not permitted
-"Unable to remove symlink. You must have SUDO privileges"
-"Unable to create symlink. You must have SUDO privileges"
-You probably need to have sudo privileges to install tfswitch.
- - - - -This project is maintained by warrensbox
- -
-
-
A command line tool to switch between different versions of terraform (with homebrew and more)
- -
- The tfswitch command line tool lets you switch between different versions of terraform.
-If you do not have a particular version of terraform installed, tfswitch will download the version you desire.
-The installation is minimal and easy.
-Once installed, simply select the version you require from the dropdown and start using terraform.
tfswitch is available for MacOS and Linux based operating systems.
Installation for MacOS is the easiest with Homebrew. If you do not have homebrew installed, click here.
- -brew install warrensbox/tap/tfswitch
-Installation for Linux operation systems.
- -curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
-Alternatively, you can install the binary from the source here
- -
tfswitch on your terminal.The most recently selected versions are presented at the top of the dropdown.
- -
tfswitch 0.10.5 for version 0.10.5 of terraform.
tfswitch -l or tfswitch --list-all to see all versions.If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to version 0.12.24:
terraform {
- required_version = ">= 0.12.9"
-
- required_providers {
- aws = ">= 2.52.0"
- kubernetes = ">= 1.11.1"
- }
-}
-
This is similiar to using a .tfswitchrc file, but you can specify a custom binary path for your terraform installation
- -
-
mkdir /Users/warrenveerasingam/bin (replace warrenveerasingam with your username)export PATH=$PATH:/Users/warrenveerasingam/bin (add this to your bash profile or zsh profile)tfswitch -b /Users/warrenveerasingam/bin/terraform 0.10.8 .tfswitch.toml file in your terraform directory..tfswitch.toml file should look like this:
- bin = "/Users/warrenveerasingam/bin/terraform"
-version = "0.11.3"
-tfswitch and it should automatically install the required terraform version in the specified binary path
.tfswitchrc file containing the desired version.echo "0.10.5" >> .tfswitchrc for version 0.10.5 of terraform.tfswitch in the same directory as your .tfswitchrc.Instead of a .tfswitchrc file, a .terraform-version file may be used for compatibility with tfenv and other tools which use it
Automatically switch with bash
- -Add the following to the end of your ~/.bashrc file:
-(Use either .tfswitchrc or .tfswitch.toml or .terraform-version)
cdtfswitch(){
- builtin cd "$@";
- cdir=$PWD;
- if [ -e "$cdir/.tfswitchrc" ]; then
- tfswitch
- fi
-}
-alias cd='cdtfswitch'
-Automatically switch with zsh
- -Add the following to the end of your ~/.zshrc file:
load-tfswitch() {
- local tfswitchrc_path=".tfswitchrc"
-
- if [ -f "$tfswitchrc_path" ]; then
- tfswitch
- fi
-}
-add-zsh-hook chpwd load-tfswitch
-load-tfswitch
--- -NOTE: if you see an error like this:
-command not found: add-zsh-hook, then you might be on an older version of zsh (see below), or you simply need to loadadd-zsh-hookby adding this to your.zshrc:-autoload -U add-zsh-hook -
older version of zsh
-cd(){
- builtin cd "$@";
- cdir=$PWD;
- if [ -e "$cdir/.tfswitchrc" ]; then
- tfswitch
- fi
-}
-
#!/bin/bash
-
-echo "Installing tfswitch locally"
-wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh
-chmod 755 install.sh
-./install.sh -b bin-directory
-
-./bin-directory/tfswitch
-Please open issues here: New Issue
- -See how to upgrade, uninstall, troubleshoot here: -Additional Info
- - -This project is maintained by warrensbox
- -
-
-1. You can switch between different versions of terraform by typing the command `tfswitch` on your terminal.
-2. Select the version of terraform you require by using the up and down arrow.
-3. Hit **Enter** to select the desired version.
-
-The most recently selected versions are presented at the top of the dropdown.
-
-### Supply version on command line
-
-
-1. You can also supply the desired version as an argument on the command line.
-2. For example, `tfswitch 0.10.5` for version 0.10.5 of terraform.
-3. Hit **Enter** to switch.
-
-### See all versions including beta, alpha and release candidates(rc)
-
-
-1. Display all versions including beta, alpha and release candidates(rc).
-2. For example, `tfswitch -l` or `tfswitch --list-all` to see all versions.
-3. Hit **Enter** to select the desired version.
-
-### Use version.tf file
-If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to version `0.12.24`:
-```
-terraform {
- required_version = ">= 0.12.9"
-
- required_providers {
- aws = ">= 2.52.0"
- kubernetes = ">= 1.11.1"
- }
-}
-```
-
-
-
-### Use .tfswitch.toml file (For non-admin - users with limited privilege on their computers)
-This is similiar to using a .tfswitchrc file, but you can specify a custom binary path for your terraform installation
-
-
-
-
-1. Create a custom binary path. Ex: `mkdir /Users/warrenveerasingam/bin` (replace warrenveerasingam with your username)
-2. Add the path to your PATH. Ex: `export PATH=$PATH:/Users/warrenveerasingam/bin` (add this to your bash profile or zsh profile)
-3. Pass -b or --bin parameter with your custom path to install terraform. Ex: `tfswitch -b /Users/warrenveerasingam/bin/terraform 0.10.8 `
-4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory.
-5. Your `.tfswitch.toml` file should look like this:
-```
-bin = "/Users/warrenveerasingam/bin/terraform"
-version = "0.11.3"
-```
-4. Run `tfswitch` and it should automatically install the required terraform version in the specified binary path
-
-### Use .tfswitchrc file
-
-
-1. Create a `.tfswitchrc` file containing the desired version.
-2. For example, `echo "0.10.5" >> .tfswitchrc` for version 0.10.5 of terraform.
-3. Run the command `tfswitch` in the same directory as your `.tfswitchrc`.
-
-*Instead of a `.tfswitchrc` file, a `.terraform-version` file may be used for compatibility with [`tfenv`](https://github.com/tfutils/tfenv#terraform-version-file) and other tools which use it*
-
-**Automatically switch with bash**
-
-Add the following to the end of your `~/.bashrc` file:
-(Use either `.tfswitchrc` or `.tfswitch.toml` or `.terraform-version`)
-
-```
-cdtfswitch(){
- builtin cd "$@";
- cdir=$PWD;
- if [ -e "$cdir/.tfswitchrc" ]; then
- tfswitch
- fi
-}
-alias cd='cdtfswitch'
-```
-
-**Automatically switch with zsh**
-
-Add the following to the end of your `~/.zshrc` file:
-
-```
-load-tfswitch() {
- local tfswitchrc_path=".tfswitchrc"
-
- if [ -f "$tfswitchrc_path" ]; then
- tfswitch
- fi
-}
-add-zsh-hook chpwd load-tfswitch
-load-tfswitch
-```
-> NOTE: if you see an error like this: `command not found: add-zsh-hook`, then you might be on an older version of zsh (see below), or you simply need to load `add-zsh-hook` by adding this to your `.zshrc`:
-> ```
-> autoload -U add-zsh-hook
-> ```
-
-*older version of zsh*
-```
-cd(){
- builtin cd "$@";
- cdir=$PWD;
- if [ -e "$cdir/.tfswitchrc" ]; then
- tfswitch
- fi
-}
-```
-
-### Jenkins setup
-
-
-```
-#!/bin/bash
-
-echo "Installing tfswitch locally"
-wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh
-chmod 755 install.sh
-./install.sh -b bin-directory
-
-./bin-directory/tfswitch
-```
-
-
+
+```sh
+#!/bin/bash
+
+echo "Installing tfswitch locally"
+wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
+
+chmod 755 install.sh #Make installer executable
+
+./install.sh -b `pwd`/.bin #Install tfswitch in a location you have permission
+
+CUSTOMBIN=`pwd`/.bin #set custom bin path
+
+export PATH=$PATH:$CUSTOMBIN #Add custom bin path to PATH environment
+
+$CUSTOMBIN/tfswitch -b $CUSTOMBIN/terraform 0.11.7 #or simply tfswitch -b $CUSTOMBIN/terraform 0.11.7
+
+terraform -v #testing version
+```
+
+### Circle CI setup
+
+
+
+
+Example config yaml
+```yaml
+version: 2
+jobs:
+ build:
+ docker:
+ - image: ubuntu
+
+ working_directory: /go/src/github.com/warrensbox/terraform-switcher
+
+ steps:
+ - checkout
+ - run:
+ command: |
+ set +e
+ apt-get update
+ apt-get install -y wget
+ rm -rf /var/lib/apt/lists/*
+
+ echo "Installing tfswitch locally"
+
+ wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
+
+ chmod 755 install.sh #Make installer executable
+
+ ./install.sh -b `pwd`/.bin #Install tfswitch in a location you have permission
+
+ CUSTOMBIN=`pwd`/.bin #set custom bin path
+
+ export PATH=$PATH:$CUSTOMBIN #Add custom bin path to PATH environment
+
+ $CUSTOMBIN/tfswitch -b $CUSTOMBIN/terraform 0.11.7 #or simply tfswitch -b $CUSTOMBIN/terraform 0.11.7
+
+ terraform -v #testing version
+```
\ No newline at end of file
diff --git a/www/docs/How-to-Contribute.md b/www/docs/How-to-Contribute.md
new file mode 100644
index 00000000..9c1cc5a6
--- /dev/null
+++ b/www/docs/How-to-Contribute.md
@@ -0,0 +1,80 @@
+## Step by step instructions
+
+An open source project becomes meaningful when people collaborate to improve the code.
+
+Feel free to look at the code, critique and make suggestions. Lets make `tfswitch` better!
+
+## Required version
+```sh
+go version 1.13
+```
+
+### Step 1 - Create workspace
+*Skip this step if you already have a github go workspace*
+Create a github workspace.
+
+
+### Step 2 - Set GOPATH
+*Skip this step if you already have a github go workspace*
+Export your GOPATH environment variable in your `go` directory.
+```sh
+export GOPATH=`pwd`
+```
+
+
+### Step 3 - Clone repository
+Git clone this repository.
+```sh
+git clone git@github.com:warrensbox/terraform-switcher.git
+```
+
+
+### Step 4 - Get dependencies
+Go get all the dependencies.
+
+```sh
+go mod download
+```
+```sh
+go get -v -t -d ./...
+```
+Test the code (optional).
+```sh
+go vet -tests=false ./...
+```
+```sh
+go test -v ./...
+```
+
+
+### Step 5 - Build executable
+Create a new branch.
+```sh
+git checkout -b feature/put-your-branch-name-here
+```
+Refactor and add new features to the code.
+Go build the code.
+```sh
+go build -o test-tfswitch
+```
+Test the code and create a new pull request!
+
+
+
+### Contributors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/www/docs/Install.md b/www/docs/Install.md
new file mode 100644
index 00000000..c9f6bb08
--- /dev/null
+++ b/www/docs/Install.md
@@ -0,0 +1,33 @@
+## Installation
+
+`tfswitch` is available for MacOS and Linux based operating systems.
+
+### Homebrew
+
+Installation for MacOS is the easiest with Homebrew. If you do not have homebrew installed, click here.
+
+```ruby
+brew install warrensbox/tap/tfswitch
+```
+
+### Linux
+
+Installation for Linux operation systems.
+
+```sh
+curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+```
+
+### Snapcraft for CentOS, Ubuntu, Linux Mint, RHEL, Debian, Fedora
+
+```sh
+sudo snap install tfswitch
+```
+
+### Install from source
+
+Alternatively, you can install the binary from the source here.
+
+[Having trouble installing](https://tfswitch.warrensbox.com/Troubleshoot/).
+
+
diff --git a/docs/index.md b/www/docs/Quick-Start.md
similarity index 60%
rename from docs/index.md
rename to www/docs/Quick-Start.md
index 87cffb16..3669fd00 100644
--- a/docs/index.md
+++ b/www/docs/Quick-Start.md
@@ -1,65 +1,30 @@
-# Terraform Switcher
-
-The `tfswitch` command line tool lets you switch between different versions of [terraform](https://www.terraform.io/){:target="_blank"}.
-If you do not have a particular version of terraform installed, `tfswitch` will download the version you desire.
-The installation is minimal and easy.
-Once installed, simply select the version you require from the dropdown and start using terraform.
-
-
+
-1. You can switch between different versions of terraform by typing the command `tfswitch` on your terminal.
+1. You can switch between different versions of terraform by typing the command `tfswitch` on your terminal.
2. Select the version of terraform you require by using the up and down arrow.
3. Hit **Enter** to select the desired version.
The most recently selected versions are presented at the top of the dropdown.
### Supply version on command line
-
+
1. You can also supply the desired version as an argument on the command line.
2. For example, `tfswitch 0.10.5` for version 0.10.5 of terraform.
3. Hit **Enter** to switch.
### See all versions including beta, alpha and release candidates(rc)
-
+
1. Display all versions including beta, alpha and release candidates(rc).
2. For example, `tfswitch -l` or `tfswitch --list-all` to see all versions.
3. Hit **Enter** to select the desired version.
### Use version.tf file
-If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to version `0.12.24`:
+If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to the lastest version:
```
terraform {
required_version = ">= 0.12.9"
@@ -70,41 +35,40 @@ terraform {
}
}
```
-
-
+
### Use .tfswitch.toml file (For non-admin - users with limited privilege on their computers)
This is similiar to using a .tfswitchrc file, but you can specify a custom binary path for your terraform installation
-
-
+
+
1. Create a custom binary path. Ex: `mkdir /Users/warrenveerasingam/bin` (replace warrenveerasingam with your username)
2. Add the path to your PATH. Ex: `export PATH=$PATH:/Users/warrenveerasingam/bin` (add this to your bash profile or zsh profile)
3. Pass -b or --bin parameter with your custom path to install terraform. Ex: `tfswitch -b /Users/warrenveerasingam/bin/terraform 0.10.8 `
-4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory.
+4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory(current directory) OR in your home directory(~/.tfswitch.toml). The toml file in the current directory has a higher precedence than toml file in the home directory
5. Your `.tfswitch.toml` file should look like this:
-```
+```ruby
bin = "/Users/warrenveerasingam/bin/terraform"
version = "0.11.3"
```
4. Run `tfswitch` and it should automatically install the required terraform version in the specified binary path
### Use .tfswitchrc file
-
+
-1. Create a `.tfswitchrc` file containing the desired version.
-2. For example, `echo "0.10.5" >> .tfswitchrc` for version 0.10.5 of terraform.
-3. Run the command `tfswitch` in the same directory as your `.tfswitchrc`.
+1. Create a `.tfswitchrc` file containing the desired version
+2. For example, `echo "0.10.5" >> .tfswitchrc` for version 0.10.5 of terraform
+3. Run the command `tfswitch` in the same directory as your `.tfswitchrc`
*Instead of a `.tfswitchrc` file, a `.terraform-version` file may be used for compatibility with [`tfenv`](https://github.com/tfutils/tfenv#terraform-version-file) and other tools which use it*
**Automatically switch with bash**
-Add the following to the end of your `~/.bashrc` file:
+Add the following to the end of your `~/.bashrc` file:
(Use either `.tfswitchrc` or `.tfswitch.toml` or `.terraform-version`)
-```
+```sh
cdtfswitch(){
builtin cd "$@";
cdir=$PWD;
@@ -119,7 +83,7 @@ alias cd='cdtfswitch'
Add the following to the end of your `~/.zshrc` file:
-```
+```sh
load-tfswitch() {
local tfswitchrc_path=".tfswitchrc"
@@ -136,7 +100,7 @@ load-tfswitch
> ```
*older version of zsh*
-```
+```sh
cd(){
builtin cd "$@";
cdir=$PWD;
@@ -145,28 +109,25 @@ cd(){
fi
}
```
+**Automatically switch with fish shell**
-### Jenkins setup
-
+Add the following to the end of your `~/.config/fish/config.fish` file:
+```sh
+function switch_terraform --on-event fish_postexec
+ string match --regex '^cd\s' "$argv" > /dev/null
+ set --local is_command_cd $status
+
+ if test $is_command_cd -eq 0
+ if count *.tf > /dev/null
+
+ grep -c "required_version" *.tf > /dev/null
+ set --local tf_contains_version $status
+
+ if test $tf_contains_version -eq 0
+ command tfswitch
+ end
+ end
+ end
+end
```
-#!/bin/bash
-
-echo "Installing tfswitch locally"
-wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh
-chmod 755 install.sh
-./install.sh -b bin-directory
-
-./bin-directory/tfswitch
-```
-
-
+
diff --git a/www/docs/Upgrade-or-Uninstall.md b/www/docs/Upgrade-or-Uninstall.md
new file mode 100644
index 00000000..10dc0088
--- /dev/null
+++ b/www/docs/Upgrade-or-Uninstall.md
@@ -0,0 +1,29 @@
+## Upgrade:
+
+### Homebrew
+
+```ruby
+brew upgrade warrensbox/tap/tfswitch
+```
+### Linux
+
+Rerun:
+
+```sh
+curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+```
+
+## Uninstall:
+
+### Homebrew
+
+```ruby
+brew uninstall warrensbox/tap/tfswitch
+```
+### Linux
+
+Run:
+
+```sh
+rm /usr/local/bin/tfswitch
+```
\ No newline at end of file
diff --git a/www/docs/index.md b/www/docs/index.md
new file mode 100644
index 00000000..646bcb7c
--- /dev/null
+++ b/www/docs/index.md
@@ -0,0 +1,9 @@
+# Introduction to tfswitch
+
+
+
+The `tfswitch` command line tool lets you switch between different versions of terraform.
+If you do not have a particular version of terraform installed, `tfswitch` lets you download the version you desire.
+The installation is minimal and easy.
+Once installed, simply select the version you require from the dropdown and start using terraform.
+
diff --git a/www/docs/static/favicon_tfswitch_16.png b/www/docs/static/favicon_tfswitch_16.png
new file mode 100644
index 00000000..7951adc4
Binary files /dev/null and b/www/docs/static/favicon_tfswitch_16.png differ
diff --git a/www/docs/static/favicon_tfswitch_48.png b/www/docs/static/favicon_tfswitch_48.png
new file mode 100644
index 00000000..8d5fb3bf
Binary files /dev/null and b/www/docs/static/favicon_tfswitch_48.png differ
diff --git a/www/docs/static/logo.png b/www/docs/static/logo.png
new file mode 100644
index 00000000..835e0748
Binary files /dev/null and b/www/docs/static/logo.png differ
diff --git a/www/mkdocs.yml b/www/mkdocs.yml
new file mode 100644
index 00000000..d611190f
--- /dev/null
+++ b/www/mkdocs.yml
@@ -0,0 +1,27 @@
+site_name: TFSwitch
+site_description: A command line tool to switch between different versions of terraform (install with homebrew and more)
+copyright: This project is maintained by warrensbox
+repo_name: warrensbox/terraform-switcher
+repo_url: https://github.com/warrensbox/terraform-switcher
+site_url: https://tfswitch.warrensbox.com
+
+theme:
+ name: material
+ palette:
+ primary: indigo
+ favicon: static/favicon_tfswitch_16.png
+ logo: static/logo.png
+
+nav:
+ - index.md
+ - Install.md
+ - Quick-Start.md
+ - Continuous-Integration.md
+ - Upgrade-or-Uninstall.md
+ - How-to-Contribute.md
+ - Troubleshoot.md
+
+google_analytics:
+ - UA-120055973-1
+ - auto
+
\ No newline at end of file