Skip to content

Commit

Permalink
Merge pull request #5474 from snyk/docs/automatic-gitbook-update
Browse files Browse the repository at this point in the history
docs: Synchronizing CLI help from user-docs
  • Loading branch information
thisislawatts authored Sep 13, 2024
2 parents f7eeeb9 + 6cb11ab commit ea78b29
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 3 deletions.
2 changes: 2 additions & 0 deletions help/cli-commands/config-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ENVIRONMENT>`
Expand Down
2 changes: 1 addition & 1 deletion help/cli-commands/iac-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Save test output in SARIF format directly to the \<OUTPUT_FILE_PATH> 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=<BUSINESS_CRITICALITY>[,<BUSINESS_CRITICALITY>]...>`

Expand Down
20 changes: 19 additions & 1 deletion help/cli-commands/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`.

Expand Down
24 changes: 23 additions & 1 deletion help/cli-commands/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.`

Expand Down

0 comments on commit ea78b29

Please sign in to comment.