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.

Qui peut utiliser cette fonctionnalité ?

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

Référentiels publics sur GitHub.com, consultez conditions générales de CodeQL GitHub
Référentiels appartenant à l’organisation sur GitHub Enterprise Cloud avec GitHub Advanced Security activé

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 ls <options>... -- <dir>

codeql pack ls <options>... -- <dir>

Description

[Plomberie profonde] Liste les packages CodeQL enracinés dans cet annuaire. Ce répertoire doit contenir un fichier qlpack.yml ou .codeqlmanifest.json.

Disponible depuis v2.7.1.

Le répertoire racine du package ou de l’espace de travail est défini par défaut sur le répertoire de travail actif. Si ce paramètre pointe vers un répertoire contenant un fichier qlpack.yml, cette opération s’exécute uniquement sur ce package CodeQL. Si ce paramètre pointe vers un répertoire contenant un fichier codeql-workspace.yml, cette opération s’exécute sur tous les packages CodeQL de l’espace de travail.

Options pour configurer les packs CodeQL auxquels appliquer cette commande.

`--format=<fmt>`

Sélectionne le format de sortie text (par défaut) ou json.

`--groups=[-]<group>[,[-]<group>...]`

Liste les groupes de packs CodeQL à inclure ou exclure de cette opération. Un qlpack dans l’espace de travail donné est inclus si :

Il se trouve dans au moins un des groupes cités sans signe moins (cette condition est automatiquement remplie en l’absence de groupe sans signe moins).
Il ne se trouve dans aucun groupe listé avec un signe moins

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.