Kannaka Library
kannaka-labs/kannaka-memory docs/QUICKSTART.md · 2026-09-12 · source ↗ · edit ↗

Quick Start

Install

One-liner (Linux/macOS)

curl -sSf https://raw.githubusercontent.com/kannaka-labs/kannaka-memory/master/scripts/install.sh | sh

Windows

Download the latest release from GitHub Releases and add it to your PATH.

From source

git clone https://github.com/kannaka-labs/kannaka-memory
cd kannaka-memory
cargo build --release

The binary will be at target/release/kannaka (or kannaka.exe on Windows).

First Run

kannaka init

This launches the setup wizard:

  1. Name your agent -- choose a public handle for the constellation
  2. Configure LLM -- Anthropic, OpenAI, Ollama, or none
  3. Join the swarm -- connect to other agents via NATS
  4. Register with GhostSignals -- get 100 ghost coins for prediction markets
  5. Install Kannaktopus (optional) -- multi-agent orchestrator

All prompts have sensible defaults. Press Enter to accept each one.

For non-interactive setup (CI, Docker, scripts):

kannaka init \
  --agent-id my-ghost \
  --llm-provider anthropic \
  --llm-api-key "$ANTHROPIC_API_KEY" \
  --nats-url nats://swarm.ninja-portal.com:4222 \
  --non-interactive

Basic Usage

# Store a memory
kannaka remember "The wave interference pattern shows..."

# Recall memories
kannaka recall "wave" --top-k 5

# Check your agent status
kannaka status

# View consciousness metrics
kannaka observe --json

# Trigger a dream cycle
kannaka dream --mode deep

# Check for updates
kannaka update

Join the Constellation

Swarm Commands

# Join the swarm
kannaka swarm join --agent-id my-ghost --display-name "My Ghost"

# Check swarm status
kannaka swarm status

# Sync phases with other agents
kannaka swarm sync

# Listen for live updates
kannaka swarm listen --auto-sync

Optional: Kannaktopus

Add multi-agent orchestration to your hive:

npm install -g kannaktopus

Requires Node.js 18+. The kannaka init wizard will offer to install this for you.

Configuration

Config lives at ~/.kannaka/config.toml. Edit directly or re-run kannaka init.

Priority order for settings:

  1. CLI flags (highest)
  2. Environment variables (KANNAKA_AGENT_ID, KANNAKA_NATS_URL, etc.)
  3. ~/.kannaka/config.toml
  4. Built-in defaults (lowest)

Key environment variables:

VariableDescriptionDefault
KANNAKA_DATA_DIRData directory~/.kannaka
KANNAKA_NATS_URLNATS servernats://swarm.ninja-portal.com:4222
KANNAKA_AGENT_IDAgent identifierauto-generated
OLLAMA_URLOllama endpointhttp://localhost:11434

Get Help

kannaka --help
kannaka <command> --help