Hinweis: Dieser Artikel wurde im Januar 2023 von der CodeQL-Dokumentationswebsite migriert.
Informationen zur CodeQL CLI
Softwareentwickler*innen und Sicherheitsfachkräfte können ihren Code mithilfe der CodeQL CLI sichern.
Die CodeQL CLI ist ein Befehlszeilentool, das zum lokalen Ausführen von CodeQL-Prozessen in Open-Source-Softwareprojekten verwendet wird. Du kannst die CodeQL CLI verwenden, um Folgendes zu tun:
- Ausführen von CodeQL-Analysen mithilfe von Abfragen, die von GitHub-Entwickler*innen und der Open-Source-Community bereitgestellt werden
- Erstellen von CodeQL-Datenbanken zur Verwendung in der CodeQL für Visual Studio Code
- Entwickeln und Testen von benutzerdefinierten CodeQL-Abfragen für die Verwendung in eigenen Analysen
Informationen zur Verwendung der CodeQL CLI findest du unter Erste Schritte mit der CodeQL CLI.
Du kannst auch GitHub Actions oder Azure DevOps-Pipelines verwenden, um Code mithilfe der CodeQL CLI zu überprüfen. Weitere Informationen findest du unter Konfigurieren der Codeüberprüfung für ein Repository oder Konfigurieren von GitHub Advanced Security for Azure DevOps in Microsoft Learn.
Informationen zur GitHub CodeQL-Lizenz
Lizenzhinweis: Wenn du keine GitHub Enterprise-Lizenz besitzt, stimmst du mit dem Installieren dieses Produkts den GitHub CodeQL-Geschäftsbedingungen zu.
GitHub CodeQL wird auf Benutzerbasis lizenziert. Im Rahmen der Lizenzbeschränkungen kannst du CodeQL verwenden, um die folgenden Aufgaben auszuführen:
- Durchführen wissenschaftlicher Forschung
- Vorstellen der Software
- Testen der CodeQL-Abfragen, die unter einer von der OSI genehmigten Lizenz veröffentlicht werden, um zu bestätigen, dass neue Versionen dieser Abfragen weiterhin die richtigen Sicherheitsrisiken ermitteln
„Von der OSI genehmigte Lizenz“ meint dabei eine von der Open Source Initiative (OSI) genehmigte Open-Source-Softwarelizenz.
Wenn du mit einer Open-Source-Codebasis arbeitest (d. h. einer Codebasis, die unter einer von der OSI genehmigten Lizenz veröffentlicht wurde), kannst du CodeQL auch für die folgenden Aufgaben verwenden:
- Durchführen der Analyse der Open-Source-Codebasis
- Wenn die Open-Source-Codebasis auf GitHub.com gehostet und verwaltet wird, um CodeQL-Datenbanken für oder während der automatisierten Analyse, Continuous Integration oder Continuous Delivery zu generieren
CodeQL kann nicht für automatisierte Analysen, Continuous Integration oder Continuous Delivery verwendet werden, weder als Teil normaler Softwareentwicklungsprozesse noch anderweitig, außer in den hier ausdrücklich genannten Fällen. Wende dich für diese Verwendungszwecke an das Vertriebsteam.
CodeQL CLI-Befehle
Die CodeQL CLI enthält Befehle zum Erstellen und Analysieren von CodeQL-Datenbanken über die Befehlszeile. So führst du einen Befehl aus:
codeql [command] [subcommand]
Die vollständige Referenzdokumentation für einen Befehl kannst du durch Hinzufügen des Flags --help aufrufen. Alternativ findest du sie unter Leitfaden zu CodeQL-CLI-Befehlen.