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.

Qui peut utiliser cette fonctionnalité ?

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

Dans cet article

Note

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

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