ghprmerge

ghprmerge

A command-line tool to evaluate, merge, rebase, or close GitHub pull requests sharing the same source branch across an organization.

Use case: merging automated dependency update pull requests (e.g., Dependabot) without requiring clicking through each repository individually.

Quick Start

# Set your GitHub token
export GITHUB_TOKEN=ghp_xxxxxxxxxxxx

# Optionally set the org as an environment variable (or use --org)
export GITHUB_ORG=myorg

# Check version
ghprmerge --version

# Show help with subcommand descriptions
ghprmerge --help

# Rebase out-of-date branches
ghprmerge rebase --org myorg --source-branch dependabot/

# Merge ready PRs (that are already up-to-date)
ghprmerge merge --org myorg --source-branch dependabot/

# Close matching PRs without merging them
ghprmerge close --org myorg --source-branch stale/

# Delete source branches after successfully closing their PRs
ghprmerge close --org myorg --source-branch stale/ --delete-source-branch

# PRs with no checks configured are allowed; pending checks still block merging

# Merge PRs even if behind (skip rebase requirement)
ghprmerge merge --org myorg --source-branch dependabot/ --skip-rebase

# Wait at least 30 seconds between merge requests (or set GHPRMERGE_MIN_MERGE_DELAY=30)
ghprmerge merge --org myorg --source-branch dependabot/ --min-merge-delay 30

# Match multiple source branches
ghprmerge merge --org myorg --source-branch dependabot/ --source-branch feature/

# Filter by author (e.g. only Dependabot PRs opened by the app)
ghprmerge merge --author 'dependabot[bot]' --org myorg --source-branch dependabot/

# Close PRs opened by a specific author
ghprmerge close --author JaredHatfield --org myorg --source-branch stale/

# Use --confirm to review pending actions before taking action
ghprmerge rebase --org myorg --source-branch dependabot/ --confirm

# Stream all repo results as they are scanned
ghprmerge merge --verbose --org myorg --source-branch dependabot/

# Disable colored output
ghprmerge merge --no-color --org myorg --source-branch dependabot/

# Report mode: group open PRs by source branch
ghprmerge report --org myorg

# Report with prefix filter and JSON output
ghprmerge report --json --org myorg --source-branch-prefix dependabot/

# Report with minimum group size
ghprmerge report --org myorg --min-group-size 3

Documentation

• Purpose & Philosophy - Design goals and safety model
• Usage Guide - Complete command-line reference
• Examples - Practical workflows
• Merge Command - Merge subcommand details
• Rebase Command - Rebase subcommand details
• Close Command - Close subcommand details
• Report Command - Report subcommand details
• Installation - Installation instructions

License

MIT License - see LICENSE for details.