Skip to main content

Getting Started

Get PicoClaw running in 2 minutes.

API Keys

Get free API keys: OpenRouter (200K tokens/month) · Zhipu (200K tokens/month)

Step 1: Initialize

picoclaw onboard

This creates your workspace at ~/.picoclaw/ and generates a default config file.

Step 2: Configure

Edit ~/.picoclaw/config.json:

{
"agents": {
"defaults": {
"workspace": "~/.picoclaw/workspace",
"model": "gpt4",
"max_tokens": 8192,
"temperature": 0.7,
"max_tool_iterations": 20
}
},
"model_list": [
{
"model_name": "gpt4",
"model": "openai/gpt-5.2",
"api_key": "your-api-key"
},
{
"model_name": "claude",
"model": "anthropic/claude-sonnet-4-6",
"api_key": "your-anthropic-key"
}
]
}

See Model Configuration for all supported providers.

Step 3: Chat

# One-shot chat
picoclaw agent -m "What is 2+2?"

# Interactive mode
picoclaw agent

That's it! You have a working AI assistant.

CLI Reference

CommandDescription
picoclaw onboardInitialize config and workspace
picoclaw agent -m "..."One-shot chat
picoclaw agentInteractive chat mode
picoclaw gatewayStart the gateway (for chat apps)
picoclaw statusShow status
picoclaw cron listList all scheduled jobs
picoclaw cron add ...Add a scheduled job

Scheduled Tasks

PicoClaw supports reminders and recurring tasks via the cron tool:

  • One-time: "Remind me in 10 minutes"
  • Recurring: "Remind me every 2 hours"
  • Cron expressions: "Remind me at 9am daily"

Jobs are stored in ~/.picoclaw/workspace/cron/ and processed automatically.

Run on Android (Termux)

Give your old phone a second life as an AI assistant:

# Note: Replace v0.1.1 with the latest version from the Releases page
wget https://github.com/sipeed/picoclaw/releases/download/v0.1.1/picoclaw-linux-arm64
chmod +x picoclaw-linux-arm64
pkg install proot
termux-chroot ./picoclaw-linux-arm64 onboard

Troubleshooting

Web search says "API 配置问题"

This is normal if you haven't configured a search API key. PicoClaw falls back to DuckDuckGo automatically (no key required).

To enable Brave Search (2000 free queries/month):

{
"tools": {
"web": {
"brave": {
"enabled": true,
"api_key": "YOUR_BRAVE_API_KEY",
"max_results": 5
}
}
}
}

Content filtering errors

Some providers (like Zhipu) have content filtering. Try rephrasing your query or use a different model.

Telegram bot "Conflict: terminated by other getUpdates"

Only one picoclaw gateway instance should run at a time. Stop any other instances.

API Key Comparison

ServiceFree TierUse Case
OpenRouter200K tokens/monthMultiple models (Claude, GPT-4, etc.)
Zhipu200K tokens/monthBest for Chinese users
Brave Search2000 queries/monthWeb search functionality
GroqFree tierFast inference (Llama, Mixtral)
CerebrasFree tierFast inference (Llama, Qwen)