1.5 KiB
1.5 KiB
Setup & Usage
Prerequisites
- Node.js installed.
- API Keys:
OPENROUTER_API_KEY(for Primary Model & Embeddings).ANTHROPIC_API_KEY(for Fallback Model).SERPER_API_KEY(for Web Search).
Configuration "Gotchas"
- Global Config:
mcporter.jsonMUST reside in~/.clawdbot/mcporter.jsonfor the global agent to detect MCP servers. - Memory Sync: Requires an OpenAI-compatible embedding endpoint. We use OpenRouter (
text-embedding-3-small) configured inclawdbot.json. - Search: If MCP fails (
mcp.localerrors), use the native fallback script:node tools/search.js.
Installation
- Navigate to the project root.
- Install dependencies:
npm install
Bootstrapping a New Agent
- Read
BOOTSTRAP.mdif it exists.- Follow the instructions to initialize your identity.
- Delete
BOOTSTRAP.mdonce complete.
- Edit
IDENTITY.mdto define your name, avatar, and vibe. - Edit
TOOLS.mdto configure local environment specifics (cameras, etc.).
Running
- Canvas UI: Open
canvas/index.htmlin a browser or a compatible mobile web view wrapper to test the interface. - Agent Logic: The agent logic is primarily driven by the LLM reading the context files (
AGENTS.md,MEMORY.md, etc.). There is no single "start" script defined inpackage.jsonby default, suggesting this workspace is context for an external runner or a custom script (not yet present or external to this repo).