fix: help docs to include iac ignores

snyk · Aug 10, 2021 · 6c18b2b · 6c18b2b
1 parent 755f586
commit 6c18b2b
Show file tree

Hide file tree

Showing 16 changed files with 73 additions and 48 deletions.
diff --git 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`=<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.
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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`=<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.