Skip to content

gabsrodrigues-dev/pr-ship

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pr-ship

Create and merge GitHub Pull Requests from the terminal in one command.

Installation

Option 1: Via PPA (apt-get)

sudo add-apt-repository ppa:gabsrodrigues-dev/pr-ship
sudo apt-get update
sudo apt-get install pr-ship

Option 2: Quick install (from source)

git clone https://github.com/gabsrodrigues-dev/pr-ship.git
cd pr-ship
sudo bash install.sh

Option 3: Debian package (.deb)

git clone https://github.com/gabsrodrigues-dev/pr-ship.git
cd pr-ship
bash build-deb.sh
sudo dpkg -i build/pr-ship_1.0.2.deb

Option 4: Makefile

sudo make install

Prerequisites

  • bash >= 4.0
  • gh (GitHub CLI) — installed and authenticated (gh auth login)

Setup

After installing, run the interactive setup:

pr-ship --setup

This will ask you:

  1. Language — auto-detects your system language (falls back to English)
  2. Default GitHub owner — your username or org (e.g. gabsrodrigues-dev)
  3. Default head branch — source branch (default: development)
  4. Default base branch — target branch (default: sandbox)
  5. Default PR title — optional custom title
  6. Default PR body — optional custom body

Config is saved at ~/.config/pr-ship/config.

Usage

pr-ship <repo> [head] [base] [--title "..."] [--body "..."]

Examples

# Uses configured owner, default branches
pr-ship my-repo

# Custom branches
pr-ship my-repo feature/login main

# Full owner/repo
pr-ship gabsrodrigues-dev/my-repo development sandbox

# Custom title and body
pr-ship my-repo --title "Release v2.0" --body "Production release"

Flags

Flag Description
--setup Run interactive setup
--title "..." Custom PR title
--body "..." Custom PR body
--help Show help
--version Show version

Languages

pr-ship auto-detects your system language. Supported:

  • en — English
  • pt_BR — Português (Brasil)
  • es — Español
  • fr — Français
  • de — Deutsch
  • it — Italiano

To add a new language, create a file at /usr/share/pr-ship/lang/<locale>.sh following the existing format.

Publishing to PPA

To distribute via sudo apt-get install pr-ship:

  1. Create a Launchpad account
  2. Create a PPA at https://launchpad.net/~YOUR_USER/+activate-archive
  3. Set up GPG key and upload it to Ubuntu keyserver
  4. Build the source package:
export DEBEMAIL="your@email.com"
export DEBFULLNAME="Your Name"
debuild -S -sa
  1. Upload to your PPA:
dput ppa:YOUR_USER/pr-ship ../pr-ship_1.0.2-1_source.changes

Users can then install with:

sudo add-apt-repository ppa:YOUR_USER/pr-ship
sudo apt-get update
sudo apt-get install pr-ship

Uninstall

# If installed via install.sh or make
sudo bash uninstall.sh
# or
sudo make uninstall

# If installed via .deb
sudo apt-get remove pr-ship

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors