Skip to content

Commit 47358cd

Browse files
committedNov 17, 2020
chore: update --help docs
1 parent 401265d commit 47358cd

File tree

5 files changed

+11
-10
lines changed

5 files changed

+11
-10
lines changed
 

‎help/commands-docs/_ENVIRONMENT.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ You can set these environment variables to change CLI run settings. These keys w
1313

1414
- `SNYK_CFG_`<KEY>:
1515
Allows you to override any key that's also available as `snyk config` option.
16+
17+
E.g. `SNYK_CFG_ORG`=myorg will override default org option in `config` with "myorg".

‎help/commands-docs/_EXAMPLES.md

-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ See `snyk container --help` for more details and examples:
1919

2020
$ snyk container test ubuntu:18.04 --org=my-team
2121
$ snyk container test app:latest --file=Dockerfile --policy-path=path/to/.snyk
22-
$ snyk test --yarn-workspaces --detection-depth=4 --strict-out-of-sync=false
2322

2423
### Infrastructure as Code (IAC) scanning
2524

‎help/commands-docs/_SNYK_COMMAND_HEADER.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## DESCRIPTION
88

9-
Snyk helps you find, fix and monitor known vulnerabilities in open-source dependencies.<br />
9+
Snyk helps you find, fix and monitor known vulnerabilities in open source dependencies.<br />
1010
For more information see https://snyk.io
1111

1212
### Not sure where to start?
@@ -21,13 +21,13 @@ To see command-specific flags and usage, see `help` command, e.g. `snyk containe
2121
Available top-level CLI commands:
2222

2323
- `auth` \[<API_TOKEN>\]:
24-
Authenticate Snyk CLI with a Snyk account
24+
Authenticate Snyk CLI with a Snyk account.
2525

2626
- `test`:
27-
Test local project for vulnerabilities
27+
Test local project for vulnerabilities.
2828

2929
- `monitor`:
30-
Snapshot and continuously monitor your project
30+
Snapshot and continuously monitor your project.
3131

3232
- `container`:
3333
Test container images for vulnerabilities. See `snyk container --help` for full instructions.
@@ -36,16 +36,16 @@ Available top-level CLI commands:
3636
Find security issues in your Infrastructure as Code files. See `snyk iac --help` for full instructions.
3737

3838
- `config`:
39-
Manage Snyk CLI configuration
39+
Manage Snyk CLI configuration.
4040

4141
- `protect`:
42-
Applies the patches specified in your .snyk file to the local file system
42+
Applies the patches specified in your .snyk file to the local file system.
4343

4444
- `policy`:
4545
Display the .snyk policy for a package.
4646

4747
- `ignore`:
48-
Modifies the .snyk policy to ignore stated issues
48+
Modifies the .snyk policy to ignore stated issues.
4949

5050
- `wizard`:
5151
Configure your policy file to update, auto patch and ignore vulnerabilities. Snyk wizard updates your .snyk file.

‎help/commands-docs/_SNYK_COMMAND_OPTIONS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For advanced usage, we offer language and context specific flags, listed further
3232
Set or override the remote URL for the repository that you would like to monitor.
3333

3434
- `--dev`:
35-
Include devDependencies.
35+
Include development-only dependencies. Applicable only for some package managers. E.g. _devDependencies_ in npm or _:development_ dependencies in Gemfile.
3636

3737
Default: scan only production dependencies
3838

‎help/commands-docs/container.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Find vulnerabilities in your container images.
2626

2727
- `--platform`=<PLATFORM>:
2828
For multi-architecture images, specify the platform to test.
29-
[linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7 orlinux/arm/v6]
29+
[linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7 or linux/arm/v6]
3030

3131
- `--json`:
3232
Prints results in JSON format.

0 commit comments

Comments
 (0)
Please sign in to comment.