f0e2deb5a6 | ||
---|---|---|
.github/workflows | ||
cmd/docker-index | ||
commands | ||
format | ||
internal | ||
lsp | ||
query | ||
registry | ||
sbom | ||
types | ||
.gitignore | ||
.golangci.yml | ||
.goreleaser.yaml | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
Taskfile.yaml | ||
go.mod | ||
go.sum | ||
install.sh |
README.md
Note: This repository is not an officially supported Docker project.
docker index
Docker CLI tool
Docker CLI tool to create image SBOMs as well as analyze packages for known vulnerabilities using the Atomist data plane.
Installation
You can install manually by following these steps:
- Download the binary from the release page
- Unzip the archive
Usage
docker-index sbom
To create an SBOM for a local or remote image, run the following command:
$ docker-index sbom --image <IMAGE>
--image <IMAGE>
can either be a local image id or fully qualified image name from a remote registry--oci-dir <DIR>
can point to a local image in OCI directory format--output <OUTPUT FILE>
allows to store the generated SBOM in a local file--include-cves
will include all detected CVEs in generated output
docker-index cve
To detect base images for local or remote images, use the following command:
$ docker-index cve --image <IMAGE> CVE_ID
--image <IMAGE>
can either be a local image id or fully qualified image name from a remote registry--oci-dir <DIR>
can point to a local image in OCI directory format--remediate
include suggested remediation in the outputCVE_ID
can be any known CVE id