From 6cb11ab3a2afdca390b0007b523bbe1e5f16e994 Mon Sep 17 00:00:00 2001 From: thisislawatts Date: Mon, 9 Sep 2024 09:04:26 +0000 Subject: [PATCH] docs: synchronizing help from snyk/user-docs --- help/cli-commands/config-environment.md | 2 ++ help/cli-commands/iac-test.md | 2 +- help/cli-commands/monitor.md | 20 +++++++++++++++++++- help/cli-commands/test.md | 24 +++++++++++++++++++++++- 4 files changed, 45 insertions(+), 3 deletions(-) diff --git a/help/cli-commands/config-environment.md b/help/cli-commands/config-environment.md index 7ff666e557..8a45d9ee64 100644 --- a/help/cli-commands/config-environment.md +++ b/help/cli-commands/config-environment.md @@ -2,6 +2,8 @@ **Note:** This command will be available as of CLI version 1.1293.0. +If you are not in the system default environment, SNYK-US-01, use the `snyk config environment` command to set your environment before you run `snyk auth`. + ## Usage `snyk config environment ` diff --git a/help/cli-commands/iac-test.md b/help/cli-commands/iac-test.md index ba3a5916cd..14ee7913cc 100644 --- a/help/cli-commands/iac-test.md +++ b/help/cli-commands/iac-test.md @@ -89,7 +89,7 @@ Save test output in SARIF format directly to the \ file, regar This is especially useful if you want to display the human-readable test output using stdout and at the same time save the SARIF format output to a file. -Note: If you use an option that sets project attributes and your role lacks permission to edit project attributes the `iac test` command fails. For instructions on how to proceed see [Editing project attributes from the Snyk CLI](https://docs.snyk.io/features/user-and-group-management/managing-users-and-permissions/managing-permissions#editing-project-attributes-from-the-snyk-cli) +Note: If you use an option that sets project attributes and your role lacks permission to edit project attributes the `iac test` command fails. For instructions on how to proceed see [Permissions required to edit Project attributes from the Snyk CLI](https://docs.snyk.io/snyk-admin/user-roles/user-role-management#permissions-required-to-edit-project-attributes-from-the-snyk-cli) ### `--project-business-criticality=[,]...>` diff --git a/help/cli-commands/monitor.md b/help/cli-commands/monitor.md index d09f11b131..bec3279656 100644 --- a/help/cli-commands/monitor.md +++ b/help/cli-commands/monitor.md @@ -333,6 +333,24 @@ Control monitoring out-of-sync lockfiles. Default: true +## Options for pnpm projects + +**Snyk CLI pnpm support is in Early Access**. To enable it, in your Snyk account navigate to Settings, select Snyk Preview, and install CLI v1.1293.0 or above. + +**Note**: You can use the following options with pnpm projects: + +`--dev`. See the [`--dev` option help](https://docs.snyk.io/snyk-cli/commands/monitor#dev) + +`--all-projects` to scan and detect pnpm projects and all other projects in the directory. See the [`--all-projects` option help](https://docs.snyk.io/snyk-cli/commands/monitor#all-projects) + +`--prune-repeated-subdependencies, -p`. See the [--prune-repeated subdependencies option help](https://docs.snyk.io/snyk-cli/commands/monitor#prune-repeated-subdependencies-p) + +### `--strict-out-of-sync=true|false` + +Control monitoring out-of-sync lockfiles. + +Default: true + ## Options for Yarn projects **Note**: You can use the following options with Yarn projects: @@ -349,7 +367,7 @@ Default: true ### `--yarn-workspaces` -Detect and scan Yarn Workspaces only when a lockfile is in the root. +Detect and scan only Yarn Workspaces when a lockfile is in the root. You can specify how many sub-directories to search using `--detection-depth`. diff --git a/help/cli-commands/test.md b/help/cli-commands/test.md index bcd4943213..6fba808d28 100644 --- a/help/cli-commands/test.md +++ b/help/cli-commands/test.md @@ -368,6 +368,28 @@ If there are out-of-sync lockfiles in the project, the `test` command fails when Default: true +## Options for pnpm projects + +**Snyk CLI pnpm support is in Early Access**. To enable it, in your Snyk account navigate to Settings, select Snyk Preview, and install CLI v1.1293.0 or above. + +**Note**: You can use the following options with pnpm projects: + +`--dev`. See the [`--dev` option help](https://docs.snyk.io/snyk-cli/commands/test#dev) + +`--all-projects` to scan and detect pnpm projects and all other projects in the directory. See the [`--all-projects` option help](https://docs.snyk.io/snyk-cli/commands/test#all-projects) + +`--fail-on`. See the [--fail-on option help](https://docs.snyk.io/snyk-cli/commands/test#fail-on-less-than-all-or-upgradable-or-patchable-greater-than) + +`--prune-repeated-subdependencies, -p`. See the [`--prune-repeated subdependencies` option help](https://docs.snyk.io/snyk-cli/commands/test#prune-repeated-subdependencies-p) + +### `--strict-out-of-sync=true|false` + +Prevent testing out-of-sync lockfiles. + +If there are out-of-sync lockfiles in the project, the `test` command fails when `--strict-out-of-sync=true`. + +Default: true + ## Options for Yarn projects **Note**: You can use the following options with Yarn projects: @@ -388,7 +410,7 @@ Default: true ### `--yarn-workspaces` -Detect and scan Yarn Workspaces only when a lockfile is in the root. +Detect and scan only Yarn Workspaces when a lockfile is in the root. You can specify how many sub-directories to search using `--detection-depth.`