# 解析库路径

[深层管道] 确定查询的 QL 库路径和 dbscheme。

> [!NOTE]
> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。
>
> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style="white-space: nowrap;">`--help`</span> 选项运行命令。

## 概要

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

## Description

              \[深层管道] 确定查询的 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 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 环境变量。

### 用于指定要编译的内容的选项

必须恰好提供其中一个选项。

#### `--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>`

              \[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。

#### `--logdir=<dir>`

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

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

#### `--common-caches=<dir>`

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

自 `v2.15.2` 起可用。