Synopsis

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

Description

[Experimental] Export diagnostic information from a database for afailed analysis.

Available sincev2.12.6.

Options

Primary Options

<database>

[Mandatory] Path to the CodeQL database under construction. This musthave been prepared for extraction withcodeql database init.

If the--db-cluster option is given, this is not a database itself,but a directory thatcontains databases, and all of those databaseswill be processed together.

--format=<format>

[Mandatory] The format in which to write the results. One of:

raw: A list of raw, uninterpreted diagnostic messages as JSON objects.

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.

text: A bullet point list of diagnostic messages.

--[no-]db-cluster

Indicates that the directory given on the command line is not a databaseitself, but a directory thatcontains one or more databases underconstruction. Those databases will be processed together.

-o, --output=<output>

The output path to write diagnostic information to.

--sarif-exit-code=<sarifExitCode>

[SARIF formats only] Exit code of the failing process.

--sarif-exit-code-description=<sarifExitCodeDescription>

[SARIF formats only] Reason that the failing process exited.

--sarif-category=<category>

[SARIF formats only] [Recommended] Specify a category for thisanalysis to include in the SARIF output. A category can be used todistinguish multiple analyses performed on the same commit andrepository, but on different languages or different parts of the code.

If you analyze the same version of a code base in several different ways(e.g., for different languages) and upload the results to GitHub forpresentation in Code Scanning, this value should differ between each ofthe analyses, which tells Code Scanning that the analysessupplementrather thansupersede each other. (The values should be consistentbetween runs of the same analysis fordifferent versions of the codebase.)

This value will appear (with a trailing slash appended if not alreadypresent) as the<run>.automationDetails.id property.

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.