Skip to content
VibeKit is in alpha. The packages are unstable and not ready to build on — APIs will break without notice.

Installation

The installer downloads two binaries: the vibekit CLI and the vibekit-tui Explorer sidecar. The Explorer is not optional — vibekit explore resolves the sidecar as a sibling of the CLI binary, so both land in the same directory.

There is no stable release yet, so every install below sets the alpha channel. Once 1.0.0 ships you can drop it.

The CLI and the Explorer are self-contained binaries — nothing else is needed to install them or to read the chain. Signing and building do have prerequisites.

ForYou need
Browsing the chain — queries, the Explorer, vibekit newNothing
Signing anything — payments, assets, deploysNode.js, plus npm once
Building a project — compiling and testing contractsNode.js 24+
LocalNetDocker Compose v2
The keystore, on LinuxA Secret Service keychain
The keystore, on WindowsVisual C++ Redistributable (winget install Microsoft.VCRedist.2015+.x64)

Signing needs Node because the keystore daemon is a Node program; vibekit keystore provisions the pinned @algorandfoundation/keystore-node with npm the first time. Building needs it because the starter templates declare engines: node >=24 and run puya-ts, tsx, and vitest.

vibekit doctor reports what is missing without changing anything.

Terminal window
curl -fsSL https://getvibekit.ai/alpha | sh

/alpha is the same script as /install with the channel pre-set, so the one-liner stays short. The explicit form is equivalent:

Terminal window
curl -fsSL https://getvibekit.ai/install | VIBEKIT_CHANNEL=alpha sh

Installs to ~/.local/bin. If that is not on your PATH, the installer prints the line to add for your shell.

Terminal window
irm https://getvibekit.ai/alpha.ps1 | iex

/alpha.ps1 is /install.ps1 with the channel pre-set. The explicit form is equivalent:

Terminal window
$env:VIBEKIT_CHANNEL = "alpha"; irm https://getvibekit.ai/install.ps1 | iex

Installs to ~\.vibekit\bin and adds that directory to your user PATH automatically. Restart your terminal for the change to take effect.

Both installers read the same environment variables.

VariableMeaning
VIBEKIT_VERSIONInstall a specific tag, e.g. v1.0.0-alpha.2
VIBEKIT_CHANNELstable (default), alpha, or beta
VIBEKIT_INSTALL_DIROverride the install directory
VIBEKIT_FORCE_INSTALLReplace an existing install without prompting

Upgrading over an existing install prompts for confirmation. When you are piping the installer into a shell with no terminal attached — CI, a container, a provisioning script — set VIBEKIT_FORCE_INSTALL=1 so it does not try to prompt.

A specific version, on either platform:

Terminal window
curl -fsSL https://getvibekit.ai/install | VIBEKIT_VERSION=v1.0.0-alpha.2 sh
Terminal window
$env:VIBEKIT_VERSION = "v1.0.0-alpha.2"; irm https://getvibekit.ai/install.ps1 | iex

Download both binaries for your platform from GitHub Releases, put them in the same directory on your PATH, and rename them to vibekit and vibekit-tui (.exe on Windows). On macOS and Linux, chmod +x both.

Terminal window
vibekit --version
vibekit doctor

doctor reports what is missing — Docker for LocalNet, the keystore daemon for signing — without changing anything. vibekit doctor --fix is the opt-in repair path.

You do not need the released binaries to work on VibeKit itself. From a clone, with Bun 1.4 or newer:

Terminal window
bun install
bun run cli -- --help

For example, scaffold a project with:

Terminal window
bun run cli -- new my-algorand-app --template contracts

The Explorer is a separate terminal application. Start it from the repository root:

Terminal window
bun run tui

bun run cli -- explore also works; set VIBEKIT_EXPLORE to point it at a specific TUI entry.