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

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

décodage BQRS

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.

hachage bqrs

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

bqrs informations

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

bqrs interprètent

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

diagnostic d'extension de base de données

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

analyse de base de données

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

bundle de bases de données

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

nettoyage de base de données

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

création de base de données

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.

diagnostics d'exportation de base de données

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

finalisation de la base de données

[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.

fichiers index de base de données

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

init de base de données

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

base de données interpréter les résultats

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

base de référence d’impression de base de données

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

requêtes d’exécution de base de données

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

base de données trace-command

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

dissocier la base de données

Extrait une archive de base de données CodeQL.

mise à niveau de base de données

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

vérification du jeu de données

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

nettoyage du jeu de données

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

importation de jeu de données

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

mesure du jeu de données

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

mise à niveau du jeu de données

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

diagnostic ajouté

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

exportation de diagnostic

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

exécuter cli-server

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

exécuter le serveur de langage

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

exécuter des requêtes

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

exécuter un serveur de requêtes

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

exécuter query-server2

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

exécuter des mises à niveau

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

générer métadonnées de prédicats extensibles

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

générer un résumé de log

[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

générer l’aide sur les requêtes

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

GitHub résultats de fusion

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

github télécharger-résultats

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

ajouter un paquet

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.

ensemble de packs

[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.

création de pack

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

téléchargement du pack

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).

initialiser le pack

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

installation de paquet

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 liste de paquets

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

publication de pack

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.

mise à niveau du pack

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

compilation de requêtes

Compile ou vérifie le code QL.

Décompilation de requête

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

format de requête

Met automatiquement en forme le code source QL.

exécution de requête

Exécute une seule requête.

résoudre la base de données

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

résoudre les 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.

résoudre l’extracteur

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

résoudre les fichiers

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

résoudre les langues

Liste les packs d’extracteur CodeQL installés.

résoudre le chemin d’accès à la bibliothèque

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

résoudre les métadonnées

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

résoudre les modèles d'apprentissage automatique

[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.

résoudre les qlpacks

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

résoudre qlref

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

résoudre les requêtes

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

résoudre les problèmes de RAM

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

résoudre les tests

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

résoudre les mises à niveau

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

test d'acceptation

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

extrait de test

[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.