Skip to main content

Leitfaden zu CodeQL-CLI-Befehlen

Referenzinformationen zu den Befehlen, die in der neuesten Version von CodeQL CLI verfügbar sind

Who can use this feature?

GitHub CodeQL wird nach der Installation auf Benutzerbasis lizenziert. Du kannst CodeQL nur für bestimmte Aufgaben unter den Lizenzeinschränkungen verwenden. Weitere Informationen findest du unter Informationen zur CodeQL-CLI.

Wenn du über eine GitHub Advanced Security-Lizenz verfügst, kannst du CodeQL für eine automatisierte Analyse sowie für Continuous Integration und Continuous Delivery verwenden. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

In diesem Inhalt wird die neueste Version von CodeQL CLI beschrieben. Weitere Informationen zu diesem Thema findest du unter https://github.com/github/codeql-cli-binaries/releases.

Um Details zu den Optionen anzuzeigen, die für diesen Befehl in früheren Releases verfügbar sind, führe den Befehl mit der Option --help im Terminal aus.

bqrs decode

Konvertiert Ergebnisdaten aus BQRS in andere Formulare.

bqrs diff

Berechnet die Differenz zwischen zwei Resultsets.

bqrs-Hash

[Plumbing] Berechnet einen stabilen Hash einer BQRS-Datei.

bqrs info

Zeigt Metadaten für eine BQRS-Datei an.

bqrs interpret

[Sanitär] Interpretieren von Daten in einem einzelnen BQRS.

database add-diagnostic

[Experimentell] Hinzufügen von Diagnoseinformationen zu einer Datenbank

database analyze

Analysiert eine Datenbank und erzeugt aussagekräftige Ergebnisse im Kontext des Quellcodes.

database bundle

Erstellt ein wiederverwendbares Archiv einer CodeQL-Datenbank.

database cleanup

Komprimiert eine CodeQL-Datenbank auf dem Datenträger.

database create

Erstellt eine CodeQL-Datenbank für eine Quellstruktur, die mithilfe eines der CodeQL-Produkte analysiert werden kann.

database export-diagnostics

[Experimentell] Exportieren von Diagnoseinformationen aus einer Datenbank für eine fehlgeschlagene Analyse

database finalize

[Infrastruktur] Letzte Schritte bei der Datenbankerstellung.

Datenbankimport

[Erweitert] [Sanitär] Importiere nicht abgeschlossene Datenbanken in eine andere nicht definierte Datenbank.

database index-files

[Infrastruktur] Indiziere eigenständige Dateien mit einem angegebenen CodeQL-Extraktor.

database init

[Sanitär] Erstellt eine leere CodeQL-Datenbank.

database interpret-results

[Plumbing] Interpretiert die berechneten Abfrageergebnisse in aussagekräftige Formate wie SARIF oder CSV.

database print-baseline

[Plumbing] Gibt eine Zusammenfassung der angezeigten Baselinecodezeilen aus.

database run-queries

[Plumbing] Führt eine Reihe von Abfragen zusammen aus.

database trace-command

[Plumbing] Führt einen einzelnen Befehl als Teil eines überwachten Builds aus.

database unbundle

Extrahiert ein CodeQL-Datenbankarchiv

database upgrade

Führe ein Upgrade für eine Datenbank durch, damit sie von den aktuellen Tools verwendet werden kann.

dataset check

[Plumbing] Überprüft ein bestimmtes Dataset auf interne Konsistenz

dataset cleanup

[Plumbing] Bereinigt temporäre Dateien in einem Dataset.

dataset import

[Plumbing] Importiert TRAP-Dateien in ein unformatiertes Dataset.

dataset measure

[Plumbing] Sammelt Statistiken zu den Beziehungen in einem bestimmten Dataset.

dataset upgrade

[Plumbing] Führt ein Upgrade für ein Dataset durch, damit es von den aktuellen Tools verwendet werden kann.

diagnostic add

[Experimentell] [Infrastruktur] Hinzufügen von Diagnoseinformationen

Diagnoseexport

[Experimentell] Exportieren von Diagnoseinformationen für eine fehlgeschlagene Analyse

execute cli-server

[Deep Plumbing] Server für die Ausführung mehrerer Befehle unter Vermeidung wiederholter JVM-Initialisierung

execute language-server

[Plumbing] Onlineunterstützung für die QL-Sprache in IDEs.

execute queries

[Plumbing] Führt mindestens eine Abfrage für ein Dataset aus.

execute query-server

[Plumbing] Unterstützung für die Ausführung von Abfragen aus IDEs.

execute query-server2

[Plumbing] Unterstützung für die Ausführung von Abfragen aus IDEs.

execute upgrades

[Plumbing] Führt Upgradeskripts für ein vorhandenes unformatiertes QL-Dataset aus.

generate extensible-predicate-metadata

[Experimentell] [Deep Plumbing] Hiermit werden die im jeweiligen Paket enthaltenen erweiterbaren Prädikate gemeldet.

generate log-summary

[Erweitert] Erstellt eine Zusammenfassung einer strukturierten Protokolldatei.

generate query-help

Generiert Hilfeinformationen zur Abfrage für Endbenutzer*innen aus QHELP-Dateien.

github upload-results

Lädt eine SARIF-Datei in die GitHub-Codeüberprüfung hoch.

pack add

[Experimentell] Fügt eine Liste von QL-Bibliothekspaketen mit optionalen Versionsbereichen als Abhängigkeiten des aktuellen Pakets hinzu und installiert diese dann.

pack bundle

[Experimentell] [Plumbing] Bündelt ein QL-Bibliothekspaket.

pack ci

[Experimentell] Installiert Abhängigkeiten für dieses Paket und überprüft, ob die vorhandene Sperrdatei auf dem neuesten Stand ist.

pack create

[Experimentell] [Plumbing] Erstellt den Inhalt eines QL-Pakets aus dem Quellcode.

pack download

[Experimentell] Lädt die qlpacks aus der Registrierung herunter, auf die von der Abfragespezifikation an der Befehlszeile verwiesen wird. Pakete können anhand des Namens oder implizit innerhalb einer Abfragesammlungsdatei (QLS) bereitgestellt werden.

pack init

[Experimentell] Initialisiert ein qlpack im angegebenen Verzeichnis.

pack install

[Experimentell] Installiert Abhängigkeiten für dieses Paket.

pack ls

[Experimentell] [Deep Plumbing] Listet die CodeQL-Pakete auf, deren Stamm dieses Verzeichnis ist. Dieses Verzeichnis muss eine Datei „qlpack.yml“ oder „.codeqlmanifest.json“ enthalten.

pack packlist

[Experimentell] [Infrastruktur] Berechne die Gruppe von Dateien, die in ein QL-Abfragepaket oder in ein Bibliothekspaket eingeschlossen werden sollen.

pack publish

[Experimentell] Veröffentlicht ein QL-Bibliothekspaket in einer Paketregistrierung.

pack resolve-dependencies

[Experimentell] [Plumbing] Berechnet die erforderlichen Abhängigkeiten für dieses QL-Paket.

pack upgrade

[Experimentell] Aktualisiert die Abhängigkeiten für dieses Paket auf die neuesten verfügbaren Versionen.

query compile

Kompiliert oder überprüft QL-Code.

query decompile

[Plumbing] Liest eine Zwischendarstellung einer kompilierten Abfrage aus einer QLO-Datei.

query format

Automatische Formatierung von QL-Quellcode

query run

Führt eine einzelne Abfrage aus.

resolve database

[Deep Plumbing] Erstellt einen Metadatenbericht für die Datenbank

resolve extensions

[Experimentell] [Deep Plumbing] Ermittelt Erweiterungen, auf die ein Zugriff möglich ist. Dies umfasst Machine Learning-Modelle und Datenerweiterungen.

Auflösen von Erweiterungen nach Paket

[Experimentell] [Deep Plumbing] Lege die zugänglichen Erweiterungen für die angegebenen Pfade zu Packstämmen fest. Dies umfasst Machine Learning-Modelle und Datenerweiterungen.

resolve extractor

[Deep Plumbing] Bestimmt das Extraktorpaket, das für eine bestimmte Sprache verwendet werden soll

resolve files

[Deep Plumbing] Erweitert mehrere Globs für Dateieinschlüsse/-ausschlüsse.

resolve languages

Listet die installierten CodeQL-Extraktorpakete auf.

resolve library-path

[Deep Plumbing] Legt den QL-Bibliothekspfad und das Datenbankschema für eine Abfrage fest.

resolve metadata

[Deep Plumbing] Löst die Schlüssel-Wert-Metadatenpaare aus einer Abfragequelldatei auf und gibt sie zurück.

resolve ml-models

[Veraltet] [Experimentell] [Deep Plumbing] Ermittelt Machine Learning-Modelle, auf die ein Zugriff möglich ist.

resolve qlpacks

Erstellt eine Liste der installierten QL-Pakete mit deren Speicherorten.

resolve qlref

[Deep Plumbing] Dereferenziert eine QLREF-Datei, um eine QL-Datei zurückzugeben.

resolve queries

[Deep Plumbing] Erweitert die Spezifikationen für Abfrageverzeichnisse und Sammlungen.

resolve ram

[Deep Plumbing] Bereitet RAM-Optionen vor.

resolve tests

[Deep Plumbing] Sucht QL-Komponententests in bestimmten Verzeichnissen

resolve upgrades

[Deep Plumbing] Bestimmt Upgrades, die für ein unformatiertes Dataset ausgeführt werden sollen.

test accept

Akzeptieren von Ergebnissen fehlerhafter Komponententests.

test extract

[Plumbing] Erstellt ein Dataset für ein Testverzeichnis.

test run

Führt Komponententests für QL-Abfragen aus.

version

Zeigt die Version der CodeQL-Toolkette an.