The Wayback Machine - https://web.archive.org/web/20230416055503/https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/pack-add
Skip to main content
All products
Code security

pack add

In this article

[Experimental] Adds a list of QL library packs with optional version ranges as dependencies of the current package, and then installs them.

GitHub CodeQL is licensed on a per-user basis upon installation. You can use CodeQL only for certain tasks under the license restrictions. For more information, see "About the CodeQL CLI."

If you have a GitHub Enterprise account and GitHub Advanced Security license, you can use CodeQL for automated analysis, continuous integration and continuous delivery. You can create an enterprise account by contacting the sales team. For more information, see "About GitHub Advanced Security."

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.

Synopsis

Shell
codeql pack add <options>... -- <scope/name[@range]>...

Description

[Experimental] Adds a list of QL library packs with optional version ranges as dependencies 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.

Primary options

<scope/name[@range]>...

[Mandatory] The scope, name, and optional version range of the pack to add to the dependency list. The latest version that satisfies the specified range is downloaded and the specified range is added to the qlpack.yml. If the version is missing, then the latest version of this pack is retrieved and that version is added to the qlpack.yml.

--dir=<dir>

The root directory of the package.

--registries-auth-stdin

Authenticate to GitHub Enterprise Server Container registries by passing a comma-separated list of \<registry_url>=\ pairs.

For example, you can pass https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 to authenticate to two GitHub Enterprise Server instances.

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.

--[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 will be ignored.

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 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.)