初次使用 git 的“核弹级选项”:filter-branch 从仓库中删除文件

当初看 Pro Git 时就被作者这个“ 核弹级选项 ”的称呼吓到了,因此一直没敢好奇地去尝试。核弹啊,用对了威力无穷,用错了破坏力无穷!

但是,今天,我不得不用了,因为我想把我的原来写一些代码放到 github 上去公开。由于之前没想过要公开,到上传时才发现不能上传大于50M的文件。

折腾了半天,还是无法上传,于是,整个命令出来了:

  • --tree-filter表示修改文件列表。
  • --msg-filter表示修改提交信息,原提交信息从标准输入读入,新提交信息输出到标准输出。
  • --prune-empty表示如果修改后的提交为空则扔掉不要。在一次试运行中我发现虽然文件被删除了,但是还剩下个空的提交,就查了下 man 文档,找到了这个选项。
  • -f是忽略备份。不加这个选项第二次运行这个命令时会出错,意思是 git 上次做了备份,现在再要运行的话得处理掉上次的备份。
  • --all是针对所有的分支。

试运行了几次,看到 40 多次提交逐一被重写,然后检查下,发现要删除的文件确实被删除了。于是高兴地到 github 建立新仓库,并上传了。

折腾完毕,我更加喜欢 git 了 :-)

下面是具体的使用方法,主要是要gc,再覆盖到远程仓库。

1
2
3
4
5
6
7
git filter-branch --index-filter 'git rm --cached --ignore-unmatch <your-file-name>'
rm -rf .git/refs/original/
git reflog expire --expire=now --all
git fsck --full --unreachable
git repack -A -d
git gc --aggressive --prune=now
git push --force origin master

-—————– 2019-06-25更新,–all参数好像不能使用了,其实有更方便的第三方工具BFG可以使用,支持指定文件大小和文件名。
bfg-repo-cleaner

顺便也写下BFG的使用方式吧

首先仓库要使用bare方式,克隆的时候要加上–bare或者–mirror选项。

删除100M以上的文件 

1
java -jar bfg.jar --strip-blobs-bigger-than 100M some-big-repo.git

删除test.sdf文件 

1
java -jar bfg.jar --delete-files test.sdf some-big-repo.git

删除_Boot 文件夹

1
java -jar bfg.jar --delete-folders _Boot some-big-repo.git

 最后要gc,再push到远程仓库

1
git reflog expire --expire=now --all && git gc --prune=now --aggressivegit push --force --all

-—————– 2025-12-31更新:现在可以使用 git-filter-repo 来操作,更方便。

1
2
3
4
# 删除文件
git-filter-repo --invert-paths --path <your-file-name> --force
# 删除目录
git-filter-repo --invert-paths --path <your-directory-name> --force

注意: 使用git-filter-repo后要重新关联远程仓库

1
git remote add origin <your-remote-repo-url>