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
  • Tests
  • Upgrading

Tutorial

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

Reference Documentation

• ScanPipe Concepts
  • Project
  • Project workspace
  • Pipelines
  • Codebase Resources
  • Discovered Packages
• ScanPipe Commands Help
  • $ scanpipe –help
  • $ scanpipe <subcommand> –help
  • $ scanpipe create-project <name>
  • $ scanpipe add-input –project PROJECT <input …>
  • $ scanpipe add-pipeline –project PROJECT <pipeline …>
  • $ scanpipe run –project PROJECT
  • $ scanpipe show-pipeline –project PROJECT
  • $ scanpipe output –project PROJECT <output_file>
  • $ scanpipe graph <pipeline …>
• ScanPipe REST API
• Offline packaging and installation
  • Offline Installation
  • Offline Upgrade

Indices and tables

• Index
• Search Page