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 resolve extensions <options>... -- <query|dir|suite|pack>...
codeql resolve extensions <options>... -- <query|dir|suite|pack>...
Description
[Plomberie profonde] Détermine les extensions accessibles. Cela inclut les modèles Machine Learning et les extensions de données.
Cette commande de plomberie résout l’ensemble des extensions de données et des modèles Machine Learning créés par GitHub qui sont disponibles pour les spécificateurs de requête passés en tant qu’arguments de ligne de commande.
Options
Options principales
<querysuite|pack>...
[Obligatoire] Requêtes à exécuter. Chaque argument se présente sous la forme scope/name@range:path
où :
scope/name
est le nom qualifié d’un pack CodeQL.range
est une plage semver.path
est un chemin de système de fichiers.
Si scope/name
est spécifié, range
et path
sont facultatifs. Un range
manquant implique la dernière version du pack spécifié. Un path
manquant implique la suite de requêtes par défaut du pack spécifié.
path
peut être, au choix, un fichier de requête *.ql
, un répertoire contenant une ou plusieurs requêtes ou un fichier de suite de requêtes .qls
. Si aucun nom de pack n’est spécifié, un path
doit être fourni et sera interprété comme relatif au répertoire de travail actuel du processus en cours.
Pour spécifier un path
qui contient un littéral @
ou :
, utilisez path:
comme préfixe de l’argument, comme suit : path:directory/with:and@/chars
.
Si scope/name
et path
sont spécifiés, path
ne peut pas être absolu. Il est considéré comme relatif à la racine du pack CodeQL.
--search-path=<dir>[:<dir>...]
Liste des répertoires sous lesquels les packs QL peuvent être trouvés. Chaque répertoire peut être un pack QL (ou un bundle de packs contenant un fichier .codeqlmanifest.json
à la racine) ou le parent immédiat d’un ou plusieurs de ces répertoires.
Si le chemin contient plusieurs répertoires, leur ordre définit la priorité entre eux : quand un nom de pack qui doit être résolu est mis en correspondance dans plusieurs arborescences de répertoires, celle donnée en premier gagne.
Le pointage de ce chemin vers une extraction du dépôt CodeQL open source devrait fonctionner lors de l’interrogation d’un des langages qui y résident.
Si vous avez extrait le dépôt CodeQL en tant que frère de la chaîne d’outils CodeQL décompressée, vous n’avez pas besoin de donner cette option ; ces répertoires frères sont toujours recherchés pour les packs QL qui ne peuvent pas être trouvés autrement. (Si cette valeur par défaut ne fonctionne pas, il est fortement recommandé de configurer --search-path
une fois pour toutes dans un fichier de configuration par utilisateur).
(Remarque : Sur Windows, le séparateur de chemin est ;
.)
--additional-packs=<dir>[:<dir>...]
Si cette liste de répertoires est donnée, des packs y sont recherchés avant ceux indiqués dans --search-path
. L’ordre entre eux n’a pas d’importance ; il s’agit d’une erreur si un nom de pack est trouvé dans deux répertoires différents de cette liste.
Cette option est utile si vous développez temporairement une nouvelle version d’un pack qui apparaît aussi dans le chemin par défaut. En revanche, il n’est pas recommandé de remplacer cette option dans un fichier de configuration ; certaines actions internes ajoutent cette option à la volée, remplaçant toute valeur configurée.
(Remarque : Sur Windows, le séparateur de chemin est ;
.)
--model-packs=<
name@range>...
Une liste de noms de packs CodeQL, chacun avec une plage de versions optionnelle, à utiliser comme packs de modèles pour personnaliser les requêtes qui sont sur le point d'être évaluées.
--threat-model=<name>...
Liste des modèles de risque à activer ou désactiver.
L’argument est le nom d’un modèle de risque, éventuellement précédé d’un « ! ». Si aucun « ! » n’est présent, le modèle de risque nommé et tous ses descendants sont activés. Si un « ! » est présent, le modèle de risque nommé et tous ses descendants sont désactivés.
Le modèle de risque « par défaut » est activé par défaut, mais peut être désactivé en spécifiant « --threat-model !default ».
Le modèle de risque « all » peut être utilisé pour activer ou désactiver tous les modèles de risque.
Les options -- modeles de risque sont traitées dans l’ordre. Par exemple, « --threat-model local --threat-model !environment » active tous les modèles de risque dans le groupe « local », à l’exception du modèle de risque « environnement ».
Cette option a uniquement un effet pour les langages qui prennent en charge les modèles de risque.
Disponible depuis v2.15.3
.
Options pour configurer le gestionnaire de package CodeQL
--registries-auth-stdin
Permet de vous authentifier auprès des registres de conteneurs GitHub Enterprise Server en passant une liste de paires <registry_url>=<token> séparées par des virgules.
Par exemple, vous pouvez passer https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
pour vous authentifier auprès de deux instances GitHub Enterprise Server.
Cela remplace les variables d’environnement CODEQL_REGISTRIES_AUTH et GITHUB_TOKEN. Si vous avez seulement besoin de vous authentifier auprès du registre de conteneurs github.com, vous pouvez vous authentifier en utilisant l’option plus simple --github-auth-stdin
.
--github-auth-stdin
Permet de vous authentifier auprès du registre de conteneurs github.com en passant un jeton github.com GitHub Apps ou un jeton d’accès personnel via une entrée standard.
Pour vous authentifier auprès des registres de conteneurs GitHub Enterprise Server, passez --registries-auth-stdin
ou utilisez la variable d’environnement CODEQL_REGISTRIES_AUTH.
Cela remplace la variable d’environnement GITHUB_TOKEN.
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
.