Git LFS (Git Large File Storage) is used to solve the problem of storing large binary files that are committed to a git repository.
Based on git’s versioning mechanism, when frequent changes are made and large binary files are committed to the repository, the size of the repository expands rapidly, causing problems such as slow repository pulls and commits.
Git LFS puts the specified type of file versioning on the LFS large file server according to a set of rules, and the git repository only uses the index index to point to the corresponding file on the LFS large file server.
Download and install it from the official website.
Mac computers can use Homebrew or MacPorts to quickly install.
brew install git-lfs
port install git-lfs
After the installation is complete, initialize the LFS by executing the following command.
2. Setting up LFS in a Git project
If we need to set binary files with
.node suffix types to use lfs, execute the following command.
After execution, the file
.gitattributes will be created in the project’s current directory (if not already there), in which the relevant suffix type settings will be written or updated as follows.
Remember to add the file to the git repository by running the command:
git add .gitattributes.
3. Enable LFS in the gitlab project settings
The switch is set in the following path
Settings-General--Visibility, project features, permissions-Git Large File Storage, see the image below.
If the above settings work well, subsequent commits to git with
.node suffixes will be stored using LFS. When you commit to gitlab, the file will be marked with
Note: If you don’t have Git LFS installed locally and you only clone the repository itself, git pull will only fetch the repository itself, and the only thing stored on LFS is the version index information.
4. Migrating Existing Files in Your Repository to LFS
Git LFS will only keep track of newly created files after you set it up, but you can use the
git lfs migrate command to migrate existing files. For more information on how to do this, see below.
5. Git LFS Common Commands Reference
- Use Git LFS to manage files of a specific type:
git lfs track "*.psd"
- Stop using Git LFS to manage files of a specific type:
git lfs untrack "*.psd" && git rm --cached "*.psd"
- See a list of matches in your current project that are managed using Git LFS:
git lfs track
- Enumerate all the specific files that are currently managed by Git LFS:
git lfs ls-files
- View the status of the current Git LFS object:
git lfs status
- pull LFS files:
git lfs pull
- View the version of Git LFS:
git lfs version
A short summary of the above main points is as follows.
- Installation: All users should download and install Git LFS from the official website.
- Configuration: Use the
git lfs trackcommand to configure which file types you want to use with LFS; you should also turn on the switch in the gitlab settings.
- Migrate: Use
git lfs migrateto migrate existing files
- All users need to have LFS installed, otherwise the local content of files stored on the LFS server in the pulled repository will only be index information