使い方

ここでは、Git LFSの使い方について説明していきます。

操作としては、いままでのGitに対してLFS用のコマンドが追加されているため、それらの主要なものについて説明します。

今までと同じ操作

基本的にGit LFSを利用したからと言って、特別な操作が必要になるかというと、そんなことはありません。

例えば、クローン、コミット、プッシュ、プルなどのほとんどの操作は、今まで通りと同じようにできます。

Gitにはフック機能があり、何か特定の操作をする際に処理を追加することができるようになっています。そのため、この機能を使い、通常のコマンドによる操作のときにGit LFS用の処理を追加で実行しているため、基本的に特別なことをする必要がないようになっています。

しかし、まったくGit LFS用の操作が必要ないかというと、そんなことはありません。

初期設定

Git LFSを使いたい場合は、最初にそのリポジトリでGit LFSを使うことを明示します。

$ git lfs install

これは、リポジトリごとに一度だけ実行します。

このコマンドを実行することで、Git LFSに関するフック処理が追加されます。

ファイルの設定

別の記事で説明したように、Git LFSはバイナリファイルの管理を目的として作られたものです。

しかし、Gitはどのファイルがバイナリファイルであるかを知りません。そのため、Git LFSでは、Git LFSとして管理したいファイルを手動で設定してあげる必要があります。

拡張子がpngとなる画像ファイルを除外する場合は、次のようにコマンドを実行します。

$ git lfs track "*.png"

正規表現を使用して、末尾がpngで終わるものをGit LFSとして管理するようにしました。

Git LFSで管理するファイルの一覧は、.gitattributesに記述されているため、このファイルを直接編集しても構いません。もし、管理するファイルから削除する場合はこのファイルから除外するファイルに関する記述を削除します。

Git LFSで管理されているファイルは次のコマンドで確認することができるので、もしファイルがGit LFSで管理されているか不安な場合は、確認しましょう。

$ git lfs ls-files

コミット前のファイルがトラックされているかどうかは、このコマンドからは分かりませんので、注意が必要です。

注意

ここまでの説明では、複数人での使用の際に全員がGit LFSを使える環境であるという前提で進めています。

そのため、リポジトリを操作する人のひとりでもGit LFSが使えない環境であると、このGit LFSは正しく動作しません。

このようなことから、リポジトリ操作者はGit LFSがインストールされているかをちゃんと確認してから、リポジトリを使うようにしましょう。

さいごに

Git LFSの使い方はそれほど難しくありません。

今までGitの使用が難しかった場面でもGitを使うことができるような機能となっていますので、そのような環境でどんどん使っていきましょう。