resolve library-path

Übersicht

codeql resolve library-path (--query=<qlfile> | --dir=<dir> | --root-pack=<pkgname>) <options>...

codeql resolve library-path (--query=<qlfile> | --dir=<dir> | --root-pack=<pkgname>) <options>...

Beschreibung

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

Legt fest, für welchen QL-Bibliothekspfad eine bestimmte Abfrage kompiliert werden soll. Diese Berechnung ist implizit für mehrere Unterbefehle, die möglicherweise Abfragen kompilieren müssen. Er wird als separater Plumbing-Befehl verfügbar gemacht, um (a) bei der Problembehandlung zu helfen und (b) einen Ausgangspunkt für die Änderung des Pfads in Ausnahmefällen zu bieten, in denen eine genaue Steuerung erforderlich ist.

Der Befehl erkennt auch die Sprache und das Datenbankschema, für die eine Abfrage kompiliert werden soll, da diese auch von der automatischen Erkennung der Sprache einer QL-Abfrage abhängen können.

Der Befehl ist absolut intern, und sein Verhalten oder Vorhandensein kann sich ohne Ankündigung ändern, wenn das QL-Sprachökosystem weiterentwickelt wird.

Optionen

Primäre Optionen

--[no-]find-extractors

[Erweitert] Fügt in die Ausgabe eine Zusammenfassung der extractor-Felder aus den QL-Paketen ein, von denen die Abfrage abhängt. Diese Option wird nur in einigen seltenen internen Fällen verwendet und erfordert möglicherweise mehr Rechenaufwand. Aus diesem Grund ist sie standardmäßig deaktiviert.

--format=<fmt>

Legt ein Ausgabeformat fest. Verfügbare Optionen:

lines (Standard) : Damit werden Befehlszeilenargumente jeweils in einer Zeile ausgegeben.

json: gibt ein JSON-Objekt mit allen Daten aus.

path: gibt nur den berechneten Bibliothekspfad aus.

dbscheme: gibt nur das erkannte Datenbankschema aus.

cache: gibt den Standardspeicherort für den Kompilierungscache aus oder nichts, wenn „none“.

Optionen von der Befehlszeile des aufrufenden Befehls

--search-path=<dir>[:<dir>...]

Eine Liste der Verzeichnisse, in denen QL-Pakete gefunden werden können. Jedes Verzeichnis kann entweder ein QL-Paket (oder ein Bündel von Paketen mit einer Datei vom Typ .codeqlmanifest.json am Stamm) oder das unmittelbar übergeordnete Element eines oder mehrerer solcher Verzeichnisse sein.

Wenn der Pfad mehrere Verzeichnisse enthält, definiert deren Reihenfolge ihre Rangfolge: Ist ein Paketname, der aufgelöst werden muss, in mehreren der Verzeichnisstrukturen enthalten, wird die erste Angabe verwendet.

Ein entsprechender Verweis beim Auschecken des Open-Source-CodeQL-Repositorys sollte funktionieren, wenn eine der darin enthaltenen Sprachen abgefragt wird.

Wenn du das CodeQL-Repository als gleichgeordnetes Element der entpackten CodeQL-Toolkette ausgecheckt hast, musst du diese Option nicht verwenden. Solche gleichgeordneten Verzeichnisse werden immer nach QL-Paketen durchsucht, die andernfalls nicht gefunden werden können. (Wenn diese Standardeinstellung nicht funktioniert, solltest du unbedingt --search-path in einer Benutzerkonfigurationsdatei festlegen.)

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--additional-packs=<dir>[:<dir>...]

Bei Angabe dieser Verzeichnisliste werden die Verzeichnisse vor den Verzeichnissen in --search-path nach Paketen durchsucht. Die Reihenfolge zwischen diesen Elementen spielt keine Rolle. Wenn ein Paketname über diese Liste an zwei verschiedenen Stellen gefunden wird, handelt es sich um einen Fehler.

Dies ist hilfreich, wenn du vorübergehend eine neue Version eines Pakets entwickelst, die auch am Standardpfad vorhanden ist. Andererseits wird davon abgeraten, diese Option in einer Konfigurationsdatei außer Kraft zu setzen. Einige interne Aktionen fügen diese Option direkt hinzu, wodurch alle konfigurierten Werte überschrieben werden.

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--library-path=<dir>[:<dir>...]

[Erweitert] Eine optionale Liste von Verzeichnissen, die dem unformatierten Suchpfad für den Import von QL-Bibliotheken hinzugefügt werden. Sollte nur verwendet werden, wenn du QL-Bibliotheken verwendest, die nicht als QL-Pakete gepackt wurden.

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--dbscheme=<file>

[Erweitert] Definiert explizit, für welche Abfragen des Datenbankschemas kompiliert werden sollen. Sollte nur von Aufrufer*innen angegeben werden, die sehr genau wissen, was sie tun.

--compilation-cache=<dir>

[Erweitert] Gibt ein zusätzliches Verzeichnis an, das als Kompilierungscache verwendet werden soll.

--no-default-compilation-cache

[Erweitert] Verwendet keine Kompilierungscaches an Standardspeicherorten, z. B. im QL-Paket mit der Abfrage oder im Verzeichnis der CodeQL-Toolkette.

Optionen zum Konfigurieren des CodeQL-Paket-Managers

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

Optionen zum Angeben der zu kompilierenden Elemente

Es muss genau eine dieser Optionen angegeben werden.

--query=<qlfile>

Der Pfad zur QL-Datei, die kompiliert werden soll.

Das Verzeichnis und die übergeordneten Verzeichnisse werden nach der Datei „qlpack.yml“ oder der Legacydatei „queries.xml“ durchsucht, um die erforderlichen Pakete zu ermitteln.

--dir=<dir>

Das Stammverzeichnis des Pakets mit den zu kompilierenden Abfragen.

--root-pack=<pkgname>

[Erweitert] Der deklarierte Name eines Pakets, das als Stamm für die Auflösung von Abhängigkeiten verwendet werden soll.

Diese Option wird verwendet, wenn das Paket unter diesem Namen an einer beliebigen Stelle im Suchpfad gefunden werden kann. Wenn du den Datenträgerspeicherort des gewünschten Stammpakets kennst, kannst du annehmen, dass es eine QL-Datei enthält und stattdessen --query verwenden.

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.