pack ls
[Deep plumbing] List the CodeQL packages rooted atthis directory. This directory must contain a qlpack.yml or.codeqlmanifest.json 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 ls <options>... -- <dir>
codeql pack ls <options>... -- <dir>Description
[Deep plumbing] List the CodeQL packages rooted at this directory.This directory must contain a qlpack.yml or .codeqlmanifest.json file.
Available sincev2.7.1.
Options
Primary Options
<dir>
The root directory of the package or workspace, defaults to the currentworking directory. If this parameter points to a directory containing aqlpack.yml, then this operation will run on only that CodeQL package. Ifthis parameter points to a directory containing a codeql-workspace.yml,then this operation will run on all CodeQL packages in the workspace.
Options for configuring which CodeQL packs to apply this command to.
--format=<fmt>
Select output format, eithertext(default) orjson.
--groups=[-]<group>[,[-]<group>...]
List of CodeQL pack groups to include or exclude from this operation. Aqlpack in the given workspace is included if:
- It is in at least one of the groups listed without a minus sign (thiscondition is automatically satisfied if there are no groups listedwithout a minus sign), and
- It is not in any group listed with a minus sign
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.