Skip to main content
Version: v0.19.0

Getting Started

regis-cli is designed to be easy to set up and run, whether locally or in a CI/CD environment.

Installation​

The easiest way to use regis-cli without managing local dependencies is to use the official Docker image. It comes pre-packaged with Skopeo, Trivy, Hadolint, and Dockle.

docker run --rm trivoallan/regis-cli --help

Local Installation​

Prerequisites​

The requirements depend on whether you use the Docker image or install the tool locally.

  • Core Requirement:
    • Skopeo: Essential for multi-architecture registry inspection and metadata extraction.
  • Optional Analyzers:
    • Trivy: Required for vulnerability scanning and SBOM generation.
    • Hadolint: Required for Dockerfile linting.
    • Dockle: Required for container image security linting.
pip install regis-cli
tip

For developers wanting to contribute to the project, use Pipenv: pipenv install --dev