generate query-help

从 .qhelp 文件生成最终用户查询帮助。

谁可以使用此功能？

CodeQL 可用于以下存储库类型：

本文内容

Note

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

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

摘要

Shell
codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...

说明

从 .qhelp 文件生成最终用户查询帮助。

选项

主要选项

<qhelpquerysuite>...

[必需] 要呈现的查询帮助文件。 每个参数是下列项之一：

  • 要呈现的 .qhelp 文件。
  • 要呈现的 .md 文件。
  • 一个 .ql 文件，其中包含要呈现的相应 .qhelp 或 .md 文件。
  • 将以递归方式在其中搜索具有相应 .qhelp 或 .md 文件的 .ql 文件的目录。
  • 定义一组特定查询的 .qls 文件。
  • 由已安装的 QL 包之一导出的“已知”.qls 文件的基名称。

--format=<format>

[必需] 呈现文档的格式。 下列其中一项：

markdown：GitHub 风格的 Markdown。

sarif-latest：静态分析结果交换格式 (SARIF)，这是一种基于 JSON 的格式，用于描述静态分析结果。 此格式选项使用最新的受支持版本 (v2.1.0)。 此选项不适合用于自动化，因为它在不同 CodeQL 版本之间生成不同版本的 SARIF。

sarifv2.1.0：SARIF v2.1.0。

-o, --output=<dir|file>

要向其中写入呈现的文档的路径。 这通常是将在其中写入呈现的输出的目录。

如果仅提供了一个 .qhelp 或 .ql 文件，并且输出路径中不存在任何目录，则输出将写入该路径中的单个文件。

如果未提供输出路径，则仅接受单个 .qhelp 或 .ql 文件，并且输出会写入 stdout。

如果使用输出目录，则输出目录中的文件名派生自 .qhelp 文件名。

--warnings=<mode>

如何处理来自查询帮助呈现器的警告。 下列其中一项：

hide：禁止显示警告。

show（默认值）：输出警告，但继续呈现。

error：将警告视为错误。

--no-sarif-minify

[仅限 SARIF 格式] 生成整齐打印的 SARIF 输出。 默认情况下，SARIF 输出会缩小，以减少输出文件的大小。

用于查找 QL 包的选项（可能需要此包才可解析查询套件）

--search-path=<dir>[:<dir>...]

可在其中找到 QL 包的目录列表。 每个目录可以是一个 QL 包（或在根目录下包含一个 .codeqlmanifest.json 文件的多个包），也可以是一个或多个此类目录的直接父目录。

如果路径包含多个目录，则它们的顺序定义了它们之间的优先级：当必须解析的包名称在多个目录树中匹配时，给定的第一个目录树优先。

在查询其中一种语言时，将其指向开源 CodeQL 存储库的签出应该是可行的。

如果已将 CodeQL 存储库签出为未打包的 CodeQL 工具链的同级，则无需提供此选项；将始终在此类同级目录中搜索以其他方式找不到的 QL 包。 （如果此默认值不起作用，强烈建议在每用户配置文件中一次性设置 --search-path）。

（注意：在 Windows 上，路径分隔符为 ;）。

--additional-packs=<dir>[:<dir>...]

如果给定了此目录列表，则先在这些目录中的搜索包，然后在 --search-path 中的目录搜索包。 它们之间的顺序并不重要；如果在此列表的两个不同位置发现同一个包名称，这是一个错误。

如果你正临时开发一个同时出现在默认路径中的新版本的包，这将非常有用。 另一方面，建议不要在配置文件中替代此选项；一些内部操作将动态添加此选项，覆盖任何配置的值。

（注意：在 Windows 上，路径分隔符为 ;）。

用于配置 CodeQL 包管理器的选项

--registries-auth-stdin

通过传递逗号分隔的 <registry_url>=<token> 对列表，向 GitHub Enterprise Server 容器注册表进行身份验证。

例如，可以传递 https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 向两个 GitHub Enterprise Server 实例进行身份验证。

这会替代 CODEQL_REGISTRIES_AUTH and GITHUB_TOKEN 环境变量。 如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 --github-auth-stdin 选项进行身份验证。

--github-auth-stdin

通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。

若要向 GitHub Enterprise Server 容器注册表进行身份验证，请传递 --registries-auth-stdin 或使用 CODEQL_REGISTRIES_AUTH 环境变量。

这会替代 GITHUB_TOKEN 环境变量。

常用选项

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