Skip to main content

This version of GitHub Enterprise Server will be discontinued on 2023-12-20. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

execute language-server

[Plumbing] On-line support for the QL language in IDEs.

GitHub CodeQL is licensed on a per-user basis upon installation. You can use CodeQL only for certain tasks under the license restrictions. For more information, see "About the CodeQL CLI."

If you have a GitHub Advanced Security license, you can use CodeQL for automated analysis, continuous integration, and continuous delivery. For more information, see "About GitHub Advanced Security."

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

Synopsis

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

Description

[Plumbing] On-line support for the QL language in IDEs.

This command is only relevant for authors of QL language extensions for IDEs. It is started by the IDE extension in the background and communicates with it through a special protocol on its standard input and output streams.

Options

Primary Options

--check-errors=<checkErrors>

[Mandatory] How to check errors. One of: ON_CHANGE, EXPLICIT.

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

This works like the similar option to codeql query compile (q.v.).

There are no --additional-packs or --library-path options, as the corresponding values are provided online by the IDE extension through the language server protocol.

(Note: On Windows the path separator is ;).

--synchronous

Carry out actions a single main thread rather than in a threaded executor.

Common options

-h, --help

Show this help text.

-J=<opt>

[Advanced] Give option to the JVM running the command.

(Beware that options containing spaces will not be handled correctly.)

-v, --verbose

Incrementally increase the number of progress messages printed.

-q, --quiet

Incrementally decrease the number of progress messages printed.

--verbosity=<level>

[Advanced] Explicitly set the verbosity level to one of errors, warnings, progress, progress+, progress++, progress+++. Overrides -v and -q.

--logdir=<dir>

[Advanced] Write detailed logs to one or more files in the given directory, with generated names that include timestamps and the name of the running subcommand.

(To write a log file with a name you have full control over, instead give --log-to-stderr and redirect stderr as desired.)

--common-caches=<dir>

[Advanced] Controls the location of cached data on disk that will persist between several runs of the CLI, such as downloaded QL packs and compiled query plans. If not set explicitly, this defaults to a directory named .codeql in the user's home directory; it will be created if it doesn't already exist.

Available since v2.15.2.