query decompile
[Plumbing] Read an intermediate representation of a compiled queryfrom a .qlo file.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://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 query decompile [--output=<file>] <options>... -- <file>
codeql query decompile [--output=<file>] <options>... -- <file>
Description
[Plumbing] Read an intermediate representation of a compiled queryfrom a .qlo file.
The code will be written to standard output, unless the--output
option is specified.
Options
Primary Options
<file>
[Mandatory] QLO file to read from.
-o, --output=<file>
The file to write the desired output to.
--kind=<kind>
The kind of the intermediate representation to read. The options are:
dil
: A Datalog intermediate representation.
ra
: A relational algebra intermediate representation. This is used bythe query evaluation phase.
bytecode
: Show the raw (uncompressed) bytecode from the .qlo file.Mostly useful for debugging the compiler/evaluator.
The default isdil
if the query was compiled with--include-dil-in-qlo
andra
otherwise
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-v
and-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
.