Git LFS Setup Guide

2024-10-26 19:18 UTC gpt-4o Open in ChatGPT ↗

Setting up Git LFS (Large File Storage) allows you to manage large files more efficiently by storing them outside your Git repository, reducing repo size and improving performance. Here’s how to set it up:

Step 1: Install Git LFS

Download and Install Git LFS:
- For Windows or macOS: Download Git LFS from the official Git LFS website and run the installer.
- For Linux: Use a package manager:
  Terminal window
```
sudo apt-get install git-lfs   # Debian/Ubuntu
sudo dnf install git-lfs       # Fedora
brew install git-lfs           # macOS with Homebrew
```
Initialize Git LFS: Run the following command to initialize Git LFS in your Git repository:
Terminal window
```
git lfs install
```
This command installs Git LFS hooks for your current repository. You only need to run this once per repo.

Step 2: Track Large File Types

Specify which file types you want to store using Git LFS. For example, if you want to track .psd files:

git lfs track "*.psd"

This command will create or update a .gitattributes file in your repo, which tells Git LFS to track those file types.

Note: You can track multiple file types by running git lfs track for each file extension you need.

Step 3: Add and Commit Files

Now, add your files as usual, and Git will use LFS for the tracked file types:

git add .gitattributes  # Stage the .gitattributes file if it’s new
git add path/to/large_file.psd
git commit -m "Add large file using Git LFS"

Step 4: Push Files to Remote Repository

When pushing your changes, Git LFS will handle the large files separately:

git push origin main

Step 5: Verify LFS Storage

To confirm that Git LFS is handling the large files, use:

git lfs ls-files

Additional Tips

Configure Git LFS storage limits on your remote repository (e.g., GitHub, GitLab) to avoid storage cap issues.
Manage tracked files by editing .gitattributes if needed, and re-track files by updating your Git LFS configurations.

After these steps, Git LFS will manage the specified large files in your repository, optimizing your Git operations for large assets.

Here’s a Windows-specific guide to setting up Git LFS:

Step 1: Install Git LFS

Download Git LFS for Windows:
- Go to the Git LFS website, and download the Windows installer.
- Run the installer, which will automatically set up Git LFS on your system.
Initialize Git LFS in Your Repository: Open Git Bash (or any terminal you prefer on Windows) and run:
Terminal window
```
git lfs install
```
This command sets up Git LFS hooks for the current repository. You need to run this only once per repo.

Step 2: Track Your Large Files

Specify the file types you want Git LFS to manage. For example, if you’re working with .psd files or .zip files, tell Git LFS to track them:

git lfs track "*.psd"
git lfs track "*.zip"

This creates a .gitattributes file in your repository, which lists the file types managed by Git LFS.

Step 3: Add and Commit Files

Now, you can add the files to your repo as usual. Git will automatically manage files of the types specified in .gitattributes using Git LFS:

git add .gitattributes  # Stage .gitattributes if it’s new
git add path/to/your/largefile.psd
git commit -m "Add large file with Git LFS"

Step 4: Push Changes to Remote

When you push to your remote repository, Git LFS will handle the large files separately, uploading them to LFS storage on the remote server.

git push origin main

Step 5: Confirm Git LFS Is Working

After committing and pushing, you can verify that Git LFS is tracking your large files with:

git lfs ls-files

Windows-Specific Notes

Git LFS on GitHub/GitLab/Bitbucket: Most cloud Git providers support Git LFS, but they may have storage limits. Check your provider’s Git LFS quota and pricing if you’re working with very large files.
Git Bash or Command Prompt: While you can use Git LFS with the Windows Command Prompt or PowerShell, Git Bash often provides a smoother experience.

With these steps, Git LFS will manage large files on your Windows setup effectively.