À propos des extensions GitHub CLI
Note
Les extensions en dehors de GitHub Enterprise Server et GitHub CLI ne sont pas certifiées par GitHub Enterprise Server et sont régies par des conditions d’utilisation, une politique de confidentialité et une documentation de support distinctes. Pour atténuer les risques lors de l’utilisation d’extensions tierces, auditez le code source de l’extension avant d’installer ou de mettre à jour l’extension.
Les extensions GitHub CLI sont des commandes GitHub CLI personnalisées que tout le monde peut créer et utiliser. Pour plus d’informations sur la création d’extensions GitHub CLI, consultez Création d’extensions CLI GitHub.
Les extensions sont installées localement et sont étendues à l’utilisateur. Par conséquent, si vous accédez à GitHub CLI à partir d’un autre ordinateur ou qu’un autre utilisateur accède à GitHub CLI à partir du même ordinateur, l’extension n’est pas disponible.
Recherche d’extensions
Vous pouvez trouver des extensions en parcourant les référentiels avec la rubrique gh-extension.
Installation des extensions
Pour installer une extension, utilisez la sous-commande extensions install. Remplacez le paramètre repo par le référentiel de l’extension. Vous pouvez utiliser l’URL complète, comme https://github.com/octocat/gh-whoami, ou simplement le propriétaire et le référentiel, comme octocat/gh-whoami.
Si le propriétaire et le référentiel sont utilisés, gh installe l’extension à l’aide du nom d’hôte auquel gh est actuellement authentifié. Le format d’URL complet est utile lors de l’installation d’extensions à partir d’un autre hôte. Par exemple, les utilisateurs sur GitHub Enterprise Server doivent utiliser l’URL de référentiel complète pour installer des extensions à partir de GitHub.com ou d’un autre hôte.
Pour installer une extension dans le développement à partir du répertoire actif, utilisez . comme valeur pour le paramètre repo.
gh extension install REPO
Si vous disposez déjà d’une extension portant le même nom, la commande échoue. Par exemple, si vous avez installé octocat/gh-whoami, vous devez le désinstaller avant d’installer hubot/gh-whoami.
Exécution d’une extension
Une fois que vous avez installé une extension, vous l’exécutez comme vous le feriez pour une commande GitHub CLI native, à l’aide de gh EXTENSION-NAME. EXTENSION-NAME est le nom du dépôt qui contient l’extension, si l’on enlève le préfixe gh-.
Par exemple, si vous avez installé l’extension à partir du dépôt octocat/gh-whoami, vous pouvez l’exécuter avec la commande suivante :
gh whoami
En règle générale, vous trouverez des informations spécifiques sur l’utilisation d’une extension dans le fichier LISEZMOI du dépôt qui la contient.
Affichage des extensions installées
Pour afficher toutes les extensions installées, utilisez la sous-commande extensions list. La sortie vous indique également quelles extensions ont des mises à jour disponibles.
gh extension list
Mise à jour des extensions
Pour mettre à jour une extension, utilisez la sous-commande extensions upgrade. Remplacez le paramètre extension par le nom de l’extension.
gh extension upgrade EXTENSION
Pour mettre à jour toutes les extensions installées, utilisez l’indicateur --all.
gh extension upgrade --all
Désinstallation des extensions
Pour désinstaller une extension, utilisez la sous-commande extensions remove. Remplacez le paramètre extension par le nom de l’extension.
gh extension remove EXTENSION