diff --git a/README.md b/README.md index fed5057..22fbc99 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ cargo run --release -- integrations list Every subsystem is a **trait** — swap implementations with a config change, zero code changes.

- ZeroClaw Architecture + ZeroClaw Architecture

| Subsystem | Trait | Ships with | Extend | diff --git a/docs/architecture.svg b/docs/architecture.svg index 8dcfb77..95d8a92 100644 --- a/docs/architecture.svg +++ b/docs/architecture.svg @@ -1,4 +1,4 @@ - + @@ -11,239 +11,299 @@ + + + + + + + + + + - + - ZeroClaw Architecture - Zero overhead. Zero compromise. 100% Rust. 100% Agnostic. + ZeroClaw Architecture + Zero overhead. Zero compromise. 100% Rust. 100% Agnostic. - - Chat Apps + + Chat Apps - - - Telegram + + Telegram + + Discord + + Slack + + iMessage + + Matrix + + Webhook + + CLI - - Discord - - - Slack - - - iMessage - - - Matrix - - - Webhook - - - CLI - - + any Channel trait + + any Channel trait - - + - - - Security Layer + + + Security Layer + + + + Gateway Pairing + 6-digit OTP + bearer tokens + constant-time comparison - - Auth Gate - allowed_users - webhook_secret + + Auth Gate + allowed_users + webhook_secret - - Rate Limiter - sliding window - max actions/hr & cost/day + + Rate Limiter + sliding window, cost/day cap + + + + Filesystem Sandbox + path jail + null byte block + symlink escape detection + + + + Encrypted Secrets + XOR + local key file (0600) - - + - - - Agent Loop + + + Agnostic Tunnel + Bring Your Own - - - Message - 💬 + + Cloudflare + + Tailscale + + ngrok + + Custom (bore, frp, ssh...) - - - LLM - 🤖 + + any Tunnel trait - - - Tools - 🛠️ + + - - - Response - 💬 + + + AI Providers (22+) + Any OpenAI-compatible API - - - - - + + + OpenRouter + + Anthropic + + OpenAI + + Ollama - - - Context - Memory (SQLite/MD) - Skills & Workspace - IDENTITY.md / AGENTS.md + + Venice + + Groq + + Mistral + + xAI / Grok - - - Sandbox - Command allowlist - Path jail & traversal block - Autonomy levels + + DeepSeek + + Together AI + + Fireworks + + Perplexity - - - Heartbeat & Cron - HEARTBEAT.md tasks - Scheduled actions - Periodic check-ins + + Cohere + + Cloudflare AI + + Bedrock + + custom:URL - - - Agnostic Tunnel - Bring Your Own - - - Cloudflare - - - Tailscale - - - ngrok - - - Custom (bore, frp, ssh...) - - + any Tunnel trait - - - - - - - - AI Providers (22+) - Any OpenAI-compatible API - - - - OpenRouter - - - Anthropic - - - OpenAI - - - Venice - - - Groq - - - Mistral - - - DeepSeek - - - xAI / Grok - - - Ollama - - - Together AI - - - Fireworks - - - Perplexity - - - Cloudflare AI - - - Cohere - - - Custom - - + any Provider trait / custom:URL + + any Provider trait / custom:URL - + + + + + Agent Loop + + + + Message + In + + + Memory Recall + ctx + + + LLM + AI + + + Tools + exec + + + Memory Save + store + + + Response + Out + + + + Composio + 1000+ OAuth + + + + + + + + + + + Memory Search Engine (All Custom) + No Pinecone, no Elasticsearch, no LangChain + + + + Vector DB + SQLite BLOB + cosine similarity + + + Keyword + FTS5 virtual tables + BM25 + + + Hybrid Merge + Weighted vector + keyword fusion + + + Embeddings + OpenAI / custom URL / noop + + + Chunking + Markdown-aware + heading ctx + + + Caching + embedding_cache + LRU eviction + + + Safe Reindex: rebuild FTS5 + re-embed missing vectors atomically | LIKE fallback | Upsert/Delete/Reindex + + + + + + + Sandbox + + Command allowlist + Path jail + traversal block + Null byte injection blocked + Symlink escape detection + 14 system dirs + 4 dotfiles blocked + Autonomy: ReadOnly / Supervised / Full + Workspace-only mode (default) + + + + + + Heartbeat & Cron + + HEARTBEAT.md periodic tasks + Scheduled actions + Skills loader (TOML manifests) + 50+ integrations registry + Observability (noop/log/multi) + + + - - Setup Wizard — zeroclaw onboard - 6 steps, under 60 seconds, so easy a 5-year-old can do it + + Setup Wizard -- zeroclaw onboard (--quick for instant setup) + 7 steps, under 60 seconds - - - 1. Workspace - ~/.zeroclaw/ + + + 1. Workspace + ~/.zeroclaw/ - - 2. AI Provider - 22+ or custom URL + + 2. AI Provider + 22+ or custom URL - - 3. Channels - 7 channels + test + + 3. Channels + 7 channels + test - - 4. Tunnel - 5 providers or skip + + 4. Tunnel + 5 providers or skip - - 5. Personalize - name, style, timezone + + 5. Tool Mode + Sovereign / Composio - - 6. Scaffold - workspace MD files + + 6. Personalize + name, style, timezone + + + 7. Scaffold + workspace MD files - - - - - - + + + + + + - - ✅ Ready — zeroclaw agent + + Ready -- zeroclaw agent - ~3MB binary · <10ms startup · 657 tests · 22+ providers · 7 channels · 5 tunnels · Pluggable everything + ~3.4MB binary | <10ms startup | 1,017 tests | 22+ providers | 7 channels | 5 tunnels | Encrypted secrets | Pluggable everything