Installation

Package Managers

Homebrew (macOS)

brew install kexi/tap/vibe

npm (Node.js)

# Global install
npm install -g @kexi/vibe

# Or run directly with npx
npx @kexi/vibe start feat/my-feature

Note

@kexi/vibe is a thin launcher. On install, npm pulls in the matching per-platform package (@kexi/vibe-<platform>-<arch>) via optionalDependencies and runs the Rust binary it ships. Copy-on-Write file cloning (macOS APFS, Linux Btrfs/XFS) is built into that binary.

Bun

# Global install
bun add -g @kexi/vibe

# Or run directly with bunx
bunx @kexi/vibe start feat/my-feature

Note

Requires Bun 1.2.0 or later. @kexi/vibe is a thin launcher: it pulls in the matching per-platform package (@kexi/vibe-<platform>-<arch>) via optionalDependencies and runs the Rust binary it ships. Copy-on-Write file cloning (macOS APFS, Linux Btrfs/XFS) is built into that binary.

mise

Add to your .mise.toml:

[plugins]
vibe = "https://github.com/kexi/mise-vibe"

[tools]
vibe = "latest"

Then run:

mise install

Tip

You can skip manual shell setup by using vibe shell-setup with mise hooks. See automatic setup for details.

Nix

# Run directly (ephemeral)
nix run github:kexi/vibe -- start feat/my-feature

# Install persistently
nix profile install github:kexi/vibe

For NixOS or Home Manager, add as a flake input:

{
  inputs.vibe.url = "github:kexi/vibe";

  # Then use in your configuration:
  # environment.systemPackages = [ inputs.vibe.packages.${system}.default ];
}

Note

The default package (packages.default / .#fromSource) is built from source for reproducibility. If you prefer the prebuilt release binary (skips compiling, verified with SHA-256 hashes), use packages.binary:

nix run github:kexi/vibe#binary -- start feat/my-feature

Linux

Note

WSL2 users can use the Linux installation methods below based on their distribution.

Ubuntu/Debian

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

# ARM64
curl -LO https://github.com/kexi/vibe/releases/latest/download/vibe_arm64.deb
sudo apt install ./vibe_arm64.deb

# Uninstall
sudo apt remove vibe

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/

# ARM64
curl -L https://github.com/kexi/vibe/releases/latest/download/vibe-linux-arm64 -o vibe
chmod +x vibe
sudo mv vibe /usr/local/bin/

Windows

Windows (x64) is supported. Install via npm — the @kexi/vibe launcher pulls in the @kexi/vibe-win32-x64 binary package for your platform:

npm install -g @kexi/vibe

Note

Copy-on-Write cloning is not available on Windows; vibe falls back to a standard file copy when creating worktrees. Everything else (commands, flags, the trust model) works the same as on Linux and macOS.

Tip

You can also run vibe under WSL2 with the Linux instructions above — useful if you want Copy-on-Write on a Btrfs volume — or build from source with the Rust toolchain.

Manual Build

With the Rust toolchain installed, build the binary from source:

git clone https://github.com/kexi/vibe.git
cd vibe
cargo build --manifest-path rust/Cargo.toml -p vibe --release
# Binary is written to rust/target/release/vibe

Next Steps

After installation, set up your shell to enable vibe’s directory changing functionality.