Перейти к файлу
Christian Dupuis 56dd3635cd Update from 4e9de2d11a4e64289302eff14f84265cdec48be2 2023-04-21 18:25:25 +00:00
.github/workflows refactor: move main.go to cmd/docker-index folder 2023-01-10 10:07:45 +01:00
cmd/docker-index refactor: move main.go to cmd/docker-index folder 2023-01-10 10:07:45 +01:00
commands Add username and password to lsp func 2023-02-03 09:41:41 +01:00
format chore: fix gosimple issues 2023-01-09 17:57:45 +01:00
internal chore: use Docker Desktop proxy if available 2023-02-08 11:32:01 +01:00
lsp Delint 2023-02-03 09:54:07 +01:00
query chore: use Docker Desktop proxy if available 2023-02-08 11:32:01 +01:00
registry chore: use Docker Desktop proxy if available 2023-02-08 11:32:01 +01:00
sbom Fix python test 2023-03-11 09:23:49 +01:00
types Delint 2023-03-11 09:24:26 +01:00
.gitignore Add diff command 2022-10-28 16:25:28 +02:00
.golangci.yml chore: add golangci-lint task and config 2023-01-09 17:57:39 +01:00
.goreleaser.yaml Merge pull request #13 from eunomie/refactor-main 2023-01-24 22:21:12 +01:00
Dockerfile Update packages and hide generic packages that are already covered 2023-03-11 09:13:30 +01:00
LICENSE Initial commit 2022-10-27 07:44:35 +02:00
README.md Some more progress 2022-11-01 16:09:47 +01:00
Taskfile-bla.yaml Update from 4e9de2d11a4e64289302eff14f84265cdec48be2 2023-04-21 18:25:25 +00:00
Taskfile.yaml refactor: move main.go to cmd/docker-index folder 2023-01-10 10:07:45 +01:00
go.mod Update packages and hide generic packages that are already covered 2023-03-11 09:13:30 +01:00
go.sum Update packages and hide generic packages that are already covered 2023-03-11 09:13:30 +01:00
install.sh Run standalone 2022-10-27 22:41:00 +02:00

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 output
  • CVE_ID can be any known CVE id