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
codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...
codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...
Descripción
[Experimental] Asociación] [Agrega un fragmento de información de diagnóstico.
Disponible desde la versión v2.12.6.
Opciones
Opciones principales
--markdown-message=<markdownMessage>
Mensaje para el diagnóstico, en formato Markdown con estilo GitHub.
--plaintext-message=<plaintextMessage>
Mensaje para el diagnóstico, en texto sin formato. Esta opción solo debe utilizarse cuando rellenar un mensaje Markdown con --markdown-message no resulte práctico.
--severity=<severity>
Gravedad del diagnóstico. Puede ser "error", "advertencia" o "nota".
--help-link=<helpLinks>
Vínculos de ayuda pertinentes para el diagnóstico.
--attributes-json=<attributesJson>
Metadatos estructurados pertinentes para el diagnóstico.
Opciones que especifican dónde guardar la información de diagnóstico
Se debe proporcionar exactamente una de estas opciones.
--diagnostic-dir=<diagnosticDir>
Directorio al que se debe agregar el diagnóstico.
Opciones que indican dónde se puede mostrar el mensaje de diagnóstico
--ready-for-status-page
Indica que el diagnóstico es adecuado para mostrarse en la página de estado.
--ready-for-cli-summary-table
Indica que el diagnóstico es adecuado para mostrarse en la tabla de resumen de diagnóstico impresa por comandos como database analyze.
Opciones que describen el origen del diagnóstico
--source-id=<id>
[Obligatorio] Identificador del origen de este diagnóstico.
--source-name=<name>
[Obligatorio] Una descripción legible del origen de este diagnóstico.
--extractor-name=<extractorName>
Nombre del extractor de CodeQL, si este diagnóstico lo generó un extractor de CodeQL.
Opciones que describen la ubicación del diagnóstico
--file-path=<file>
Ruta de acceso del archivo al que se aplica el diagnóstico, en relación con la raíz de origen.
--start-line=<startLine>
Número de línea basado en 1 (incluido) donde se inicia la ubicación del diagnóstico.
--start-column=<startColumn>
Número de columna basado en 1 (incluido) donde se inicia la ubicación del diagnóstico.
--end-line=<endLine>
Número de línea basado en 1 (incluido) donde finaliza la ubicación del diagnóstico.
--end-column=<endColumn>
Número de columna basado en 1 (incluido) donde finaliza la ubicación del diagnóstico.
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.