Skip to content

Commit

Permalink
Add missing options to the readme. (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
rhoboat committed Apr 9, 2021
1 parent 4b8a1ec commit 9783f9f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Expand Up @@ -51,7 +51,10 @@ Option | Required | Description
`--binary-sha512-checksum` | No | The SHA512 checksum of the binary specified by `--binary-name`. Should be exactly 128 characters..
`--module-param` | No | A key-value pair of the format `key=value` you wish to pass to the module as a parameter. May be used multiple times. <br>Note: a `--` will automatically be appended to the `key` when your module is invoked<br>See the documentation for each module to find out what parameters it accepts.
`--download-dir` | No | The directory to which the module will be downloaded and from which it will be installed.
`--branch ` | No | Download the latest commit from this branch in --repo. This is an alternative to --tag,<br>and is used only for testing. This value is exposed to module install scripts as GRUNTWORK_INSTALL_BRANCH.
`--binary-install-dir` | No | The directory to which the binary will be installed. Only applies to binaries (not modules). Default: $DEFAULT_BIN_DIR"
`--no-sudo` | No | When true, don't use sudo to install the binary into the install directory. Only applies to binaries (not modules). Default: false.
`--branch` | No | Download the latest commit from this branch in --repo. This is an alternative to --tag,<br>and is used only for testing. This value is exposed to module install scripts as GRUNTWORK_INSTALL_BRANCH.
`--ref` | No | Download the latest commit from this ref in --repo. This is an alternative to --tag,<br>and is used only for testing. This value is exposed to module install scripts as GRUNTWORK_INSTALL_BRANCH.
`--help` | No | Show the help text and exit.

#### Examples
Expand Down

0 comments on commit 9783f9f

Please sign in to comment.