git archiveで、リポジトリの中身をzipにする方法

​​Git​コマンドライン

git archive --format=zip --output=<ファイル名>.zip HEAD を実行すると、今のコミットに入っているファイルだけを zip ファイルにまとめられます。ソースコードを配布用に固めたいときや、課題の提出などで「.git フォルダーや node_modules を含めずに zip で送ってほしい」と言われたときに使える方法です。.git フォルダーのほか、コミットしていない変更や .gitignore で無視しているファイルも入りません。検証環境でコマンドを実行し、操作の前と後の出力をそのまま載せています。

補足

検証環境は Ubuntu 24.04、Git 2.43.0、zip の中身の確認には UnZip 6.00 を使いました。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定し、コミットの日時は環境変数で決めています。zip ファイルはリポジトリの1つ上のフォルダー(../)に作っています。Windows と macOS での動作、--remote でほかのサーバーから取り出す使い方、tar 形式での細かな違いは試していません。

zip にする前のリポジトリ

neko-app というリポジトリを用意しました。コミットは2つあり、最初のコミットに v1.0 のタグを付けています。そのうえで、コミットしていない変更(src/main.js の書き換え)、Git の管理に入れていないファイル(memo.txt)、.gitignore で無視しているもの(node_modules/ と .env)を作業フォルダーに置きました。

console
$ git status --short --ignored
 M src/main.js
?? memo.txt
!! .env
!! node_modules/

$ git log --oneline
0c66e81 鳴き声を2回にする
c08a37c 最初のコミット

$ git ls-files
.gitignore
README.md
docs/guide.md
src/main.js
tests/main.test.js

git ls-files に出ている5つが、Git が管理しているファイルです。

git archive で zip を作る

リポジトリのフォルダーで、次のコマンドを実行します。gitrevisions の公式リファレンスによると、HEAD は今の作業のもとになっているコミットを指します。

console
$ git archive --format=zip --output=../neko-app.zip HEAD

何も表示されずに終わり、../neko-app.zip ができます。中身を unzip -l で一覧にしました。

console
$ unzip -l ../neko-app.zip
Archive:  ../neko-app.zip
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638
  Length      Date    Time    Name
---------  ---------- -----   ----
       19  2026-11-12 10:30   .gitignore
       21  2026-11-12 10:30   README.md
        0  2026-11-12 10:30   docs/
       12  2026-11-12 10:30   docs/guide.md
        0  2026-11-12 10:30   src/
       35  2026-11-12 10:30   src/main.js
        0  2026-11-12 10:30   tests/
        5  2026-11-12 10:30   tests/main.test.js
---------                     -------
       92                     8 files

$ unzip -p ../neko-app.zip src/main.js
console.log("にゃーにゃー");

入ったのは git ls-files の5つのファイルと、そのフォルダーだけです。.git フォルダー、memo.txt、node_modules/、.env は入っていません。src/main.js の中身も、コミットしたときの「にゃーにゃー」です。一方で、.gitignore はコミットしたファイルなので zip に入りました。

ポイント

git archive が zip にするのは、指定したコミットに記録されているファイルです。作業フォルダーの今の状態ではありません。コミットしていない変更は、zip に入りません。

zip を作った後も、作業フォルダーは何も変わっていません。

console
$ git status --short --ignored
 M src/main.js
?? memo.txt
!! .env
!! node_modules/

ファイルの日時と、zip に残るコミットの ID

一覧の日時は、どのファイルも 10:30 でした。これは HEAD のコミットの日時です。一覧の上にある 0c66e81… の行は zip ファイルのコメントで、unzip -z で取り出すと、git rev-parse HEAD で調べたコミットの ID と同じでした。

console
$ unzip -z ../neko-app.zip
Archive:  ../neko-app.zip
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638

$ git rev-parse HEAD
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638

git archive の公式リファレンスにも、コミットやタグを指定したときは、そのコミットの日時をファイルの日時にし、zip ではコミットの ID をファイルのコメントに入れると書かれています。後から zip を見て、どのコミットから作ったものかを確かめられます。

–format を省くと、ファイル名の拡張子で形式が決まる

--output(短く書くと -o)のファイル名が .zip で終わっていれば、--format=zip を付けなくても zip になりました。.tar にすると tar 形式になり、-o を付けずに標準出力へ書き出したときも tar 形式でした。

console
$ git archive --list
tar
tgz
tar.gz
zip

$ git archive -o ../auto.zip HEAD

$ file ../auto.zip
../auto.zip: Zip archive data, at least v1.0 to extract, compression method=store

$ git archive -o ../auto.tar HEAD

$ file ../auto.tar
../auto.tar: POSIX tar archive

$ git archive HEAD > ../stdout.out

$ file ../stdout.out
../stdout.out: POSIX tar archive

公式リファレンスの –format の説明にも、--format がなく出力先のファイル名が分かるときは名前から形式を決め、それ以外は tar になると書かれています。リダイレクトで .zip の名前に書き出したときも、中身は tar でした。この書き方のときは --format=zip を付けると zip になります。

console
$ git archive HEAD > ../redirect.zip

$ file ../redirect.zip
../redirect.zip: POSIX tar archive

$ git archive --format=zip HEAD > ../redirect2.zip

$ file ../redirect2.zip
../redirect2.zip: Zip archive data, at least v1.0 to extract, compression method=store

展開したときのフォルダー名を付ける –prefix

さきほどの zip は、展開するとファイルがその場にばらばらに出てきます。--prefix=neko-app/ を付けると、すべてのファイルの前に neko-app/ が付き、1つのフォルダーにまとまります。

console
$ git archive -o ../neko-app-prefix.zip --prefix=neko-app/ HEAD

$ unzip -l ../neko-app-prefix.zip
Archive:  ../neko-app-prefix.zip
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638
  Length      Date    Time    Name
---------  ---------- -----   ----
        0  2026-11-12 10:30   neko-app/
       19  2026-11-12 10:30   neko-app/.gitignore
       21  2026-11-12 10:30   neko-app/README.md
        0  2026-11-12 10:30   neko-app/docs/
       12  2026-11-12 10:30   neko-app/docs/guide.md
        0  2026-11-12 10:30   neko-app/src/
       35  2026-11-12 10:30   neko-app/src/main.js
        0  2026-11-12 10:30   neko-app/tests/
        5  2026-11-12 10:30   neko-app/tests/main.test.js
---------                     -------
       92                     9 files

$ unzip -q ../neko-app-prefix.zip -d ../extracted && ls -A ../extracted ../extracted/neko-app
../extracted:
neko-app

../extracted/neko-app:
.gitignore
README.md
docs
src
tests

展開先の extracted の中に neko-app フォルダーが1つでき、その中にファイルが並びました。

最後の / は省けません。--prefix=neko-app と書くと、フォルダーにはならず、ファイル名の頭に neko-app がそのままくっつきました(unzip -Z1 は、ファイル名だけを1行ずつ出す指定です)。

console
$ git archive -o ../no-slash.zip --prefix=neko-app HEAD

$ unzip -Z1 ../no-slash.zip
neko-app.gitignore
neko-appREADME.md
neko-appdocs/
neko-appdocs/guide.md
neko-appsrc/
neko-appsrc/main.js
neko-apptests/
neko-apptests/main.test.js

タグやブランチを指定して、過去の版を zip にする

HEAD の代わりに、タグやブランチの名前、コミットの ID を書くと、その時点の中身を zip にできます。v1.0 のタグを指定し、フォルダー名にも版を入れました。

console
$ git archive -o ../neko-app-v1.0.zip --prefix=neko-app-v1.0/ v1.0

$ unzip -p ../neko-app-v1.0.zip neko-app-v1.0/src/main.js
console.log("にゃー");

$ unzip -z ../neko-app-v1.0.zip
Archive:  ../neko-app-v1.0.zip
c08a37c1b28afa06691e216e4841f126208b35e4

$ git rev-parse v1.0^{commit}
c08a37c1b28afa06691e216e4841f126208b35e4

src/main.js は最初のコミットの「にゃー」になっていて、コメントには v1.0 が指すコミットの ID が入っています。今いるブランチを切り替えなくても、過去の版を取り出せます。

一部のフォルダーだけを zip にする

コミットの後ろにフォルダーやファイルの名前を書くと、そこだけを zip にできます。

console
$ git archive -o ../docs.zip HEAD docs

$ unzip -l ../docs.zip
Archive:  ../docs.zip
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638
  Length      Date    Time    Name
---------  ---------- -----   ----
        0  2026-11-12 10:30   docs/
       12  2026-11-12 10:30   docs/guide.md
---------                     -------
       12                     2 files

zip の中でも docs/ の下に入ります。docs/ を付けずに中身だけを入れたいときは、HEAD:docs のように : でつないで書く方法があります。

console
$ git archive -o ../docs-tree.zip HEAD:docs

$ unzip -l ../docs-tree.zip
Archive:  ../docs-tree.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
       12  2026-11-12 11:19   guide.md
---------                     -------
       12                     1 file

$ unzip -z ../docs-tree.zip
Archive:  ../docs-tree.zip

guide.md がいちばん上に入りましたが、日時はコミットの 10:30 ではなく、コマンドを実行した時刻になりました。zip のコメントも空です。HEAD:docs はコミットではなくフォルダー(Git の用語では tree)を指すため、公式リファレンスの説明どおり、今の時刻が使われ、コミットの ID も残りません。どのコミットから作ったかを zip に残したいときは、HEAD docs の書き方を使います。

テストなど、配布しないファイルを除く export-ignore

テストのフォルダーや設定ファイルのように、Git では管理したいけれど zip には入れたくないものは、.gitattributes に export-ignore を書いて除きます(gitattributes の公式リファレンス)。tests/、.gitignore、.gitattributes 自体を除くように書きました。

console
$ printf "tests/ export-ignore\n.gitattributes export-ignore\n.gitignore export-ignore\n" > .gitattributes

$ git archive -o ../before-commit.zip HEAD

$ unzip -l ../before-commit.zip
Archive:  ../before-commit.zip
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638
  Length      Date    Time    Name
---------  ---------- -----   ----
       19  2026-11-12 10:30   .gitignore
       21  2026-11-12 10:30   README.md
        0  2026-11-12 10:30   docs/
       12  2026-11-12 10:30   docs/guide.md
        0  2026-11-12 10:30   src/
       35  2026-11-12 10:30   src/main.js
        0  2026-11-12 10:30   tests/
        5  2026-11-12 10:30   tests/main.test.js
---------                     -------
       92                     8 files

.gitattributes を作っただけでは、tests/ も .gitignore も zip に入ったままでした。git archive は、zip にするコミットの中の .gitattributes を読むためです。まだコミットしていない .gitattributes を使いたいときは、--worktree-attributes を付けます。

console
$ git archive --worktree-attributes -o ../worktree-attr.zip HEAD

$ unzip -l ../worktree-attr.zip
Archive:  ../worktree-attr.zip
0c66e81f6b6c4a3b88a7aea7c4bcd9793a83c638
  Length      Date    Time    Name
---------  ---------- -----   ----
       21  2026-11-12 10:30   README.md
        0  2026-11-12 10:30   docs/
       12  2026-11-12 10:30   docs/guide.md
        0  2026-11-12 10:30   src/
       35  2026-11-12 10:30   src/main.js
---------                     -------
       68                     5 files

毎回この指定をしなくて済むように、.gitattributes をコミットしました。このコミットの日時は 11:00 にしています。その後は、オプションなしで同じ結果になりました。

console
$ git add .gitattributes && git commit -q -m "配布用のzipにテストを入れない"

$ git archive -o ../release.zip HEAD

$ unzip -l ../release.zip
Archive:  ../release.zip
6565d678b3d1edb455dd3cabfa3d8f4a7df7567e
  Length      Date    Time    Name
---------  ---------- -----   ----
       21  2026-11-12 11:00   README.md
        0  2026-11-12 11:00   docs/
       12  2026-11-12 11:00   docs/guide.md
        0  2026-11-12 11:00   src/
       35  2026-11-12 11:00   src/main.js
---------                     -------
       68                     5 files

公式リファレンスの ATTRIBUTES の節にも、属性はふつう zip にするコミットの .gitattributes から読み、作業フォルダーの .gitattributes を使うには --worktree-attributes を付けると書かれています。

Git で管理していないファイルを足す –add-file

--add-file を使うと、Git で管理していないファイルを zip に足せます。memo.txt を足しました。

console
$ git archive -o ../with-memo.zip --add-file=memo.txt HEAD

$ unzip -l ../with-memo.zip
Archive:  ../with-memo.zip
6565d678b3d1edb455dd3cabfa3d8f4a7df7567e
  Length      Date    Time    Name
---------  ---------- -----   ----
       21  2026-11-12 11:00   README.md
        0  2026-11-12 11:00   docs/
       12  2026-11-12 11:00   docs/guide.md
        0  2026-11-12 11:00   src/
       35  2026-11-12 11:00   src/main.js
        7  2026-11-12 11:00   memo.txt
---------                     -------
       75                     6 files

公式リファレンスの –add-file の説明によると、zip の中での場所は、その前に書いた --prefix とファイル名(フォルダーを除いた名前)をつないだものになります。docs/memo.txt を --prefix=neko-app/ と一緒に足してみると、zip の中では neko-app/docs/memo.txt ではなく neko-app/memo.txt になりました。

console
$ cp memo.txt docs/memo.txt && git archive -o ../with-docs-memo.zip --prefix=neko-app/ --add-file=docs/memo.txt HEAD && rm docs/memo.txt

$ unzip -Z1 ../with-docs-memo.zip
neko-app/
neko-app/README.md
neko-app/docs/
neko-app/docs/guide.md
neko-app/src/
neko-app/src/main.js
neko-app/memo.txt

memo.txt を docs/ にコピーしてから zip を作り、終わったらコピーを消しています。

コミットしていない変更も入れたいとき

作業中の変更も含めて zip にしたいときは、コミットしてから作るのが確実です。コミットせずに済ませたいときは、git stash create で作業中の変更を一時的なコミットにし、その ID を git archive に渡す方法もあります。

console
$ git status --short
 M src/main.js
?? memo.txt

$ git archive -o ../wip.zip $(git stash create)

$ git stash list

$ unzip -l ../wip.zip
Archive:  ../wip.zip
70ecf49640520a046c4cb0c8d22e035222f4e27a
  Length      Date    Time    Name
---------  ---------- -----   ----
       21  2026-11-12 11:00   README.md
        0  2026-11-12 11:00   docs/
       12  2026-11-12 11:00   docs/guide.md
        0  2026-11-12 11:00   src/
       26  2026-11-12 11:00   src/main.js
---------                     -------
       59                     5 files

$ unzip -p ../wip.zip src/main.js
console.log("作業中");

$ git status --short
 M src/main.js
?? memo.txt

src/main.js は作業中の内容で zip に入りました。git stash list は空のままで、作業フォルダーの変更もそのまま残っています。ただし、Git の管理に入れていない memo.txt は、この方法でも入りませんでした。git stash の公式リファレンスでは、git stash create はスクリプトから使うためのもので、ふだん使うコマンドではないとされています。

​Posted by 86