Skip to main content

Manual de comandos de la CLI de CodeQL

Información de referencia de los comandos disponibles en la versión más reciente de CodeQL CLI.

¿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.

bqrs decode

Convierte los datos de resultados de BQRS en otros formularios.

bqrs diff

Calcula la diferencia entre dos conjuntos de resultados.

bqrs hash

[Asociación] Calcula un hash estable de un archivo BQRS.

bqrs info

Muestra los metadatos de un archivo BQRS.

bqrs interpret

[Asociación] Interpreta los datos de un único archivo BQRS.

adición de diagnóstico de base de datos

[Experimental] Agrega un fragmento de información de diagnóstico a una base de datos.

database analyze

Analiza una base de datos y genera resultados significativos en el contexto del código fuente.

agrupación de bases de datos

Crea un archivo reasignable de una base de datos CodeQL.

database cleanup

Compacta una base de datos CodeQL en el disco.

database create

Crea una base de datos CodeQL para un árbol de origen que se pueda analizar mediante uno de los productos CodeQL.

exportación de diagnóstico de base de datos

[Experimental] Exporta la información de diagnóstico de una base de datos para un análisis con errores.

finalización de la base de datos

[Fontanería] Pasos finales en la creación de la base de datos.

importación de base de datos

[Avanzado] [Asociación] Importa las bases de datos sin finalizar en otra base de datos sin finalizar.

database index-files

[Asociación] Indexa archivos independientes con un extractor de CodeQL determinado.

database init

[Asociación] Crea una base de datos CodeQL vacía.

database interpret-results

[Asociación] Interpreta los resultados calculados de consultas en formatos significativos como SARIF o CSV.

database print-baseline

[Asociación] Imprime un resumen de las líneas de código de base de referencia que se ven.

database run-queries

[Asociación] Ejecuta un conjunto de consultas juntas.

database trace-command

[Asociación] Ejecuta un solo comando como parte de una compilación de la que se realiza un seguimiento.

desagrupación de base de datos

Extrae un archivo de base de datos CodeQL.

database upgrade

Actualiza una base de datos para que las herramientas actuales puedan usarla.

dataset check

[Asociación] Comprueba si existe coherencia interna en un conjunto de datos determinado.

limpieza del conjunto de datos

[Asociación] Limpia los archivos temporales de un conjunto de datos.

dataset import

[Asociación] Importa un conjunto de archivos TRAP en un conjunto de datos sin procesar.

medida del conjunto de datos

[Asociación] Recopila estadísticas sobre las relaciones de un conjunto de datos determinado.

dataset upgrade

[Asociación] Actualiza un conjunto de datos para que las herramientas actuales puedan usarlo.

diagnostic add

[Experimental] [Asociación] Agrega un fragmento de información de diagnóstico.

exportación de diagnóstico

[Experimental] Exporta la información de diagnóstico para un análisis con errores.

execute cli-server

[Asociación profunda] Servidor para ejecutar varios comandos a la vez que se evita la inicialización repetida de JVM.

execute language-server

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

execute queries

[Asociación] Ejecuta una o varias consultas en un conjunto de datos.

ejecutación de query-server

[Asociación] Compatibilidad con la ejecución de consultas desde los IDE.

execute query-server2

[Asociación] Compatibilidad con la ejecución de consultas desde los IDE.

execute upgrades

[Asociación] Ejecuta scripts de actualización en un conjunto de datos QL sin procesar existente.

generate extensible-predicate-metadata

[Experimental] [Asociación profunda] Informe de los predicados extensibles que se encuentran en el paquete especificado.

generate log-summary

[Avanzado] Crea un resumen de un archivo de registro estructurado.

generate query-help

Genera ayuda de consultas de usuario final a partir de archivos .qhelp.

github merge-results

[Asociación profunda] Combina varios archivos SARIF en un único archivo SARIF.

github upload-results

Carga un archivo SARIF en el examen de código de GitHub.

pack add

Agrega una lista de paquetes de biblioteca QL con rangos de versiones opcionales como dependencias del paquete actual y, a continuación, los instala.

pack bundle

[Asociación] Agrupa un paquete de biblioteca QL.

pack ci

Realiza una instalación de las dependencias de este paquete y comprueba que el archivo de bloqueo existente está actualizado.

pack create

[Asociación] Compila el contenido de un paquete QL a partir del código fuente.

pack download

Descarga el conjunto de elementos qlpack al que hace referencia la especificación de consulta de la línea de comandos desde el registro. Los paquetes pueden proporcionarse por nombre o de forma implícita dentro de un archivo de conjunto de consultas (.qls).

pack init

Inicializa un objeto qlpack en el directorio especificado.

pack install

Instala las dependencias para este paquete.

pack ls

[Asociación profunda] Enumera los paquetes de CodeQL con raíz en este directorio. Este directorio debe contener un archivo qlpack.yml o .codeqlmanifest.json.

pack packlist

[Asociación] Calcula el conjunto de archivos que se va a incluir en un paquete de biblioteca o un paquete de consultas QL.

pack publish

Publica un paquete de biblioteca QL en un registro de paquetes.

pack resolve-dependencies

[Asociación] Calcula el conjunto de dependencias necesarias para este paquete de QL.

pack upgrade

Actualiza las dependencias de este paquete a las versiones más recientes disponibles.

query compile

Compila o prueba el código QL.

query decompile

[Asociación] Lee una representación intermedia de una consulta compilada desde un archivo .qlo.

query format

Formato automático del código fuente QL.

query run

Ejecuta una consulta única.

resolve database

[Asociación profunda] Metadatos de informe sobre la base de datos.

resolve extensions

[Experimental] [Asociación profunda] Determina las extensiones accesibles. Esto incluye extensiones de datos y modelos de Machine Learning.

Resolución de extensiones por paquete

[Experimental] [Asociación profunda] Determina las extensiones accesibles para las rutas de acceso especificadas a raíces de paquetes. Esto incluye extensiones de datos y modelos de Machine Learning.

resolve extractor

[Asociación profunda] Determina el paquete extractor que se va a usar para un lenguaje determinado.

resolve files

[Asociación profunda] Expande un conjunto de elementos glob de inclusión o exclusión de archivos.

resolve languages

Enumera los paquetes extractores de CodeQL instalados.

resolve library-path

[Asociación profunda] Determina la ruta de acceso a la biblioteca QL y dbscheme para una consulta.

resolve metadata

[Asociación profunda] Resuelve y devuelve los pares de metadatos clave-valor de un archivo de origen de consulta.

resolve ml-models

[En desuso] [Experimental] [Asociación profunda] Determina los modelos de Machine Learning accesibles.

resolve qlpacks

Crea una lista de paquetes de QL instalados y sus ubicaciones.

resolve qlref

[Asociación profunda] Desreferencia un archivo .qlref para devolver un archivo .ql.

resolve queries

[Asociación profunda] Expande los directorios de consultas y las especificaciones del conjunto.

resolve ram

[Asociación profunda] Prepara las opciones de RAM.

resolve tests

[Asociación profunda] Busca pruebas unitarias de QL en los directorios dados.

resolve upgrades

[Asociación profunda] Determina las actualizaciones que se van a ejecutar para un conjunto de datos sin procesar.

test accept

Acepta los resultados de pruebas unitarias con errores.

test extract

[Asociación] Compila un conjunto de datos para un directorio de prueba.

test run

Ejecuta pruebas unitarias para consultas QL.

version

Muestra la versión de la cadena de herramientas de CodeQL.