生成查询帮助

概要

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

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

描述

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

选项

主要选项

<qhelpquerysuite>...

[必填] 要呈现的查询帮助文件。每个参数都是以下之一

• 要呈现的 .qhelp 文件。
• 要呈现的 .md 文件。
• 具有相应 .qhelp 或 .md 文件要呈现的 .ql 文件。
• 将递归搜索具有相应 .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 文件，并且输出将写入标准输出。

如果使用输出目录，则输出目录内的文件名将从 .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 和 GITHUB_TOKEN 环境变量。如果您只需要对 github.com 容器注册表进行身份验证，则可以使用更简单的 --github-auth-stdin 选项进行身份验证。

--github-auth-stdin

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

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

这将覆盖 GITHUB_TOKEN 环境变量。

常用选项

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