github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/2-the-jackal-cli/100-cli-commands/jackal_tools_sbom.md (about)

     1  # jackal tools sbom
     2  <!-- Auto-generated by hack/gen-cli-docs.sh -->
     3  
     4  Generates a Software Bill of Materials (SBOM) for the given package
     5  
     6  ## Synopsis
     7  
     8  Generate a packaged-based Software Bill Of Materials (SBOM) from container images and filesystems
     9  
    10  ```
    11  jackal tools sbom [flags]
    12  ```
    13  
    14  ## Options
    15  
    16  ```
    17        --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
    18        --catalogers stringArray   enable one or more package catalogers
    19    -c, --config string            syft configuration file
    20        --exclude stringArray      exclude paths from being scanned using a glob expression
    21        --file string              file to write the default report output to (default is STDOUT) (DEPRECATED: use: output)
    22    -h, --help                     help for sbom
    23        --name string              set the name of the target being analyzed (DEPRECATED: use: source-name)
    24    -o, --output stringArray       report output format (<format>=<file> 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])
    25        --platform string          an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux')
    26    -q, --quiet                    suppress all logging output
    27    -s, --scope string             selection of layers to catalog, options=[squashed all-layers] (default "squashed")
    28        --source-name string       set the name of the target being analyzed
    29        --source-version string    set the version of the target being analyzed
    30    -t, --template string          specify the path to a Go template file
    31    -v, --verbose count            increase verbosity (-v = info, -vv = debug)
    32  ```
    33  
    34  ## SEE ALSO
    35  
    36  * [jackal tools](jackal_tools.md)	 - Collection of additional tools to make airgap easier
    37  * [jackal tools sbom attest](jackal_tools_sbom_attest.md)	 - Generate an SBOM as an attestation for the given [SOURCE] container image
    38  * [jackal tools sbom convert](jackal_tools_sbom_convert.md)	 - Convert between SBOM formats
    39  * [jackal tools sbom login](jackal_tools_sbom_login.md)	 - Log in to a registry
    40  * [jackal tools sbom scan](jackal_tools_sbom_scan.md)	 - Generate an SBOM
    41  * [jackal tools sbom version](jackal_tools_sbom_version.md)	 - show version information