Create a list of installed QL packs and their locations.
CodeQL is available for the following repository types:
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.
--help
codeql resolve qlpacks <options>...
[Deprecated] Create a list of installed QL packs and their locations.
This command is deprecated. Use the codeql resolve packs command instead.
This command creates a list of QL packs that can be resolved given the configured (or given) search path.
When run with JSON output selected, it can report multiple locations for each pack name. When that happens, it means that the pack has conflicting locations within a single search element, so it cannot actually be resolved. The caller may use the actual locations to format an error message.
--search-path=<dir>[:<dir>...]
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 .codeqlmanifest.json file at the root) or the immediate parent of one or more such directories.
.codeqlmanifest.json
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 --search-path once and for all in a per-user configuration file).
--search-path
(Note: On Windows the path separator is ;).
;
--additional-packs=<dir>[:<dir>...]
If this list of directories is given, they will be searched for packs before the ones in --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.
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.
--kind=<kind>
Specifies which kind of packages to return. Options are: query, library, extension, and all (default).
query
library
extension
all
Note that extension packs are a kind of library pack and are included when the kind is library.
--format=<fmt>
Select output format, either text (default) or json.
text
json
--no-recursive
Do not recurse through dependencies. Only return packs directly accessible from the --additional-packs, --search-path, and distribution.
--additional-packs
--registries-auth-stdin
Authenticate to GitHub Enterprise Server Container registries by passing a comma-separated list of <registry_url>=<token> pairs.
For example, you can pass https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 to authenticate to two GitHub Enterprise Server instances.
https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
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 --github-auth-stdin option.
--github-auth-stdin
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 --registries-auth-stdin or use the CODEQL_REGISTRIES_AUTH environment variable.
This overrides the GITHUB_TOKEN environment variable.
-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.
-v
-q
--logdir=<dir>
[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 --log-to-stderr and redirect stderr as desired.)
--log-to-stderr
--common-caches=<dir>
[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 .codeql in the user's home directory; it will be created if it doesn't already exist.
.codeql
Available since v2.15.2.
v2.15.2