docs / start

Installation

Install the botdb CLI, verify it, and set up shell completions.

botdb is one binary, botdb, with SQLite bundled. There is no daemon or runtime to set up, and botdb login creates your botdb cloud account for you. The same binary runs the relay (botdb relay) and the MCP server (botdb mcp).

Install script

On macOS (Apple silicon) and Linux (x86_64 and arm64, static binaries):

curl -fsSL https://botdb.dev/install.sh | sh

It downloads the binary from the same site, checks its SHA-256 checksum and puts it in ~/.local/bin (set BOTDB_INSTALL_DIR to choose another directory). Make sure that directory is on your PATH.

From source

On other platforms (Intel Macs, Windows), build it with a Rust toolchain (1.89 or newer). The repository is private for now, so this needs access to it:

cargo install --git https://github.com/vimtor/botdb botdb-cli

This builds the botdb binary and puts it in ~/.cargo/bin.

Release packages (planned)

Tagged releases will also publish binaries for Intel Macs and Windows, with:

shell and PowerShell install scripts
a Homebrew formula
an npm package (npx @vimtor/botdb-cli)
the relay Docker image, ghcr.io/vimtor/botdb-relay

Verify

botdb --version
botdb doctor

botdb doctor checks the setup and explains anything that needs attention. Before you log in, it reports that there is no vault yet.

Shell completions

botdb completions <shell> prints a completion script for bash, elvish, fish, powershell or zsh.

# zsh: put the script in a directory on $fpath
botdb completions zsh > ~/.zfunc/_botdb

# bash
botdb completions bash > ~/.local/share/bash-completion/completions/botdb

# fish
botdb completions fish > ~/.config/fish/completions/botdb.fish

Continue with the Quickstart.