Command Line Interface Reference

• Synopsis
  • Installation
  • Quickstart
  • Type of Options
  • Output Formats
  • Other Important Documentation
• Getting Help from the Command Line
  • All Documentation/Help Options
  • Help text
  • Command Examples Text
  • Plugins Help Text
  • --list-packages Option
  • --print-options Option
• All Available Options
  • All “Basic” Scan Options
  • All Extractcode Options
  • scancode-reindex-licenses Usage
  • Options
  • All “Core” Scan Options
  • All Scan Output Options
  • All “Output Control” Scan Options
  • All “Pre-Scan” Options
  • All “Post-Scan” Options
• How to Run a Scan
  • Prerequisites
  • Looking into Files
  • Performing Extraction
  • Deciding Scan Options
  • Running The Scan
  • Other Important Documentation
• Other available CLIs
  • scancode-reindex-licenses Usage
  • Options
  • All Extractcode Options
  • scancode-reindex-licenses command
• Basic Options
  • All “Basic” Scan Options
  • --copyright Option
  • --license Option
  • --package Option
  • --info Option
  • --email Option
  • --url Option
  • --generated Option
  • --max-email Option
  • --max-url Option
  • --license-score Option
  • --license-text Option
  • --license-url-template Option
  • --license-text-diagnostics Option
  • --license-diagnostics Option
• Core Options
  • All “Core” Scan Options
  • Comparing Progress Message Options
  • --timeout Option
  • --from-json Option
  • --max-in-memory Option
  • --max_depth Option
• Scancode Output Formats
  • All Scan Output Options
  • Print to stdout (Terminal)
  • --json FILE
  • --json-pp FILE
  • --json-lines FILE
  • Comparing Different json Output Formats
  • --spdx-rdf FILE
  • --spdx-tv FILE
  • --html FILE
  • --html-app FILE
  • --csv FILE
  • --cyclonedx FILE
  • --cyclonedx-xml FILE
  • Custom Output Format
• Controlling Scancode Output and Filters
  • All “Output Control” Scan Options
  • --strip-root Vs. --full-root
  • --ignore-author <pattern> Option
  • --ignore-copyright-holder <pattern> Option
  • --only-findings Plugin
• Pre-Scan Options
  • All “Pre-Scan” Options
  • --ignore Option
  • --include Option
  • --classify
  • --facet Option
  • Glob Pattern Matching
  • What is a Facet?
• Post-Scan Options
  • All “Post-Scan” Options
  • --mark-source Option
  • --consolidate Option
  • --filter-clues Option
  • --license-clarity-score Option
  • --license-policy FILE Option
  • --license-references Option
  • --summary Option
  • --tallies Option
  • --tallies-by-facet Option
  • --tallies-key-files Option
  • --tallies-with-details Option