snyk 1.783.0 → 1.784.0

package/help/README.md

@@ -1,20 +1,21 @@
 # CLI Help files
 
-Snyk CLI help files are generated from markdown sources in `help/commands-docs` folder.
-
-There is a simple templating system that pieces markdown sources together into a markdown that gets rendered.
+Snyk CLI help files are in the `help/cli-commands` folder.
 
 ## Updating or adding help documents
 
-Contact **Team Hammer** or open an issue in this repository when in doubt.
+All commands are documented in a Markdown format. They are automatically pushed to the [Snyk User Documentation site](https://docs.snyk.io).
 
-Keep all changes in `help/commands-docs` folder, as that is used as source for generating Markdown, ronn and txt files. When you are done editing, or you want to preview your changes, run the `npm run generate-help` (see "Running locally" below for troubleshooting). Then commit all changes, including the generated files.
+Don't use HTML tags. These markdown files are the source for the `--help` command output in the Snyk CLI.
+
+Contact **Team Hammer** or open an issue in this repository when in doubt.
 
 ### CLI options
 
 ```markdown
-- `--severity-threshold`=low|medium|high|critical:
-  Only report vulnerabilities of provided level or higher.
+### `--severity-threshold=low|medium|high|critical`
+
+Only report vulnerabilities of provided level or higher.
 ```
 
-CLI flag should be in backticks. Options (filenames, org names…) should use Keyword extension (see below) and literal options (true|false, low|medium|high|critical…) should be typed as above.
+CLI flag should be a heading and in backticks. See already documented commands and flags for more examples.

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

@@ -18,9 +18,6 @@ Your Snyk token. May be an user token or a service account.<br />
 [How to get your account token](https://snyk.co/ucT6J)<br />
 [How to use Service Accounts](https://snyk.co/ucT6L)<br />
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -43,19 +40,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.
@@ -81,27 +65,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-code.md

@@ -2,7 +2,7 @@
 
 ## Usage
 
-`snyk code [<COMMAND>] [<OPTIONS>] <PATH>`
+`snyk code [<COMMAND>] [<OPTIONS>] [<PATH>]`
 
 ## Description
 
@@ -41,9 +41,6 @@ Default: uses <ORG_NAME> that sets as default in your [Account settings](https:/
 
 Return results in SARIF format.
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -66,19 +63,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.
@@ -104,27 +88,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-config.md

@@ -2,7 +2,7 @@
 
 ## Usage
 
-`snyk config get|set|unset|clear [<KEY>[=<VALUE>]] [<OPTIONS>]`
+`snyk config <COMMAND> [<OPTIONS>]`
 
 ## Description
 
@@ -56,9 +56,6 @@ Configures the username for an OCI registry used in IaC scannings with custom ru
 
 Configures the password for an OCI registry used in IaC scannings with custom rules.
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -81,19 +78,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.
@@ -119,27 +103,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-container.md

@@ -2,7 +2,7 @@
 
 ## Usage
 
-`snyk container [<COMMAND>] [<OPTIONS>] [<IMAGE>]`
+`snyk container <COMMAND> [<OPTIONS>] [<IMAGE>]`
 
 ## Description
 
@@ -77,9 +77,6 @@ Specify a username to use when connecting to a container registry. This will be
 
 Specify a password to use when connecting to a container registry. This will be ignored in favour of local Docker binary credentials when Docker is present.
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -102,19 +99,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.
@@ -140,27 +124,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-iac.md

@@ -1,8 +1,8 @@
-# snyk-iac(1) -- Find security issues in your Infrastructure as Code files
+# snyk iac -- Find security issues in your Infrastructure as Code files
 
 ## Usage
 
-`snyk` `iac` [<COMMAND>][<options>] <PATH>
+`snyk iac <COMMAND> [<OPTIONS>] [<PATH>]`
 
 ## Description
 
@@ -87,9 +87,6 @@ This flag cannot be used if the custom rules settings were configured via the Sn
 Default: If the `--rules` flag is not provided it would scan the configuration files using the internal Snyk rules only.
 Example: `--rules=bundle.tar.gz` (scans the configuration files using custom rules and internal Snyk rules)
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -112,7 +109,6 @@ Prints versions.
 
 Prints a help text. You may specify a `<COMMAND>` to get more details.
 
-
 ## Examples
 
 [For more information see IaC help page](https://snyk.co/ucT6Q)
@@ -147,17 +143,6 @@ Prints a help text. You may specify a `<COMMAND>` to get more details.
 
 \$ snyk iac test /path/to/directory --rules=bundle.tar.gz
 
-
-## 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.
@@ -183,27 +168,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-ignore.md

@@ -30,9 +30,6 @@ Expiry date, according to [RFC2822](https://tools.ietf.org/html/rfc2822)
 
 Human-readable <REASON> to ignore this issue.
 
-
-
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -55,24 +52,12 @@ Prints versions.
 
 Prints a help text. You may specify a `<COMMAND>` to get more details.
 
-
 ## Examples
 
 ### `Ignore a specific vulnerability`
 
 \$ snyk ignore --id='npm:qs:20170213' --expiry='2021-01-10' --reason='Module not affected by this vuln'
 
-
-## 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.
@@ -98,27 +83,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-monitor.md

@@ -8,7 +8,6 @@
 
 Create a project on the Snyk website that will be continuously monitored for new vulnerabilities. After running this command you will see it by logging in to the website and viewing Your projects.
 
-
 ## 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>`
@@ -97,23 +91,19 @@ A reference which differentiates this project. For example, a branch name or ver
 
 ### `--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
+Set the project environment to one or more values (comma-separated). To clear the project environment set `--project-environment=`. 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
+Set the project lifecycle to one or more values (comma-separated). To clear the project lifecycle set `--project-lifecycle=`. 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
+Set the project business criticality to one or more values (comma-separated). To clear the project business criticality set `--project-business-criticality=`. 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
+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. To clear the project tags set `--project-tags=`
 
 ### `--tags=<TAG>[,<TAG>]...>`
 
@@ -127,22 +117,10 @@ Manually pass a path to a snyk policy file.
 
 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.
-
 ### `--sarif`
 
 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.
-
 ### `--severity-threshold=low|medium|high|critical`
 
 Only report vulnerabilities of provided level or higher.
@@ -172,7 +150,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 +181,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 +226,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 +249,6 @@ Example: `--command=python3`
 
 Allow skipping packages that are not found in the environment.
 
-
 ### Flags available accross all commands
 
 #### `--insecure`
@@ -297,19 +271,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 +296,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 />