picoclaw/docs

PicoClaw Documentation

Welcome to the PicoClaw documentation. PicoClaw is an ultra-lightweight AI assistant written in Go that runs on $10 hardware with less than 10MB RAM.

Why PicoClaw?

Feature	OpenClaw	NanoBot	PicoClaw
Language	TypeScript	Python	Go
RAM	>1GB	>100MB	<10MB
Startup	>500s	>30s	<1s
Cost	Mac Mini $599	~$50	As low as $10

Quick Links

• Installation - Get PicoClaw up and running
• Quick Start - Your first conversation in 5 minutes
• Configuration Reference - Complete config options
• CLI Reference - All command-line options
• Troubleshooting - Common issues and solutions

Documentation Sections

Getting Started

New to PicoClaw? Start here.

• Installation - Install via binary, source, or Docker
• Quick Start - 5-minute setup guide
• Configuration Basics - Essential config concepts
• Your First Chat - Running your first conversation

User Guide

Complete guide to using PicoClaw features.

• CLI Reference - All commands and options

  • onboard - Initialize configuration
  • agent - Chat with the agent
  • gateway - Start the gateway
  • status - System status
  • auth - OAuth management
  • cron - Scheduled tasks
  • skills - Skill management
  • migrate - Migration from OpenClaw

• Channels - Chat platform integrations

  • Telegram - Telegram bot setup
  • Discord - Discord bot setup
  • Slack - Slack integration
  • WhatsApp - WhatsApp integration
  • Feishu/Lark - Feishu setup
  • LINE - LINE bot setup
  • QQ - QQ bot setup
  • DingTalk - DingTalk setup
  • WeCom - WeCom (Enterprise WeChat)
  • OneBot - OneBot protocol
  • MaixCam - MaixCam device

• Providers - LLM provider setup

  • OpenRouter - Multi-model access (recommended)
  • Zhipu/GLM - Chinese AI models
  • Anthropic - Claude models
  • OpenAI - GPT models
  • Gemini - Google Gemini
  • Groq - Fast inference
  • DeepSeek - DeepSeek models
  • Ollama - Local models
  • vLLM - Self-hosted models

• IDE Setup - IDE integrations

  • Antigravity - Google Cloud Code Assist (free Claude/Gemini)

• Workspace - Customizing behavior

  • Structure - Directory layout
  • AGENT.md - Agent behavior
  • IDENTITY.md - Agent identity
  • Memory - Long-term memory
  • Heartbeat Tasks - Periodic tasks

• Tools - Available tools

  • File System - read_file, write_file, etc.
  • Exec - Shell commands
  • Web - web_search, web_fetch
  • Messaging - Send messages
  • Spawn - Subagents
  • Cron - Scheduled tasks
  • Hardware - I2C, SPI

• Skills - Skills system

  • Using Skills
  • Installing Skills
  • Built-in Skills
  • Creating Skills

• Advanced Features

  • Multi-Agent System
  • Message Routing
  • Session Management
  • Model Fallbacks
  • Security Sandbox
  • Environment Variables
  • Voice Transcription

Developer Guide

Building and extending PicoClaw.

• Architecture - System design
• Data Flow - Message bus architecture
• Building - Build from source
• Testing - Running tests
• Contributing - Contribution guidelines
• Code Style - Code standards

Extending PicoClaw

• Creating Tools
• Creating Providers
• Creating Channels
• Creating Skills
• Antigravity Implementation - OAuth and API details

API Reference

• Tool Interface
• Provider Interface
• Message Bus
• Session API

Deployment

Deploying PicoClaw in various environments.

• Docker - Docker and Docker Compose
• Systemd - Linux service
• Termux - Android phones
• Single-Board Computers
  • Raspberry Pi
  • LicheeRV Nano
  • MaixCAM
• Security - Production security

Operations

Running and monitoring PicoClaw.

• Health Endpoints
• Monitoring
• Logging
• Device Monitoring
• Troubleshooting

Configuration

Complete configuration reference.

• Config File - config.json reference
• Agents Config
• Bindings Config
• Channels Config
• Providers Config
• Tools Config
• Gateway Config
• Heartbeat Config
• Devices Config

Migration

Migrating from older configurations.

• Model List Migration - Migrate to model_list configuration

Design

Architecture and design decisions.

• Provider Refactoring - Protocol-based provider architecture
• Provider Refactoring Tests - Test patterns for providers

Tutorials

Step-by-step guides.

• Basic Assistant - Beginner setup
• Telegram Bot - Telegram tutorial
• Scheduled Tasks - Cron and heartbeat
• Multi-Agent Setup - Multiple agents
• Hardware Control - I2C/SPI tutorial
• Skill Development - Custom skills

Community

Join the community.

• Roadmap - Project roadmap
• Support - Getting help
• Contributing Roles - Volunteer opportunities

Getting Help

• Discord: Join our server
• GitHub Issues: Report bugs
• GitHub Discussions: Feature requests

Contributing

PRs are welcome! See the Contributing Guide for details.