Earthly

Security scanning with Earthly builds.

Warning Snippets on this page install the current CLI release rather than pinning one, so they do not go stale. If one no longer works, open an issue with the output of vulnetix --version.

Before You Start

Credentials come from --secret on RUN, which mounts the value for that command only and never records it in a layer.

VariableValue
VULNETIX_ORG_IDOrganization UUID
VULNETIX_API_KEYApiKey hex digest

Environment variables authenticate on their own. Do not run vulnetix auth login on an ephemeral runner — see Authentication in CI/CD.

Quick Start

Earthfile:

VERSION 0.8
FROM golang:1.21

vulnetix-scan:
    RUN go install github.com/vulnetix/cli/v3@latest
    COPY . /workspace
    WORKDIR /workspace
    RUN --secret VULNETIX_ORG_ID --secret VULNETIX_API_KEY vulnetix auth verify
    RUN --secret VULNETIX_ORG_ID --secret VULNETIX_API_KEY vulnetix scan --severity high

vulnetix auth verify on the first line fails the build immediately when the credential is missing or revoked, rather than halfway through a scan.

Note RUN --secret VAR is the only correct way to pass a credential. A --build-arg is recorded in image metadata.

Running Individual Scans

Each subcommand runs standalone and uploads its own findings. Swap vulnetix scan for any of them:

vulnetix sca --severity high -o dist/sbom.cdx.json     # dependencies
vulnetix sast --severity high -o dist/sast.sarif       # source code
vulnetix secrets -o dist/secrets.sarif                 # hardcoded credentials
vulnetix license --allow MIT,Apache-2.0                # SPDX policy
vulnetix cbom --output-file dist/cbom.cdx.json         # cryptography, PQC posture
vulnetix aibom --output-file dist/aibom.cdx.json       # AI agents, SDKs, models

Note the flag split: the scan family takes -o <path>, while cbom, aibom, and malscan take --output-file. license takes neither. The full table is in the Subcommand Reference.

Keeping the Report

SAVE ARTIFACT dist/ AS LOCAL dist/

The SARIF-producing scans write their file only when there are findings, so a clean run leaves nothing behind. Tolerate the missing path rather than failing on it.

Quality Gates

Gates are opt-in; without a gate flag the command reports and exits 0.

vulnetix scan --severity high --block-malware --block-eol --exploits active

To surface a breach without blocking the merge: RUN ... || true inside the target.

Full gate list in the Subcommand Reference.

Uploading Third-Party Artifacts

The scans upload themselves. upload is for reports produced by other tools:

vulnetix upload --file reports/semgrep.sarif --format sarif

Accepted formats: cyclonedx, spdx, sarif, openvex, csaf_vex.

See Also