Home • Explore • Blog • Models • CI
☰



docker
1st chunk of `_vendor/github.com/docker/scout-cli/docs/scout_recommendations.md`
ba56610474c6e6548560c62c5e6600bc98033c937155123d0000000100000c43
# docker scout recommendations

<!---MARKER_GEN_START-->
Display available base image updates and remediation recommendations

### Options

| Name             | Type     | Default | Description                                                                                             |
|:-----------------|:---------|:--------|:--------------------------------------------------------------------------------------------------------|
| `--only-refresh` |          |         | Only display base image refresh recommendations                                                         |
| `--only-update`  |          |         | Only display base image update recommendations                                                          |
| `--org`          | `string` |         | Namespace of the Docker organization                                                                    |
| `-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 |
| `--tag`          | `string` |         | Specify tag                                                                                             |


<!---MARKER_GEN_END-->

## Description

The `docker scout recommendations` command display recommendations for base images updates.
It analyzes the image and display recommendations to refresh or update the base image.
For each recommendation it shows a list of benefits, such as
fewer vulnerabilities or smaller image size.

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 base image update recommendations

```console
$ docker scout recommendations golang:1.19.4
```

### Display base image refresh only recommendations

```console
$ docker scout recommendations --only-refresh golang:1.19.4
```

### Display base image update only recommendations

```console
$ docker scout recommendations --only-update golang:1.19.4
```
Title: Docker Scout Recommendations: Base Image Updates and Remediation
Summary
The `docker scout recommendations` command provides recommendations for updating base images, analyzing the image and displaying suggestions to refresh or update it. It supports various artifact types (Images, OCI layout directories, Tarball archives, Local directory/file) and allows specifying options to filter recommendations (refresh/update only), define the Docker organization, output to a file, specify the platform, reference, and tag. Examples demonstrate displaying recommendations for specific images with filtering options.