Installation

KanVibe is distributed as a macOS desktop app. The recommended install path is Homebrew Cask.

Prerequisites

Dependency	Required	Why it is needed	Install example
Git	Required	Branch and worktree creation/cleanup	`brew install git`
tmux	Recommended	Default session backend. Not needed if you switch the session type to `terminal`	`brew install tmux`
GitHub CLI `gh`	Required	PR URL lookup and GitHub workflows	`brew install gh`, then `gh auth login`
zellij	Optional	Alternative session backend	`brew install zellij`

To work without a multiplexer, choose the terminal session type. KanVibe then owns that shell directly, so running work disappears when the app quits or a remote connection drops. Install tmux or zellij if you plan to leave long-running work unattended.

Install with Homebrew

brew install --cask rookedsysc/kanvibe/kanvibe
open -a KanVibe

After KanVibe is accepted into the official Homebrew Cask repository, the command becomes:

brew install --cask kanvibe

Update or remove

brew update
brew upgrade --cask kanvibe

brew uninstall --cask kanvibe
brew untap rookedsysc/kanvibe

First-run checklist

1. Register a project

Click the board toolbar’s magnifying-glass directory scan button and pick a local or remote git repository. KanVibe scans existing worktree branches.

2. Confirm session type

Use tmux by default, switch the default session type if you prefer zellij, or choose terminal to skip multiplexers entirely.

3. Allow notifications

Enable system notifications so AI agent hook status changes are visible immediately.