Skip to main content

Esta versión de GitHub Enterprise Server se discontinuó el 2026-04-09. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Especificación de opciones de comando en un archivo de configuración de CodeQL

Ahorre tiempo agregando las opciones de comando usadas con frecuencia y los paquetes personalizados CodeQL a un CodeQL archivo de configuración.

¿Quién puede utilizar esta característica?

CodeQL está disponible para los siguientes tipos de repositorios:

Uso de un CodeQL archivo de configuración

  1. Cree y guarde un archivo config en su directorio principal (Linux y macOS) o perfil de usuario (Windows) en el subdirectorio .config/codeql/. Por ejemplo: $HOME/.config/codeql/config.

  2. En el config archivo, especifique las opciones que desea aplicar a los CodeQL comandos. La sintaxis para especificar opciones es la siguiente:

    <command> <subcommand> <option> <value>
    
  3. Para aplicar las mismas opciones a más de un comando, puede hacer lo siguiente:

    • Omitir <subcommand>, lo que especificará la opción para cada <subcommand> relevante.
    • Omita tanto <command> como <subcommand>, lo que especificará la opción globalmente para cada <command> y <subcommand> pertinentes.

Nota:

* config los archivos solo aceptan espacios, no =, entre marcas de opción y valores.

  • Al especificar una opción en la línea de comandos, se invalida cualquier config valor definido para esa opción.
  • Para especificar más de una opción para <command>, <subcommand> o globalmente, use una línea por opción.

Ejemplos

  • Para generar todos los resultados de análisis que produce codeql database analyze como formato CSV, debes especificar lo siguiente:

    database analyze --format csv
    

    Aquí debes especificar el comando y el subcomando para impedir que se pase la misma opción database analyze a los comandos de bajo nivel que se ejecutan durante --format.

  • Para definir la RAM (4096 MB) y el número de subprocesos (4) que se usarán al ejecutar CodeQL comandos, especifique lo siguiente, en líneas independientes:

    --ram 4096
    --threads 4
    
  • Para especificar globalmente un directorio para que CodeQL escanee en busca de CodeQL paquetes (que no está relacionado con el directorio de instalación), use:

    --search-path <path-to-directory>