Developerayo/git-history-cleaner

User-friendly tool to generate customizable scripts for clearing git repository history while preserving your current files.

โ˜… 0Forks 0GitHub โ†—Compare

Project website โ†—

README

๐Ÿงน Git History Cleaner

A user-friendly tool to generate customizable scripts for clearing git repository history while preserving your current files.

Deploy to GitHub Pages

๐Ÿš€ Live Demo

Try it out: https://andreagriffiths11.github.io/git-history-cleaner/

โœจ Features

  • Safe Script Generation - Creates customized bash scripts with proper safety checks
  • Backup Options - Automatically includes backup creation commands
  • Command Explanations - Learn what each git command does in plain English
  • Multiple Output Formats - Copy to clipboard, download as .sh file, or view inline
  • Input Validation - Sanitizes repository names and prevents common errors
  • Customizable - Configure branch names and safety options

๐Ÿ› ๏ธ Local Development

Prerequisites

  • Node.js 20 or higher
  • npm

Setup

# Clone the repository
git clone https://github.com/AndreaGriffiths11/git-history-cleaner.git
cd git-history-cleaner

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

๐Ÿ“ฆ Tech Stack

  • React 19 - UI framework
  • TypeScript - Type safety
  • Vite - Build tool
  • Tailwind CSS - Styling
  • Radix UI - Accessible component primitives
  • Phosphor Icons - Icon library
  • Sonner - Toast notifications

๐Ÿ”’ Safety First

This tool generates scripts that permanently delete git history. Always:

  • โœ… Create backups before running any generated scripts
  • โœ… Review and understand each command
  • โœ… Get team approval for shared repositories
  • โœ… Test on a copy of your repository first

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


Built with โค๏ธ & ๐Ÿค–

Contributors

AndreaGriffiths11dependabot[bot]

Issues