Getting Started

What is vibe?

vibe is a CLI tool that simplifies Git Worktree management. It helps you:

• Create worktrees for new features without leaving your main repository
• Automatically copy configuration files and dependencies
• Run setup hooks when creating or cleaning up worktrees
• Safely manage worktree lifecycle with interactive prompts

Quick Start

1. Install vibe

Homebrew

bash brew install kexi/tap/vibe

Deno

bash deno install -A --global jsr:@kexi/vibe

Linux

# Ubuntu/Debian (x64)
curl -LO https://github.com/kexi/vibe/releases/latest/download/vibe_amd64.deb
sudo apt install ./vibe_amd64.deb

# Other distributions (x64)
curl -L https://github.com/kexi/vibe/releases/latest/download/vibe-linux-x64 -o vibe
chmod +x vibe && sudo mv vibe /usr/local/bin/

Windows

Invoke-WebRequest -Uri "https://github.com/kexi/vibe/releases/latest/download/vibe-windows-x64.exe" -OutFile "$env:LOCALAPPDATA\vibe.exe"
# Add to PATH (first time only)
$path = [Environment]::GetEnvironmentVariable("Path", "User")
[Environment]::SetEnvironmentVariable("Path", "$path;$env:LOCALAPPDATA", "User")

2. Set up your shell

Add the following to your shell configuration:

Zsh

# Add to ~/.zshrc
vibe() { eval "$(command vibe "$@")" }

Bash

# Add to ~/.bashrc
vibe() { eval "$(command vibe "$@")"; }

Fish

# Add to ~/.config/fish/config.fish
function vibe
    eval (command vibe $argv)
end

Nushell

# Add to ~/.config/nushell/config.nu
def --env vibe [...args] {
    ^vibe ...$args | lines | each { |line| nu -c $line }
}

PowerShell

# Add to your $PROFILE
function vibe { Invoke-Expression (& vibe.exe $args) }

3. Create your first worktree

# Start working on a new feature
vibe start feat/my-new-feature

# Your terminal is now in the new worktree!
# Make your changes, commit, push, etc.

# When done, clean up the worktree
vibe clean

Basic Workflow

main repository
     │
     ├── vibe start feat/feature-a  →  repo-feat-feature-a/
     │                                      │
     │                                      └── (work on feature)
     │
     └── vibe clean  ←─────────────────────────┘
           (returns to main, removes worktree)

Next Steps

• Installation - Detailed installation instructions
• Shell Setup - Configure your shell
• Configuration - Set up .vibe.toml