Skip to main content

Enterprise Server 3.20 est actuellement disponible en tant que version candidate.

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 les packs CodeQL à un fichier de configuration CodeQL.

Qui peut utiliser cette fonctionnalité ?

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

Utilisation d’un fichier de configuration CodeQL

  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 fichier config, spécifiez les options que vous voulez appliquer à vos commandes CodeQL. 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

  •           Les fichiers `config` 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.

Examples

  • 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 (4 096 Mo) et le nombre de threads (4) à utiliser pour l’exécution des commandes CodeQL, spécifiez les éléments suivants sur des lignes distinctes :

    --ram 4096
    --threads 4
    
  • Pour spécifier globalement un répertoire dans lequel CodeQL recherche les packs CodeQL (qui ne soit pas un répertoire frère du répertoire d’installation), utilisez :

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