Skip to main content

Como especificar opções de comando em um arquivo de configuração do CodeQL

Economize tempo adicionando suas opções de comando usadas com frequência e pacotes personalizados CodeQL a um arquivo de configuração CodeQL.

Quem pode usar esse recurso?

O CodeQL está disponível para os seguintes tipos de repositórios:

Como usar um arquivo de configuração do CodeQL

  1. Crie e salve um arquivo config em sua página inicial (Linux e macOS) ou no diretório de perfil de usuário (Windows) no subdiretório .config/codeql/. Por exemplo, $HOME/.config/codeql/config.

  2.        `config` No arquivo, especifique as opções que você deseja aplicar aos seus comandos CodeQL . A sintaxe para especificar opções é a seguinte:
    
    <command> <subcommand> <option> <value>
    
  3. Para aplicar as mesmas opções a mais de um comando, você pode:

    • Omitir <subcommand>, que especificará a opção para cada relevante <subcommand>
    • Omitir ambos <command> e <subcommand>, o que especificará a opção globalmente para todos os <command> e <subcommand> relevantes.

Observação

* config os arquivos aceitam apenas espaços, não =, entre sinalizadores de opção e valores.

  • Especificar uma opção na linha de comando substitui o valor config definido para essa opção.
  • Para especificar mais de uma opção para um <command>, <subcommand>ou globalmente, use uma linha por opção.

Exemplos

  • Para emitir todos os resultados de análise gerados pelo codeql database analyze no formato CSV, você especificaria:

    database analyze --format csv
    

    Aqui, você precisa especificar o comando e o subcomando para impedir que um dos comandos de baixo nível executados durante database analyze passe a mesma opção --format.

  • Para definir a RAM (4096 MB) e o número de threads (4) a serem usados ao executar comandos do CodeQL, especifique o seguinte, em linhas separadas:

    --ram 4096
    --threads 4
    
  • Para especificar globalmente um diretório para CodeQL a fim de verificar pacotes do CodeQL (que não sejam irmãos do diretório de instalação), use:

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