diff --git a/help/cli-commands/code-test.md b/help/cli-commands/code-test.md index 5be3b20a5e3..69b202f3be6 100644 --- a/help/cli-commands/code-test.md +++ b/help/cli-commands/code-test.md @@ -37,7 +37,11 @@ Set a default to ensure all newly tested projects are tested under your default Default: `` that is the current preferred Organization in your [Account settings](https://app.snyk.io/account) -Note that you can also use `--org=`. The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. +**Note:** You can also use `--org=.` The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. + +`orgslugname` must match the slug name as displayed in the URL of your org in the Snyk UI: `https://snyk.io/org/[orgslugname]`. The orgname does not work. + +For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/how-to-select-the-organization-to-use-in-the-cli) ### `--report` diff --git a/help/cli-commands/container-monitor.md b/help/cli-commands/container-monitor.md index f54581a3b9c..4d941d86ec3 100644 --- a/help/cli-commands/container-monitor.md +++ b/help/cli-commands/container-monitor.md @@ -46,9 +46,11 @@ Set a default to ensure all newly tested and monitored projects are tested and m Default: `` that is the current preferred Organization in your [Account settings](https://app.snyk.io/account) -Note that you can also use `--org=`. The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. +**Note:** You can also use `--org=.` The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. -For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/test-for-vulnerabilities/how-to-select-the-organization-to-use-in-the-cli) +`orgslugname` must match the slug name as displayed in the URL of your org in the Snyk UI: `https://snyk.io/org/[orgslugname]`. The orgname does not work. + +For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/how-to-select-the-organization-to-use-in-the-cli) ### `--file=` diff --git a/help/cli-commands/container-sbom.md b/help/cli-commands/container-sbom.md index c9ee6c2fa49..5792bb739be 100644 --- a/help/cli-commands/container-sbom.md +++ b/help/cli-commands/container-sbom.md @@ -10,13 +10,13 @@ The `snyk container sbom` feature requires an internet connection. ## Usage -`$ snyk container sbom --format= [--org=] [--exclude-app-vulns] ` +`$ snyk container sbom --format= [--org=] [--exclude-app-vulns] ` ## Description The `snyk container sbom` command generates an SBOM for a container image. -Supported formats include CycloneDX v1.4 (JSON or XML) and SPDX v2.3 (JSON). +Supported formats include CycloneDX v1.4 (JSON or XML), CycloneDX v1.5 (JSON or XML) and SPDX v2.3 (JSON). An SBOM can be generated for operating system dependencies as well as application dependencies within the image. Unmanaged dependencies are currently not supported. @@ -33,11 +33,11 @@ Use the `-d` or `--debug` option to output the debug logs. ## Options -### `--format=` +### `--format=` Required. Specify the output format for the SBOM to be produced. -Set the desired SBOM output format. Available options are `cyclonedx1.4+json`, `cyclonedx1.4+xml`, and `spdx2.3+json` +Set the desired SBOM output format. Available options are `cyclonedx1.4+json`, `cyclonedx1.4+xml`, `cyclonedx1.5+json`, `cyclonedx1.5+xml` and `spdx2.3+json` ### `[--org=]` @@ -77,11 +77,11 @@ Required. The image for which you will generate an SBOM document. ### Create a CycloneDX JSON document for an image -`$ snyk container sbom --format=cyclonedx1.4+json redis:latest` +`$ snyk container sbom --format=cyclonedx1.5+json redis:latest` ### Create a CycloneDX JSON document for an image and redirect stdout to a file -`$ snyk container sbom --format=cyclonedx1.4+json redis:latest > mySBOM.json` +`$ snyk container sbom --format=cyclonedx1.5+json redis:latest > mySBOM.json` ### Create a SPDX JSON document for an image while excluding application dependencies @@ -89,4 +89,4 @@ Required. The image for which you will generate an SBOM document. ### Refer to a container image by its digest -`$ snyk container sbom --format=cyclonedx1.4+xml alpine@sha256:c5c5fda71656f28e49ac9c5416b3643eaa6a108a8093151d6d1afc9463be8e33` +`$ snyk container sbom --format=cyclonedx1.5+xml alpine@sha256:c5c5fda71656f28e49ac9c5416b3643eaa6a108a8093151d6d1afc9463be8e33` diff --git a/help/cli-commands/container-test.md b/help/cli-commands/container-test.md index 5d049481d0f..6b68b71a79d 100644 --- a/help/cli-commands/container-test.md +++ b/help/cli-commands/container-test.md @@ -45,7 +45,11 @@ Set a default to ensure all newly tested and monitored projects are tested and m Default: `` that is the current preferred Organization in your [Account settings](https://app.snyk.io/account) -Note that you can also use `--org=`. The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. +**Note:** You can also use `--org=.` The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. + +`orgslugname` must match the slug name as displayed in the URL of your org in the Snyk UI: `https://snyk.io/org/[orgslugname]`. The orgname does not work. + +For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/how-to-select-the-organization-to-use-in-the-cli) ### `--file=` diff --git a/help/cli-commands/iac-test.md b/help/cli-commands/iac-test.md index 3723ef03d5a..bee4dcc68f4 100644 --- a/help/cli-commands/iac-test.md +++ b/help/cli-commands/iac-test.md @@ -51,7 +51,11 @@ Set a default to ensure all newly tested projects are tested under your default Default: `` that is the current preferred Organization in your [Account settings](https://app.snyk.io/account) -Note that you can also use `--org=`. The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. +**Note:** You can also use `--org=.` The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. + +`orgslugname` must match the slug name as displayed in the URL of your org in the Snyk UI: `https://snyk.io/org/[orgslugname]`. The orgname does not work. + +For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/how-to-select-the-organization-to-use-in-the-cli) ### `--ignore-policy` diff --git a/help/cli-commands/monitor.md b/help/cli-commands/monitor.md index cc5a8f3b0e4..6b85005cf5d 100644 --- a/help/cli-commands/monitor.md +++ b/help/cli-commands/monitor.md @@ -121,7 +121,9 @@ Set a default to ensure all newly monitored projects are created under your defa Default: `` that is the current preferred Organization in your [Account settings](https://app.snyk.io/account) -Note that you can also use `--org=`. The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. +**Note:** You can also use `--org=.` The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. + +`orgslugname` must match the slug name as displayed in the URL of your org in the Snyk UI: `https://snyk.io/org/[orgslugname]`. The orgname does not work. For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/how-to-select-the-organization-to-use-in-the-cli) diff --git a/help/cli-commands/sbom.md b/help/cli-commands/sbom.md index b4ffe2ba9eb..ff992cfd3a3 100644 --- a/help/cli-commands/sbom.md +++ b/help/cli-commands/sbom.md @@ -10,13 +10,13 @@ The `snyk sbom` feature requires an internet connection. ## Usage -`$ snyk sbom --format= [--file=] [--unmanaged] [--org=] [--dev] [--all-projects] [--name=] [--version=] [--exclude=[,...]] [--detection-depth=] [--prune-repeated-subdependencies|-p] [--maven-aggregate-project] [--scan-unmanaged] [--scan-all-unmanaged] [--sub-project=] [--gradle-sub-project=] [--all-sub-projects] [--configuration-matching=] [--configuration-attributes=[,]] [--init-script=] [--json-file-output=] []` +`$ snyk sbom --format= [--file=] [--unmanaged] [--org=] [--dev] [--all-projects] [--name=] [--version=] [--exclude=[,...]] [--detection-depth=] [--prune-repeated-subdependencies|-p] [--maven-aggregate-project] [--scan-unmanaged] [--scan-all-unmanaged] [--sub-project=] [--gradle-sub-project=] [--all-sub-projects] [--configuration-matching=] [--configuration-attributes=[,]] [--init-script=] [--json-file-output=] []` ## Description The `snyk sbom` command generates an SBOM for a local software project in an ecosystem supported by Snyk. -Supported formats include CycloneDX v1.4 (JSON or XML) and SPDX v2.3 (JSON). +Supported formats include CycloneDX v1.4 (JSON or XML), CycloneDX v1.5 (JSON or XML) and SPDX v2.3 (JSON). An SBOM can be generated for all supported Open Source package managers as well as unmanaged software projects. @@ -33,11 +33,11 @@ Use the `-d` or `--debug` option to output the debug logs. ## Options -### `--format=` +### `--format=` Required. Specify the output format for the SBOM to be produced. -Set the desired SBOM output format. Available options are `cyclonedx1.4+json`, `cyclonedx1.4+xml`, and `spdx2.3+json` +Set the desired SBOM output format. Available options are `cyclonedx1.4+json`, `cyclonedx1.4+xml`, `cyclonedx1.5+json`, `cyclonedx1.5+xml` and `spdx2.3+json` ### `[--org=]` @@ -288,11 +288,11 @@ Example: `snyk sbom -- -s settings.xml` ### Create a CycloneDX JSON document for a local software project -`$ snyk sbom --format=cyclonedx1.4+json` +`$ snyk sbom --format=cyclonedx1.5+json` ### Create a CycloneDX JSON document and redirect stdout to a file -`$ snyk sbom --format=cyclonedx1.4+json > mySBOM.json` +`$ snyk sbom --format=cyclonedx1.5+json > mySBOM.json` ### Create an SPDX JSON document and write it to a file @@ -304,8 +304,8 @@ Example: `snyk sbom -- -s settings.xml` ### Create a CycloneDX XML document for a Maven project -`$ snyk sbom --file=pom.xml --format=cyclonedx1.4+xml` +`$ snyk sbom --file=pom.xml --format=cyclonedx1.5+xml` ### Create a CycloneDX JSON document for a monorepo -`$ snyk sbom --format=cyclonedx1.4+json --all-projects` +`$ snyk sbom --format=cyclonedx1.5+json --all-projects` diff --git a/help/cli-commands/test.md b/help/cli-commands/test.md index 67cc04fa21a..04e519c653c 100644 --- a/help/cli-commands/test.md +++ b/help/cli-commands/test.md @@ -114,6 +114,8 @@ Default: `` that is the current preferred Organization in your [Account **Note:** You can also use `--org=.` The `ORG_ID` works in both the CLI and the API. The Organization slug name works in the CLI, but not in the API. +`orgslugname` must match the slug name as displayed in the URL of your org in the Snyk UI: `https://snyk.io/org/[orgslugname]`. The orgname does not work. + For more information see the article [How to select the Organization to use in the CLI](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/how-to-select-the-organization-to-use-in-the-cli) ### `--file=`