Synopsis

codeql resolve queries <options>... -- <query|dir|suite|pack>...

codeql resolve queries <options>... -- <query|dir|suite|pack>...

Description

[Deep plumbing] Expand query directories and suite specifications.

This plumbing command is responsible for expanding the command-lineparameters of subcommands that can run multiple queries, to an actuallist of individual .ql files to execute.

If run without any arguments, will display a help message including alist of "well-known" query suite definitions found in available QLpacks to the standard error stream, and successfully return an emptylist of queries.

Options

Primary Options

<query|dir|suite|pack>...

[Mandatory] Queries to execute. Each argument is in the formscope/name@range:path where:

• scope/name is the qualified name of a CodeQL pack.
• range is a semver range.
• path is a file system path.

If ascope/name is specified, therange andpath are optional. Amissingrange implies the latest version of the specified pack. Amissingpath implies the default query suite of the specified pack.

Thepath can be one of a*.ql query file, a directory containing oneor more queries, or a.qls query suite file. If there is no pack namespecified, then apath must be provided, and will be interpretedrelative to the current working directory of the current process.

To specify apath that contains a literal@ or:, usepath: as aprefix to the argument, like this:path:directory/with:and@/chars.

If ascope/name andpath are specified, then thepath cannot beabsolute. It is considered relative to the root of the CodeQL pack.

--format=<fmt>

Select output format. Choices include:

text(default): A line-oriented list of pathnames.

json: A plain list of pathnames as strings.

bylanguage: A richer JSON representation that groups queries by whichextractor they work with, as deduced from their library dependencies --this is slightly more expensive to compute.

installedpacks: [Deep plumbing] A JSON representation listing CodeQLquery packs that are referenced directly or inside of a query suite andare not locally available.

Options for finding QL packs (which may be necessary to interpret 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.