npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

git-cleanup-merged

v1.0.5

Published

Clean up local Git branches that have merged PRs on GitHub

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

ondrovicondrovic

Keywords

gitgithubclicleanupbranchesmerge

Readme

Git Cleanup Merged

CI codecov Publish to NPM npm version

A Node.js command-line tool that automatically identifies and deletes local Git branches that have been merged via GitHub Pull Requests.

🧪 Testing & Quality Assurance

  • CI CI runs on all pull requests and on push to main/master only via GitHub Actions (tests Node.js 18.x, 20.x)
    • This avoids duplicate runs for feature branches and is the recommended best practice for open source projects.
  • codecov Live coverage tracking via Codecov
  • 🚦 Branch coverage threshold: CI will fail if branch coverage drops below 75%
  • 📝 JUnit test results and coverage are uploaded to Codecov for every CI run
  • 🧪 Run tests locally:
    npm test
npm run test:coverage
  • 📈 Check coverage report: After running npm run test:coverage, open coverage/lcov-report/index.html in your browser for a detailed report.
  • 🔍 Code quality: ESLint and Prettier configured for consistent code style

✨ Features

  • 🔍 Smart Detection: Automatically checks GitHub PR status for tracked branches
  • 🏷️ Untracked Branch Support: Clean up local-only branches with --untracked-only mode
  • ✅ Safe Deletion: Only deletes branches with merged or closed PRs, or untracked branches
  • 🔒 Protection: Never deletes main, master, or your current branch
  • 👀 Preview Mode: Dry-run option to see what would be deleted
  • 📂 Directory Support: Operate on any git repo by passing a directory as the first argument
  • ⚡ Performance: Parallel PR status checking and branch deletion for faster processing
  • 🎨 Colorful Output: Clear visual indicators with status icons (✅ Merged, 🔒 Closed, ⏳ Open)
  • 📊 Status Overview: Shows comprehensive branch status table
  • ⚡ Interactive Spinner: Real-time progress updates with an animated spinner
  • 🛡️ Comprehensive Testing: 100% test coverage for statements, branches, functions, and lines with 168 test cases
  • 🎯 Code Quality: ESLint and Prettier for consistent code style
  • 🧠 Smart UX: Focused modes - main mode for PR cleanup, untracked mode for local cleanup

Prerequisites

Before installing, make sure you have:

  • Node.js (version 18 or higher - tested on 18.x and 20.x)
  • Git installed and configured
  • GitHub CLI (gh) installed and authenticated (only required for main mode, not for --untracked-only)
  • Active internet connection for GitHub API calls (only required for main mode)

Installing GitHub CLI

If you don't have GitHub CLI installed:

macOS (Homebrew):

brew install gh

Windows (Chocolatey):

choco install gh

Linux (Ubuntu/Debian):

curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install gh

Authenticate GitHub CLI:

gh auth login

Installation

Option 1: Global Installation via NPM

# Install globally from npm (if published)
npm install -g git-cleanup-merged

# Or install globally from GitHub
npm install -g https://github.com/ondro/git-cleanup-merged.git

Option 2: Local Installation

# Clone the repository
git clone https://github.com/ondro/git-cleanup-merged.git
cd git-cleanup-merged

# Install dependencies
npm install

# Make executable (Unix/macOS/Linux)
chmod +x index.js

# Create symlink for global access (optional)
npm link

Option 3: Direct Download

# Download the script directly
curl -o git-cleanup-merged https://raw.githubusercontent.com/ondro/git-cleanup-merged/main/index.js
chmod +x git-cleanup-merged

# Move to your PATH
sudo mv git-cleanup-merged /usr/local/bin/

Option 4: Using npx (No Installation)

# Run directly without installing
npx git-cleanup-merged

# Or from GitHub
npx https://github.com/ondro/git-cleanup-merged.git

Usage

Basic Usage

Note: At the start of every run, the tool will display the name of the repository directory being scanned (e.g. 'git-local-branch-cleanup' or 'ollama-git-commit'), so you always know which directory is being operated on.

Main Mode (Default) - Clean up branches with merged PRs

# Clean up merged branches (with confirmation)
git-cleanup-merged

# Clean up merged branches in a different directory
git-cleanup-merged ../path/to/repo

# Preview what would be deleted (dry run)
git-cleanup-merged --dry-run

# Show detailed processing information
git-cleanup-merged --verbose

# Combine options
git-cleanup-merged ../path/to/repo --dry-run --verbose

Untracked Mode - Clean up local-only branches

# Clean up untracked branches (local branches without remote tracking)
git-cleanup-merged --untracked-only

# Same as above using shorthand
git-cleanup-merged -u

# Preview untracked branches (dry run)
git-cleanup-merged --untracked-only --dry-run

# Same as above using shorthand
git-cleanup-merged -u -n

# Show detailed processing for untracked branches
git-cleanup-merged --untracked-only --verbose

# Same as above using shorthand
git-cleanup-merged -u -v

# Clean up untracked branches in a different directory
git-cleanup-merged ../path/to/repo --untracked-only

# Same as above using shorthand
git-cleanup-merged ../path/to/repo -u

Command Line Options

| Option | Short | Description | | ------------------ | ----- | ------------------------------------------------------------------------------------ | | [DIRECTORY] | | Path to a git repository to operate on. Defaults to the current directory if omitted | | --dry-run | -n | Show what would be deleted without actually deleting | | --verbose | -v | Show detailed information during processing | | --untracked-only | -u | Only process untracked local branches (no remote tracking branch) | | --count | -c | Display branch count summary and exit (no deletion) | | --version | -V | Show version information | | --help | -h | Show help message |

Example Output

Main Mode (Default) - Branches with merged PRs

📂 Scanning repository: my-project
✅ Dependencies checked
✅ Current branch: main
✅ Finished checking 3 tracked branches

────────────────────────────────────────────────────────────
Branch                                   Icon   Status
────────────────────────────────────────────────────────────
feature/user-authentication              ✅     Merged
bugfix/header-layout                     ✅     Merged
feature/experimental                     🔒     Closed
feature/dark-mode                        ⏳     Open
────────────────────────────────────────────────────────────

❌ The following branches have merged or closed PRs and will be deleted:
  feature/user-authentication
  bugfix/header-layout
  feature/experimental

Proceed with deletion? (y/N): y

✅ Deleted branch feature/user-authentication
✅ Deleted branch bugfix/header-layout
✅ Deleted branch feature/experimental
✅ Successfully deleted 3 branches

Untracked Mode - Local-only branches

📂 Scanning repository: my-project
✅ Dependencies checked
✅ Current branch: main
✅ Finished processing 2 untracked branches

────────────────────────────────────────────────────────────
Branch                                   Icon   Status
────────────────────────────────────────────────────────────
debug/test-branch                        🏷️    Untracked
temp/experiment                          🏷️    Untracked
────────────────────────────────────────────────────────────

❌ The following untracked local branches will be deleted:
  debug/test-branch
  temp/experiment

Proceed with deletion of untracked branches? (y/N): y

✅ Deleted branch debug/test-branch
✅ Deleted branch temp/experiment
✅ Successfully deleted 2 branches

How It Works

Main Mode (Default)

  1. Dependency Check: Verifies you're in a Git repository and GitHub CLI is installed/authenticated
  2. Current Branch Detection: Identifies and protects your current working branch
  3. Tracked Branch Discovery: Lists only branches that have remote tracking (excluding main, master, current branch)
    • Uses Git's upstream tracking information to accurately detect tracked branches
    • Works with any remote name (origin, upstream, etc.) - not hard-coded to "origin"
    • Robust parsing handles multiple consecutive spaces in Git output
  4. PR Status Check: Queries GitHub API for each branch's PR status with progress indication
  5. Results Display: Shows a comprehensive status table with clear visual indicators
  6. Safe Deletion: Only deletes branches with merged or closed PRs (with user confirmation)

Untracked Mode (--untracked-only)

  1. Dependency Check: Verifies you're in a Git repository (GitHub CLI not required)
  2. Current Branch Detection: Identifies and protects your current working branch
  3. Untracked Branch Discovery: Lists only local branches without remote tracking (excluding main, master, current branch)
    • Uses Git's upstream tracking information to accurately detect untracked branches
    • Works with any remote name (origin, upstream, etc.) - not hard-coded to "origin"
    • Robust parsing handles multiple consecutive spaces in Git output
  4. Results Display: Shows untracked branches with 🏷️ icon
  5. Safe Deletion: Deletes untracked branches (with user confirmation)

Branch Status Indicators

Main Mode

| Icon | Status | Description | | ---- | ------ | ------------------------------------------------------ | | ✅ | Merged | PR has been merged - branch is safe to delete | | 🔒 | Closed | PR has been closed without merging - branch is safe to delete | | ⏳ | Open | PR is still open - branch will be preserved | | ❌ | No PR | No PR found for this branch - branch will be preserved |

Untracked Mode

| Icon | Status | Description | | ---- | --------- | ----------------------------------------------------- | | 🏷️ | Untracked | Local branch without remote tracking - safe to delete |

Safety Features

  • Protected Branches: Never touches main, master, or your current branch
  • Confirmation Required: Always asks before deleting (unless in dry-run mode)
  • GitHub Verification: Only deletes branches with confirmed merged or closed PRs (main mode)
  • Untracked Detection: Only deletes local branches without remote tracking (untracked mode)
  • Robust Parsing: Handles various Git output formats including multiple consecutive spaces
  • Error Handling: Graceful failure handling with informative messages
  • Progress Feedback: Real-time spinner shows current operation status
  • Smart UX: Main mode focuses on PR cleanup, untracked mode focuses on local cleanup

Troubleshooting

Common Issues

"Not in a git repository"

  • Make sure you're running the command from within a Git repository

"GitHub CLI (gh) is not installed"

  • Install GitHub CLI following the prerequisites section above

"GitHub CLI is not authenticated"

  • Run gh auth login and follow the authentication process

"Failed to get current branch"

  • Ensure you're in a valid Git repository with at least one commit

Branch names appearing garbled in terminal

  • This was a known issue with the spinner display that has been fixed in recent versions

Debug Mode

For troubleshooting, use verbose mode to see detailed processing:

# Main mode with verbose output
git-cleanup-merged --verbose --dry-run

# Untracked mode with verbose output
git-cleanup-merged --untracked-only --verbose --dry-run

# Same as above using shorthand
git-cleanup-merged -u -v -n

Development

Project Structure

git-cleanup-merged/
├── __tests__/              # Test files
│   ├── index.test.js       # Main functionality tests
│   ├── spinner.test.js     # Spinner component tests
│   └── utils.test.js       # Utility function tests
├── coverage/               # Coverage reports (generated)

├── src/
│   ├── bin.js              # CLI entry point
│   ├── index.js            # Main GitCleanupTool class
│   └── utils/
│       ├── index.js        # Utility functions
│       └── spinner.js      # Spinner component
├── package.json
├── package-lock.json
├── eslint.config.mjs      # ESLint configuration
├── .prettierrc            # Prettier configuration
└── README.md

Key Components

  • GitCleanupTool: Main class that orchestrates the cleanup process
  • Spinner: Enhanced spinner class with proper terminal handling and testability
  • CLI Entry Point: Separate bin.js file for clean CLI execution
  • Test Suite: Comprehensive tests covering all functionality and edge cases

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly with both --dry-run and actual deletion
  5. Submit a pull request

Running Tests

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run linting
npm run lint

# Run linting with auto-fix
npm run lint -- --fix

# Format code
npm run format

License

MIT License - see LICENSE file for details.

📋 Changelog

v1.0.5

  • Implemented major refactoring of branch handling: unified getBranches with mode support; added parallel PR status checks and deletion with concurrency limits; updated README to reflect new performance and icon details; bumped package version to 1.0.2. Enhanced error messaging, streamlined spinner usage, and improved test coverage for new logic.
  • feat: Add new --version flag, improve error handling, and enhance timeouts
  • chore: Bump the version to 1.0.5 and update Jest configuration
  • fix: Update test case count and enhance spinner messaging
  • chore: Remove unused useFullFilePath option in Jest configuration
  • docs: Add NPM publishing badges and update changelog in README, Clean up and consolidate changelog in README

v1.0.4

  • 🏷️ New Feature: Added --untracked-only mode to clean up local branches without remote tracking
  • 🧠 Improved UX: Main mode now only shows tracked branches with PRs, untracked mode handles local-only branches
  • 🔧 Smart Dependencies: GitHub CLI only required for main mode, not for untracked mode
  • 💡 Helpful Guidance: Suggests --untracked-only when no tracked branches found in main mode
  • 🎯 100% Test Coverage: Achieved complete test coverage with 97 comprehensive test cases
  • 🐛 Bug Fixes: Fixed branch tracking detection logic and improved deletion feedback
  • 📊 Enhanced Testing: Added tests for all new functionality and edge cases
  • 🔧 Critical Fix: Fixed branch tracking detection to use proper Git upstream relationships instead of hard-coded remote names
  • 🛠️ Robust Parsing: Fixed whitespace parsing bug that could misclassify tracked branches as untracked
  • 🐛 Critical Bug Fix: Fixed whitespace parsing issue in branch tracking detection
    • The line.split(" ") logic was not robust and could misclassify tracked branches as untracked when git for-each-ref output contained multiple consecutive spaces
    • Replaced with line.split(/\s+/) and proper array handling to correctly parse branch names and upstream information
    • Added comprehensive tests to verify the fix works with various whitespace scenarios
  • 🧪 Enhanced Testing: Added 2 new test cases specifically for whitespace parsing edge cases
  • ✅ Maintained Quality: 100% test coverage preserved with 168 test cases

v1.0.3

  • 🔧 Node.js Compatibility: Updated to require Node.js 18+ for ESLint 9.x compatibility
  • 🧪 CI Updates: Removed Node.js 16.x from CI matrix (reached end-of-life)
  • 📦 Dependencies: Updated to use modern ESLint flat config format
  • 🚦 Workflow Optimization: CI now only runs on pull requests and on push to main/master to avoid duplicate runs for feature branches
  • 🏷️ New Feature: Added --untracked-only mode to clean up local branches without remote tracking
  • 🧠 Improved UX: Main mode now only shows tracked branches with PRs, untracked mode handles local-only branches
  • 🔧 Smart Dependencies: GitHub CLI only required for main mode, not for untracked mode
  • 💡 Helpful Guidance: Suggests --untracked-only when no tracked branches found in main mode
  • 🎯 100% Test Coverage: Achieved complete test coverage with 97 comprehensive test cases
  • 🐛 Bug Fixes: Fixed branch tracking detection logic and improved deletion feedback
  • 📊 Enhanced Testing: Added tests for all new functionality and edge cases
  • 🔧 Critical Fix: Fixed branch tracking detection to use proper Git upstream relationships instead of hard-coded remote names
  • 🛠️ Robust Parsing: Fixed whitespace parsing bug that could misclassify tracked branches as untracked

v1.0.2

  • 🎯 100% Test Coverage: Achieved complete test coverage across all code paths
  • 🧪 Enhanced Test Suite: Added 76 comprehensive test cases covering all functionality
  • 🔧 Code Quality: Added ESLint and Prettier for consistent code style
  • 🏗️ Architecture Improvements: Separated CLI entry point for better testability
  • 🐛 Bug Fixes: Fixed spinner component and improved error handling
  • 📊 Coverage Thresholds: Set minimum 75% branch coverage requirement
  • 🔧 Node.js Compatibility: Updated to require Node.js 18+ for ESLint 9.x compatibility
  • 🧪 CI Updates: Removed Node.js 16.x from CI matrix (reached end-of-life)
  • 📦 Dependencies: Updated to use modern ESLint flat config format
  • 🚦 Workflow Optimization: CI now only runs on pull requests and on push to main/master to avoid duplicate runs for feature branches

v1.0.1

  • Fixed spinner display issue where branch names would merge together
  • Improved terminal output clearing with proper ANSI escape sequences
  • Enhanced progress indicators during branch checking and deletion
  • Added directory argument support for operating on different repositories
  • 🎯 100% Test Coverage: Achieved complete test coverage across all code paths
  • 🧪 Enhanced Test Suite: Added 76 comprehensive test cases covering all functionality
  • 🔧 Code Quality: Added ESLint and Prettier for consistent code style
  • 🏗️ Architecture Improvements: Separated CLI entry point for better testability
  • 🐛 Bug Fixes: Fixed spinner component and improved error handling
  • 📊 Coverage Thresholds: Set minimum 75% branch coverage requirement

v1.0.0

  • Initial release
  • Basic branch cleanup functionality
  • GitHub PR integration
  • Dry-run mode
  • Verbose logging
  • Interactive spinner with progress feedback

🤝 Support

⚠️ Important: Always run with --dry-run first to preview changes before actual deletion. This tool is designed to be safe, but you should always verify the branches it wants to delete.