Skip to content

Commit cec67d2

Browse files
authored
Merge pull request #198 from cyberark/197-readme-flags
Updating README.md with a couple missing flags.
2 parents 78b0ab9 + 0c86c5d commit cec67d2

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,11 @@ VARIABLE_WITH_DEFAULT: !var:default='defaultvalue' path/to/variable
174174
summon -D ENV=production --yaml 'SQL_PASSWORD: !var env/$ENV/db-password' deploy.sh
175175
```
176176
177+
* `--yaml` secrets.yml as a literal string.
178+
179+
This flag is used to pass `secrets.yml` to the provider as a literal string
180+
(see example above).
181+
177182
* `-i, --ignore` A secret path for which to ignore provider errors.
178183

179184
This flag can be useful for when you have secrets that you don't need access to for development. For example API keys for monitoring tools. This flag can be used multiple times.
@@ -182,6 +187,10 @@ VARIABLE_WITH_DEFAULT: !var:default='defaultvalue' path/to/variable
182187

183188
This flag can be useful when the underlying system that's going to be using the values implements defaults. For example, when using summon as a bridge to [confd](https://github.com/kelseyhightower/confd).
184189

190+
* `-V, --all-provider-versions` List of all of the providers in the default
191+
path and their versions (if they have the --version tag).
192+
* `-v, --version` Print the Summon version.
193+
185194
* `-e, --environment` Specify section (environment) to parse from secret YAML.
186195

187196
This flag specifies which specific environment/section to parse from the secrets YAML file (or string). In addition, it will also enable the usage of a `common` (or `default`) section which will be inherited by other sections/environments. In other words, if your `secrets.yaml` looks something like this:
@@ -203,7 +212,7 @@ Doing something along the lines of: `summon -f secrets.yaml -e staging printenv
203212

204213
Note: `default` is an alias for `common` section. You can use either one.
205214

206-
View help and all flags with `summon -h`.
215+
* `-h` View help and all flags.
207216

208217
### env-file
209218

0 commit comments

Comments
 (0)