Synopsis

codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...

codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...

Description

Generate end-user query help from .qhelp files.

Options

Primary Options

<qhelp|mdhelp|query|dir|suite>...

[Mandatory] Query help files to render. Each argument is one of:

• A .qhelp file to render.
• A .md file to render.
• A .ql file with a corresponding .qhelp or .md file to render.
• A directory that will be searched recursively for .ql files withcorresponding .qhelp or .md files.
• A .qls file that defines a particular set of queries.
• The basename of a "well-known" .qls file exported by one of theinstalled QL packs.

--format=<format>

[Mandatory] The format in which to render the documentation. One of:

markdown: GitHub flavored markdown.

sarif-latest: Static Analysis Results Interchange Format (SARIF), aJSON-based format for describing static analysis results. This formatoption uses the most recent supported version (v2.1.0). This option isnot suitable for use in automation as it will produce different versionsof SARIF between different CodeQL versions.

sarifv2.1.0: SARIF v2.1.0.

-o, --output=<dir|file>

A path to write the rendered documentation to. Usually this is adirectory into which the rendered output will be written.

If only a single .qhelp or .ql file is provided, and no directory existsat the output path, the output will be written to a single file at thatpath.

If no output path is provided, only a single .qhelp or .ql file will beaccepted, and the output will be written to stdout.

If an output directory is used, filenameswithin the output directorywill be derived from the .qhelp file names.

--warnings=<mode>

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.

--no-sarif-minify

[SARIF formats only] Produce pretty-printed SARIF output. By default,SARIF output is minified to reduce the size of the output file.

Options for finding QL packs (which may be necessary to resolve query suites)

--search-path=<dir>[:<dir>...]

A list of directories under which QL packs may be found. Each directorycan either be a QL pack (or bundle of packs containing a.codeqlmanifest.json file at the root) or the immediate parent of oneor more such directories.

If the path contains more than one directory, their order definesprecedence between them: when a pack name that must be resolved ismatched in more than one of the directory trees, the one given firstwins.

Pointing this at a checkout of the open-source CodeQL repository oughtto work when querying one of the languages that live there.

If you have checked out the CodeQL repository as a sibling of theunpacked CodeQL toolchain, you don't need to give this option; suchsibling directories will always be searched for QL packs that cannot befound otherwise. (If this default does not work, it is stronglyrecommended to set up--search-path once and for all in a per-userconfiguration file).

(Note: On Windows the path separator is;).

--additional-packs=<dir>[:<dir>...]

If this list of directories is given, they will be searched for packsbefore the ones in--search-path. The order between these doesn'tmatter; it is an error if a pack name is found in two different placesthrough this list.

This is useful if you're temporarily developing a new version of a packthat also appears in the default path. On the other hand, it isnotrecommended to override this option in a config file; some internalactions will add this option on the fly, overriding any configuredvalue.

(Note: On Windows the path separator is;).

Options for configuring the CodeQL package manager

--registries-auth-stdin

Authenticate to GitHub Enterprise Server Container registries by passinga comma-separated list of <registry_url>=<token> pairs.

For example, you can passhttps://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2to authenticate to two GitHub Enterprise Server instances.

This overrides the CODEQL_REGISTRIES_AUTH and GITHUB_TOKEN environmentvariables. If you only need to authenticate to the github.com Containerregistry, you can instead authenticate using the simpler--github-auth-stdin option.

--github-auth-stdin

Authenticate to the github.com Container registry by passing agithub.com GitHub Apps token or personal access token via standardinput.

To authenticate to GitHub Enterprise Server Container registries, pass--registries-auth-stdin or use the CODEQL_REGISTRIES_AUTH environmentvariable.

This overrides the GITHUB_TOKEN environment variable.

Common options

-h, --help

Show this help text.

-J=<opt>

[Advanced] Give option to the JVM running the command.

(Beware that options containing spaces will not be handled correctly.)

-v, --verbose

Incrementally increase the number of progress messages printed.

-q, --quiet

Incrementally decrease the number of progress messages printed.

--verbosity=<level>

[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.

--logdir=<dir>

[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.

(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)

--common-caches=<dir>

[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.

Available sincev2.15.2.