From 96eba680cde68e14c0bbb36bb2962c9b4ac8ea14 Mon Sep 17 00:00:00 2001 From: Jahed Ahmed Date: Tue, 16 Nov 2021 18:00:23 +0000 Subject: [PATCH] docs: target ref only works with snyk open source --- help/commands-docs/_SNYK_COMMAND_OPTIONS.md | 2 +- help/commands-man/snyk-auth.1 | 6 +- help/commands-man/snyk-code.1 | 6 +- help/commands-man/snyk-config.1 | 8 +- help/commands-man/snyk-container.1 | 8 +- help/commands-man/snyk-help.1 | 6 +- help/commands-man/snyk-iac.1 | 6 +- help/commands-man/snyk-ignore.1 | 10 +- help/commands-man/snyk-monitor.1 | 16 +- help/commands-man/snyk-policy.1 | 6 +- help/commands-man/snyk-protect.1 | 10 +- help/commands-man/snyk-test.1 | 16 +- help/commands-man/snyk-wizard.1 | 10 +- help/commands-man/snyk-woof.1 | 6 +- help/commands-man/snyk.1 | 16 +- help/commands-md/snyk-monitor.md | 2 +- help/commands-md/snyk-test.md | 2 +- help/commands-md/snyk.md | 2 +- help/commands-txt/snyk-auth.txt | 4 +- help/commands-txt/snyk-code.txt | 8 +- help/commands-txt/snyk-config.txt | 8 +- help/commands-txt/snyk-container.txt | 8 +- help/commands-txt/snyk-help.txt | 4 +- help/commands-txt/snyk-iac.txt | 46 ++--- help/commands-txt/snyk-ignore.txt | 46 ++--- help/commands-txt/snyk-monitor.txt | 184 +++++++++---------- help/commands-txt/snyk-policy.txt | 4 +- help/commands-txt/snyk-protect.txt | 4 +- help/commands-txt/snyk-test.txt | 184 +++++++++---------- help/commands-txt/snyk-wizard.txt | 8 +- help/commands-txt/snyk-woof.txt | 4 +- help/commands-txt/snyk.txt | 190 ++++++++++---------- 32 files changed, 420 insertions(+), 420 deletions(-) diff --git a/help/commands-docs/_SNYK_COMMAND_OPTIONS.md b/help/commands-docs/_SNYK_COMMAND_OPTIONS.md index 62125c100a..48466bdaee 100644 --- a/help/commands-docs/_SNYK_COMMAND_OPTIONS.md +++ b/help/commands-docs/_SNYK_COMMAND_OPTIONS.md @@ -68,7 +68,7 @@ For advanced usage, we offer language and context specific flags, listed further Specify a custom Snyk project name. - `--target-reference`=: - 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). + 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`=[,]...>: (only in `monitor` command) diff --git a/help/commands-man/snyk-auth.1 b/help/commands-man/snyk-auth.1 index 2d9f41503b..03afed42c7 100644 --- a/help/commands-man/snyk-auth.1 +++ b/help/commands-man/snyk-auth.1 @@ -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 diff --git a/help/commands-man/snyk-code.1 b/help/commands-man/snyk-code.1 index bcedb6b7a2..8753dc63f3 100644 --- a/help/commands-man/snyk-code.1 +++ b/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 diff --git a/help/commands-man/snyk-config.1 b/help/commands-man/snyk-config.1 index d9934c1390..bedf27146f 100644 --- a/help/commands-man/snyk-config.1 +++ b/help/commands-man/snyk-config.1 @@ -8,7 +8,7 @@ .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 @@ -82,7 +82,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 @@ -101,7 +101,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 diff --git a/help/commands-man/snyk-container.1 b/help/commands-man/snyk-container.1 index 812ceb782f..b8000b4b3a 100644 --- a/help/commands-man/snyk-container.1 +++ b/help/commands-man/snyk-container.1 @@ -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 diff --git a/help/commands-man/snyk-help.1 b/help/commands-man/snyk-help.1 index 0209555db0..8597aaee03 100644 --- a/help/commands-man/snyk-help.1 +++ b/help/commands-man/snyk-help.1 @@ -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 diff --git a/help/commands-man/snyk-iac.1 b/help/commands-man/snyk-iac.1 index 631972bc50..943a882a2c 100644 --- a/help/commands-man/snyk-iac.1 +++ b/help/commands-man/snyk-iac.1 @@ -132,7 +132,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 @@ -151,7 +151,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 diff --git a/help/commands-man/snyk-ignore.1 b/help/commands-man/snyk-ignore.1 index 85092ce770..c517f34962 100644 --- a/help/commands-man/snyk-ignore.1 +++ b/help/commands-man/snyk-ignore.1 @@ -8,7 +8,7 @@ .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: \'\': \- \'*\': reason: expires: \fR +\fByaml ignore: '': \- '*': reason: expires: \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 diff --git a/help/commands-man/snyk-monitor.1 b/help/commands-man/snyk-monitor.1 index e006816105..3e576848e9 100644 --- a/help/commands-man/snyk-monitor.1 +++ b/help/commands-man/snyk-monitor.1 @@ -55,10 +55,10 @@ When testing locally or monitoring a project, you can specify the file that Snyk Ignores all set policies\. The current policy in \fB\.snyk\fR file, Org level ignores and the project policy on snyk\.io\. .TP \fB\-\-trust\-policies\fR -Applies and uses ignore rules from your dependencies\' Snyk policies, otherwise ignore policies are only shown as a suggestion\. +Applies and uses ignore rules from your dependencies' Snyk policies, otherwise ignore policies are only shown as a suggestion\. .TP \fB\-\-show\-vulnerable\-paths\fR=none|some|all -Display the dependency paths from the top level dependencies, down to the vulnerable packages\. Doesn\'t affect output when using JSON \fB\-\-json\fR output\. +Display the dependency paths from the top level dependencies, down to the vulnerable packages\. Doesn't affect output when using JSON \fB\-\-json\fR output\. .IP Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fInone\fR\. .TP @@ -66,7 +66,7 @@ Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fIn Specify a custom Snyk project name\. .TP \fB\-\-target\-reference\fR=\fITARGET_REFERENCE\fR -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 \fIhttps://snyk\.info/3B0vTPs\fR\. +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 \fIhttps://snyk\.info/3B0vTPs\fR\. .TP \fB\-\-project\-environment\fR=\fIENVIRONMENT\fR[,\fIENVIRONMENT\fR]\|\.\|\.\|\.> (only in \fBmonitor\fR command) Set the project environment to one or more values (comma\-separated)\. Allowed values: frontend, backend, internal, external, mobile, saas, onprem, hosted, distributed @@ -109,7 +109,7 @@ Only fail when there are vulnerabilities that can be fixed\. If vulnerabilities do not have a fix and this option is being used, tests will pass\. .TP \fB\-\-dry\-run\fR -(only in \fBprotect\fR command) Don\'t apply updates or patches during \fBprotect\fR command run\. +(only in \fBprotect\fR command) Don't apply updates or patches during \fBprotect\fR command run\. .TP \fB\-\-\fR [\fICOMPILER_OPTIONS\fR] Pass extra arguments directly to Gradle or Maven\. E\.g\. \fBsnyk test \-\- \-\-build\-cache\fR @@ -180,7 +180,7 @@ Default: false .SS "Python options" .TP \fB\-\-command\fR=\fICOMMAND\fR -Indicate which specific Python commands to use based on Python version\. The default is \fBpython\fR which executes your systems default python version\. Run \'python \-V\' to find out what version is it\. If you are using multiple Python versions, use this parameter to specify the correct Python command for execution\. +Indicate which specific Python commands to use based on Python version\. The default is \fBpython\fR which executes your systems default python version\. Run 'python \-V' to find out what version is it\. If you are using multiple Python versions, use this parameter to specify the correct Python command for execution\. .IP Default: \fBpython\fR Example: \fB\-\-command=python3\fR .TP @@ -226,7 +226,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 @@ -245,7 +245,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 diff --git a/help/commands-man/snyk-policy.1 b/help/commands-man/snyk-policy.1 index d12f89642e..e3a78c8759 100644 --- a/help/commands-man/snyk-policy.1 +++ b/help/commands-man/snyk-policy.1 @@ -51,7 +51,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 @@ -70,7 +70,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 diff --git a/help/commands-man/snyk-protect.1 b/help/commands-man/snyk-protect.1 index ba9dfd5be2..55f8edba4d 100644 --- a/help/commands-man/snyk-protect.1 +++ b/help/commands-man/snyk-protect.1 @@ -6,11 +6,11 @@ .SH "SYNOPSIS" \fBsnyk\fR \fBprotect\fR [\fIOPTIONS\fR] .SH "DESCRIPTION" -\fB$ snyk protect\fR is used to apply patches to your vulnerable dependencies\. It\'s useful after opening a fix pull request from our website (GitHub only) or after running snyk wizard on the CLI\. snyk protect reads a \.snyk policy file to determine what patches to apply\. +\fB$ snyk protect\fR is used to apply patches to your vulnerable dependencies\. It's useful after opening a fix pull request from our website (GitHub only) or after running snyk wizard on the CLI\. snyk protect reads a \.snyk policy file to determine what patches to apply\. .SH "OPTIONS" .TP \fB\-\-dry\-run\fR -Don\'t apply updates or patches when running\. +Don't apply updates or patches when running\. .SS "Flags available accross all commands" .TP \fB\-\-insecure\fR @@ -51,7 +51,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 @@ -70,7 +70,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 diff --git a/help/commands-man/snyk-test.1 b/help/commands-man/snyk-test.1 index 168a4d1c9f..bc93dd0056 100644 --- a/help/commands-man/snyk-test.1 +++ b/help/commands-man/snyk-test.1 @@ -55,10 +55,10 @@ When testing locally or monitoring a project, you can specify the file that Snyk Ignores all set policies\. The current policy in \fB\.snyk\fR file, Org level ignores and the project policy on snyk\.io\. .TP \fB\-\-trust\-policies\fR -Applies and uses ignore rules from your dependencies\' Snyk policies, otherwise ignore policies are only shown as a suggestion\. +Applies and uses ignore rules from your dependencies' Snyk policies, otherwise ignore policies are only shown as a suggestion\. .TP \fB\-\-show\-vulnerable\-paths\fR=none|some|all -Display the dependency paths from the top level dependencies, down to the vulnerable packages\. Doesn\'t affect output when using JSON \fB\-\-json\fR output\. +Display the dependency paths from the top level dependencies, down to the vulnerable packages\. Doesn't affect output when using JSON \fB\-\-json\fR output\. .IP Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fInone\fR\. .TP @@ -66,7 +66,7 @@ Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fIn Specify a custom Snyk project name\. .TP \fB\-\-target\-reference\fR=\fITARGET_REFERENCE\fR -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 \fIhttps://snyk\.info/3B0vTPs\fR\. +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 \fIhttps://snyk\.info/3B0vTPs\fR\. .TP \fB\-\-project\-environment\fR=\fIENVIRONMENT\fR[,\fIENVIRONMENT\fR]\|\.\|\.\|\.> (only in \fBmonitor\fR command) Set the project environment to one or more values (comma\-separated)\. Allowed values: frontend, backend, internal, external, mobile, saas, onprem, hosted, distributed @@ -109,7 +109,7 @@ Only fail when there are vulnerabilities that can be fixed\. If vulnerabilities do not have a fix and this option is being used, tests will pass\. .TP \fB\-\-dry\-run\fR -(only in \fBprotect\fR command) Don\'t apply updates or patches during \fBprotect\fR command run\. +(only in \fBprotect\fR command) Don't apply updates or patches during \fBprotect\fR command run\. .TP \fB\-\-\fR [\fICOMPILER_OPTIONS\fR] Pass extra arguments directly to Gradle or Maven\. E\.g\. \fBsnyk test \-\- \-\-build\-cache\fR @@ -180,7 +180,7 @@ Default: false .SS "Python options" .TP \fB\-\-command\fR=\fICOMMAND\fR -Indicate which specific Python commands to use based on Python version\. The default is \fBpython\fR which executes your systems default python version\. Run \'python \-V\' to find out what version is it\. If you are using multiple Python versions, use this parameter to specify the correct Python command for execution\. +Indicate which specific Python commands to use based on Python version\. The default is \fBpython\fR which executes your systems default python version\. Run 'python \-V' to find out what version is it\. If you are using multiple Python versions, use this parameter to specify the correct Python command for execution\. .IP Default: \fBpython\fR Example: \fB\-\-command=python3\fR .TP @@ -226,7 +226,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 @@ -245,7 +245,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 diff --git a/help/commands-man/snyk-wizard.1 b/help/commands-man/snyk-wizard.1 index 7e3f5910b7..60652e1aef 100644 --- a/help/commands-man/snyk-wizard.1 +++ b/help/commands-man/snyk-wizard.1 @@ -6,9 +6,9 @@ .SH "SYNOPSIS" \fBsnyk\fR \fBwizard\fR [\fIOPTIONS\fR] .SH "DESCRIPTION" -Snyk\'s wizard will: +Snyk's wizard will: .IP "\[ci]" 4 -Enumerate your local dependencies and query Snyk\'s servers for vulnerabilities +Enumerate your local dependencies and query Snyk's servers for vulnerabilities .IP "\[ci]" 4 Guide you through fixing found vulnerabilities .IP "\[ci]" 4 @@ -57,7 +57,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 @@ -76,7 +76,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 diff --git a/help/commands-man/snyk-woof.1 b/help/commands-man/snyk-woof.1 index 94e0c4d6de..c42c4cc7af 100644 --- a/help/commands-man/snyk-woof.1 +++ b/help/commands-man/snyk-woof.1 @@ -51,7 +51,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 @@ -70,7 +70,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 diff --git a/help/commands-man/snyk.1 b/help/commands-man/snyk.1 index ef13cac544..7963a8e58a 100644 --- a/help/commands-man/snyk.1 +++ b/help/commands-man/snyk.1 @@ -100,10 +100,10 @@ When testing locally or monitoring a project, you can specify the file that Snyk Ignores all set policies\. The current policy in \fB\.snyk\fR file, Org level ignores and the project policy on snyk\.io\. .TP \fB\-\-trust\-policies\fR -Applies and uses ignore rules from your dependencies\' Snyk policies, otherwise ignore policies are only shown as a suggestion\. +Applies and uses ignore rules from your dependencies' Snyk policies, otherwise ignore policies are only shown as a suggestion\. .TP \fB\-\-show\-vulnerable\-paths\fR=none|some|all -Display the dependency paths from the top level dependencies, down to the vulnerable packages\. Doesn\'t affect output when using JSON \fB\-\-json\fR output\. +Display the dependency paths from the top level dependencies, down to the vulnerable packages\. Doesn't affect output when using JSON \fB\-\-json\fR output\. .IP Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fInone\fR\. .TP @@ -111,7 +111,7 @@ Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fIn Specify a custom Snyk project name\. .TP \fB\-\-target\-reference\fR=\fITARGET_REFERENCE\fR -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 \fIhttps://snyk\.info/3B0vTPs\fR\. +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 \fIhttps://snyk\.info/3B0vTPs\fR\. .TP \fB\-\-project\-environment\fR=\fIENVIRONMENT\fR[,\fIENVIRONMENT\fR]\|\.\|\.\|\.> (only in \fBmonitor\fR command) Set the project environment to one or more values (comma\-separated)\. Allowed values: frontend, backend, internal, external, mobile, saas, onprem, hosted, distributed @@ -154,7 +154,7 @@ Only fail when there are vulnerabilities that can be fixed\. If vulnerabilities do not have a fix and this option is being used, tests will pass\. .TP \fB\-\-dry\-run\fR -(only in \fBprotect\fR command) Don\'t apply updates or patches during \fBprotect\fR command run\. +(only in \fBprotect\fR command) Don't apply updates or patches during \fBprotect\fR command run\. .TP \fB\-\-\fR [\fICOMPILER_OPTIONS\fR] Pass extra arguments directly to Gradle or Maven\. E\.g\. \fBsnyk test \-\- \-\-build\-cache\fR @@ -225,7 +225,7 @@ Default: false .SS "Python options" .TP \fB\-\-command\fR=\fICOMMAND\fR -Indicate which specific Python commands to use based on Python version\. The default is \fBpython\fR which executes your systems default python version\. Run \'python \-V\' to find out what version is it\. If you are using multiple Python versions, use this parameter to specify the correct Python command for execution\. +Indicate which specific Python commands to use based on Python version\. The default is \fBpython\fR which executes your systems default python version\. Run 'python \-V' to find out what version is it\. If you are using multiple Python versions, use this parameter to specify the correct Python command for execution\. .IP Default: \fBpython\fR Example: \fB\-\-command=python3\fR .TP @@ -325,7 +325,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 @@ -344,7 +344,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 diff --git a/help/commands-md/snyk-monitor.md b/help/commands-md/snyk-monitor.md index 5095295f7c..6c823807e0 100644 --- a/help/commands-md/snyk-monitor.md +++ b/help/commands-md/snyk-monitor.md @@ -79,7 +79,7 @@ For advanced usage, we offer language and context specific flags, listed further Specify a custom Snyk project name. - `--target-reference`=: - 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). + 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`=[,]...>: (only in `monitor` command) diff --git a/help/commands-md/snyk-test.md b/help/commands-md/snyk-test.md index 0691a1869d..4c87d13fbc 100644 --- a/help/commands-md/snyk-test.md +++ b/help/commands-md/snyk-test.md @@ -79,7 +79,7 @@ For advanced usage, we offer language and context specific flags, listed further Specify a custom Snyk project name. - `--target-reference`=: - 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). + 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`=[,]...>: (only in `monitor` command) diff --git a/help/commands-md/snyk.md b/help/commands-md/snyk.md index 67ae3d776c..ab40b36210 100644 --- a/help/commands-md/snyk.md +++ b/help/commands-md/snyk.md @@ -124,7 +124,7 @@ For advanced usage, we offer language and context specific flags, listed further Specify a custom Snyk project name. - `--target-reference`=: - 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). + 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`=[,]...>: (only in `monitor` command) diff --git a/help/commands-txt/snyk-auth.txt b/help/commands-txt/snyk-auth.txt index 546e3016ef..0e3bf6a87d 100644 --- a/help/commands-txt/snyk-auth.txt +++ b/help/commands-txt/snyk-auth.txt @@ -32,8 +32,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-code.txt b/help/commands-txt/snyk-code.txt index 62f170b1a1..d95fb29b17 100644 --- a/help/commands-txt/snyk-code.txt +++ b/help/commands-txt/snyk-code.txt @@ -22,8 +22,8 @@ --json Prints results in JSON format. --org=ORG_NAME - Specify the ORG_NAME to run Snyk commands tied to a specific - organization. This will influence private tests limits. If you + Specify the ORG_NAME to run Snyk commands tied to a specific or- + ganization. This will influence private tests limits. If you have multiple organizations, you can set a default from the CLI using: @@ -51,8 +51,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-config.txt b/help/commands-txt/snyk-config.txt index f97ef36b28..11ac9d3136 100644 --- a/help/commands-txt/snyk-config.txt +++ b/help/commands-txt/snyk-config.txt @@ -5,8 +5,8 @@ snyk config get|set|clear [KEY[=VALUE]] [OPTIONS] DESCRIPTION - Manage your local Snyk CLI config file. This config file is a JSON - located at $XDG_CONFIG_HOME or ~/.config followed by config- + Manage your local Snyk CLI config file. This config file is a JSON lo- + cated at $XDG_CONFIG_HOME or ~/.config followed by config- store/snyk.json. For example ~/.config/configstore/snyk.json. This command does not manage the .snyk file that's part of your @@ -59,8 +59,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-container.txt b/help/commands-txt/snyk-container.txt index 7f94f596ad..d899aca5f1 100644 --- a/help/commands-txt/snyk-container.txt +++ b/help/commands-txt/snyk-container.txt @@ -19,8 +19,8 @@ Exclude from display base image vulnerabilities. --file=FILE_PATH - Include the path to the image's Dockerfile for more detailed - advice. + Include the path to the image's Dockerfile for more detailed ad- + vice. --platform=PLATFORM For multi-architecture images, specify the platform to test. @@ -81,8 +81,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-help.txt b/help/commands-txt/snyk-help.txt index e3cd7a8560..d7ace45d00 100644 --- a/help/commands-txt/snyk-help.txt +++ b/help/commands-txt/snyk-help.txt @@ -21,8 +21,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-iac.txt b/help/commands-txt/snyk-iac.txt index 159e845e3e..3f9347476f 100644 --- a/help/commands-txt/snyk-iac.txt +++ b/help/commands-txt/snyk-iac.txt @@ -43,8 +43,8 @@ save the JSON format output to a file. --org=ORG_NAME - Specify the ORG_NAME to run Snyk commands tied to a specific - organization. This will influence private tests limits. If you + Specify the ORG_NAME to run Snyk commands tied to a specific or- + ganization. This will influence private tests limits. If you have multiple organizations, you can set a default from the CLI using: @@ -87,7 +87,7 @@ not be used if the custom rules settings were configured via the Snyk UI. 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 + Example: --rules=bundle.tar.gz (scans the configuration files using custom rules and internal Snyk rules) Flags available accross all commands @@ -103,8 +103,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXAMPLES For more information see IaC help page https://snyk.co/ucT6Q @@ -142,7 +142,7 @@ You can set these environment variables to change CLI run settings. SNYK_TOKEN - Snyk authorization token. Setting this envvar will override the + 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 @@ -150,47 +150,47 @@ SNYK_CFG_KEY - Allows you to override any key that's also available as snyk + 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 con- fig with "myorg". SNYK_REGISTRY_USERNAME - Specify a username to use when connecting to a container reg- - istry. Note that using the --username flag will override this - value. This will be ignored in favour of local Docker binary + Specify a username to use when connecting to a container reg- + istry. 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 reg- - istry. Note that using the --password flag will override this - value. This will be ignored in favour of local Docker binary + Specify a password to use when connecting to a container reg- + istry. 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 + 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_PROTO- + will upgrade the requests to https. Unless SNYK_HTTP_PROTO- COL_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., + 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 + 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 pack- - age or otherwise, is subject to the terms & conditions + The use of Snyk's API, whether through the use of the 'snyk' npm pack- + age or otherwise, is subject to the terms & conditions https://snyk.co/ucT6N diff --git a/help/commands-txt/snyk-ignore.txt b/help/commands-txt/snyk-ignore.txt index 93389b142f..30ec380c57 100644 --- a/help/commands-txt/snyk-ignore.txt +++ b/help/commands-txt/snyk-ignore.txt @@ -5,7 +5,7 @@ snyk ignore --id=ISSUE_ID [--expiry=EXPIRY] [--reason=REASON] [OPTIONS] DESCRIPTION - Ignore a certain issue, according to its snyk ID for all occurrences. + Ignore a certain issue, according to its snyk ID for all occurrences. This will update your local .snyk to contain a similar block: yaml ignore: '<ISSUE_ID>': - '*': reason: <REASON> expires: <EXPIRY> @@ -15,7 +15,7 @@ Snyk ID for the issue to ignore. Required. --expiry=EXPIRY - Expiry date, according to RFC2822 + Expiry date, according to RFC2822 https://tools.ietf.org/html/rfc2822 --reason=REASON @@ -34,12 +34,12 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXAMPLES Ignore a specific vulnerability - $ snyk ignore --id='npm:qs:20170213' --expiry='2021-01-10' + $ snyk ignore --id='npm:qs:20170213' --expiry='2021-01-10' --reason='Module not affected by this vuln' EXIT CODES @@ -54,7 +54,7 @@ You can set these environment variables to change CLI run settings. SNYK_TOKEN - Snyk authorization token. Setting this envvar will override the + 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 @@ -62,47 +62,47 @@ SNYK_CFG_KEY - Allows you to override any key that's also available as snyk + 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 con- fig with "myorg". SNYK_REGISTRY_USERNAME - Specify a username to use when connecting to a container reg- - istry. Note that using the --username flag will override this - value. This will be ignored in favour of local Docker binary + Specify a username to use when connecting to a container reg- + istry. 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 reg- - istry. Note that using the --password flag will override this - value. This will be ignored in favour of local Docker binary + Specify a password to use when connecting to a container reg- + istry. 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 + 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_PROTO- + will upgrade the requests to https. Unless SNYK_HTTP_PROTO- COL_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., + 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 + 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 pack- - age or otherwise, is subject to the terms & conditions + The use of Snyk's API, whether through the use of the 'snyk' npm pack- + age or otherwise, is subject to the terms & conditions https://snyk.co/ucT6N diff --git a/help/commands-txt/snyk-monitor.txt b/help/commands-txt/snyk-monitor.txt index 46310c4080..9b6793ba00 100644 --- a/help/commands-txt/snyk-monitor.txt +++ b/help/commands-txt/snyk-monitor.txt @@ -26,42 +26,42 @@ Default: 4 (the current working directory and 3 sub-directories) --exclude=DIRECTORY[,DIRECTORY]...> - (only in test and monitor commands) Can be used with + (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 + 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 vulner- - abilities, but potentially not all of the vulnerable paths. + (only in test and monitor commands) Prune dependency trees, re- + moving duplicate sub-dependencies. Will still find all vulnera- + bilities, but potentially not all of the vulnerable paths. --print-deps - (only in test and monitor commands) Print the dependency tree + (only in test and monitor commands) Print the dependency tree before sending it for analysis. --remote-repo-url=URL Set or override the remote URL for the repository that you would like to monitor. - --dev Include development-only dependencies. Applicable only for some - package managers. E.g. devDependencies in npm or :development + --dev Include development-only dependencies. Applicable only for some + package managers. E.g. devDependencies in npm or :development dependencies in Gemfile. Default: scan only production dependencies --org=ORG_NAME - Specify the ORG_NAME to run Snyk commands tied to a specific - organization. This will influence where will new projects be - created after running monitor command, some features availabil- - ity and private tests limits. If you have multiple organiza- - tions, you can set a default from the CLI using: + Specify the ORG_NAME to run Snyk commands tied to a specific or- + ganization. This will influence where will new projects be cre- + ated after running monitor command, some features availability + and private tests limits. If you have multiple organizations, + you can set a default from the CLI using: $ snyk config set org=ORG_NAME - Setting a default will ensure all newly monitored projects will + Setting a default will ensure all newly monitored projects will be created under your default organization. If you need to over- ride the default, you can use the --org=ORG_NAME argument. @@ -71,23 +71,23 @@ --file=FILE Sets a package file. - When testing locally or monitoring a project, you can specify - the file that Snyk should inspect for package information. When - ommitted Snyk will try to detect the appropriate file for your + When testing locally or monitoring a project, you can specify + the file that Snyk should inspect for package information. When + ommitted Snyk will try to detect the appropriate file for your project. --ignore-policy - Ignores all set policies. The current policy in .snyk file, Org + Ignores all set policies. The current policy in .snyk file, Org level ignores and the project policy on snyk.io. --trust-policies Applies and uses ignore rules from your dependencies' Snyk poli- - cies, otherwise ignore policies are only shown as a suggestion. + cies, otherwise ignore policies are only shown as a suggestion. --show-vulnerable-paths=none|some|all Display the dependency paths from the top level dependencies, - down to the vulnerable packages. Doesn't affect output when - using JSON --json output. + down to the vulnerable packages. Doesn't affect output when us- + ing JSON --json output. Default: some (a few example paths shown) false is an alias for none. @@ -96,10 +96,10 @@ Specify a custom Snyk project name. --target-reference=TARGET_REFERENCE - 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 informa- - tion https://snyk.info/3B0vTPs. + 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 in- + formation https://snyk.info/3B0vTPs. --project-environment=ENVIRONMENT[,ENVIRONMENT]...> (only in monitor command) Set the project environment to one or @@ -109,18 +109,18 @@ --project-lifecycle=LIFECYCLE[,LIFECYCLE]...> (only in monitor command) Set the project lifecycle to one or - more values (comma-separated). Allowed values: production, - development, sandbox + more values (comma-separated). Allowed values: production, de- + velopment, sandbox --project-business-criticality=BUSINESS_CRITICALITY[,BUSINESS_CRITICAL- ITY]...> - (only in monitor command) Set the project business criticality - to one or more values (comma-separated). Allowed values: criti- + (only in monitor command) Set the project business criticality + to one or more values (comma-separated). Allowed values: criti- cal, 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). + (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]...> @@ -132,10 +132,10 @@ --json 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 + (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 @@ -143,9 +143,9 @@ --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 + 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 + 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 @@ -154,16 +154,16 @@ --fail-on=all|upgradable|patchable Only fail when there are vulnerabilities that can be fixed. - all fails when there is at least one vulnerability that can be - either upgraded or patched. upgradable fails when there is at - least one vulnerability that can be upgraded. patchable fails + all fails when there is at least one vulnerability that can be + either upgraded or patched. upgradable fails when there is at + least one vulnerability that can be upgraded. patchable fails when there is at least one vulnerability that can be patched. - If vulnerabilities do not have a fix and this option is being + If vulnerabilities do not have a fix and this option is being used, tests will pass. --dry-run - (only in protect command) Don't apply updates or patches during + (only in protect command) Don't apply updates or patches during protect command run. -- [COMPILER_OPTIONS] @@ -175,17 +175,17 @@ Maven options --scan-all-unmanaged - Auto detects maven jars, aars, and wars in given directory. - Individual testing can be done with --file=JAR_FILE_NAME + Auto detects maven jars, aars, and wars in given directory. In- + dividual testing can be done with --file=JAR_FILE_NAME --reachable - (only in test and monitor commands) Analyze your source code to + (only in test and monitor commands) Analyze your source code to find which vulnerable functions and packages are called. --reachable-timeout=TIMEOUT - The amount of time (in seconds) to wait for Snyk to gather - reachability data. If it takes longer than TIMEOUT, Reachable - Vulnerabilities are not reported. This does not affect regular + The amount of time (in seconds) to wait for Snyk to gather + reachability data. If it takes longer than TIMEOUT, Reachable + Vulnerabilities are not reported. This does not affect regular test or monitor output. Default: 300 (5 minutes). @@ -193,49 +193,49 @@ Gradle options More information about Gradle CLI options https://snyk.co/ucT6P - O --sub-project=NAME, --gradle-sub-project=NAME: For Gradle "multi + O --sub-project=NAME, --gradle-sub-project=NAME: For Gradle "multi project" configurations, test a specific sub-project. - O --all-sub-projects: For "multi project" configurations, test all + O --all-sub-projects: For "multi project" configurations, test all sub-projects. - O --configuration-matching=CONFIGURATION_REGEX: Resolve dependencies - using only configuration(s) that match the provided Java regular + O --configuration-matching=CONFIGURATION_REGEX: Resolve dependencies + using only configuration(s) that match the provided Java regular expression, e.g. ^releaseRuntimeClasspath$. O --configuration-attributes=ATTRIBUTE[,ATTRIBUTE]...: Select certain - values of configuration attributes to resolve the dependencies. + values of configuration attributes to resolve the dependencies. E.g. buildtype:release,usage:java-runtime - O --reachable: (only in test and monitor commands) Analyze your - source code to find which vulnerable functions and packages are + O --reachable: (only in test and monitor commands) Analyze your + source code to find which vulnerable functions and packages are called. - O --reachable-timeout=TIMEOUT: The amount of time (in seconds) to - wait for Snyk to gather reachability data. If it takes longer than - TIMEOUT, Reachable Vulnerabilities are not reported. This does not + O --reachable-timeout=TIMEOUT: The amount of time (in seconds) to + wait for Snyk to gather reachability data. If it takes longer than + TIMEOUT, Reachable Vulnerabilities are not reported. This does not affect regular test or monitor output. Default: 300 (5 minutes). - O --init-script=FILE For projects that contain a gradle initializa- + O --init-script=FILE For projects that contain a gradle initializa- tion script. .Net & NuGet options --assets-project-name - When monitoring a .NET project using NuGet PackageReference use + When monitoring a .NET project using NuGet PackageReference use the project name in project.assets.json, if found. --packages-folder Custom path to packages folder --project-name-prefix=PREFIX_STRING - When monitoring a .NET project, use this flag to add a custom - prefix to the name of files inside a project along with any - desired separators, e.g. snyk monitor --file=my-project.sln - --project-name-prefix=my-group/. This is useful when you have + When monitoring a .NET project, use this flag to add a custom + prefix to the name of files inside a project along with any de- + sired separators, e.g. snyk monitor --file=my-project.sln + --project-name-prefix=my-group/. This is useful when you have multiple projects with the same name in other sln files. npm options @@ -251,9 +251,9 @@ 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 + (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 @@ -264,11 +264,11 @@ Python options --command=COMMAND - Indicate which specific Python commands to use based on Python - version. The default is python which executes your systems - default python version. Run 'python -V' to find out what version - is it. If you are using multiple Python versions, use this - parameter to specify the correct Python command for execution. + Indicate which specific Python commands to use based on Python + version. The default is python which executes your systems de- + fault python version. Run 'python -V' to find out what version + is it. If you are using multiple Python versions, use this pa- + rameter to specify the correct Python command for execution. Default: python Example: --command=python3 @@ -288,8 +288,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: @@ -303,7 +303,7 @@ You can set these environment variables to change CLI run settings. SNYK_TOKEN - Snyk authorization token. Setting this envvar will override the + 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 @@ -311,47 +311,47 @@ SNYK_CFG_KEY - Allows you to override any key that's also available as snyk + 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 con- fig with "myorg". SNYK_REGISTRY_USERNAME - Specify a username to use when connecting to a container reg- - istry. Note that using the --username flag will override this - value. This will be ignored in favour of local Docker binary + Specify a username to use when connecting to a container reg- + istry. 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 reg- - istry. Note that using the --password flag will override this - value. This will be ignored in favour of local Docker binary + Specify a password to use when connecting to a container reg- + istry. 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 + 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_PROTO- + will upgrade the requests to https. Unless SNYK_HTTP_PROTO- COL_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., + 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 + 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 pack- - age or otherwise, is subject to the terms & conditions + The use of Snyk's API, whether through the use of the 'snyk' npm pack- + age or otherwise, is subject to the terms & conditions https://snyk.co/ucT6N diff --git a/help/commands-txt/snyk-policy.txt b/help/commands-txt/snyk-policy.txt index 0b2ad0b32c..3927090688 100644 --- a/help/commands-txt/snyk-policy.txt +++ b/help/commands-txt/snyk-policy.txt @@ -24,8 +24,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-protect.txt b/help/commands-txt/snyk-protect.txt index 2dbbaba26d..0a4a5ba11f 100644 --- a/help/commands-txt/snyk-protect.txt +++ b/help/commands-txt/snyk-protect.txt @@ -28,8 +28,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-test.txt b/help/commands-txt/snyk-test.txt index eb26d5b822..b74d30b08b 100644 --- a/help/commands-txt/snyk-test.txt +++ b/help/commands-txt/snyk-test.txt @@ -26,42 +26,42 @@ Default: 4 (the current working directory and 3 sub-directories) --exclude=DIRECTORY[,DIRECTORY]...> - (only in test and monitor commands) Can be used with + (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 + 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 vulner- - abilities, but potentially not all of the vulnerable paths. + (only in test and monitor commands) Prune dependency trees, re- + moving duplicate sub-dependencies. Will still find all vulnera- + bilities, but potentially not all of the vulnerable paths. --print-deps - (only in test and monitor commands) Print the dependency tree + (only in test and monitor commands) Print the dependency tree before sending it for analysis. --remote-repo-url=URL Set or override the remote URL for the repository that you would like to monitor. - --dev Include development-only dependencies. Applicable only for some - package managers. E.g. devDependencies in npm or :development + --dev Include development-only dependencies. Applicable only for some + package managers. E.g. devDependencies in npm or :development dependencies in Gemfile. Default: scan only production dependencies --org=ORG_NAME - Specify the ORG_NAME to run Snyk commands tied to a specific - organization. This will influence where will new projects be - created after running monitor command, some features availabil- - ity and private tests limits. If you have multiple organiza- - tions, you can set a default from the CLI using: + Specify the ORG_NAME to run Snyk commands tied to a specific or- + ganization. This will influence where will new projects be cre- + ated after running monitor command, some features availability + and private tests limits. If you have multiple organizations, + you can set a default from the CLI using: $ snyk config set org=ORG_NAME - Setting a default will ensure all newly monitored projects will + Setting a default will ensure all newly monitored projects will be created under your default organization. If you need to over- ride the default, you can use the --org=ORG_NAME argument. @@ -71,23 +71,23 @@ --file=FILE Sets a package file. - When testing locally or monitoring a project, you can specify - the file that Snyk should inspect for package information. When - ommitted Snyk will try to detect the appropriate file for your + When testing locally or monitoring a project, you can specify + the file that Snyk should inspect for package information. When + ommitted Snyk will try to detect the appropriate file for your project. --ignore-policy - Ignores all set policies. The current policy in .snyk file, Org + Ignores all set policies. The current policy in .snyk file, Org level ignores and the project policy on snyk.io. --trust-policies Applies and uses ignore rules from your dependencies' Snyk poli- - cies, otherwise ignore policies are only shown as a suggestion. + cies, otherwise ignore policies are only shown as a suggestion. --show-vulnerable-paths=none|some|all Display the dependency paths from the top level dependencies, - down to the vulnerable packages. Doesn't affect output when - using JSON --json output. + down to the vulnerable packages. Doesn't affect output when us- + ing JSON --json output. Default: some (a few example paths shown) false is an alias for none. @@ -96,10 +96,10 @@ Specify a custom Snyk project name. --target-reference=TARGET_REFERENCE - 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 informa- - tion https://snyk.info/3B0vTPs. + 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 in- + formation https://snyk.info/3B0vTPs. --project-environment=ENVIRONMENT[,ENVIRONMENT]...> (only in monitor command) Set the project environment to one or @@ -109,18 +109,18 @@ --project-lifecycle=LIFECYCLE[,LIFECYCLE]...> (only in monitor command) Set the project lifecycle to one or - more values (comma-separated). Allowed values: production, - development, sandbox + more values (comma-separated). Allowed values: production, de- + velopment, sandbox --project-business-criticality=BUSINESS_CRITICALITY[,BUSINESS_CRITICAL- ITY]...> - (only in monitor command) Set the project business criticality - to one or more values (comma-separated). Allowed values: criti- + (only in monitor command) Set the project business criticality + to one or more values (comma-separated). Allowed values: criti- cal, 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). + (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]...> @@ -132,10 +132,10 @@ --json 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 + (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 @@ -143,9 +143,9 @@ --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 + 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 + 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 @@ -154,16 +154,16 @@ --fail-on=all|upgradable|patchable Only fail when there are vulnerabilities that can be fixed. - all fails when there is at least one vulnerability that can be - either upgraded or patched. upgradable fails when there is at - least one vulnerability that can be upgraded. patchable fails + all fails when there is at least one vulnerability that can be + either upgraded or patched. upgradable fails when there is at + least one vulnerability that can be upgraded. patchable fails when there is at least one vulnerability that can be patched. - If vulnerabilities do not have a fix and this option is being + If vulnerabilities do not have a fix and this option is being used, tests will pass. --dry-run - (only in protect command) Don't apply updates or patches during + (only in protect command) Don't apply updates or patches during protect command run. -- [COMPILER_OPTIONS] @@ -175,17 +175,17 @@ Maven options --scan-all-unmanaged - Auto detects maven jars, aars, and wars in given directory. - Individual testing can be done with --file=JAR_FILE_NAME + Auto detects maven jars, aars, and wars in given directory. In- + dividual testing can be done with --file=JAR_FILE_NAME --reachable - (only in test and monitor commands) Analyze your source code to + (only in test and monitor commands) Analyze your source code to find which vulnerable functions and packages are called. --reachable-timeout=TIMEOUT - The amount of time (in seconds) to wait for Snyk to gather - reachability data. If it takes longer than TIMEOUT, Reachable - Vulnerabilities are not reported. This does not affect regular + The amount of time (in seconds) to wait for Snyk to gather + reachability data. If it takes longer than TIMEOUT, Reachable + Vulnerabilities are not reported. This does not affect regular test or monitor output. Default: 300 (5 minutes). @@ -193,49 +193,49 @@ Gradle options More information about Gradle CLI options https://snyk.co/ucT6P - O --sub-project=NAME, --gradle-sub-project=NAME: For Gradle "multi + O --sub-project=NAME, --gradle-sub-project=NAME: For Gradle "multi project" configurations, test a specific sub-project. - O --all-sub-projects: For "multi project" configurations, test all + O --all-sub-projects: For "multi project" configurations, test all sub-projects. - O --configuration-matching=CONFIGURATION_REGEX: Resolve dependencies - using only configuration(s) that match the provided Java regular + O --configuration-matching=CONFIGURATION_REGEX: Resolve dependencies + using only configuration(s) that match the provided Java regular expression, e.g. ^releaseRuntimeClasspath$. O --configuration-attributes=ATTRIBUTE[,ATTRIBUTE]...: Select certain - values of configuration attributes to resolve the dependencies. + values of configuration attributes to resolve the dependencies. E.g. buildtype:release,usage:java-runtime - O --reachable: (only in test and monitor commands) Analyze your - source code to find which vulnerable functions and packages are + O --reachable: (only in test and monitor commands) Analyze your + source code to find which vulnerable functions and packages are called. - O --reachable-timeout=TIMEOUT: The amount of time (in seconds) to - wait for Snyk to gather reachability data. If it takes longer than - TIMEOUT, Reachable Vulnerabilities are not reported. This does not + O --reachable-timeout=TIMEOUT: The amount of time (in seconds) to + wait for Snyk to gather reachability data. If it takes longer than + TIMEOUT, Reachable Vulnerabilities are not reported. This does not affect regular test or monitor output. Default: 300 (5 minutes). - O --init-script=FILE For projects that contain a gradle initializa- + O --init-script=FILE For projects that contain a gradle initializa- tion script. .Net & NuGet options --assets-project-name - When monitoring a .NET project using NuGet PackageReference use + When monitoring a .NET project using NuGet PackageReference use the project name in project.assets.json, if found. --packages-folder Custom path to packages folder --project-name-prefix=PREFIX_STRING - When monitoring a .NET project, use this flag to add a custom - prefix to the name of files inside a project along with any - desired separators, e.g. snyk monitor --file=my-project.sln - --project-name-prefix=my-group/. This is useful when you have + When monitoring a .NET project, use this flag to add a custom + prefix to the name of files inside a project along with any de- + sired separators, e.g. snyk monitor --file=my-project.sln + --project-name-prefix=my-group/. This is useful when you have multiple projects with the same name in other sln files. npm options @@ -251,9 +251,9 @@ 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 + (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 @@ -264,11 +264,11 @@ Python options --command=COMMAND - Indicate which specific Python commands to use based on Python - version. The default is python which executes your systems - default python version. Run 'python -V' to find out what version - is it. If you are using multiple Python versions, use this - parameter to specify the correct Python command for execution. + Indicate which specific Python commands to use based on Python + version. The default is python which executes your systems de- + fault python version. Run 'python -V' to find out what version + is it. If you are using multiple Python versions, use this pa- + rameter to specify the correct Python command for execution. Default: python Example: --command=python3 @@ -288,8 +288,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: @@ -303,7 +303,7 @@ You can set these environment variables to change CLI run settings. SNYK_TOKEN - Snyk authorization token. Setting this envvar will override the + 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 @@ -311,47 +311,47 @@ SNYK_CFG_KEY - Allows you to override any key that's also available as snyk + 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 con- fig with "myorg". SNYK_REGISTRY_USERNAME - Specify a username to use when connecting to a container reg- - istry. Note that using the --username flag will override this - value. This will be ignored in favour of local Docker binary + Specify a username to use when connecting to a container reg- + istry. 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 reg- - istry. Note that using the --password flag will override this - value. This will be ignored in favour of local Docker binary + Specify a password to use when connecting to a container reg- + istry. 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 + 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_PROTO- + will upgrade the requests to https. Unless SNYK_HTTP_PROTO- COL_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., + 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 + 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 pack- - age or otherwise, is subject to the terms & conditions + The use of Snyk's API, whether through the use of the 'snyk' npm pack- + age or otherwise, is subject to the terms & conditions https://snyk.co/ucT6N diff --git a/help/commands-txt/snyk-wizard.txt b/help/commands-txt/snyk-wizard.txt index 520f530ac4..474d04ca27 100644 --- a/help/commands-txt/snyk-wizard.txt +++ b/help/commands-txt/snyk-wizard.txt @@ -1,6 +1,6 @@ NAME - snyk-wizard - Configure your policy file to update, auto patch and - ignore vulnerabilities + snyk-wizard - Configure your policy file to update, auto patch and ig- + nore vulnerabilities SYNOPSIS snyk wizard [OPTIONS] @@ -35,8 +35,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk-woof.txt b/help/commands-txt/snyk-woof.txt index c201ca8b0b..ec88016e9d 100644 --- a/help/commands-txt/snyk-woof.txt +++ b/help/commands-txt/snyk-woof.txt @@ -25,8 +25,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXIT CODES Possible exit codes and their meaning: diff --git a/help/commands-txt/snyk.txt b/help/commands-txt/snyk.txt index 4c156012da..80edb26d10 100644 --- a/help/commands-txt/snyk.txt +++ b/help/commands-txt/snyk.txt @@ -71,42 +71,42 @@ Default: 4 (the current working directory and 3 sub-directories) --exclude=DIRECTORY[,DIRECTORY]...> - (only in test and monitor commands) Can be used with + (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 + 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 vulner- - abilities, but potentially not all of the vulnerable paths. + (only in test and monitor commands) Prune dependency trees, re- + moving duplicate sub-dependencies. Will still find all vulnera- + bilities, but potentially not all of the vulnerable paths. --print-deps - (only in test and monitor commands) Print the dependency tree + (only in test and monitor commands) Print the dependency tree before sending it for analysis. --remote-repo-url=URL Set or override the remote URL for the repository that you would like to monitor. - --dev Include development-only dependencies. Applicable only for some - package managers. E.g. devDependencies in npm or :development + --dev Include development-only dependencies. Applicable only for some + package managers. E.g. devDependencies in npm or :development dependencies in Gemfile. Default: scan only production dependencies --org=ORG_NAME - Specify the ORG_NAME to run Snyk commands tied to a specific - organization. This will influence where will new projects be - created after running monitor command, some features availabil- - ity and private tests limits. If you have multiple organiza- - tions, you can set a default from the CLI using: + Specify the ORG_NAME to run Snyk commands tied to a specific or- + ganization. This will influence where will new projects be cre- + ated after running monitor command, some features availability + and private tests limits. If you have multiple organizations, + you can set a default from the CLI using: $ snyk config set org=ORG_NAME - Setting a default will ensure all newly monitored projects will + Setting a default will ensure all newly monitored projects will be created under your default organization. If you need to over- ride the default, you can use the --org=ORG_NAME argument. @@ -116,23 +116,23 @@ --file=FILE Sets a package file. - When testing locally or monitoring a project, you can specify - the file that Snyk should inspect for package information. When - ommitted Snyk will try to detect the appropriate file for your + When testing locally or monitoring a project, you can specify + the file that Snyk should inspect for package information. When + ommitted Snyk will try to detect the appropriate file for your project. --ignore-policy - Ignores all set policies. The current policy in .snyk file, Org + Ignores all set policies. The current policy in .snyk file, Org level ignores and the project policy on snyk.io. --trust-policies Applies and uses ignore rules from your dependencies' Snyk poli- - cies, otherwise ignore policies are only shown as a suggestion. + cies, otherwise ignore policies are only shown as a suggestion. --show-vulnerable-paths=none|some|all Display the dependency paths from the top level dependencies, - down to the vulnerable packages. Doesn't affect output when - using JSON --json output. + down to the vulnerable packages. Doesn't affect output when us- + ing JSON --json output. Default: some (a few example paths shown) false is an alias for none. @@ -141,10 +141,10 @@ Specify a custom Snyk project name. --target-reference=TARGET_REFERENCE - 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 informa- - tion https://snyk.info/3B0vTPs. + 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 in- + formation https://snyk.info/3B0vTPs. --project-environment=ENVIRONMENT[,ENVIRONMENT]...> (only in monitor command) Set the project environment to one or @@ -154,18 +154,18 @@ --project-lifecycle=LIFECYCLE[,LIFECYCLE]...> (only in monitor command) Set the project lifecycle to one or - more values (comma-separated). Allowed values: production, - development, sandbox + more values (comma-separated). Allowed values: production, de- + velopment, sandbox --project-business-criticality=BUSINESS_CRITICALITY[,BUSINESS_CRITICAL- ITY]...> - (only in monitor command) Set the project business criticality - to one or more values (comma-separated). Allowed values: criti- + (only in monitor command) Set the project business criticality + to one or more values (comma-separated). Allowed values: criti- cal, 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). + (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]...> @@ -177,10 +177,10 @@ --json 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 + (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 @@ -188,9 +188,9 @@ --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 + 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 + 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 @@ -199,16 +199,16 @@ --fail-on=all|upgradable|patchable Only fail when there are vulnerabilities that can be fixed. - all fails when there is at least one vulnerability that can be - either upgraded or patched. upgradable fails when there is at - least one vulnerability that can be upgraded. patchable fails + all fails when there is at least one vulnerability that can be + either upgraded or patched. upgradable fails when there is at + least one vulnerability that can be upgraded. patchable fails when there is at least one vulnerability that can be patched. - If vulnerabilities do not have a fix and this option is being + If vulnerabilities do not have a fix and this option is being used, tests will pass. --dry-run - (only in protect command) Don't apply updates or patches during + (only in protect command) Don't apply updates or patches during protect command run. -- [COMPILER_OPTIONS] @@ -220,17 +220,17 @@ Maven options --scan-all-unmanaged - Auto detects maven jars, aars, and wars in given directory. - Individual testing can be done with --file=JAR_FILE_NAME + Auto detects maven jars, aars, and wars in given directory. In- + dividual testing can be done with --file=JAR_FILE_NAME --reachable - (only in test and monitor commands) Analyze your source code to + (only in test and monitor commands) Analyze your source code to find which vulnerable functions and packages are called. --reachable-timeout=TIMEOUT - The amount of time (in seconds) to wait for Snyk to gather - reachability data. If it takes longer than TIMEOUT, Reachable - Vulnerabilities are not reported. This does not affect regular + The amount of time (in seconds) to wait for Snyk to gather + reachability data. If it takes longer than TIMEOUT, Reachable + Vulnerabilities are not reported. This does not affect regular test or monitor output. Default: 300 (5 minutes). @@ -238,49 +238,49 @@ Gradle options More information about Gradle CLI options https://snyk.co/ucT6P - O --sub-project=NAME, --gradle-sub-project=NAME: For Gradle "multi + O --sub-project=NAME, --gradle-sub-project=NAME: For Gradle "multi project" configurations, test a specific sub-project. - O --all-sub-projects: For "multi project" configurations, test all + O --all-sub-projects: For "multi project" configurations, test all sub-projects. - O --configuration-matching=CONFIGURATION_REGEX: Resolve dependencies - using only configuration(s) that match the provided Java regular + O --configuration-matching=CONFIGURATION_REGEX: Resolve dependencies + using only configuration(s) that match the provided Java regular expression, e.g. ^releaseRuntimeClasspath$. O --configuration-attributes=ATTRIBUTE[,ATTRIBUTE]...: Select certain - values of configuration attributes to resolve the dependencies. + values of configuration attributes to resolve the dependencies. E.g. buildtype:release,usage:java-runtime - O --reachable: (only in test and monitor commands) Analyze your - source code to find which vulnerable functions and packages are + O --reachable: (only in test and monitor commands) Analyze your + source code to find which vulnerable functions and packages are called. - O --reachable-timeout=TIMEOUT: The amount of time (in seconds) to - wait for Snyk to gather reachability data. If it takes longer than - TIMEOUT, Reachable Vulnerabilities are not reported. This does not + O --reachable-timeout=TIMEOUT: The amount of time (in seconds) to + wait for Snyk to gather reachability data. If it takes longer than + TIMEOUT, Reachable Vulnerabilities are not reported. This does not affect regular test or monitor output. Default: 300 (5 minutes). - O --init-script=FILE For projects that contain a gradle initializa- + O --init-script=FILE For projects that contain a gradle initializa- tion script. .Net & NuGet options --assets-project-name - When monitoring a .NET project using NuGet PackageReference use + When monitoring a .NET project using NuGet PackageReference use the project name in project.assets.json, if found. --packages-folder Custom path to packages folder --project-name-prefix=PREFIX_STRING - When monitoring a .NET project, use this flag to add a custom - prefix to the name of files inside a project along with any - desired separators, e.g. snyk monitor --file=my-project.sln - --project-name-prefix=my-group/. This is useful when you have + When monitoring a .NET project, use this flag to add a custom + prefix to the name of files inside a project along with any de- + sired separators, e.g. snyk monitor --file=my-project.sln + --project-name-prefix=my-group/. This is useful when you have multiple projects with the same name in other sln files. npm options @@ -296,9 +296,9 @@ 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 + (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 @@ -309,11 +309,11 @@ Python options --command=COMMAND - Indicate which specific Python commands to use based on Python - version. The default is python which executes your systems - default python version. Run 'python -V' to find out what version - is it. If you are using multiple Python versions, use this - parameter to specify the correct Python command for execution. + Indicate which specific Python commands to use based on Python + version. The default is python which executes your systems de- + fault python version. Run 'python -V' to find out what version + is it. If you are using multiple Python versions, use this pa- + rameter to specify the correct Python command for execution. Default: python Example: --command=python3 @@ -333,8 +333,8 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more - details. + Prints a help text. You may specify a COMMAND to get more de- + tails. EXAMPLES Authenticate in your CI without user interaction @@ -376,10 +376,10 @@ - To use your own custom rules to scan IaC configuration files, download + To use your own custom rules to scan IaC configuration files, download the snyk-iac-rules SDK from https://github.com/snyk/snyk-iac-rules. - Follow the instructions there to write, build, and push a custom rules - bundle and then either use the Snyk UI to configure your custom rules + Follow the instructions there to write, build, and push a custom rules + bundle and then either use the Snyk UI to configure your custom rules settings or configure a remote OCI registry locally by running the fol- lowing commands: @@ -410,7 +410,7 @@ You can set these environment variables to change CLI run settings. SNYK_TOKEN - Snyk authorization token. Setting this envvar will override the + 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 @@ -418,47 +418,47 @@ SNYK_CFG_KEY - Allows you to override any key that's also available as snyk + 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 con- fig with "myorg". SNYK_REGISTRY_USERNAME - Specify a username to use when connecting to a container reg- - istry. Note that using the --username flag will override this - value. This will be ignored in favour of local Docker binary + Specify a username to use when connecting to a container reg- + istry. 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 reg- - istry. Note that using the --password flag will override this - value. This will be ignored in favour of local Docker binary + Specify a password to use when connecting to a container reg- + istry. 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 + 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_PROTO- + will upgrade the requests to https. Unless SNYK_HTTP_PROTO- COL_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., + 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 + 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 pack- - age or otherwise, is subject to the terms & conditions + The use of Snyk's API, whether through the use of the 'snyk' npm pack- + age or otherwise, is subject to the terms & conditions https://snyk.co/ucT6N