Git intègre un système d’aide complet directement dans votre
terminal. Trois commandes couvrent tous les cas : git help pour la
documentation détaillée, git <commande> -h pour un résumé rapide, et
git help -g pour les guides thématiques. Ce guide vous montre comment
les utiliser efficacement.
Ce que vous allez apprendre
Section intitulée « Ce que vous allez apprendre »- Utiliser
git helppour accéder à la documentation officielle - Distinguer les 3 niveaux d’aide : résumé, manuel complet, guide thématique
- Rechercher efficacement dans une page de manuel Git
- Explorer les guides thématiques intégrés avec
git help -g
Les 3 niveaux d’aide
Section intitulée « Les 3 niveaux d’aide »| Besoin | Commande | Résultat |
|---|---|---|
| Résumé rapide (options) | git commit -h | Synopsis + options courtes |
| Documentation complète | git help commit | Page de manuel complète |
| Documentation dans le navigateur | git help --web commit | Ouvre la doc dans Firefox/Chrome |
Résumé rapide avec -h
Section intitulée « Résumé rapide avec -h »Pour un rappel des options sans quitter votre workflow :
git commit -hSortie attendue (extrait) :
usage: git commit [-a | --interactive | --patch] [-s] [-v] ... -q, --quiet suppress summary after successful commit -v, --verbose show diff in commit message template ...C’est la commande la plus rapide. Elle affiche les options directement dans le terminal, sans ouvrir de pager.
Documentation complète avec git help
Section intitulée « Documentation complète avec git help »git help commitCette commande ouvre la page de manuel (man page) de git commit.
C’est la même chose que man git-commit. La documentation est
exhaustive : chaque option, chaque comportement, des exemples.
Appuyez sur q pour quitter le pager.
Documentation dans le navigateur
Section intitulée « Documentation dans le navigateur »git help --web commitOuvre la documentation sur git-scm.com dans votre navigateur. Le format est plus lisible que les pages de manuel, avec une table des matières et des liens internes.
Lister toutes les commandes
Section intitulée « Lister toutes les commandes »Pour voir toutes les commandes Git disponibles :
git help -aGit les organise en catégories : commandes principales, commandes auxiliaires, commandes de bas niveau (plumbing). Vous n’aurez besoin au quotidien que d’une dizaine de commandes principales.
Guides thématiques intégrés
Section intitulée « Guides thématiques intégrés »Git inclut des guides sur des sujets transversaux :
git help -gSortie attendue (extrait) :
The Git concept guides are: attributes Defining attributes per path cli Git command-line interface and conventions core-tutorial A Git core tutorial for developers everyday A useful minimum set of commands for Everyday Git glossary A Git Glossary revisions Specifying revisions and ranges for Git tutorial A tutorial introduction to Git workflows An overview of recommended workflows with GitPour lire un guide :
git help everyday # Les commandes du quotidiengit help revisions # La syntaxe HEAD~2, main..feature, etc.git help workflows # Les workflows recommandésRessources externes
Section intitulée « Ressources externes »| Ressource | URL | Usage |
|---|---|---|
| Pro Git Book | https://git-scm.com/book/fr/v2 | Guide complet gratuit (en français) |
| Documentation officielle | https://git-scm.com/docs | Référence de chaque commande |
| Learn Git Branching | https://learngitbranching.js.org/ | Exercices visuels interactifs |
| Git Flight Rules | https://github.com/k88hudson/git-flight-rules | ”Que faire quand…” — recettes de survie |
Dépannage : problèmes courants
Section intitulée « Dépannage : problèmes courants »| Symptôme | Cause probable | Solution |
|---|---|---|
git help affiche une erreur “no manual entry” | Man pages non installées | Installez le paquet git-man (Debian/Ubuntu) ou git-doc |
--web n’ouvre pas le navigateur | Variable BROWSER non définie | git config --global web.browser firefox |
| La doc est en anglais | Normal — la traduction officielle est partielle | Le Pro Git Book est disponible en français |
À retenir
Section intitulée « À retenir »git <commande> -hpour un résumé rapide des optionsgit help <commande>pour la documentation complètegit help -gpour les guides thématiques intégrésgit help everydayest le meilleur point de départ pour les commandes essentielles- Pro Git Book (gratuit, en français) est la référence externe la plus complète