Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.77 KB

license-scanner.md

File metadata and controls

52 lines (37 loc) · 1.77 KB

license-scanner

license-scanner: scan files to detect licenses

Synopsis

LICENSE-SCANNER

Scan files to detect licenses.

Example usage to print copyrights, hash codes, and blocks found in file LICENSE.txt:

$ license-scanner -c -x -f LICENSE.txt

Example usage to scan LICENSE.txt, but only print the license IDs and positions of license matches:

$ license-scanner --quiet -f LICENSE.txt

Please give us feedback at: https://github.com/CycloneDX/license-scanner/issues

license-scanner [flags]

Options

  -g, --acceptable          Flag acceptable
      --addAll string       Add licenses from this dir to spdx, spdxPath, custom or customPath dir
      --configName string   Base name for config file (default "config")
      --configPath string   Path to any config files
  -c, --copyrights          Flag copyrights
      --custom string       Custom templates to use (default "default")
      --customPath string   Path to external custom templates to use
  -d, --debug               Enable debug logging
      --dir string          A directory in which to identify licenses
  -f, --file string         A file in which to identify licenses
  -x, --hash                Output file hash
  -h, --help                help for license-scanner
  -k, --keywords            Flag keywords
  -l, --license string      Display match debugging for the given license
      --list                List the license templates to be used
  -n, --normalized          Flag normalized
  -q, --quiet               Set logging to quiet
      --spdx string         Set of embedded SPDX templates to use (default "default")
      --spdxPath string     Path to external SPDX templates to use
      --updateAll           Update existing licenses
Auto generated by spf13/cobra on 15-Aug-2023