Synopsis

codeql pack install [--force] <options>... -- <dir>

codeql pack install [--force] <options>... -- <dir>

Description

Install dependencies for this pack.

This command installs the dependencies of the pack. If acodeql-pack.lock.yml exists, the versions specified in that lock filewill be installed if they are compatible with the version constraintsspecified in the qlpack.yml file. If any dependency versions specifiedin the lock file are incompatible with this pack's constraints, thiscommand will install the latest compatible version of each of thosedependencies, updating the lock file with the newly chosen versions. Ifno lock file is present, this command installs the latest compatibleversion of all dependencies, creating a new lock file.

Available sincev2.6.0.

Options

Primary Options

<dir>

The root directory of the package.

--format=<fmt>

Select output format, eithertext(default) orjson.

-f, --[no-]force

Allow overwriting already existing packs.

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

--lock-override=<file>

[Advanced] Specifies an alternate lock file to use as the input todependency resolution.

--lock-output=<file>

[Advanced] Specifies an alternate location to save the lock filegenerated by dependency resolution.

Available sincev2.14.1.

--no-strict-mode

[Advanced] Turn off strict mode to avoid a warning when resolvingpackages from the--additional-packs

and other locally resolved locations. Packages resolved locally arenever downloaded

and will not be added to the package lock.

--mode=<mode>

[Deprecated] Specifies how to resolve dependencies:

minimal-update(default): Update or create the codeql-pack.lock.ymlbased on the existing contents of the qlpack.yml file. If any existingcodeql-pack.lock.yml does not satisfy the current dependencies in theqlpack.yml, the lock file will be updated as necessary.

upgrade: Update or create the codeql-pack.lock.yml to use the latestversions of all dependencies, subject to the constraints in theqlpack.yml file. This mode has been superseded by the 'codeql packupgrade' command.

verify: Verify that the existing codeql-pack.lock.yml is still validwith respect to the dependencies specified in the qlpack.yml file, orfail the lock file if it does not exist. This mode has been supersededby the 'codeql pack ci' command.

no-lock: Ignore the existing codeql-pack.lock.yml and performresolution based on qlpack.yml file. Does not create or update the lockfile.

use-lock: Use the existing codeql-pack.lock.yml file to resolvedependencies, or create the lock file if it does not exist.

update: [Deprecated] Update or create the codeql-pack.lock.yml touse the latest versions of all dependencies, subject to the constraintsin the qlpack.yml file. This mode has been superseded by the 'codeqlpack upgrade' command.

Options for resolving QL packs outside of the package registry

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