Synopsis
git for-each-ref [--format=<fmt>] [--sort=<key>] [<pattern>...]
Description
The git for-each-ref command iterates over every ref (branches, tags, remotes, notes, stash) and applies a customizable format. It is far more powerful than parsing git branch or git tag output: you can sort by version, by date, or by any field, and produce stable machine-readable output.
Dans l'usage quotidien, git for-each-ref s'intègre étroitement avec les alias de shell, les plugins d'éditeur et l'intégration continue. Les utilisateurs avancés ajoutent souvent des alias combinant les flags qu'ils passent toujours, ou enveloppent la commande dans des scripts qui appliquent les conventions d'équipe. Le formatage de la sortie peut être personnalisé via la configuration Git — pretty formats, schémas de couleurs et comportement du pager sont tous ajustables. Quand quelque chose tourne mal, la première étape de diagnostic est généralement de relancer la commande avec GIT_TRACE=1 dans l'environnement, ce qui révèle les appels de plomberie sous-jacents. Pour les situations inhabituelles, la sortie --help (git for-each-ref --help) ouvre la page de manuel complète avec les détails de chaque option, y compris celles rarement utilisées dans les workflows ordinaires mais essentielles pour le débogage ou le scripting à grande échelle.
Comprendre comment git for-each-ref interagit avec le reste du modèle de données de Git — la base d'objets, l'index, les refs et l'arborescence de travail — est rentable. Chaque commande opère sur un sous-ensemble de ces pièces, et savoir laquelle elle touche aide à prédire les résultats et récupérer après les erreurs. Lire la documentation officielle de Git en parallèle de la pratique sur un dépôt jetable est la façon la plus rapide d'intérioriser les subtilités. La plupart des problèmes de production avec Git proviennent de l'une de trois causes : comportement par défaut surprenant, opérations réseau partielles, ou réécriture d'historique déjà partagé. Un modèle mental fonctionnel des effets de bord de git for-each-ref aide à éviter les trois.
When to Use
Reach for for-each-ref in scripts that need detailed ref metadata: build version selectors, dashboards of branch ages, automated cleanup of stale branches, or release-note generators.
Options courantes
| Option | Description |
|---|---|
--format=<fmt> | Format string with field placeholders. |
--sort=<key> | Sort by field (prefix - for descending). |
--count=<n> | Limit number of entries. |
--contains <commit> | Refs containing the given commit. |
--merged <commit> | Refs merged into the given commit. |
--points-at <commit> | Refs that directly point at a commit. |
Exemples
git for-each-ref --format='%(refname:short) %(objectname:short)' refs/heads/
# Local branch names with abbreviated SHAs
git for-each-ref --sort=-committerdate --count=10 \
--format='%(committerdate:short) %(refname:short)' refs/heads/
# Top 10 most recently updated branches
git for-each-ref --sort=-v:refname --format='%(refname:short)' refs/tags/ | head -5
# Five highest semver tags
Erreurs fréquentes
Forgetting the trailing / on refs/heads/ patterns can match unintended refs. Format strings can be tricky — quote field names with parentheses. --sort=v:refname only works on tags that look like versions.
Commandes liées
git branch, git tag, git ls-remote, git rev-parse