ScanCode Toolkit Documentation

Welcome to ScanCode Toolkit Documentation!

If you are new to ScanCode Toolkit, start here:

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

Here’s a list of more Documentation Pages:

• A Synopsis of ScanCode Command Line Options

• Tutorials on How to Run a Scan and How to Visualize Scan results

• An exhaustive List of All Available Options

• Documentation on Contributing to Code Development

• Documentation on Plugin Architecture

• FAQ

---

Getting Started

• Getting Started
  • Home
  • Comprehensive Installation
  • Are you new to Scancode-Toolkit?

---

Command Line Options Reference

Reference documents describe the Command Line options, and application concepts in depth.

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

---

Tutorials

Tutorial documents provide specific instructions to help you get started.

• 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 documents explain how to accomplish specific tasks.

• How-To Guides
  • How To Add a New License for Detection
  • How to Add New License Rules for Enhanced Detection
  • How to Install External Licenses to Use in License Detection
  • How To Generate Attribution from a ScanCode Scan

---

Contribute To ScanCode

• Contribute
  • Contributing to Code Development
  • How to cut a new release
  • Contributing to the Documentation
  • Roadmap
  • Google Summer of Code 2017 - Final report
  • Google Summer of Code 2019 - Final report
  • Google Summer of Code 2021 Final report

---

Plugins Documentation

• Plugins
  • Plugin Architecture
  • License Policy Plugin
  • Plugin Tutorials
  • CPP Includes Plugin
  • LKMClue Plugin
  • Dwarf Plugin

---

Miscellaneous Documents

• Miscellaneous
  • FAQ
  • Support
  • Runtime Performance Reports
  • Versioning approach

Reference Documents

Reference documents provide reference pages for technical reference information about ScanCode Toolkit, including how it works and supported features.

• Reference Docs
  • Overview
  • License Detection Updates
  • Supported package manifests and package datafiles

---

Indices and Tables

• Index

• Module Index

• Search Page

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!