Ce contenu décrit la version la plus récente de CodeQL CLI. Pour plus d’informations sur cette version, consultez https://github.com/github/codeql-cli-binaries/releases.
Pour voir les détails des options disponibles pour cette commande dans une version antérieure, exécutez la commande avec l’option --help dans votre 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
[Expérimental] [Plomberie] Ajoute un élément d’informations de diagnostic.
Disponible depuis v2.12.6.
Options
Options principales
--markdown-message=<markdownMessage>
Message pour le diagnostic, au format Markdown avec saveur GitHub.
--plaintext-message=<plaintextMessage>
Message pour le diagnostic, en texte brut. Cette option ne doit être utilisée que si le remplissage d’un message Markdown avec --markdown-message n’est pas pratique.
--severity=<severity>
Gravité du diagnostic. Peut être « error », « warning » ou « note ».
--help-link=<helpLinks>
Liens d’aide pertinents pour le diagnostic.
--attributes-json=<attributesJson>
Métadonnées structurées pertinentes pour le diagnostic.
Options spécifiant où enregistrer les informations de diagnostic
Exactement l’une de ces options doit être donnée.
--diagnostic-dir=<diagnosticDir>
Répertoire auquel nous devons ajouter le diagnostic.
Options indiquant où le message de diagnostic peut être affiché
--ready-for-status-page
Indique que le diagnostic peut être affiché sur la page d’état.
--ready-for-cli-summary-table
Indique que le diagnostic peut être affiché dans le tableau récapitulatif des diagnostics généré par des commandes telles que database analyze.
Options décrivant la source du diagnostic
--source-id=<id>
[Obligatoire] Identificateur de la source de ce diagnostic.
--source-name=<name>
[Obligatoire] Description explicite de la source de ce diagnostic.
--extractor-name=<extractorName>
Nom de l’extracteur CodeQL, si ce diagnostic a été produit par un extracteur CodeQL.
Options décrivant l’emplacement du diagnostic
--file-path=<file>
Chemin du fichier auquel le diagnostic s’applique, par rapport à la racine source.
--start-line=<startLine>
Numéro de ligne de base 1 (inclus) où commence l’emplacement du diagnostic.
--start-column=<startColumn>
Numéro de colonne de base 1 (inclus) où commence l’emplacement du diagnostic.
--end-line=<endLine>
Numéro de ligne de base 1 (inclus) où se termine l’emplacement du diagnostic.
--end-column=<endColumn>
Numéro de colonne de base 1 (inclus) où se termine l’emplacement du diagnostic.
Options courantes
-h, --help
Affiche ce texte d’aide.
-J=<opt>
[Avancé] Donne une option à l’environnement JVM exécutant la commande.
(Attention, les options contenant des espaces ne sont pas gérées correctement.)
-v, --verbose
Augmente de façon incrémentielle le nombre de messages de progression affichés.
-q, --quiet
Diminue de façon incrémentielle le nombre de messages de progression affichés.
--verbosity=<level>
[Avancé] Définit explicitement le niveau de détail sur errors, warnings, progress, progress+, progress++ ou progress+++. Remplace -v et -q.
--logdir=<dir>
[Avancé] Écrit des journaux détaillés dans un ou plusieurs fichiers du répertoire donné, avec des noms générés qui incluent des horodatages et le nom de la sous-commande en cours d’exécution.
(Pour écrire un fichier journal avec un nom sur lequel vous avez un contrôle total, donnez plutôt --log-to-stderr et redirigez stderr comme vous le souhaitez.)
--common-caches=<dir>
[Avancé] Contrôle l’emplacement des données en cache sur le disque qui persisteront entre plusieurs exécutions de l’interface CLI, telles que les packs QL téléchargés et les plans de requête compilés. S’il n’est pas défini explicitement, il s’agit par défaut d’un répertoire nommé .codeql dans le répertoire de base de l’utilisateur. S’il n’existe pas déjà, il est créé.
Disponible depuis v2.15.2.