docker scout recommendations

Early Access

Docker Scout is an early access product.

If you’re interested in Docker Scout for your organization and want to learn more, get in touch by filling out the contact form on the Docker Scout product page.


Display available base image updates and remediation recommendations

Usage

$ docker scout recommendations IMAGE|DIRECTORY|ARCHIVE

Refer to the options section for an overview of available OPTIONS for this command.

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 like less vulnerabilities, smaller image, etc.

The following artifact types are supported:

  • Images
  • OCI layout directories
  • Tarball archives, as created by docker save

The tool analyzes the provided software artifact, and generates base image updates and remediation recommendations.

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 or a tarball archive, you must use the --type flag.

For example uses of this command, refer to the examples section below.

Options

Name, shorthand Default Description
--only-refresh Only display base image refresh recommendations
--only-update Only display base image update recommendations
--output , -o Write the report to a file.
--platform Platform of image to analyze
--ref Reference to use if the provided tarball contains multiple references. Can only be used with --type archive.
--tag Specify tag
--type image Type of the image to analyze. Can be one of: - image - oci-dir - archive (docker save tarball)

Examples

Display base image update recommendations

$ docker scout recommendations golang:1.19.4

Display base image refresh only recommendations

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

Display base image update only recommendations

$ docker scout recommendations --only-update golang:1.19.4

Parent command

Command Description
docker scout Command line tool for Docker Scout
Command Description
docker scout compare [experimental] Compare two images and display differences
docker scout cves Display CVEs identified in a software artifact
docker scout quickview Quick overview of an image
docker scout recommendations Display available base image updates and remediation recommendations
docker scout version Show Docker Scout version information