Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.26 KB

how_to_format_scan_output.rst

File metadata and controls

40 lines (23 loc) · 1.26 KB
Raw

How to specify Scancode Output Format

A basic overview of formatting Scancode Output is presented here.

More information on :ref:`cli_output_format`.

JSON

If you want JSON output of ScanCode results, you can pass the --json argument to ScanCode. The following commands will output scan results in a formatted json file:

  • ./scancode --json /path/to/output.json /path/to/target/dir
  • ./scancode --json-pp /path/to/output.json /path/to/target/dir
  • ./scancode --json-lines /path/to/output.json /path/to/target/dir

To compare the JSON output in different formats refer :ref:`comparing_json`.

HTML

If you want HTML output of ScanCode results, you can pass the --html argument to ScanCode. The following commands will output scan results in a formatted HTML page or simple web application:

  • ./scancode --html /path/to/output.html /path/to/target/dir
  • ./scancode --html-app /path/to/output.html /path/to/target/dir

For more details on the HTML output format refer :ref:`output_html`.

Warning

The --html-app option has been deprecated, use Scancode Workbench instead.