brainforge-ai 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +193 -570
  2. package/dist/cli.js +47 -2
  3. package/dist/cli.js.map +1 -1
  4. package/dist/commands/defensePack.d.ts +2 -0
  5. package/dist/commands/defensePack.d.ts.map +1 -0
  6. package/dist/commands/defensePack.js +269 -0
  7. package/dist/commands/defensePack.js.map +1 -0
  8. package/dist/commands/difficulty.d.ts +2 -0
  9. package/dist/commands/difficulty.d.ts.map +1 -0
  10. package/dist/commands/difficulty.js +177 -0
  11. package/dist/commands/difficulty.js.map +1 -0
  12. package/dist/commands/doctor.d.ts.map +1 -1
  13. package/dist/commands/doctor.js +53 -1
  14. package/dist/commands/doctor.js.map +1 -1
  15. package/dist/commands/help.d.ts.map +1 -1
  16. package/dist/commands/help.js +24 -1
  17. package/dist/commands/help.js.map +1 -1
  18. package/dist/commands/init.d.ts +6 -1
  19. package/dist/commands/init.d.ts.map +1 -1
  20. package/dist/commands/init.js +64 -2
  21. package/dist/commands/init.js.map +1 -1
  22. package/dist/commands/professorCheck.d.ts +2 -0
  23. package/dist/commands/professorCheck.d.ts.map +1 -0
  24. package/dist/commands/professorCheck.js +203 -0
  25. package/dist/commands/professorCheck.js.map +1 -0
  26. package/dist/commands/simplify.d.ts +2 -0
  27. package/dist/commands/simplify.d.ts.map +1 -0
  28. package/dist/commands/simplify.js +174 -0
  29. package/dist/commands/simplify.js.map +1 -0
  30. package/dist/commands/status.d.ts +2 -0
  31. package/dist/commands/status.d.ts.map +1 -0
  32. package/dist/commands/status.js +105 -0
  33. package/dist/commands/status.js.map +1 -0
  34. package/dist/commands/study.d.ts +2 -0
  35. package/dist/commands/study.d.ts.map +1 -0
  36. package/dist/commands/study.js +193 -0
  37. package/dist/commands/study.js.map +1 -0
  38. package/dist/commands/update.js +2 -2
  39. package/dist/commands/update.js.map +1 -1
  40. package/dist/core/dashboard.d.ts +41 -0
  41. package/dist/core/dashboard.d.ts.map +1 -1
  42. package/dist/core/dashboard.js +121 -0
  43. package/dist/core/dashboard.js.map +1 -1
  44. package/dist/core/dashboardTemplate.d.ts.map +1 -1
  45. package/dist/core/dashboardTemplate.js +523 -92
  46. package/dist/core/dashboardTemplate.js.map +1 -1
  47. package/dist/core/fileSystem.d.ts.map +1 -1
  48. package/dist/core/fileSystem.js +175 -0
  49. package/dist/core/fileSystem.js.map +1 -1
  50. package/dist/core/templates.d.ts.map +1 -1
  51. package/dist/core/templates.js +652 -233
  52. package/dist/core/templates.js.map +1 -1
  53. package/package.json +5 -1
package/README.md CHANGED
@@ -1,703 +1,326 @@
1
1
  # ⚡ BrainForge
2
2
 
3
- > Transform any idea into a structured, AI-assisted project with agents, slash commands, a phase roadmap, persistent memory, a live dashboard, and **83 Claude Code skills** pre-wired for every task.
3
+ > Un outil qui aide ton IA à coder **correctement et dans l'ordre** au lieu de tout faire d'un coup et n'importe comment.
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/brainforge-ai.svg)](https://www.npmjs.com/package/brainforge-ai)
6
6
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
7
7
  [![Node.js >= 16](https://img.shields.io/badge/node-%3E%3D16-brightgreen)](https://nodejs.org)
8
8
 
9
- ```bash
10
- npx brainforge-ai init
11
- ```
12
-
13
9
  ---
14
10
 
15
- ## What is BrainForge?
11
+ ## C'est quoi BrainForge ?
16
12
 
17
- BrainForge is a CLI that installs a **structured AI development system** into any project directory.
13
+ Quand tu utilises une IA comme Claude ou Copilot pour coder, tu rencontres vite ces problèmes :
18
14
 
19
- Instead of vibing and hoping the AI does the right thing, BrainForge forces a clean workflow:
15
+ - L'IA code tout en une seule fois, et le résultat est trop complexe pour toi
16
+ - Elle oublie le contexte d'une session à l'autre
17
+ - Le code ressemble à du "code de senior" alors que tu es étudiant
18
+ - Tu ne saurais pas l'expliquer à ton prof
19
+
20
+ **BrainForge installe une structure dans ton projet** qui force l'IA à :
21
+
22
+ 1. Planifier avant de coder
23
+ 2. Suivre des phases claires (Planifier → Coder → Tester → Réviser)
24
+ 3. Adapter le code à **ton niveau réel**
25
+ 4. Garder une mémoire persistante entre les sessions
20
26
 
21
27
  ```
22
- Idea Plan Research Execute Test → Review → Commit → Repeat
28
+ Sans BrainForge : l'IA fait tout, tu comprends rien
29
+ Avec BrainForge : l'IA suit tes instructions étape par étape
23
30
  ```
24
31
 
25
- It works with any AI tool: **Claude Code**, **GitHub Copilot**, **Gemini CLI**, **Codex**, **Cursor**, **OpenCode**.
26
-
27
32
  ---
28
33
 
29
- ## Why use it?
34
+ ## Aperçu du dashboard
30
35
 
31
- | Without BrainForge | With BrainForge |
32
- |--------------------|-----------------|
33
- | AI codes everything at once | AI follows a phase plan |
34
- | No memory between sessions | Persistent project memory |
35
- | Hard to explain your code | `/explain-my-code` generates your defense speech |
36
- | Code looks too AI-perfect | Code Level Engine adapts to your real level |
37
- | No tests | `/write-tests` generates the right tests for your level |
38
- | No version history | Automatic git checkpoints |
39
- | Lost in files | Live dashboard with auto-reload |
40
- | AI ignores best practices | 83 skills enforce the right patterns per task |
36
+ ![BrainForge dashboard preview](./assets/screenshots/dashboard.png)
41
37
 
42
38
  ---
43
39
 
44
- ## Installation
40
+ ## Ce qu'il te faut avant de commencer
45
41
 
46
- ### Run directly (no install needed)
42
+ - **Node.js** (version 16 ou plus) — [télécharger ici](https://nodejs.org)
43
+ - **Git** — recommandé pour sauvegarder ton travail automatiquement
44
+ - Un **outil IA** : Claude Code, Cursor, GitHub Copilot, Gemini CLI, ou autre
47
45
 
48
- ```bash
49
- npx brainforge-ai init
50
- ```
51
-
52
- ### Install globally
53
-
54
- ```bash
55
- npm install -g brainforge-ai
56
- brainforge init
57
- ```
46
+ > Tu peux vérifier si Node.js est installé en tapant `node --version` dans ton terminal.
58
47
 
59
48
  ---
60
49
 
61
- ## Quick Start
50
+ ## Démarrage rapide (5 minutes)
62
51
 
63
- ### 1. Initialize BrainForge in your project
52
+ ### Étape 1 Lance BrainForge dans ton projet
64
53
 
65
54
  ```bash
66
- mkdir my-project
67
- cd my-project
55
+ mkdir mon-projet
56
+ cd mon-projet
68
57
  npx brainforge-ai init
69
58
  ```
70
59
 
71
- Answer the questions:
72
- - Project name and description
73
- - Project type (web app, API, fullstack, mobile…)
74
- - Stack (React, Node.js, PostgreSQL…)
75
- - Your actual coding level
76
- - Target code level
77
- - Whether it's a school project
60
+ L'outil va te poser quelques questions simples :
61
+ - Nom et description du projet
62
+ - Type de projet (site web, API, app mobile…)
63
+ - Les technologies que tu utilises (React, Node.js, Python…)
64
+ - Ton niveau de code actuel
65
+ - Si c'est un projet scolaire
66
+
67
+ Ensuite il génère tout automatiquement et fait le premier commit git.
78
68
 
79
- BrainForge generates the full structure and makes the first git commit automatically.
69
+ > **Pas envie de répondre aux questions ?** Utilise `--yes` pour tout passer avec les valeurs par défaut :
70
+ > ```bash
71
+ > npx brainforge-ai init --yes
72
+ > ```
80
73
 
81
74
  ---
82
75
 
83
- ### 2. Open your AI tool and start working
76
+ ### Étape 2 Ouvre ton outil IA dans le dossier du projet
84
77
 
85
- Open **Claude Code**, **Cursor**, or any AI tool in the project folder.
78
+ Ouvre **Claude Code**, **Cursor**, ou ton outil préféré dans le dossier que tu viens de créer.
86
79
 
87
- The AI reads `AGENTS.md` and `CLAUDE.md` automatically, which includes a mandatory skills table telling it exactly which skill file to load for every type of task.
80
+ L'IA lira automatiquement les fichiers `AGENTS.md` et `CLAUDE.md` générés par BrainForge elle sait donc quoi faire et comment se comporter.
88
81
 
89
82
  ---
90
83
 
91
- ### 3. Follow the workflow with slash commands
92
-
93
- #### Step 1 — Document the project
94
- ```
95
- /start-project
96
- ```
97
- Describe your idea. The AI asks questions and fills in `.brainforge/project.md`.
84
+ ### Étape 3 Suis le workflow avec des commandes
98
85
 
99
- #### Step 2 Create the roadmap
100
- ```
101
- /create-roadmap
102
- ```
103
- Breaks the project into phases with tasks and checklists.
86
+ Tape ces commandes directement dans ton outil IA, dans l'ordre :
104
87
 
105
- #### Step 3 Prepare a phase (before coding)
106
- ```
107
- /initiate-phase 1
108
- ```
109
- Research + planning. The AI proposes an approach and waits for your confirmation.
88
+ | Commande | Ce que ça fait |
89
+ |----------|---------------|
90
+ | `/start-project` | Tu décris ton idée, l'IA pose des questions et remplit le fichier projet |
91
+ | `/create-roadmap` | L'IA divise ton projet en phases avec des tâches précises |
92
+ | `/initiate-phase 1` | L'IA planifie la phase 1 et attend ta validation avant de coder |
93
+ | `/execute-phase 1` | L'IA code **uniquement ce qui était prévu** — rien de plus |
94
+ | `/write-tests` | Génère des tests adaptés à ton niveau |
95
+ | `/review-phase 1` | Vérifie les bugs, la complexité, et si le code est trop "AI-looking" |
96
+ | `/checkpoint` | Sauvegarde ton travail avec git (ne pousse jamais automatiquement) |
110
97
 
111
- #### Step 4 Execute the phase
112
- ```
113
- /execute-phase 1
114
- ```
115
- The AI codes **only what was planned**. Nothing more.
98
+ Répète `/initiate-phase`, `/execute-phase`, `/review-phase`, `/checkpoint` pour chaque phase.
116
99
 
117
- #### Step 5 — Write tests
118
- ```
119
- /write-tests
120
- ```
121
- Generates tests adapted to your stack and code level.
122
-
123
- #### Step 6 — Review the phase
124
- ```
125
- /review-phase 1
126
- ```
127
- Checks for bugs, dead code, complexity, and level-appropriateness.
100
+ ---
128
101
 
129
- #### Step 7Save your progress
130
- ```
131
- /checkpoint
132
- ```
133
- Creates a local git commit. Never pushes automatically.
102
+ ### Étape 4Surveille ta progression avec le dashboard
134
103
 
135
- #### Step 8 — Watch the dashboard update live
136
104
  ```bash
137
105
  brainforge serve
138
106
  ```
139
- Opens `localhost:3000` — reloads automatically as you work.
140
107
 
141
- Repeat steps 3–8 for each phase.
108
+ Ouvre `localhost:3000` dans ton navigateur — il se recharge automatiquement pendant que tu travailles.
142
109
 
143
110
  ---
144
111
 
145
- ## CLI Commands
146
-
147
- | Command | Description |
148
- |---------|-------------|
149
- | `brainforge init` | Initialize BrainForge in the current directory |
150
- | `brainforge update` | Refresh all agents, commands, and skills to latest version |
151
- | `brainforge serve` | Live dashboard on localhost:3000 (auto-reloads) |
152
- | `brainforge dashboard` | Open the static HTML dashboard in the browser |
153
- | `brainforge update-dashboard` | Refresh dashboard data from project state |
154
- | `brainforge doctor` | Health check — verify all files and setup |
155
- | `brainforge guide` | Show all CLI and slash commands with project status |
156
- | `brainforge version` | Show version info |
157
-
158
- ---
112
+ ## Commandes spéciales pour les étudiants
159
113
 
160
- ## Claude Code Skills 83 Pre-Wired Best-Practice Guides
114
+ Si tu rends un projet scolaire, ces commandes sont faites pour toi :
161
115
 
162
- Every project initialized with BrainForge gets **83 skill files** installed in `.claude/skills/`. Claude Code reads these automatically when you trigger a matching task.
116
+ ### `brainforge simplify`
163
117
 
164
- Every agent and the `CLAUDE.md` instruction file include a mandatory skills table — Claude **must** read the relevant skill before starting any task. No exceptions.
118
+ ```bash
119
+ brainforge simplify
120
+ ```
165
121
 
166
- ### How it works
122
+ Génère un prompt pour **simplifier le code** à ton niveau réel. Utile avant de rendre un projet pour que le code soit expliquable.
167
123
 
124
+ Ensuite dans ton outil IA :
168
125
  ```
169
- You type: /execute-phase 1 (which involves React + TypeScript + API)
170
-
171
- Coder agent reads its skills table
172
-
173
- Loads: react-best-practices.md + typescript-patterns.md + api-design.md
174
-
175
- Codes with enforced best practices for all three technologies
126
+ /simplify-codebase
176
127
  ```
177
128
 
178
- ### Skills by Category
179
-
180
- #### Core Engineering
181
- | Skill | What it enforces |
182
- |-------|-----------------|
183
- | `software-architecture` | System design, folder structure, module boundaries |
184
- | `typescript-patterns` | Strict typing, generics, discriminated unions |
185
- | `ag-clean-code` | SOLID principles, naming conventions, refactoring |
186
- | `ag-systematic-debugging` | Hypothesis-driven, evidence-first debugging |
187
- | `error-handling` | Result types, typed errors, retry logic |
188
- | `environment-config` | `.env` management, secrets, Zod validation |
189
- | `logging-observability` | Structured logging, tracing, OpenTelemetry |
190
- | `static-analysis` | ESLint, Semgrep, CodeQL, CVE scanning |
191
-
192
- #### Frontend & UI
193
- | Skill | What it enforces |
194
- |-------|-----------------|
195
- | `react-best-practices` | Components, hooks, state management patterns |
196
- | `next-best-practices` | Routing, SSR, caching, server actions |
197
- | `tailwind-css` | Utility classes, responsive design, dark mode |
198
- | `ag-tailwind-v4` | Tailwind v4 specifics, new API surface |
199
- | `web-performance` | Core Web Vitals, bundle size, lazy loading |
200
- | `accessibility` | WCAG 2.1, ARIA, keyboard navigation |
201
- | `ag-frontend-design` | Component layout, UX patterns |
202
- | `ag-web-design-guidelines` | Visual hierarchy, spacing, typography rules |
203
- | `figma-to-code` | Design handoff, CSS mapping from Figma |
204
- | `seo-optimization` | Meta tags, schema markup, Open Graph |
205
- | `internationalization` | i18n, locale detection, date/currency formatting |
206
- | `svelte-sveltekit` | Svelte 5, SvelteKit routes and actions |
207
- | `vue-nuxt` | Vue 3, Nuxt 3, Pinia, composables |
208
- | `angular-development` | Angular 17+, signals, standalone components |
209
- | `ag-mobile-design` | Mobile UI, React Native, Expo patterns |
210
-
211
- #### Backend & APIs
212
- | Skill | What it enforces |
213
- |-------|-----------------|
214
- | `api-design` | REST API design, OpenAPI, status codes |
215
- | `ag-api-patterns` | REST/RPC patterns, versioning, contracts |
216
- | `ag-nodejs-best-practices` | Node.js streams, modules, async patterns |
217
- | `ag-python-patterns` | Python packaging, type hints, idioms |
218
- | `ag-rust-pro` | Rust ownership, lifetimes, async, traits |
219
- | `graphql-api` | GraphQL schema, Apollo, DataLoader |
220
- | `websockets-realtime` | WebSockets, SSE, real-time architecture |
221
- | `event-driven-arch` | Pub/sub, message queues, BullMQ |
222
- | `rate-limiting` | Throttling, abuse prevention strategies |
223
- | `file-uploads` | S3, multipart, image processing |
224
- | `email-service` | Transactional email, Resend, templates |
225
- | `caching-redis` | Redis, TTL strategies, cache invalidation |
226
- | `monorepo` | Turborepo, pnpm workspaces, shared packages |
227
-
228
- #### Database
229
- | Skill | What it enforces |
230
- |-------|-----------------|
231
- | `database-queries` | Queries, migrations, ORM patterns |
232
- | `ag-database-design` | Schema design, normalization, ER modeling |
233
- | `postgres-best-practices` | PostgreSQL, indexes, RLS, query optimization |
234
-
235
- #### Security & Auth
236
- | Skill | What it enforces |
237
- |-------|-----------------|
238
- | `security-review` | Auth, access control, input validation |
239
- | `authentication-oauth` | JWT, OAuth2, session flows |
240
- | `better-auth` | Better Auth setup, OAuth providers, 2FA |
241
- | `ag-vulnerability-scanner` | OWASP Top 10, CVE scanning, threat modeling |
242
- | `ag-red-team-tactics` | Threat modeling, adversarial testing |
243
-
244
- #### Testing
245
- | Skill | What it enforces |
246
- |-------|-----------------|
247
- | `test-driven-development` | TDD cycles, test structure, coverage |
248
- | `ag-tdd-workflow` | Red-green-refactor discipline |
249
- | `ag-testing-patterns` | Mocks, fixtures, factories, coverage |
250
- | `webapp-testing` | Browser/UI testing, Playwright |
251
- | `api-testing` | Integration tests, Supertest patterns |
252
- | `property-based-testing` | Fuzz testing, generative test cases |
253
-
254
- #### DevOps & Deployment
255
- | Skill | What it enforces |
256
- |-------|-----------------|
257
- | `docker-devops` | Docker, compose, multi-stage builds |
258
- | `terraform-infrastructure` | IaC, Terraform, cloud provisioning |
259
- | `ag-deployment-procedures` | Deployment runbooks, rollback plans |
260
- | `ag-server-management` | nginx, systemd, server hardening |
261
- | `vercel-deployment` | Vercel deployment, edge middleware |
262
- | `netlify-deployment` | Netlify functions, forms, deployment |
263
- | `cloudflare-workers` | Cloudflare Workers, KV, Wrangler |
264
- | `github-workflow` | GitHub PRs, code review, CI/CD |
265
-
266
- #### Cloud Services & SaaS
267
- | Skill | What it enforces |
268
- |-------|-----------------|
269
- | `supabase` | Supabase auth, DB, storage, realtime |
270
- | `stripe-integration` | Stripe payments, subscriptions, webhooks |
271
- | `openai-integration` | OpenAI API, embeddings, tool use |
272
- | `huggingface-ml` | Hugging Face models, inference |
273
- | `sentry-monitoring` | Error tracking, alerts, performance |
274
- | `sanity-cms` | Sanity CMS, GROQ queries, schema |
275
- | `web-scraping` | Firecrawl, Playwright extraction |
276
- | `connect` | Third-party API integration patterns |
277
- | `composio-connect` | 1000+ SaaS integrations via Composio |
278
-
279
- #### Documentation & Process
280
- | Skill | What it enforces |
281
- |-------|-----------------|
282
- | `documentation` | Inline docs, README, JSDoc |
283
- | `content-writing` | Technical writing, copywriting |
284
- | `ag-documentation-templates` | Spec templates, ADR format |
285
- | `changelog` | Changelog format, release notes |
286
- | `deep-research` | Multi-step research with citations |
287
- | `prompt-engineering` | AI prompt crafting, optimization |
288
- | `subagent-development` | Parallel agents, task decomposition |
289
-
290
- #### Architecture & Planning
291
- | Skill | What it enforces |
292
- |-------|-----------------|
293
- | `ag-architecture` | High-level architecture decisions, ADRs |
294
- | `ag-app-builder` | Full app scaffolding, feature planning |
295
- | `ag-plan-writing` | Technical specs, scope documents |
296
- | `ag-intelligent-routing` | Agent routing, task delegation |
297
- | `ag-parallel-agents` | Parallel task splitting, fan-out patterns |
298
- | `ag-brainstorming` | Idea generation, creative problem solving |
299
-
300
- #### Language & Platform Specific
301
- | Skill | What it enforces |
302
- |-------|-----------------|
303
- | `ag-bash-linux` | Bash scripting, Linux CLI, shell automation |
304
- | `ag-powershell-windows` | PowerShell scripting, Windows automation |
305
- | `ag-mcp-builder` | MCP server and tool building |
306
- | `ag-game-development` | Game loops, physics, entity systems |
307
- | `ag-geo-fundamentals` | GIS, coordinates, spatial queries |
308
- | `ag-performance-profiling` | Flame graphs, APM, bottleneck analysis |
309
- | `code-review` | Code review process and quality gates |
310
- | `git-workflow` | Git operations, branching, commit conventions |
311
- | `ag-lint-and-validate` | Linting pipelines, formatting enforcement |
312
- | `ag-code-review-checklist` | PR checklists, review standards |
313
- | `ag-behavioral-modes` | Agent persona and mode switching |
129
+ ### `brainforge professor-check`
314
130
 
315
- ---
316
-
317
- ## 41 Specialized Agents
318
-
319
- BrainForge installs **41 agent files** in `.brainforge/agents/`. Every agent has a `## Skills — Read BEFORE Starting` section that specifies exactly which skill files to load before starting work.
320
-
321
- ### Core Workflow Agents
322
-
323
- | Agent | Role |
324
- |-------|------|
325
- | `architect` | System design, folder structure, architecture decisions |
326
- | `researcher` | Pre-implementation technical research |
327
- | `planner` | Phase planning and task breakdown |
328
- | `coder` | Implementation — reads 40+ skills based on task type |
329
- | `reviewer` | Code review — bugs, security, level-appropriateness |
330
- | `teacher` | Explain code, prepare for presentations/defenses |
331
- | `git-agent` | Local commits and checkpoints (never pushes) |
332
- | `dashboard-agent` | Keep the live dashboard up to date |
333
-
334
- ### Advanced Agents (brainforge-*)
335
-
336
- These agents handle complex workflows: atomic code fixes, adversarial reviews, AI framework selection, UI auditing, security verification, and more.
337
-
338
- | Agent | Role |
339
- |-------|------|
340
- | `brainforge-advisor-researcher` | Research gray-area decisions — returns comparison tables |
341
- | `brainforge-ai-researcher` | AI/LLM framework implementation guidance |
342
- | `brainforge-assumptions-analyzer` | Extract codebase assumptions with evidence |
343
- | `brainforge-code-fixer` | Atomic fix application with rollback and verification |
344
- | `brainforge-code-reviewer` | Adversarial review → structured REVIEW.md |
345
- | `brainforge-codebase-mapper` | Analyze codebase: tech, arch, quality, concerns |
346
- | `brainforge-debug-session-manager` | Multi-cycle debug session orchestration |
347
- | `brainforge-debugger` | Scientific root cause investigation |
348
- | `brainforge-doc-classifier` | Classify planning docs: ADR/PRD/SPEC/DOC/UNKNOWN |
349
- | `brainforge-doc-synthesizer` | Merge classified docs, surface conflicts |
350
- | `brainforge-doc-verifier` | Verify doc claims against live codebase |
351
- | `brainforge-doc-writer` | Codebase-verified documentation writing |
352
- | `brainforge-domain-researcher` | AI system domain and eval criteria research |
353
- | `brainforge-eval-auditor` | Retroactive AI evaluation coverage audit |
354
- | `brainforge-eval-planner` | AI evaluation strategy design |
355
- | `brainforge-executor` | Atomic PLAN.md execution with TDD support |
356
- | `brainforge-framework-selector` | AI/LLM framework selection interview |
357
- | `brainforge-integration-checker` | Verify cross-phase wiring end-to-end |
358
- | `brainforge-intel-updater` | Generate structured codebase intel files |
359
- | `brainforge-nyquist-auditor` | Adversarial test gap closure |
360
- | `brainforge-pattern-mapper` | Map new files to existing code analogs |
361
- | `brainforge-phase-researcher` | Pre-planning domain investigation |
362
- | `brainforge-plan-checker` | 12-dimension plan verification |
363
- | `brainforge-planner` | Goal-backward phase plan creation |
364
- | `brainforge-project-researcher` | Ecosystem research before roadmap |
365
- | `brainforge-research-synthesizer` | Synthesize parallel researcher outputs |
366
- | `brainforge-roadmapper` | Requirements → phase roadmap |
367
- | `brainforge-security-auditor` | Threat model mitigation verification |
368
- | `brainforge-ui-auditor` | 6-pillar frontend implementation audit |
369
- | `brainforge-ui-checker` | UI-SPEC.md quality gate |
370
- | `brainforge-ui-researcher` | UI design contract creation |
371
- | `brainforge-user-profiler` | Analyze developer behavior across 8 dimensions |
372
- | `brainforge-verifier` | Goal-backward phase completion verification |
373
-
374
- ---
375
-
376
- ## Slash Commands
377
-
378
- These are prompt files in `.brainforge/commands/` — paste the command name into your AI tool.
379
-
380
- ### Project Setup
381
-
382
- | Command | What it does |
383
- |---------|-------------|
384
- | `/start-project` | Document your idea and gather all project info |
385
- | `/create-roadmap` | Break project into phases (Epic › Feature › Task) |
131
+ ```bash
132
+ brainforge professor-check
133
+ ```
386
134
 
387
- ### Phase Workflow
135
+ Génère un prompt pour **détecter les patterns qui semblent trop AI-générés**. Le but : vérifier que tu peux défendre chaque ligne devant un prof.
388
136
 
389
- | Command | What it does |
390
- |---------|-------------|
391
- | `/initiate-phase N` | Research + plan phase N before any coding |
392
- | `/execute-phase N` | Code phase N following the plan exactly |
393
- | `/review-phase N` | Quality review — bugs, level check, academic check |
394
- | `/checkpoint` | Local git commit (never pushes automatically) |
137
+ Ensuite dans ton outil IA :
138
+ ```
139
+ /professor-check
140
+ ```
395
141
 
396
- ### Code Quality
142
+ > Ces outils ne t'aident pas à tricher — ils t'aident à t'assurer que tu comprends ton propre code.
397
143
 
398
- | Command | What it does |
399
- |---------|-------------|
400
- | `/write-tests` | Generate tests for a file, function, or phase |
401
- | `/humanize-code` | Adapt code to match your real coding level |
402
- | `/debug-issue` | Systematic bug analysis and fix |
144
+ ---
403
145
 
404
- ### Student Tools
146
+ ## Les niveaux de code
405
147
 
406
- | Command | What it does |
407
- |---------|-------------|
408
- | `/explain-my-code` | Generate an explanation for your professor or team |
409
- | `/professor-check` | Detect code that looks suspiciously AI-generated |
410
- | `/generate-report` | Generate an academic report template |
148
+ BrainForge adapte le code généré à ton niveau :
411
149
 
412
- ### Documentation & UI
150
+ | Niveau | Pour qui | Ce que ça produit |
151
+ |--------|----------|------------------|
152
+ | `beginner` | 1ère année | Fonctions simples, logique directe, commentaires en français |
153
+ | `intermediate` | 1-3 ans d'expérience | Structure propre, composants réutilisables |
154
+ | `academic-realistic` | Projets scolaires / PFA | Code propre mais expliquable ligne par ligne — pas de patterns "enterprise" |
155
+ | `professional` | Projets de production | Typé, testé, sécurisé, scalable |
413
156
 
414
- | Command | What it does |
415
- |---------|-------------|
416
- | `/design-system` | Create a UI/UX design system guide |
417
- | `/generate-docs` | Generate README and docs/ folder |
418
- | `/update-dashboard` | Refresh the HTML dashboard data |
157
+ Le niveau **`academic-realistic`** est le plus utile pour les étudiants : le code est assez propre pour avoir une bonne note, mais assez simple pour l'expliquer en soutenance.
419
158
 
420
159
  ---
421
160
 
422
- ## The Live Dashboard
423
-
424
- Run `brainforge serve` to open a live dashboard at `localhost:3000`.
425
-
426
- It **auto-reloads** every time a file in `.brainforge/` changes — no manual refresh needed.
161
+ ## Toutes les commandes CLI
427
162
 
428
163
  ```bash
429
- brainforge serve # localhost:3000
430
- brainforge serve --port 4000 # custom port
164
+ brainforge init # Initialiser BrainForge dans le dossier actuel
165
+ brainforge init --yes # Init sans questions (valeurs par défaut)
166
+ brainforge status # Voir l'état du projet en un coup d'œil
167
+ brainforge serve # Dashboard live sur localhost:3000
168
+ brainforge simplify # Générer un prompt de simplification du code
169
+ brainforge professor-check # Générer une vérification académique
170
+ brainforge update # Mettre à jour les agents et skills à la dernière version
171
+ brainforge doctor # Vérifier que tout est bien installé
172
+ brainforge guide # Voir toutes les commandes disponibles
431
173
  ```
432
174
 
433
- It shows:
434
- - Project name, description, stack, and level
435
- - Phase progress bar
436
- - Status of each phase (pending / in-progress / done)
437
- - Recent git commits
438
- - Known bugs
439
- - Last architecture decisions
440
- - Git status
441
- - A green dot in the corner when live reload is active
442
-
443
175
  ---
444
176
 
445
- ## Code Level Engine
177
+ ## Ce que BrainForge génère dans ton projet
446
178
 
447
- BrainForge adapts all generated and reviewed code to your target level:
179
+ Après `brainforge init`, tu obtiens cette structure :
448
180
 
449
- | Level | Who it's for | What it produces |
450
- |-------|-------------|-----------------|
451
- | `beginner` | First year students | Simple functions, direct logic, FR comments |
452
- | `intermediate` | 1-3 years experience | Clean structure, reusable components |
453
- | `academic-realistic` | School / PFA projects | Credible student code — clean but explainable |
454
- | `professional` | Production projects | Typed, tested, secure, scalable |
181
+ ```
182
+ mon-projet/
183
+ .brainforge/
184
+ config.json ← tes paramètres (niveau, stack, phases…)
185
+ project.md ← description de ton projet
186
+ roadmap.md ← ton plan de travail par phases
187
+ memory/ ← mémoire persistante (l'IA s'en souvient entre sessions)
188
+ architecture.md ← notes techniques
189
+ known-bugs.md ← bugs connus
190
+ coding-style.md ← règles de style adaptées à ton niveau
191
+ phases/ ← un fichier par phase avec la checklist
192
+ agents/ ← 41 rôles d'IA spécialisés (architecte, codeur, reviewer…)
193
+ commands/ ← les fichiers de commandes slash
194
+ dashboard/ ← le dashboard HTML
195
+ .claude/
196
+ skills/ ← 83 guides de bonnes pratiques (chargés automatiquement)
197
+ AGENTS.md ← instructions pour tous les outils IA
198
+ CLAUDE.md ← config Claude Code
199
+ GEMINI.md ← config Gemini CLI
200
+ OPENAI.md ← config Codex / ChatGPT
201
+ ```
455
202
 
456
- ### The `academic-realistic` level
203
+ ---
457
204
 
458
- The most important level for students. It produces code that:
205
+ ## Exemples concrets
459
206
 
460
- - Is clean enough to get a good grade
461
- - ✅ Is simple enough to explain line by line in an oral defense
462
- - ✅ Has no enterprise patterns that would raise suspicion
463
- - ✅ Looks like it was written by a good student, not a senior engineer
464
- - ✅ Has natural comments — not AI-generated-sounding ones
207
+ ### Projet scolaire / PFA
465
208
 
466
- ---
209
+ ```bash
210
+ npx brainforge-ai init
211
+ # Choisir "academic-realistic" comme niveau
212
+ # Dans ton outil IA :
213
+ # → /start-project → /create-roadmap → /initiate-phase 1 → /execute-phase 1
214
+ # → /write-tests → /review-phase 1 → /checkpoint
215
+ # Avant de rendre :
216
+ # → brainforge simplify (simplifier le code)
217
+ # → brainforge professor-check (vérifier l'authenticité)
218
+ # → /professor-check (rapport complet)
219
+ ```
467
220
 
468
- ## `/write-tests` Test Generator
221
+ ### Apprendre un nouveau langage
469
222
 
470
- The `/write-tests` command generates tests adapted to your project:
223
+ ```bash
224
+ npx brainforge-ai init
225
+ # Choisir "beginner" ou "intermediate"
226
+ # → /explain-my-code après chaque phase pour comprendre ce qui a été construit
227
+ ```
471
228
 
472
- - **Detects the right framework** automatically (Jest, Vitest, pytest, PHPUnit…)
473
- - **Adapts test complexity** to your code level
474
- - **Beginner:** 2-3 tests per function, happy path only, no mocks
475
- - **Academic-realistic:** happy path + edge cases, mocks for external services, readable names
476
- - **Professional:** full coverage, integration tests, all error paths
229
+ ### Projet personnel
477
230
 
478
- ```
479
- /write-tests src/auth/login.ts
480
- /write-tests the login feature
481
- /write-tests phase 2
231
+ ```bash
232
+ npx brainforge-ai init
233
+ # Choisir "intermediate" ou "professional"
234
+ # brainforge serve ← garder le dashboard ouvert pendant que tu codes
482
235
  ```
483
236
 
484
237
  ---
485
238
 
486
- ## Project Structure
239
+ ## Règles git
487
240
 
488
- After `brainforge init`, your project contains:
241
+ BrainForge utilise git pour sauvegarder ton travail, mais **ne pousse jamais automatiquement** :
489
242
 
490
- ```
491
- .brainforge/
492
- config.json ← project config (level, stack, phases…)
493
- project.md ← project definition
494
- questions.md ← answered questions from init
495
- decisions.md ← architecture decision log
496
- roadmap.md ← full roadmap
497
- memory/
498
- architecture.md ← technical notes (updated each phase)
499
- coding-style.md ← code level rules
500
- known-bugs.md ← bug tracker
501
- glossary.md ← project vocabulary
502
- design-system.md ← UI/UX guide
503
- phases/
504
- phase-01.md ← plan + checklist for phase 1
505
- phase-02.md
506
- agents/ ← 41 specialized AI agents
507
- architect.md
508
- researcher.md
509
- planner.md
510
- coder.md
511
- reviewer.md
512
- teacher.md
513
- git-agent.md
514
- dashboard-agent.md
515
- brainforge-advisor-researcher.md
516
- brainforge-ai-researcher.md
517
- brainforge-assumptions-analyzer.md
518
- brainforge-code-fixer.md
519
- brainforge-code-reviewer.md
520
- brainforge-codebase-mapper.md
521
- brainforge-debug-session-manager.md
522
- brainforge-debugger.md
523
- brainforge-doc-classifier.md
524
- brainforge-doc-synthesizer.md
525
- brainforge-doc-verifier.md
526
- brainforge-doc-writer.md
527
- brainforge-domain-researcher.md
528
- brainforge-eval-auditor.md
529
- brainforge-eval-planner.md
530
- brainforge-executor.md
531
- brainforge-framework-selector.md
532
- brainforge-integration-checker.md
533
- brainforge-intel-updater.md
534
- brainforge-nyquist-auditor.md
535
- brainforge-pattern-mapper.md
536
- brainforge-phase-researcher.md
537
- brainforge-plan-checker.md
538
- brainforge-planner.md
539
- brainforge-project-researcher.md
540
- brainforge-research-synthesizer.md
541
- brainforge-roadmapper.md
542
- brainforge-security-auditor.md
543
- brainforge-ui-auditor.md
544
- brainforge-ui-checker.md
545
- brainforge-ui-researcher.md
546
- brainforge-user-profiler.md
547
- brainforge-verifier.md
548
- commands/
549
- start-project.md
550
- create-roadmap.md
551
- initiate-phase.md
552
- execute-phase.md
553
- review-phase.md
554
- write-tests.md
555
- humanize-code.md
556
- explain-my-code.md
557
- professor-check.md
558
- checkpoint.md
559
- debug-issue.md
560
- design-system.md
561
- generate-docs.md
562
- generate-report.md
563
- update-dashboard.md
564
- dashboard/
565
- index.html ← visual dashboard
566
- style.css
567
- data.json
568
- .claude/
569
- skills/ ← 83 Claude Code skill files (auto-loaded by agents)
570
- software-architecture.md
571
- typescript-patterns.md
572
- react-best-practices.md
573
- next-best-practices.md
574
- api-design.md
575
- database-queries.md
576
- security-review.md
577
- git-workflow.md
578
- test-driven-development.md
579
- code-review.md
580
- … (83 total)
581
- AGENTS.md ← instructions for all AI agents
582
- CLAUDE.md ← Claude Code config + mandatory skills table
583
- GEMINI.md ← Gemini CLI config
584
- OPENAI.md ← OpenAI / Codex config
585
- ```
243
+ | Action | Comportement |
244
+ |--------|-------------|
245
+ | `git init` | Automatique au premier `init` |
246
+ | Commit (`/checkpoint`) | Oui, local uniquement |
247
+ | Push vers GitHub | ❌ Jamais automatique — c'est toi qui décides |
586
248
 
587
249
  ---
588
250
 
589
- ## Keeping Skills & Agents Up to Date
251
+ ## Dépannage
590
252
 
591
- Run `brainforge update` at any time to refresh all agent files, skill files, and slash commands to the latest version — without touching your project data (project.md, phases/, memory/, decisions.md are never modified).
253
+ **BrainForge ne se lance pas ?**
254
+ ```bash
255
+ node --version # Doit afficher v16 ou plus
256
+ brainforge doctor # Vérifie l'installation
257
+ ```
258
+
259
+ **L'IA ne suit pas les commandes ?**
260
+ - Assure-toi d'avoir ouvert ton outil IA dans le bon dossier (celui avec `.brainforge/`)
261
+ - Lance `/start-project` en premier si ce n'est pas encore fait
592
262
 
263
+ **Mettre à jour BrainForge :**
593
264
  ```bash
594
265
  brainforge update
595
266
  ```
596
267
 
597
268
  ---
598
269
 
599
- ## Multi-AI Compatibility
270
+ ## Limitations à connaître
600
271
 
601
- BrainForge generates config files for every major AI tool:
602
-
603
- | File | Tool |
604
- |------|------|
605
- | `CLAUDE.md` | Claude Code (with full 83-skill mandatory table) |
606
- | `GEMINI.md` | Gemini CLI |
607
- | `OPENAI.md` | Codex / ChatGPT |
608
- | `AGENTS.md` | All tools (universal) |
272
+ BrainForge guide l'IA avec des fichiers et des prompts — mais il ne **contrôle pas** ce que l'IA fait à 100%.
609
273
 
610
- Each file tells the AI: what the project is, what code level to use, how to follow the workflow, what files to update, and git rules (never push).
274
+ - L'IA peut parfois ignorer les instructions ou prendre des raccourcis
275
+ - Tu dois toujours relire le code, lancer les tests, et vérifier avant de remettre
276
+ - BrainForge est un garde-fou, pas un pilote automatique
611
277
 
612
278
  ---
613
279
 
614
- ## Git Rules
280
+ ## Infos techniques (pour les curieux)
615
281
 
616
- | Action | Status |
617
- |--------|--------|
618
- | `git init` | ✅ Auto on first init |
619
- | `git add` + `git commit` | ✅ Via `/checkpoint` |
620
- | `git push` | ❌ Never automatic |
621
- | `git push --force` | ❌ Never |
282
+ <details>
283
+ <summary>83 guides de bonnes pratiques (skills)</summary>
622
284
 
623
- You always control when and where you push.
285
+ Chaque projet BrainForge reçoit 83 fichiers de bonnes pratiques dans `.claude/skills/`. Ils couvrent : React, Next.js, TypeScript, Node.js, Python, Rust, PostgreSQL, Docker, Stripe, Supabase, tests, sécurité, accessibilité, et bien plus.
624
286
 
625
- ---
626
-
627
- ## Example Use Cases
628
-
629
- ### School / PFA project
630
- ```bash
631
- npx brainforge-ai init
632
- # → choose "academic-realistic" code level
633
- # → choose "yes" for academic project
634
- # → /start-project → /create-roadmap → phases
635
- # → /write-tests before each review
636
- # → /professor-check before submission
637
- # → /generate-report for the written report
638
- ```
287
+ L'IA les charge automatiquement selon la tâche en cours — tu n'as rien à faire.
639
288
 
640
- ### Personal MVP
641
- ```bash
642
- npx brainforge-ai init
643
- # → choose "intermediate" or "professional"
644
- # → brainforge serve ← keep the dashboard open while you build
645
- ```
289
+ </details>
646
290
 
647
- ### Learning a new stack
648
- ```bash
649
- npx brainforge-ai init
650
- # → choose "beginner" or "intermediate"
651
- # → /explain-my-code after each phase to understand what was built
652
- ```
291
+ <details>
292
+ <summary>41 agents spécialisés</summary>
653
293
 
654
- ### AI system / LLM feature
655
- ```bash
656
- npx brainforge-ai init
657
- # → brainforge-framework-selector picks your AI framework
658
- # → brainforge-ai-researcher writes implementation guidance
659
- # → brainforge-eval-planner designs the evaluation strategy
660
- # → brainforge-eval-auditor verifies it was actually implemented
661
- ```
294
+ BrainForge installe 41 fichiers d'agents dans `.brainforge/agents/`. Chaque agent a un rôle précis : architecte, codeur, reviewer, debugger, enseignant, etc.
662
295
 
663
- ---
296
+ Les agents avancés (`brainforge-*`) gèrent des tâches complexes comme l'audit de sécurité, la vérification de couverture de tests, ou la sélection de framework IA.
664
297
 
665
- ## Requirements
298
+ </details>
666
299
 
667
- - Node.js >= 16
668
- - Git (optional but recommended)
669
- - An AI tool: Claude Code, Cursor, Copilot, Gemini CLI, Codex…
300
+ <details>
301
+ <summary>Compatibilité multi-IA</summary>
670
302
 
671
- ---
303
+ BrainForge génère des fichiers de config pour tous les outils populaires :
672
304
 
673
- ## Development
305
+ | Fichier | Outil |
306
+ |---------|-------|
307
+ | `CLAUDE.md` | Claude Code |
308
+ | `GEMINI.md` | Gemini CLI |
309
+ | `OPENAI.md` | Codex / ChatGPT |
310
+ | `AGENTS.md` | Tous les outils (universel) |
674
311
 
675
- ```bash
676
- git clone https://github.com/MEHDImp4/brainforge-ai
677
- cd brainforge-ai
678
- npm install
679
- npm run build
680
- npm link
681
-
682
- # Test locally
683
- brainforge init
684
- brainforge guide
685
- brainforge serve
686
- brainforge doctor
687
- ```
312
+ </details>
688
313
 
689
314
  ---
690
315
 
691
- ## Contributing
692
-
693
- Issues and PRs welcome on [GitHub](https://github.com/MEHDImp4/brainforge-ai).
316
+ ## Contribuer
694
317
 
695
- ---
318
+ Issues et PRs bienvenus sur [GitHub](https://github.com/MEHDImp4/brainforge-ai).
696
319
 
697
- ## License
320
+ ## Licence
698
321
 
699
- MIT — free to use, modify, and share.
322
+ MIT — libre d'utilisation, de modification et de partage.
700
323
 
701
324
  ---
702
325
 
703
- *Built for students and developers who want structure, best practices, and 83 skill guides before they start vibing.*
326
+ *Fait pour les étudiants et développeurs qui veulent coder avec structure pas juste "vibe coder" et espérer que ça marche.*