pack resolve-dependencies¶

Synopsis¶

codeql pack resolve-dependencies <options>... [--] <dir>

Description¶

[Experimental] [Plumbing] Compute the set of required dependencies for this QL pack.

This command searches the configured registries for required dependencies and returns the list of resolved dependencies.

Options¶

<dir>¶: The root directory of the package.

--format=<fmt>¶: Select output format. Choices include text (default) and json.

--mode=<resolution-mode>¶

Specifies the specific behavior of this run of resolve dependencies.

[Default] use-lock: Use the existing qlpack.lock.yml file to resolve dependencies, or create the lock file if it does not exist.

verify: Verify that the existing qlpack.lock.yml is still valid with respect to the dependencies specified in the qlpack.yml file, or fail the lock file if it does not exist.

update: Update or create the qlpack.lock.yml based on the existing contents of the qlpack.yml file. Any existing qlpack.lock.yml will be recreated.

no-lock: Ignore the existing qlpack.lock.yml and perform resolution based on qlpack.yml file. Does not create or update the lock file.

Options to set up compilation environment¶

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

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

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

(Note: On Windows the path separator is ;).

--library-path=<dir>[:<dir>...]¶

[Advanced] An optional list of directories that will be added to the raw import search path for QL libraries. This should only be used if you’re using QL libraries that have not been packaged as QL packs.

(Note: On Windows the path separator is ;).

--dbscheme=<file>¶: [Advanced] Explicitly define which dbscheme queries should be compiled against. This should only be given by callers that are extremely sure what they’re doing.

--compilation-cache=<dir>¶: [Advanced] Specify an additional directory to use as a compilation cache.

--no-default-compilation-cache¶: [Advanced] Don’t use compilation caches in standard locations such as in the QL pack containing the query or in the CodeQL toolchain directory.

Options for configuring the CodeQL package manager¶

--github-auth-stdin¶

Accept a GitHub Apps token or personal access token via standard input.

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