Skip to main content

Spécification des options de commande dans un fichier de configuration CodeQL

Gagnez du temps en ajoutant vos options de commande fréquemment utilisées et vos packs personnalisés CodeQL à un CodeQL fichier de configuration.

Qui peut utiliser cette fonctionnalité ?

CodeQL est disponible pour les types de référentiels suivants :

Utilisation d’un CodeQL fichier de configuration

  1. Créez et enregistrez un fichier config sous votre sous-répertoire famille (Linux et macOS) ou profil utilisateur (Windows) dans le sous-répertoire .config/codeql/. Par exemple : $HOME/.config/codeql/config.

  2. Dans le config fichier, spécifiez les options à appliquer à vos CodeQL commandes. La syntaxe pour la spécification des options est la suivante :

    <command> <subcommand> <option> <value>
    
  3. Pour appliquer les mêmes options à plusieurs commandes, vous pouvez :

    • Omettre <subcommand>, qui spécifie l’option pour chaque élément pertinent <subcommand>
    • Omettre à la fois <command> et <subcommand>, qui spécifie l’option globalement pour chaque élément pertinent <command> et <subcommand>

Remarque

* config les fichiers acceptent uniquement les espaces, pas =entre les indicateurs d’option et les valeurs.

  • La spécification d’une option sur la ligne de commande remplace toute config valeur définie pour cette option.
  • Pour spécifier plusieurs options pour un <command>, <subcommand>ou globalement, utilisez une ligne par option.

Exemples

  • Pour sortir tous les résultats d’analyse générés par codeql database analyze au format CSV, vous devez spécifier :

    database analyze --format csv
    

    Ici, vous devez spécifier la commande et la sous-commande pour éviter que la même option database analyze soit transférée aux commandes de bas niveau exécutées pendant --format.

  • Pour définir la RAM (4096 Mo) et le nombre de threads (4) à utiliser lors de l’exécution CodeQL de commandes, spécifiez ce qui suit sur des lignes distinctes :

    --ram 4096
    --threads 4
    
  • Pour spécifier au niveau global un répertoire pour que CodeQL analyse CodeQL les packs (qui n’est pas situé au même niveau que le répertoire d’installation), utilisez :

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