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?

CodeQL está disponible para los siguientes tipos de repositorios:

Nota:

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.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

Descodificación de bqrs

Convierte los datos de resultados de BQRS en otros formularios.

diferencias de bqrs

Calcula la diferencia entre dos conjuntos de resultados.

hash de bqrs

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

Información de bqrs

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.

análisis de base de datos

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.

limpieza de base de datos

Compacta una base de datos CodeQL en el disco.

creación de base de datos

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.

archivos de índice de base de datos

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

inicio de base de datos

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

base de datos interpret-results

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

base de datos de impresión estándar

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

ejecución de consultas en la base de datos

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

comando de traza de base de datos

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

actualización de base de datos

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

comprobación del conjunto de datos

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

importación de conjunto de datos

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

actualización del conjunto de datos

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

Añadir diagnóstico

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

ejecutar cli-server

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

ejecutar servidor de lenguaje

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

ejecutar consultas

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

ejecutar query-server2

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

ejecutar actualizaciones

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

generar metadatos de predicados extensibles

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

generar resumen de registros

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

generar superposición-cambios

[Asociaciones] Generar un archivo que se pueda usar para el

generar ayuda de consultas

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

resultados de fusión de GitHub

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

github cargar-resultados

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

paquete añadir

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

conjunto de paquetes

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

crear paquete

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

descarga del paquete

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

inicializar paquete

Inicializa un objeto qlpack en el directorio especificado.

instalar paquete

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.

publicación de paquetes

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

pack resolver dependencias

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

actualización del paquete

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

compilación de consultas

Compila o prueba el código QL.

descompilar consulta

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

formato de consulta

Formato automático del código fuente QL.

ejecución de consultas

Ejecuta una consulta única.

resolver problemas de la base de datos

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

resolver extensiones

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

solucionar extractor

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

resolver archivos

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

resolver idiomas

Enumera los paquetes extractores de CodeQL instalados.

resolver la ruta de biblioteca

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

resolver metadatos

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

resolver modelos de aprendizaje automático

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

resolver paquetes

Muestra una lista de paquetes de CodeQL disponibles y sus ubicaciones.

resolver qlpacks

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

resolver qlref

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

resolver consultas

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

resolver la RAM

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

resolver pruebas

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

solucionar actualizaciones

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

prueba aceptada

Acepta los resultados de pruebas unitarias con errores.

extracción de pruebas

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