execute language-server
[Plumbing] On-line support for the QL language in IDEs.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://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
codeql execute language-server --check-errors=<checkErrors> <options>...
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 forIDEs. It is started by the IDE extension in the background andcommunicates with it through a special protocol on its standard inputand 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 tocodeql query compile (q.v.).
There are no--additional-packs or--library-path options, as thecorresponding values are provided online by the IDE extension throughthe language server protocol.
(Note: On Windows the path separator is;).
--synchronous
Carry out actions a single main thread rather than in a threadedexecutor.
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-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.