Welcome to the comprehensive documentation for ClosedClaw - your personal AI assistant that runs on your own devices.
This documentation covers installation, configuration, security, development, and all aspects of using and extending ClosedClaw.
New to ClosedClaw? Start here:
- Installation Guide - System requirements and installation methods
- Getting Started - First steps after installation
- Onboarding Wizard - Interactive setup walkthrough
- Quick Start - TL;DR version from main README
- FAQ - Frequently asked questions
- Showcase - Real-world usage examples
Understanding ClosedClaw's architecture:
- Agents & Profiles - Multiple AI agents with distinct personalities
- Channels - Messaging platform integrations (Slack, Matrix, Microsoft Teams, Google Chat, Mattermost, etc.)
- Sessions & Routing - Message routing and session management
- Skills - Extending agent capabilities
- Memory & Context - How agents remember and learn
- Gateway - Control plane architecture
- Models - AI model selection and configuration
ClosedClaw implements comprehensive security infrastructure with OWASP/NIST compliance:
- Security Model - Architecture and principles
- Encrypted Storage - AES-256-GCM at rest (Priority 3)
- Skill Signing - Ed25519 cryptographic verification (Priority 4)
- Audit Logging - Tamper-evident SHA-256 chains (Priority 6)
- Keychain Integration - OS native credential storage (Priority 7)
- Trusted Keyring - Public key trust management
- Encryption Audit - Independent security review
- β AES-256-GCM encryption at rest
- β Argon2id key derivation (OWASP-compliant)
- β Ed25519 digital signatures for skills
- β SHA-256 hash-chain audit logging
- β OS keychain integration (macOS/Linux/Windows)
- β Network egress policies
- β Sandbox isolation (Docker/Firejail)
- Sandboxing - Process isolation
- Network Egress - Network policy enforcement
- Formal Verification - Cryptographic proofs (if available)
- Mandatory Sandboxing - Enforced isolation
- Tailscale Enforcement - VPN requirements
Command-line interface documentation:
- Security Commands - Encryption, signing, audit, keychain
- Gateway Commands - Control plane management
- Agent Commands - AI agent interactions
- Channel Commands - Messaging platform control
- Status & Diagnostics - System health and troubleshooting
# Installation & Setup
closedclaw onboard --install-daemon
# Gateway Management
closedclaw gateway --port 18789 --verbose
closedclaw status
# Agent Interaction
closedclaw agent --message "Hello" --thinking high
# Security
closedclaw security audit
closedclaw security log query --since 1h
closedclaw security keychain status
# Diagnostics
closedclaw doctor
closedclaw healthPlatform-specific integration guides:
- Microsoft Teams - MS Teams connector (extension)
- Google Chat - Google Chat integration (extension)
- Matrix - Matrix protocol (extension)
- Mattermost - Mattermost integration (extension)
- BlueBubbles - iMessage proxy server (extension)
- Zalo - Zalo messaging (extension)
- More... - See all available channels
Contributing to ClosedClaw:
- Contributing Guide - How to contribute
- Development Setup - Local development environment
- Testing Guide - Running and writing tests
- Debugging - Troubleshooting and debugging tools
- Fork Roadmap - Project history and direction
- Architecture Overview - System design and components
- Plugin System - Extension architecture
- Hooks System - Event hooks and lifecycle
- First Contribution - Step-by-step guide for new contributors (~600 lines)
- Path Aliases & Barrel Exports - Import patterns and migration guide (~500 lines)
- Adding Tools - Create new agent tools (see First Contribution guide)
- Adding Channels - Build channel extensions (see extension template in
extensions/.template/) - Extension Development - Plugin creation guide (see Plugin System docs)
Platform-specific documentation:
- Android - Android app setup
- Linux - systemd, Secret Service
- Docker - Container deployment
- VPS Hosting - Cloud deployment guides
Running ClosedClaw in production:
- Docker Deployment - Containerized deployment
- Railway Guide - Deploy to Railway
- Render Guide - Deploy to Render
- Northflank Guide - Deploy to Northflank
- VPS Setup - Self-hosted on VPS
Extending ClosedClaw functionality:
- Plugin System Overview - Extension architecture
- Creating Plugins - Plugin development guide
- Available Extensions - Browse all extensions
- Memory Systems - Custom memory backends
- Authentication Providers - OAuth/API integrations
Detailed reports on completed development priorities:
- Security Hardening Summary - Complete security implementation
- Priority 4: Skill Signing - Ed25519 signatures (2,200 lines)
- Priority 6: Audit Logging - Tamper-evident logs (2,370 lines)
- Priority 7: Keychain Integration - OS credential storage (2,854 lines)
- All Completion Reports - View all priority reports
Total Security Implementation: ~12,200 lines (code + tests + docs) β
- Doctor Command - Automated diagnostics (
closedclaw doctor) - Health Check - System health monitoring
- Debugging Guide - Debug tools and techniques
- Common Issues - FAQ and known issues
- Logging - Log collection and analysis
- GitHub Issues - Bug reports and feature requests
- Token Usage - Managing token consumption
- Environment Variables - Configuration via env vars
- Network Configuration - Proxy, firewall, networking
- Date & Time - Timezone and date handling
- TTS (Text-to-Speech) - Voice output configuration
- TUI (Terminal UI) - Terminal interface guide
- Prose System - Natural language programming
- Scripts - Automation and scripting
- Multi-Agent Sandbox - Agent collaboration
- Broadcast Groups - Multi-channel messaging
- Brave Search - Search integration
- Perplexity.ai - External AI integration
- AWS Bedrock - Bedrock model integration
- Experiments - Experimental features
- Cron Jobs - Scheduled tasks
- Auto-Reply - Automated responses
- Workflows - Task automation
- README.md - Project overview
- CHANGELOG.md - Version history
- CONTRIBUTING.md - Contribution guidelines
- LICENSE - MIT License
- SECURITY.md - Security policy
- TODO.md - Current development priorities
- GitHub Repository - Source code
- DeepWiki - Community-maintained wiki
- npm Package - npm registry
- Security: Enterprise-grade (AES-256, Ed25519, SHA-256 chains)
- Test Coverage: 70%+ (security: 90%+)
- Platforms: macOS, iOS, Android, Linux, Windows (WSL2)
- Channels: 10+ built-in, 20+ extension channels
- Documentation: 778+ markdown files
- License: MIT
Last Updated: February 10, 2026
Version: 2026.2.1
Status: Production-ready with enterprise security β
For the most up-to-date information, visit the official website.