README
¶
PRojectPilot is a fast, lightweight CLI designed to help you manage GitHub pull requests directly from your terminal. It streamlines your workflow by automating PR creation with templates, auto-generated changelogs, and smart defaults—letting you get back to coding faster.
Key Features
- Instant PR Creation: Create pull requests from your current branch with a single command.
- Automated Changelogs: Automatically injects a list of commits into your PR body.
- Templating: Support for markdown templates to keep your PRs consistent.
- Flexible Workflow: Add assignees and labels via flags or interactive prompts.
- Safety First: Use Dry-run mode to preview your PR payload before hitting the API.
- Customisable: Configure your preferences via
.envor a global~/.prpilot.yaml.
Installation
From Source
Ensure you have Go(lang) installed on your system.
Option 1: Using Makefile (Recommended)
make install
Option 2: Using Go directly
go install github.com/dmx3377/prpilot/cmd/prpilot@latest
Note: Ensure your $GOPATH/bin (usually ~/go/bin) is in your system's PATH.
Quickstart
-
Configure your GitHub Token: Provide a token with
reposcope. You can set it in a.envfile or export it:export GITHUB_TOKEN=your_token_here -
Create your first PR: From any feature branch, simply run:
prpilot pr create --title "Fix: Resolve widget alignment" --labels bug,urgent
Configuration
- Environment: Uses
GITHUB_TOKEN(supports.envfiles). - Global Config:
~/.prpilot.yaml(overridable with--config). - Base Branch: Defaults to
main(or auto-detected common branches).
Common Examples
-
Interactive Mode: If you omit flags, PRojectPilot will prompt you for missing details:
prpilot pr create -
Using a Template:
prpilot pr create --template ./templates/pr.md.tpl --assignees david --labels ready-for-review -
Preview Changes (Dry Run):
prpilot pr create --dry-run
Development
To contribute or build locally:
- Build locally:
make build - Run tests:
make test - Lint code:
make lint
License
Licensed under the Apache License 2.0 — see LICENSE
Directories