Skip to main content

execute language-server

[Asociación] Compatibilidad en línea con el lenguaje QL en los IDE.

¿Quién puede utilizar esta característica?

Las licencias de GitHub CodeQL se otorgan por usuario tras la instalación. Puedes usar CodeQL solo para determinadas tareas según las restricciones de las licencias. Para obtener más información, vea «Acerca de la CLI de CodeQL».

Si tienes una licencia de GitHub Advanced Security, puedes usar CodeQL para el análisis automatizado, la integración continua y la entrega continua. Para obtener más información, vea «Acerca de GitHub Advanced Security».

En este contenido se describe la versión más reciente de CodeQL CLI. Para obtener más información sobre esta versión, consulta https://github.com/github/codeql-cli-binaries/releases.

Para ver detalles de las opciones disponibles para este comando en una versión anterior, ejecuta el comando con la opción --help en el terminal.

Sinopsis

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

Descripción

[Asociación] Compatibilidad en línea con el lenguaje QL en los IDE.

Este comando solo es relevante para los creadores de extensiones del lenguaje QL para entornos de desarrollo integrado (IDE). La extensión IDE lo inicia en segundo plano y se comunica con él a través de un protocolo especial en sus secuencias de entrada y salida estándar.

Opciones

Opciones principales

--check-errors=<checkErrors>

[Obligatorio] Cómo comprobar los errores. Uno de estos valores: ON_CHANGE, EXPLICIT.

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

Funciona como la opción similar a codeql query compile (consultar).

No hay opciones --additional-packs ni --library-path, ya que los valores correspondientes los proporciona en línea la extensión de IDE a través del protocolo de servidor de lenguaje.

(Nota: En Windows, el separador de ruta de acceso es ;).

--synchronous

Realiza las acciones en un único subproceso principal, en lugar de en un ejecutor con subprocesos.

Opciones comunes

-h, --help

Muestra este texto de ayuda.

-J=<opt>

[Avanzado] Asigna la opción a la JVM que ejecuta el comando.

(Ten en cuenta que las opciones que contienen espacios no se administrarán correctamente).

-v, --verbose

Aumenta incrementalmente el número de mensajes de progreso impresos.

-q, --quiet

Reduce incrementalmente el número de mensajes de progreso impresos.

--verbosity=<level>

[Avanzado] Establece explícitamente el nivel de detalle en errores, advertencias, progreso, progreso+, progreso++, progreso+++. Invalida -v y -q.

--logdir=<dir>

[Avanzado] Escribe registros detallados en uno o varios archivos del directorio especificado, con nombres generados que incluyen marcas de tiempo y el nombre del subcomando en ejecución.

(Para escribir un archivo de registro con un nombre sobre el que tienes control total, proporciona --log-to-stderr y redirige stderr como quieras).

--common-caches=<dir>

[Avanzado] Controla la ubicación de los datos en caché del disco que se conservarán entre varias ejecuciones de la CLI, como paquetes QL descargados y planes de consulta compilada. Si no se define explícitamente, se toma como predeterminado un directorio denominado .codeql en el directorio principal del usuario, que se creará en caso de que no exista.

Disponible desde la versión v2.15.2.