Skip to main content

Angeben von Befehlsoptionen in einer CodeQL-Konfigurationsdatei

Sparen Sie Zeit, indem Sie Häufig verwendete Befehlsoptionen und benutzerdefinierte CodeQL Pakete zu einer CodeQL Konfigurationsdatei hinzufügen.

Wer kann dieses Feature verwenden?

CodeQL ist für die folgenden Repositorytypen verfügbar:

Verwenden einer CodeQL Konfigurationsdatei

  1. Erstellen und speichern Sie eine config-Datei unter Ihrem Heimverzeichnis (Linux und macOS) oder benutzerprofil (Windows) im Unterverzeichnis .config/codeql/. Beispiel: $HOME/.config/codeql/config.

  2. Geben Sie in der config Datei die Optionen an, die Sie auf Ihre CodeQL Befehle anwenden möchten. Für das Angeben der Optionen gilt folgende Syntax:

    <command> <subcommand> <option> <value>
    
  3. Wenn Sie die gleichen Optionen auf mehrere Befehle anwenden möchten, können Sie:

    • Lassen Sie <subcommand> weg, um die Option für alle relevanten <subcommand> festzulegen.
    • Lassen Sie sowohl <command> als auch <subcommand> weg, wodurch die Option global für alle relevanten <command> und <subcommand> festgelegt wird.

Hinweis

* config Dateien akzeptieren nur Leerzeichen, nicht =zwischen Optionskennzeichnungen und Werten.

  • Wenn Sie eine Option in der Befehlszeile angeben, werden alle config für diese Option definierten Werte außer Kraft gesetzt.
  • Wenn Sie mehrere Optionen für ein <command>, <subcommand>oder global angeben möchten, verwenden Sie eine Zeile pro Option.

Beispiele

  • Gib Folgendes an, um alle von codeql database analyze generierten Analyseergebnisse im CSV-Format auszugeben:

    database analyze --format csv
    

    An dieser Stelle musst du den Befehl und den Unterbefehl angeben, um zu verhindern, dass alle Low-Level-Befehle, die bei der database analyze ausgeführt werden, die gleiche --format-Option erhalten.

  • Um den RAM (4096 MB) und die Anzahl der Threads (4) zu definieren, die beim Ausführen CodeQL von Befehlen verwendet werden sollen, geben Sie Folgendes in separaten Zeilen an:

    --ram 4096
    --threads 4
    
  • Um global ein Verzeichnis für die Suche nach CodeQLCodeQL Paketen (die kein gleichgeordnetes Verzeichnis des Installationsverzeichnisses sind) anzugeben, verwenden Sie Folgendes:

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