Synopsis

git archive [--format=<fmt>] [--prefix=<p>/] [-o <file>] <tree-ish> [<path>...]

Description

The git archive command creates a tar or zip file containing the contents of any tree (commit, tag, or branch). Unlike a simple tar of the working tree, it includes only tracked files at a specific revision and excludes .git directories. This makes it ideal for producing release tarballs, source distributions, and reproducible snapshots.

The --prefix option wraps all files under a subdirectory inside the archive — important for releases so that extraction creates a named folder. git archive also supports running over the network from servers that allow it.

Dans l'usage quotidien, git archive 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 archive --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 archive 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 archive aide à éviter les trois.

Options courantes

Exemples

git archive --format=tar.gz --prefix=myproj-1.0/ -o myproj-1.0.tar.gz v1.0
# Release tarball with named top-level directory

git archive HEAD docs/ | tar -x -C /tmp/docs
# Extract the docs/ directory at HEAD into /tmp/docs

git archive --format=zip -o snapshot.zip HEAD
# ZIP archive of current tree

Examples (continued)

# Use .gitattributes to exclude files from archives:
echo "tests/ export-ignore" >> .gitattributes
echo ".github/ export-ignore" >> .gitattributes
git archive --worktree-attributes -o release.tar.gz HEAD

Erreurs fréquentes

Forgetting --prefix creates an archive that explodes files into the current directory on extraction. Without export-ignore attributes, your archive may include CI configs, tests, and dev-only files that you didn't intend to ship.

Commandes liées

git bundle, git tag, git show, tar