{"meta":{"title":"Abfragehilfe generieren","intro":"Generiert Hilfeinformationen zur Abfrage für Endbenutzer*innen aus QHELP-Dateien.","product":"Sicherheit und Codequalität","breadcrumbs":[{"href":"/de/code-security","title":"Sicherheit und Codequalität"},{"href":"/de/code-security/reference","title":"Reference"},{"href":"/de/code-security/reference/code-scanning","title":"Codeüberprüfung"},{"href":"/de/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/de/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI-Leitfaden"},{"href":"/de/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help","title":"Abfragehilfe generieren"}],"documentType":"article"},"body":"# Abfragehilfe generieren\n\nGeneriert Hilfeinformationen zur Abfrage für Endbenutzer*innen aus QHELP-Dateien.\n\n## Zusammenfassung\n\n```shell copy\ncodeql generate query-help --format= [--output=] ... -- ...\n```\n\n## Description\n\nGeneriert Hilfeinformationen zur Abfrage für Endbenutzer*innen aus QHELP-Dateien.\n\n## Options\n\n### Primäre Optionen\n\n#### `...`\n\n \\[Obligatorisch] Abfragehilfedateien, die gerendert werden sollen. Jedes Argument ist entweder:\n\n* Eine zu rendernden QHELP-Datei\n* Eine MD-Datei, die gerendert werden soll.\n* Eine QL-Datei mit einer zugehörigen QHELP- oder MD-Datei, die gerendert werden soll.\n* Ein Verzeichnis, das rekursiv nach QL-Dateien mit zugehörigen QHELP- oder MD-Dateien durchsucht wird.\n* Eine QLS-Datei, die bestimmte Abfragen definiert.\n* Der Basisname einer bekannten QLS-Datei, die von einem der installierten QL-Pakete exportiert wurde.\n\n#### `--format=`\n\n \\[Obligatorisch] Das Format, in der die Dokumentation gerendert werden soll. Einer von:\n\n `markdown`: GitHub Flavored Markdown.\n\n `sarif-latest`: Static Analysis Results Interchange Format (SARIF), ein JSON-basiertes Format zum Beschreiben statischer Analyseergebnisse. Diese Formatoption basiert auf der neuesten unterstützten Version (v2.1.0). Sie eignet sich nicht für die Automatisierung, da sie zwischen verschiedenen CodeQL-Versionen unterschiedliche Versionen von SARIF erzeugt.\n\n `sarifv2.1.0`: SARIF v2.1.0.\n\n#### `-o, --output=`\n\nEin Pfad, in den die gerenderte Dokumentation geschrieben werden soll. Normalerweise ist dies ein Verzeichnis, in das die gerenderte Ausgabe geschrieben wird.\n\nWenn nur eine einzelne QHELP- oder QL-Datei bereitgestellt wird und im Ausgabepfad kein Verzeichnis vorhanden ist, wird die Ausgabe in eine einzelne Datei in diesem Pfad geschrieben.\n\nWenn kein Ausgabepfad angegeben wurde, wird nur eine einzelne QHELP- oder QL-Datei akzeptiert, und die Ausgabe wird in stdout geschrieben.\n\nWenn ein Ausgabeverzeichnis verwendet wird, werden Dateinamen _innerhalb_ des Ausgabeverzeichnisses von den Namen der QHELP-Dateien abgeleitet.\n\n#### `--warnings=`\n\nBehandeln von Warnungen vom Abfragehilferenderer Einer von:\n\n `hide`: Unterdrückt Warnungen.\n\n `show`\n _(default)_: Gibt Warnungen aus, setzt das Rendern jedoch fort.\n\n `error`: Behandelt Warnungen als Fehler.\n\n#### `--no-sarif-minify`\n\n \\[Nur SARIF-Formate] Erstellt eine übersichtlich formatierte SARIF-Ausgabe. Standardmäßig wird die SARIF-Ausgabe minimiert, um die Größe der Ausgabedatei zu verringern.\n\n### Optionen zum Suchen von QL-Paketen (die möglicherweise erforderlich sind, um Abfragesammlungen aufzulösen)\n\n#### `--search-path=[:...]`\n\nEine 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.\n\nWenn 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.\n\nEin entsprechender Verweis beim Auschecken des Open-Source-CodeQL-Repositorys sollte funktionieren, wenn eine der darin enthaltenen Sprachen abgefragt wird.\n\nWenn 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.)\n\n(Hinweis: Unter Windows wird `;` als Pfadtrennzeichen verwendet.)\n\n#### `--additional-packs=[:...]`\n\nBei 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.\n\nDies 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.\n\n(Hinweis: Unter Windows wird `;` als Pfadtrennzeichen verwendet.)\n\n### Optionen zum Konfigurieren des CodeQL-Paket-Managers\n\n#### `--registries-auth-stdin`\n\nFührt eine Authentifizierung bei GitHub Enterprise Server-Containerregistrierungen durch, indem eine durch Trennzeichen getrennte Liste von \\=\\-Paaren übergeben wird.\n\nDu kannst `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2` übergeben,\num dich bei zwei GitHub Enterprise Server-Instanzen zu authentifizieren.\n\nDadurch 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.\n\n#### `--github-auth-stdin`\n\nAuthentifiziere 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.\n\nFür die Authentifizierung bei Containerregistrierungen in GitHub Enterprise Server übergibst du `--registries-auth-stdin` oder verwendest die Umgebungsvariable „CODEQL\\_REGISTRIES\\_AUTH“.\n\nDadurch wird die GITHUB\\_TOKEN-Umgebungsvariable überschrieben.\n\n### Allgemeine Optionen\n\n#### `-h, --help`\n\nZeigt diesen Hilfetext an.\n\n#### `-J=`\n\n \\[Erweitert] Dient zum Angeben einer Option für die JVM-Instanz, die den Befehl ausführt.\n\n(Beachte, dass Optionen, die Leerzeichen enthalten, nicht ordnungsgemäß verarbeitet werden.)\n\n#### `-v, --verbose`\n\nErmöglicht die inkrementelle Erhöhung der Anzahl ausgegebener Statusmeldungen.\n\n#### `-q, --quiet`\n\nErmöglicht die inkrementelle Verringerung der Anzahl ausgegebener Statusmeldungen.\n\n#### `--verbosity=`\n\n \\[Erweitert] Dient zum expliziten Festlegen des Ausführlichkeitsgrads auf „errors“, „warnings“, „progress“, „progress+“, „progress++“ oder „progress+++“. Überschreibt `-v` und `-q`:\n\n#### `--logdir=`\n\n \\[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.\n\n(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.)\n\n#### `--common-caches=`\n\n \\[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.\n\nVerfügbar seit `v2.15.2`."}