From 6c18b2be1248e351661c8961a75e3ed4b2aaff5a Mon Sep 17 00:00:00 2001 From: Ilianna Papastefanou Date: Tue, 10 Aug 2021 11:15:25 +0100 Subject: [PATCH] fix: help docs to include iac ignores --- help/commands-docs/iac.md | 6 +++ help/commands-man/snyk-auth.1 | 2 +- help/commands-man/snyk-config.1 | 2 +- help/commands-man/snyk-container.1 | 2 +- help/commands-man/snyk-help.1 | 2 +- help/commands-man/snyk-iac.1 | 8 +++- help/commands-man/snyk-ignore.1 | 2 +- help/commands-man/snyk-monitor.1 | 2 +- help/commands-man/snyk-policy.1 | 2 +- help/commands-man/snyk-protect.1 | 2 +- help/commands-man/snyk-test.1 | 2 +- help/commands-man/snyk-wizard.1 | 2 +- help/commands-man/snyk-woof.1 | 2 +- help/commands-man/snyk.1 | 2 +- help/commands-md/snyk-iac.md | 6 +++ help/commands-txt/snyk-iac.txt | 77 ++++++++++++++++-------------- 16 files changed, 73 insertions(+), 48 deletions(-) diff --git a/help/commands-docs/iac.md b/help/commands-docs/iac.md index d1bcb02e7d0..1503b48fef0 100644 --- a/help/commands-docs/iac.md +++ b/help/commands-docs/iac.md @@ -28,6 +28,9 @@ Find security issues in your Infrastructure as Code files. - `--severity-threshold`=low|medium|high: Only report vulnerabilities of provided level or higher. +- `--ignore-policy`: + Ignores all set policies. The current policy in `.snyk` file, Org level ignores and the project policy on snyk.io. + - `--json`: Prints results in JSON format. @@ -46,6 +49,9 @@ Find security issues in your Infrastructure as Code files. under your default organization. If you need to override the default, you can use the `--org`= argument. Default: uses that sets as default in your [Account settings](https://app.snyk.io/account) +- `--policy-path`=`: + Manually pass a path to a snyk policy file. + - `--sarif`: Return results in SARIF format. diff --git a/help/commands-man/snyk-auth.1 b/help/commands-man/snyk-auth.1 index 4795685f1f2..80d84cbf7d5 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" "July 2021" "Snyk.io" +.TH "SNYK\-AUTH" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-auth\fR \- Authenticate Snyk CLI with a Snyk account .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-config.1 b/help/commands-man/snyk-config.1 index 433d5d2758b..a230250ac8c 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" "July 2021" "Snyk.io" +.TH "SNYK\-CONFIG" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-config\fR \- Manage Snyk CLI configuration .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-container.1 b/help/commands-man/snyk-container.1 index 8ca7ce4ffb3..f360cc26fc7 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" "July 2021" "Snyk.io" +.TH "SNYK\-CONTAINER" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-container\fR \- Test container images for vulnerabilities .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-help.1 b/help/commands-man/snyk-help.1 index 8338b11529c..f825fcf116c 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" "July 2021" "Snyk.io" +.TH "SNYK\-HELP" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-help\fR \- Prints help topics .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-iac.1 b/help/commands-man/snyk-iac.1 index 7147e274f71..160807272ef 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" "July 2021" "Snyk.io" +.TH "SNYK\-IAC" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-iac\fR \- Find security issues in your Infrastructure as Code files .SH "SYNOPSIS" @@ -29,6 +29,9 @@ Will limit search to provided directory (or current directory if no \fIPATH\fR p \fB\-\-severity\-threshold\fR=low|medium|high Only report vulnerabilities of provided level or higher\. .TP +\fB\-\-ignore\-policy\fR +Ignores all set policies\. The current policy in \fB\.snyk\fR file, Org level ignores and the project policy on snyk\.io\. +.TP \fB\-\-json\fR Prints results in JSON format\. .TP @@ -42,6 +45,9 @@ Specify the \fIORG_NAME\fR to run Snyk commands tied to a specific organization\ .IP Setting a default will ensure all newly tested projects will be tested under your default organization\. If you need to override the default, you can use the \fB\-\-org\fR=\fIORG_NAME\fR argument\. Default: uses \fIORG_NAME\fR that sets as default in your Account settings \fIhttps://app\.snyk\.io/account\fR .TP +\fB\-\-policy\-path\fR=\fIPATH_TO_POLICY_FILE\fR` +Manually pass a path to a snyk policy file\. +.TP \fB\-\-sarif\fR Return results in SARIF format\. .TP diff --git a/help/commands-man/snyk-ignore.1 b/help/commands-man/snyk-ignore.1 index 8d616c4d181..db4d554cffa 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" "July 2021" "Snyk.io" +.TH "SNYK\-IGNORE" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-ignore\fR \- Modifies the \.snyk policy to ignore stated issues .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-monitor.1 b/help/commands-man/snyk-monitor.1 index 0ab71497255..822c3cf9aee 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" "July 2021" "Snyk.io" +.TH "SNYK\-MONITOR" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-monitor\fR \- Snapshot and continuously monitor your project .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-policy.1 b/help/commands-man/snyk-policy.1 index 34eed9d1be6..319dc381e41 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" "July 2021" "Snyk.io" +.TH "SNYK\-POLICY" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-policy\fR \- Display the \.snyk policy for a package .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-protect.1 b/help/commands-man/snyk-protect.1 index 8304746c65f..91ba1ba7bd7 100644 --- a/help/commands-man/snyk-protect.1 +++ b/help/commands-man/snyk-protect.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-PROTECT" "1" "July 2021" "Snyk.io" +.TH "SNYK\-PROTECT" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-protect\fR \- Applies the patches specified in your \.snyk file to the local file system .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-test.1 b/help/commands-man/snyk-test.1 index d1185a03c8f..21a14361b72 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" "July 2021" "Snyk.io" +.TH "SNYK\-TEST" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-test\fR \- test local project for vulnerabilities .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-wizard.1 b/help/commands-man/snyk-wizard.1 index 1832cbacef4..edf45e7fd3b 100644 --- a/help/commands-man/snyk-wizard.1 +++ b/help/commands-man/snyk-wizard.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK\-WIZARD" "1" "July 2021" "Snyk.io" +.TH "SNYK\-WIZARD" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-wizard\fR \- Configure your policy file to update, auto patch and ignore vulnerabilities .SH "SYNOPSIS" diff --git a/help/commands-man/snyk-woof.1 b/help/commands-man/snyk-woof.1 index cfe3796fa31..fb888896a0e 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" "July 2021" "Snyk.io" +.TH "SNYK\-WOOF" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\-woof\fR \- W00f .SH "SYNOPSIS" diff --git a/help/commands-man/snyk.1 b/help/commands-man/snyk.1 index 7461a003d36..b2ca66ea498 100644 --- a/help/commands-man/snyk.1 +++ b/help/commands-man/snyk.1 @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 -.TH "SNYK" "1" "July 2021" "Snyk.io" +.TH "SNYK" "1" "August 2021" "Snyk.io" .SH "NAME" \fBsnyk\fR \- CLI and build\-time tool to find & fix known vulnerabilities in open\-source dependencies .SH "SYNOPSIS" diff --git a/help/commands-md/snyk-iac.md b/help/commands-md/snyk-iac.md index f9f0c02c3d2..dde4ee61e1f 100644 --- a/help/commands-md/snyk-iac.md +++ b/help/commands-md/snyk-iac.md @@ -28,6 +28,9 @@ Find security issues in your Infrastructure as Code files. - `--severity-threshold`=low|medium|high: Only report vulnerabilities of provided level or higher. +- `--ignore-policy`: + Ignores all set policies. The current policy in `.snyk` file, Org level ignores and the project policy on snyk.io. + - `--json`: Prints results in JSON format. @@ -46,6 +49,9 @@ Find security issues in your Infrastructure as Code files. under your default organization. If you need to override the default, you can use the `--org`= argument. Default: uses that sets as default in your [Account settings](https://app.snyk.io/account) +- `--policy-path`=`: + Manually pass a path to a snyk policy file. + - `--sarif`: Return results in SARIF format. diff --git a/help/commands-txt/snyk-iac.txt b/help/commands-txt/snyk-iac.txt index 55f74c40f46..fffaa85c3ea 100644 --- a/help/commands-txt/snyk-iac.txt +++ b/help/commands-txt/snyk-iac.txt @@ -26,47 +26,54 @@ --severity-threshold=low|medium|high Only report vulnerabilities of provided level or higher. + --ignore-policy + Ignores all set policies. The current policy in .snyk file, Org + level ignores and the project policy on snyk.io. + --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. --org=ORG_NAME 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 + ganization. This will influence 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 tested projects will be - tested under your default organization. If you need to override - the default, you can use the --org=ORG_NAME argument. Default: - uses ORG_NAME that sets as default in your Account settings + Setting a default will ensure all newly tested projects will be + tested under your default organization. If you need to override + the default, you can use the --org=ORG_NAME argument. Default: + uses ORG_NAME that sets as default in your Account settings https://app.snyk.io/account + --policy-path=PATH_TO_POLICY_FILE` + Manually pass a path to a snyk policy file. + --sarif Return results in SARIF format. --sarif-file-output=OUTPUT_FILE_PATH (only in test command) Save test output in SARIF format directly - to the OUTPUT_FILE_PATH file, regardless of whether or not you + 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. --scan=TERRAFORM_PLAN_SCAN_MODE Dedicated flag for Terraform plan scanning modes. - It enables to control whether the scan should analyse the full - final state (e.g. planned-values), or the proposed changes only + It enables to control whether the scan should analyse the full + final state (e.g. planned-values), or the proposed changes only (e.g. resource-changes). - Default: If the --scan flag is not provided it would scan the + Default: If the --scan flag is not provided it would scan the proposed changes only by default. - Example #1: --scan=planned-values (full state scan) Example #2: + Example #1: --scan=planned-values (full state scan) Example #2: --scan=resource-changes (proposed changes scan) Flags available accross all commands @@ -82,7 +89,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 @@ -115,7 +122,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 @@ -123,47 +130,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