Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Onboarding

A first run does not open the wizard. OpenCrabs goes straight to the chat, with its built-in provider already provisioned and the agent greeting you. The onboarding wizard is opt-in: run opencrabs --onboard, or /onboard from inside a session.

Les vidéos pas à pas se trouvent sur la page Vidéos d’onboarding.

Démarrage rapide (3 minutes)

La voie rapide vous permet de discuter avec l’agent en moins de 3 minutes.

ÉtapeAction
1. ModeAppuyez sur Enter sur QuickStart
2. Espace de travailAppuyez sur Enter pour accepter le chemin par défaut
3. ProviderUtilisez les flèches pour aller à votre provider (par ex. z.ai), puis appuyez sur Enter. Utilisez la flèche bas pour choisir un forfait (par ex. Coding), puis appuyez sur Enter
4. Clé APICollez votre clé (Cmd+V / Ctrl+V / Cmd+Shift+V / Ctrl+Shift+V), puis appuyez sur Enter. La liste des models se charge en direct
5. ModelUtilisez les flèches pour aller à votre model (par ex. gemini-2.5-pro), puis appuyez sur Enter
6. DaemonUtilisez les flèches pour choisir si OpenCrabs doit tourner en daemon en arrière-plan, puis appuyez sur Enter
7. Vibe CheckToutes les vérifications doivent afficher ✅. Appuyez sur Enter
8. À propos de vousÉcrivez quelques lignes sur vous. Plus l’agent en sait, mieux c’est. Appuyez sur Enter
9. À propos de l’agentDécrivez la personnalité de l’agent. Appuyez sur Enter
10. ChatVous êtes prêt. Commencez à parler à votre agent

Configuration avancée (7 minutes)

Configuration complète avec Telegram, la voix locale, la vision et la génération d’images.

ÉtapeAction
1. ModeAppuyez sur Enter sur QuickStart
2. Espace de travailAppuyez sur Enter pour accepter le chemin par défaut
3. ProviderUtilisez les flèches pour aller à votre provider (par ex. z.ai), puis appuyez sur Enter. Utilisez la flèche bas pour choisir un forfait, puis appuyez sur Enter
4. Clé APICollez votre clé, puis appuyez sur Enter. La liste des models se charge en direct
5. ModelUtilisez les flèches pour aller à votre model, puis appuyez sur Enter
6. ChannelsUtilisez les flèches pour aller à Other, appuyez sur Space pour sélectionner Telegram, puis sur Enter. Collez votre token de bot, suivez les instructions pour obtenir votre chat ID, puis appuyez sur Enter. Choisissez le mode mention, puis appuyez sur Enter. Une fois que Connected s’affiche, appuyez de nouveau sur Enter. Utilisez la flèche bas pour aller à Continue, puis appuyez sur Enter
7. STTSélectionnez Local, puis appuyez sur Enter. Choisissez la taille du model (par ex. tiny pour la vitesse), puis appuyez sur Enter
8. TTSSélectionnez de nouveau Local, puis appuyez sur Enter. Choisissez une voix (par ex. Ryan), puis appuyez sur Enter. Attendez la fin du téléchargement du model, utilisez la flèche bas pour aller à Continue, puis appuyez sur Enter
9. ImageAppuyez sur Space pour sélectionner Vision et Génération d’images, puis appuyez sur Enter. Collez votre clé API Gemini, puis appuyez sur Enter
10. DaemonUtilisez les flèches pour choisir si OpenCrabs doit tourner en daemon en arrière-plan, puis appuyez sur Enter
11. Vibe CheckToutes les vérifications doivent afficher ✅. Appuyez sur Enter
12. À propos de vousÉcrivez quelques lignes sur vous. Plus l’agent en sait, mieux c’est. Appuyez sur Enter
13. À propos de l’agentDécrivez la personnalité de l’agent. Appuyez sur Enter
14. ChatVous êtes prêt. Commencez à parler à votre agent

Déroulement de l’onboarding

L’assistant est une interface TUI pilotée au clavier, en 8 étapes. Naviguez avec les flèches, Tab pour avancer et Esc pour revenir en arrière.

ÉtapeÉcranCe que vous faites
1Choix du modeChoisissez QuickStart (sans les channels) ou Advanced
2Espace de travailChoisissez un répertoire de travail pour les opérations sur les fichiers
3Provider et authentificationChoisissez le provider → collez la clé API → choisissez le model (récupéré en direct)
4ChannelsSpace pour activer ou désactiver les channels → Enter sur chacun pour le configurer
5VoixProvider STT (Groq, Whisper local ou désactivé) + voix TTS
6ImageActivation de la vision + model de génération + clé API
7DaemonInstaller le daemon en arrière-plan (facultatif)
8Configuration du brainGénérer automatiquement SOUL.md à partir de votre profil

Configuration des channels (étape 4)

L’écran des channels liste 5 intégrations : Telegram, Discord, WhatsApp, Slack, Trello.

  • Space active ou désactive un channel
  • Enter sur un channel activé ouvre son écran de configuration (token, identifiants, listes d’autorisation)
  • Enter sur Continue ou Tab passe à l’étape suivante
  • Chaque écran de configuration de channel possède un bouton Test Connection

Consultez Vue d’ensemble des channels pour le guide de navigation complet.

Relancer la configuration

Vous pouvez accéder directement à n’importe quelle étape sans relancer tout l’assistant :

CommandeÉtape
/onboardAssistant complet
/onboard:providerChoix du provider et du model
/onboard:channelsSélection des channels
/onboard:voiceConfiguration de la voix
/onboard:imageConfiguration de l’image
/onboard:brainGénération des brain files

Après l’onboarding, votre agent démarre et se présente. Il lit ses brain files (SOUL.md, AGENTS.md, TOOLS.md) et lance une conversation.

Amorçage

Au tout premier lancement, l’agent passe par une phase d’amorçage :

  • Apprend à vous connaître (nom, préférences, manière de travailler)
  • Définit son identité (nom, personnalité, emoji)
  • Ouvre SOUL.md avec vous pour discuter des valeurs
  • Met en place USER.md avec votre profil

Le fichier d’amorçage (BOOTSTRAP.md) se supprime automatiquement une fois terminé.

Migration depuis un autre outil

Vous utilisez déjà ClaudeCode, OpenClaw, Hermes ou un autre harness d’agent IA ? Votre agent peut migrer vos données existantes (mémoire, skills, commandes personnalisées, préférences) vers ses propres brain files, en langage naturel. Aucune manipulation manuelle de fichiers n’est nécessaire.

Cela fonctionne avec tout agent ou harness de code qui stocke sa configuration en local. La migration recherche dans votre système de fichiers les répertoires de configuration de l’autre outil, lit leur contenu et le transpose dans le format de brain files d’OpenCrabs (SOUL.md, USER.md, TOOLS.md, MEMORY.md, AGENTS.md, CODE.md).

Migration guidée

Si vous souhaitez vérifier ce qui sera migré avant que cela n’ait lieu :

Recherchez mes données ClaudeCode/OpenClaw/Hermes en local (ou tout autre harness d’agent que j’utilisais), auditez une migration vers nos propres brain files, faites-moi un rapport une fois terminé, et exécutez-la quand je confirme et approuve.

L’agent va :

  1. Rechercher dans votre système de fichiers les répertoires de configuration de l’autre outil
  2. Lire et analyser tous les fichiers pertinents (mémoire, commandes, skills, préférences)
  3. Produire un audit indiquant exactement ce qui correspond à quoi
  4. Attendre votre confirmation
  5. Exécuter la migration et fournir un bilan complet

Migration autonome

Si vous voulez simplement que ce soit fait :

Recherchez mes données d’agent ou de harness existantes en local et migrez tout vers nos propres brain files, sans attendre mon approbation. Lancez-vous, planifiez et exécutez, puis faites-moi un bilan complet une fois terminé.

L’agent saute l’étape d’audit, planifie la migration en interne, l’exécute et vous donne un résumé de tout ce qui a été déplacé.

Ce qui est transposé

SourceDestinationExemple
Mémoire / CLAUDE.md / fichiers de contexteMEMORY.mdDécisions de projet, contexte passé
Commandes personnaliséescommands.tomlCommandes slash et leurs définitions
Skills / instructions de l’agentAGENTS.md, TOOLS.mdRègles de workflow, configurations d’outils
Préférences / profil de l’utilisateurUSER.mdNom, fuseau horaire, style de code
Standards de code / règles de lintingCODE.mdGuides de style, conventions

Astuce : Lancez la migration juste après l’onboarding, tant que le contexte est frais. L’agent dispose déjà de votre USER.md et de votre SOUL.md issus de l’assistant : il peut donc fusionner intelligemment au lieu d’écraser.

Commandes principales

CommandeDescription
/helpAfficher toutes les commandes disponibles
/modelsChanger de provider ou de model
/newCréer une nouvelle session
/sessionsPasser d’une session à l’autre
/cdChanger de répertoire de travail
/compactCompacter manuellement le contexte
/evolveTélécharger la dernière version
/rebuildCompiler depuis les sources
/approveDéfinir la politique d’approbation

Modes d’approbation

Contrôlez le niveau d’autonomie de l’agent :

ModeComportement
/approveDemander avant chaque utilisation d’outil (par défaut)
/approve autoApprobation automatique pour cette session
/approve yoloApprobation automatique permanente (conservée)

Répertoire de travail

L’agent travaille dans un répertoire de travail pour ses opérations sur les fichiers. Modifiez-le avec :

  • La commande /cd dans le chat
  • Le sélecteur de répertoire dans le TUI (Tab pour sélectionner)
  • L’outil config_manager set_working_directory

Le répertoire de travail est conservé par session. Changer de session restaure automatiquement le répertoire.

Indication de filtre des models (v0.3.78)

Le sélecteur de model de l’onboarding affiche désormais toujours une indication de filtre au-dessus de la liste des models (“Tapez pour filtrer…”). Auparavant, cette indication n’apparaissait qu’après la saisie, et les utilisateurs ne savaient pas que le filtrage était disponible. De plus, un ID de model saisi exactement l’emporte désormais sur une correspondance partielle : si vous tapez claude-opus-4-8 exactement, ce model est sélectionné même si d’autres models contiennent la même sous-chaîne.