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é ?

CodeQL est disponible pour les types de rĂ©fĂ©rentiels suivants :

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.

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Ă©.

générer des modifications de superposition

[Commande interne] GĂ©nĂ©rez un fichier pouvant ĂȘtre utilisĂ© avec

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

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

[Plomberie] Regroupe un pack de bibliothĂšque QL.

pack ci

Installez les dépendances pour ce pack, tout en vérifiant que le fichier verrouillé existant est à jour.

pack create

[Plomberie] GĂ©nĂšre le contenu d’un package QL Ă  partir du code source.

pack download

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

Initialise un qlpack dans le répertoire spécifié.

pack install

Installe les dépendances pour ce pack.

pack ls

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

pack packlist

[Plomberie] Calcule l’ensemble de fichiers Ă  inclure dans un pack de bibliothĂšques ou un pack de requĂȘtes QL.

pack publish

Publie un pack de bibliothĂšques QL dans un registre de packages.

pack resolve-dependencies

[Plomberie] Calcule l’ensemble des dĂ©pendances requises pour ce pack QL.

pack upgrade

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.

résoudre les packs

Affichez la liste des packs CodeQL disponibles et de leurs emplacements.

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.