Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jocgir committed Oct 24, 2017
1 parent aa79528 commit eb202b5
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ or install it through command line:
On `OSX`:

```bash
curl -sL https://github.com/coveo/tgf/releases/download/v1.13.3/tgf_1.13.3_macOS_64-bits.zip | bsdtar -xf- -C /usr/local/bin && chmod +x /usr/local/bin/tgf
curl -sL https://github.com/coveo/tgf/releases/download/v1.14.0/tgf_1.14.0_macOS_64-bits.zip | bsdtar -xf- -C /usr/local/bin && chmod +x /usr/local/bin/tgf
```

On `Linux`:

```bash
curl -sL https://github.com/coveo/tgf/releases/download/v1.13.3/tgf_1.13.3_linux_64-bits.zip | gzip -d > /usr/local/bin/tgf && chmod +x /usr/local/bin/tgf
curl -sL https://github.com/coveo/tgf/releases/download/v1.14.0/tgf_1.14.0_linux_64-bits.zip | gzip -d > /usr/local/bin/tgf && chmod +x /usr/local/bin/tgf
```

On `Windows` with Powershell:

```powershell
Invoke-WebRequest https://github.com/coveo/tgf/releases/download/v1.13.3/tgf_1.13.3_windows_64-bits.zip -OutFile tgf.zip
Invoke-WebRequest https://github.com/coveo/tgf/releases/download/v1.14.0/tgf_1.14.0_windows_64-bits.zip -OutFile tgf.zip
```

## Configuration
Expand Down Expand Up @@ -108,7 +108,7 @@ Note: *The key names are not case sensitive*
> tgf
usage: tgf [<flags>]
tgf v1.13.3, a docker frontend for terragrunt. Any parameter after -- will be directly sent to the command identified by entrypoint.
tgf v1.14.0, a docker frontend for terragrunt. Any parameter after -- will be directly sent to the command identified by entrypoint.
Flags:
-h, --help Show context-sensitive help (also try --help-long and --help-man).
Expand All @@ -120,8 +120,11 @@ Flags:
-r, --refresh Force a refresh of the docker image
-v, --version Get the current version of tgf
-l, --logging=<level> Set the logging level (critical=0, error=1, warning=2, notice=3, info=4, debug=5)
-f, --flush-cache Invoke terragrunt with --terragrunt-update-source to flush the cache
--no-home Disable the mapping of the home directory
-f, --flush-cache Pass --terragrunt-update-source to terragrunt to flush the cache
--get-image-name Just return the resulting image name
--docker-arg=<opt> ... Supply extra argument to Docker
```

If any of the tgf arguments conflicts with an argument of the desired entry point, you must place that argument after -- to ensure that they are
Expand All @@ -132,7 +135,7 @@ Example:

```bash
> tgf --version
v1.13.3
v1.14.0
```

Returns the current version of the tgf tool
Expand Down

0 comments on commit eb202b5

Please sign in to comment.