Guide de démarrage rapide sur l’interface CLI de 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

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

Affichage de l’état

Entrez gh status pour voir les détails de votre travail actuel sur GitHub dans tous les référentiels auxquels vous êtes abonné.

Affichage d'un référentiel

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

Si vous exécutez la sous-commande repo à partir de l’annuaire d'un référentiel Git local qui a un dépôt distant sur GitHub, vous pouvez omettre OWNER/REPO.

Clonage d’un dépôt

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

Création d'un dépôt

Entrez gh repo create et suivez les instructions qui s'affichent à l'écran. Vous pouvez créer un nouveau référentiel vide sur GitHub puis, facultativement, le cloner localement. Alternativement, vous pouvez envoyer (push) un référentiel local existant vers GitHub, et facultativement le définir comme le dépôt distant pour votre référentiel local. Pour en savoir plus sur la configuration d'un annuaire local comme référentiel Git, consultez «Ajout de code hébergé localement dans GitHub ».

Traitement des problèmes

Entrez gh issue list --repo OWNER/REPO pour lister les derniers problèmes créés qui sont actuellement ouverts pour le référentiel défini. Si vous exécutez la sous-commande issue à partir de l’annuaire d'un référentiel Git local qui a un dépôt distant sur GitHub, vous pouvez omettre --repo OWNER/REPO. Par exemple, entrez gh issue list --assignee "@me" pour lister les problèmes qui vous ont été attribués dans ce référentiel, ou gh issue list --author monalisa pour lister les problèmes créés par l'utilisateur « monalisa ».

Vous pouvez également créer un nouveau 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 (pull requests)

Entrez gh pr list --repo OWNER/REPO pour lister les dernières demandes de tirage (pull requests) créées qui sont actuellement ouvertes pour le référentiel défini. Si vous exécutez la sous-commande pr à partir de l’annuaire d'un référentiel Git local qui a un dépôt distant sur GitHub, vous pouvez omettre --repo OWNER/REPO. Par exemple, entrez gh pr list --author "@me" pour lister les demandes de tirage (pull requests) ouvertes que vous avez créées dans ce référentiel.

Entrez gh pr list --label LABEL-NAME pour lister les demandes de tirage (pull requests) ouvertes avec une éiquette spécifique. Entrez gh search prs --review-requested=@me --state=open pour lister les demandes de tirage (pull requests) que vous avez été invité à réviser.

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

Traitement des codespaces

Pour créer un nouvel codespace, entrez gh codespace create et suivez les instructions qui s'affichent à l'écran.

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

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

Obtenir de l’aide

Entrez gh pour un rappel des commandes de premier niveau GitHub CLI 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.

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

Par exemple, vous pouvez spécifier l'éditeur de texte utilisé lorsqu'une commande GitHub CLI vous oblige à modifier le texte, par exemple lorsque vous ajoutez le corps de texte à un nouveau problème que vous créez. Pour définir votre éditeur de texte préféré sur Visual Studio Code, entrez gh config set editor "code -w". L'indicateur -w (ou --wait) dans cet exemple fait en sorte que la commande attende 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 avec les extensions GitHub CLI. Pour plus d’informations, consultez « Utilisation des extensions CLI GitHub » et « Création d’extensions CLI GitHub ».

Utilisation de GitHub CLI avec plusieurs comptes

Si vous avez plusieurs comptes sur la même plateforme GitHub, comme GitHub.com, vous pouvez vous authentifier sur chacun d'entre eux et passer de l'un à l'autre à l'aide de la commande gh auth switch. Voir le commutateur gh auth dans le manuel GitHub CLI.

Si vous devez utiliser le GitHub CLI sur plusieurs GitHub plateformes, comme un compte personnel sur GitHub.com et un compte d’utilisateur managé sur GHE.com, voir « Utilisation de l’interface CLI GitHub sur les plateformes GitHub ».