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
- Installation
- User Interface
- FAQs
- Contributing to ScanCode.io
- Changelog
- v31.1.0 (unreleased)
- v31.0.0 (2022-08-25)
- v30.2.0 (2021-12-17)
- v30.1.1 (2021-11-23)
- v30.1.0 (2021-11-22)
- 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
Reference Documentation
- ScanPipe Concepts
- Built-in Pipelines
- Custom Pipelines
- Pipes
- Data Models
- Output Files
- Command Line Interface
- $ scanpipe –help
- $ scanpipe <subcommand> –help
- $ scanpipe create-project <name>
- $ scanpipe list-project [–search SEARCH] [–include-archived]
- $ 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 reset-project –project PROJECT
- $ scanpipe delete-project –project PROJECT
- $ scanpipe create-user <username>
- REST API
- Application Settings
- Recognized Distros, OS, and Images