Restructure all 6 README files (en, zh, ja, fr, pt-br, vi) from
~1200-1580 lines down to ~250 lines each. Long sections (Chat Apps,
Providers, Configuration, Docker, Spawn Tasks, Troubleshooting, Tools)
are extracted into dedicated docs under docs/{lang}/ subdirectories.
Changes:
- Split README content into 7 sub-documents per language (42 new files)
- Update News section with v0.2.3/v0.2.1/v0.2.0/20K milestones
- Add 3 new Features (MCP Support, Vision Pipeline, Smart Routing)
- Complete CLI reference (14 commands, was 7)
- Fix Go badge 1.21+ -> 1.25+ (matches go.mod)
- Add LoongArch to architecture badge
- Fix Install section: hardcoded v0.1.1 -> latest/download URL
- Add Termux GitHub links
- Fix currency symbol placement ($599 not 599$)
- Add missing channels (Feishu, Slack, IRC, OneBot, MaixCam, Pico)
- Add missing providers (Kimi, Minimax, Avian, Mistral, Longcat, ModelScope)
- Add missing security docs (allow_read/write_paths, allow_remote, symlink)
- Remove incorrect azure from Providers table (azure uses model_list only)
- Cross-verified all claims against source code
Co-authored-by: BeaconCat <BeaconCat@users.noreply.github.com>
5.4 KiB
🐳 Docker e Início Rápido
Voltar ao README
🐳 Docker Compose
Você também pode executar o PicoClaw usando Docker Compose sem instalar nada localmente.
# 1. Clone este repositório
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw
# 2. Primeira execução — gera automaticamente docker/data/config.json e encerra
docker compose -f docker/docker-compose.yml --profile gateway up
# O contêiner exibe "First-run setup complete." e para.
# 3. Configure suas chaves de API
vim docker/data/config.json # Set provider API keys, bot tokens, etc.
# 4. Iniciar
docker compose -f docker/docker-compose.yml --profile gateway up -d
Tip
Usuários Docker: Por padrão, o Gateway escuta em
127.0.0.1, que não é acessível a partir do host. Se você precisar acessar os endpoints de saúde ou expor portas, definaPICOCLAW_GATEWAY_HOST=0.0.0.0no seu ambiente ou atualize oconfig.json.
# 5. Verificar logs
docker compose -f docker/docker-compose.yml logs -f picoclaw-gateway
# 6. Parar
docker compose -f docker/docker-compose.yml --profile gateway down
Modo Launcher (Console Web)
A imagem launcher inclui os três binários (picoclaw, picoclaw-launcher, picoclaw-launcher-tui) e inicia o console web por padrão, que fornece uma interface baseada em navegador para configuração e chat.
docker compose -f docker/docker-compose.yml --profile launcher up -d
Abra http://localhost:18800 no seu navegador. O launcher gerencia o processo do gateway automaticamente.
Warning
O console web ainda não suporta autenticação. Evite expô-lo na internet pública.
Modo Agent (One-shot)
# Fazer uma pergunta
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent -m "What is 2+2?"
# Modo interativo
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent
Atualização
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml --profile gateway up -d
🚀 Início Rápido
Tip
Configure sua chave de API em
~/.picoclaw/config.json. Obtenha chaves de API: Volcengine (CodingPlan) (LLM) · OpenRouter (LLM) · Zhipu (LLM). A busca na web é opcional — obtenha gratuitamente uma API Tavily (1000 consultas gratuitas/mês) ou API Brave Search (2000 consultas gratuitas/mês).
1. Inicializar
picoclaw onboard
2. Configurar (~/.picoclaw/config.json)
{
"agents": {
"defaults": {
"workspace": "~/.picoclaw/workspace",
"model_name": "gpt-5.4",
"max_tokens": 8192,
"temperature": 0.7,
"max_tool_iterations": 20
}
},
"model_list": [
{
"model_name": "ark-code-latest",
"model": "volcengine/ark-code-latest",
"api_key": "sk-your-api-key",
"api_base":"https://ark.cn-beijing.volces.com/api/coding/v3"
},
{
"model_name": "gpt-5.4",
"model": "openai/gpt-5.4",
"api_key": "your-api-key",
"request_timeout": 300
},
{
"model_name": "claude-sonnet-4.6",
"model": "anthropic/claude-sonnet-4.6",
"api_key": "your-anthropic-key"
}
],
"tools": {
"web": {
"enabled": true,
"fetch_limit_bytes": 10485760,
"format": "plaintext",
"brave": {
"enabled": false,
"api_key": "YOUR_BRAVE_API_KEY",
"max_results": 5
},
"tavily": {
"enabled": false,
"api_key": "YOUR_TAVILY_API_KEY",
"max_results": 5
},
"duckduckgo": {
"enabled": true,
"max_results": 5
},
"perplexity": {
"enabled": false,
"api_key": "YOUR_PERPLEXITY_API_KEY",
"max_results": 5
},
"searxng": {
"enabled": false,
"base_url": "http://your-searxng-instance:8888",
"max_results": 5
}
}
}
}
Novo: O formato de configuração
model_listpermite adicionar provedores sem alteração de código. Veja Configuração de Modelos para detalhes.request_timeouté opcional e usa segundos. Se omitido ou definido como<= 0, o PicoClaw usa o timeout padrão (120s).
3. Obter chaves de API
- Provedor LLM: OpenRouter · Zhipu · Anthropic · OpenAI · Gemini
- Busca na Web (opcional):
- Brave Search - Pago ($5/1000 consultas, ~$5-6/mês)
- Perplexity - Busca com IA e interface de chat
- SearXNG - Metabuscador auto-hospedado (gratuito, sem necessidade de chave de API)
- Tavily - Otimizado para agentes de IA (1000 requisições/mês)
- DuckDuckGo - Fallback integrado (sem necessidade de chave de API)
Nota: Veja
config.example.jsonpara um modelo de configuração completo.
4. Conversar
picoclaw agent -m "What is 2+2?"
Pronto! Você tem um assistente de IA funcionando em 2 minutos.