Skip to content

Commit

Permalink
chore: update Snyk Container help text
Browse files Browse the repository at this point in the history
* Fixed alignment of options
* Added missing global options
* Added examples, including for archive files
  • Loading branch information
garethr committed Jun 19, 2020
1 parent df62c5d commit 3757780
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions help/container.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Container:
Usage:

$ snyk container [command] [options] [image]

Find vulnerabilities in your a container images.
Find vulnerabilities in your container images.

Commands:

Expand All @@ -12,17 +12,22 @@ Commands:

Options:

--exclude-base-image-vulns ............. Exclude from display base image vulnerabilities.
--file=<string> ........................ Include the path to the image's Dockerfile for more detailed advice.
--exclude-base-image-vulns .............. Exclude from display base image vulnerabilities.
--file=<string> ......................... Include the path to the image's Dockerfile for more detailed advice.
-h, --help
--json
--print-deps ............................ Print the dependency tree before sending it for analysis.
--project-name=<string> ................. Specify a custom Snyk project name.
--policy-path=<path> .................... Manually pass a path to a snyk policy file.
--severity-threshold=<low|medium|high>... Only report vulnerabilities of provided level or higher.

Examples:

$ snyk container test alpine
$ snyk container monitor alpine
$ snyk container test docker-archive:archive.tar
$ snyk container test oci-archive:archive.tar

Pro tip: use `snyk container test --file=Dockerfile` for more detailed advice.

For more information see https://snyk.io
For more information see https://snyk.io

0 comments on commit 3757780

Please sign in to comment.