Why use git archive instead of zip?

git archive automatically excludes the .git folder, respects export rules (.gitattributes export-ignore), and can export a specific tag or commit. A regular zip includes everything, including the Git history.

How do I exclude files from the archive?

Add export-ignore in .gitattributes. For example: "tests/ export-ignore" excludes the tests folder from the archive. This is useful for excluding tests, CI, internal docs, etc.

Can I archive a specific commit?

Yes, replace HEAD with the commit hash or a tag: git archive --format=zip a1b2c3d. You can even archive a branch: git archive --format=zip origin/release.

What formats are supported?

Git supports tar, tar.gz (tgz), zip by default. The tar format is the lightest. Use --format to specify, or Git will infer it from the extension in --output.

How do I archive only a subdirectory?

Add the path after the reference: git archive HEAD src/. Only the contents of the src directory will be included in the archive.

Git archive: export your project cleanly

git archive creates an archive (zip, tar) of your project without the .git folder. Ideal for delivering code, creating releases, or sharing without history.

Practice git archive Git Glossary

gitquest — enquête

Delivery

What is git archive?

git archive creates an archive of your project from a commit, tag, or branch. The archive contains your files without the .git folder.

It is like packaging your code: you choose the version to package and Git creates a clean zip or tar, ready to be delivered or shared.

Git archive syntax

git archive --format=zip -o f.zip HEAD

ZIP archive of HEAD

git archive --format=tar.gz -o f.tar.gz v1.0

tar.gz archive of a tag

git archive --prefix=project/ HEAD

With a root folder in the archive

Git archive in practice

Creating zip and tar archives of your project.

ZIP archive

gitquest — archive zip

# Create a ZIP archive of the project

$git archive --format=zip --output=project.zip HEAD

Archive created: project.zip

# Create an archive of a specific tag

$git archive --format=zip --output=v1.0.zip v1.0.0

Archive created: v1.0.zip

# The .git folder is NOT included!

TAR archive and subdirectory

gitquest — archive tar

# Create a tar.gz archive

$git archive --format=tar.gz --output=project.tar.gz HEAD

Archive created: project.tar.gz

# Export only a subdirectory

$git archive HEAD src/ | tar -x -C /tmp/export/

src/ directory exported

# With a directory prefix

$git archive --prefix=my-project/ HEAD | gzip > release.tar.gz

Archive with prefix created

git archive vs regular zip

`git archive`

Automatically excludes .git, respects export-ignore, can target a specific tag/commit.

Recommended for Git projects

`regular zip`

Includes everything including .git, node_modules, and ignored files.

Generic but less clean

Common mistakes with git archive

Including sensitive files

If .env is in the repo, it will be in the archive. Use .gitattributes with export-ignore to exclude sensitive files.

Forgetting --prefix

Without prefix, files are at the root of the archive. Add --prefix=project-name/ to put them in a folder (don't forget the trailing /).

Archiving uncommitted files

git archive only takes committed files. Uncommitted changes will not be in the archive. Commit or stash first.

Part of the Git Advanced guide

Related commands

git tag

Create tags for releases

git log

Find the commit to archive

git config

Configure exports

GitQuest is created by Anaïs (nouvelle fenêtre), web developer and head of education, specializing in tech training and digital accessibility.

Questions about git archive

Deliver your code with GitQuest

Learn to create clean releases and deliver your code with confidence.

Start the investigations