mirror of
https://github.com/github/codeql.git
synced 2025-12-16 16:53:25 +01:00
32 lines
1.2 KiB
ReStructuredText
32 lines
1.2 KiB
ReStructuredText
.. _codeql-cli-reference:
|
|
|
|
CodeQL CLI reference
|
|
====================
|
|
|
|
Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates.
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
:hidden:
|
|
|
|
about-ql-packs
|
|
query-reference-files
|
|
sarif-output
|
|
exit-codes
|
|
|
|
|
|
- :doc:`About QL packs <about-ql-packs>`: QL packs are used to organize the files used in CodeQL analysis. They
|
|
contain queries, library files, query suites, and important metadata.
|
|
- :doc:`Query reference files <query-reference-files>`: A query reference file is text file that defines the location of one query to test.
|
|
- :doc:`SARIF output <sarif-output>`: CodeQL supports SARIF as an output format for sharing static analysis results.
|
|
- :doc:`Exit codes <exit-codes>`: The CodeQL CLI reports the status of each command it runs as an exit code.
|
|
This exit code provides information for subsequent commands or for other tools that rely on the CodeQL CLI.
|
|
|
|
.. _cli-commands:
|
|
|
|
CodeQL CLI manual
|
|
-----------------
|
|
|
|
To view detailed information about each CodeQL CLI command,
|
|
including its usage and options, add the ``--help`` flag or visit the "`CodeQL CLI manual <../codeql-cli-manual>`__."
|