From b544723b0d6bccb633657442bd6bb8f01d79b686 Mon Sep 17 00:00:00 2001 From: Jahed Ahmed Date: Wed, 29 Sep 2021 18:15:10 +0000 Subject: [PATCH 1/3] chore: fix doc generator portability --- help/generator/generator.ts | 55 +++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 26 deletions(-) diff --git a/help/generator/generator.ts b/help/generator/generator.ts index 99ae52478d..232d0fb932 100644 --- a/help/generator/generator.ts +++ b/help/generator/generator.ts @@ -1,6 +1,6 @@ import * as path from 'path'; import * as fs from 'fs'; -import { exec } from 'child_process'; +import { runCommand } from '../../test/jest/util/runCommand'; const RONN_COMMAND = process.env.RONN_COMMAND || 'ronn'; const COMMANDS: Record = { @@ -23,35 +23,43 @@ const COMMANDS: Record = { woof: {}, }; -const GENERATED_MARKDOWN_FOLDER = './help/commands-md'; -const GENERATED_MAN_FOLDER = './help/commands-man'; -const GENERATED_TXT_FOLDER = './help/commands-txt'; +const MARKDOWN_DIR = path.resolve(__dirname, '../commands-md'); +const MAN_DIR = path.resolve(__dirname, '../commands-man'); +const TXT_DIR = path.resolve(__dirname, '../commands-txt'); -function execShellCommand(cmd): Promise { - return new Promise((resolve) => { - exec(cmd, (error, stdout, stderr) => { - if (error) { - console.warn(error); - } - return resolve(stdout ? stdout : stderr); - }); +async function execShellCommand(cmd: string, args: string[]): Promise { + const { code, stdout, stderr } = await runCommand(cmd, args, { + env: { + ...process.env, + PAGER: 'more', // see https://github.com/apjanke/ronn-ng/issues/71 + }, }); + if (stderr) { + console.error(stderr); + } + if (code !== 0) { + throw new Error('Command exiting with non-zero exit code.'); + } + return stdout; } async function generateRoff(inputFile): Promise { - return await execShellCommand( - `cat ${inputFile} | ${RONN_COMMAND} --roff --pipe --organization=Snyk.io`, - ); + return await execShellCommand(RONN_COMMAND, [ + '--roff', + '--pipe', + '--organization=Snyk.io', + inputFile, + ]); } -async function printRoff2Txt(inputFile) { - return await execShellCommand(`cat ${inputFile} | ${RONN_COMMAND} -m`); +async function printRoff2Txt(inputFile): Promise { + return await execShellCommand(RONN_COMMAND, ['-m', inputFile]); } async function processMarkdown(markdownDoc, commandName) { - const markdownFilePath = `${GENERATED_MARKDOWN_FOLDER}/${commandName}.md`; - const roffFilePath = `${GENERATED_MAN_FOLDER}/${commandName}.1`; - const txtFilePath = `${GENERATED_TXT_FOLDER}/${commandName}.txt`; + const markdownFilePath = path.resolve(MARKDOWN_DIR, `${commandName}.md`); + const roffFilePath = path.resolve(MAN_DIR, `${commandName}.1`); + const txtFilePath = path.resolve(TXT_DIR, `${commandName}.txt`); console.info(`Generating markdown version ${commandName}.md`); fs.writeFileSync(markdownFilePath, markdownDoc); @@ -74,18 +82,13 @@ async function processMarkdown(markdownDoc, commandName) { .split('\n') .slice(4, -4) .join('\n'); - console.log(formattedTxtDoc); fs.writeFileSync(txtFilePath, formattedTxtDoc); } async function run() { // Ensure folders exists - [ - GENERATED_MAN_FOLDER, - GENERATED_MARKDOWN_FOLDER, - GENERATED_TXT_FOLDER, - ].forEach((path) => { + [MAN_DIR, MARKDOWN_DIR, TXT_DIR].forEach((path) => { if (!fs.existsSync(path)) { fs.mkdirSync(path); } From cd87bf7ee9a1d373e6fa4f925709b9934d25d1e5 Mon Sep 17 00:00:00 2001 From: Jahed Ahmed Date: Wed, 29 Sep 2021 16:25:22 +0000 Subject: [PATCH 2/3] chore: regenerate docs --- help/commands-man/snyk-auth.1 | 8 ++++---- help/commands-man/snyk-code.1 | 6 +++--- help/commands-man/snyk-config.1 | 10 +++++----- help/commands-man/snyk-container.1 | 10 +++++----- help/commands-man/snyk-help.1 | 8 ++++---- help/commands-man/snyk-iac.1 | 8 ++++---- help/commands-man/snyk-ignore.1 | 12 ++++++------ help/commands-man/snyk-monitor.1 | 16 ++++++++-------- help/commands-man/snyk-policy.1 | 8 ++++---- help/commands-man/snyk-protect.1 | 12 ++++++------ help/commands-man/snyk-test.1 | 16 ++++++++-------- help/commands-man/snyk-wizard.1 | 12 ++++++------ help/commands-man/snyk-woof.1 | 8 ++++---- help/commands-man/snyk.1 | 14 +++++++------- 14 files changed, 74 insertions(+), 74 deletions(-) diff --git a/help/commands-man/snyk-auth.1 b/help/commands-man/snyk-auth.1 index 80d84cbf7d..5d1f5bd8cc 100644 --- a/help/commands-man/snyk-auth.1 +++ b/help/commands-man/snyk-auth.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-AUTH" "1" "August 2021" "Snyk.io" +.TH "SNYK\-AUTH" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-auth\fR \- Authenticate Snyk CLI with a Snyk account .SH "SYNOPSIS" @@ -59,7 +59,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR .TP \fBSNYK_CFG_KEY\fR -Allows you to override any key that\'s also available as \fBsnyk config\fR option\. +Allows you to override any key that's also available as \fBsnyk config\fR option\. .IP E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\. .TP @@ -78,7 +78,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\. .TP \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR -Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\. +Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\. .SH "NOTICES" .SS "Snyk API usage policy" -The use of Snyk\'s API, whether through the use of the \'snyk\' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR +The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR diff --git a/help/commands-man/snyk-code.1 b/help/commands-man/snyk-code.1 index 5f8bcb9873..2124ef2e7e 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 5cc44eef5d..0e630ea0bc 100644 --- a/help/commands-man/snyk-config.1 +++ b/help/commands-man/snyk-config.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-CONFIG" "1" "August 2021" "Snyk.io" +.TH "SNYK\-CONFIG" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-config\fR \- Manage Snyk CLI configuration .SH "SYNOPSIS" @@ -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 @@ -73,7 +73,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR .TP \fBSNYK_CFG_KEY\fR -Allows you to override any key that\'s also available as \fBsnyk config\fR option\. +Allows you to override any key that's also available as \fBsnyk config\fR option\. .IP E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\. .TP @@ -92,7 +92,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\. .TP \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR -Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\. +Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\. .SH "NOTICES" .SS "Snyk API usage policy" -The use of Snyk\'s API, whether through the use of the \'snyk\' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR +The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR diff --git a/help/commands-man/snyk-container.1 b/help/commands-man/snyk-container.1 index f360cc26fc..085706e842 100644 --- a/help/commands-man/snyk-container.1 +++ b/help/commands-man/snyk-container.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-CONTAINER" "1" "August 2021" "Snyk.io" +.TH "SNYK\-CONTAINER" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-container\fR \- Test container images for vulnerabilities .SH "SYNOPSIS" @@ -20,7 +20,7 @@ Record the state of dependencies and any vulnerabilities on snyk\.io\. Exclude from display base image vulnerabilities\. .TP \fB\-\-file\fR=\fIFILE_PATH\fR -Include the path to the image\'s Dockerfile for more detailed advice\. +Include the path to the image's Dockerfile for more detailed advice\. .TP \fB\-\-platform\fR=\fIPLATFORM\fR For multi\-architecture images, specify the platform to test\. [linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7 or linux/arm/v6] @@ -94,7 +94,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR .TP \fBSNYK_CFG_KEY\fR -Allows you to override any key that\'s also available as \fBsnyk config\fR option\. +Allows you to override any key that's also available as \fBsnyk config\fR option\. .IP E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\. .TP @@ -113,7 +113,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\. .TP \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR -Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\. +Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\. .SH "NOTICES" .SS "Snyk API usage policy" -The use of Snyk\'s API, whether through the use of the \'snyk\' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR +The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR diff --git a/help/commands-man/snyk-help.1 b/help/commands-man/snyk-help.1 index f825fcf116..07da0aae6f 100644 --- a/help/commands-man/snyk-help.1 +++ b/help/commands-man/snyk-help.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-HELP" "1" "August 2021" "Snyk.io" +.TH "SNYK\-HELP" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-help\fR \- Prints help topics .SH "SYNOPSIS" @@ -48,7 +48,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR .TP \fBSNYK_CFG_KEY\fR -Allows you to override any key that\'s also available as \fBsnyk config\fR option\. +Allows you to override any key that's also available as \fBsnyk config\fR option\. .IP E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\. .TP @@ -67,7 +67,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\. .TP \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR -Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\. +Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\. .SH "NOTICES" .SS "Snyk API usage policy" -The use of Snyk\'s API, whether through the use of the \'snyk\' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR +The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR diff --git a/help/commands-man/snyk-iac.1 b/help/commands-man/snyk-iac.1 index bf1cf0c0da..827389a472 100644 --- a/help/commands-man/snyk-iac.1 +++ b/help/commands-man/snyk-iac.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-IAC" "1" "August 2021" "Snyk.io" +.TH "SNYK\-IAC" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-iac\fR \- Find security issues in your Infrastructure as Code files .SH "SYNOPSIS" @@ -119,7 +119,7 @@ How to use Service Accounts \fIhttps://snyk\.co/ucT6L\fR .TP \fBSNYK_CFG_KEY\fR -Allows you to override any key that\'s also available as \fBsnyk config\fR option\. +Allows you to override any key that's also available as \fBsnyk config\fR option\. .IP E\.g\. \fBSNYK_CFG_ORG\fR=myorg will override default org option in \fBconfig\fR with "myorg"\. .TP @@ -138,7 +138,7 @@ Sets API host to use for Snyk requests\. Useful for on\-premise instances and co If set to the value of \fB0\fR, API requests aimed at \fBhttp\fR URLs will not be upgraded to \fBhttps\fR\. If not set, the default behavior will be to upgrade these requests from \fBhttp\fR to \fBhttps\fR\. Useful e\.g\., for reverse proxies\. .TP \fBHTTPS_PROXY\fR and \fBHTTP_PROXY\fR -Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn\'t need to use \fBhttps\fR\. +Allows you to specify a proxy to use for \fBhttps\fR and \fBhttp\fR calls\. The \fBhttps\fR in the \fBHTTPS_PROXY\fR means that \fIrequests using \fBhttps\fR protocol\fR will use this proxy\. The proxy itself doesn't need to use \fBhttps\fR\. .SH "NOTICES" .SS "Snyk API usage policy" -The use of Snyk\'s API, whether through the use of the \'snyk\' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR +The use of Snyk's API, whether through the use of the 'snyk' npm package or otherwise, is subject to the terms & conditions \fIhttps://snyk\.co/ucT6N\fR diff --git a/help/commands-man/snyk-ignore.1 b/help/commands-man/snyk-ignore.1 index db4d554cff..a7a068ae90 100644 --- a/help/commands-man/snyk-ignore.1 +++ b/help/commands-man/snyk-ignore.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-IGNORE" "1" "August 2021" "Snyk.io" +.TH "SNYK\-IGNORE" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-ignore\fR \- Modifies the \.snyk policy to ignore stated issues .SH "SYNOPSIS" @@ -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 822c3cf9ae..fd79f9962e 100644 --- a/help/commands-man/snyk-monitor.1 +++ b/help/commands-man/snyk-monitor.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-MONITOR" "1" "August 2021" "Snyk.io" +.TH "SNYK\-MONITOR" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-monitor\fR \- Snapshot and continuously monitor your project .SH "SYNOPSIS" @@ -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 @@ -91,7 +91,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 @@ -162,7 +162,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 @@ -208,7 +208,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 @@ -227,7 +227,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 319dc381e4..6a2e5dc27e 100644 --- a/help/commands-man/snyk-policy.1 +++ b/help/commands-man/snyk-policy.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-POLICY" "1" "August 2021" "Snyk.io" +.TH "SNYK\-POLICY" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-policy\fR \- Display the \.snyk policy for a package .SH "SYNOPSIS" @@ -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 91ba1ba7bd..162900945d 100644 --- a/help/commands-man/snyk-protect.1 +++ b/help/commands-man/snyk-protect.1 @@ -1,16 +1,16 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-PROTECT" "1" "August 2021" "Snyk.io" +.TH "SNYK\-PROTECT" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-protect\fR \- Applies the patches specified in your \.snyk file to the local file system .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 21a14361b7..20cb3e5671 100644 --- a/help/commands-man/snyk-test.1 +++ b/help/commands-man/snyk-test.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-TEST" "1" "August 2021" "Snyk.io" +.TH "SNYK\-TEST" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-test\fR \- test local project for vulnerabilities .SH "SYNOPSIS" @@ -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 @@ -91,7 +91,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 @@ -162,7 +162,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 @@ -208,7 +208,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 @@ -227,7 +227,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 edf45e7fd3..57ee79bd5f 100644 --- a/help/commands-man/snyk-wizard.1 +++ b/help/commands-man/snyk-wizard.1 @@ -1,14 +1,14 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-WIZARD" "1" "August 2021" "Snyk.io" +.TH "SNYK\-WIZARD" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-wizard\fR \- Configure your policy file to update, auto patch and ignore vulnerabilities .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 fb888896a0..8a34eaf2c7 100644 --- a/help/commands-man/snyk-woof.1 +++ b/help/commands-man/snyk-woof.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-WOOF" "1" "August 2021" "Snyk.io" +.TH "SNYK\-WOOF" "1" "September 2021" "Snyk.io" .SH "NAME" \fBsnyk\-woof\fR \- W00f .SH "SYNOPSIS" @@ -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 eb5e5faa4b..5b9c3fcc6f 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 @@ -136,7 +136,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 @@ -207,7 +207,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 @@ -297,7 +297,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 @@ -316,7 +316,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 From 0d93f00041ab8b1b709b5ae8f9b38dd61b0c3a01 Mon Sep 17 00:00:00 2001 From: Jahed Ahmed Date: Wed, 29 Sep 2021 16:26:01 +0000 Subject: [PATCH 3/3] docs: add help for --target-reference --- help/commands-docs/_SNYK_COMMAND_OPTIONS.md | 4 + help/commands-man/snyk-monitor.1 | 3 + help/commands-man/snyk-test.1 | 3 + help/commands-man/snyk.1 | 3 + help/commands-md/snyk-monitor.md | 4 + help/commands-md/snyk-test.md | 4 + help/commands-md/snyk.md | 4 + help/commands-txt/snyk-monitor.txt | 122 ++++++++++---------- help/commands-txt/snyk-test.txt | 122 ++++++++++---------- help/commands-txt/snyk.txt | 122 ++++++++++---------- 10 files changed, 217 insertions(+), 174 deletions(-) diff --git a/help/commands-docs/_SNYK_COMMAND_OPTIONS.md b/help/commands-docs/_SNYK_COMMAND_OPTIONS.md index 2d6f664ef9..7f2fe14367 100644 --- a/help/commands-docs/_SNYK_COMMAND_OPTIONS.md +++ b/help/commands-docs/_SNYK_COMMAND_OPTIONS.md @@ -67,6 +67,10 @@ For advanced usage, we offer language and context specific flags, listed further - `--project-name`=: Specify a custom Snyk project name. +- `--target-reference`=: + (only in `monitor` command) + A reference to separate this project from other scans of the same project. For example, a branch name or version. Projects using the same reference can be used for grouping. [More information](https://snyk.info/3B0vTPs). + - `--policy-path`=`: Manually pass a path to a snyk policy file. diff --git a/help/commands-man/snyk-monitor.1 b/help/commands-man/snyk-monitor.1 index fd79f9962e..3f7fc1ce5a 100644 --- a/help/commands-man/snyk-monitor.1 +++ b/help/commands-man/snyk-monitor.1 @@ -65,6 +65,9 @@ Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fIn \fB\-\-project\-name\fR=\fIPROJECT_NAME\fR Specify a custom Snyk project name\. .TP +\fB\-\-target\-reference\fR=\fITARGET_REFERENCE\fR +(only in \fBmonitor\fR command) A reference to separate this project from other scans of the same project\. For example, a branch name or version\. Projects using the same reference can be used for grouping\. More information \fIhttps://snyk\.info/3B0vTPs\fR\. +.TP \fB\-\-policy\-path\fR=\fIPATH_TO_POLICY_FILE\fR` Manually pass a path to a snyk policy file\. .TP diff --git a/help/commands-man/snyk-test.1 b/help/commands-man/snyk-test.1 index 20cb3e5671..6c5dd21607 100644 --- a/help/commands-man/snyk-test.1 +++ b/help/commands-man/snyk-test.1 @@ -65,6 +65,9 @@ Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fIn \fB\-\-project\-name\fR=\fIPROJECT_NAME\fR Specify a custom Snyk project name\. .TP +\fB\-\-target\-reference\fR=\fITARGET_REFERENCE\fR +(only in \fBmonitor\fR command) A reference to separate this project from other scans of the same project\. For example, a branch name or version\. Projects using the same reference can be used for grouping\. More information \fIhttps://snyk\.info/3B0vTPs\fR\. +.TP \fB\-\-policy\-path\fR=\fIPATH_TO_POLICY_FILE\fR` Manually pass a path to a snyk policy file\. .TP diff --git a/help/commands-man/snyk.1 b/help/commands-man/snyk.1 index 5b9c3fcc6f..cc86d0590c 100644 --- a/help/commands-man/snyk.1 +++ b/help/commands-man/snyk.1 @@ -110,6 +110,9 @@ Default: \fIsome\fR (a few example paths shown) \fIfalse\fR is an alias for \fIn \fB\-\-project\-name\fR=\fIPROJECT_NAME\fR Specify a custom Snyk project name\. .TP +\fB\-\-target\-reference\fR=\fITARGET_REFERENCE\fR +(only in \fBmonitor\fR command) A reference to separate this project from other scans of the same project\. For example, a branch name or version\. Projects using the same reference can be used for grouping\. More information \fIhttps://snyk\.info/3B0vTPs\fR\. +.TP \fB\-\-policy\-path\fR=\fIPATH_TO_POLICY_FILE\fR` Manually pass a path to a snyk policy file\. .TP diff --git a/help/commands-md/snyk-monitor.md b/help/commands-md/snyk-monitor.md index 6a70f7c5d6..1d0600f413 100644 --- a/help/commands-md/snyk-monitor.md +++ b/help/commands-md/snyk-monitor.md @@ -78,6 +78,10 @@ For advanced usage, we offer language and context specific flags, listed further - `--project-name`=: Specify a custom Snyk project name. +- `--target-reference`=: + (only in `monitor` command) + A reference to separate this project from other scans of the same project. For example, a branch name or version. Projects using the same reference can be used for grouping. [More information](https://snyk.info/3B0vTPs). + - `--policy-path`=`: Manually pass a path to a snyk policy file. diff --git a/help/commands-md/snyk-test.md b/help/commands-md/snyk-test.md index be13080b5f..8a04e23acf 100644 --- a/help/commands-md/snyk-test.md +++ b/help/commands-md/snyk-test.md @@ -78,6 +78,10 @@ For advanced usage, we offer language and context specific flags, listed further - `--project-name`=: Specify a custom Snyk project name. +- `--target-reference`=: + (only in `monitor` command) + A reference to separate this project from other scans of the same project. For example, a branch name or version. Projects using the same reference can be used for grouping. [More information](https://snyk.info/3B0vTPs). + - `--policy-path`=`: Manually pass a path to a snyk policy file. diff --git a/help/commands-md/snyk.md b/help/commands-md/snyk.md index 8a351c183e..e033b7b775 100644 --- a/help/commands-md/snyk.md +++ b/help/commands-md/snyk.md @@ -123,6 +123,10 @@ For advanced usage, we offer language and context specific flags, listed further - `--project-name`=: Specify a custom Snyk project name. +- `--target-reference`=: + (only in `monitor` command) + A reference to separate this project from other scans of the same project. For example, a branch name or version. Projects using the same reference can be used for grouping. [More information](https://snyk.info/3B0vTPs). + - `--policy-path`=`: Manually pass a path to a snyk policy file. diff --git a/help/commands-txt/snyk-monitor.txt b/help/commands-txt/snyk-monitor.txt index 0de28fa584..98de6109e2 100644 --- a/help/commands-txt/snyk-monitor.txt +++ b/help/commands-txt/snyk-monitor.txt @@ -95,16 +95,22 @@ --project-name=PROJECT_NAME Specify a custom Snyk project name. + --target-reference=TARGET_REFERENCE + (only in monitor command) A reference to separate this project + from other scans of the same project. For example, a branch name + or version. Projects using the same reference can be used for + grouping. More information https://snyk.info/3B0vTPs. + --policy-path=PATH_TO_POLICY_FILE` Manually pass a path to a snyk policy file. --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 @@ -112,9 +118,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 @@ -123,16 +129,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] @@ -144,17 +150,17 @@ Maven options --scan-all-unmanaged - Auto detects maven jars, aars, and wars in given directory. In- + 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). @@ -162,49 +168,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 de- - sired 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 @@ -220,9 +226,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 @@ -233,10 +239,10 @@ Python options --command=COMMAND - 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- + 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 @@ -257,7 +263,7 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more de- + Prints a help text. You may specify a COMMAND to get more de- tails. EXIT CODES @@ -272,7 +278,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 @@ -280,47 +286,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-test.txt b/help/commands-txt/snyk-test.txt index 4c69a9413c..7314e16b75 100644 --- a/help/commands-txt/snyk-test.txt +++ b/help/commands-txt/snyk-test.txt @@ -95,16 +95,22 @@ --project-name=PROJECT_NAME Specify a custom Snyk project name. + --target-reference=TARGET_REFERENCE + (only in monitor command) A reference to separate this project + from other scans of the same project. For example, a branch name + or version. Projects using the same reference can be used for + grouping. More information https://snyk.info/3B0vTPs. + --policy-path=PATH_TO_POLICY_FILE` Manually pass a path to a snyk policy file. --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 @@ -112,9 +118,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 @@ -123,16 +129,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] @@ -144,17 +150,17 @@ Maven options --scan-all-unmanaged - Auto detects maven jars, aars, and wars in given directory. In- + 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). @@ -162,49 +168,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 de- - sired 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 @@ -220,9 +226,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 @@ -233,10 +239,10 @@ Python options --command=COMMAND - 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- + 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 @@ -257,7 +263,7 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more de- + Prints a help text. You may specify a COMMAND to get more de- tails. EXIT CODES @@ -272,7 +278,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 @@ -280,47 +286,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.txt b/help/commands-txt/snyk.txt index c3e331afb2..f1e314e029 100644 --- a/help/commands-txt/snyk.txt +++ b/help/commands-txt/snyk.txt @@ -140,16 +140,22 @@ --project-name=PROJECT_NAME Specify a custom Snyk project name. + --target-reference=TARGET_REFERENCE + (only in monitor command) A reference to separate this project + from other scans of the same project. For example, a branch name + or version. Projects using the same reference can be used for + grouping. More information https://snyk.info/3B0vTPs. + --policy-path=PATH_TO_POLICY_FILE` Manually pass a path to a snyk policy file. --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 @@ -157,9 +163,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 @@ -168,16 +174,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] @@ -189,17 +195,17 @@ Maven options --scan-all-unmanaged - Auto detects maven jars, aars, and wars in given directory. In- + 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). @@ -207,49 +213,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 de- - sired 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 @@ -265,9 +271,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 @@ -278,10 +284,10 @@ Python options --command=COMMAND - 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- + 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 @@ -302,7 +308,7 @@ Prints versions. [COMMAND] --help, --help [COMMAND], -h - Prints a help text. You may specify a COMMAND to get more de- + Prints a help text. You may specify a COMMAND to get more de- tails. EXAMPLES @@ -364,7 +370,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 @@ -372,47 +378,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