解析 ml-models

已弃用] [实验性] [底层机制] 确定可访问的机器学习模型。

谁可以使用此功能？

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

本文内容

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

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

概要

Shell
codeql resolve ml-models <options>... -- <query|dir|suite|pack>...

描述

已弃用] [底层机制] 确定可访问的机器学习模型。

此底层机制命令已弃用。以前，它会解析作为命令行参数传入的查询说明符可用的 GitHub 创建的机器学习模型集。

现在它返回一个空的机器学习模型列表。

选项

主要选项

<querysuite|pack>...

[必填] 要执行的查询。每个参数的格式为 scope/name@range:path，其中

  • scope/name 是 CodeQL 包的限定名称。
  • range 是 semver 范围。
  • path 是文件系统路径。

如果指定了 scope/name，则 range 和 path 是可选的。缺少 range 表示指定包的最新版本。缺少 path 表示指定包的默认查询套件。

path 可以是 *.ql 查询文件、包含一个或多个查询的目录或 .qls 查询套件文件。如果没有指定包名称，则必须提供 path，它将被解释为当前进程的当前工作目录的相对路径。

要指定包含文字 @ 或 : 的 path，请在参数前使用 path: 作为前缀，例如：path:directory/with:and@/chars。

如果指定了 scope/name 和 path，则 path 不能是绝对路径。它被认为是 CodeQL 包根目录的相对路径。

--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 Container 注册表。

例如，您可以传递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>

[高级] 将详细程度显式设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖-v和-q。

--logdir=<dir>

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

(要写入名称完全受您控制的日志文件，请改用--log-to-stderr并根据需要重定向 stderr。)

--common-caches=<dir>

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

自v2.15.2版本起可用。