@theclawlab/agent
v1.0.8
Published
Agent runtime and lifecycle management for TheClaw platform.
Downloads
31
Readme
agent
A CLI tool for managing autonomous AI agents in TheClaw — each agent has an inbox thread, an LLM identity, and a routing table that maps incoming messages to conversation threads.
How it works
- Initialize an agent with
agent init <id>— creates the directory structure, config, and inbox thread. - Start the agent with
agent start <id>— registers an inbox subscription sonotifiercan triggeragent runon new messages. - When a message arrives in the inbox,
notifierdispatchesagent run <id>— which routes the message to the right thread, calls the LLM viapai chat, and writes the reply back. - Outbound replies are delivered by
agent deliver— which reads from the thread and callsxgw send(external) orthread push(internal).
Install
From npm
npm install -g @theclawlab/agentFrom source
npm run build && npm linkQuick start
# Initialize a new agent
agent init my-agent --kind user
# Start the agent (registers inbox subscription)
agent start my-agent
# Check status
agent status my-agent
# Simulate an incoming message (for testing)
agent send my-agent \
--source xgw:telegram:user42 \
--type message \
--content '{"text":"hello","reply_context":{"channel_type":"external","channel_id":"telegram","peer_id":"user42"}}'
# Interactive debug chat (bypasses inbox/notifier, calls LLM directly)
agent chat my-agent
# Stop the agent
agent stop my-agentCommands
| Command | Description |
|---------|-------------|
| agent init <id> | Initialize a new agent directory |
| agent start <id> | Register inbox subscription (enable dispatch) |
| agent stop <id> | Unregister inbox subscription (pause, keep state) |
| agent status [<id>] | Show agent status (or list all agents) |
| agent list | List all initialized agents |
| agent send <id> | Push a message into the agent's inbox (debug) |
| agent chat <id> | Interactive LLM chat, bypasses full pipeline (debug) |
| agent run <id> | Process inbox messages — called by notifier, not manually |
| agent deliver | Deliver outbound replies — called by thread dispatch, not manually |
Data directory
Default: ~/.theclaw/agents/<id>/ — override root with THECLAW_HOME.
~/.theclaw/agents/<id>/
├── IDENTITY.md # agent system prompt
├── USAGE.md # usage notes for the agent itself
├── config.yaml # LLM provider, routing, outbound config
├── inbox/ # inbox thread (SQLite-backed)
├── sessions/ # pai chat session files (per thread)
├── memory/ # persistent memory files
├── threads/ # per-peer/channel/agent conversation threads
├── workdir/ # scratch space
└── logs/ # agent run logsDependencies
Requires the following tools to be installed and on PATH:
pai— LLM CLI (pai chat)thread— event queue CLInotifier— task scheduler daemonxgw— communication gateway (for external channel delivery)
Documentation
- USAGE.md — full CLI reference, config format, and data directory details
