GitHub CLI (gh)

Qu’est-ce que GitHub CLI (gh) ?

GitHub CLI, connu sous le nom de gh, est l’outil en ligne de commande officiel de GitHub. Il apporte la puissance de GitHub à votre terminal, vous permettant de gérer les dépôts, de travailler avec les tickets (issues), de traiter les pull requests et d’interagir avec GitHub Actions sans jamais quitter votre environnement de ligne de commande. Il est conçu pour rationaliser votre flux de travail, réduire le changement de contexte et rendre le scripting et l’automatisation transparents.

Fonctionnalités Clés

• Gestion Complète des Dépôts : Créez, clonez, forkez et visualisez les dépôts directement depuis le CLI.
• Tickets et Pull Requests : Listez, visualisez, créez et gérez les tickets et les pull requests. Vous pouvez même récupérer les branches des PR, réviser le code et les fusionner.
• Intégration avec GitHub Actions : Visualisez l’état des workflows, suivez les journaux en direct et téléchargez les artefacts des exécutions de workflows.
• Gists et Releases : Créez et gérez des gists, et gérez les versions de logiciels, y compris le téléversement d’actifs.
• Extensibilité : Créez des commandes personnalisées et des alias pour adapter gh à vos besoins et flux de travail spécifiques.
• Authentification : S’authentifie de manière sécurisée avec votre compte GitHub en utilisant des flux basés sur le navigateur ou des jetons.

Cas d’Utilisation

• Automatisation et Scripting : Automatisez les tâches répétitives comme la création de pull requests, la configuration de nouveaux dépôts ou la gestion en masse de tickets.
• Intégration CI/CD : Utilisez gh dans vos pipelines CI/CD pour interagir avec GitHub, comme la création d’une release après une construction réussie.
• Flux de Travail Centré sur le Terminal : Pour les développeurs qui vivent dans le terminal, gh offre un moyen d’effectuer presque toutes les tâches liées à GitHub sans interface graphique.
• Vérifications Rapides de Statut : Vérifiez rapidement le statut d’une pull request ou consultez les derniers tickets d’un projet avec une seule commande.

Pour Commencer

Voici un guide simple de style “Hello World” pour vous lancer avec gh.

1. Installation : Sur macOS, vous pouvez utiliser Homebrew :

   brew install gh
   

   Pour d’autres systèmes comme Windows ou Linux, consultez le guide d’installation officiel.

2. Authentification : Connectez-vous à votre compte GitHub. Cette commande ouvrira une fenêtre de navigateur pour que vous autorisiez le CLI.

   gh auth login
   

3. Créer et Cloner un Dépôt : Créons un nouveau dépôt public et clonons-le.

   # Créer un nouveau dépôt sur GitHub
   gh repo create mon-app-cli --public --source=. --remote=origin
   
   # Cloner un dépôt existant
   gh repo clone cli/cli
   

4. Lister les Tickets : Naviguez dans le répertoire d’un dépôt cloné et listez ses tickets ouverts.

   cd cli
   gh issue list
   

Tarification

GitHub CLI (gh) est entièrement gratuit et open-source, distribué sous la licence MIT. Vous pouvez l’utiliser sans aucun coût pour des projets personnels et commerciaux.

Communauté

En tant qu’outil officiel de GitHub, gh bénéficie d’une communauté massive et active. Le projet compte des dizaines de milliers d’étoiles sur GitHub et est largement salué pour son ensemble de fonctionnalités robustes et pour améliorer considérablement la productivité des développeurs. Les retours sont extrêmement positifs et l’outil est considéré comme mature et stable pour un usage quotidien.