ScanCode.io documentation

Welcome to the very start of your ScanCode.io journey! In this documentation you’ll find information on:

• An overview of ScanCode.io and ScanPipe

• Installation instructions

• Tutorials to get you started

• Reference documentation about the ScanPipe concepts, Pipelines, Pipes and more

• How to make technical contributions to the project and the community

Getting Started

• ScanCode.io Overview
  • Why ScanCode.io?
  • What is ScanPipe?
  • Should I use ScanPipe?
  • Dependencies and Internal Tools
• Installation
  • Run with Docker
  • Offline installation with Docker
  • Local development installation
• User Interface
  • Home Screen
  • Creating a New Project
  • Archiving a Project
  • Deleting a Project
• FAQs
  • How can I run a scan?
  • I am unable to run ScanCode.io on Windows?
  • Is it possible to compare scan results?
  • How can I trigger a pipeline scan from a CI/CD, such as Jenkins, TeamCity or Azure Devops?
• Contributing to ScanCode.io
  • Do Your Homework
  • Ways to Contribute
  • Helpful Resources
• Changelog
  • Unreleased
  • v30.0.1 (2021-10-11)
  • v30.0.0 (2021-10-8)
  • v21.9.6
  • v21.8.2
  • v21.6.10
  • v21.5.12
  • v21.4.28
  • v21.4.14
  • v21.4.5
  • v1.1.0 (2021-02-16)
  • v1.0.7 (2021-02-01)
  • v1.0.6 (2020-12-23)
  • v1.0.5 (2020-12-07)
  • v1.0.4 (2020-11-17)
  • v1.0.3 (2020-09-24)
  • v1.0.2 (2020-09-18)
  • v1.0.1 (2020-09-12)
  • v1.0.0 (2020-09-09)

Tutorial

• Analyze Docker Image (Web UI)
  • Requirements
  • Instructions
• Review Scan Results (Web UI)
  • Packages
  • Resources
  • Errors
  • Other Information
• Analyze Docker Image (Command Line)
  • Requirements
  • Instructions
• Analyze Codebase (Command Line)
  • Requirements
  • Instructions
• Analyse Package Archive (REST API)
  • Using cURL
  • Using Python script

Reference Documentation

• ScanPipe Concepts
  • Project
  • Project workspace
  • Pipelines
  • Pipes
  • Codebase Resources
  • Discovered Packages
• Built-in Pipelines
  • Pipeline Base Class
  • Docker Image Analysis
  • Docker Windows Image Analysis
  • Load Inventory From Scan
  • Root Filesystem Analysis
  • Scan Codebase
  • Scan Package
• Custom Pipelines
  • Pipeline registration
  • Create a Pipeline
  • Modify Existing Pipelines
  • Custom Pipeline Example
  • Pipeline Packaging
  • Pipeline Packaging Example
  • Pipeline Publishing to PyPI
• Pipes
  • Generic
  • Alpine
  • Codebase
  • Compliance
  • Debian
  • Docker
  • Windows
  • Fetch
  • Input
  • Output
  • RootFS
  • RPM
  • ScanCode
• Data Models
  • Project
  • CodebaseResource
  • DiscoveredPackage
  • ProjectError
  • Run
• Output Files
  • Creating Output Files
  • Understanding Output Files
• Command Line Interface
  • $ scanpipe –help
  • $ scanpipe <subcommand> –help
  • $ scanpipe create-project <name>
  • $ scanpipe add-input –project PROJECT [–input-file FILES] [–input-url URLS]
  • $ scanpipe add-pipeline –project PROJECT PIPELINE_NAME [PIPELINE_NAME …]
  • $ scanpipe execute –project PROJECT
  • $ scanpipe show-pipeline –project PROJECT
  • $ scanpipe status –project PROJECT
  • $ scanpipe output –project PROJECT –format {json,csv,xlsx}
  • $ scanpipe graph [PIPELINE_NAME …]
  • $ scanpipe archive-project –project PROJECT
  • $ scanpipe delete-project –project PROJECT
• REST API
  • Authentication
  • Project list
  • Create a project
  • Project details
  • Managing projects
  • Run details
  • Managing pipeline runs
• Application Settings
  • DATABASE
  • TIME_ZONE
  • SCANCODEIO_WORKSPACE_LOCATION
  • SCANCODEIO_PROCESSES
  • SCANCODEIO_ASYNC
  • SCANCODE_TOOLKIT_CLI_OPTIONS
  • SCANCODEIO_PIPELINES_DIRS
  • SCANCODEIO_POLICIES_FILE
  • SCANCODEIO_REST_API_PAGE_SIZE
  • SCANCODEIO_LOG_LEVEL
• Recognized Distros, OS, and Images
  • Archives Formats
  • Operating Systems Detection
  • Installed System Packages

Indices and tables

• Index

• Search Page