Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Démarrage rapide

Quickstart est l’assistant de configuration guidée qui vous mène d’une installation vierge à un agent fonctionnel en une seule passe. Il s’exécute sur trois interfaces : la CLI, l’interface de terminal zerocode et la passerelle web. Les trois pilotent le même flux sous-jacent, donc la configuration qu’elles produisent est identique. Utilisez celle qui convient le mieux à votre contexte.

Installer

Chemin rapide Unix

curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | sh

Cette route est non interactive et n’ouvre pas de sélecteur.

Il privilégie un binaire précompilé correspondant et se rabat sur une compilation à partir des sources si nécessaire.

Une archive précompilée peut contenir zerocode ; un repli non interactif vers les sources installe l’application par défaut sans ouvrir de sélecteur.

La commande utilise un ensemble de fonctionnalités fixe.

Si une compilation à partir des sources est nécessaire, l’installateur peut installer Rust automatiquement s’il est absent.

Sous Unix, le programme d’installation met à jour le profil du shell si cela est autorisé ; rechargez le shell parent avant de vous fier au nouveau PATH.

L’installateur ignore la configuration et affiche zeroclaw quickstart comme étape suivante.

Parcours guidé Unix

git clone https://github.com/zeroclaw-labs/zeroclaw.git
cd zeroclaw
./install.sh

Cette route est guidée et peut proposer des choix pris en charge.

Sur les cibles prises en charge, il propose une installation à partir de binaires précompilés ou une compilation depuis les sources.

Une archive précompilée peut contenir zerocode ; le choix de la source le sélectionne par défaut et permet de sélectionner l’application.

Le chemin source vous permet également de sélectionner des fonctionnalités Cargo facultatives.

Si une compilation à partir des sources est nécessaire, l’installateur peut installer Rust automatiquement s’il est absent.

Sous Unix, le programme d’installation met à jour le profil du shell si cela est autorisé ; rechargez le shell parent avant de vous fier au nouveau PATH.

Pour une installation non configurée, il propose zeroclaw quickstart ou le Quickstart dans le navigateur.

Chemin de la version précompilée pour Windows

Utilisez le bloc PowerShell du guide d’installation Windows. L’installation et la configuration du PATH sont idempotentes ; Quickstart s’exécute toujours.

Cette route est non interactive et n’ouvre pas de sélecteur.

Cette méthode installe une archive de version précompilée.

L’archive peut également contenir zerocode ; la disponibilité dépend de l’élément de version.

La commande utilise un ensemble de fonctionnalités fixe.

Cette route précompilée ne nécessite pas de chaîne d’outils Rust.

Sous Windows, le chemin PowerShell met à jour le processus actuel et le PATH utilisateur persistant.

Le bloc PowerShell se termine en exécutant automatiquement zeroclaw quickstart.

Chemin source avancé

Unix

./install.sh --source

Cette route est guidée et peut proposer des choix pris en charge.

Cette méthode compile toujours à partir des sources.

L’installation depuis les sources sélectionne zerocode par défaut et vous permet de modifier la sélection de l’application.

Le chemin source vous permet également de sélectionner des fonctionnalités Cargo facultatives.

Si une compilation à partir des sources est nécessaire, l’installateur peut installer Rust automatiquement s’il est absent.

Sous Unix, le programme d’installation met à jour le profil du shell si cela est autorisé ; rechargez le shell parent avant de vous fier au nouveau PATH.

Pour une installation non configurée, il propose zeroclaw quickstart ou le Quickstart dans le navigateur.

Windows

cargo install --locked --path .

Cette route est non interactive et n’ouvre pas de sélecteur.

Cette méthode compile toujours à partir des sources.

Cette commande installe le binaire principal zeroclaw ; elle n’installe pas les applications facultatives.

La commande utilise un ensemble de fonctionnalités fixe.

Une chaîne d’outils Rust est requise avant d’utiliser cette commande.

Cette commande Cargo ne modifie pas PATH ; assurez-vous que le répertoire bin de Cargo est déjà disponible dans votre shell.

Après l’installation, exécutez zeroclaw quickstart.

Les étapes

Important : si l’un de ces termes ne vous est pas familier, consultez d’abord Getting Started → Concepts. Il définit en un seul endroit le fournisseur de modèle, le profil de risque, l’alias et le reste.

Chaque surface parcourt la même liste de contrôle et écrit la même configuration. Les étapes obligatoires doivent être satisfaites avant que l’agent puisse être créé ; les étapes facultatives peuvent être ignorées.

ÉtapeObligatoireCe qu’il définit
Fournisseur de modèleouiFamille de fournisseurs (Anthropic, OpenAI, Ollama, OpenRouter, …), sa clé API ou son point de terminaison, et le modèle.
Profil de risqueouiAutonomie et posture de bac à sable. Choisissez un préréglage ou réutilisez un [risk_profiles.<alias>] existant.
MémoireouiBackend de mémoire (sqlite, markdown, postgres, qdrant, lucid ou none).
CanauxfacultatifPlateformes de messagerie (Telegram, Discord, Slack, …). Le canal intégré cli fonctionne toujours ; ajoutez les autres ici ou plus tard.
Groupes de pairsfacultatifAppartenance des pairs multi-agents pour les canaux que vous avez configurés.
AgentouiAlias de l’agent, invite système et tous les fichiers de personnalité.

Le profil d’exécution est défini automatiquement. Quickstart installe le préréglage unbounded pour le nouvel agent. Ajustez ensuite les budgets et les délais d’expiration en modifiant [runtime_profiles.<alias>] (voir Référence → Config).

CLI

Le chemin le plus rapide sur une machine sans interface graphique ou via SSH :

sh

zeroclaw quickstart

Vous répondez à une invite par étape dans le terminal. Le canal intégré cli fonctionne immédiatement, donc les sections Channels et Peer groups peuvent être ignorées. Pour une configuration entièrement par défaut, sans approbations, consultez le mode YOLO.

OpenAI Codex auth d’abonnement

Le démarrage rapide peut configurer le chemin d’abonnement OpenAI Codex sans clé API. Authentifiez-vous une fois, puis choisissez OpenAI comme fournisseur et définissez Authentification sur codex lorsque vous y êtes invité :

# Si vous êtes déjà connecté avec le Codex CLI :
zeroclaw auth login --model-provider openai-codex --import ~/.codex/auth.json

# Ou lancer le flux de connexion OpenAI Codex propre à ZeroClaw :
zeroclaw auth login --model-provider openai-codex

Pour une configuration scriptée, openai-codex est accepté comme alias de saisie pour le démarrage rapide et génère l’entrée canonique [providers.models.openai.<alias>] :

zeroclaw quickstart --model-provider openai-codex --model gpt-5.4 --agent assistant

Authentification setup-token abonnement Claude

Le démarrage rapide peut également configurer Claude/Anthropic avec une clé API Console normale ou un token généré par Claude Max :

claude setup-token
zeroclaw quickstart --model-provider anthropic --model claude-sonnet-4-5 --agent assistant

Choisissez Anthropic, définissez Authentification sur setup_token, puis collez le jeton issu de claude setup-token dans l’invite de clé API/jeton. La saisie scriptée peut utiliser --model-provider claude comme alias. Quickstart conserve toujours l’entrée canonique [providers.models.anthropic.<alias>] ; le jeton est stocké via le même chemin d’identifiants que api_key.

zerocode

Dans l’interface de terminal zerocode, le panneau Quickstart est l’un des onglets. Pilotez-le avec le clavier :

Basculez vers le volet Quickstart :

ClésAction
Alt+← / Alt+bpanneau précédent
Alt+→ / Alt+fpanneau suivant

À l’intérieur du volet :

ClésAction
k / ↑précédent
j / ↓suivant
Enterouvrir
q / Escquitter
c / Ccréer un agent

La souris fonctionne aussi : cliquez sur un onglet dans la barre de mode pour changer de volet, cliquez sur une étape pour la sélectionner et l’ouvrir, et faites défiler pour parcourir la liste.

Chaque étape ouvre une fenêtre modale qui reflète la liste de vérification ci-dessus, avec une option « Use existing » qui répertorie les alias correspondants déjà présents dans votre configuration.

Passerelle Web

Avec le démon en cours d’exécution, ouvrez le tableau de bord dans un navigateur :

sh

zeroclaw daemon

zeroclaw daemon exécute le runtime complet : la passerelle, vos canaux configurés, le planificateur et le moniteur de heartbeat. (zeroclaw gateway démarre uniquement la passerelle HTTP si c’est tout ce dont vous avez besoin.)

Visitez ensuite http://127.0.0.1:42617/quickstart. Une nouvelle installation sans agents configurés y redirige automatiquement ; vous pourrez ensuite toujours y accéder depuis la navigation du tableau de bord.

Le formulaire web présente les mêmes étapes sous forme de cartes. Lors de l’envoi, il applique votre soumission via le démon (POST /api/quickstart/apply), qui renvoie une liste d’erreurs structurée si quelque chose est invalide, puis recharge le démon sur place afin que le nouvel agent soit actif sans redémarrage. Un point de terminaison distinct POST /api/quickstart/validate exécute les mêmes vérifications sans les appliquer, pour les clients qui souhaitent valider au préalable.

Après le démarrage rapide

  • Pilotez-le depuis zerocode : l’interface en terminal est le meilleur moyen de discuter, consulter les journaux en direct, gérer la configuration et surveiller le démon, le tout au même endroit. Exécutez simplement zerocode.
  • Petite commande ponctuelle depuis le shell : zeroclaw agent -a <alias> -m "your message".
  • Exécution permanente : zeroclaw service install && zeroclaw service start.
  • Ajouter des canaux plus tard : Canaux → Vue d’ensemble.
  • Ajuster l’autonomie et les budgets : Référence → Config.