Option 1: Earnie, ready to use
Earnie is SCANOSS’s governance platform. Choose it if you want SCANOSS to run the whole workflow for you:- policies that you define once and apply to every repository
- a merge gate on every pull request
- a review workspace to triage findings and record decisions
- dashboards across all your projects
- exportable evidence for customers and auditors
Go to Earnie
Policies, merge gates, triage, dashboards, and evidence in one platform.
Option 2: Standalone tools, build your own pipeline
Choose the standalone tools if you already have a pipeline, a results store, or a review process, and you want SCANOSS data inside it. You run the tools, you keep the output, and you decide what fails a build. SCANOSS does not maintain integrations for specific CI platforms. Instead, we publish Recipes. Each Recipe is a complete workflow written in plain shell commands, with an explanation of every step. Recipes run in any CI system, in a Git hook, or on a laptop.scanoss-cli uses the SCANOSS v3 API and does not work with OSSKB.org. If you depend on
OSSKB.org, use SCANOSS-PY.Which one fits?
Where to start
1
Get an API key
The hosted SCANOSS API at
https://api.scanoss.com requires an API key. See
API keys and authentication.2
Run your first scan
Install scanoss-cli, scan a project, and generate an SBOM in about five minutes. See
Quickstart.
3
Pick a Recipe
Copy a complete workflow into your pipeline. See Recipes.
Coming from scanoss-py or the v2 API
If you scan withscanoss-py, use a SCANOSS integration, or run a v2 deployment yourself, see
Migrating to v3. It explains what changes for
you and what keeps working on v2.
Use with AI coding agents
SCANOSS publishes agent skills that teach a coding agent to use scanoss-cli, Crypto Finder, the SCANOSS API, and the Recipes. Install them into your agent from the scanoss/skills repository:--skill, for example --skill scanoss-cli. Agents can also read
any page of these docs as Markdown by adding .md to its URL, and find every page from
llms.txt.