Skip to Content
Setup & Install

Setup & Install

Option 1: npm global install

BASH
npm install -g @kalamdb/cli

Use this when your machine already manages developer tools through Node/npm. The package downloads the matching native release binary during install.

Option 2: install.sh

BASH
curl -fsSL https://kalamdb.org/install.sh | sh

Pin an exact release:

BASH
curl -fsSL https://kalamdb.org/install.sh | sh -s -- --version 0.5.1-beta.2

Install the latest GitHub prerelease:

BASH
curl -fsSL https://kalamdb.org/install.sh | sh -s -- --pre-release

Environment variables for CI:

BASH
curl -fsSL https://kalamdb.org/install.sh | KALAM_VERSION=0.5.1-beta.2 shcurl -fsSL https://kalamdb.org/install.sh | KALAM_PRE_RELEASE=1 shcurl -fsSL https://kalamdb.org/install.sh | KALAM_INSTALL_DIR=/usr/local/bin shcurl -fsSL https://kalamdb.org/install.sh | KALAM_NO_MODIFY_PATH=1 sh
InputEffect
--version <version> or KALAM_VERSIONInstall an exact release. Leading v is accepted.
--pre-release or KALAM_PRE_RELEASE=1Install the latest GitHub prerelease.
KALAM_INSTALL_DIRCustom install directory (default $HOME/.kalam/bin).
KALAM_NO_MODIFY_PATH=1Skip shell profile PATH edits.

Option 3: GitHub release binaries

See Server binaries for prebuilt downloads without a Rust toolchain.

Option 4: Build from source

BASH
cd clicargo build --release./target/release/kalam --help

Verify installation

BASH
kalam --helpkalam versionkalam doctor
  • kalam version — packaged version plus commit, branch, and build timestamp
  • kalam doctor — compact status by default; pass -v for full detail

Self-update

BASH
kalam update

Downloads a verified release archive, verifies SHA256SUMS, and replaces the installed native binary.

When interactive mode starts, the CLI checks for updates. If a newer release exists, it prints a one-time notice and may add an update:<version> segment to the prompt.

KalamDB Skills for coding agents

Load KalamDB commands, SQL syntax, and SDK patterns into Codex, Claude Code, OpenCode, and Agent Skills-compatible tools:

BASH
npx skills add kalamdb/kalamdb-skills

JavaScript package managers (TypeScript projects)

kalam init supports npm, pnpm, yarn, and bun for installing TypeScript starter dependencies. Install any one of them before scaffolding a TypeScript project, or pass --package-manager with kalam init --yes. The choice is stored in kalam.toml as [project].package_manager.

Next

Last updated on
OverviewProject Init