diagnostic add
[Experimental] [Plumbing] Add a piece of diagnostic information.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the--help option in your terminal.
Synopsis
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>...Description
[Experimental] [Plumbing] Add a piece of diagnostic information.
Available sincev2.12.6.
Options
Primary Options
--markdown-message=<markdownMessage>
Message for the diagnostic, in GitHub-flavored Markdown format.
--plaintext-message=<plaintextMessage>
Message for the diagnostic, in plain text. This option should only beused when populating a Markdown message with --markdown-message is notpractical.
--severity=<severity>
Severity of the diagnostic. Can be "error", "warning", or "note".
--help-link=<helpLinks>
Help links relevant to the diagnostic.
--attributes-json=<attributesJson>
Structured metadata relevant to the diagnostic.
Options specifying where to save the diagnostic information
Exactly one of these options must be given.
--diagnostic-dir=<diagnosticDir>
Directory to which we should add the diagnostic.
Options that indicate where the diagnostic message can be displayed
--ready-for-status-page
Indicate that the diagnostic is suitable for display on the status page.
--ready-for-cli-summary-table
Indicate that the diagnostic is suitable for display in the diagnosticssummary table printed by commands likedatabase analyze.
Options describing the source of the diagnostic
--source-id=<id>
[Mandatory] An identifier for the source of this diagnostic.
--source-name=<name>
[Mandatory] A human-readable description of the source of thisdiagnostic.
--extractor-name=<extractorName>
The name of the CodeQL extractor, if this diagnostic was produced by aCodeQL extractor.
Options describing the diagnostic's location
--file-path=<file>
The path of the file to which the diagnostic applies, relative to thesource root.
--start-line=<startLine>
The 1-based line number (inclusive) where the diagnostic's locationstarts.
--start-column=<startColumn>
The 1-based column number (inclusive) where the diagnostic's locationstarts.
--end-line=<endLine>
The 1-based line number (inclusive) where the diagnostic's locationends.
--end-column=<endColumn>
The 1-based column number (inclusive) where the diagnostic's locationends.
Common options
-h, --help
Show this help text.
-J=<opt>
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.
-q, --quiet
Incrementally decrease the number of progress messages printed.
--verbosity=<level>
[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.