Note
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.
Synopsis
codeql database analyze --format=--output=
codeql database analyze --format= --output= Description
Analyze a database, producing meaningful results in the context of the source code.
Run a query suite (or some individual queries) against a CodeQL database, producing results, styled as alerts or paths, in SARIF or another interpreted format.
This command combines the effect of the codeql database run-queries and codeql database interpret-results commands. If you want to run queries whose results don't meet the requirements for being interpreted as source-code alerts, use codeql database run-queries or codeql query run instead, and then codeql bqrs decode to convert the raw results to a readable notation.
Options
Primary Options
[Mandatory] Path to the CodeQL database to query.
...
Queries to execute. Each argument is in the form scope/name@range:path
where:
scope/nameis the qualified name of a CodeQL pack.rangeis a semver range.pathis a file system path.
If a scope/name is specified, the range and path are optional. A
missing range implies the latest version of the specified pack. A
missing path implies the default query suite of the specified pack.
The path can be one of a *.ql query file, a directory containing one
or more queries, or a .qls query suite file. If there is no pack name
specified, then a path must be provided, and will be interpreted
relative to the current working directory of the current process.
To specify a path that contains a literal @ or :, use path: as a
prefix to the argument, like this: path:directory/with:and@/chars.
If a scope/name and path are specified, then the path cannot be
absolute. It is considered relative to the root of the CodeQL pack.
If no queries are specified, the CLI will automatically determine a
suitable set of queries to run. In particular, if a Code Scanning
configuration file was specified at database creation time using
--codescanning-config then the queries from this will be used.
Otherwise, the default queries for the language being analyzed will be
used.
--format=
[Mandatory] The format in which to write the results. One of:
csv: Formatted comma-separated values, including columns with both
rule and alert metadata.
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.
graphtext: A textual format representing a graph. Only compatible with
queries with @kind graph.
dgml: Directed Graph Markup Language, an XML-based format for
describing graphs. Only compatible with queries with @kind graph.
dot: Graphviz DOT language, a text-based format for describing graphs.
Only compatible with queries with @kind graph.
-o, --output=
[Mandatory] The output path to write results to. For graph formats this should be a directory, and the result (or results if this command supports interpreting more than one query) will be written within that directory.
--[no-]rerun
Evaluate even queries that seem to have a BQRS result stored in the database already.
--no-print-diagnostics-summary
Don't print a summary of the analyzed diagnostics to standard output.
--no-print-metrics-summary
Don't print a summary of the analyzed metrics to standard output.
--max-paths=
The maximum number of paths to produce for each alert with paths. (Default: 4)
--[no-]sarif-add-file-contents
[SARIF formats only] Include the full file contents for all files referenced in at least one result.
--[no-]sarif-add-snippets
[SARIF formats only] Include code snippets for each location mentioned in the results, with two lines of context before and after the reported location.
--[no-]sarif-add-query-help
[SARIF formats only] [Deprecated] Include Markdown query help for
all queries. It loads query help for /path/to/query.ql from the
/path/to/query.md file. If this flag is not supplied the default
behavior is to include help only for custom queries i.e. those in query
packs which are not of the form `codeql/
--sarif-include-query-help=
[SARIF formats only] Specify whether to include query help in the SARIF output. One of:
always: Include query help for all queries.
This option has no effect when passed to codeql bqrs interpret. Available since [Advanced] [SARIF formats only] Do not include alert provenance
information in the SARIF output. Available since [SARIF formats only] Place the rule object for each query under its
corresponding QL pack in the [SARIF formats only] For alerts that have multiple causes, include
them as a Markdown-formatted itemized list in the output in addition to
as a plain string. [SARIF formats only] Produce pretty-printed SARIF output. By default,
SARIF output is minified to reduce the size of the output file. [SARIF formats only] A key value pair to add to the generated SARIF
'run' property bag. Can be repeated. [SARIF formats only] Produce one result per message, rather than one
result per unique location. The format in which to produce locations in CSV output. One of: uri,
line-column, offset-length. (Default: line-column) A format string defining the format in which to produce file location
URLs in DOT output. The following place holders can be used {path}
{start:line} {start:column} {end:line} {end:column}, {offset}, {length} [GitHub.com and GitHub Enterprise Server v3.12.0+ only] Use
sub-language file coverage information. This calculates, displays, and
exports separate file coverage information for languages which share a
CodeQL extractor like C and C++, Java and Kotlin, and JavaScript and
TypeScript. Available since [SARIF formats only] [Recommended] Specify a category for this
analysis to include in the SARIF output. A category can be used to
distinguish multiple analyses performed on the same commit and
repository, 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 for
presentation in Code Scanning, this value should differ between each of
the analyses, which tells Code Scanning that the analyses supplement
rather than supersede each other. (The values should be consistent
between runs of the same analysis for different versions of the code
base.) This value will appear (with a trailing slash appended if not already
present) as the [Advanced] Omit extension packs stored in the database during database
creation, either from a Code Scanning configuration file or from
extension files stored in the 'extensions' directory of the analyzed
codebase. [Advanced] Omit threat model configuration stored in the database
during database creation from a Code Scanning configuration file. Download any missing queries before analyzing. A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated. A list of threat models to enable or disable. The argument is the name of a threat model, optionally preceded by a
'!'. If no '!' is present, the named threat model and all of its
descendants are enabled. If a '!' is present, the named threat model
and all of its descendants are disabled. The 'default' threat model is enabled by default, but can be disabled
by specifying '--threat-model !default'. The 'all' threat model can be used to enable or disable all threat
models. The --threat-model options are processed in order. For example,
'--threat-model local --threat-model !environment' enables all of
the threat models in the 'local' group except for the 'environment'
threat model. This option only has an effect for languages that support threat models. Available since [Advanced] Display tuple counts for each evaluation step in the query
evaluator logs. If the [Advanced] Set the timeout length for query evaluation, in seconds. The timeout feature is intended to catch cases where a complex query
would take "forever" to evaluate. It is not an effective way to limit
the total amount of time the query evaluation can take. The evaluation
will be allowed to continue as long as each separately timed part of the
computation completes within the timeout. Currently these separately
timed parts are "RA layers" of the optimized query, but that might
change in the future. If no timeout is specified, or is given as 0, no timeout will be set
(except for codeql test run, where the default timeout is 5 minutes). Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine,
or -N to leave N cores unused (except still use at least one
thread). [Advanced] Aggressively write intermediate results to the disk cache.
This takes more time and uses (much) more disk space, but may speed up
the subsequent execution of similar queries. [Advanced] Make decisions about which predicates to evaluate, and what
to write to the disk cache, based on the assumption that the cache will
be discarded after the queries have been executed. [Advanced] Don't clean up the disk cache after evaluation completes.
This may save time if you're going to do codeql dataset cleanup or codeql database cleanup afterwards anyway. Set the maximum amount of space that the disk cache for intermediate
query results can use. If this size is not configured explicitly, the evaluator will try to use
a "reasonable" amount of cache space, based on the size of the dataset
and the complexity of the queries. Explicitly setting a higher limit
than this default usage will enable additional caching which can speed
up later queries. [Advanced] Set target amount of free space on file system. If [Advanced] Set target fraction of free space on file system. If A CSV file that contains rows for external predicate [Advanced] Controls whether to show progress tracking during QL
evaluation using xterm control sequences. Possible values are: [Advanced] Output structured logs about evaluator performance to the
given file. The format of this log file is subject to change with no
notice, but will be a stream of JSON objects separated by either two
newline characters (by default) or one if the [Advanced] If the The query evaluator will try hard to keep its total memory footprint
below this value. (However, for large databases it is possible that the
threshold may be broken by file-backed memory maps, which can be swapped
to disk in case of memory pressure). The value should be at least 2048 MB; smaller values will be
transparently rounded up. How to handle warnings from the QL compiler. One of: Don't emit source location info in RA for debugging. [Deprecated] [Advanced] Omit particularly slow optimization steps. [Advanced] Use the newest compiler features, at the cost of
portability. From time to time, new QL language features and evaluator optimizations
will be supported by the QL evaluator a few releases before they are
enabled by default in the QL compiler. This helps ensure that the
performance you experience when developing queries in the newest CodeQL
release can be matched by slightly older releases that may still be in
use for Code Scanning or CI integrations. If you do not care about your queries being compatible with other
(earlier or later) CodeQL releases, you can sometimes achieve a small
amount of extra performance by using this flag to enable recent
improvements in the compiler early. In releases where there are no recent improvements to enable, this
option silently does nothing. Thus it is safe to set it once and for all
in your global CodeQL config file. Available since Only perform initial checks on the part of the QL source that is used. Don't check embedded query metadata in QLDoc comments for validity. [Advanced] Override the default maximum size for a compilation cache
directory. [Advanced] Fail compilation if an ambiguous relation name is generated
during compilation. 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
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 (Note: On Windows the path separator is If this list of directories is given, they will be searched for packs
before the ones in 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 [Advanced] An optional list of directories that will be added to the
raw import search path for QL libraries. This should only be used if
you're using QL libraries that have not been packaged as QL packs. (Note: On Windows the path separator is [Advanced] Explicitly define which dbscheme queries should be compiled
against. This should only be given by callers that are extremely sure
what they're doing. [Advanced] Specify an additional directory to use as a compilation
cache. [Advanced] Don't use compilation caches in standard locations such as
in the QL pack containing the query or in the CodeQL toolchain
directory. Authenticate to GitHub Enterprise Server Container registries by passing
a comma-separated list of For example, you can pass
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
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
give [Advanced] Controls the location of cached data on disk that will
persist between several runs of the CLI, such as downloaded QL packs and
compiled query plans. If not set explicitly, this defaults to a
directory named Available since custom_queries_only (default): Include query help only for custom
queries i.e. those in query packs which are not of the form
`codeql/never: Do not include query help for any queries.v2.15.2.--no-sarif-include-alert-provenancev2.18.1.--[no-]sarif-group-rules-by-pack--[no-]sarif-multicause-markdown--no-sarif-minify--sarif-run-property=--no-group-results--csv-location-format=--dot-location-url-format=--[no-]sublanguage-file-coveragev2.15.2.--sarif-category=--no-database-extension-packs--no-database-threat-models--[no-]downloadOptions to control the model packs to be used
--model-packs=<name@range>...Options to control the threat models to be used
--threat-model=v2.15.3.Options to control the query evaluator
--[no-]tuple-counting--evaluator-log option is provided, tuple
counts will be included in both the text-based and structured JSON logs
produced by the command. (This can be useful for performance
optimization of complex QL code).--timeout=-j, --threads=--[no-]save-cache--[no-]expect-discarded-cache--[no-]keep-full-cache--max-disk-cache=--min-disk-free=--max-disk-cache is not given, the evaluator will try hard to
curtail disk cache usage if the free space on the file system drops
below this value.--min-disk-free-pct=--max-disk-cache is not given, the evaluator will try hard to
curtail disk cache usage if the free space on the file system drops
below this percentage.--external=--external options can be supplied.--xterm-progress=no: Never produce fancy progress; assume a dumb terminal.auto (default): Autodetect whether the command is running in an
appropriate terminal.yes: Assume the terminal can understand xterm control sequences. The
feature still depends on being able to autodetect the size of the
terminal, and will also be disabled if -q is given.25x80 (or similar): Like yes, and also explicitly give the size of
the terminal.25x80:/dev/pts/17 (or similar): show fancy progress on a different
terminal than stderr. Mostly useful for internal testing.Options for controlling outputting of structured evaluator logs
--evaluator-log=--evaluator-log-minify
option is passed. Please use codeql generate log-summary to
produce a more stable summary of this file, and avoid parsing the file
directly. The file will be overwritten if it already exists.--evaluator-log-minify--evaluator-log option is passed, also passing
this option will minimize the size of the JSON log produced, at the
expense of making it much less human readable.Options to control RAM usage
-M, --ram=Options to control QL compilation
--warnings=hide: Suppress warnings.show (default): Print warnings but continue with compilation.error: Treat warnings as errors.--no-debug-info--[no-]fast-compilation--no-release-compatibilityv2.11.1.--[no-]local-checking--no-metadata-verification--compilation-cache-size=--fail-on-ambiguous-relation-nameOptions to set up compilation environment
--search-path=.codeqlmanifest.json file at the root) or the immediate parent of one
or more such directories.--search-path once and for all in a per-user
configuration file).;).--additional-packs=--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.;).--library-path=;).--dbscheme=--compilation-cache=--no-default-compilation-cacheOptions for configuring the CodeQL package manager
--registries-auth-stdinhttps://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
to authenticate to two GitHub Enterprise Server instances.--github-auth-stdin option.--github-auth-stdin--registries-auth-stdin or use the CODEQL_REGISTRIES_AUTH environment
variable.Common options
-h, --help-J=-v, --verbose-q, --quiet--verbosity=-v
and -q.--logdir=--log-to-stderr and redirect stderr as desired.)--common-caches=.codeql in the user's home directory; it will be
created if it doesn't already exist.v2.15.2.