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 generate log-summary <options>... -- <input> <result>
codeql generate log-summary <options>... -- <input> <result>
Description
[Avancé] Crée un résumé d’un fichier journal structuré.
Cette commande crée un résumé d’un journal des événements d’évaluateur JSON structuré. La sortie de cette commande vise à être plus stable dans les différentes versions de l’interface CLI que les fichiers journaux eux-mêmes. Par conséquent, lors de l’implémentation d’un script qui utilise la sortie des journaux d’activité, il est fortement recommandé d’exécuter cette commande et d’utiliser sa sortie plutôt que d’utiliser directement les journaux des événements.
Options
Options principales
<input>
[Obligatoire] Chemin du fichier journal des événements duquel produire un résumé.
<result>
Chemin de l’emplacement vers lequel générer le fichier journal résumé. Si cette valeur est omise, le résumé est généré dans stdout.
--minify-output
Le cas échéant, omettez les espaces blancs dans le résumé généré. Le résultat sera moins lisible par les êtres humains, mais occupera moins de mémoire. Cette option n’a d’effet que pour certains formats de sortie.
--utc
[Avancé] Certains horodatages dans les résumés produits par cette commande peuvent utiliser le fuseau horaire local de la machine sur laquelle ils s’exécutent. L’activation de cet indicateur force tous les horodatages à être à l’heure UTC.
--format=<format>
Contrôle le format de la sortie produite.
predicates (par défaut) : Produit un résumé du calcul effectué pour chaque prédicat. Il s’agit d’un flux d’objets JSON séparés par deux caractères de nouvelle ligne (par défaut) ou un si l’option --minify-output est passée.
text : Produit un résumé lisible par les êtres humains de l’exécution de l’évaluation.
overall : Produit un fichier JSON contenant des informations générales sur l’exécution de l’évaluation, notamment des statistiques récapitulatives et des informations sur les évaluations les plus chronophages qui ont été effectuées.
--[no-]deduplicate-stage-summaries
[Avancé] Cette option fonctionne uniquement avec le format texte. Si elle est passée, les tableaux récapitulatifs contenant les prédicats les plus coûteux ne sont pas répétés pour les phases partagées entre les requêtes. Cela a pour effet de déplacer tous les tableaux récapitulatifs à la fin du journal, plutôt que de les voir apparaître chaque fois qu’une requête est terminée.
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.