跳至主要内容

执行语言服务器

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

谁可以使用此功能?

CodeQL 可用于以下存储库类型

本文档内容

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

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

概要

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

描述

[管道] 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>

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

--logdir=<dir>

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

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

--common-caches=<dir>

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

v2.15.2起可用。