{"meta":{"title":"execute language-server","intro":"[Plumbing] On-line support for the QL language in IDEs.","product":"Security and code quality","breadcrumbs":[{"href":"/en/code-security","title":"Security and code quality"},{"href":"/en/code-security/reference","title":"Reference"},{"href":"/en/code-security/reference/code-scanning","title":"Code scanning"},{"href":"/en/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/en/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI manual"},{"href":"/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server","title":"execute language-server"}],"documentType":"article"},"body":"# execute language-server\n\n\\[Plumbing] On-line support for the QL language in IDEs.\n\n> \\[!NOTE]\n> 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>.\n>\n> To see details of the options available for this command in an earlier release, run the command with the <span style=\"white-space: nowrap;\">`--help`</span> option in your terminal.\n\n## Synopsis\n\n```shell copy\ncodeql execute language-server --check-errors=<checkErrors> <options>...\n```\n\n## Description\n\n\\[Plumbing] On-line support for the QL language in IDEs.\n\nThis command is only relevant for authors of QL language extensions for\nIDEs. It is started by the IDE extension in the background and\ncommunicates with it through a special protocol on its standard input\nand output streams.\n\n## Options\n\n### Primary Options\n\n#### `--check-errors=<checkErrors>`\n\n\\[Mandatory] How to check errors. One of: ON\\_CHANGE, EXPLICIT.\n\n#### `--search-path=<dir>[:<dir>...]`\n\nThis works like the similar option to [codeql query compile](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile) (q.v.).\n\nThere are no `--additional-packs` or `--library-path` options, as the\ncorresponding values are provided online by the IDE extension through\nthe language server protocol.\n\n(Note: On Windows the path separator is `;`).\n\n#### `--synchronous`\n\nCarry out actions a single main thread rather than in a threaded\nexecutor.\n\n### Common options\n\n#### `-h, --help`\n\nShow this help text.\n\n#### `-J=<opt>`\n\n\\[Advanced] Give option to the JVM running the command.\n\n(Beware that options containing spaces will not be handled correctly.)\n\n#### `-v, --verbose`\n\nIncrementally increase the number of progress messages printed.\n\n#### `-q, --quiet`\n\nIncrementally decrease the number of progress messages printed.\n\n#### `--verbosity=<level>`\n\n\\[Advanced] Explicitly set the verbosity level to one of errors,\nwarnings, progress, progress+, progress++, progress+++. Overrides `-v`\nand `-q`.\n\n#### `--logdir=<dir>`\n\n\\[Advanced] Write detailed logs to one or more files in the given\ndirectory, with generated names that include timestamps and the name of\nthe running subcommand.\n\n(To write a log file with a name you have full control over, instead\ngive `--log-to-stderr` and redirect stderr as desired.)\n\n#### `--common-caches=<dir>`\n\n\\[Advanced] Controls the location of cached data on disk that will\npersist between several runs of the CLI, such as downloaded QL packs and\ncompiled query plans. If not set explicitly, this defaults to a\ndirectory named `.codeql` in the user's home directory; it will be\ncreated if it doesn't already exist.\n\nAvailable since `v2.15.2`."}