snyk 1.783.0 → 1.784.0

package/help/{commands-md → cli-commands}/snyk-policy.md

@@ -14,9 +14,6 @@ Displays a `.snyk` policy file.
 
 Manually pass a path to a snyk policy file.
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -39,19 +36,6 @@ Prints versions.
 
 Prints a help text. You may specify a `<COMMAND>` to get more details.
 
-
-
-
-## Exit codes
-
-Possible exit codes and their meaning:
-
-**0**: success, no vulns found<br />
-**1**: action_needed, vulns found<br />
-**2**: failure, try to re-run command<br />
-**3**: failure, no supported projects detected<br />
-
-
 ## Environment
 
 You can set these environment variables to change CLI settings.
@@ -77,27 +61,27 @@ Specify a username to use when connecting to a container registry. Note that usi
 
 Specify a password to use when connecting to a container registry. Note that using the `--password` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
 
-## Connecting to Snyk API
+### Connecting to Snyk API
 
 By default Snyk CLI will connect to `https://snyk.io/api/v1`.
 
-### `SNYK_API`
+#### `SNYK_API`
 
 Sets API host to use for Snyk requests. Useful for on-premise instances and configuring proxies. If set with `http` protocol CLI will upgrade the requests to `https`. Unless `SNYK_HTTP_PROTOCOL_UPGRADE` is set to `0`.
 
-### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
+#### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
 
 If set to the value of `0`, API requests aimed at `http` URLs will not be upgraded to `https`. If not set, the default behavior will be to upgrade these requests from `http` to `https`. Useful e.g., for reverse proxies.
 
-### `HTTPS_PROXY` and `HTTP_PROXY`
+#### `HTTPS_PROXY` and `HTTP_PROXY`
 
 Allows you to specify a proxy to use for `https` and `http` calls. The `https` in the `HTTPS_PROXY` means that _requests using `https` protocol_ will use this proxy. The proxy itself doesn't need to use `https`.
 
+## Exit codes
 
-## Notices
-
-### Snyk API usage policy
-
-The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions
-https://snyk.co/ucT6N
+Possible exit codes and their meaning:
 
+**0**: success, no vulns found<br />
+**1**: action_needed, vulns found<br />
+**2**: failure, try to re-run command<br />
+**3**: failure, no supported projects detected<br />

package/help/{commands-md → cli-commands}/snyk-protect.md

@@ -20,9 +20,6 @@ See the official guide for the usage: https://github.com/snyk/snyk/tree/master/p
 
 Don't apply updates or patches when running.
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -45,19 +42,6 @@ Prints versions.
 
 Prints a help text. You may specify a `<COMMAND>` to get more details.
 
-
-
-
-## Exit codes
-
-Possible exit codes and their meaning:
-
-**0**: success, no vulns found<br />
-**1**: action_needed, vulns found<br />
-**2**: failure, try to re-run command<br />
-**3**: failure, no supported projects detected<br />
-
-
 ## Environment
 
 You can set these environment variables to change CLI settings.
@@ -83,27 +67,27 @@ Specify a username to use when connecting to a container registry. Note that usi
 
 Specify a password to use when connecting to a container registry. Note that using the `--password` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
 
-## Connecting to Snyk API
+### Connecting to Snyk API
 
 By default Snyk CLI will connect to `https://snyk.io/api/v1`.
 
-### `SNYK_API`
+#### `SNYK_API`
 
 Sets API host to use for Snyk requests. Useful for on-premise instances and configuring proxies. If set with `http` protocol CLI will upgrade the requests to `https`. Unless `SNYK_HTTP_PROTOCOL_UPGRADE` is set to `0`.
 
-### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
+#### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
 
 If set to the value of `0`, API requests aimed at `http` URLs will not be upgraded to `https`. If not set, the default behavior will be to upgrade these requests from `http` to `https`. Useful e.g., for reverse proxies.
 
-### `HTTPS_PROXY` and `HTTP_PROXY`
+#### `HTTPS_PROXY` and `HTTP_PROXY`
 
 Allows you to specify a proxy to use for `https` and `http` calls. The `https` in the `HTTPS_PROXY` means that _requests using `https` protocol_ will use this proxy. The proxy itself doesn't need to use `https`.
 
+## Exit codes
 
-## Notices
-
-### Snyk API usage policy
-
-The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions
-https://snyk.co/ucT6N
+Possible exit codes and their meaning:
 
+**0**: success, no vulns found<br />
+**1**: action_needed, vulns found<br />
+**2**: failure, try to re-run command<br />
+**3**: failure, no supported projects detected<br />

package/help/{commands-md → cli-commands}/snyk-test.md

@@ -8,7 +8,6 @@
 
 Test command checks locally installed projects for vulnerabilities. It tries to autodetect supported manifest files with dependencies and test those.
 
-
 ## Options
 
 To see command-specific flags and usage, see `help` command, e.g. `snyk container --help`.
@@ -16,32 +15,27 @@ For advanced usage, we offer language and context specific flags, listed further
 
 ### `--all-projects`
 
-(only in `test` and `monitor` commands)
 Auto-detect all projects in working directory
 
 ### `--detection-depth=<DEPTH>`
 
-(only in `test` and `monitor` commands)
 Use with --all-projects or --yarn-workspaces to indicate how many sub-directories to search. `DEPTH` must be a number.
 
 Default: 4 (the current working directory and 3 sub-directories)
 
 ### `--exclude=<DIRECTORY>[,<DIRECTORY>]...>`
 
-(only in `test` and `monitor` commands)
 Can be used with --all-projects and --yarn-workspaces to indicate sub-directories and files to exclude. Must be comma separated.
 
 If using with `--detection-depth` exclude ignores directories at any level deep.
 
 ### `--prune-repeated-subdependencies`, `-p`
 
-(only in `test` and `monitor` commands)
 Prune dependency trees, removing duplicate sub-dependencies.
 Will still find all vulnerabilities, but potentially not all of the vulnerable paths.
 
 ### `--print-deps`
 
-(only in `test` and `monitor` commands)
 Print the dependency tree before sending it for analysis.
 
 ### `--remote-repo-url=<URL>`
@@ -95,26 +89,6 @@ Specify a custom Snyk project name.
 
 A reference which differentiates this project. For example, a branch name or version. Projects using the same reference can be used for grouping. Only supported for Snyk Open Source. [More information](https://snyk.info/3B0vTPs).
 
-### `--project-environment=<ENVIRONMENT>[,<ENVIRONMENT>]...>`
-
-(only in `monitor` command)
-Set the project environment to one or more values (comma-separated). Allowed values: frontend, backend, internal, external, mobile, saas, onprem, hosted, distributed
-
-### `--project-lifecycle=<LIFECYCLE>[,<LIFECYCLE>]...>`
-
-(only in `monitor` command)
-Set the project lifecycle to one or more values (comma-separated). Allowed values: production, development, sandbox
-
-### `--project-business-criticality=<BUSINESS_CRITICALITY>[,<BUSINESS_CRITICALITY>]...>`
-
-(only in `monitor` command)
-Set the project business criticality to one or more values (comma-separated). Allowed values: critical, high, medium, low
-
-### `--project-tags=<TAG>[,<TAG>]...>`
-
-(only in `monitor` command)
-Set the project tags to one or more values (comma-separated key value pairs with an "=" separator). e.g. --project-tags=department=finance,team=alpha
-
 ### `--tags=<TAG>[,<TAG>]...>`
 
 This is an alias for `--project-tags`.
@@ -129,7 +103,6 @@ Prints results in JSON format.
 
 ### `--json-file-output=<OUTPUT_FILE_PATH>`
 
-(only in `test` command)
 Save test output in JSON format directly to the specified file, regardless of whether or not you use the `--json` option.
 This is especially useful if you want to display the human-readable test output via stdout and at the same time save the JSON format output to a file.
 
@@ -139,7 +112,6 @@ Return results in SARIF format.
 
 ### `--sarif-file-output=<OUTPUT_FILE_PATH>`
 
-(only in `test` command)
 Save test output in SARIF format directly to the <OUTPUT_FILE_PATH> file, regardless of whether or not you use the `--sarif` option.
 This is especially useful if you want to display the human-readable test output via stdout and at the same time save the SARIF format output to a file.
 
@@ -172,7 +144,6 @@ Auto detects maven jars, aars, and wars in given directory. Individual testing c
 
 #### `--reachable`
 
-(only in `test` and `monitor` commands)
 Analyze your source code to find which vulnerable
 functions and packages are called.
 
@@ -204,7 +175,6 @@ Select certain values of configuration attributes to resolve the dependencies. E
 
 #### `--reachable`
 
-(only in `test` and `monitor` commands)
 Analyze your source code to find which vulnerable
 functions and packages are called.
 
@@ -250,7 +220,6 @@ Default: true
 
 #### `--yarn-workspaces`
 
-(only in `test` and `monitor` commands)
 Detect and scan yarn workspaces. You can specify how many sub-directories to search using `--detection-depth` and exclude directories and files using `--exclude`.
 
 ### CocoaPods options
@@ -274,7 +243,6 @@ Example: `--command=python3`
 
 Allow skipping packages that are not found in the environment.
 
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -297,19 +265,6 @@ Prints versions.
 
 Prints a help text. You may specify a `<COMMAND>` to get more details.
 
-
-
-
-## Exit codes
-
-Possible exit codes and their meaning:
-
-**0**: success, no vulns found<br />
-**1**: action_needed, vulns found<br />
-**2**: failure, try to re-run command<br />
-**3**: failure, no supported projects detected<br />
-
-
 ## Environment
 
 You can set these environment variables to change CLI settings.
@@ -335,27 +290,27 @@ Specify a username to use when connecting to a container registry. Note that usi
 
 Specify a password to use when connecting to a container registry. Note that using the `--password` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
 
-## Connecting to Snyk API
+### Connecting to Snyk API
 
 By default Snyk CLI will connect to `https://snyk.io/api/v1`.
 
-### `SNYK_API`
+#### `SNYK_API`
 
 Sets API host to use for Snyk requests. Useful for on-premise instances and configuring proxies. If set with `http` protocol CLI will upgrade the requests to `https`. Unless `SNYK_HTTP_PROTOCOL_UPGRADE` is set to `0`.
 
-### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
+#### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
 
 If set to the value of `0`, API requests aimed at `http` URLs will not be upgraded to `https`. If not set, the default behavior will be to upgrade these requests from `http` to `https`. Useful e.g., for reverse proxies.
 
-### `HTTPS_PROXY` and `HTTP_PROXY`
+#### `HTTPS_PROXY` and `HTTP_PROXY`
 
 Allows you to specify a proxy to use for `https` and `http` calls. The `https` in the `HTTPS_PROXY` means that _requests using `https` protocol_ will use this proxy. The proxy itself doesn't need to use `https`.
 
+## Exit codes
 
-## Notices
-
-### Snyk API usage policy
-
-The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions
-https://snyk.co/ucT6N
+Possible exit codes and their meaning:
 
+**0**: success, no vulns found<br />
+**1**: action_needed, vulns found<br />
+**2**: failure, try to re-run command<br />
+**3**: failure, no supported projects detected<br />

package/help/{commands-md → cli-commands}/snyk-wizard.md

@@ -15,9 +15,6 @@ Snyk's wizard will:
 
 ## Options
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -40,19 +37,6 @@ Prints versions.
 
 Prints a help text. You may specify a `<COMMAND>` to get more details.
 
-
-
-
-## Exit codes
-
-Possible exit codes and their meaning:
-
-**0**: success, no vulns found<br />
-**1**: action_needed, vulns found<br />
-**2**: failure, try to re-run command<br />
-**3**: failure, no supported projects detected<br />
-
-
 ## Environment
 
 You can set these environment variables to change CLI settings.
@@ -78,27 +62,27 @@ Specify a username to use when connecting to a container registry. Note that usi
 
 Specify a password to use when connecting to a container registry. Note that using the `--password` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
 
-## Connecting to Snyk API
+### Connecting to Snyk API
 
 By default Snyk CLI will connect to `https://snyk.io/api/v1`.
 
-### `SNYK_API`
+#### `SNYK_API`
 
 Sets API host to use for Snyk requests. Useful for on-premise instances and configuring proxies. If set with `http` protocol CLI will upgrade the requests to `https`. Unless `SNYK_HTTP_PROTOCOL_UPGRADE` is set to `0`.
 
-### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
+#### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
 
 If set to the value of `0`, API requests aimed at `http` URLs will not be upgraded to `https`. If not set, the default behavior will be to upgrade these requests from `http` to `https`. Useful e.g., for reverse proxies.
 
-### `HTTPS_PROXY` and `HTTP_PROXY`
+#### `HTTPS_PROXY` and `HTTP_PROXY`
 
 Allows you to specify a proxy to use for `https` and `http` calls. The `https` in the `HTTPS_PROXY` means that _requests using `https` protocol_ will use this proxy. The proxy itself doesn't need to use `https`.
 
+## Exit codes
 
-## Notices
-
-### Snyk API usage policy
-
-The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions
-https://snyk.co/ucT6N
+Possible exit codes and their meaning:
 
+**0**: success, no vulns found<br />
+**1**: action_needed, vulns found<br />
+**2**: failure, try to re-run command<br />
+**3**: failure, no supported projects detected<br />

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "snyk",
-  "version": "1.783.0",
+  "version": "1.784.0",
   "description": "snyk library and cli utility",
   "files": [
-    "help/commands-md",
+    "help/cli-commands",
     "dist",
     "bin",
     "pysrc",
@@ -15,7 +15,7 @@
   "directories": {
     "lib": "src",
     "test": "test",
-    "doc": "help/commands-md"
+    "doc": "help/cli-commands"
   },
   "bin": {
     "snyk": "bin/snyk"
@@ -41,7 +41,6 @@
     "build:prod": "lerna run build --ignore snyk && npm run build-cli:prod",
     "build-cli:dev": "node --max-old-space-size=8192 node_modules/webpack/bin/webpack.js --config webpack.dev.ts",
     "build-cli:prod": "node --max-old-space-size=8192 node_modules/webpack/bin/webpack.js --config webpack.prod.ts",
-    "generate-help": "npx ts-node ./help/generator/generator.ts",
     "watch": "npm run build-cli:dev -- --watch",
     "test": "npm run test:acceptance && npm run test:system && npm run test:test && npm run test:jest && test:packages-unit && test:packages-acceptance",
     "test:acceptance": "tap test/acceptance/**/*.test.* test/acceptance/*.test.* -Rspec --timeout=300 --node-arg=-r --node-arg=ts-node/register",
@@ -87,5 +86,5 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "gitHead": "2b9058070bded1451b357eed1bebd434e60dd1bb"
+  "gitHead": "206605208b06d88c256619ea13c2f5f39543466a"
 }

package/help/commands-md/snyk-help.md

@@ -1,99 +0,0 @@
-# snyk help -- Prints help topics
-
-## Usage
-
-`snyk help [<TOPIC>] [<OPTIONS>]`
-
-## Description
-
-Prints help information. Pass in name of a command as `<TOPIC>`.
-
-## Options
-
-
-
-
-### Flags available accross all commands
-
-#### `--insecure`
-
-Ignore unknown certificate authorities.
-
-#### `-d`
-
-Output debug logs.
-
-#### `--quiet`, `-q`
-
-Silence all output.
-
-#### `--version`, `-v`
-
-Prints versions.
-
-#### `--help [<COMMAND>]`, `[<COMMAND>] --help`, `-h`
-
-Prints a help text. You may specify a `<COMMAND>` to get more details.
-
-
-
-
-## Exit codes
-
-Possible exit codes and their meaning:
-
-**0**: success, no vulns found<br />
-**1**: action_needed, vulns found<br />
-**2**: failure, try to re-run command<br />
-**3**: failure, no supported projects detected<br />
-
-
-## Environment
-
-You can set these environment variables to change CLI settings.
-
-### `SNYK_TOKEN`
-
-Snyk authorization token. Setting this envvar will override the token that may be available in your `snyk config` settings.
-
-[How to get your account token](https://snyk.co/ucT6J)<br />
-[How to use Service Accounts](https://snyk.co/ucT6L)<br />
-
-### `SNYK_CFG_KEY`
-
-Allows you to override any key that's also available as `snyk config` option.
-
-E.g. `SNYK_CFG_ORG=myorg` will override default org option in `config` with "myorg".
-
-### `SNYK_REGISTRY_USERNAME`
-
-Specify a username to use when connecting to a container registry. Note that using the `--username` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
-
-### `SNYK_REGISTRY_PASSWORD`
-
-Specify a password to use when connecting to a container registry. Note that using the `--password` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
-
-## Connecting to Snyk API
-
-By default Snyk CLI will connect to `https://snyk.io/api/v1`.
-
-### `SNYK_API`
-
-Sets API host to use for Snyk requests. Useful for on-premise instances and configuring proxies. If set with `http` protocol CLI will upgrade the requests to `https`. Unless `SNYK_HTTP_PROTOCOL_UPGRADE` is set to `0`.
-
-### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
-
-If set to the value of `0`, API requests aimed at `http` URLs will not be upgraded to `https`. If not set, the default behavior will be to upgrade these requests from `http` to `https`. Useful e.g., for reverse proxies.
-
-### `HTTPS_PROXY` and `HTTP_PROXY`
-
-Allows you to specify a proxy to use for `https` and `http` calls. The `https` in the `HTTPS_PROXY` means that _requests using `https` protocol_ will use this proxy. The proxy itself doesn't need to use `https`.
-
-
-## Notices
-
-### Snyk API usage policy
-
-The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions
-https://snyk.co/ucT6N
-

package/help/commands-md/snyk-woof.md

@@ -1,103 +0,0 @@
-# snyk woof -- W00f
-
-## Usage
-
-`snyk woof [<OPTIONS>]`
-
-## Description
-
-Easter egg that prints a Patch ascii art.
-
-## Options
-
-### `--language=<LANGUAGE>`
-
-Woof in a specific language. `<LANGUAGE>` should be an ISO 639-1 code.
-
-
-
-
-### Flags available accross all commands
-
-#### `--insecure`
-
-Ignore unknown certificate authorities.
-
-#### `-d`
-
-Output debug logs.
-
-#### `--quiet`, `-q`
-
-Silence all output.
-
-#### `--version`, `-v`
-
-Prints versions.
-
-#### `--help [<COMMAND>]`, `[<COMMAND>] --help`, `-h`
-
-Prints a help text. You may specify a `<COMMAND>` to get more details.
-
-
-
-
-## Exit codes
-
-Possible exit codes and their meaning:
-
-**0**: success, no vulns found<br />
-**1**: action_needed, vulns found<br />
-**2**: failure, try to re-run command<br />
-**3**: failure, no supported projects detected<br />
-
-
-## Environment
-
-You can set these environment variables to change CLI settings.
-
-### `SNYK_TOKEN`
-
-Snyk authorization token. Setting this envvar will override the token that may be available in your `snyk config` settings.
-
-[How to get your account token](https://snyk.co/ucT6J)<br />
-[How to use Service Accounts](https://snyk.co/ucT6L)<br />
-
-### `SNYK_CFG_KEY`
-
-Allows you to override any key that's also available as `snyk config` option.
-
-E.g. `SNYK_CFG_ORG=myorg` will override default org option in `config` with "myorg".
-
-### `SNYK_REGISTRY_USERNAME`
-
-Specify a username to use when connecting to a container registry. Note that using the `--username` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
-
-### `SNYK_REGISTRY_PASSWORD`
-
-Specify a password to use when connecting to a container registry. Note that using the `--password` flag will override this value. This will be ignored in favour of local Docker binary credentials when Docker is present.
-
-## Connecting to Snyk API
-
-By default Snyk CLI will connect to `https://snyk.io/api/v1`.
-
-### `SNYK_API`
-
-Sets API host to use for Snyk requests. Useful for on-premise instances and configuring proxies. If set with `http` protocol CLI will upgrade the requests to `https`. Unless `SNYK_HTTP_PROTOCOL_UPGRADE` is set to `0`.
-
-### `SNYK_HTTP_PROTOCOL_UPGRADE=0`
-
-If set to the value of `0`, API requests aimed at `http` URLs will not be upgraded to `https`. If not set, the default behavior will be to upgrade these requests from `http` to `https`. Useful e.g., for reverse proxies.
-
-### `HTTPS_PROXY` and `HTTP_PROXY`
-
-Allows you to specify a proxy to use for `https` and `http` calls. The `https` in the `HTTPS_PROXY` means that _requests using `https` protocol_ will use this proxy. The proxy itself doesn't need to use `https`.
-
-
-## Notices
-
-### Snyk API usage policy
-
-The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions
-https://snyk.co/ucT6N
-