quickstart

Démarrage rapide — installer brainclaw avec une seule commande

Ajoutez brainclaw à votre projet en moins d'une minute. Demandez à votre agent de l'installer ; brainclaw s'occupe du reste. Ce guide explique ce qui est créé, pourquoi chaque fichier est important et comment vérifier son fonctionnement.

Le chemin le plus court vers brainclaw est de demander à votre agent IA de l’installer. L’agent installe le package, exécute brainclaw init, qui détecte votre stack, analyse les docs existantes, dérive les graines de mémoire et écrit le fichier d’instruction natif de l’agent (CLAUDE.md, AGENTS.md, .cursor/rules/, .windsurfrules, GEMINI.md, …) afin que la prochaine session de tout agent puisse le récupérer automatiquement.

Installer avec une seule commande

> Please install and initialize brainclaw in this project.
> Run: npm install -g brainclaw && brainclaw init

C’est tout le processus d’intégration pour un développeur solo sur un dépôt vierge. L’agent exécutera les commandes, répondra aux invites interactives (ou utilisera brainclaw init --yes pour les valeurs par défaut), et committera les fichiers générés dans Git.

Quatre chemins de démarrage

La commande unique ci-dessus combine deux éléments qu’il est utile de garder séparés lorsque vous rejoignez un dépôt existant ou que vous intégrez un coéquipier.

1. Configuration de la machine — une seule fois par machine

> Run: npm install -g brainclaw

Installe les binaires brainclaw et bclaw globalement. Ceci est requis pour que le serveur MCP résolve vers un binaire épinglé au lieu d’un re-fetch npx à chaque session d’agent.

2. Nouveau projet — bootstrap

> Run: brainclaw init

Exécuter à la racine du dépôt. Détecte votre stack, dérive les graines de mémoire, écrit le fichier d’instruction natif de l’agent (CLAUDE.md, AGENTS.md, …) et crée .brainclaw/. Committez tout.

3. Rejoindre un dépôt brainclaw existant

Vous avez cloné un dépôt qui contient déjà .brainclaw/ commité. Ne pas exécuter brainclaw init — cela re-scaffolderait et pourrait écraser la mémoire du projet. L’étape 1 (installation machine) est suffisante ; lors de la prochaine session d’agent, le fichier d’instruction existant est lu et la mémoire du projet s’active.

Pour vérifier que le projet est sain :

> Run: brainclaw doctor

4. Bootstrap — la commande unique

Le chemin combiné couvre les cas 1 et 2 en une seule commande :

> Run: npm install -g brainclaw && brainclaw init

Utilisez ceci pour les nouveaux projets. Sautez cette étape (utilisez uniquement l’étape 1) lorsque vous rejoignez un dépôt déjà activé pour brainclaw.

Pourquoi npm install -g en premier, et pas seulement npx brainclaw init ?

npx brainclaw init fonctionne pour l’étape de scaffolding — mais il n’installe pas brainclaw sur la machine. Il télécharge le package dans le cache npx, s’exécute une fois et ne laisse rien derrière. Après init, le .mcp.json généré doit lancer brainclaw mcp chaque fois que l’agent démarre une session. Deux chemins :

  • npm install -g brainclaw (recommandé) — .mcp.json résout vers le binaire global au moment de l’installation ; chaque démarrage MCP est rapide et épinglé à une version connue. Mettez à jour avec npm install -g brainclaw@latest.
  • npx brainclaw init seulement.mcp.json revient à npx brainclaw mcp. Le premier démarrage MCP peut re-télécharger depuis le registre npm (lent, dépendance en ligne). Acceptable pour un essai, fragile pour les projets de longue durée.

Exécutez npx brainclaw doctor après init, quelle que soit la méthode — cela vous indique dans quel mode se trouve le projet et signale tout écart entre la version installée et ce que .mcp.json référence.

Ce qui est créé

Une fois qu’ init est terminé, vous verrez :

.brainclaw/                       # magasin de mémoire du projet (versionné Git)
├── config.yaml                   # nom du projet, id, agent actuel, liens
├── memory/                       # décisions, constraints, traps, instructions — un fichier par élément
├── coordination/                 # plans, claims, handoffs, sessions, agent_runs
├── code/                         # Code Map — index structurel (symboles, imports) ; reconstructible, supprimable sans risque
├── project.md                    # résumé human-readable généré de l'état local
└── audit.log                     # JSONL de chaque mutation d'état

PROJECT.md                        # vos règles de domaine canoniques (racine du dépôt) — injectées dans les fichiers d'agent
CLAUDE.md / AGENTS.md / GEMINI.md # fichier d'instruction natif de l'agent (par agent détecté)
.mcp.json                         # configuration du serveur MCP pour que l'agent puisse communiquer avec brainclaw
.claude/commands/brainclaw.md     # commande slash (Claude Code uniquement)

Commitez .brainclaw/, les fichiers d’agent et .mcp.json. Ce sont la mémoire partagée du projet. D’autres machines et d’autres agents les liront lors de la prochaine session et reprendront le même contexte.

Vérifier son fonctionnement

Lors d’une nouvelle session d’agent, demandez :

> What plans are currently in_progress on this project?

Si l’agent répond avec des éléments de plan concrets, MCP communique avec brainclaw et la mémoire est connectée. S’il dit “Je ne sais pas” ou s’il hallucine une réponse générique, vérifiez :

  • Est-ce que .mcp.json est présent et commité ?
  • Le fichier d’instruction de l’agent (ex. CLAUDE.md) référence-t-il brainclaw ?
  • npx brainclaw doctor a-t-il réussi ?

brainclaw doctor est le diagnostic. Il vérifie l’intégrité du magasin, l’enregistrement des agents, la version du catalogue MCP et signale les candidats à la réparation.

Ce que vous obtenez

  • Mémoire de projet dans .brainclaw/ (versionnée Git, local-first, pas de cloud requis)
  • Une Code Map dans .brainclaw/code/ — un index structurel que les agents interrogent (brainclaw code-map brief <chemin>) pour savoir quoi lire avant de grep
  • Un serveur MCP avec 66+ tools couvrant la session, la mémoire, les claims, les plans, le dispatch, la fédération, le routage inter-projets
  • Fichiers d’instruction natifs de l’agent rafraîchis à la fin de chaque session afin qu’ils reflètent l’état actuel du projet, et non un instantané obsolète
  • Grammaire canonique sur 17 entities — six verbes, chaque entité, aucun outil par entité à apprendre

Prochaines étapes