bfg-repo-cleaner README

The project's README from github.com/rtyley/bfg-repo-cleaner. As one markdown file: README.md.

BFG Repo-Cleaner

CI Release

Removes large or troublesome blobs like git-filter-branch does, but faster - and written in Scala - Fund the BFG

$ bfg --strip-blobs-bigger-than 1M --replace-text banned.txt repo.git

The BFG is a simpler, faster (10 - 720x faster) alternative to git-filter-branch for cleansing bad data out of your Git repository:

Main documentation for The BFG is here : https://rtyley.github.io/bfg-repo-cleaner/

bfg-repo-cleaner (rtyley/bfg-repo-cleaner)

Searching Database…

这是什么?BFG Repo-Cleaner 是一款命令行工具,用于从 Git 仓库的历史记录中删除大文件或有问题的数据块(blob),比如大文件、密码、凭据和隐私数据。它是 git-filter-branch 的更快替代方案。
它是命令行工具还是别的什么?它是一个独立的命令行 Java/Scala jar 包,需要针对仓库的克隆来运行。没有图形界面,也没有可以集成到其他代码中的库接口。
我该怎么在自己的仓库上运行它?下载 BFG 的 jar 包,然后在你仓库的裸镜像克隆(bare mirror clone)上用 Java 运行它,之后再按文档说明使用 Git 标准的历史清理命令。
使用它需要安装 Java 吗?需要。BFG 以 Scala 编写,并以 jar 文件的形式分发,因此必须安装 Java 运行环境才能执行它。
它比 git-filter-branch 快多少?README 中称,它清理 Git 仓库中错误数据的速度比 git-filter-branch 快 10 到 720 倍。
一般哪些人需要这个工具?需要在敏感内容永久留在仓库历史中之前,清除误提交的大文件或泄露的密钥(密码、凭据)的开发者。
它的两个主要用途是什么?清除误提交、让仓库变得臃肿的超大文件,以及删除泄露到提交历史中的密码或其他隐私数据。
它是否像 git-filter-branch 那样重写 Git 历史?是的,它和 git-filter-branch 一样会重写历史,但专为这些常见清理操作设计,速度大幅提升。
What are similar projects?turbocrypt, git-sim, git-secrets, xerj, GDecay, Photon, thefuck, lazygit
Creator
rtyley
Size
1.9 MB
Stars
12.2K
Age
13y
Commits · 90 Days