Remarque
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 overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
Description
[Commande interne] Générez un fichier pouvant être utilisé avec l’option --overlay-changes codeql database create lors de l’extraction d’une base de données en superposition.
Cette commande est principalement destinée aux tests manuels ou automatisés. Elle n’est pas particulièrement efficace. Pour une utilisation en production, envisagez de dériver le fichier de modifications à partir d’un élément tel que git diff --name-only.
Options
Options principales
<database>
[Obligatoire] Chemin d’accès vers la base de données de base dans laquelle la superposition sera extraite.
-s, --source-root=<dir>
Répertoire contenant le code source à extraire comme superposition. Si aucun chemin n’est indiqué, le répertoire de travail en cours sera utilisé.
-o, --output=<file>
Le fichier de modifications sera écrit à cet emplacement. Si ce n’est pas spécifié, les modifications seront écrites dans la sortie standard.
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.