Installation

Prerequisites

Building from source requires:

• Rust stable (latest recommended)
• cmake
• libssl-dev
• pkg-config

On Debian/Ubuntu:

sudo apt install cmake libssl-dev pkg-config

Pre-built binaries

The fastest way to get started. Downloads the latest release for your platform:

curl -fsSL https://raw.githubusercontent.com/heartbit-ai/heartbit/main/install.sh | bash

From source (Git)

Install the CLI directly from the repository:

cargo install --git https://github.com/heartbit-ai/heartbit heartbit-cli

From crates.io

cargo install heartbit-cli

Docker

Pull the official image and optionally start the full stack (Restate + Kafka):

docker pull ghcr.io/heartbit-ai/heartbit:latest

# Full stack with docker compose
docker compose up -d

As a library

Add Heartbit to an existing Rust project:

cargo add heartbit

This gives you the core feature set by default: agent runner, orchestrator, LLM providers, tools, memory, and config.

Feature flags

Enable additional capabilities by selecting feature flags:

Feature	What it enables
core (default)	Agent runner, orchestrator, LLM providers, tools, memory, config
kafka	Kafka consumer/producer
daemon	Daemon with HTTP API, cron, metrics
sensor	7 sensor sources, triage, stories
restate	Durable workflow execution (Restate SDK 0.8)
postgres	PostgreSQL memory + task store
a2a	Agent-to-Agent protocol
telegram	Telegram bot integration
local-embedding	Local ONNX embeddings (no API keys)
full	Everything except local-embedding

Example with specific features:

cargo add heartbit --features postgres,daemon