diagnostic add

Note

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

Shell

codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

Beschreibung

[Experimentell] [Infrastruktur] Hinzufügen von Diagnoseinformationen

Verfügbar seit v2.12.6.

Optionen

Primäre Optionen

`--markdown-message=<markdownMessage>`

Meldung für die Diagnose im GitHub Flavored Markdown-Format.

`--plaintext-message=<plaintextMessage>`

Meldung für die Diagnose im Nur-Text-Format. Diese Option sollte nur verwendet werden, wenn das Auffüllen einer Markdown-Meldung mit „--markdown-message“ nicht möglich ist.

`--severity=<severity>`

Schweregrad der Diagnose. Die möglichen Werte sind „error“, „warning“ und „note“.

`--help-link=<helpLinks>`

Hilfelinks, die für die Diagnose relevant sind.

`--attributes-json=<attributesJson>`

Strukturierte Metadaten, die für die Diagnose relevant sind.

Optionen zum Angeben des Speicherorts für die Diagnoseinformationen

Es muss genau eine dieser Optionen angegeben werden.

`--diagnostic-dir=<diagnosticDir>`

Verzeichnis, dem die Diagnose hinzugefügt werden soll.

Optionen zum Angeben der möglichen Anzeigeorte für die Diagnosemeldung

`--ready-for-status-page`

Gibt an, dass die Diagnose für die Anzeige auf der Statusseite geeignet ist.

`--ready-for-cli-summary-table`

Gibt an, dass die Diagnose für die Anzeige in der Zusammenfassungstabelle der Diagnose geeignet ist, die von Befehlen wie database analyze ausgegeben wird.

Optionen zum Beschreiben der Quelle der Diagnose

`--source-id=<id>`

[Obligatorisch] Ein Bezeichner für die Quelle der Diagnose.

`--source-name=<name>`

[Obligatorisch] Eine für Menschen lesbare Beschreibung der Quelle der Diagnose.

`--extractor-name=<extractorName>`

Der Name des CodeQL-Extraktors, wenn die Diagnose von einem CodeQL-Extraktor erstellt wurde.

Optionen zum Beschreiben des Speicherorts der Diagnose

`--file-path=<file>`

Der Pfad der Datei, für die die Diagnose gilt, relativ zum Quellstamm.

`--start-line=<startLine>`

Die auf 1 (einschließlich) basierende Zeilennummer, an der der Speicherort der Diagnose beginnt.

`--start-column=<startColumn>`

Die auf 1 (einschließlich) basierende Spaltennummer, an der der Speicherort der Diagnose beginnt.

`--end-line=<endLine>`

Die auf 1 (einschließlich) basierende Zeilennummer, an der der Speicherort der Diagnose endet.

`--end-column=<endColumn>`

Die auf 1 (einschließlich) basierende Spaltennummer, an der der Speicherort der Diagnose endet.

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.