pack init

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 init [--dir=<dir>] [--extractor=<extractor>] <options>... -- <package-name>

codeql pack init [--dir=<dir>] [--extractor=<extractor>] <options>... -- <package-name>

Beschreibung

Initialisiert ein qlpack im angegebenen Verzeichnis.

Das Paket wird in einem untergeordneten Verzeichnis des angegebenen Verzeichnisses erstellt.

Verfügbar seit v2.6.0.

Optionen

Primäre Optionen

`<package-name>`

[Obligatorisch] Der Bereich und Name des zu erstellenden Pakets. Der Bereich ist nur erforderlich, wenn dieses Paket veröffentlicht werden soll.

`--version=<semver>`

Ursprüngliche Version des Pakets.

`-d, --dir=<dir>`

Das Verzeichnis, in dem das Paket erstellt werden soll. Der Standardwert ist das aktuelle Arbeitsverzeichnis.

`-e, --extractor=<extractor>`

Der Extraktor, der für dieses qlpack verwendet werden soll. Nur nützlich, wenn dieses Paket Tests enthält.

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.