This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the
--help option in your terminal.
codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|query|dir|suite>...
Generate end-user query help from .qhelp files.
[Mandatory] Query help files to render. Each argument is one of:
- A .qhelp file to render.
- A .ql file with a corresponding .qhelp file to render.
- A directory that will be searched recursively for .ql files with corresponding .qhelp files.
- A .qls file that defines a particular set of queries.
- The basename of a "well-known" .qls file exported by one of the installed QL packs.
[Mandatory] The format in which to render the documentation. One of:
markdown: GitHub flavored markdown.
sarif-latest: Static Analysis Results Interchange Format (SARIF), a
JSON-based format for describing static analysis results. This format
option uses the most recent supported version (v2.1.0). This option is
not suitable for use in automation as it will produce different versions
of SARIF between different CodeQL versions.
sarifv2.1.0: SARIF v2.1.0.
A path to write the rendered documentation to. Usually this is a directory into which the rendered output will be written.
If only a single .qhelp or .ql file is provided, and no directory exists at the output path, the output will be written to a single file at that path.
If no output path is provided, only a single .qhelp or .ql file will be accepted, and the output will be written to stdout.
If an output directory is used, filenames within the output directory will be derived from the .qhelp file names.
How to handle warnings from the query help renderer. One of:
hide: Suppress warnings.
show (default): Print warnings but continue with rendering.
error: Treat warnings as errors.
A list of directories under which QL packs may be found. Each directory
can either be a QL pack (or bundle of packs containing a
.codeqlmanifest.json file at the root) or the immediate parent of one
or more such directories.
If the path contains more than one directory, their order defines precedence between them: when a pack name that must be resolved is matched in more than one of the directory trees, the one given first wins.
Pointing this at a checkout of the open-source CodeQL repository ought to work when querying one of the languages that live there.
If you have checked out the CodeQL repository as a sibling of the
unpacked CodeQL toolchain, you don't need to give this option; such
sibling directories will always be searched for QL packs that cannot be
found otherwise. (If this default does not work, it is strongly
recommended to set up
--search-path once and for all in a per-user
(Note: On Windows the path separator is
If this list of directories is given, they will be searched for packs
before the ones in
--search-path. The order between these doesn't
matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack that also appears in the default path. On the other hand, it is not recommended to override this option in a config file; some internal actions will add this option on the fly, overriding any configured value.
(Note: On Windows the path separator is
Authenticate to GitHub Enterprise Server Container registries by passing
a comma-separated list of \<registry_url>=\
For example, you can pass
to authenticate to two GitHub Enterprise Server instances.
This overrides the CODEQL_REGISTRIES_AUTH and GITHUB_TOKEN environment
variables. If you only need to authenticate to the github.com Container
registry, you can instead authenticate using the simpler
Authenticate to the github.com Container registry by passing a github.com GitHub Apps token or personal access token via standard input.
To authenticate to GitHub Enterprise Server Container registries, pass
--registries-auth-stdin or use the CODEQL_REGISTRIES_AUTH environment
This overrides the GITHUB_TOKEN environment variable.
Show this help text.
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
Incrementally increase the number of progress messages printed.
Incrementally decrease the number of progress messages printed.
[Advanced] Explicitly set the verbosity level to one of errors,
warnings, progress, progress+, progress++, progress+++. Overrides
[Advanced] Write detailed logs to one or more files in the given directory, with generated names that include timestamps and the name of the running subcommand.
(To write a log file with a name you have full control over, instead
--log-to-stderr and redirect stderr as desired.)