Skip to main content
scanoss.go is SCANOSS’s Go CLI and SDK. It is the CLI we recommend from now on for customers who integrate SCANOSS into their pipelines. It installs as the scanoss-cli binary, named after its Go package directory. The name also avoids a clash on your PATH with the SCANOSS scan engine, which is called scanoss.
scanoss-cli talks to the SCANOSS v3 API and is not compatible with OSSKB.org. If you depend on OSSKB.org, use SCANOSS-PY instead.

​
Prerequisites

  • Go 1.25+. You need it only if you install with go install or build from source.

​
Installation

​
go install

​
Prebuilt binary

Download the archive for your platform from the releases page, extract it, and move the scanoss-cli binary onto your PATH:
On Windows, unzip the archive and add the folder to your PATH. On macOS, Gatekeeper may quarantine an unsigned direct download. To clear the quarantine, run:
Verify a download against the published checksums:

​
Docker

Every release publishes multi-arch images for linux/amd64 and linux/arm64 to GitHub Container Registry:
Use :latest or a specific version tag such as :0.9.0. Using Docker explains a permission issue with writing output and has more examples.

​
Build from source

​
Go SDK

The same repository is also a Go SDK, github.com/scanoss/scanoss.go/pkg/scanoss. It provides scanning, a parallel decoration pipeline over PURLs, and a client for each service. See the repository README for usage.

​
Verify installation

​
What’s next

  • Scan a project in one command with the quick start.
  • Store your API key once instead of passing it on every command. See Configuration.