Installation

The fastest way to install @keyoku/openclaw is the setup wizard. One command handles everything — binary download, plugin registration, LLM configuration, and health verification.

Requirements

Dependency	Version
Node.js	>= 20
OpenClaw	Installed and configured
Platform	macOS (arm64/x64), Linux (arm64/x64), Windows (x64)

Quick install

Run the interactive setup wizard. It will walk you through every step.

npx @keyoku/openclaw init

What the wizard does

The wizard runs 11 steps in sequence.

Step 1

Detect OpenClaw

Locates your OpenClaw installation and verifies the version is compatible.

Step 2

Install engine binary

Downloads the correct keyoku-engine binary for your platform to ~/.keyoku/bin/.

Step 3

Register plugin

Registers keyoku-memory in the plugins.entries block of openclaw.json and assigns it to the memory slot.

Step 4

Configure storage

Sets the SQLite database path. Default: ~/.keyoku/data/keyoku.db.

Step 5

LLM provider setup

Configures embedding provider (Gemini, OpenAI, or Ollama) and extraction provider (Gemini, OpenAI, Anthropic, or Ollama) with model selection and API keys.

Step 6

Autonomy level

Sets the initial autonomy mode: observe, suggest, or act.

Step 7

Timezone & quiet hours

Configures your timezone and quiet hours window for heartbeat suppression.

Step 8

Disable OpenClaw heartbeat

Turns off OpenClaw's built-in heartbeat so Keyoku's 14-signal scan takes over.

Step 9

Install SKILL.md

Writes the SKILL.md file that teaches the LLM how to use memory naturally.

Step 10

Migrate existing memories

If OpenClaw has existing memory data, offers to import it into Keyoku's store.

Step 11

Health check

Starts the engine, verifies /api/v1/health responds, and confirms all hooks are registered.

Manual install

If you prefer to configure things yourself, install the package directly and register it in your OpenClaw config.

1. Install the package

npm install @keyoku/openclaw

2. Register in openclaw.json

Add the plugin to the plugins.entries block in your openclaw.json and assign it to the memory slot.

{
  "plugins": {
    "entries": {
      "keyoku-memory": {
        "enabled": true,
        "config": {
          "keyokuUrl": "http://localhost:18900",
          "autoRecall": true,
          "autoCapture": true,
          "heartbeat": true,
          "topK": 5
        }
      }
    },
    "slots": {
      "memory": "keyoku-memory"
    }
  }
}

3. Restart the gateway

Reload OpenClaw so the plugin hooks are registered and the engine sidecar starts.

openclaw gateway restart

After install

Once installed, the plugin will automatically start the Keyoku Engine as a sidecar process. You can verify the installation by checking the engine health endpoint.

curl http://localhost:18900/api/v1/health

See Configuration to customize behavior, or Hooks & Tools for the full hook and tool reference.