pack download
Download the set of qlpacks referenced by the queryspec of the command line from the registry. Packs can be provided byname or implicitly inside of a query suite (.qls) 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 pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...
codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...Description
Download the set of qlpacks referenced by the query spec of the commandline from the registry. Packs can be provided by name or implicitlyinside of a query suite (.qls) file.
The packs will be downloaded and unzipped into the package cache bydefault.
Available sincev2.6.0.
Options
Primary Options
<scope/name[@version]|suite.qls>...
[Mandatory] List of CodeQL packs and query suites to download. If aquery suite is provided, its instructions will be inspected and allreferenced CodeQL packs will be downloaded. If you don't specify aversion for a CodeQL pack, then the latest version will be downloaded.
--format=<fmt>
Select output format, eithertext(default) orjson.
-d, --dir=<dir>
The directory to download the pack to. Defaults to installing into thepackage cache.
--for-pack=<pack>
The pack whose dependencies are being downloaded. The package registryfor each pack will be determined by the 'registries' property of<pack>.
--[no-]allow-prerelease
Allow packs with pre-release version qualifiers (e.g.,X.Y.Z-qualifier) to be used. Without this flag, pre-release packs willbe ignored.
Available sincev2.11.3.
-f, --[no-]force
Allow overwriting already existing packs.
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.