execute language-server

[Plomberie] Prend en charge en ligne le langage QL dans les IDE.

Qui peut utiliser cette fonctionnalité ?

CodeQL est disponible pour les types de référentiels suivants :

Dans cet article

Note

Ce contenu décrit la version la plus récente de CodeQL CLI. Pour plus d’informations sur cette version, consultez https://github.com/github/codeql-cli-binaries/releases.

Pour voir les détails des options disponibles pour cette commande dans une version antérieure, exécutez la commande avec l’option --help dans votre terminal.

Synopsis

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

Description

[Plomberie] Prend en charge en ligne le langage QL dans les IDE.

Cette commande s’applique uniquement aux auteurs d’extensions du langage QL pour les IDE. Elle est démarrée par l’extension IDE en arrière-plan et communique avec elle via un protocole spécial sur ses flux d’entrée et de sortie standard.

Options

Options principales

--check-errors=<checkErrors>

[Obligatoire] Mode de vérification des erreurs. Peut être : ON_CHANGE, EXPLICIT.

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

Fonctionne comme l’option similaire de codeql query compile (q.v.).

Il n’existe aucune option --additional-packs ou --library-path, car les valeurs correspondantes sont fournies en ligne par l’extension IDE via le protocole de serveur de langage.

(Remarque : Sur Windows, le séparateur de chemin est ;.)

--synchronous

Effectue des actions dans un seul thread principal plutôt que dans un exécuteur à thread.

Options courantes

-h, --help

Affiche ce texte d’aide.

-J=<opt>

[Avancé] Donne une option à l’environnement JVM exécutant la commande.

(Attention, les options contenant des espaces ne sont pas gérées correctement.)

-v, --verbose

Augmente de façon incrémentielle le nombre de messages de progression affichés.

-q, --quiet

Diminue de façon incrémentielle le nombre de messages de progression affichés.

--verbosity=<level>

[Avancé] Définit explicitement le niveau de détail sur errors, warnings, progress, progress+, progress++ ou progress+++. Remplace -v et -q.

--logdir=<dir>

[Avancé] Écrit des journaux détaillés dans un ou plusieurs fichiers du répertoire donné, avec des noms générés qui incluent des horodatages et le nom de la sous-commande en cours d’exécution.

(Pour écrire un fichier journal avec un nom sur lequel vous avez un contrôle total, donnez plutôt --log-to-stderr et redirigez stderr comme vous le souhaitez.)

--common-caches=<dir>

[Avancé] Contrôle l’emplacement des données en cache sur le disque qui persisteront entre plusieurs exécutions de l’interface CLI, telles que les packs QL téléchargés et les plans de requête compilés. S’il n’est pas défini explicitement, il s’agit par défaut d’un répertoire nommé .codeql dans le répertoire de base de l’utilisateur. S’il n’existe pas déjà, il est créé.

Disponible depuis v2.15.2.