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
codeql pack add <options>... -- <scope/name[@range]>...
codeql pack add <options>... -- <scope/name[@range]>...
Beschreibung
Fügt eine Liste von QL-Bibliothekspaketen mit optionalen Versionsbereichen als Abhängigkeiten des aktuellen Pakets hinzu und installiert diese dann.
Dieser Befehl ändert die Datei „qlpack.yml“ des aktuellen Pakets. Formatierungen und Kommentare werden entfernt.
Verfügbar seit v2.6.0
.
Optionen
Primäre Optionen
<scope/name[@range]>...
[Obligatorisch] Der Bereich, der Name und der optionale Versionsbereich des Pakets, das der Abhängigkeitsliste hinzugefügt werden soll.
Wenn kein Versionsbereich angegeben ist oder der Versionsbereich als „Neuester“ angegeben ist, wird die neueste Version des Pakets heruntergeladen, und qlpack.yml wird eine Abhängigkeit hinzugefügt, die jede Version zulässt, die mit der heruntergeladenen Version kompatibel ist.
Wenn eine einzelne Version angegeben ist, wird diese Version des Pakets heruntergeladen, und qlpack.yml wird eine Abhängigkeit hinzugefügt, die jede Version zulässt, die mit der angegebenen Version kompatibel ist.
Wenn ein Versionsbereich angegeben ist, wird die neueste Version des Pakets heruntergeladen, die zum angegebenen Bereich gehört, und qlpack.yml wird eine Abhängigkeit mit dem angegebenen Versionsbereich hinzugefügt.
--dir=<dir>
Das Stammverzeichnis des Pakets.
--registries-auth-stdin
Führt eine Authentifizierung bei GitHub Enterprise Server-Containerregistrierungen durch, indem eine durch Trennzeichen getrennte Liste von <registry_url>=<token>-Paaren übergeben wird.
Du kannst https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
übergeben,
um dich bei zwei GitHub Enterprise Server-Instanzen zu authentifizieren.
Dadurch werden die Umgebungsvariablen CODEQL_REGISTRIES_AUTH und GITHUB_TOKEN überschrieben. Wenn du dich nur bei der Containerregistrierung von github.com authentifizieren musst, kannst du dich stattdessen mit der einfacheren Option --github-auth-stdin
authentifizieren.
--github-auth-stdin
Authentifiziere dich bei der Containerregistrierung auf github.com, indem du auf github.com ein GitHub Apps-Token oder ein persönliches Zugriffstoken über die Standardeingabe übergibst.
Für die Authentifizierung bei Containerregistrierungen in GitHub Enterprise Server übergibst du --registries-auth-stdin
oder verwendest die Umgebungsvariable „CODEQL_REGISTRIES_AUTH“.
Dadurch wird die GITHUB_TOKEN-Umgebungsvariable überschrieben.
--[no-]allow-prerelease
Erlaubt Pakete mit Vorabversionsqualifizierern (z. B. X.Y.Z-qualifier
). Ohne dieses Flag werden Vorabversionspakete ignoriert.
Verfügbar seit v2.11.3
.
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
.