brainclaw / docs

Doc.

Installe brainclaw, puis laisse tes agents partager leur mémoire, claim les fichiers et passer la main proprement.

  • Runtime agent-first
  • État local-first
  • Mémoire lisible dans Git

Quickstart

Quickstart

Utilise cette séquence quand tu onboardes un repo toi-même ou quand tu demandes à un agent de le faire pour toi.

Étape 1 01

Bootstrap le repo

Installe et initialise brainclaw dans le projet pour avoir la mémoire locale, les instructions et l'état de coordination avant le début du travail. L'init construit aussi la Code Map pour que les agents sachent où vivent les choses avant de grep.

npm install -g brainclaw && brainclaw init
Étape 2 02

Ouvre la session avec le contexte vivant

Les agents devraient préférer MCP et charger le contexte de session dès le départ. Les opérateurs peuvent inspecter le même état depuis la CLI.

bclaw context --digest
Étape 3 03

Demande d'abord à la Code Map

Avant d'éditer, demande à la Code Map quoi lire — symboles, imports et la mémoire attachée à ce périmètre — pour que l'agent tombe sur les bons fichiers au lieu de grep à l'aveugle.

brainclaw code-map brief src/views/DocsPage.astro
Étape 4 04

Claime avant de modifier

Crée un plan pour le travail significatif, claime les fichiers ou dossiers touchés, puis laisse l'agent implémenter sur ce scope explicite.

bclaw claim create "Take docs page" --scope src/views/DocsPage.astro
Étape 5 05

Relâche et ferme proprement

Quand la tâche est terminée, relâche le claim et termine la session pour que l'agent ou l'humain suivant reparte d'un état partagé propre.

bclaw session-end --auto-release

Commandes CLI essentielles

Commandes CLI essentielles

La CLI est le chemin opérateur : bootstrap, inspection, coordination et fallback quand MCP n'est pas la surface active.

Bootstrap et inspection

Utilise ces commandes au setup du repo ou pour vérifier l'état courant du projet.

Init

Crée le stockage local, l'identité projet et les instructions destinées aux agents.

npm install -g brainclaw && brainclaw init
Context

Lit un snapshot court et classé du contexte avant d'agir.

bclaw context --digest
Status

Inspecte plans, claims, sessions et santé globale du workspace.

bclaw status

Coordonner le travail

Ce sont les commandes à utiliser quand l'implémentation démarre vraiment.

Plan

Crée un item de travail formel avec intention et priorité explicites.

bclaw plan create "Ship docs landing page" --priority high
Claim

Réserve le scope d'édit avant de toucher au code.

bclaw claim create "Take docs landing page" --scope src/views/DocsPage.astro
Release

Libère le scope une fois la tâche intégrée.

bclaw claim release <claim-id>

Chemin runtime MCP

Chemin runtime MCP

Les agents capables devraient rester sur MCP pour l'état vivant au lieu de reconstruire le contexte à partir de fichiers statiques.

bclaw_work

Ouvre une session, lit le contexte, claim le scope — trois étapes en un appel.

bclaw_context

Récupère le contexte mémoire / board / delta pour le scope courant. Remplace les anciens get_context.

bclaw_find / bclaw_get

Liste ou récupère n'importe quelle entité (plan, decision, claim, handoff, trap, …) — surface de lecture canonique.

bclaw_create / bclaw_update / bclaw_transition

Capture les decisions et traps, édite les plans, fait avancer le cycle de vie — surface d'écriture canonique.

bclaw_coordinate

Assigne du travail, consulte des agents, ouvre des loops de review ou ideation.

bclaw_release_claim

Ferme le claim avec un handoff et met à jour le plan en un appel.

Structure de stockage

Structure de stockage

brainclaw reste local. Le repo garde la mémoire et la coordination en texte clair sous `.brainclaw/`.

Structure typique

.brainclaw/
  memory/
    constraints/
    decisions/
    instructions/
    traps/
  coordination/
    plans/
    claims/
    runtime/
    sessions/
    handoffs/
  code/                  # Code Map index (per-project, rebuildable)
  project.md             # legacy summary (superseded by /PROJECT.md since 1.9)
  config.yaml
PROJECT.md               # canonical human-readable summary (root)
.brainclaw/memory/

La connaissance projet durable que l'agent suivant doit pouvoir reprendre.

.brainclaw/coordination/plans/

Les items de travail partagés avec statut, assigné et claims liés.

.brainclaw/coordination/claims/

Les locks consultatifs sur des fichiers ou dossiers pour réduire les collisions.

.brainclaw/coordination/handoffs/

Les instantanés qu'un agent laisse derrière lui pour que le suivant reprenne sans relire le chat.

.brainclaw/coordination/runtime/

Les observations courtes, breadcrumbs et notes opérationnelles.

.brainclaw/code/

Code Map : index structurel des symboles, imports et composants — reconstructible, supprimable sans risque.

PROJECT.md

Résumé projet lisible par un humain, canonique, à la racine du dépôt (le .brainclaw/project.md hérité en est dérivé).

Concepts et guides

Concepts et guides

Approfondissements sur les primitives, les patterns et les références qui soutiennent la boucle quotidienne de brainclaw.

concepts

bclaw_work et bclaw_context — la boucle quotidienne

Les deux points d'entrée de façade que vous appelez 10 fois par jour. bclaw_work démarre une session, pose un claim sur un périmètre et renvoie le contexte en une seule fois. bclaw_context récupère des vues mémoire ciblées sans cérémonie.

Lire →
concepts

Grammaire canonique — six verbes pour chaque entité

Les six verbes MCP (find/get/create/update/remove/transition) qui fonctionnent uniformément sur chaque entité brainclaw. Apprenez-le une fois, réutilisez-le sur les plans, les décisions, les claims, les handoffs et tout le reste.

Lire →
concepts

Claims et worktrees — agents parallèles sans roulette de fusion

Comment les claims réservent un scope avant les modifications, et comment le worktree automatique par claim isole le travail parallèle. Le pattern qui permet à plusieurs agents de toucher le même dépôt simultanément.

Lire →
concepts

Boucles de coordination — révision et idéation entre plusieurs agents

Motifs de délégation multi-tours : comment brainclaw pilote les cycles de révision et de correction entre deux agents et exécute des boucles d'idéation où un agent critique un autre. Construit sur bclaw_coordinate + bclaw_loop.

Lire →
guides

Monorepo + multi-projet — un espace de travail, plusieurs stores brainclaw

Comment configurer brainclaw sur plusieurs projets connexes sur la même machine : un monorepo avec des stores imbriqués, des dépôts frères liés, ou un espace de travail unique qui coordonne les deux. Les modèles qui évoluent au-delà d'un seul dépôt.

Lire →
guides

Dépannage — pièges courants et comment récupérer

Les quelques modes de défaillance rencontrés lors de sessions multi-agents réelles : claims périmés, dispatch non reçu, serveur MCP retournant un contexte vide, worktree effacé lors d'une fusion. Avec des commandes de récupération.

Lire →
reference

Commandes courantes — votre boucle quotidienne brainclaw

La poignée d'appels MCP et de commandes CLI qui couvrent 90 % du travail quotidien : démarrer une session, lire le contexte, poser un claim sur un périmètre, capturer des décisions.

Lire →

brainclaw

Utilise la boucle courte.

Initialise le repo, ouvre la session, claime le travail, puis laisse l'agent exécuter avec un contexte vivant au lieu d'improviser.