diff --git a/site/src/content/docs/commands/zarf_tools_sbom.md b/site/src/content/docs/commands/zarf_tools_sbom.md index 963ee996ad..eb11240f1d 100644 --- a/site/src/content/docs/commands/zarf_tools_sbom.md +++ b/site/src/content/docs/commands/zarf_tools_sbom.md @@ -21,21 +21,22 @@ zarf tools sbom [flags] ### Options ``` - --base-path string base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory - --catalogers stringArray enable one or more package catalogers - -c, --config string syft configuration file - --exclude stringArray exclude paths from being scanned using a glob expression - --file string file to write the default report output to (default is STDOUT) (DEPRECATED: use: output) - -h, --help help for sbom - --name string set the name of the target being analyzed (DEPRECATED: use: source-name) - -o, --output stringArray report output format (= to output to a file), formats=[cyclonedx-json cyclonedx-xml github-json spdx-json spdx-tag-value syft-json syft-table syft-text template] (default [syft-table]) - --platform string an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux') - -q, --quiet suppress all logging output - -s, --scope string selection of layers to catalog, options=[squashed all-layers] - --source-name string set the name of the target being analyzed - --source-version string set the version of the target being analyzed - -t, --template string specify the path to a Go template file - -v, --verbose count increase verbosity (-v = info, -vv = debug) + --base-path string base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory + -c, --config string syft configuration file + --exclude stringArray exclude paths from being scanned using a glob expression + --file string file to write the default report output to (default is STDOUT) (DEPRECATED: use: output) + --from stringArray specify the source behavior to use (e.g. docker, registry, oci-dir, ...) + -h, --help help for sbom + -o, --output stringArray report output format (= to output to a file), formats=[cyclonedx-json cyclonedx-xml github-json spdx-json spdx-tag-value syft-json syft-table syft-text template] (default [syft-table]) + --override-default-catalogers stringArray set the base set of catalogers to use (defaults to 'image' or 'directory' depending on the scan source) + --platform string an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux') + -q, --quiet suppress all logging output + -s, --scope string selection of layers to catalog, options=[squashed all-layers] + --select-catalogers stringArray add, remove, and filter the catalogers to be used + --source-name string set the name of the target being analyzed + --source-version string set the version of the target being analyzed + -t, --template string specify the path to a Go template file + -v, --verbose count increase verbosity (-v = info, -vv = debug) ``` ### Options inherited from parent commands @@ -49,6 +50,8 @@ zarf tools sbom [flags] * [zarf tools](/commands/zarf_tools/) - Collection of additional tools to make airgap easier * [zarf tools sbom attest](/commands/zarf_tools_sbom_attest/) - Generate an SBOM as an attestation for the given [SOURCE] container image +* [zarf tools sbom cataloger](/commands/zarf_tools_sbom_cataloger/) - Show available catalogers and configuration +* [zarf tools sbom config](/commands/zarf_tools_sbom_config/) - show the syft configuration * [zarf tools sbom convert](/commands/zarf_tools_sbom_convert/) - Convert between SBOM formats * [zarf tools sbom login](/commands/zarf_tools_sbom_login/) - Log in to a registry * [zarf tools sbom scan](/commands/zarf_tools_sbom_scan/) - Generate an SBOM diff --git a/site/src/content/docs/commands/zarf_tools_sbom_attest.md b/site/src/content/docs/commands/zarf_tools_sbom_attest.md index 66d6eac62b..6f8eb94737 100644 --- a/site/src/content/docs/commands/zarf_tools_sbom_attest.md +++ b/site/src/content/docs/commands/zarf_tools_sbom_attest.md @@ -21,16 +21,18 @@ zarf tools sbom attest --output [FORMAT] [flags] ### Options ``` - --base-path string base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory - --catalogers stringArray enable one or more package catalogers - --exclude stringArray exclude paths from being scanned using a glob expression - -h, --help help for attest - --name string set the name of the target being analyzed (DEPRECATED: use: source-name) - -o, --output stringArray report output format (= to output to a file), formats=[cyclonedx-json cyclonedx-xml github-json spdx-json spdx-tag-value syft-json syft-table syft-text template] (default [syft-json]) - --platform string an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux') - -s, --scope string selection of layers to catalog, options=[squashed all-layers] - --source-name string set the name of the target being analyzed - --source-version string set the version of the target being analyzed + --base-path string base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory + --exclude stringArray exclude paths from being scanned using a glob expression + --from stringArray specify the source behavior to use (e.g. docker, registry, oci-dir, ...) + -h, --help help for attest + -k, --key string the key to use for the attestation + -o, --output stringArray report output format (= to output to a file), formats=[cyclonedx-json cyclonedx-xml github-json spdx-json spdx-tag-value syft-json syft-table syft-text template] (default [syft-json]) + --override-default-catalogers stringArray set the base set of catalogers to use (defaults to 'image' or 'directory' depending on the scan source) + --platform string an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux') + -s, --scope string selection of layers to catalog, options=[squashed all-layers] + --select-catalogers stringArray add, remove, and filter the catalogers to be used + --source-name string set the name of the target being analyzed + --source-version string set the version of the target being analyzed ``` ### Options inherited from parent commands diff --git a/site/src/content/docs/commands/zarf_tools_sbom_cataloger.md b/site/src/content/docs/commands/zarf_tools_sbom_cataloger.md new file mode 100644 index 0000000000..42ae09a3f7 --- /dev/null +++ b/site/src/content/docs/commands/zarf_tools_sbom_cataloger.md @@ -0,0 +1,33 @@ +--- +title: zarf tools sbom cataloger +description: Zarf CLI command reference for zarf tools sbom cataloger. +tableOfContents: false +--- + + + +## zarf tools sbom cataloger + +Show available catalogers and configuration + +### Options + +``` + -h, --help help for cataloger +``` + +### Options inherited from parent commands + +``` + -c, --config string syft configuration file + --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --plain-http Force the connections over HTTP instead of HTTPS. This flag should only be used if you have a specific reason and accept the reduced security posture. + -q, --quiet suppress all logging output + -v, --verbose count increase verbosity (-v = info, -vv = debug) +``` + +### SEE ALSO + +* [zarf tools sbom](/commands/zarf_tools_sbom/) - Generates a Software Bill of Materials (SBOM) for the given package +* [zarf tools sbom cataloger list](/commands/zarf_tools_sbom_cataloger_list/) - List available catalogers + diff --git a/site/src/content/docs/commands/zarf_tools_sbom_cataloger_list.md b/site/src/content/docs/commands/zarf_tools_sbom_cataloger_list.md new file mode 100644 index 0000000000..157c5d98af --- /dev/null +++ b/site/src/content/docs/commands/zarf_tools_sbom_cataloger_list.md @@ -0,0 +1,40 @@ +--- +title: zarf tools sbom cataloger list +description: Zarf CLI command reference for zarf tools sbom cataloger list. +tableOfContents: false +--- + + + +## zarf tools sbom cataloger list + +List available catalogers + +``` +zarf tools sbom cataloger list [OPTIONS] [flags] +``` + +### Options + +``` + -h, --help help for list + -o, --output string format to output the cataloger list (available: table, json) + --override-default-catalogers stringArray override the default catalogers with an expression (default [all]) + --select-catalogers stringArray select catalogers with an expression + -s, --show-hidden show catalogers that have been de-selected +``` + +### Options inherited from parent commands + +``` + -c, --config string syft configuration file + --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --plain-http Force the connections over HTTP instead of HTTPS. This flag should only be used if you have a specific reason and accept the reduced security posture. + -q, --quiet suppress all logging output + -v, --verbose count increase verbosity (-v = info, -vv = debug) +``` + +### SEE ALSO + +* [zarf tools sbom cataloger](/commands/zarf_tools_sbom_cataloger/) - Show available catalogers and configuration + diff --git a/site/src/content/docs/commands/zarf_tools_sbom_config.md b/site/src/content/docs/commands/zarf_tools_sbom_config.md new file mode 100644 index 0000000000..50f7d5edc2 --- /dev/null +++ b/site/src/content/docs/commands/zarf_tools_sbom_config.md @@ -0,0 +1,38 @@ +--- +title: zarf tools sbom config +description: Zarf CLI command reference for zarf tools sbom config. +tableOfContents: false +--- + + + +## zarf tools sbom config + +show the syft configuration + +``` +zarf tools sbom config [flags] +``` + +### Options + +``` + -h, --help help for config + --load load and validate the syft configuration +``` + +### Options inherited from parent commands + +``` + -c, --config string syft configuration file + --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --plain-http Force the connections over HTTP instead of HTTPS. This flag should only be used if you have a specific reason and accept the reduced security posture. + -q, --quiet suppress all logging output + -v, --verbose count increase verbosity (-v = info, -vv = debug) +``` + +### SEE ALSO + +* [zarf tools sbom](/commands/zarf_tools_sbom/) - Generates a Software Bill of Materials (SBOM) for the given package +* [zarf tools sbom config locations](/commands/zarf_tools_sbom_config_locations/) - shows all locations and the order in which syft will look for a configuration file + diff --git a/site/src/content/docs/commands/zarf_tools_sbom_config_locations.md b/site/src/content/docs/commands/zarf_tools_sbom_config_locations.md new file mode 100644 index 0000000000..c2c58b38be --- /dev/null +++ b/site/src/content/docs/commands/zarf_tools_sbom_config_locations.md @@ -0,0 +1,37 @@ +--- +title: zarf tools sbom config locations +description: Zarf CLI command reference for zarf tools sbom config locations. +tableOfContents: false +--- + + + +## zarf tools sbom config locations + +shows all locations and the order in which syft will look for a configuration file + +``` +zarf tools sbom config locations [flags] +``` + +### Options + +``` + --all include every file extension supported + -h, --help help for locations +``` + +### Options inherited from parent commands + +``` + -c, --config string syft configuration file + --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --plain-http Force the connections over HTTP instead of HTTPS. This flag should only be used if you have a specific reason and accept the reduced security posture. + -q, --quiet suppress all logging output + -v, --verbose count increase verbosity (-v = info, -vv = debug) +``` + +### SEE ALSO + +* [zarf tools sbom config](/commands/zarf_tools_sbom_config/) - show the syft configuration + diff --git a/site/src/content/docs/commands/zarf_tools_sbom_scan.md b/site/src/content/docs/commands/zarf_tools_sbom_scan.md index fcc63cbe14..cbb5f732ed 100644 --- a/site/src/content/docs/commands/zarf_tools_sbom_scan.md +++ b/site/src/content/docs/commands/zarf_tools_sbom_scan.md @@ -21,18 +21,19 @@ zarf tools sbom scan [SOURCE] [flags] ### Options ``` - --base-path string base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory - --catalogers stringArray enable one or more package catalogers - --exclude stringArray exclude paths from being scanned using a glob expression - --file string file to write the default report output to (default is STDOUT) (DEPRECATED: use: output) - -h, --help help for scan - --name string set the name of the target being analyzed (DEPRECATED: use: source-name) - -o, --output stringArray report output format (= to output to a file), formats=[cyclonedx-json cyclonedx-xml github-json spdx-json spdx-tag-value syft-json syft-table syft-text template] (default [syft-table]) - --platform string an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux') - -s, --scope string selection of layers to catalog, options=[squashed all-layers] - --source-name string set the name of the target being analyzed - --source-version string set the version of the target being analyzed - -t, --template string specify the path to a Go template file + --base-path string base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory + --exclude stringArray exclude paths from being scanned using a glob expression + --file string file to write the default report output to (default is STDOUT) (DEPRECATED: use: output) + --from stringArray specify the source behavior to use (e.g. docker, registry, oci-dir, ...) + -h, --help help for scan + -o, --output stringArray report output format (= to output to a file), formats=[cyclonedx-json cyclonedx-xml github-json spdx-json spdx-tag-value syft-json syft-table syft-text template] (default [syft-table]) + --override-default-catalogers stringArray set the base set of catalogers to use (defaults to 'image' or 'directory' depending on the scan source) + --platform string an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux') + -s, --scope string selection of layers to catalog, options=[squashed all-layers] + --select-catalogers stringArray add, remove, and filter the catalogers to be used + --source-name string set the name of the target being analyzed + --source-version string set the version of the target being analyzed + -t, --template string specify the path to a Go template file ``` ### Options inherited from parent commands