Skip to main content

Leitfaden zu CodeQL-CLI-Befehlen

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

Wer kann dieses Feature verwenden?

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

Hinweis

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-Informationen

Zeigt Metadaten für eine BQRS-Datei an.

bqrs interpretieren

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

Diagnosedatenbank hinzufügen

[Experimentell] Hinzufügen von Diagnoseinformationen zu einer Datenbank

Datenbankanalyse

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

Datenbankbundle

Erstellt ein wiederverwendbares Archiv einer CodeQL-Datenbank.

Datenbankbereinigung

Komprimiert eine CodeQL-Datenbank auf dem Datenträger.

Datenbank erstellen

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

Datenbankexportdiagnose

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

Datenbank finalisieren

[Infrastruktur] Letzte Schritte bei der Datenbankerstellung.

Datenbankimport

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

Datenbank-Indexdateien

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

Datenbankinit

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

Datenbankinterpret-Ergebnisse

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

Datenbank-Druckreferenzwert

[Plumbing] Gibt eine Zusammenfassung der angezeigten Baselinecodezeilen aus.

Abfragen in der Datenbank ausführen

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

Datenbankablaufverfolgungsbefehl

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

Datenbankentbundle

Extrahiert ein CodeQL-Datenbankarchiv

Datenbankupgrade

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

Datensatzüberprüfung

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

Bereinigung des Datasets

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

Dataset-Import

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

Datensatz-Maß

[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.

Diagnosehinzufügen

[Experimentell] [Infrastruktur] Hinzufügen von Diagnoseinformationen

Diagnoseexport

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

Ausführen von Cli-Server

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

Ausführung des Sprachservers

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

Abfragen ausführen

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

Abfrageserver ausführen

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

abfrage-server2 ausführen

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

Ausführen von Upgrades

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

extensible-predicate-metadata generieren

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

Protokollzusammenfassung generieren

[Erweitert] Erstellt eine Zusammenfassung einer strukturierten Protokolldatei.

Generieren von Überlagerungsänderungen

[Plumbing] Generiere eine Datei, die für

Abfragehilfe generieren

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

GitHub-Zusammenführung – Ergebnisse

[Deep Plumbing] Führt mehrere SARIF-Dateien in einer einzigen SARIF-Datei zusammen.

GitHub-Upload-Ergebnisse

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

Pack hinzufügen

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

Paketpaket

[Plumbing] Bündelt ein QL-Bibliothekspaket.

Pack ci

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

Paket erstellen

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

Pack-Download

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

Initialisiert ein qlpack im angegebenen Verzeichnis.

Paketinstallation

Installiert Abhängigkeiten für dieses Paket.

Pack ls

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

pack Packliste

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

Paket veröffentlichen

Veröffentlicht ein QL-Bibliothekspaket in einer Paketregistrierung.

Pack-Auflösungsabhängigkeiten

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

Paket-Upgrade

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

Abfragekompilierung

Kompiliert oder überprüft QL-Code.

Abfrage dekompilieren

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

Abfrageformat

Automatische Formatierung von QL-Quellcode

Abfrageausführung

Führt eine einzelne Abfrage aus.

Datenbank auflösen

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

Auflösen von Erweiterungen

[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.

Extraktor auflösen

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

Auflösen von Dateien

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

Sprachen klären

Listet die installierten CodeQL-Extraktorpakete auf.

Bibliothekspfad auflösen

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

Metadaten auflösen

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

ml-Modelle auflösen

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

Auflösen von Paketen

Zeigt eine Liste der verfügbaren CodeQL-Pakete und deren Speicherorte an.

qlpacks auflösen

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

qlref auflösen

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

Abfragen auflösen

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

RAM-Probleme beheben

[Deep Plumbing] Bereitet RAM-Optionen vor.

Durchführen von Tests

[Deep Plumbing] Sucht QL-Komponententests in bestimmten Verzeichnissen

Abschluss von Upgrades

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

Test akzeptieren

Akzeptieren von Ergebnissen fehlerhafter Komponententests.

Testextrakt

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

test run

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

Ausgabe

Zeigt die Version der CodeQL-Toolkette an.