跳至主要内容

pack ls

[深度挖掘] 列出以该目录为根的 CodeQL 包。该目录必须包含 qlpack.yml 或 .codeqlmanifest.json 文件。

谁可以使用此功能?

CodeQL 可用于以下存储库类型

本文档内容

此内容描述了 CodeQL CLI 的最新版本。有关此版本的更多信息,请参阅 https://github.com/github/codeql-cli-binaries/releases

要查看早期版本中此命令可用的选项的详细信息,请在终端中使用 --help 选项运行该命令。

摘要

Shell
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 将被包含:

  • 它至少位于一个未带减号的列表组中(如果未列出任何未带减号的组,则自动满足此条件),并且
  • 它不位于任何带减号的列表组中

常用选项

-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 起可用。