{"meta":{"title":"Einrichten der CodeQL-CLI","intro":"Um mit dem CodeQL CLIProgramm zu beginnen, müssen Sie die CLI herunterladen und einrichten, damit sie auf die Tools und Bibliotheken zugreifen kann, die zum Erstellen und Analysieren von Datenbanken erforderlich sind.","product":"Sicherheit und Codequalität","breadcrumbs":[{"href":"/de/code-security","title":"Sicherheit und Codequalität"},{"href":"/de/code-security/how-tos","title":"How-tos"},{"href":"/de/code-security/how-tos/find-and-fix-code-vulnerabilities","title":"Suchen und Beheben von Coderisiken"},{"href":"/de/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-the-command-line","title":"Scannen über die Befehlszeile"},{"href":"/de/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli","title":"Einrichten der CodeQL CLI"}],"documentType":"article"},"body":"# Einrichten der CodeQL-CLI\n\nUm mit dem CodeQL CLIProgramm zu beginnen, müssen Sie die CLI herunterladen und einrichten, damit sie auf die Tools und Bibliotheken zugreifen kann, die zum Erstellen und Analysieren von Datenbanken erforderlich sind.\n\n## Einrichten von CodeQL CLI\n\nZum Ausführen von CodeQL Befehlen müssen Sie die CodeQL CLI So einrichten, dass sie auf die Tools, Abfragen und Bibliotheken zugreifen kann, die zum Erstellen und Analysieren von Datenbanken erforderlich sind.\n\nDies CodeQL CLI unterstützt eine Reihe von Anwendungsfällen und Verzeichnisstrukturen. In diesem Artikel wird ein einfaches Setup erläutert, das für die meisten Benutzer und Umgebungen funktioniert.\n\nWenn Sie beabsichtigen, die CodeQL CLI Sicherheitsforschung zu verwenden oder Abfragen zu testen oder mitzuwirken, benötigen Sie möglicherweise eine erweiterte Einrichtung. Weitere Informationen findest du unter [Informationen zur CodeQL-CLI](/de/code-security/concepts/code-scanning/codeql/about-the-codeql-cli#getting-started).\n\n### Bevor Sie anfangen\n\nWenn du macOS auf Apple Silicon (z. B. Apple M1) verwendest, stelle sicher, dass die [Entwicklertools für die Xcode-Befehlszeile](https://developer.apple.com/library/archive/technotes/tn2339/_index.html) und [Rosetta 2](https://support.apple.com/en-us/HT211861) installiert sind.\n\n> \\[!NOTE]\n> Dies CodeQL CLI ist derzeit nicht mit nicht-glibc Linux-Distributionen wie (muslc-based) Alpine Linux kompatibel.\n\n### 1. Herunterladen des Tar-Archivs CodeQL CLI\n\nDas CodeQL CLI-Downloadpaket ist ein tar-Archiv, das Tools, Skripts und verschiedene für CodeQL spezifische Dateien enthält. Wenn du keine GitHub Enterprise-Lizenz besitzt, stimmst du mit dem Herunterladen dieses Archivs den [GitHub CodeQL-Geschäftsbedingungen](https://securitylab.github.com/tools/codeql/license) zu.\n\nDu solltest das CodeQL-Paket aus herunterladen. Das Paket enthält Folgendes:\n\n* CodeQL CLI product\n* Eine kompatible Version der Abfragen und Bibliotheken von \n* Vorkompilierte Versionen aller im Paket enthaltenen Abfragen\n\nSie sollten immer das CodeQL-Bundle verwenden. Dies stellt Kompatibilität und weitaus bessere Leistung sicher, als ein separater Download von CodeQL CLI und Check-Out der CodeQL-Abfragen. Wenn du die CLI nur auf einer bestimmten Plattform ausführst, lade die entsprechende `codeql-bundle-PLATFORM.tar.zst`-Datei herunter. Alternativ kannst du `codeql-bundle.tar.zst` herunterladen. Diese Datei enthält die CLI für alle unterstützten Plattformen.\n\nEs gibt auch `tar.gz`-Varianten des Bundles, die mit den `tar.zst`-Varianten identisch sind, außer dass, sie mit dem weniger effizienten Gzip-Algorithmus komprimiert sind. Der einzige Grund zum Herunterladen der `tar.gz`-Varianten ist, wenn Sie ältere Dekomprimierungstools verwenden, die den Zstandard-Komprimierungsalgorithmus nicht unterstützen.\n\n### 2. Extrahieren des Tar-Archivs CodeQL CLI\n\nExtrahieren Sie das CodeQL CLI Tar-Archiv in ein Verzeichnis Ihrer Wahl.\n\n### Optional: Stellen Sie das CodeQL CLI In Ihrem CI-System zur Verfügung\n\nWenn Sie eine Analyse in einem CI-System durchführen CodeQLcode scanning möchten, stellen Sie sicher, dass der vollständige Inhalt des CodeQL CLI Bundles für jeden CI-Server verfügbar ist, der eine Analyse ausführt.\n\nDu hast beispielsweise folgende Möglichkeiten:\n\n* Kopieren Sie das Bündel von einem zentralen internen Speicherort, und extrahieren Sie es auf jedem Server oder\n* Verwenden Sie die REST-API, um das Bundle direkt GitHubherunterzuladen, um sicherzustellen, dass Sie die neuesten Verbesserungen für Abfragen erhalten. Weitere Informationen findest du unter [REST-API-Endpunkte für Releases und Releaseressourcen](/de/rest/releases).\n\n### 3. Starten von `codeql`\n\nNach der Extraktion kannst du CodeQL-Prozesse ausführen, indem du die ausführbare `codeql`-Datei auf verschiedene Arten ausführst:\n\n* Indem du `/codeql/codeql` ausführst, wobei `` der Ordner ist, in dem du das CodeQL CLI-Paket extrahiert hast\n* Indem du `/codeql` zu deinem `PATH` hinzufügst, damit du die ausführbare Datei einfach als `codeql` ausführen kannst\n\nAn diesem Punkt kannst du die CodeQL-Befehle ausführen. Eine vollständige Liste der CodeQL CLI-Befehle findest du unter [Leitfaden zu CodeQL-CLI-Befehlen](/de/code-security/codeql-cli/codeql-cli-manual).\n\n> \\[!NOTE]\n> Wenn Sie Zu Ihrem `PATH`Add-In hinzufügen`codeql`, kann darauf zugegriffen werden, indem CodeQLVisual Studio Code Sie Abfragen kompilieren und ausführen können. Weitere Informationen zum Konfigurieren VS Code für den Zugriff auf die CodeQL CLIDatei finden Sie unter [Das Verwalten der CodeQL-CLI in der VS Code-Erweiterung](/de/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli).\n\n## Testen der CodeQL CLI Konfiguration\n\nNachdem Sie das CodeQL CLI Bundle extrahiert haben, können Sie den folgenden Befehl ausführen, um zu überprüfen, ob die CLI ordnungsgemäß zum Erstellen und Analysieren von Datenbanken konfiguriert ist:\n\n* `codeql resolve packs` wenn `//codeql` auf der `PATH` steht.\n* Andernfalls `//codeql/codeql resolve packs`.\n\nWenn du erfolgreich bist, solltest du eine Ausgabe ähnlich dem unten stehenden Auszug sehen:\n\n```shell\nSearching directories specified by `--additional-packs`. All directories have equal priority.\n Searching in:\n No packs were found at this location.\nSearching directories specified by `--search-path`. Directories are searched in order.\nSearching the root of the CodeQL distribution.\n Searching in:\n \n The following packs were found:\n codeql/java-all@: (library) /qlpacks/codeql/javat-all//qlpack.yml\n codeql/java-queries@: (query) /qlpacks/codeql/java-queries//qlpack.yml\n codeql/javascript-all@: (library) /qlpacks/codeql/javascript-all//qlpack.yml\n codeql/javascript-queries@: (query) /qlpacks/codeql/javascript-queries//qlpack.yml\n codeql/swift-all@: (library) /qlpacks/codeql/swift-all//qlpack.yml\n codeql/swift-queries@: (query) /qlpacks/codeql/swift-queries//qlpack.yml\n...\n```\n\nDie Ergebnisse wurden aus Gründen der Übersichtlichkeit verkürzt dargestellt. Die tatsächlichen Ergebnisse werden länger und detaillierter sein.\n\nDu solltest überprüfen, ob die Ausgabe die erwarteten Sprachen enthält und ob der Verzeichnisspeicherort der qlpack-Dateien korrekt ist. Der Speicherort sollte sich innerhalb des extrahierten CodeQL CLI Bundles befinden, wie im vorherigen Beispiel gezeigt als ``. Wenn die CodeQL CLI qlpacks für die erwarteten Sprachen nicht gefunden werden können, überprüfen Sie, ob Sie das CodeQL Bundle heruntergeladen haben und keine eigenständige Kopie der .CodeQL CLI\n\nDu kannst auch `codeql resolve languages` ausführen, um die für die Datenbankerstellung verfügbaren Sprachen anzuzeigen. Dadurch werden die sprachen aufgeführt, die standardmäßig in Ihrem CodeQL CLI Paket unterstützt werden.\n\nOptional kannst du einige CodeQL-Pakete mit vorkompilierten Abfragen herunterladen, die du ausführen möchtest. Weitere Informationen findest du unter [Anpassen der Analyse mit CodeQL-Paketen](/de/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs).\n\nDer `codeql resolve packs` Befehl ist nützlich, um Probleme zu diagnostizieren, wenn die CodeQL CLI Abfragepakete, die Sie für die Analyse erwarten, nicht finden können.\n\n> \\[!NOTE] Der `codeql resolve packs` Befehl ist in den CodeQL CLI Versionen 2.19.0 und höher verfügbar. Für frühere Versionen des CLI solltest du den `codeql resolve qlpacks`-Befehl ausführen, der eine ähnliche, aber weniger detaillierte Ausgabe liefert.\n\n## Nächste Schritte\n\nInformationen zum Vorbereiten des Codes, der von autoTITLE CodeQL CLIanalysiert werden soll, finden Sie unter [Vorbereiten des Codes für die CodeQL-Analyse](/de/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis)."}