Git LFSの使い方

備忘録としてGit LFSの使い方をまとめます。
当記事はMac環境で実施した内容を基にしています。

作業の流れ

• LFS用のGit CLI拡張をインストール
• LFSの初期設定
• 対象ファイルの定義
• 対象ファイルの追加とプッシュ

LFS用のGit CLI拡張をインストール

以下のいずれかの方法でインストールします。

1. 以下からzipをダウンロードし、シェルを使用してインストールする
   https://git-lfs.com/

2. Homebrewを使用してインストールする

3. MacPortsを使用してインストールする

/usr/local/bin/git-lfsにインストールされます。

LFSの初期設定

ローカルのリポジトリのルートディレクトリで初期設定を行います。
初期設定で実行するコマンドはgit lfs installです。
CLI拡張のインストールとは別の手順となりますので注意が必要です。

sampleuser@MacBook-Pro sampleproject % git lfs install

Updated Git hooks.

Git LFS initialized.

これにより関連するGit hookがリポジトリに追加されます。
※この手順は1アカウント内で1度だけ実行します。

対象ファイルの定義

LFSの対象にしたいファイルを定義します。
PDFのファイルをLFSの対象とする場合の例を以下に示します。

sampleuser@MacBook-Pro sampleproject % git lfs track "*.pdf*"

Tracking "*.pdf*"

これにより（既存のものが無い場合は）.gitattriburesファイルが作成されます。
.gitattributesファイルの中身は以下の様になっています。

*.pdf* filter=lfs diff=lfs merge=lfs -text

※この手順はリポジトリごとに実施します。

対象ファイルの追加とプッシュ

LFSで管理したいファイル（例：Book1.pdf）をローカルリポジトリに追加します。
Book1.pdfと.gitattributesファイルを追跡対象に追加します。

git add .

コミット、プッシュします。

git commit -m "PDFをLFSで追加"
git push origin main

参考URL