CLI & SDK Reference — v1.4.0

[tyejcoleman]

Complete reference for the Keyoku TypeScript SDK and OpenClaw CLI commands as of v1.4.0.

SDK (@keyoku/memory)

Standalone TypeScript client — no OpenClaw dependency required.

import { KeyokuClient } from '@keyoku/memory';
const client = new KeyokuClient({ baseUrl: 'http://localhost:18900' });

Memory

Method	Description
remember(entityId, content, opts?)	Store a memory
search(entityId, query, opts?)	Semantic search
listMemories(entityId, limit?)	List memories
getMemory(id)	Get single memory
deleteMemory(id)	Delete single memory
deleteAllMemories(entityId)	Clear all for entity
seed(memories[])	Bulk import with full metadata
updateTags(id, tags[])	Update memory tags
sampleMemories(opts?)	Random sample
consolidate()	Trigger memory consolidation

Entities & Stats

Method	Description
listEntities()	All known entity IDs
getStats(entityId)	Per-entity stats
getGlobalStats()	Engine-wide stats (totals, by-type, by-state)

Heartbeat

Method	Description
heartbeatCheck(entityId, opts?)	Check for active signals (deadlines, pending work, decay)
heartbeatContext(entityId, opts?)	Combined heartbeat + context search, optional LLM analysis
recordHeartbeatMessage(entityId, msg, opts?)	Record a heartbeat message

Schedules

Method	Description
createSchedule(entityId, agentId, content, cron)	Create a cron-based schedule
listSchedules(entityId, agentId?)	List active schedules
ackSchedule(memoryId)	Acknowledge a schedule tick
updateSchedule(id, cron, newContent?)	Update cron tag or content
cancelSchedule(id)	Cancel a schedule

Watcher

Method	Description
watcherStatus()	Current watcher state
watcherHistory(opts?)	Recent tick history
watcherStart(entityIds[], opts?)	Start the watcher
watcherStop()	Stop the watcher
watcherWatch(entityId)	Add entity to watcher
watcherUnwatch(entityId)	Remove entity from watcher

Teams

Method	Description
createTeam(name, desc)	Create a team
getTeam(id)	Get team details
deleteTeam(id)	Delete a team
addTeamMember(teamId, agentId)	Add agent to team
listTeamMembers(teamId)	List team members
removeTeamMember(teamId, agentId)	Remove agent from team

Events & Health

Method	Description
subscribeEvents(opts?)	SSE event stream (returns cancel function)
health()	Engine health check

---

OpenClaw CLI Commands

Available when using @keyoku/openclaw plugin. All commands are subcommands of memory.

# Search memories
memory search "what does the user prefer" --limit 10

# List recent memories
memory list --limit 20

# Stats for current entity
memory stats

# Clear all memories
memory clear

# Import markdown memory files
memory import --dir ./workspace
memory import --dry-run

# Migrate OpenClaw vector stores to Keyoku
memory migrate
memory migrate --sqlite path/to/store.sqlite --agent-id my-agent
memory migrate --include-markdown --dry-run

# Watcher status + recent ticks
memory watcher
memory watcher --limit 10

# Heartbeat check
memory heartbeat

# List active schedules
memory schedules

# Health check
memory health