newren/git-filter-repo
Git Filter Repo
Git-filter-repo is a command-line utility designed for the permanent modification and restructuring of Git repository history. It functions as a maintenance tool for cleaning project data, enabling users to reorganize file structures, update commit metadata, and purge sensitive information such as credentials or large blobs from the entire commit graph.
The tool distinguishes itself by interacting directly with the internal Git object database rather than relying on standard command-line interfaces. It utilizes the native fast-import stream protocol and processes commits as a continuous data stream, which allows for efficient in-memory tree transformations and rapid history rewriting even in large repositories.
This utility supports comprehensive version control refactoring, facilitating the migration of legacy projects or the splitting of repositories into smaller components. It provides a systematic approach to maintaining repository security and size by ensuring that historical changes are applied consistently across all commits. The software is distributed as a Python script and is intended for use in automated repository maintenance workflows.
Features
- History Rewriting - Permanently removes sensitive data, reorganizes file structures, and updates commit metadata across entire project histories.
- Git Utilities - Provides a specialized utility for restructuring and cleaning Git repositories during migrations or project splitting.
- Git History Cleaners - Offers a command-line tool for permanently modifying or removing files, directories, and commit metadata from repository history.
- Version Control Utilities - Optimizes Git repository size and security by purging sensitive data and large blobs from the commit history.
- Repository Maintenance - Cleans up large or sensitive files from project history to reduce repository size and improve security.
- Git Workflows - Facilitates the restructuring and cleaning of legacy repositories during complex migration and merging workflows.
- Credential Remediation Workflows - Permanently purges passwords, API keys, and private credentials from every commit in a repository history.
- Version Control and Repository Tools - Modifies commit logs and file structures across entire projects to reorganize code and fix historical mistakes.
- In-Memory Transformation Engines - Performs rapid repository tree transformations entirely in memory to optimize history rewriting performance.
- Fast-Import Protocols - Utilizes the native fast-import stream protocol to efficiently pipe transformed repository objects into a new commit graph.
- Git Object Backends - Interacts directly with the internal Git object database to perform repository history modifications.
- Metadata Rewriters - Updates commit headers and author information by parsing and re-encoding raw commit objects during the migration process.
