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>
9.9 KiB
⚙️ Guide de Configuration
Retour au README
⚙️ Configuration
Fichier de configuration : ~/.picoclaw/config.json
Variables d'Environnement
Vous pouvez remplacer les chemins par défaut à l'aide de variables d'environnement. Ceci est utile pour les installations portables, les déploiements conteneurisés ou l'exécution de PicoClaw en tant que service système. Ces variables sont indépendantes et contrôlent des chemins différents.
| Variable | Description | Chemin par défaut |
|---|---|---|
PICOCLAW_CONFIG |
Remplace le chemin vers le fichier de configuration. Indique directement à PicoClaw quel config.json charger, en ignorant tous les autres emplacements. |
~/.picoclaw/config.json |
PICOCLAW_HOME |
Remplace le répertoire racine des données PicoClaw. Change l'emplacement par défaut du workspace et des autres répertoires de données. |
~/.picoclaw |
Exemples :
# Run picoclaw using a specific config file
# The workspace path will be read from within that config file
PICOCLAW_CONFIG=/etc/picoclaw/production.json picoclaw gateway
# Run picoclaw with all its data stored in /opt/picoclaw
# Config will be loaded from the default ~/.picoclaw/config.json
# Workspace will be created at /opt/picoclaw/workspace
PICOCLAW_HOME=/opt/picoclaw picoclaw agent
# Use both for a fully customized setup
PICOCLAW_HOME=/srv/picoclaw PICOCLAW_CONFIG=/srv/picoclaw/main.json picoclaw gateway
Structure du Workspace
PicoClaw stocke les données dans votre workspace configuré (par défaut : ~/.picoclaw/workspace) :
~/.picoclaw/workspace/
├── sessions/ # Sessions de conversation et historique
├── memory/ # Mémoire à long terme (MEMORY.md)
├── state/ # État persistant (dernier canal, etc.)
├── cron/ # Base de données des tâches planifiées
├── skills/ # Compétences personnalisées
├── AGENTS.md # Guide de comportement de l'agent
├── HEARTBEAT.md # Invites de tâches périodiques (vérifiées toutes les 30 min)
├── IDENTITY.md # Identité de l'agent
├── SOUL.md # Âme de l'agent
└── USER.md # Préférences utilisateur
Sources de Compétences
Par défaut, les compétences sont chargées depuis :
~/.picoclaw/workspace/skills(workspace)~/.picoclaw/skills(global)<current-working-directory>/skills(builtin)
Pour les configurations avancées/de test, vous pouvez remplacer la racine des compétences builtin avec :
export PICOCLAW_BUILTIN_SKILLS=/path/to/skills
Politique Unifiée d'Exécution des Commandes
- Les commandes slash génériques sont exécutées via un chemin unique dans
pkg/agent/loop.goviacommands.Executor. - Les adaptateurs de canaux ne consomment plus les commandes génériques localement ; ils transmettent le texte entrant au chemin bus/agent. Telegram enregistre toujours automatiquement les commandes prises en charge au démarrage.
- Une commande slash inconnue (par exemple
/foo) passe au traitement LLM normal. - Une commande enregistrée mais non prise en charge sur le canal actuel (par exemple
/showsur WhatsApp) renvoie une erreur explicite à l'utilisateur et arrête le traitement ultérieur.
🔒 Sandbox de Sécurité
PicoClaw s'exécute dans un environnement sandboxé par défaut. L'agent ne peut accéder aux fichiers et exécuter des commandes que dans le workspace configuré.
Configuration par Défaut
{
"agents": {
"defaults": {
"workspace": "~/.picoclaw/workspace",
"restrict_to_workspace": true
}
}
}
| Option | Par défaut | Description |
|---|---|---|
workspace |
~/.picoclaw/workspace |
Répertoire de travail de l'agent |
restrict_to_workspace |
true |
Restreindre l'accès fichiers/commandes au workspace |
Outils Protégés
Lorsque restrict_to_workspace: true, les outils suivants sont sandboxés :
| Outil | Fonction | Restriction |
|---|---|---|
read_file |
Lire des fichiers | Uniquement les fichiers dans le workspace |
write_file |
Écrire des fichiers | Uniquement les fichiers dans le workspace |
list_dir |
Lister les répertoires | Uniquement les répertoires dans le workspace |
edit_file |
Modifier des fichiers | Uniquement les fichiers dans le workspace |
append_file |
Ajouter aux fichiers | Uniquement les fichiers dans le workspace |
exec |
Exécuter des commandes | Les chemins de commande doivent être dans le workspace |
Protection Exec Supplémentaire
Même avec restrict_to_workspace: false, l'outil exec bloque ces commandes dangereuses :
rm -rf,del /f,rmdir /s— Suppression en masseformat,mkfs,diskpart— Formatage de disquedd if=— Imagerie de disque- Écriture vers
/dev/sd[a-z]— Écritures directes sur disque shutdown,reboot,poweroff— Arrêt du système- Fork bomb
:(){ :|:& };:
Contrôle d'Accès aux Fichiers
| Clé de configuration | Type | Par défaut | Description |
|---|---|---|---|
tools.allow_read_paths |
string[] | [] |
Chemins supplémentaires autorisés en lecture en dehors du workspace |
tools.allow_write_paths |
string[] | [] |
Chemins supplémentaires autorisés en écriture en dehors du workspace |
Sécurité Exec
| Clé de configuration | Type | Par défaut | Description |
|---|---|---|---|
tools.exec.allow_remote |
bool | false |
Autoriser l'outil exec depuis les canaux distants (Telegram/Discord etc.) |
tools.exec.enable_deny_patterns |
bool | true |
Activer l'interception des commandes dangereuses |
tools.exec.custom_deny_patterns |
string[] | [] |
Patterns regex personnalisés à bloquer |
tools.exec.custom_allow_patterns |
string[] | [] |
Patterns regex personnalisés à autoriser |
Note de sécurité : La protection Symlink est activée par défaut — tous les chemins de fichiers sont résolus via
filepath.EvalSymlinksavant la correspondance avec la liste blanche, empêchant les attaques d'évasion par symlink.
Limitation Connue : Processus Enfants des Outils de Build
Le garde de sécurité exec n'inspecte que la ligne de commande lancée directement par PicoClaw. Il n'inspecte pas récursivement les processus enfants générés par les outils de développement autorisés tels que make, go run, cargo, npm run ou les scripts de build personnalisés.
Cela signifie qu'une commande de niveau supérieur peut toujours compiler ou lancer d'autres binaires après avoir passé la vérification initiale du garde. En pratique, traitez les scripts de build, les Makefiles, les scripts de packages et les binaires générés comme du code exécutable nécessitant le même niveau de revue qu'une commande shell directe.
Pour les environnements à haut risque :
- Examinez les scripts de build avant l'exécution.
- Préférez l'approbation/revue manuelle pour les workflows de compilation et d'exécution.
- Exécutez PicoClaw dans un conteneur ou une VM si vous avez besoin d'une isolation plus forte que celle fournie par le garde intégré.
Exemples d'Erreurs
[ERROR] tool: Tool execution failed
{tool=exec, error=Command blocked by safety guard (path outside working dir)}
[ERROR] tool: Tool execution failed
{tool=exec, error=Command blocked by safety guard (dangerous pattern detected)}
Désactiver les Restrictions (Risque de Sécurité)
Si vous avez besoin que l'agent accède à des chemins en dehors du workspace :
Méthode 1 : Fichier de configuration
{
"agents": {
"defaults": {
"restrict_to_workspace": false
}
}
}
Méthode 2 : Variable d'environnement
export PICOCLAW_AGENTS_DEFAULTS_RESTRICT_TO_WORKSPACE=false
⚠️ Avertissement : Désactiver cette restriction permet à l'agent d'accéder à n'importe quel chemin sur votre système. À utiliser avec précaution dans des environnements contrôlés uniquement.
Cohérence des Limites de Sécurité
Le paramètre restrict_to_workspace s'applique de manière cohérente à tous les chemins d'exécution :
| Chemin d'exécution | Limite de sécurité |
|---|---|
| Main Agent | restrict_to_workspace ✅ |
| Subagent / Spawn | Hérite de la même restriction ✅ |
| Heartbeat tasks | Hérite de la même restriction ✅ |
Tous les chemins partagent la même restriction de workspace — il n'y a aucun moyen de contourner la limite de sécurité via les subagents ou les tâches planifiées.
Heartbeat (Tâches Périodiques)
PicoClaw peut effectuer des tâches périodiques automatiquement. Créez un fichier HEARTBEAT.md dans votre workspace :
# Periodic Tasks
- Check my email for important messages
- Review my calendar for upcoming events
- Check the weather forecast
L'agent lira ce fichier toutes les 30 minutes (configurable) et exécutera toutes les tâches en utilisant les outils disponibles.
Tâches Asynchrones avec Spawn
Pour les tâches longues (recherche web, appels API), utilisez l'outil spawn pour créer un subagent :
# Periodic Tasks