Quickstart

Install SBOMBox

One command installs everything. Generate SBOMs locally, then sync only the SBOM to your project.

Your source code and build context stay in your environment.

Requirements

1. Install

curl -fsSL https://sbombox.com/install.sh | sh

The installer, which you can read first at sbombox.com/install.sh:

You don't choose between them: sbombox picks the most accurate one for each project. See how the generator is chosen.

Installing with uv or pipx instead gives you the CLI only. Scoring and compliance checks work as they are; to generate SBOMs, add syft as shown under Troubleshooting.

On Windows (PowerShell), install uv, then the CLI, then syft from its releases page:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
uv tool install sbombox

Check the install:

sbombox --version

2. Sign in

sbombox login

Opens your browser to approve the sign-in. The token is kept in your OS keychain, never in shell history; sbombox logout removes it.

3. Set up a repository

sbombox init

From the repository root. It chooses the project, allows the repository's CI to upload without a secret, and writes the GitHub workflow (or prints the GitLab lines). Commit and push: every CI run now produces a scored, audited SBOM. See GitHub Action for the details and other CI systems.

4. Your first SBOM

sbombox generate            # writes sbom.json (CycloneDX 1.6)
sbombox score sbom.json     # quality score, 0-10
sbombox push sbom.json      # upload to your project

Everything up to push runs on your machine. See the CLI reference for every command.

Installer options

The defaults suit almost everyone. To change them, set variables in front of sh:

# A specific CLI version, and every generator
curl -fsSL https://sbombox.com/install.sh | SBOMBOX_VERSION=0.2.0 SBOMBOX_GENERATORS=all sh

# CI image: don't edit shell profiles
curl -fsSL https://sbombox.com/install.sh | SBOMBOX_NO_MODIFY_PATH=1 sh
VariableDefaultEffect
SBOMBOX_VERSIONcurrentPin a CLI version, e.g. 0.2.0, for reproducible CI. By default the installer installs the version SBOMBox publishes as current, and it refuses versions below the supported minimum.
SBOMBOX_GENERATORSautoComma-separated: syft, cyclonedx-py, cyclonedx-npm, cdxgen, auto, all or none. auto installs syft, cyclonedx-py, and cyclonedx-npm only when Node.js 20+ has an npm older than 9.5 (newer npm makes SBOMs itself). Add cdxgen (needs Node.js 24+) for Java and Gradle projects.
SBOMBOX_SYFT_VERSIONv1.57.1syft version. The download is always checked against syft's published SHA-256.
SBOMBOX_BIN_DIR~/.local/binWhere to put syft.
SBOMBOX_SKIP_CLI-Set to 1 to install only generators.
SBOMBOX_NO_MODIFY_PATH-Set to 1 to leave shell profiles unchanged (CI, managed machines).
SBOMBOX_API_URLhttps://api.sbombox.comSelf-hosted SBOMBox: where to read the version policy.

Upgrade and uninstall

sbombox upgrade

Installs the version SBOMBox publishes as current. The CLI tells you once a day when a newer version is available, and SBOMBox refuses versions that are no longer supported, so nobody is left on an unsafe release. Running the installer again also upgrades. To uninstall:

uv tool uninstall sbombox
rm ~/.local/bin/syft          # if the installer added it

Troubleshooting

MessageWhat to do
sbombox: command not foundOpen a new shell, or add ~/.local/bin (the directory printed at the end of the install) to your PATH.
Generation failed / no SBOM generator foundRun the installer again; it adds any missing generators. If you installed with uv or pipx, add them with curl -fsSL https://sbombox.com/install.sh | SBOMBOX_SKIP_CLI=1 sh.
No lockfile for npm (or pypi, go...)Commit your lockfile (package-lock.json, uv.lock, poetry.lock, go.sum, Cargo.lock). Without it no generator can list transitive dependencies or exact versions.
checksum mismatchThe syft download did not match its published checksum, so nothing was installed. Retry; if it persists, a proxy may be altering downloads. Contact your network team or SBOMBox support.
could not downloadThe machine cannot reach github.com. Install syft from your internal mirror and re-run with SBOMBOX_GENERATORS=none.
skipping cdxgen: needs Node.js 24 or newercdxgen needs Node.js 24+ and cyclonedx-npm needs Node.js 20+. syft covers the same ecosystems without either.
Could not detect project ecosystemRun from the directory with your manifest, or pass --dir path/to/project.
Self-hosted SBOMBoxSet SBOMBOX_API_URL, or api_url in .sbombox.yml.