Getting Started
gh-vibe is a gh extension that turns a GitHub
pull request or issue into a vibe worktree,
ready for review or local development.
1. Install prerequisites
Section titled “1. Install prerequisites”You will need:
gh— the GitHub CLI, authenticated (gh auth login).git— installed and onPATH.vibe— the worktree manager that gh-vibe drives.
2. Install gh-vibe
Section titled “2. Install gh-vibe”gh extension install kexi/gh-vibeThis downloads the prebuilt binary for your platform from the latest GitHub
Release and registers it as a gh subcommand.
3. (Optional) Enable shell auto-cd
Section titled “3. (Optional) Enable shell auto-cd”Without this step, gh vibe review prints the worktree path and exits — you
have to cd there yourself. With the snippet installed, your shell follows
along automatically:
# ~/.bashrc or ~/.zshrceval "$(gh vibe shell-setup)"
# fish — ~/.config/fish/config.fishgh vibe shell-setup --shell=fish | source
# PowerShell — $PROFILEgh vibe shell-setup --shell=pwsh | Out-String | Invoke-ExpressionReload your shell, then:
gh vibe review 123 # creates the worktree AND cd's you into it4. Review your first PR
Section titled “4. Review your first PR”From inside a git repository whose origin remote points at the PR’s base
repo:
gh vibe review 123# orgh vibe review https://github.com/owner/repo/pull/123To preview what would happen without making any changes:
gh vibe review 123 --dry-run5. Start work on an issue
Section titled “5. Start work on an issue”Turn an issue into a worktree on a fresh branch named from the issue’s labels and title:
gh vibe issue 42The branch name has the shape <type>/<num>-<slug> — see
gh vibe issue for the full label-to-type table and the
--type / --base / --dry-run flags.
Read on for the full command reference.