Forrest logo
tool overview
On this page you find all important commands for the CLI tool bfg. If the command you are looking for is missing please ask our AI.

bfg

BFG is a command line tool used for fast and efficient removal of large files from Git repositories. Its name stands for "BleachBit for Git" as it acts similar to how BleachBit removes unnecessary files from your computer.

The main use of BFG is to remove large files that shouldn't have been added to a Git repository, especially if these files are causing the repository to become bloated. Such large files can slow down repository operations, make cloning and pulling slower, and consume unnecessary disk space.

BFG provides a much faster alternative to the traditional method of using Git's "git filter-branch" to remove files. It operates on the principle of rewriting Git history and permanently removing unwanted objects from the entire commit history of a repository.

Using BFG involves specifying the patterns or file names to be removed, and it applies these removals to all branches and tags in the repository. BFG also automatically updates commit messages and associated branch references to ensure a clean cleansing process.

It's important to note that BFG is a destructive tool, as it modifies the repository's history. Therefore, it should be used with caution and only in cases where large files need to be removed from a Git repository.

List of commands for bfg:

  • bfg:tldr:4ae8e bfg: Remove all text mentioned in the specified file wherever it can be found in the repository's history.
    $ bfg --replace-text ${filename-txt}
    try on your machine
    explain this command
  • bfg:tldr:82051 bfg: Remove a file with sensitive data but leave the latest commit untouched.
    $ bfg --delete-files ${file_with_sensitive_data}
    try on your machine
    explain this command
tool overview