Skip to main content

execute language-server

[Plumbing] IDE 中对 QL 语言的在线支持。

谁可以使用此功能?

GitHub CodeQL 在安装后按用户授权。 根据许可证限制,只能将 CodeQL 用于某些任务。 有关详细信息,请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证,则可以使用 CodeQL 进行自动分析、持续集成和持续交付。 有关详细信息,请参阅“关于 GitHub 高级安全性”。

本文内容

此内容描述了 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 (q.v.) 的类似选项相似。

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

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

--synchronous

在一个主线程中执行操作,而不是在线程执行程序中执行操作。

常用选项

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