merge-ready 0.1.2

Show pull request merge blockers as concise prompt tokens
merge-ready-0.1.2 is not a library.

merge-ready

Crates.io Downloads Docs.rs CI License

merge-ready is a Rust CLI that reports whether the pull request for your current branch is mergeable. It prints concise status tokens designed for shell prompt integration and automation scripts.

Install

cargo install merge-ready

For development builds:

cargo install --path .

Usage

Show top-level help:

merge-ready --help

Show merge status tokens for prompt integration:

merge-ready prompt

Bypass cache and fetch fresh state:

merge-ready prompt --no-cache

Example output:

⚠ review

merge-ready prompt returns:

  • 0 when mergeable (✓ merge-ready)
  • 1 when blocked (⚠ ... or ✗ ...)
  • 2 when state cannot be determined (? ...)

This makes it easy to use from shell scripts and prompt hooks.

Output Tokens

  • ✓ merge-ready - ready to merge
  • ⚠ review - changes were requested in review
  • ⚠ ci-action - CI checks are still in progress
  • ✗ ci-fail - CI checks failed
  • ✗ conflict - merge conflicts exist
  • ✗ update-branch - branch is behind base branch
  • ? sync-unknown - branch sync status is unknown

Requirements

  • gh CLI installed and authenticated
  • Current git branch linked to an existing GitHub pull request

Features

  • Minimal output focused on actionable blockers
  • Prompt-friendly status token output
  • Short-lived caching to reduce GitHub API calls