How to Remove a File from Git?

In Git, managing files effectively includes knowing how to remove files that are no longer necessary or were accidentally committed. Whether you need to delete a file from your working directory, remove it from tracking without deleting it locally, or clear a sensitive file from your Git history, this guide will cover each method and the best practices for doing so.

---

Why Remove Files from Git?

There are several reasons you might want to remove a file from your Git repository:

1. Irrelevant Files: Files that don’t belong in your repository, such as local environment files or large binaries.
2. Sensitive Information: Accidental commits of sensitive data like API keys or credentials.
3. Reducing Repository Size: Removing large files that unnecessarily increase repository size and are better suited to external storage.

---

Step-by-Step Guide to Removing Files from Git

1. Remove a File and Delete it from the Local Directory

If you want to delete a file from both the Git repository and your local working directory, use the git rm command followed by the file name:

git rm filename

This command stages the file for deletion and will be included in your next commit. Here’s how to complete the process:

git rm filename
git commit -m "Remove filename from repository"
git push origin main

Note: Replace filename with the name of the file you want to delete and main with the appropriate branch name.

2. Remove a File from Git Tracking but Keep it Locally

Sometimes, you want to stop tracking a file without deleting it from your local machine. For example, you might realize that config.json should be excluded from Git tracking but still needs to be available locally.

To do this, use the --cached option:

git rm --cached filename

Next, add the file to .gitignore to prevent Git from tracking it in future commits:

echo "filename" >> .gitignore

Then, commit the changes:

git add .gitignore
git commit -m "Stop tracking filename and add to .gitignore"
git push origin main

This approach is ideal for configuration files, compiled binaries, and other local-specific files that don’t need to be shared with collaborators.

3. Remove a Directory from Git

If you need to delete an entire directory from your repository, use the -r flag with git rm:

git rm -r directoryname
git commit -m "Remove directoryname from repository"
git push origin main

This command recursively deletes the specified directory and its contents from your Git history.

4. Remove a File from All History (Permanent Removal)

If you’ve accidentally committed a sensitive file (e.g., containing passwords or API keys) or a very large file that bloats the repository, removing it requires a more in-depth approach. Use caution, as this involves rewriting the Git history, which affects collaborators.

To completely remove a file from all commits, use git filter-branch or BFG Repo-Cleaner:

Using git filter-branch

git filter-branch --force --index-filter \
  "git rm --cached --ignore-unmatch filename" \
  --prune-empty --tag-name-filter cat -- --all

Replace filename with the file name. Afterward, force-push the changes:

git push origin --force --all

Using BFG Repo-Cleaner (Recommended)

1. Install BFG Repo-Cleaner.
2. Run BFG to remove the file:

   bfg --delete-files filename

3. Clean the repository and force-push:

   git reflog expire --expire=now --all && git gc --prune=now --aggressive
   git push origin --force --all

This removes the file from all history but requires force-pushing, which can disrupt collaborators. Notify team members before proceeding.

5. Undo the Last Commit

If you’ve committed a file by mistake and want to undo it immediately, use:

git reset HEAD~1

This command undoes the most recent commit, keeping the file changes in your working directory without staging them. You can now remove or modify the file as needed before recommitting.

---

Summary

Knowing how to remove files in Git is essential for managing a clean, organized, and secure repository. Use git rm for standard deletions, git rm --cached to stop tracking files, and advanced methods like git filter-branch or BFG Repo-Cleaner to completely erase files from Git history. By following these steps and best practices, you can confidently handle file removals in Git while maintaining a reliable codebase.