Skip to content

Commit 3bfa868

Browse files
committed
add new option to database analyze tutorial
1 parent e9b1146 commit 3bfa868

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ You can also specify:
6363
language to the GitHub code scanning API. For more information about this use case,
6464
see `Configuring CodeQL CLI in your CI system <https://docs.github.com/en/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system>`__ in the GitHub documentation.
6565

66+
- ``--sarif-add-query-help``: (supported in version 2.7.1 onwards) adds any custom query help written
67+
in Markdown to SARIF (v2.1.0 or later) analysis results. For each query that runs, CodeQL command
68+
replaces the ``.ql`` extension of the query file with ``.md``. If the .md file exists,
69+
its contents are treated as Markdown-formatted help text for the query and included in the SARIF output.
70+
6671
- .. include:: ../reusables/threads-query-execution.rst
6772

6873

0 commit comments

Comments
 (0)