🦐 PicoClaw Documentation

# Download for your platform (choose one)
# x86_64:
wget https://github.com/sipeed/picoclaw/releases/latest/download/picoclaw-linux-amd64

# ARM64:
wget https://github.com/sipeed/picoclaw/releases/latest/download/picoclaw-linux-arm64

# RISC-V:
wget https://github.com/sipeed/picoclaw/releases/latest/download/picoclaw-linux-riscv64

# Make executable and run
chmod +x picoclaw-linux-*
./picoclaw-linux-amd64 onboard

# Clone the repository
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw

# Install dependencies
make deps

# Build for your current platform
make build

# Build for all platforms (cross-compile)
make build-all

# Build and install to system PATH
make install

# 1. Clone the repo
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw

# 2. Configure API keys
cp config/config.example.json config/config.json
vim config/config.json

# 3. Build & start the gateway
docker compose --profile gateway up -d

# 4. Check logs
docker compose logs -f picoclaw-gateway

# 5. Stop
docker compose --profile gateway down

{
  "agents": {
    "defaults": {
      "model": "glm-4.7",
      "max_tokens": 8192
    }
  },
  "providers": {
    "zhipu": {
      "api_key": "Your_Zhipu_API_Key",
      "api_base": "https://open.bigmodel.cn/api/paas/v4"
    }
  }
}

~/.picoclaw/workspace/
├── sessions/          # Conversation sessions and history
├── memory/            # Long-term memory (MEMORY.md)
├── cron/              # Scheduled jobs database
├── skills/            # Custom skills
├── AGENTS.md          # Agent behavior guide
├── IDENTITY.md        # Agent identity
├── SOUL.md            # Agent soul
├── TOOLS.md           # Tool descriptions
└── USER.md            # User preferences

{
  "channels": {
    "qq": {
      "enabled": true,
      "app_id": "YOUR_APP_ID",
      "app_secret": "YOUR_APP_SECRET",
      "allow_from": []
    }
  }
}

{
  "channels": {
    "dingtalk": {
      "enabled": true,
      "client_id": "YOUR_CLIENT_ID",
      "client_secret": "YOUR_CLIENT_SECRET",
      "allow_from": []
    }
  }
}

# One-shot: Ask a question and get an answer
picoclaw agent -m "Explain quantum computing in simple terms"

# Interactive: Start a conversation session
picoclaw agent

# Docker: One-shot via Docker
docker compose run --rm picoclaw-agent -m "What is 2+2?"

# Docker: Interactive via Docker
docker compose run --rm picoclaw-agent

# Start the gateway (local)
picoclaw gateway

# Start via Docker
docker compose --profile gateway up -d

# Check gateway logs
docker compose logs -f picoclaw-gateway

# List all scheduled jobs
picoclaw cron list

# Add a new scheduled job
picoclaw cron add "Check server status every hour"

{
  "tools": {
    "web": {
      "search": {
        "api_key": "YOUR_BRAVE_API_KEY",
        "max_results": 5
      }
    }
  }
}

picoclaw agent -m "Read https://clawdchat.ai/skill.md and follow the instructions to join ClawdChat.ai"

# Start
docker compose --profile gateway up -d

# Check logs
docker compose logs -f picoclaw-gateway

# Stop
docker compose --profile gateway down

# Rebuild (after updates)
docker compose --profile gateway build --no-cache
docker compose --profile gateway up -d

# Ask a question
docker compose run --rm picoclaw-agent -m "What is 2+2?"

# Interactive mode
docker compose run --rm picoclaw-agent

{
  "agents": {
    "defaults": {
      "model": "anthropic/claude-opus-4-5"
    }
  },
  "providers": {
    "openrouter": {
      "api_key": "sk-or-v1-xxx"
    },
    "groq": {
      "api_key": "gsk_xxx"
    }
  },
  "channels": {
    "telegram": {
      "enabled": true,
      "token": "123456:ABC...",
      "allow_from": ["123456789"]
    },
    "discord": {
      "enabled": true,
      "token": "",
      "allow_from": [""]
    },
    "whatsapp": {
      "enabled": false
    },
    "feishu": {
      "enabled": false,
      "app_id": "cli_xxx",
      "app_secret": "xxx",
      "encrypt_key": "",
      "verification_token": "",
      "allow_from": []
    },
    "qq": {
      "enabled": false,
      "app_id": "",
      "app_secret": "",
      "allow_from": []
    }
  },
  "tools": {
    "web": {
      "search": {
        "api_key": "BSA..."
      }
    }
  }
}