Skip to main content

marsClaw docs

Pick by what you need to do.

Get started​

→ ../README.md for the elevator pitch and quick-start. Everything else here is reference.

Understand the system​

  • architecture.md — message flow, components, SQLite schema, per-thread serialization, what the agent SDK delegates vs. what we own.
  • security.md — threat model, capability flags, sensitive-path guard, web allow-list, audit log, residual risks.
  • container-runtime.md — the optional isolated container runtime: host/sidecar split, credential proxy, what's mounted, and how the security model changes between modes.
  • vs-nanoclaw.md — when to pick marsClaw vs the multi-tenant cousin.

Configure it​

  • configuration.md — full .env and data/config.json reference; precedence rules; allowed_paths and Bash denylist.
  • channels.md — per-channel setup (Telegram, Slack, WhatsApp) including the WhatsApp pairing flow.
  • providers.md — Gemini vs Claude, switching, auth, costs, failover.
  • voice.md — Whisper STT + Kokoro TTS sidecars, voices, model sizes.
  • youtube.md — YouTube transcript MCP tool, yt-dlp dependency, auto-summarise behaviour.
  • google.md — Google OAuth, multiple accounts, Gmail/Calendar/Drive/Sheets/Docs/Slides MCP tools.

Run it​

  • operations.md — launchd service, backups, observability, troubleshooting cheatsheet.

Hack on it​

  • development.md — codebase tour, tests, adding a channel / MCP tool / provider, migrations.