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.5 KiB
🐳 Docker et Démarrage Rapide
Retour au README
🐳 Docker Compose
Vous pouvez également exécuter PicoClaw avec Docker Compose sans rien installer localement.
# 1. Cloner ce dépôt
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw
# 2. Premier lancement — génère automatiquement docker/data/config.json puis s'arrête
docker compose -f docker/docker-compose.yml --profile gateway up
# Le conteneur affiche "First-run setup complete." et s'arrête.
# 3. Configurer vos clés API
vim docker/data/config.json # Set provider API keys, bot tokens, etc.
# 4. Démarrer
docker compose -f docker/docker-compose.yml --profile gateway up -d
Tip
Utilisateurs Docker : Par défaut, le Gateway écoute sur
127.0.0.1, ce qui n'est pas accessible depuis l'hôte. Si vous devez accéder aux endpoints de santé ou exposer des ports, définissezPICOCLAW_GATEWAY_HOST=0.0.0.0dans votre environnement ou mettez à jourconfig.json.
# 5. Vérifier les logs
docker compose -f docker/docker-compose.yml logs -f picoclaw-gateway
# 6. Arrêter
docker compose -f docker/docker-compose.yml --profile gateway down
Mode Launcher (Console Web)
L'image launcher inclut les trois binaires (picoclaw, picoclaw-launcher, picoclaw-launcher-tui) et démarre la console web par défaut, qui fournit une interface navigateur pour la configuration et le chat.
docker compose -f docker/docker-compose.yml --profile launcher up -d
Ouvrez http://localhost:18800 dans votre navigateur. Le launcher gère automatiquement le processus gateway.
Warning
La console web ne prend pas encore en charge l'authentification. Évitez de l'exposer sur Internet public.
Mode Agent (One-shot)
# Poser une question
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent -m "What is 2+2?"
# Mode interactif
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent
Mise à jour
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml --profile gateway up -d
🚀 Démarrage Rapide
Tip
Configurez votre clé API dans
~/.picoclaw/config.json. Obtenir des clés API : Volcengine (CodingPlan) (LLM) · OpenRouter (LLM) · Zhipu (LLM). La recherche web est optionnelle — obtenez gratuitement une API Tavily (1000 requêtes gratuites/mois) ou une API Brave Search (2000 requêtes gratuites/mois).
1. Initialiser
picoclaw onboard
2. Configurer (~/.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
}
}
}
}
Nouveau : Le format de configuration
model_listpermet l'ajout de fournisseurs sans modification de code. Voir Configuration des Modèles pour plus de détails.request_timeoutest optionnel et utilise les secondes. S'il est omis ou défini à<= 0, PicoClaw utilise le timeout par défaut (120s).
3. Obtenir des clés API
- Fournisseur LLM : OpenRouter · Zhipu · Anthropic · OpenAI · Gemini
- Recherche Web (optionnel) :
- Brave Search - Payant ($5/1000 requêtes, ~$5-6/mois)
- Perplexity - Recherche alimentée par l'IA avec interface de chat
- SearXNG - Métamoteur auto-hébergé (gratuit, pas de clé API nécessaire)
- Tavily - Optimisé pour les agents IA (1000 requêtes/mois)
- DuckDuckGo - Solution de repli intégrée (pas de clé API requise)
Note
: Voir
config.example.jsonpour un modèle de configuration complet.
4. Discuter
picoclaw agent -m "What is 2+2?"
C'est tout ! Vous avez un assistant IA fonctionnel en 2 minutes.