.. _cli-scancode:

**ScanCode CLI**
================

Below is a quick reference of all ScanCode options.
For detailed descriptions and examples, please refer to the chapters in the table of
contents or the link to the detailed CLI options at the end of each section.

This has the same CLI options in the :ref:`cli-help-option`, available in the command line
but with more details and additional references.

----

.. _cli-scancode-basic-options:

.. include::  /rst-snippets/cli-basic-options.rst

For more details into the basic CLI options, see :ref:`cli-basic-options`.

----

.. _cli-scancode-core-options:

.. include::  /rst-snippets/cli-core-options.rst

For more details into the core CLI options, see :ref:`cli-core-options`.

----

.. _cli-scancode-output-format-options:

.. include::  /rst-snippets/cli-output-format-options.rst

For more details into the output format CLI options, see :ref:`cli-output-format-options`.

----

.. _cli-scancode-output-control-and-filter-options:

.. include::  /rst-snippets/cli-output-control-and-filter-options.rst

For more details into the output filter CLI options, see
:ref:`cli-output-control-and-filter-options`.

----

.. _cli-scancode-pre-scan-options:

.. include::  /rst-snippets/cli-pre-scan-options.rst

For more details into the pre-scan CLI options, see :ref:`cli-pre-scan-options`.

----

.. _cli-scancode-post-scan-options:

.. include::  /rst-snippets/cli-post-scan-options.rst

For more details into the post-scan CLI options, see :ref:`cli-post-scan-options`.

----

.. _cli-other-commands:

.. include::  /rst-snippets/cli-other-commands.rst

----

.. _cli-doc-help-options:

.. include::  /rst-snippets/cli-doc-help-options.rst

----

**Detailed reference for CLI options/commands**
-----------------------------------------------

.. toctree::

   cli-help-text-options
   cli-basic-options
   cli-core-options
   cli-output-format-options
   cli-output-control-and-filter-options
   cli-pre-scan-options
   cli-post-scan-options
   cli-extractcode
   cli-scancode-reindex-licenses
   cli-scancode-license-data
   cli-scancode-train-gibberish-model
