ScanCode.io documentation

ScanCode.io is a server to script and automate software composition analysis with ScanPipe pipelines. First application is for Docker container and VM composition analysis.

Getting Started

• Why ScanCode.io
  • What is ScanPipe
  • Should I use ScanPipe
• Installation
  • Pre-requisite
  • Local installation
  • Database
  • Tests
  • Web Application
  • Upgrading
• Docker image
  • Get Docker
  • Build the Image
  • Run the Image

Tutorial

• Docker Image Analysis (command line)
  • Requirements
  • Before you start
  • Step-by-step
• Scan Codebase (command line)
  • Requirements
  • Before you start
  • Step-by-step

Reference Documentation

• ScanPipe Concepts
  • Project
  • Project workspace
  • Pipelines
  • Codebase Resources
  • Discovered Packages
• Pipelines
  • Pipeline Base Class
  • Docker Image Analysis
  • Load Inventory From Scan
  • Root Filesystem Analysis
  • Scan Codebase
• Pipes
  • Generic
  • Alpine
  • Codebase
  • Compliance
  • Debian
  • Docker
  • Output
  • RootFS
  • ScanCode
• ScanPipe Commands Help
  • $ 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 delete-project –project PROJECT
• ScanPipe REST API
  • Add pipeline
  • Errors
  • File content
  • Packages
  • Resources
  • Results
  • Results (download)
• ScanCode.io Settings
  • DATABASE
  • SCANCODEIO_PROCESSES
  • SCANCODE_DEFAULT_OPTIONS
  • SCANCODEIO_POLICIES_FILE
• Offline packaging and installation
  • Offline Installation
  • Offline Upgrade

Indices and tables

• Index
• Search Page