Upgrading
How to update each Keyoku component to the latest version. Your data is always preserved — the engine runs schema migrations automatically on startup.
Keyoku Engine
| Package | keyoku-engine |
| Method | Binary replace |
Steps
- Check your current version:
./keyoku-engine --version - Download the latest binary from GitHub Releases
- Stop the running engine:
kill $(pgrep keyoku-engine) - Replace the binary and restart
One-command upgrade
If you installed via the OpenClaw plugin, run npx @keyoku/openclaw update-engine to download and replace the binary automatically.
Note: Your SQLite database is preserved across upgrades — the engine runs migrations on startup. No data loss.
TypeScript SDK
| Package | @keyoku/memory |
| Method | npm update |
Steps
- Update the package:
npm update @keyoku/memory - Or pin a specific version:
npm install @keyoku/memory@1.4.0
Note: The SDK is a stateless HTTP client — no migrations or config changes needed between versions.
OpenClaw Plugin
| Package | @keyoku/openclaw |
| Method | npm update + engine update |
Steps
- Update the plugin:
npm update @keyoku/openclaw - Update the engine binary:
npx @keyoku/openclaw update-engine - Restart your OpenClaw gateway:
openclaw gateway restart
Note: The plugin and engine are versioned independently. Always update both to avoid compatibility issues.
Keyoku Bot
| Package | @keyoku/bot |
| Method | Docker pull |
Steps
- Pull the latest images:
docker compose pull - Restart the stack:
docker compose up -d
Note: Your .env, IDENTITY.md, and SOUL.md files are preserved. The engine database is stored in a Docker volume and persists across upgrades.
Version compatibility
The engine and SDK/plugin are versioned independently. We recommend keeping both up to date. If you encounter issues after upgrading one component, update the other to match.
| Engine | SDK / Plugin | Status |
|---|---|---|
| 0.4.x | 1.4.x | Latest (recommended) |
| 0.3.x | 1.3.x | Supported |
| 0.1.x–0.2.x | 1.0.x–1.2.x | Legacy — upgrade recommended |
Checking versions
# Engine version
./keyoku-engine --version
# or via API
curl http://localhost:18900/api/v1/health
# SDK / Plugin version
npm list @keyoku/memory @keyoku/openclaw
# Bot version
npm list @keyoku/botRelated
- Changelog — full release history
- Engine Deployment — systemd, Docker, and binary setup
- Plugin Installation — first-time setup wizard