摘要

codeql pack ls <options>... -- <dir>

codeql pack ls <options>... -- <dir>

说明

[深层管道] 列出以此目录为根的 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 属于以下情况，则包含给定工作区中的 qlpack：

• 它至少在一个不带减号的所列组中（如果没有不带减号的所列组，则自动满足此条件），并且
• 它不在任何带减号的组中

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

[高级] 为运行命令的 JVM 提供选项。

（请注意，无法正确处理包含空格的选项。）

-v, --verbose

以增量方式增加输出的进度消息数。

-q, --quiet

以增量方式减少输出的进度消息数。

--verbosity=<level>

[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。 重写 -v 和 -q。

--logdir=<dir>

[高级] 将详细日志写入给定目录中的一个或多个文件，其中生成的名称包括时间戳和正在运行的子命令的名称。

（若要使用可以完全控制的名称编写日志文件，请根据需要提供 --log-to-stderr 并重定向 stderr。）

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的位置，此位置会在多次运行 CLI（例如下载的 QL 包和已编译查询计划）期间暂留。 如果未明确设置，则默认为用户主目录中名为 .codeql 的目录；如果尚不存在，则会创建该目录。

自 v2.15.2 起可用。