ScanCode.io Documentation

ScanCode.io provides a Web UI and API to run and review complex scans in rich scripted pipelines, on different kinds of containers, docker images, package archives, manifests etc, to get information on licenses, copyrights, sources, and vulnerabilities.

ScanCode.io provides an easy-to-use front-end to ScanCode Toolkit and other AboutCode projects.The flexible pipeline technology supports advanced scanning tasks such as container scanning and deploy-to-develop analysis. You can run ScanCode.io in a Docker container or install it on a Linux server. It provides full support for generating and consuming CycloneDX and SPDX SBOMs.

Documentation overview

The overview below outlines how the documentation is structured to help you know where to look for certain things.

Getting started

Start here if you are new to ScanCode.

• QuickStart

• ScanCode.io Overview

• Installation

• Contributing to ScanCode.io

• User Interface

Tutorials

Learn via practical step-by-step guides.

• Analyze Docker Image (Web UI)

• Review Scan Results (Web UI)

• Analyze Docker Image (Command Line)

• Analyse Package Archive (REST API)

• License Policies and Compliance Alerts

• Find vulnerabilities (Web UI)

• Symbol and String Collection (Web UI)

• Analyze Codebase End to End with DepLock and DejaCode (Command Line)

Reference Docs

Reference documentation for scancode features and customizations.

• Built-in Pipelines

• Custom Pipelines

• Project configuration

• Inputs

• Output Files

• Command Line Interface

• REST API

• License Policies and Compliance Alerts

• Data Models

• Automation

• Webhooks

• Application Settings

• Recognized Distros, OS, and Images

Explanations

Consult the reference to understand ScanCode.io concepts.

• ScanPipe Concepts

• Pipes

Misc

• FAQs

• Changelog

Something Missing?

If something is missing in the documentation or if you found some part confusing, please file an issue with your suggestions for improvement. Use the documentation issue label.

Your help makes ScanCode docs better, we love hearing from you!

Indices and tables

• Index

• Search Page