跳至主要内容

执行 language-server

[Plumbing] 为 IDE 中的 QL 语言提供在线支持。

谁可以使用此功能?

CodeQL 可用于以下仓库类型

本文内容

注意

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

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

概要

Shell
codeql execute language-server --check-errors=<checkErrors> <options>...

描述

[Plumbing] 为 IDE 中的 QL 语言提供在线支持。

此命令仅与 IDE 的 QL 语言扩展作者相关。它由 IDE 扩展在后台启动,并通过其标准输入/输出流使用专用协议与其通信。

选项

主要选项

--check-errors=<checkErrors>

[必填] 错误检查方式。取值之一:ON_CHANGE、EXPLICIT。

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

这与 codeql query compile 的类似选项的工作方式相同(参见)。

没有 --additional-packs--library-path 选项,因为相应的值由 IDE 扩展通过语言服务器协议在线提供。

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

--synchronous

在单个主线程中执行操作,而不是在多线程执行器中。

常用选项

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

© . This site is unofficial and not affiliated with GitHub, Inc.