resolve library-path

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

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

摘要

Shell

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

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

说明

[Deep plumbing] 确定查询的 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 环境变量。

谁可以使用此功能？

本文内容

摘要

说明

选项

主要选项

`--[no-]find-extractors`

`--format=<fmt>`

调用命令的命令行中的选项

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

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

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

`--dbscheme=<file>`

`--compilation-cache=<dir>`

`--no-default-compilation-cache`

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

`--registries-auth-stdin`

`--github-auth-stdin`

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

`--query=<qlfile>`

`--dir=<dir>`

`--root-pack=<pkgname>`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`