pack add
Adds a list of QL library packs with optional versionranges as dependencies of the current package, and then installs them.
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 add <options>... -- <scope/name[@range]>...
codeql pack add <options>... -- <scope/name[@range]>...Description
Adds a list of QL library packs with optional version ranges asdependencies of the current package, and then installs them.
This command modifies the qlpack.yml file of the current package.Formatting and comments will be removed.
Available sincev2.6.0.
Options
Primary Options
<scope/name[@range]>...
[Mandatory] The scope, name, and optional version range of the pack toadd to the dependency list.
If no version range is specified, or if the version range is specifiedas 'latest', the latest version of the pack is downloaded, and adependency is added to qlpack.yml that allows any version that iscompatible with the downloaded version.
If a single version is specified, that version of the pack isdownloaded, and a dependency is added to qlpack.yml that allows anyversion that is compatible with the specified version.
If a version range is specified, the latest version of the pack thatsatisfies the specified range is downloaded, and a dependency is addedto qlpack.yml with the specified version range.
--dir=<dir>
The root directory of the package.
--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.
--[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.
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.