AboutCode Documentation

Aboutcode Projects

• ScanCode-Toolkit Documentation
• Scancode-Workbench Documentation
• Deltacode Documentation
• AboutCode Docs
• AboutCode-Toolkit Documentation
• AboutCode Data : ABCD

Documentation Guide

• Help
  • AboutCode Projects
• License
• Document Maintenance
  • Document Software Setup
  • Clone AboutCode
  • Improve AboutCode Documents
  • Share AboutCode Document Improvements
  • Continuous Integration
  • Style Checks Using Doc8
  • Interspinx
  • Extra Style Checks
  • Converting from Markdown

Getting Started

• Are you new to Scancode-Toolkit?
  • Table of Contents
  • Try ScanCode Toolkit
  • Learn more about ScanCode Toolkit
  • Contribute

Tutorial Documents

• Basic Tutorials
  • How to Run a Scan
  • How to Visualize Scan results
  • How To Extract Archives
  • How to specify Scancode Output Format
  • How to set what will be detected in Scan
  • Add A Post-Scan Plugin

How-To Documents

• How-To Guides
  • How To Add a New License for Detection
  • How to Add New License Rules for Enhanced Detection

Reference Documents

• Command Line Interface Reference
  • Synopsis
  • Getting Help from the Command Line
  • All Available Options
  • How to Run a Scan
  • Basic Options
  • Core Options
  • Scancode Output Formats
  • Controlling Scancode Output and Filters
  • Pre-Scan Options
  • Post-Scan Options

Discussion Documents

• How it all Works
  • Overview

Indices and Tables

• Index

• Module Index

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 Improvement” template. Your help makes ScanCode docs better, we love hearing from you!