Merge pull request snyk#2286 from snyk/docs/target-reference

docs: add help for --target-reference

help/commands-docs/_SNYK_COMMAND_OPTIONS.md

@@ -67,6 +67,10 @@ For advanced usage, we offer language and context specific flags, listed further
 - `--project-name`=<PROJECT_NAME>:
   Specify a custom Snyk project name.
 
+- `--target-reference`=<TARGET_REFERENCE>:
+  (only in `monitor` command)
+  A reference to separate this project from other scans of the same project. For example, a branch name or version. Projects using the same reference can be used for grouping. [More information](https://snyk.info/3B0vTPs).
+
 - `--policy-path`=<PATH_TO_POLICY_FILE>`:
   Manually pass a path to a snyk policy file.
 

help/commands-man/snyk-auth.1

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "SNYK\-AUTH" "1" "August 2021" "Snyk.io"
+.TH "SNYK\-AUTH" "1" "September 2021" "Snyk.io"
 .SH "NAME"
 \fBsnyk\-auth\fR \- Authenticate Snyk CLI with a Snyk account
 .SH "SYNOPSIS"
@@ -59,7 +59,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -78,7 +78,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR

help/commands-man/snyk-code.1

@@ -70,7 +70,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -89,7 +89,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR

help/commands-man/snyk-config.1

@@ -1,14 +1,14 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "SNYK\-CONFIG" "1" "August 2021" "Snyk.io"
+.TH "SNYK\-CONFIG" "1" "September 2021" "Snyk.io"
 .SH "NAME"
 \fBsnyk\-config\fR \- Manage Snyk CLI configuration
 .SH "SYNOPSIS"
 \fBsnyk\fR \fBconfig\fR \fBget|set|clear\fR [\fIKEY\fR[=\fIVALUE\fR]] [\fIOPTIONS\fR]
 .SH "DESCRIPTION"
 Manage your local Snyk CLI config file\. This config file is a JSON located at \fB$XDG_CONFIG_HOME\fR or \fB~/\.config\fR followed by \fBconfigstore/snyk\.json\fR\. For example \fB~/\.config/configstore/snyk\.json\fR\.
 .P
-This command does not manage the \fB\.snyk\fR file that\'s part of your project\. See \fBsnyk policy\fR, \fBsnyk ignore\fR or \fBsnyk wizard\fR\.
+This command does not manage the \fB\.snyk\fR file that's part of your project\. See \fBsnyk policy\fR, \fBsnyk ignore\fR or \fBsnyk wizard\fR\.
 .SH "COMMANDS"
 .TP
 \fBget\fR \fIKEY\fR
@@ -73,7 +73,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -92,7 +92,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR

help/commands-man/snyk-container.1

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "SNYK\-CONTAINER" "1" "August 2021" "Snyk.io"
+.TH "SNYK\-CONTAINER" "1" "September 2021" "Snyk.io"
 .SH "NAME"
 \fBsnyk\-container\fR \- Test container images for vulnerabilities
 .SH "SYNOPSIS"
@@ -20,7 +20,7 @@ Record the state of dependencies and any vulnerabilities on snyk\.io\.
 Exclude from display base image vulnerabilities\.
 .TP
 \fB\-\-file\fR=\fIFILE_PATH\fR
-Include the path to the image\'s Dockerfile for more detailed advice\.
+Include the path to the image's Dockerfile for more detailed advice\.
 .TP
 \fB\-\-platform\fR=\fIPLATFORM\fR
 For multi\-architecture images, specify the platform to test\. [linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7 or linux/arm/v6]
@@ -94,7 +94,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -113,7 +113,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR

help/commands-man/snyk-help.1

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "SNYK\-HELP" "1" "August 2021" "Snyk.io"
+.TH "SNYK\-HELP" "1" "September 2021" "Snyk.io"
 .SH "NAME"
 \fBsnyk\-help\fR \- Prints help topics
 .SH "SYNOPSIS"
@@ -48,7 +48,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -67,7 +67,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR

help/commands-man/snyk-iac.1

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "SNYK\-IAC" "1" "August 2021" "Snyk.io"
+.TH "SNYK\-IAC" "1" "September 2021" "Snyk.io"
 .SH "NAME"
 \fBsnyk\-iac\fR \- Find security issues in your Infrastructure as Code files
 .SH "SYNOPSIS"
@@ -119,7 +119,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -138,7 +138,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR

help/commands-man/snyk-ignore.1

@@ -1,14 +1,14 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "SNYK\-IGNORE" "1" "August 2021" "Snyk.io"
+.TH "SNYK\-IGNORE" "1" "September 2021" "Snyk.io"
 .SH "NAME"
 \fBsnyk\-ignore\fR \- Modifies the \.snyk policy to ignore stated issues
 .SH "SYNOPSIS"
 \fBsnyk\fR \fBignore\fR \fB\-\-id\fR=\fIISSUE_ID\fR [\fB\-\-expiry\fR=\fIEXPIRY\fR] [\fB\-\-reason\fR=\fIREASON\fR] [\fIOPTIONS\fR]
 .SH "DESCRIPTION"
 Ignore a certain issue, according to its snyk ID for all occurrences\. This will update your local \fB\.snyk\fR to contain a similar block:
 .P
-\fByaml ignore: \'<ISSUE_ID>\': \- \'*\': reason: <REASON> expires: <EXPIRY>\fR
+\fByaml ignore: '<ISSUE_ID>': \- '*': reason: <REASON> expires: <EXPIRY>\fR
 .SH "OPTIONS"
 .TP
 \fB\-\-id\fR=\fIISSUE_ID\fR
@@ -38,7 +38,7 @@ Prints a help text\. You may specify a \fICOMMAND\fR to get more details\.
 .SH "EXAMPLES"
 .TP
 \fBIgnore a specific vulnerability\fR
-$ snyk ignore \-\-id=\'npm:qs:20170213\' \-\-expiry=\'2021\-01\-10\' \-\-reason=\'Module not affected by this vuln\'
+$ snyk ignore \-\-id='npm:qs:20170213' \-\-expiry='2021\-01\-10' \-\-reason='Module not affected by this vuln'
 .SH "EXIT CODES"
 Possible exit codes and their meaning:
 .P
@@ -63,7 +63,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR
 
 .TP
 \fBSNYK_CFG_KEY\fR
-Allows you to override any key that\'s also available as \fBsnyk config\fR option\.
+Allows you to override any key that's also available as \fBsnyk config\fR option\.
 .IP
 E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\.
 .TP
@@ -82,7 +82,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co
 If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\.
 .TP
 \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR
-Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\.
+Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\.
 .SH "NOTICES"
 .SS "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 \fIhttps://snyk\.co/ucT6N\fR
+The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR