AboutCode
update-docs
  • ScanCode-Toolkit Documentation
    • Getting Started
    • Command Line Interface Reference
    • Plugins
    • 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 Guides
    • How it all Works
    • Contribute
    • Miscellaneous
  • Scancode-Workbench Documentation
  • Deltacode Documentation
  • AboutCode Docs
  • AboutCode-Toolkit Documentation
  • AboutCode Data : ABCD
  • Help
  • License
  • Document Maintenance
  • Are you new to Scancode-Toolkit?
  • 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 Guides
  • Command Line Interface Reference
  • How it all Works
AboutCode
  • Docs »
  • ScanCode-Toolkit Documentation »
  • Basic Tutorials
  • Edit on GitHub

Basic Tutorials¶

  • How to Run a Scan
    • Prerequisites
    • Setting up a Virtual Environment
    • Setting up Scancode Toolkit
    • Looking into Files
    • Performing Extraction
    • Deciding Scan Options
    • Running The Scan
    • Other Important Documentation
  • How to Visualize Scan results
    • Setting up Scancode Workbench
    • Importing Data into Scancode Workbench
    • Visualization
  • How To Extract Archives
    • Usage:
    • All Extractcode Options
  • How to specify Scancode Output Format
    • JSON
    • Print to stdout (Terminal)
    • HTML
    • Custom Output Format
  • How to set what will be detected in Scan
    • All “Basic” Scan Options
    • Different Scans
  • Add A Post-Scan Plugin
    • Built-In vs. Optional Installation
    • Example Post-Scan Plugin: Hello ScanCode
    • Load the plugin
    • More-complex examples
Next Previous

© Copyright 2019 AboutCode.org Revision 214b8e89.

Built with Sphinx using a theme provided by Read the Docs.