Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: move --all-projects help text #982

Merged
merged 1 commit into from
Jan 28, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions help/help.txt
Original file line number Diff line number Diff line change
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