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 pack add <options>... -- <scope/name[@range]>...
codeql pack add <options>... -- <scope/name[@range]>...
Description
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.
Cette commande modifie le fichier qlpack.yml du package actuel. La mise en forme et les commentaires sont supprimés.
Disponible depuis v2.6.0
.
Options
Options principales
<scope/name[@range]>...
[Obligatoire] Ătendue, nom et plage de versions facultatives du pack Ă ajouter Ă la liste des dĂ©pendances.
Si aucune plage de versions nâest spĂ©cifiĂ©e ou si la plage de versions est spĂ©cifiĂ©e comme « la plus rĂ©cente », la derniĂšre version du pack est tĂ©lĂ©chargĂ©e et une dĂ©pendance est ajoutĂ©e Ă qlpack.yml qui autorise toute version compatible avec la version tĂ©lĂ©chargĂ©e.
Si une seule version est spécifiée, cette version du pack est téléchargée et une dépendance est ajoutée à qlpack.yml pour autoriser toute version compatible avec la version spécifiée.
Si une plage de versions est spécifiée, la derniÚre version du pack qui répond à la plage spécifiée est téléchargée et une dépendance est ajoutée à qlpack.yml avec la plage de versions spécifiée.
--dir=<dir>
Répertoire racine du package.
--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.
--[no-]allow-prerelease
Autorise lâutilisation des packs avec des qualificateurs de prĂ©version (par exemple, X.Y.Z-qualifier
) à utiliser. Sans cet indicateur, les packs de préversion sont ignorés.
Disponible depuis v2.11.3
.
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
.