跳至主要内容

解析库路径

[深度解读] 为查询确定 QL 库路径和 dbscheme。

谁可以使用此功能?

CodeQL 可用于以下类型的代码库

本文内容

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

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

概要

Shell
codeql resolve library-path (--query=<qlfile> | --dir=<dir> | --root-pack=<pkgname>) <options>...

描述

[深度解读] 为查询确定 QL 库路径和 dbscheme。

确定应针对哪个 QL 库路径编译特定查询。此计算在可能需要编译查询的多个子命令中是隐式的。为了 (a) 有助于进行疑难解答,以及 (b) 为在需要精确控制的特殊情况下修改路径提供起点,它作为单独的管道命令公开。

该命令还将检测用于编译查询的语言和 dbscheme,因为这些也可能取决于自动检测 QL 查询的语言。

该命令是高度内部的,其行为或存在可能会在 QL 语言生态系统发展时无需过多通知而发生变化。

选项

主要选项

--[no-]find-extractors

[高级] 在输出中包含查询依赖的 QL 包的 extractor 字段摘要。这仅用于少数罕见的内部情况,可能需要更多工作才能计算,因此默认情况下未启用。

--format=<fmt>

选择输出格式。选项包括

lines (默认):每行打印一个命令行参数。

json:打印包含所有数据的 JSON 对象。

path:仅打印计算出的库路径。

dbscheme:仅打印检测到的 dbscheme。

cache:打印默认编译缓存位置,如果没有则不打印任何内容。

来自调用命令的命令行的选项

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

可能找到 QL 包的目录列表。每个目录都可以是 QL 包(或包含根目录下 .codeqlmanifest.json 文件的包捆绑包)或一个或多个此类目录的直接父目录。

如果路径包含多个目录,则它们的顺序定义它们之间的优先级:当必须解析的包名称在一个以上目录树中匹配时,首先给出的目录获胜。

指向开源 CodeQL 代码库的检出应该在查询其中一种语言时有效。

如果您已将 CodeQL 代码库检出为解压的 CodeQL 工具链的同级目录,则无需提供此选项;始终将搜索此类同级目录以查找无法以其他方式找到的 QL 包。(如果此默认值不起作用,强烈建议在每个用户的配置文件中设置 --search-path。)

(注意:在 Windows 上,路径分隔符为 ;)。

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

如果给出此目录列表,则在 --search-path 中的目录之前搜索这些目录中的包。这些之间的顺序无关紧要;如果通过此列表在两个不同位置找到包名称,则为错误。

如果您正在临时开发一个也在默认路径中出现的包的新版本,这将很有用。另一方面,_不建议_在配置文件中覆盖此选项;某些内部操作将动态添加此选项,从而覆盖任何已配置的值。

(注意:在 Windows 上,路径分隔符为 ;)。

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

[高级] 一个可选的目录列表,这些目录将添加到 QL 库的原始导入搜索路径中。只有在使用未打包为 QL 包的 QL 库时才应使用此选项。

(注意:在 Windows 上,路径分隔符为 ;)。

--dbscheme=<file>

[高级] 显式定义应针对其编译 dbscheme 查询。只有在调用者非常确定自己在做什么的情况下才应提供此选项。

--compilation-cache=<dir>

[高级] 指定一个额外的目录用作编译缓存。

--no-default-compilation-cache

[高级] 不使用标准位置的编译缓存,例如包含查询的 QL 包或 CodeQL 工具链目录中的缓存。

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 环境变量。

指定要编译内容的选项

必须提供以下选项中的一个。

--query=<qlfile>

要编译的 QL 文件的路径。

将搜索其目录和父目录中的 qlpack.yml 或旧版 queries.xml 文件,以确定必要的包。

--dir=<dir>

包含要编译的查询的包的根目录。

--root-pack=<pkgname>

[高级] 用作依赖项解析根的包的声明名称。

当可以在搜索路径中的某个位置按名称找到包时使用此选项。如果您知道所需根包的 *磁盘位置*,请假装它包含一个 .ql 文件并改用 --query

常用选项

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