Skip to Content
QuickstartInstall the CLI

Setup & Install

Option 1: release installer

BASH
curl -fsSL https://kalamdb.org/install.sh | bash -s -- --version 0.8.0

This downloads the matching native 0.8 CLI archive and verifies its checksum. The npm @kalamdb/cli package currently resolves to 0.7.0-beta.0, so it is not suitable for a 0.8 server.

Option 2: latest release with install.sh

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

Pin an exact release when you need reproducible installations:

install.sh pinned versionBASH
curl -fsSL https://kalamdb.org/install.sh | sh -s -- --version 0.8.0

Install the newest published pre-release (rc, beta, or alpha):

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

Environment variables for CI:

install.sh environment variablesBASH
curl -fsSL https://kalamdb.org/install.sh | KALAM_VERSION=0.8.0 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 newest published pre-release (rc, beta, or alpha) by version, not GitHub’s prerelease flag.
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

kalam updateBASH
kalam updatekalam update --pre-releasekalam update --stablekalam update --version 0.8.0

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

CommandVersion selectedDowngrade
kalam updateGitHub’s latest non-draft releaseNever. Skips if the installed CLI is newer.
kalam update --pre-releaseNewest published rc, beta, or alpha by version, including GitHub releases that are not flagged as prereleasesNever. Skips if the installed CLI is newer.
kalam update --stableSame GitHub latest as kalam updateAllowed only when the installed CLI is itself a pre-release, so you can leave that channel.
kalam update --version <version>That exact versionAllowed. --version cannot be combined with --pre-release or --stable.

--force reinstalls the same version (for a newer build of that tag). It does not override the no-downgrade rule. --dry-run prints the resolved target without replacing the 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

Docker & Auth SetupLocal Development