docker scout sbom: Generate or display SBOM of an image

_vendor/github.com/docker/scout-cli/docs/scout_sbom.md

9a400ebeccc971f3440dfa84bacfe710eef0b916c357dec10000000300000e32

# docker scout sbom

<!---MARKER_GEN_START-->
Generate or display SBOM of an image

### Options

| Name                  | Type          | Default | Description                                                                                                                                                                                         |
|:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--format`            | `string`      | `json`  | Output format:<br>- list: list of packages of the image<br>- json: json representation of the SBOM<br>- spdx: spdx representation of the SBOM<br>- cyclonedx: cyclone dx representation of the SBOM |
| `--only-package-type` | `stringSlice` |         | Comma separated list of package types (like apk, deb, rpm, npm, pypi, golang, etc)<br>Can only be used with --format list                                                                           |
| `-o`, `--output`      | `string`      |         | Write the report to a file                                                                                                                                                                          |
| `--platform`          | `string`      |         | Platform of image to analyze                                                                                                                                                                        |
| `--ref`               | `string`      |         | Reference to use if the provided tarball contains multiple references.<br>Can only be used with archive                                                                                             |


<!---MARKER_GEN_END-->

## Description

The `docker scout sbom` command analyzes a software artifact to generate a
Software Bill Of Materials (SBOM).

The SBOM contains a list of all packages in the image.
You can use the `--format` flag to filter the output of the command
to display only packages of a specific type.

If no image is specified, the most recently built image is used.

The following artifact types are supported:

- Images
- OCI layout directories
- Tarball archives, as created by `docker save`
- Local directory or file

By default, the tool expects an image reference, such as:

- `redis`
- `curlimages/curl:7.87.0`
- `mcr.microsoft.com/dotnet/runtime:7.0`

If the artifact you want to analyze is an OCI directory, a tarball archive, a local file or directory,
or if you want to control from where the image will be resolved, you must prefix the reference with one of the following:

- `image://` (default) use a local image, or fall back to a registry lookup
- `local://` use an image from the local image store (don't do a registry lookup)
- `registry://` use an image from a registry (don't use a local image)
- `oci-dir://` use an OCI layout directory
- `archive://` use a tarball archive, as created by `docker save`
- `fs://` use a local directory or file

## Examples

### Display the list of packages

```console
$ docker scout sbom --format list alpine
```

### Only display packages of a specific type

```console
 $ docker scout sbom --format list --only-package-type apk alpine
```

### Display the full SBOM in JSON format

```console
$ docker scout sbom alpine
```

### Display the full SBOM of the most recently built image

```console
$ docker scout sbom
```

### Write SBOM to a file

```console
$ docker scout sbom --output alpine.sbom alpine
```

Chunks

189b6fed (1st chunk of `_vendor/github.com/docker/scout-cli/docs/scout_sbom.md`)

Title: docker scout sbom: Generate or display SBOM of an image

Summary

The `docker scout sbom` command generates a Software Bill Of Materials (SBOM) for a given software artifact. It supports various artifact types including images, OCI layout directories, tarball archives, and local directories/files. The output format can be specified as a list, JSON, SPDX, or CycloneDX. Options are available to filter packages by type, specify the platform, and write the output to a file. Examples demonstrate how to display a list of packages, filter by package type, display the full SBOM in JSON format, and write the SBOM to a file.