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 resolve extensions-by-pack <options>... -- <pack>...
codeql resolve extensions-by-pack <options>... -- <pack>...
Description
[Commandes de bas niveau (Deep plumbing)] Détermine les extensions de données accessibles pour les chemins donnés vers les racines de pack.
Cette commande de bas niveau rĂ©sout lâensemble des extensions de donnĂ©es disponibles pour les chemins transmis en arguments de ligne de commande.
Disponible depuis v2.13.3
.
Options
Options principales
<pack>...
Chemin dâaccĂšs Ă la racine des packs pour rĂ©soudre les extensions.
--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
.