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.

Wer kann dieses Feature verwenden?

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

In diesem Artikel

Note

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.

Übersicht

Shell
codeql pack ls <options>... -- <dir>

Beschreibung

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

Verfügbar seit v2.7.1.

Optionen

Primäre Optionen

<dir>

Das Stammverzeichnis des Pakets oder Arbeitsbereichs, standardmäßig ist dies das aktuelle Arbeitsverzeichnis. Wenn dieser Parameter auf ein Verzeichnis verweist, das eine Datei „qlpack.yml“ enthält, wird dieser Vorgang nur für dieses CodeQL-Paket ausgeführt. Wenn dieser Parameter auf ein Verzeichnis verweist, das eine Datei „codeql-workspace.yml“ enthält, wird dieser Vorgang für alle CodeQL-Pakete im Arbeitsbereich ausgeführt.

Optionen zum Konfigurieren, auf welche CodeQL-Pakete dieser Befehl angewandt werden soll.

--format=<fmt>

Dient zum Auswählen des Ausgabeformats: text (Standardwert) oder json

--groups=[-]<group>[,[-]<group>...]

Listet die CodeQL-Paketgruppen auf, die bei diesem Vorgang ein- oder ausgeschlossen werden sollen. Ein qlpack im angegebenen Arbeitsbereich wird in folgenden Fällen eingeschlossen:

  • Es befindet sich in mindestens einer der Gruppen, die ohne Minuszeichen aufgeführt sind (diese Bedingung wird automatisch erfüllt, wenn keine Gruppen ohne Minuszeichen aufgeführt werden).
  • Es befindet sich in keiner Gruppe, die mit einem Minuszeichen aufgeführt ist.

Allgemeine Optionen

-h, --help

Zeigt diesen Hilfetext an.

-J=<opt>

[Erweitert] Dient zum Angeben einer Option für die JVM-Instanz, die den Befehl ausführt.

(Beachte, dass Optionen, die Leerzeichen enthalten, nicht ordnungsgemäß verarbeitet werden.)

-v, --verbose

Ermöglicht die inkrementelle Erhöhung der Anzahl ausgegebener Statusmeldungen.

-q, --quiet

Ermöglicht die inkrementelle Verringerung der Anzahl ausgegebener Statusmeldungen.

--verbosity=<level>

[Erweitert] Dient zum expliziten Festlegen des Ausführlichkeitsgrads auf „errors“, „warnings“, „progress“, „progress+“, „progress++“ oder „progress+++“. Überschreibt -v und -q:

--logdir=<dir>

[Erweitert] Ermöglicht das Schreiben detaillierter Protokolle in eine oder mehrere Dateien im angegebenen Verzeichnis mit generierten Namen, die Zeitstempel und den Namen des ausgeführten Unterbefehls enthalten.

(Um eine Protokolldatei mit einem Namen zu schreiben, über den du die volle Kontrolle hast, gib stattdessen --log-to-stderr an, und leite stderr wie gewünscht um.)

--common-caches=<dir>

[Erweitert] Steuert den Speicherort zwischengespeicherter Daten auf dem Datenträger, der zwischen mehreren Ausführungsvorgängen der CLI beibehalten wird, z. B. heruntergeladene QL-Pakete und kompilierte Abfragepläne. Wenn dies nicht explizit festgelegt ist, wird dieses Verzeichnis standardmäßig auf ein Verzeichnis mit dem Namen .codeql festgelegt, das sich im Startverzeichnis des Benutzer. Es wird erstellt, wenn es noch nicht vorhanden ist.

Verfügbar seit v2.15.2.