Aller au contenu

README

Guide de Démarrage Progressif — Grimoire Kit

J1 → Première session en 10 minutes S1 → Première semaine productive M1 → Premier mois, maîtrise complète

J1 — Premier Jour (10 min)

1. Installation et setup en une commande

# Chemin recommandé (SDK, aucun clone nécessaire)
pipx install grimoire-kit
cd votre-projet
grimoire up . --name "Mon Projet" --user "Votre Nom" --archetype minimal

grimoire up enchaîne : init express, propagation de l'identité, standard agentique gouverné (profil starter), puis diagnostic. Idempotent — relancez-le quand vous voulez, il ne touche que ce qui manque. Pour le wizard complet : grimoire up . --interactive.

Chemin shell legacy (mode maintenance, nécessite --legacy)
curl -fsSL <url-install.sh> | bash -s -- --legacy \
  --name "Mon Projet" \
  --user "Votre Nom" \
  --archetype minimal
Sans `--legacy`, `install.sh` affiche les instructions SDK et s'arrête.

2. Vérifier l'installation

grimoire doctor

Attendu : tous les checks OK, y compris l'environnement (uv, docker, Qdrant, Ollama — optionnels, avec remédiation affichée si absents). Pour régénérer des wrappers agents ou un .mcp.json manquants : grimoire doctor . --fix.

3. Enrôler vos autres projets (optionnel)

grimoire cockpit scan ~/dev --yes

Détecte récursivement les projets Grimoire de votre machine et les enrôle dans le cockpit multi-projets (grimoire cockpit).

Le registre garde une entrée par projet enrôlé. Quand un projet est supprimé ou déplacé, son entrée survit et pointe dans le vide :

grimoire cockpit prune --dry-run   # voir ce qui partirait
grimoire cockpit prune             # retirer, après confirmation

Par défaut, seules les entrées dont le chemin a disparu sont retirées : un répertoire encore présent a pu être enrôlé délibérément, et supprimer une entrée valide coûte plus cher que d'en garder une douteuse. --stale élargit aux chemins qui existent mais ne portent plus de marqueur Grimoire.

4. Première interaction

Ouvrez VS Code, activez GitHub Copilot Chat, puis tapez :

/grimoire-master

L'agent Grimoire Master se présente avec un menu numéroté. Tapez le numéro d'une option pour commencer.

5. Structure à connaître

votre-projet/
├── _grimoire/                  # Cerveau du projet
│   ├── _config/            # Configuration des agents
│   ├── _memory/            # Mémoire persistante
│   └── bmm/                # Module méthodologie
├── _grimoire-output/           # Artefacts produits
│   ├── planning-artifacts/ # PRD, épics, brainstorms
│   └── implementation-artifacts/
└── project-context.yaml    # Identité du projet

C'est tout pour J1. Vous avez un projet Grimoire fonctionnel.

S1 — Première Semaine

Jour 2-3 : Comprendre les agents

Les agents sont des personas spécialisées. Chacun a un domaine d'expertise :

Agent Spécialité Quand l'utiliser
Grimoire Master Orchestration Commencer ici, il route vers les autres
Analyst (Mary) Business Étude de marché, exigences métier
PM (John) Produit PRD, user stories, priorisation
Architect (Winston) Technique Architecture, choix technologiques
Dev (Amelia) Code Implémentation, TDD
QA (Quinn) Qualité Tests, couverture, E2E
SM (Bob) Agile Sprint planning, backlog

Astuce : tapez /grimoire- dans Copilot Chat pour voir tous les workflows disponibles.

Jour 4-5 : Les modes Plan/Act

Chaque agent supporte deux modes :

  • [PLAN] — L'agent prépare, structure, propose. N'écrit rien sans votre accord.
  • [ACT] — L'agent exécute directement. Mode par défaut.

Pour switcher : tapez [PLAN] ou [ACT] dans le chat.

Règle d'or : Utilisez [PLAN] pour les décisions structurantes, [ACT] pour l'exécution.

Jour 5-7 : Le Completion Contract (CC)

Le CC est la règle fondatrice : un agent qui dit "terminé" doit le prouver.

Avant chaque "fait" : 1. L'agent détecte le stack (Python/Go/TS/...) 2. Lance les vérifications automatiques (tests, lint, build) 3. Affiche &#x2713; CC PASS ou CC FAIL

Si CC FAIL → l'agent corrige automatiquement avant de rendre la main.

M1 — Premier Mois

Semaine 2 : Mémoire et contexte

Le système de mémoire à 4 couches :

  1. shared-context.md — Vérité partagée (stack, conventions, décisions)
  2. agent-learnings/ — Leçons apprises par chaque agent
  3. decisions-log.md — Journal des décisions ADR
  4. Procedural memory — Patterns par type de tâche
# Vérifier la santé de la mémoire
python3 framework/memory/maintenance.py health-check

# Voir l'état de la mémoire
grimoire memory status

Semaine 2-3 : Outils CLI

Le kit inclut une CLI unifiée :

# Vue d'ensemble
bash grimoire.sh status

# Santé du système
bash grimoire.sh doctor

# Liste des outils disponibles
bash grimoire.sh tools

# Qualité des artefacts
grimoire standard score

# Dépendances inter-outils
python3 framework/tools/dep-check.py --project-root . graph

Semaine 3 : Archétypes

Les archétypes sont des configurations pré-packagées pour différents types de projets :

Archétype Pour qui Agents inclus
minimal Tout projet Base seulement
web-app Apps web full-stack Frontend Specialist, Fullstack Dev
infra-ops DevOps/Infrastructure Ops Engineer, SRE
fix-loop Debugging intensif Bug Hunter, Analyzer
features Feature development Tous agents de dev
meta Framework Grimoire lui-même Agent Optimizer, Art Director, Toolsmith
# Installer un archétype
grimoire init . -a web-app

# Lister les archétypes disponibles
grimoire registry list

Semaine 4 : NSO et Intelligence Layer

Le Nervous System Orchestrator (NSO) est le méta-outil qui orchestre tout le système :

# Run complet du système nerveux
python3 framework/tools/nso.py --project-root . run

# Mode rapide
python3 framework/tools/nso.py --project-root . run --quick

# Rétrospective automatique
python3 framework/tools/nso.py --project-root . retro

Workflow typique M1

1. [PLAN] Demander au PM de créer un PRD
2. [PLAN] L'Architect propose l'architecture
3. [ACT]  Le SM découpe en stories
4. [ACT]  Le Dev implémente (TDD + CC)
5. [ACT]  Le QA valide la couverture
6.        Le NSO fait une rétrospective

Aide rapide

Besoin Commande
Aide Grimoire /grimoire-master puis option aide
Diagnostic bash grimoire.sh doctor
Sync config grimoire setup --check
État mémoire python3 framework/memory/maintenance.py status
Qualité sortie grimoire standard score

Grimoire Kit — Documentation progressive. Pour les détails, voir docs/.