mirror of
https://github.com/github/codeql.git
synced 2025-12-22 03:36:30 +01:00
ed66388551
This moves the following three PRs to the 3.7 branch: - https://github.com/github/codeql/pull/10182 - https://github.com/github/codeql/pull/10146 - https://github.com/github/codeql/pull/10105
26 lines
1.3 KiB
ReStructuredText
26 lines
1.3 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-codeql-packs
|
|
about-codeql-workspaces
|
|
query-reference-files
|
|
sarif-output
|
|
exit-codes
|
|
extractor-options
|
|
|
|
- :doc:`About CodeQL packs <about-codeql-packs>`: CodeQL packs are created with the CodeQL CLI and are used to create, depend on, publish, and run CodeQL queries, libraries, and query suites.
|
|
- :doc:`About CodeQL workspaces <about-codeql-workspaces>`: CodeQL workspaces are used to group multiple CodeQL packs together.
|
|
- :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.
|
|
- :doc:`Extractor options <extractor-options>`: You can customize the behavior of extractors by setting options through the CodeQL CLI.
|