Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@arielton/shippr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

shippr 🚢

Interactive CLI for finding and merging GitHub PRs quickly.

Features

Interactive TUI for listing and filtering open PRs
View, merge, and manage PRs right from your terminal
Merge options: squash (default), rebase, or merge commit
Option to delete branches after merging
Support for listing PRs across an entire organization
Lightweight Go app that wraps the GitHub CLI

Requirements

Go 1.21+ (if building from source)
GitHub CLI (gh) installed and authenticated:
```
gh auth login
```

Installation

Option A: via npm (Recommended)

# Install globally
npm install -g @arielton/shippr

# Or run directly
npx @arielton/shippr --help

Note: This builds the Go binary using a postinstall script. You'll need Go installed and in your PATH.

Option B: Build from Source

git clone https://github.com/arioberek/shippr
cd shippr
go build -o shippr ./cmd/git-shippr

This creates a shippr binary in the current directory.

Usage

Basic Commands

# Browse PRs for a specific repo
shippr --org <org> --repo <repo>

# Shorthand slug format
shippr <org/repo>

# List open PRs across an organization
shippr list --org <org>

# Disable alt screen (if your terminal clears on exit)
shippr --no-alt --org <org> --repo <repo>

Examples

# Browse PRs in microsoft/vscode
shippr microsoft/vscode

# List PRs in your org
shippr list --org mycompany

# With flags
shippr --org facebook --repo react

Keyboard Shortcuts

Key	Action
`Enter`	Select or confirm
`q` / `Esc` / `Ctrl+C`	Quit
Typing	Filter the list
`↑` / `↓`	Navigate

How It Works

shippr wraps the GitHub CLI (gh) to keep things simple:

Lists PRs with gh pr list
Shows details via gh pr view
Merges using gh pr merge and your chosen method
Deletes branches with the --delete-branch flag if you want

Project Structure

shippr/
├─ cmd/
│  └─ git-shippr/
│     └─ main.go          # Main entry point with Bubble Tea TUI
├─ internal/
│  └─ gh/
│     └─ gh.go            # GitHub CLI wrappers
├─ package.json           # npm config
└─ README.md

Contributing

Fork the repo
Create a feature branch (git checkout -b feature/something-cool)
Commit your changes (git commit -m 'Add something cool')
Push it (git push origin feature/something-cool)
Open a PR

Support

If you encounter any issues or have questions:

Open an issue on GitHub
Check existing issues for solutions
Make sure gh is properly authenticated: gh auth status

Made with ❤️ for developers who love shipping code fast! 🚀