Keyoku
Docs / Bot / Overview

@keyoku/bot

A ready-to-run AI bot with Keyoku memory and heartbeat built in. Supports Telegram, Discord, and API-only mode. Runs via Docker Compose with OpenClaw gateway and Keyoku engine in one stack.

One command to init. Zero config for memory. Personality via markdown files.

One command to get running.

The init wizard checks prerequisites, then asks for your LLM provider, model, API keys, extraction and embedding config, and channel setup. It generates Docker Compose config, environment files, and personality templates — then optionally starts the stack immediately.

# Initialize a new bot project
npx @keyoku/bot init

# Start the stack
docker compose up -d

# Check health
npx @keyoku/bot status
What you get

Memory + heartbeat, no assembly required.

@keyoku/bot bundles the full Keyoku stack into a single deployable unit. Every feature works out of the box.

Memory out of the box

Keyoku engine runs alongside your bot. Every conversation is captured, deduplicated, and stored automatically.

Heartbeat active by default

The 14-signal heartbeat scan runs on every tick.

Your bot can proactively reach out about deadlines, stalled tasks, and sentiment shifts — pure SQL per tick — LLM only for analysis.

Telegram + Discord + API

Ship to Telegram or Discord with platform-native integration. Or run in API-only mode for custom frontends.

One-command setup

Run npx @keyoku/bot init and the interactive wizard handles everything.

Configures LLM provider, channel config, API keys, and Docker stack in one pass.

Docker Compose stack

OpenClaw gateway + Keyoku engine in one stack.

docker compose up -d and you're live. No infra management.

Personality files

Customize your bot's identity with IDENTITY.md and behavior rules with SOUL.md.

Plain markdown, version-controlled, hot-reloadable.

Architecture

The stack.

@keyoku/bot is a thin orchestration layer. The real work happens in OpenClaw (agent framework) and Keyoku (memory engine). Docker Compose ties them together.

Channel

Telegram, Discord, or API-only

Gateway

OpenClaw (AI agent framework)

Memory

Keyoku engine (Go, SQLite, HNSW)

LLM

OpenAI, OpenAI (ChatGPT subscription), Anthropic, or Gemini

Runtime

Docker Compose (single stack)

Next steps

Dive deeper.