Skip to content

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.

You will need:

  • gh — the GitHub CLI, authenticated (gh auth login).
  • git — installed and on PATH.
  • vibe — the worktree manager that gh-vibe drives.
Terminal window
gh extension install kexi/gh-vibe

This downloads the prebuilt binary for your platform from the latest GitHub Release and registers it as a gh subcommand.

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:

Terminal window
# ~/.bashrc or ~/.zshrc
eval "$(gh vibe shell-setup)"
# fish — ~/.config/fish/config.fish
gh vibe shell-setup --shell=fish | source
# PowerShell — $PROFILE
gh vibe shell-setup --shell=pwsh | Out-String | Invoke-Expression

Reload your shell, then:

Terminal window
gh vibe review 123 # creates the worktree AND cd's you into it

From inside a git repository whose origin remote points at the PR’s base repo:

Terminal window
gh vibe review 123
# or
gh vibe review https://github.com/owner/repo/pull/123

To preview what would happen without making any changes:

Terminal window
gh vibe review 123 --dry-run

Turn an issue into a worktree on a fresh branch named from the issue’s labels and title:

Terminal window
gh vibe issue 42

The 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.