Démarrage rapide de l’interface CLI GitHub

À propos de GitHub CLI

GitHub CLI est un outil open source permettant d’utiliser GitHub à partir de la ligne de commande de votre ordinateur. Lorsque vous travaillez à partir de la ligne de commande, vous pouvez utiliser l’GitHub CLI pour gagner du temps et éviter de changer de contexte.

Prérequis

Installez GitHub CLI sur macOS, Windows ou Linux. Pour en savoir plus, consultez Installation dans le référentiel GitHub CLI.
Pour vous authentifier sur GitHub, exécutez la commande suivante depuis votre terminal.
```
gh auth login
```
Sélectionnez l'endroit où vous souhaitez vous authentifier :
- Si vous accédez à GitHub à GitHub.com, sélectionnez GitHub.com.
- Si vous accédez à GitHub sur un autre domaine, sélectionnez Autre , puis entrez votre nom d'hôte (par exemple : octocorp.ghe.com).
Suivez les autres invites à l'écran.

GitHub CLI enregistre automatiquement vos identifiants Git lorsque vous choisissez HTTPS comme protocole préféré pour les opérations Git et que vous répondez « oui » à l'invite vous demandant si vous souhaitez vous authentifier sur Git avec vos identifiants GitHub. Ce procédé peut être utile car il vous permet d'utiliser les commandes Git telles que git push et git pull, sans avoir à configurer un gestionnaire d'informations d'identification distinct ou à utiliser SSH.

Quelques commandes utiles

Remarque

Lorsque vous utilisez certaines commandes pour la première fois, par exemple gh codespace SUBCOMMAND, vous serez invité à ajouter des étendues supplémentaires à votre jeton d’authentification. Suivez les instructions qui s’affichent à l’écran.

Affichage de l’état

Saisissez gh status pour voir les détails de votre travail actuel dans GitHub, dans tous les dépôts auxquels vous êtes abonné.

Affichage d’un référentiel

Saisissez gh repo view OWNER/REPO pour voir la description du référentiel et README.md pour le référentiel. Saisissez gh repo view OWNER/REPO --web pour afficher le référentiel dans votre navigateur par défaut.

Si vous exécutez la sous-commande repo dans le répertoire d’un dépôt Git local qui a un dépôt distant sur GitHub, vous pouvez omettre OWNER/REPO.

Clonage d’un dépôt

Entrez gh repo clone OWNER/REPO. Par exemple, gh repo clone octo-org/octo-repo clone le référentiel octo-org/octo-repo dans le répertoire à partir duquel vous avez exécuté cette commande sur votre ordinateur local.

Création d'un dépôt

Saisissez gh repo create, puis suivez les instructions à l’écran. Vous pouvez créer un nouveau dépôt vide sur GitHub, puis, si vous le souhaitez, le cloner localement. Vous pouvez également envoyer (push) un dépôt local existant vers GitHub, et éventuellement le définir comme distant pour votre référentiel local. Pour plus d’informations sur la définition d’un répertoire local en tant que référentiel Git, consultez Ajout de code hébergé localement dans GitHub.

Traitement des problèmes

Saisissez gh issue list --repo OWNER/REPO pour afficher la liste des problèmes créés récemment qui sont actuellement ouverts pour le référentiel spécifié. Si vous exécutez la sous-commande issue depuis le répertoire d’un dépôt Git local qui a un dépôt distant sur GitHub, vous pouvez omettre --repo OWNER/REPO. Par exemple, saisissez gh issue list --assignee "@me" pour afficher la liste des problèmes qui vous ont été attribués dans ce référentiel, ou gh issue list --author monalisa pour afficher la liste des problèmes créés par l’utilisateur « monalisa ».

Vous pouvez également créer un problème, voir Création d’un problème ou rechercher un problème, voir Filtrage et recherche de problèmes et de demandes de tirage.

Traitement des demandes de tirage

Saisissez gh pr list --repo OWNER/REPO pour afficher la liste des demandes de tirage créées récemment qui sont actuellement ouvertes pour le référentiel spécifié. Si vous exécutez pr la sous-commande depuis le répertoire d’un référentiel Git local qui a un dépôt distant sur GitHub, vous pouvez omettre --repo OWNER/REPO. Par exemple, saisissez gh pr list --author "@me" pour afficher la liste des demandes de tirage ouvertes que vous avez créées dans ce référentiel.

Saisissez gh pr list --label LABEL-NAME pour afficher la liste des demandes de tirage ouvertes avec une étiquette spécifique. Saisissez gh search prs --review-requested=@me --state=open pour afficher la liste des demandes de tirage que vous avez été invité à réviser.

Pour créer une demande de tirage, saisissez gh pr create et suivez les instructions qui s’affichent à l’écran. Pour plus d’informations, consultez « Création d’une pull request ».

Traitement des codespaces

Pour créer un nouveau codespace, saisissez gh codespace create et suivez les instructions qui s’affichent à l’écran.

Pour afficher vos codespaces existants, saisissez gh codespace list. Pour ouvrir un codespace dans la version web de VS Code, saisissez gh codespace code -w et choisissez un codespace.

Dans toutes ces commandes, vous pouvez remplacer cs par codespace.

Obtenir de l’aide

Saisissez gh pour afficher un rappel des commandes GitHub CLI de niveau supérieur que vous pouvez utiliser. Par exemple, issue, pr, repo, etc.

Pour chaque commande et chaque sous-commande auxiliaire, vous pouvez ajouter l’indicateur --help pour savoir comment elle est utilisée. Par exemple, gh issue --help ou gh issue create --help.

Personnalisation GitHub CLI

Vous pouvez modifier les paramètres de configuration et ajouter des alias ou des extensions pour que GitHub CLI fonctionne de la manière qui vous convient le mieux.

Saisissez gh config set SUBCOMMANDS pour configurer les paramètres de GitHub CLI, en remplaçant SUBCOMMANDS par le paramètre que vous souhaitez modifier.

Par exemple, vous pouvez spécifier l’éditeur de texte utilisé lorsqu’une GitHub CLI commande vous oblige à modifier du texte, par exemple lorsque vous ajoutez le texte du corps pour un nouveau problème que vous créez. Pour définir votre éditeur de texte préféré à Visual Studio Code entrer gh config set editor "code -w". L’option -w (ou --wait) dans cet exemple amène la commande à attendre que le fichier soit fermé dans Visual Studio Code avant de passer à l’étape suivante dans votre terminal.

Pour plus d’informations, consultez gh config set.
Définissez des alias pour les commandes que vous exécutez couramment. Par exemple, si vous exécutez gh alias set prd "pr create --draft", vous serez ainsi en mesure d’exécuter gh prd pour ouvrir rapidement un brouillon de demande de tirage. Pour plus d’informations, consultez gh alias.
Créez ou ajoutez des commandes personnalisées grâce à des extensions GitHub CLI. Pour plus d’informations, consultez Utilisation des extensions CLI GitHub et Création d’extensions CLI GitHub.

Utilisation GitHub CLI avec plusieurs comptes

Si vous avez plusieurs comptes sur la même GitHub plateforme, par GitHub.comexemple, vous pouvez vous authentifier auprès de chacun d’eux et basculer entre eux à l’aide de la gh auth switch commande. Consultez gh auth switch dans la GitHub CLI documentation.

Si vous avez besoin d’utiliser GitHub CLI sur plusieurs plateformes GitHub, telles qu’un compte personnel sur GitHub.com et un compte d’utilisateur managé sur GHE.com, consultez Utilisation de l’interface CLI GitHub sur plusieurs plateformes GitHub.