Skip to content

Commit

Permalink
fix: move --all-projects help text
Browse files Browse the repository at this point in the history
Moving --all-projects, --detection-depth and --exclude help test
out of experimental section, and higher up now that this feature
has been released.
  • Loading branch information
gitphill committed Jan 28, 2020
1 parent a295643 commit 1f1fd72
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions help/help.txt
Expand Up @@ -27,6 +27,18 @@ Commands:

Options:

--all-projects ..... (test & monitor commands only)
Auto detect all projects in working directory.
Note gradle is not supported, use --all-sub-projects instead.
--detection-depth=<number>
(test & monitor commands only)
Use with --all-projects to indicate how many sub-directories to search.
Defaults to 2 (the current working directory and one sub-directory).
--exclude=<comma seperated list of directory names>
(test & monitor commands only)
Can only be used with --all-projects to indicate sub-directories to exclude.
Directories must be comma seperated.
If using with --detection-depth exclude ignores directories at any level deep.
--dev .............. Include devDependencies (defaults to production only).
--file=<File> ...... Sets package file. For more help run `snyk help file`.
--org=<org-name> ... Specify the org machine-name to run Snyk with a specific
Expand Down Expand Up @@ -125,22 +137,6 @@ Docker options:
--exclude-base-image-vulns
Exclude from display Docker base image vulnerabilities.

Experimental options:
The following options may change without notice, we do not recommend using them in production.

--all-projects ..... (test & monitor commands only)
Auto detect all projects in working directory.
Currently npm, yarn, ruby and maven projects are supported.
--detection-depth=<number>
(test & monitor commands only)
Use with --all-projects to indicate how many sub-directories to search.
Defaults to 2 (the current working directory and one sub-directory).
--exclude=<comma seperated list of directory names>
(test & monitor commands only)
Can only be used with --all-projects to indicate sub-directories to exclude.
Directories must be comma seperated.
If using with --detection-depth exclude ignores directories at any level deep.

Examples:

$ snyk test
Expand Down

0 comments on commit 1f1fd72

Please sign in to comment.