Skip to main content

Manuel des commandes de l’interface CLI CodeQL

Informations de référence sur les commandes disponibles dans la version la plus récente de l’CodeQL CLI.

Qui peut utiliser cette fonctionnalité ?

GitHub CodeQL est concédé sous licence par utilisateur lors de l’installation. Vous pouvez utiliser CodeQL uniquement pour certaines tâches soumises aux restrictions de licence. Pour plus d’informations, consultez « À propos de CodeQL CLI ».

Si vous disposez d’une licence GitHub Advanced Security, vous pouvez utiliser CodeQL pour l’analyse automatisée, l’intégration continue et la livraison continue. Pour plus d’informations, consultez « À propos de GitHub Advanced Security ».

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.

bqrs decode

Convertit les données de résultat de BQRS en d’autres formes.

bqrs diff

Calcule la différence entre deux jeux de résultats.

bqrs hash

[Plomberie] Calcule un hachage stable d’un fichier BQRS.

bqrs info

Affiche les métadonnées d’un fichier BQRS.

bqrs interpret

[Plomberie] Interprète des données dans un seul BQRS.

database add-diagnostic

[Expérimental] Ajoute des informations de diagnostic à une base de données.

database analyze

Analyse une base de données en produisant des résultats significatifs dans le contexte du code source.

database bundle

Crée une archive relocalisable d’une base de données CodeQL.

database cleanup

Compacte une base de données CodeQL sur le disque.

database create

Crée une base de données CodeQL pour une arborescence source qui peut être analysée à l’aide de l’un des produits CodeQL.

database export-diagnostics

[Expérimental] Exporte les informations de diagnostic d’une base de données pour une analyse ayant échoué.

database finalize

[Plomberie] Étapes finales de la création de bases de données.

importation de base de données

[Avancé] [Plomberie] Importe la ou les bases de données non finalisées dans une autre base de données non finalisée.

database index-files

[Plomberie] Indexe des fichiers autonomes avec un extracteur CodeQL donné.

database init

[Plomberie] Crée une base de données CodeQL vide.

database interpret-results

[Plomberie] Interprète les résultats des requêtes calculées dans des formats pertinents tels que SARIF ou CSV.

database print-baseline

[Plomberie] Affiche un résumé des lignes de base de code vues.

database run-queries

[Plomberie] Exécute un jeu de requêtes ensemble.

database trace-command

[Plomberie] Exécute une seule commande dans le cadre d’une build tracée.

database unbundle

Extrait une archive de base de données CodeQL.

database upgrade

Met à niveau une base de données pour qu’elle soit utilisable par les outils actuels.

dataset check

[Plomberie] Vérifie la cohérence interne d’un jeu de données particulier.

dataset cleanup

[Plomberie] Nettoie les fichiers temporaires d’un jeu de données.

dataset import

[Plomberie] Importe un ensemble de fichiers TRAP dans un jeu de données brut.

dataset measure

[Plomberie] Collecte des statistiques sur les relations dans un jeu de données particulier.

dataset upgrade

[Plombage] Met à niveau un jeu de données pour que les outils actuels puissent l’utiliser.

diagnostic add

[Expérimental] [Plomberie] Ajoute un élément d’informations de diagnostic.

diagnostic export

[Expérimental] Exporte les informations de diagnostic pour une analyse ayant échoué.

execute cli-server

[Plomberie profonde] Serveur permettant d’exécuter plusieurs commandes tout en évitant l’initialisation JVM répétée.

execute language-server

[Plomberie] Prend en charge en ligne le langage QL dans les IDE.

execute queries

[Plomberie] Exécute une ou plusieurs requêtes sur un jeu de données.

execute query-server

[Plomberie] Prend en charge l’exécution de requêtes dans des IDE.

execute query-server2

[Plomberie] Prend en charge l’exécution de requêtes dans des IDE.

execute upgrades

[Plomberie] Exécute des scripts de mise à niveau sur un jeu de données QL brut existant.

generate extensible-predicate-metadata

[Expérimental] [Plomberie profonde] Signaler les prédicats extensibles trouvés dans le pack donné.

generate log-summary

[Avancé] Crée un résumé d’un fichier journal structuré.

generate query-help

Génère l’aide des requêtes des utilisateurs finaux à partir de fichiers .qhelp.

github merge-results

[Plomberie profonde] Fusionne plusieurs fichiers SARIF en un seul.

github upload-results

Charge un fichier SARIF dans l’analyse du code GitHub.

pack add

[Expérimental] Ajoute une liste de packs de bibliothèques QL avec des plages de versions facultatives en tant que dépendances du package actuel, puis les installe.

pack bundle

[Expérimental] [Plomberie] Regroupe un pack de bibliothèque QL dans un bundle.

pack ci

[Expérimental] Installe les dépendances pour ce pack tout en vérifiant que le fichier lock existant est à jour.

pack create

[Expérimental] [Plomberie] Génère le contenu d’un package QL à partir du code source.

pack download

[Expérimental] Télécharge l’ensemble des qlpacks référencés par la spécification de requête de la ligne de commande à partir du Registre. Les packs peuvent être fournis par nom ou implicitement dans un fichier de suite de requêtes (.qls).

pack init

[Expérimental] Initialise un qlpack dans le répertoire spécifié.

pack install

[Expérimental] Installe les dépendances pour ce pack.

pack ls

[Expérimental] [Plomberie profonde] Liste les packages CodeQL enracinés dans ce répertoire. Ce répertoire doit contenir un fichier qlpack.yml ou .codeqlmanifest.json.

pack packlist

[Expérimental] [Plomberie] Calcule l’ensemble de fichiers à inclure dans un pack de bibliothèques ou un pack de requêtes QL.

pack publish

[Expérimental] Publie un pack de bibliothèques QL dans un registre de packages.

pack resolve-dependencies

[Expérimental] [Plomberie] Calcule l’ensemble des dépendances requises pour ce pack QL.

pack upgrade

[Expérimental] Met à jour les dépendances de ce pack vers les dernières versions disponibles.

query compile

Compile ou vérifie le code QL.

query decompile

[Plomberie] Lit une représentation intermédiaire d’une requête compilée à partir d’un fichier .qlo.

query format

Met automatiquement en forme le code source QL.

query run

Exécute une seule requête.

resolve database

[Plomberie profonde] Signale les métadonnées relatives à la base de données.

resolve extensions

[Expérimental] [Plomberie profonde] Détermine les extensions accessibles. Cela inclut les modèles Machine Learning et les extensions de données.

résoudre les extensions par pack

[Expérimental] [Plomberie profonde] Déterminez les extensions accessibles pour les chemins d’accès donnés aux racines de pack. Cela inclut les modèles Machine Learning et les extensions de données.

resolve extractor

[Plomberie profonde] Détermine le pack d’extracteur à utiliser pour un langage donné.

resolve files

[Plomberie profonde] Développe un ensemble de globs d’inclusion/exclusion de fichiers.

resolve languages

Liste les packs d’extracteur CodeQL installés.

resolve library-path

[Plomberie profonde] Détermine le chemin de la bibliothèque QL et le schéma de base de données pour une requête.

resolve metadata

[Plomberie profonde] Résout et retourne les paires de métadonnées clé-valeur d’un fichier source de requête.

resolve ml-models

[Déprécié] [Expérimental] [Plomberie profonde] Détermine les modèles Machine Learning accessibles.

resolve qlpacks

Crée la liste des packs QL installés et de leurs emplacements.

resolve qlref

[Plomberie profonde] Déréférence un fichier .qlref pour retourner un fichier .ql.

resolve queries

[Plomberie profonde] Développe les répertoires de requêtes et les spécifications de suite.

resolve ram

[Plomberie profonde] Prépare les options de mémoire RAM.

resolve tests

[Plomberie profonde] Recherche les tests unitaires QL dans des répertoires donnés.

resolve upgrades

[Plomberie profonde] Détermine les mises à niveau à exécuter pour un jeu de données brut.

test accept

Accepte les résultats des tests unitaires défaillants.

test extract

[Plomberie] Génère un jeu de données pour un répertoire de test.

test run

Exécute des tests unitaires pour les requêtes QL.

version

Affiche la version de la chaîne d’outils CodeQL.