注意
此内容描述了 CodeQL CLI 的最新发布版本。有关此版本的更多信息,请参阅 https://github.com/github/codeql-cli-binaries/releases。
要查看早期版本中此命令可用的选项详情,请在终端中使用 --help 选项运行该命令。
概要
codeql pack ls <options>... -- <dir>
codeql pack ls <options>... -- <dir>
描述
[Deep plumbing] 列出此目录下的 CodeQL 包。此目录必须包含 qlpack.yml 或 .codeqlmanifest.json 文件。
自 v2.7.1 起可用。
选项
主要选项
<dir>
包或工作区的根目录,默认是当前工作目录。如果此参数指向包含 qlpack.yml 的目录,则此操作仅在该 CodeQL 包上运行。如果此参数指向包含 codeql-workspace.yml 的目录,则此操作将在工作区中的所有 CodeQL 包上运行。
用于配置此命令要应用于哪些 CodeQL 包的选项。
--format=<fmt>
选择输出格式,可为 text (默认) 或 json。
--groups=[-]<group>[,[-]<group>...]
要在此操作中包含或排除的 CodeQL 包组列表。如果给定工作区中的 qlpack 满足以下条件,则被包含:
- 它位于至少一个未加负号的组中(如果没有未加负号的组,则此条件自动满足),并且
- 它不在任何加负号的组中
常用选项
-h, --help
显示此帮助文本。
-J=<opt>
[高级] 为运行该命令的 JVM 提供选项。
(请注意,包含空格的选项将无法正确处理。)
-v, --verbose
逐步增加打印的进度信息数量。
-q, --quiet
逐步减少打印的进度信息数量。
--verbosity=<level>
[高级] 将详细程度显式设置为以下之一:errors、warnings、progress、progress+、progress++、progress+++。会覆盖 -v 和 -q。
--logdir=<dir>
[高级] 将详细日志写入指定目录中的一个或多个文件,文件名会包含时间戳和运行的子命令名称。
(若希望自行完全控制日志文件名,请改用 --log-to-stderr 并按需重定向 stderr。)
--common-caches=<dir>
[高级] 控制磁盘上缓存数据的位置,这些数据会在 CLI 的多次运行之间保持,例如已下载的 QL 包和已编译的查询计划。如果未显式设置,则默认使用用户主目录下名为 .codeql 的目录;如该目录不存在,则会自动创建。
自 v2.15.2 起可用。