diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 0079a5e81..696ac8f6a 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -7,6 +7,7 @@ on: - "src/**" - "tools/installer/**" - "package.json" + - "removals.txt" workflow_dispatch: inputs: channel: @@ -135,6 +136,22 @@ jobs: env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Advance @next dist-tag to stable + if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest' + # Failure here leaves @next stale until the next push-driven prerelease + # republishes — annoying but not release-breaking. Don't fail the job + # after a successful stable publish + tag + GH release. + continue-on-error: true + run: | + # Without this, @latest can leapfrog @next (e.g. latest=6.5.0 while + # next=6.4.1-next.0) and `npx bmad-method@next install` silently + # downgrades users. Point @next at the just-published stable so + # @next >= @latest always holds; the next push-driven prerelease will + # bump from this base via the existing derive step above. + VERSION=$(node -p 'require("./package.json").version') + npm dist-tag add "bmad-method@${VERSION}" next + echo "Advanced @next dist-tag to ${VERSION}" + - name: Notify Discord if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest' continue-on-error: true diff --git a/.gitignore b/.gitignore index b15ba6c17..9279c89d1 100644 --- a/.gitignore +++ b/.gitignore @@ -50,6 +50,9 @@ z*/ _bmad _bmad-output + +# Personal customization files (team files are committed, personal files are not) +_bmad/custom/*.user.toml .clinerules # .augment/ is gitignored except tracked config files — add exceptions explicitly .augment/* diff --git a/CHANGELOG.md b/CHANGELOG.md index 391f809c8..bbb0373a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,125 @@ # Changelog +## v6.5.0 - 2026-04-26 + +### 🎁 Features + +* Support for 18 new agent platforms: AdaL, Sourcegraph Amp, IBM Bob, Command Code, Snowflake Cortex Code, Factory Droid, Firebender, Block Goose, Kode, Mistral Vibe, Mux, Neovate, OpenClaw, OpenHands, Pochi, Replit Agent, Warp, Zencoder — bringing total supported platforms to 42 (#2313) +* All platforms that support the cross-tool `.agents/skills/` standard now use it (#2313) + +## v6.4.0 - 2026-04-24 + +### ✨ Headline + +**Full agent and workflow customization across the entire BMad Method.** Every agent and workflow in BMM, Core, CIS, GDS, and TEA can now be customized via TOML overrides in `_bmad/custom/`. Customize agents to apply tooling, version control, or behavior changes across whole groups of workflows. Drop in fine-grained per-workflow overrides where you need them. Built for power users who want BMad to fit their stack without forking. + +**Stable and bleeding-edge release channels, standardized across all modules.** Pick `stable` or `next` per module, pin specific versions, and switch channels interactively or via CLI flags (`--channel`, `--all-stable`, `--all-next`, `--next=CODE`, `--pin CODE=TAG`). Same model across BMM, Core, and every external module. + +### 💥 Breaking Changes + +* Customization is now TOML-based; the briefly introduced YAML-based customization is no longer supported (#2284, #2283) + +### 🎁 Features + +**Customization framework** + +* TOML-based agent and workflow customization with flat schema, structural merge rules (scalars, tables, code-keyed arrays, append arrays), and `persistent_facts` unification (#2284) +* Central `_bmad/config.toml` surface with four-file architecture (`config.toml`, `config.user.toml`, `custom/config.toml`, `custom/config.user.toml`) for agent roster and scope-partitioned install answers (#2285) +* `customize.toml` support extended to 17 bmm-skills workflows with flattened SKILL.md architecture and standardized `[workflow]` block (#2287) +* `customize.toml` extended to all six developer-execution workflows: bmad-dev-story, bmad-code-review, bmad-sprint-planning, bmad-sprint-status, bmad-quick-dev, bmad-checkpoint-preview (#2308) +* `bmad-customize` skill — guided authoring of TOML overrides in `_bmad/custom/` with stdlib-only resolver verification (#2289) +* Wire `on_complete` hook into all 23 workflow terminal steps with full customize.toml documentation (#2290) + +**Release channels & installer** + +* Channel-based version resolution for external modules with interactive channel management (`stable` / `next` / `pinned`) and CLI flags (`--channel`, `--all-stable`, `--all-next`, `--next=CODE`, `--pin CODE=TAG`) (#2305) +* GitHub API as primary fetch with raw CDN fallback in installer registry client to support corporate proxies (#2248) + +**Other** + +* Kimi Code CLI support for installing BMM skills in `.kimi/skills/` (#2302) +* `bmad-create-story` now reads every UPDATE-marked file before generating dev notes so brownfield stories preserve current behavior instead of improvising at implementation time (#2274) +* Sync `sprint-status.yaml` from quick-dev on epic-story implementation with idempotent writes tracking `in-progress` and `review` transitions (#2234) +* Enforce model parity for all code review subagents to match orchestrator session capability for improved rare-event detection (#2236) +* Set `team: software-development` on all six BMM agents for unified grouping in party-mode and retrospective skills (#2286) + +### 🐛 Bug Fixes + +* PRD workflow no longer silently de-scopes user requirements or invents MVP/Growth/Vision phasing; requires explicit confirmation before any scope reduction (#1927) +* Installer shows live npm version for external modules instead of stale cached metadata (#2307) +* Resolve external-module agents from cache during manifest write so agents land in `config.toml` (#2295) +* Fix installer version resolution for external modules with shared resolver preferring package.json > module.yaml > marketplace.json (#2298) +* Replace fs-extra with native `node:fs` to prevent file loss during multi-module installs from deferred retry-queue races (#2253) +* Add `move()` and overwrite support to fs-native wrapper for directory migrations during upgrades (#2253) +* Stop skill scanner from recursing into discovered skills to prevent spurious errors on nested template files (#2255) +* Source built-in modules locally in installer UI to preserve core and bmm in module list when registry is unreachable (#2251) +* Remove dead Batch-apply option from code-review patch menu and rename apply options for clarity (#2225) + +### ♻️ Refactoring + +* Remove 1,683 lines of dead code: three entirely dead files (agent-command-generator.js, bmad-artifacts.js, module-injections.js) and ~50 unused exports across installer modules (#2247) +* Remove dead template and agent-command pipeline from installer; SKILL.md directory copying is the sole installation path (#2244) + +### 📚 Documentation + +* Sync and update Vietnamese (vi-VN) docs with missing pages and refreshed translations (#2291, #2222) +* Sync French (fr-FR) translations with upstream, restore Amelia as dev agent, fix sidebar ordering (#2231) +* Add Czech (cs-CZ) `analysis-phase.md` translation; normalize typographic quotes (#2240, #2241, #2242) +* Add missing Chinese (zh-CN) translations for 3 documents (#2254) +* Update stale Analyst agent triggers and add PRFAQ link (#2238) +* Remove Bob from workflow map diagrams reflecting consolidation into Amelia in v6.3.0 (#2252) + +## v6.3.0 - 2026-04-09 + +### 💥 Breaking Changes + +* Remove custom content installation feature; use marketplace-based plugin installation instead (#2227) +* Remove bmad-init skill; all agents and skills now load config directly from `{project-root}/_bmad/bmm/config.yaml` (#2159) +* Remove spec-wip.md singleton; quick-dev now writes directly to `spec-{slug}.md` with status field, enabling parallel sessions (#2214) +* Consolidate three agent personas into Developer agent (Amelia): remove Barry quick-flow-solo-dev (#2177), Quinn QA agent (#2179), and Bob Scrum Master agent (#2186) + +### 🎁 Features + +* Universal source support for custom module installs with 5-strategy PluginResolver cascade supporting any Git host (GitHub, GitLab, Bitbucket, self-hosted) and local file paths (#2233) +* Community module browser with three-tier selection: official, community (category drill-down from marketplace index), and custom URL with unverified source warning (#2229) +* Switch module source of truth from bundled config to remote marketplace registry with network-failure fallback (#2228) +* Add bmad-prfaq skill implementing Amazon's Working Backwards methodology as alternative Phase 1 analysis path with 5-stage coached workflow and subagent architecture (#2157) +* Add bmad-checkpoint-preview skill for guided, concern-ordered human review of commits, branches, or PRs (#2145) +* Epic context compilation for quick-dev step-01: sub-agent compiles planning docs into cached `epic-{N}-context.md` for story implementation (#2218) +* Previous story continuity in quick-dev: load completed spec from same epic as implementation context (#2201) +* Planning artifact awareness in quick-dev: selectively load PRD, architecture, UX, and epics docs for context-informed specs (#2185) +* One-shot route now generates lightweight spec trace file for consistent artifact tracking (#2121) +* Improve checkpoint-preview UX with clickable spec paths, external edit detection, and missing-file halt (#2217) +* Add Junie (JetBrains AI) platform support (#2142) +* Restore KiloCoder support with native-skills installation (#2151) +* Add bmad-help support for llms.txt general questions (#2230) + +### ♻️ Refactoring + +* Consolidate party-mode into single SKILL.md with real subagent spawning via Agent tool, replacing multi-file workflow architecture (#2160) + +### 🐛 Bug Fixes + +* Fix version display bug where marketplace.json walk-up reported wrong version (#2233) +* Fix checkpoint-preview step-05 advancing without user confirmation by adding explicit HALT (#2184) +* Address adversarial triage findings: clarify review_mode transitions, label walkthrough branches, fix terse commit handling (#2180) +* Preserve local custom module sources during quick update (#2172) +* Support skills/ folder as fallback module source location for bmb compatibility (#2149) + +### 🔧 Maintenance + +* Overhaul installer branding with responsive BMAD METHOD logo, blue color scheme, unified version sourcing from marketplace.json, and surgical manifest-based skill cleanup (#2223) +* Stop copying skill prompts to _bmad by default (#2182) +* Add Python 3.10+ and uv as documented prerequisites (#2221) + +### 📚 Documentation + +* Complete Czech (cs-CZ) documentation translation (#2134) +* Complete Vietnamese (vi-VN) documentation translation (#2110, #2192) +* Rewrite get-answers-about-bmad as 1-2-3 escalation flow, remove deprecated references (#2213) +* Add checkpoint-preview explainer page and workflow diagram (#2183) +* Update docs theme to match bmadcode.com with responsive logo and blue color scheme (#2176) + ## v6.2.2 - 2026-03-25 ### ♻️ Refactoring diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 362d638e3..5f2b59b3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,12 @@ Thank you for considering contributing! We believe in **Human Amplification, Not --- +> **Before you write code: talk to us on [Discord](https://discord.gg/gk8jAdXWmj).** +> +> If your change adds features, restructures code, or touches more than a couple of files, **confirm with a maintainer that it fits**. A large PR out of the blue has a high chance of being closed — regardless of effort invested. A five-minute conversation can save you hours. + +--- + ## Our Philosophy BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"** @@ -57,15 +63,10 @@ After searching, use the [feature request template](https://github.com/bmad-code ## Before Starting Work -⚠️ **Required before submitting PRs:** - -| Work Type | Requirement | -| ------------- | ---------------------------------------------- | -| Bug fix | An open issue (create one if it doesn't exist) | -| Feature | An open feature request issue | -| Large changes | Discussion via issue first | - -**Why?** This prevents wasted effort on work that may not align with project direction. +| Work Type | Requirement | +| ----------------------- | -------------------------------------------------------- | +| Typo / small bug fix | Just open the PR | +| Feature or large change | Confirm with a maintainer on Discord **before** you start | --- @@ -83,6 +84,12 @@ Submit PRs to the `main` branch. We use trunk-based development. Every push to ` If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently. +### AI-Generated Code + +Given the nature of this project, we expect most contributions involve AI assistance — that's fine. What we require is **heavy human curation**. You must understand every line you're submitting, have made deliberate choices about what to include, and be able to explain your reasoning. + +We will reject PRs that read like raw LLM output: bulk refactors nobody asked for, unsolicited "improvements" across many files, or changes where the submitter clearly hasn't read the existing code. Using AI to write code is normal here; using AI as a substitute for thinking is not. + ### New to Pull Requests? 1. **Fork** the repository diff --git a/README.md b/README.md index 5a6d67c44..c9fb503e2 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ [![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org) +[![Python Version](https://img.shields.io/badge/python-%3E%3D3.10-blue?logo=python&logoColor=white)](https://www.python.org) +[![uv](https://img.shields.io/badge/uv-package%20manager-blueviolet?logo=uv)](https://docs.astral.sh/uv/) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj) **Build More Architect Dreams** — An AI-driven agile development module for the BMad Method Module Ecosystem, the best and most comprehensive Agile AI Driven Development framework that has true scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. @@ -34,7 +36,7 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag ## Quick Start -**Prerequisites**: [Node.js](https://nodejs.org) v20+ +**Prerequisites**: [Node.js](https://nodejs.org) v20+ · [Python](https://www.python.org) 3.10+ · [uv](https://docs.astral.sh/uv/) ```bash npx bmad-method install @@ -79,18 +81,15 @@ BMad Method extends with official modules for specialized domains. Available dur ## Community - [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate -- [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025) +- [YouTube](https://youtube.com/@BMadCode) — Tutorials, master class, and more +- [X / Twitter](https://x.com/BMadCode) +- [Website](https://bmadcode.com) - [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests - [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations ## Support BMad -BMad is free for everyone — and always will be. If you'd like to support development: - -- ⭐ Please click the star project icon near the top right of this page -- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development -- 🏢 Corporate sponsorship — DM on Discord -- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord) +BMad is free for everyone and always will be. Star this repo, [buy me a coffee](https://buymeacoffee.com/bmad), or email for corporate sponsorship. ## Contributing diff --git a/README_VN.md b/README_VN.md index 8aa862071..14cd5c88e 100644 --- a/README_VN.md +++ b/README_VN.md @@ -3,6 +3,8 @@ [![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org) +[![Python Version](https://img.shields.io/badge/python-%3E%3D3.10-blue?logo=python&logoColor=white)](https://www.python.org) +[![uv](https://img.shields.io/badge/uv-package%20manager-blueviolet?logo=uv)](https://docs.astral.sh/uv/) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj) [English](README.md) | [简体中文](README_CN.md) | Tiếng Việt @@ -36,7 +38,7 @@ Các công cụ AI truyền thống thường làm thay phần suy nghĩ của b ## Bắt đầu nhanh -**Điều kiện tiên quyết**: [Node.js](https://nodejs.org) v20+ +**Điều kiện tiên quyết**: [Node.js](https://nodejs.org) v20+ · [Python](https://www.python.org) 3.10+ · [uv](https://docs.astral.sh/uv/) ```bash npx bmad-method install @@ -80,18 +82,15 @@ BMad Method có thể được mở rộng bằng các mô-đun chính thức ch ## Cộng đồng - [Discord](https://discord.gg/gk8jAdXWmj) - Nhận trợ giúp, chia sẻ ý tưởng, cộng tác -- [Đăng ký trên YouTube](https://www.youtube.com/@BMadCode) - video hướng dẫn, lớp chuyên sâu và podcast (ra mắt tháng 2 năm 2025) +- [YouTube](https://youtube.com/@BMadCode) - Video hướng dẫn, master class và nhiều nội dung khác +- [X / Twitter](https://x.com/BMadCode) +- [Website](https://bmadcode.com) - [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) - Báo lỗi và yêu cầu tính năng - [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) - Trao đổi cộng đồng ## Hỗ trợ BMad -BMad miễn phí cho tất cả mọi người - và sẽ luôn như vậy. Nếu bạn muốn hỗ trợ quá trình phát triển: - -- ⭐ Hãy nhấn sao cho dự án ở góc trên bên phải của trang này -- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) - Tiếp thêm năng lượng cho quá trình phát triển -- 🏢 Tài trợ doanh nghiệp - Nhắn riêng trên Discord -- 🎤 Diễn thuyết và truyền thông - Sẵn sàng cho hội nghị, podcast, phỏng vấn (BM trên Discord) +BMad miễn phí cho tất cả mọi người và sẽ luôn như vậy. Hãy nhấn sao cho repo này, [mời tôi một ly cà phê](https://buymeacoffee.com/bmad), hoặc gửi email tới nếu bạn muốn tài trợ doanh nghiệp. ## Đóng góp diff --git a/docs/cs/404.md b/docs/cs/404.md new file mode 100644 index 000000000..74ba6c89b --- /dev/null +++ b/docs/cs/404.md @@ -0,0 +1,8 @@ +--- +title: Stránka nenalezena +template: splash +--- + +Stránka, kterou hledáte, neexistuje nebo byla přesunuta. + +[Zpět na úvodní stránku](/cs/index.md) diff --git a/docs/cs/_STYLE_GUIDE.md b/docs/cs/_STYLE_GUIDE.md new file mode 100644 index 000000000..3cdd71871 --- /dev/null +++ b/docs/cs/_STYLE_GUIDE.md @@ -0,0 +1,370 @@ +--- +title: "Průvodce stylem dokumentace" +description: Projektově specifické konvence dokumentace založené na stylu Google a struktuře Diataxis +--- + +Tento projekt se řídí [Google Developer Documentation Style Guide](https://developers.google.com/style) a používá [Diataxis](https://diataxis.fr/) pro strukturování obsahu. Následují pouze projektově specifické konvence. + +## Projektově specifická pravidla + +| Pravidlo | Specifikace | +| -------------------------------------- | ---------------------------------------- | +| Žádné horizontální čáry (`---`) | Narušují plynulost čtení | +| Žádné nadpisy `####` | Místo toho použijte tučný text nebo admonitions | +| Žádné sekce „Souvisejí“ nebo „Další:“ | Navigaci zajišťuje postranní panel | +| Žádné hluboce vnořené seznamy | Místo toho rozdělejte do sekcí | +| Žádné bloky kódu pro nekód | Pro příklady dialogů použijte admonitions | +| Žádné tučné odstavce pro upozornění | Místo toho použijte admonitions | +| Max 1–2 admonitions na sekci | Tutoriály povolují 3–4 na hlavní sekci | +| Buňky tabulek / položky seznamů | Max 1–2 věty | +| Rozpočet nadpisů | 8–12 `##` na dokument; 2–3 `###` na sekci | + +## Admonitions (syntaxe Starlight) + +```md +:::tip[Název] +Zkratky, osvědčené postupy +::: + +:::note[Název] +Kontext, definice, příklady, předpoklady +::: + +:::caution[Název] +Upozornění, potenciální problémy +::: + +:::danger[Název] +Pouze kritická varování — ztráta dat, bezpečnostní problémy +::: +``` + +### Standardní použití + +| Admonition | Použití pro | +| ------------------------ | ----------------------------- | +| `:::note[Předpoklady]` | Závislosti před začátkem | +| `:::tip[Rychlá cesta]` | TL;DR shrnutí na začátku dokumentu | +| `:::caution[Důležité]` | Kritická upozornění | +| `:::note[Příklad]` | Příklady příkazů/odpovědí | + +## Standardní formáty tabulek + +**Fáze:** + +```md +| Fáze | Název | Co se děje | +| ---- | -------- | -------------------------------------------- | +| 1 | Analýza | Brainstorming, průzkum *(volitelné)* | +| 2 | Plánování | Požadavky — PRD nebo specifikace *(povinné)* | +``` + +**Skills:** + +```md +| Skill | Agent | Účel | +| -------------------- | ------- | ------------------------------------ | +| `bmad-brainstorming` | Analytik | Brainstorming nového projektu | +| `bmad-create-prd` | PM | Vytvoření dokumentu požadavků (PRD) | +``` + +## Bloky struktury složek + +Zobrazujte v sekcích „Co jste dosáhli“: + +````md +``` +váš-projekt/ +├── _bmad/ # Konfigurace BMad +├── _bmad-output/ +│ ├── planning-artifacts/ +│ │ └── PRD.md # Váš dokument požadavků +│ ├── implementation-artifacts/ +│ └── project-context.md # Pravidla implementace (volitelné) +└── ... +``` +```` + +## Struktura tutoriálu + +```text +1. Název + Háček (1–2 věty popisující výsledek) +2. Upozornění na verzi/modul (info nebo warning admonition) (volitelné) +3. Co se naučíte (odrážkový seznam výsledků) +4. Předpoklady (info admonition) +5. Rychlá cesta (tip admonition – TL;DR shrnutí) +6. Pochopení [Tématu] (kontext před kroky – tabulky pro fáze/agenty) +7. Instalace (volitelné) +8. Krok 1: [První hlavní úkol] +9. Krok 2: [Druhý hlavní úkol] +10. Krok 3: [Třetí hlavní úkol] +11. Co jste dosáhli (shrnutí + struktura složek) +12. Rychlý přehled (tabulka skills) +13. Časté otázky (formát FAQ) +14. Získání pomoci (komunitní odkazy) +15. Klíčové poznatky (tip admonition) +``` + +### Kontrolní seznam tutoriálu + +- [ ] Háček popisuje výsledek v 1–2 větách +- [ ] Sekce „Co se naučíte“ je přítomna +- [ ] Předpoklady v admonition +- [ ] Rychlá cesta TL;DR admonition nahoře +- [ ] Tabulky pro fáze, skills, agenty +- [ ] Sekce „Co jste dosáhli“ je přítomna +- [ ] Tabulka rychlého přehledu je přítomna +- [ ] Sekce častých otázek je přítomna +- [ ] Sekce získání pomoci je přítomna +- [ ] Klíčové poznatky admonition na konci + +## Struktura praktického návodu + +```text +1. Název + Háček (jedna věta: „Použijte workflow `X` k...“) +2. Kdy to použít (odrážkový seznam scénářů) +3. Kdy to přeskočit (volitelné) +4. Předpoklady (note admonition) +5. Kroky (číslované ### podsekce) +6. Co získáte (výstup/vytvořené artefakty) +7. Příklad (volitelné) +8. Tipy (volitelné) +9. Další kroky (volitelné) +``` + +### Kontrolní seznam praktického návodu + +- [ ] Háček začíná „Použijte workflow `X` k...“ +- [ ] „Kdy to použít“ má 3–5 odrážek +- [ ] Předpoklady jsou uvedeny +- [ ] Kroky jsou číslované `###` podsekce s akčními slovesy +- [ ] „Co získáte“ popisuje výstupní artefakty + +## Struktura vysvětlení + +### Typy + +| Typ | Příklad | +| ----------------- | ----------------------------- | +| **Úvodní stránka** | `core-concepts/index.md` | +| **Koncept** | `what-are-agents.md` | +| **Funkce** | `quick-dev.md` | +| **Filosofie** | `why-solutioning-matters.md` | +| **FAQ** | `established-projects-faq.md` | + +### Obecná šablona + +```text +1. Název + Háček (1–2 věty) +2. Přehled/Definice (co to je, proč je to důležité) +3. Klíčové koncepty (### podsekce) +4. Srovnávací tabulka (volitelné) +5. Kdy použít / Kdy nepoužít (volitelné) +6. Diagram (volitelné – mermaid, max 1 na dokument) +7. Další kroky (volitelné) +``` + +### Úvodní/Vstupní stránky + +```text +1. Název + Háček (jedna věta) +2. Tabulka obsahu (odkazy s popisy) +3. Jak začít (číslovaný seznam) +4. Vyberte si svou cestu (volitelné – rozhodovací strom) +``` + +### Vysvětlení konceptů + +```text +1. Název + Háček (co to je) +2. Typy/Kategorie (### podsekce) (volitelné) +3. Tabulka klíčových rozdílů +4. Komponenty/Části +5. Co byste měli použít? +6. Vytváření/Přizpůsobení (odkaz na praktické návody) +``` + +### Vysvětlení funkcí + +```text +1. Název + Háček (co to dělá) +2. Rychlá fakta (volitelné – „Ideální pro:“, „Čas:“) +3. Kdy použít / Kdy nepoužít +4. Jak to funguje (mermaid diagram volitelné) +5. Klíčové výhody +6. Srovnávací tabulka (volitelné) +7. Kdy přejít na vyšší úroveň (volitelné) +``` + +### Dokumenty filosofie/zdůvodnění + +```text +1. Název + Háček (princip) +2. Problém +3. Řešení +4. Klíčové principy (### podsekce) +5. Výhody +6. Kdy to platí +``` + +### Kontrolní seznam vysvětlení + +- [ ] Háček uvádí, co dokument vysvětluje +- [ ] Obsah v přehledných `##` sekcích +- [ ] Srovnávací tabulky pro 3+ možností +- [ ] Diagramy mají jasné popisky +- [ ] Odkazy na praktické návody pro procedurální otázky +- [ ] Max 2–3 admonitions na dokument + +## Struktura reference + +### Typy + +| Typ | Příklad | +| ----------------- | --------------------- | +| **Úvodní stránka** | `workflows/index.md` | +| **Katalog** | `agents/index.md` | +| **Hloubkový pohled** | `document-project.md` | +| **Konfigurace** | `core-tasks.md` | +| **Slovníček** | `glossary/index.md` | +| **Komplexní** | `bmgd-workflows.md` | + +### Úvodní stránky reference + +```text +1. Název + Háček (jedna věta) +2. Sekce obsahu (## pro každou kategorii) + - Odrážkový seznam s odkazy a popisy +``` + +### Katalogová reference + +```text +1. Název + Háček +2. Položky (## pro každou položku) + - Stručný popis (jedna věta) + - **Skills:** nebo **Klíčové info:** jako plochý seznam +3. Univerzální/Sdílené (## sekce) (volitelné) +``` + +### Hloubková reference položky + +```text +1. Název + Háček (jedna věta účel) +2. Rychlá fakta (volitelné note admonition) + - Modul, Skill, Vstup, Výstup jako seznam +3. Účel/Přehled (## sekce) +4. Jak vyvolat (blok kódu) +5. Klíčové sekce (## pro každý aspekt) + - Použijte ### pro pod-možnosti +6. Poznámky/Upozornění (tip nebo caution admonition) +``` + +### Konfigurační reference + +```text +1. Název + Háček +2. Obsah (odkazy pro skok, pokud 4+ položek) +3. Položky (## pro každou konfiguraci/úkol) + - **Tučné shrnutí** — jedna věta + - **Použijte když:** odrážkový seznam + - **Jak to funguje:** číslované kroky (max 3–5) + - **Výstup:** očekávaný výsledek (volitelné) +``` + +### Komplexní referenční průvodce + +```text +1. Název + Háček +2. Přehled (## sekce) + - Diagram nebo tabulka zobrazující organizaci +3. Hlavní sekce (## pro každou fázi/kategorii) + - Položky (### pro každou položku) + - Standardizovaná pole: Skill, Agent, Vstup, Výstup, Popis +4. Další kroky (volitelné) +``` + +### Kontrolní seznam reference + +- [ ] Háček uvádí, co dokument referuje +- [ ] Struktura odpovídá typu reference +- [ ] Položky používají konzistentní strukturu +- [ ] Tabulky pro strukturovaná/srovnávací data +- [ ] Odkazy na dokumenty vysvětlení pro koncepční hloubku +- [ ] Max 1–2 admonitions + +## Struktura slovníčku + +Starlight generuje navigaci „Na této stránce“ z nadpisů na pravé straně: + +- Kategorie jako `##` nadpisy — zobrazují se v pravé navigaci +- Termíny v tabulkách — kompaktní řádky, ne jednotlivé nadpisy +- Žádný inline TOC — pravý panel zajišťuje navigaci + +### Formát tabulky + +```md +## Název kategorie + +| Termín | Definice | +| ------------ | ------------------------------------------------------------------------------------------- | +| **Agent** | Specializovaná AI persona s konkrétní odborností, která provází uživatele pracovními postupy. | +| **Workflow** | Vícekrokový řízený proces, který orchestruje aktivity AI agentů k vytvoření výstupů. | +``` + +### Pravidla definic + +| Správně | Špatně | +| ------------------------------ | -------------------------------------------- | +| Začněte tím, co to JE nebo DĚLÁ | Nezačínejte „Toto je...“ nebo „[Termín] je...“ | +| Držte se 1–2 vět | Nepište víceodstavcová vysvětlení | +| Tučný název termínu v buňce | Nepoužívejte prostý text pro termíny | + +### Kontextové značky + +Přidejte kurzívní kontext na začátek definice pro termíny s omezeným rozsahem: + +- `*Pouze Quick Flow.*` +- `*BMad Method/Enterprise.*` +- `*Fáze N.*` +- `*BMGD.*` +- `*Existující projekty.*` + +### Kontrolní seznam slovníčku + +- [ ] Termíny v tabulkách, ne jako jednotlivé nadpisy +- [ ] Termíny abecedně seřazeny v kategoriích +- [ ] Definice 1–2 věty +- [ ] Kontextové značky kurzívou +- [ ] Názvy termínů tučně v buňkách +- [ ] Žádné definice „[Termín] je...“ + +## Sekce FAQ + +```md +## Otázky + +- [Potřebuji vždy architekturu?](#potřebuji-vždy-architekturu) +- [Mohu později změnit svůj plán?](#mohu-později-změnit-svůj-plán) + +### Potřebuji vždy architekturu? + +Pouze pro BMad Method a Enterprise. Quick Flow přeskakuje rovnou k implementaci. + +### Mohu později změnit svůj plán? + +Ano. SM agent má workflow `bmad-correct-course` pro řešení změn rozsahu. + +**Máte otázku, na kterou jste zde nenašli odpověď?** [Vytvořte issue](...) nebo se zeptejte na [Discordu](...). +``` + +## Validační příkazy + +Před odesláním změn dokumentace: + +```bash +npm run docs:fix-links # Náhled oprav formátu odkazů +npm run docs:fix-links -- --write # Aplikovat opravy +npm run docs:validate-links # Kontrola existence odkazů +npm run docs:build # Ověření bez chyb při sestavení +``` diff --git a/docs/cs/explanation/advanced-elicitation.md b/docs/cs/explanation/advanced-elicitation.md new file mode 100644 index 000000000..a2eaac16a --- /dev/null +++ b/docs/cs/explanation/advanced-elicitation.md @@ -0,0 +1,49 @@ +--- +title: "Pokročilá elicitace" +description: Přimějte LLM přehodnotit svou práci pomocí strukturovaných metod uvažování +sidebar: + order: 6 +--- + +Přimějte LLM přehodnotit, co právě vygeneroval. Vyberete metodu uvažování, LLM ji aplikuje na svůj vlastní výstup, a vy rozhodnete, zda si vylepšení ponecháte. + +## Co je pokročilá elicitace? + +Strukturovaný druhý průchod. Místo žádání AI, aby „to zkusila znovu“ nebo „to zlepšila“, vyberete specifickou metodu uvažování a AI přezkoumá svůj vlastní výstup přes tento objektiv. + +Rozdíl je podstatný. Vágní požadavky produkují vágní revize. Pojmenovaná metoda vynucuje konkrétní úhel útoku, odhaluje postřehy, které by generický pokus přehlédl. + +## Kdy ji použít + +- Poté, co workflow vygeneruje obsah a chcete alternativy +- Když výstup vypadá v pořádku, ale tušíte, že je v něm víc hloubky +- K zátěžovému testování předpokladů nebo nalezení slabých míst +- Pro důležitý obsah, kde přehodnocení pomáhá + +Workflow nabízejí pokročilou elicitaci v rozhodovacích bodech — poté, co LLM něco vygeneruje, budete dotázáni, zda ji chcete spustit. + +## Jak to funguje + +1. LLM navrhne 5 relevantních metod pro váš obsah +2. Vyberete jednu (nebo zamícháte pro jiné možnosti) +3. Metoda je aplikována, vylepšení zobrazena +4. Přijměte nebo zahoďte, opakujte nebo pokračujte + +## Vestavěné metody + +K dispozici jsou desítky metod uvažování. Několik příkladů: + +- **Pre-mortem analýza** — Předpokládejte, že projekt už selhal, a zpětně hledejte proč +- **Myšlení z prvních principů** — Odstraňte předpoklady, znovu postavte od základní pravdy +- **Inverze** — Zeptejte se, jak zaručit selhání, a poté se tomu vyhněte +- **Red Team vs Blue Team** — Napadněte vlastní práci, pak ji braňte +- **Sokratovské dotazování** — Zpochybněte každé tvrzení otázkou „proč?“ a „jak víte?“ +- **Odstranění omezení** — Odstraňte všechna omezení, podívejte se, co se změní, selektivně je přidejte zpět +- **Mapování zainteresovaných stran** — Přehodnoťte z perspektivy každé zainteresované strany +- **Analogické uvažování** — Najděte paralely v jiných oblastech a aplikujte jejich lekce + +A mnoho dalších. AI vybírá nejrelevantnější možnosti pro váš obsah — vy si vyberete, kterou spustit. + +:::tip[Začněte zde] +Pre-mortem analýza je dobrá první volba pro jakoukoli specifikaci nebo plán. Konzistentně nachází mezery, které standardní revize přehlédne. +::: diff --git a/docs/cs/explanation/adversarial-review.md b/docs/cs/explanation/adversarial-review.md new file mode 100644 index 000000000..5ccfed100 --- /dev/null +++ b/docs/cs/explanation/adversarial-review.md @@ -0,0 +1,59 @@ +--- +title: "Adversariální revize" +description: Technika vynuceného uvažování, která zabraňuje líným „vypadá dobře“ revizím +sidebar: + order: 5 +--- + +Vynuťte hlubší analýzu tím, že budete vyžadovat nalezení problémů. + +## Co je adversariální revize? + +Technika revize, kde recenzent *musí* najít problémy. Žádné „vypadá dobře“ není povoleno. Recenzent zaujme cynický postoj — předpokládá, že problémy existují, a hledá je. + +Nejde o negativismus. Jde o vynucení skutečné analýzy místo povrchního pohledu, který automaticky schválí cokoli, co bylo předloženo. + +**Základní pravidlo:** Musíte najít problémy. Nulové nálezy spouštějí zastavení — analyzujte znovu nebo vysvětlete proč. + +## Proč to funguje + +Běžné revize trpí konfirmačním zkreslením. Proletíte práci, nic nevyskočí, schválíte to. Mandát „najít problémy“ tento vzor rozbíjí: + +- **Vynucuje důkladnost** — Nemůžete schválit, dokud jste nehledali dostatečně pečlivě +- **Zachytí chybějící věci** — „Co zde není?“ se stává přirozenou otázkou +- **Zlepšuje kvalitu signálu** — Nálezy jsou konkrétní a akční, ne vágní obavy +- **Informační asymetrie** — Provádějte revize s čerstvým kontextem (bez přístupu k původnímu uvažování), abyste hodnotili artefakt, ne záměr + +## Kde se používá + +Adversariální revize se objevuje v celém BMad workflow — revize kódu, kontroly připravenosti implementace, validace specifikací a další. Někdy je to povinný krok, někdy volitelný (jako pokročilá elicitace nebo party mode). Vzor se přizpůsobí jakémukoli artefaktu, který potřebuje kontrolu. + +## Vyžadováno lidské filtrování + +Protože AI je *instruována* najít problémy, najde problémy — i když neexistují. Očekávejte falešné pozitivy: malichernosti převlečené za problémy, nepochopení záměru nebo přímo vymyšlené obavy. + +**Vy rozhodujete, co je skutečné.** Zkontrolujte každý nález, odmítněte šum, opravte to, na čem záleží. + +## Příklad + +Místo: + +> „Implementace autentizace vypadá rozumně. Schváleno.“ + +Adversariální revize produkuje: + +> 1. **VYSOKÁ** — `login.ts:47` — Žádné omezení rychlosti neúspěšných pokusů +> 2. **VYSOKÁ** — Session token uložen v localStorage (zranitelný vůči XSS) +> 3. **STŘEDNÍ** — Validace hesla probíhá pouze na straně klienta +> 4. **STŘEDNÍ** — Žádné auditní logování neúspěšných pokusů o přihlášení +> 5. **NÍZKÁ** — Magické číslo `3600` by mělo být `SESSION_TIMEOUT_SECONDS` + +První revize mohla přehlédnout bezpečnostní zranitelnost. Druhá zachytila čtyři. + +## Iterace a klesající výnosy + +Po řešení nálezů zvažte opětovné spuštění. Druhý průchod obvykle zachytí více. Třetí také není vždy zbytečný. Ale každý průchod zabere čas a nakonec dosáhnete klesajících výnosů — jen malichernosti a falešné nálezy. + +:::tip[Lepší revize] +Předpokládejte, že problémy existují. Hledejte, co chybí, ne jen co je špatně. +::: diff --git a/docs/cs/explanation/analysis-phase.md b/docs/cs/explanation/analysis-phase.md new file mode 100644 index 000000000..71b6dd650 --- /dev/null +++ b/docs/cs/explanation/analysis-phase.md @@ -0,0 +1,70 @@ +--- +title: "Fáze analýzy: od nápadu k základům" +description: Co je brainstorming, výzkum, product brief a PRFAQ — a kdy který nástroj použít +sidebar: + order: 1 +--- + +Fáze analýzy (fáze 1) vám pomůže jasně si promyslet váš produkt, než se pustíte do jeho tvorby. Každý nástroj v této fázi je volitelný, ale úplné vynechání analýzy znamená, že váš PRD je postaven na předpokladech namísto vhledu. + +## Proč analýza před plánováním? + +PRD odpovídá na otázku „Co bychom měli postavit a proč?“. Pokud jej nakrmíte vágním myšlením, získáte vágní PRD — a každý navazující dokument tuto vágnost zdědí. Architektura postavená na slabém PRD sází na špatnou techniku. Příběhy odvozené ze slabé architektury opomíjejí okrajové případy. Náklady se zvyšují. + +Existují analytické nástroje, které vám PRD zostří. Napadají problém z různých úhlů — kreativní průzkum, realita trhu, jasnost zákazníka, proveditelnost — takže v době, kdy sedíte s agentem PM, víte, co a pro koho stavíte. + +## Nástroje + +### Brainstorming + +**Co to je.** Zprostředkované tvůrčí sezení s využitím osvědčených technik generování nápadů. AI funguje jako kouč, který z vás tahá nápady prostřednictvím strukturovaných cvičení — negeneruje nápady za vás. + +**Proč je to tady.** Neotřelé nápady potřebují prostor pro rozvoj, než se zakotví v požadavcích. Brainstorming tento prostor vytváří. Je cenný zejména tehdy, když máte problémovou oblast, ale nemáte jasné řešení, nebo když chcete prozkoumat více směrů, než se k něčemu zavážete. + +**Kdy jej použít.** Máte nejasnou představu o tom, co chcete vytvořit, ale nemáte vykrystalizovaný koncept. Nebo máte koncept, ale chcete ho otestovat pod tlakem oproti alternativám. + +Viz [Brainstorming](./brainstorming.md), kde se dozvíte, jak relace fungují. + +### Výzkum (trhu, domény, technický) + +**Co to je.** Tři cílené pracovní postupy výzkumu, které zkoumají různé rozměry vašeho nápadu. Výzkum trhu zkoumá konkurenci, trendy a nálady uživatelů. Doménový výzkum vytváří odborné znalosti v daném oboru a terminologii. Technický výzkum hodnotí proveditelnost, možnosti architektury a přístupy k implementaci. + +**Proč je to tady.** Stavět na předpokladech je nejrychlejší způsob, jak vytvořit něco, co nikdo nepotřebuje. Výzkum zakládá váš koncept na realitě — co již existuje u konkurence, s čím uživatelé skutečně bojují, co je technicky proveditelné a jakým omezením specifickým pro dané odvětví budete čelit. + +**Kdy ho použít.** Vstupujete do neznámé oblasti, tušíte, že konkurence existuje, ale nemáte ji zmapovanou, nebo váš koncept závisí na technických možnostech, které nemáte ověřené. Proveďte jeden, dva nebo všechny tři — každý z nich je samostatný. + +### Product Brief + +**Co to je.** Řízené zjišťovací sezení, jehož výsledkem je 1–2stránkové shrnutí vašeho konceptu produktu. AI funguje jako spolupracující obchodní analytik, který vám pomůže formulovat vizi, cílovou skupinu, nabídku hodnoty a rozsah. + +**Proč tu je.** Produktový brief je jemnější cestou k plánování. Zachycuje vaši strategickou vizi ve strukturovaném formátu, který se přímo promítá do tvorby PRD. Nejlépe funguje, když jste již o svém konceptu přesvědčeni — znáte zákazníka, problém a zhruba víte, co chcete vytvořit. Brief tyto úvahy uspořádá a vyostří. + +**Kdy jej použít.** Váš koncept je relativně jasný a chcete jej efektivně zdokumentovat ještě před vytvořením PRD. Jste si jisti svým směřováním a nepotřebujete své předpoklady agresivně zpochybňovat. + +### PRFAQ (Working Backwards) + +**Co to je.** Metodika Working Backwards společnosti Amazon upravená jako interaktivní výzva. Napíšete tiskovou zprávu oznamující váš hotový produkt dříve, než existuje jediný řádek kódu, a pak odpovíte na nejtěžší otázky, které by vám zákazníci a zainteresované strany položili. Umělá inteligence funguje jako neúprosný, ale konstruktivní produktový kouč. + +**Proč je to tady.** PRFAQ je přísná cesta k plánování. Vynucuje si jasnost v zájmu zákazníka tím, že vás nutí obhájit každé tvrzení. Pokud nedokážete napsat přesvědčivou tiskovou zprávu, produkt není připraven. Pokud odpovědi na časté dotazy zákazníků odhalí nedostatky, jsou to nedostatky, které byste objevili mnohem později — a nákladněji — při implementaci. Hozená rukavice odhalí slabé myšlení v rané fázi, kdy je nejlevnější ho opravit. + +**Kdy ji použít.** Před vyčleněním zdrojů chcete, aby váš koncept prošel zátěžovým testem. Nejste si jisti, zda to uživatele bude skutečně zajímat. Chcete si ověřit, že dokážete formulovat jasnou a obhajitelnou nabídku hodnoty. Nebo si prostě chcete disciplínou Working Backwards zpřesnit své myšlení. + +## Který nástroj bych měl použít? + +| Situace | Doporučený nástroj | +| --------- | ---------------- | +| „Mám nejasný nápad, ale nevím, kde začít“ | Brainstorming | +| „Než se rozhodnu, potřebuji pochopit trh“ | Výzkum | +| „Vím, co chci vytvořit, jen to potřebuji zdokumentovat“ | Product Brief | +| „Chci se ujistit, že tento nápad skutečně stojí za vybudování“ | PRFAQ | +| „Chci prozkoumat, pak ověřit a pak zdokumentovat“ | Brainstorming → Výzkum → PRFAQ nebo Brief | + +Product Brief i PRFAQ jsou vstupem pro PRD — vyberte si jeden z nich podle toho, jak moc chcete být nároční. Brief je společným objevováním. PRFAQ je hozená rukavice. Obojí vás dovede ke stejnému cíli; PRFAQ testuje, zda si váš koncept zaslouží se tam dostat. + +:::tip[Nejste si jisti?] +Spusťte `bmad-help` a popište svou situaci. Doporučí vám správný výchozí bod na základě toho, co jste již udělali a čeho se snažíte dosáhnout. +::: + +## Co se stane po analýze? + +Výstupy analýzy se přímo promítají do fáze 2 (plánování). Pracovní postup PRD přijímá jako vstupy produktové briefy, dokumenty PRFAQ, výsledky výzkumu a zprávy z brainstormingu — syntetizuje vše, co jste vytvořili, do strukturovaných požadavků. Čím více analýz provedete, tím ostřejší bude vaše PRD. diff --git a/docs/cs/explanation/brainstorming.md b/docs/cs/explanation/brainstorming.md new file mode 100644 index 000000000..685312098 --- /dev/null +++ b/docs/cs/explanation/brainstorming.md @@ -0,0 +1,33 @@ +--- +title: "Brainstorming" +description: Interaktivní kreativní sezení s využitím 60+ osvědčených technik ideace +sidebar: + order: 2 +--- + +Uvolněte svou kreativitu prostřednictvím řízeného průzkumu. + +## Co je brainstorming? + +Spusťte `bmad-brainstorming` a máte kreativního facilitátora, který z vás táhne nápady — ne který je generuje za vás. AI působí jako kouč a průvodce, používá osvědčené techniky k vytvoření podmínek, ve kterých se projeví vaše nejlepší myšlení. + +**Ideální pro:** + +- Překonání kreativních bloků +- Generování nápadů na produkty nebo funkce +- Zkoumání problémů z nových úhlů +- Rozvíjení surových konceptů do akčních plánů + +## Jak to funguje + +1. **Příprava** — Definujte téma, cíle, omezení +2. **Volba přístupu** — Vyberte techniky sami, nechte si doporučit od AI, zvolte náhodně, nebo postupujte progresivním tokem +3. **Facilitace** — Projděte techniky s podněcujícími otázkami a kolaborativním koučováním +4. **Organizace** — Nápady seskupeny do témat a prioritizovány +5. **Akce** — Nejlepší nápady dostanou další kroky a metriky úspěchu + +Vše je zachyceno v dokumentu sezení, na který se můžete později odkazovat nebo ho sdílet se zúčastněnými stranami. + +:::note[Vaše nápady] +Každý nápad pochází od vás. Workflow vytváří podmínky pro vhled — vy jste zdrojem. +::: diff --git a/docs/cs/explanation/established-projects-faq.md b/docs/cs/explanation/established-projects-faq.md new file mode 100644 index 000000000..7c2a1e35a --- /dev/null +++ b/docs/cs/explanation/established-projects-faq.md @@ -0,0 +1,50 @@ +--- +title: "FAQ pro existující projekty" +description: Časté otázky o používání BMad Method na existujících projektech +sidebar: + order: 8 +--- +Rychlé odpovědi na časté otázky o práci na existujících projektech s BMad Method (BMM). + +## Otázky + +- [Musím nejdřív spustit document-project?](#musím-nejdřív-spustit-document-project) +- [Co když zapomenu spustit document-project?](#co-když-zapomenu-spustit-document-project) +- [Mohu použít Quick Flow pro existující projekty?](#mohu-použít-quick-flow-pro-existující-projekty) +- [Co když můj existující kód nedodržuje osvědčené postupy?](#co-když-můj-existující-kód-nedodržuje-osvědčené-postupy) + +### Musím nejdřív spustit document-project? + +Vysoce doporučeno, zejména pokud: + +- Neexistuje žádná dokumentace +- Dokumentace je zastaralá +- AI agenti potřebují kontext o existujícím kódu + +Můžete to přeskočit, pokud máte komplexní, aktuální dokumentaci včetně `docs/index.md` nebo budete používat jiné nástroje nebo techniky k usnadnění discovery pro agenta stavějícího na existujícím systému. + +### Co když zapomenu spustit document-project? + +Nedělejte si starosti — můžete to udělat kdykoli. Můžete to udělat i během nebo po projektu, aby pomohl udržet dokumentaci aktuální. + +### Mohu použít Quick Flow pro existující projekty? + +Ano! Quick Flow funguje skvěle pro existující projekty. Umí: + +- Automaticky detekovat váš existující stack +- Analyzovat existující vzory kódu +- Detekovat konvence a požádat o potvrzení +- Generovat kontextově bohatou specifikaci, která respektuje existující kód + +Ideální pro opravy chyb a malé funkce v existujících kódových bázích. + +### Co když můj existující kód nedodržuje osvědčené postupy? + +Quick Flow detekuje vaše konvence a zeptá se: „Mám dodržovat tyto existující konvence?“ Rozhodujete vy: + +- **Ano** → Zachovat konzistenci se současnou kódovou bází +- **Ne** → Zavést nové standardy (zdokumentujte proč ve specifikaci) + +BMM respektuje vaši volbu — nevynucuje modernizaci, ale nabídne ji. + +**Máte otázku, na kterou jste zde nenašli odpověď?** Prosím [vytvořte issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) nebo se zeptejte na [Discordu](https://discord.gg/gk8jAdXWmj), abychom ji mohli přidat! diff --git a/docs/cs/explanation/party-mode.md b/docs/cs/explanation/party-mode.md new file mode 100644 index 000000000..03b6950cb --- /dev/null +++ b/docs/cs/explanation/party-mode.md @@ -0,0 +1,59 @@ +--- +title: "Party Mode" +description: Spolupráce více agentů — všichni vaši AI agenti v jedné konverzaci +sidebar: + order: 7 +--- + +Všichni vaši AI agenti v jedné konverzaci. + +## Co je Party Mode? + +Spusťte `bmad-party-mode` a máte celý svůj AI tým v jedné místnosti — PM, Architect, Dev, UX Designer, kohokoli potřebujete. BMad Master orchestruje, vybírá relevantní agenty pro každou zprávu. Agenti odpovídají v charakteru, souhlasí, nesouhlasí a staví na nápadech ostatních. + +Konverzace pokračuje tak dlouho, jak chcete. Ptejte se na doplňující otázky, oponujte odpovědím, přesměrujte diskuzi — je to skutečná výměna s vašimi agenty, dokud neskončíte. + +**Ideální pro:** + +- Velká rozhodnutí s kompromisy +- Brainstormingová sezení +- Post-mortemy, když se něco pokazí +- Retrospektivy a plánování sprintů + +## Příklady + +### Kritika špatné architektury + +**Vy:** „Dobře, týme, náš poslední sprint byl katastrofa. Autentizační služba spadla třikrát. Kdo to pokazil?“ + +**Architect:** „Design byl v pořádku — distribuovaná autentizace se správnými záložními řešeními. Pokud se implementace odchýlila od specifikace...“ + +**Dev:** „Následoval jsem architektonický dokument přesně. Specifikace nepočítala s race conditions při souběžné invalidaci relací.“ + +**PM:** „Oba jste přehlédli větší problém — nevalidovali jsme požadavky na správu relací v PRD. Tohle je na mně, že jsem to nezachytil.“ + +**TEA:** „A já to měl zachytit v integračních testech. Testovací scénáře nepokrývaly souběžnou invalidaci.“ + +### Kreativní brainstorming + +**Vy:** „Jak udělat onboarding magický místo nudného?“ + +**UX Designer:** „Začněte s progresivním odhalováním — odhalujte funkce, jak je uživatelé potřebují, ne všechny najednou v tutoriálu.“ + +**Storyteller:** „Co kdyby onboarding byl příběh? Každý krok odhaluje cestu postavy — uživatel JE hrdina.“ + +**Game Designer:** „Navazuji na to — co kdyby první ‚quest' vlastně řešil skutečný problém uživatele? Učí se tím, že dělají něco hodnotného.“ + +### Technické rozhodnutí + +**Vy:** „Monolit nebo mikroslužby pro MVP?“ + +**Architect:** „Začněte monolitem. Mikroslužby přidávají složitost, kterou při 1000 uživatelích nepotřebujete.“ + +**PM:** „Souhlasím. Čas na trh je důležitější než teoretická škálovatelnost.“ + +**Dev:** „Monolit s jasnými hranicemi modulů. Služby můžeme extrahovat později, pokud bude potřeba.“ + +:::tip[Lepší rozhodnutí] +Lepší rozhodnutí prostřednictvím různorodých perspektiv. Vítejte v party mode. +::: diff --git a/docs/cs/explanation/preventing-agent-conflicts.md b/docs/cs/explanation/preventing-agent-conflicts.md new file mode 100644 index 000000000..d0dd2d01e --- /dev/null +++ b/docs/cs/explanation/preventing-agent-conflicts.md @@ -0,0 +1,112 @@ +--- +title: "Předcházení konfliktům agentů" +description: Jak architektura zabraňuje konfliktům, když více agentů implementuje systém +sidebar: + order: 4 +--- + +Když více AI agentů implementuje různé části systému, mohou dělat protichůdná technická rozhodnutí. Dokumentace architektury tomu zabraňuje stanovením sdílených standardů. + +## Běžné typy konfliktů + +### Konflikty stylu API + +Bez architektury: +- Agent A používá REST s `/users/{id}` +- Agent B používá GraphQL mutations +- Výsledek: Nekonzistentní vzory API, zmatení konzumenti + +S architekturou: +- ADR specifikuje: „Použít GraphQL pro veškerou komunikaci klient-server“ +- Všichni agenti dodržují stejný vzor + +### Konflikty návrhu databáze + +Bez architektury: +- Agent A používá snake_case pro názvy sloupců +- Agent B používá camelCase pro názvy sloupců +- Výsledek: Nekonzistentní schéma, matoucí dotazy + +S architekturou: +- Dokument standardů specifikuje konvence pojmenování +- Všichni agenti dodržují stejné vzory + +### Konflikty řízení stavu + +Bez architektury: +- Agent A používá Redux pro globální stav +- Agent B používá React Context +- Výsledek: Více přístupů k řízení stavu, složitost + +S architekturou: +- ADR specifikuje přístup k řízení stavu +- Všichni agenti implementují konzistentně + +## Jak architektura zabraňuje konfliktům + +### 1. Explicitní rozhodnutí skrze ADR + +Každé významné technologické rozhodnutí je zdokumentováno s: +- Kontext (proč toto rozhodnutí záleží) +- Zvažované možnosti (jaké alternativy existují) +- Rozhodnutí (co jsme zvolili) +- Zdůvodnění (proč jsme to zvolili) +- Důsledky (přijaté kompromisy) + +### 2. Specifické pokyny pro FR/NFR + +Architektura mapuje každý funkční požadavek na technický přístup: +- FR-001: Správa uživatelů → GraphQL mutations +- FR-002: Mobilní aplikace → Optimalizované dotazy + +### 3. Standardy a konvence + +Explicitní dokumentace: +- Struktura adresářů +- Konvence pojmenování +- Organizace kódu +- Vzory testování + +## Architektura jako sdílený kontext + +Představte si architekturu jako sdílený kontext, který všichni agenti čtou před implementací: + +```text +PRD: "Co budovat" + ↓ +Architektura: "Jak to budovat" + ↓ +Agent A čte architekturu → implementuje Epic 1 +Agent B čte architekturu → implementuje Epic 2 +Agent C čte architekturu → implementuje Epic 3 + ↓ +Výsledek: Konzistentní implementace +``` + +## Klíčová témata ADR + +Běžná rozhodnutí, která zabraňují konfliktům: + +| Téma | Příklad rozhodnutí | +| ---------------- | -------------------------------------------- | +| Styl API | GraphQL vs REST vs gRPC | +| Databáze | PostgreSQL vs MongoDB | +| Autentizace | JWT vs Sessions | +| Řízení stavu | Redux vs Context vs Zustand | +| Stylování | CSS Modules vs Tailwind vs Styled Components | +| Testování | Jest + Playwright vs Vitest + Cypress | + +## Anti-vzory, kterým se vyhnout + +:::caution[Běžné chyby] +- **Implicitní rozhodnutí** — „Styl API vyřešíme průběžně“ vede k nekonzistenci +- **Nadměrná dokumentace** — Dokumentování každého drobného rozhodnutí způsobuje paralýzu analýzou +- **Zastaralá architektura** — Dokumenty napsané jednou a nikdy neaktualizované způsobují, že agenti následují zastaralé vzory +::: + +:::tip[Správný přístup] +- Dokumentujte rozhodnutí, která přesahují hranice epiců +- Zaměřte se na oblasti náchylné ke konfliktům +- Aktualizujte architekturu, jak se učíte +- Použijte `bmad-correct-course` pro významné změny +::: diff --git a/docs/cs/explanation/project-context.md b/docs/cs/explanation/project-context.md new file mode 100644 index 000000000..795b4b7b5 --- /dev/null +++ b/docs/cs/explanation/project-context.md @@ -0,0 +1,157 @@ +--- +title: "Kontext projektu" +description: Jak project-context.md vede AI agenty s pravidly a preferencemi vašeho projektu +sidebar: + order: 7 +--- + +Soubor `project-context.md` je implementační průvodce vašeho projektu pro AI agenty. Podobně jako „ústava“ v jiných vývojových systémech zachycuje pravidla, vzory a preference, které zajišťují konzistentní generování kódu napříč všemi workflow. + +## Co dělá + +AI agenti neustále dělají implementační rozhodnutí — jaké vzory následovat, jak strukturovat kód, jaké konvence používat. Bez jasného vedení mohou: +- Následovat generické osvědčené postupy, které neodpovídají vaší kódové bázi +- Dělat nekonzistentní rozhodnutí napříč různými stories +- Přehlédnout požadavky nebo omezení specifická pro projekt + +Soubor `project-context.md` toto řeší dokumentací toho, co agenti potřebují vědět, ve stručném formátu optimalizovaném pro LLM. + +## Jak to funguje + +Každý implementační workflow automaticky načítá `project-context.md`, pokud existuje. Architektonický workflow ho také načítá, aby respektoval vaše technické preference při navrhování architektury. + +**Načítán těmito workflow:** +- `bmad-create-architecture` — respektuje technické preference během solutioningu +- `bmad-create-story` — informuje tvorbu stories vzory projektu +- `bmad-dev-story` — vede implementační rozhodnutí +- `bmad-code-review` — validuje proti standardům projektu +- `bmad-quick-dev` — aplikuje vzory při implementaci specifikací +- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` — poskytuje celkový kontext projektu + +## Kdy ho vytvořit + +Soubor `project-context.md` je užitečný v jakékoli fázi projektu: + +| Scénář | Kdy vytvořit | Účel | +| ------------------------------------ | ----------------------------------------------- | -------------------------------------------------------------------- | +| **Nový projekt, před architekturou** | Ručně, před `bmad-create-architecture` | Dokumentujte vaše technické preference, aby je architekt respektoval | +| **Nový projekt, po architektuře** | Přes `bmad-generate-project-context` nebo ručně | Zachyťte architektonická rozhodnutí pro implementační agenty | +| **Existující projekt** | Přes `bmad-generate-project-context` | Objevte existující vzory, aby agenti dodržovali zavedené konvence | +| **Quick Flow projekt** | Před nebo během `bmad-quick-dev` | Zajistěte, aby rychlá implementace respektovala vaše vzory | + +:::tip[Doporučeno] +Pro nové projekty ho vytvořte ručně před architekturou, pokud máte silné technické preference. Jinak ho vygenerujte po architektuře pro zachycení těchto rozhodnutí. +::: + +## Co do něj patří + +Soubor má dvě hlavní sekce: + +### Technologický stack a verze + +Dokumentuje frameworky, jazyky a nástroje, které váš projekt používá se specifickými verzemi: + +```markdown +## Technology Stack & Versions + +- Node.js 20.x, TypeScript 5.3, React 18.2 +- State: Zustand (not Redux) +- Testing: Vitest, Playwright, MSW +- Styling: Tailwind CSS with custom design tokens +``` + +### Kritická pravidla implementace + +Dokumentuje vzory a konvence, které by agenti jinak mohli přehlédnout: + +```markdown +## Critical Implementation Rules + +**TypeScript Configuration:** +- Strict mode enabled — no `any` types without explicit approval +- Use `interface` for public APIs, `type` for unions/intersections + +**Code Organization:** +- Components in `/src/components/` with co-located `.test.tsx` +- Utilities in `/src/lib/` for reusable pure functions +- API calls use the `apiClient` singleton — never fetch directly + +**Testing Patterns:** +- Unit tests focus on business logic, not implementation details +- Integration tests use MSW to mock API responses +- E2E tests cover critical user journeys only + +**Framework-Specific:** +- All async operations use the `handleError` wrapper for consistent error handling +- Feature flags accessed via `featureFlag()` from `@/lib/flags` +- New routes follow the file-based routing pattern in `/src/app/` +``` + +Zaměřte se na to, co je **neočividné** — věci, které agenti nemusí odvodit z čtení úryvků kódu. Nedokumentujte standardní postupy, které platí univerzálně. + +## Vytvoření souboru + +Máte tři možnosti: + +### Ruční vytvoření + +Vytvořte soubor na `_bmad-output/project-context.md` a přidejte svá pravidla: + +```bash +# V kořeni projektu +mkdir -p _bmad-output +touch _bmad-output/project-context.md +``` + +Upravte ho s vaším technologickým stackem a pravidly implementace. Architektonický a implementační workflow ho automaticky najdou a načtou. + +### Generování po architektuře + +Spusťte workflow `bmad-generate-project-context` po dokončení architektury: + +```bash +bmad-generate-project-context +``` + +Toto skenuje váš dokument architektury a soubory projektu a generuje kontextový soubor zachycující učiněná rozhodnutí. + +### Generování pro existující projekty + +Pro existující projekty spusťte `bmad-generate-project-context` pro objevení existujících vzorů: + +```bash +bmad-generate-project-context +``` + +Workflow analyzuje vaši kódovou bázi, identifikuje konvence a vygeneruje kontextový soubor, který můžete zkontrolovat a upřesnit. + +## Proč na tom záleží + +Bez `project-context.md` agenti dělají předpoklady, které nemusí odpovídat vašemu projektu: + +| Bez kontextu | S kontextem | +| ----------------------------------------------- | ---------------------------------------- | +| Používá generické vzory | Dodržuje vaše zavedené konvence | +| Nekonzistentní styl napříč stories | Konzistentní implementace | +| Může přehlédnout omezení specifická pro projekt | Respektuje všechny technické požadavky | +| Každý agent rozhoduje nezávisle | Všichni agenti se řídí stejnými pravidly | + +To je zvláště důležité pro: +- **Quick Flow** — přeskakuje PRD a architekturu, takže kontextový soubor vyplní mezeru +- **Týmové projekty** — zajistí, že všichni agenti dodržují stejné standardy +- **Existující projekty** — zabrání porušení zavedených vzorů + +## Editace a aktualizace + +Soubor `project-context.md` je živý dokument. Aktualizujte ho, když: + +- Se změní architektonická rozhodnutí +- Jsou zavedeny nové konvence +- Vzory se vyvíjejí během implementace +- Identifikujete mezery z chování agentů + +Můžete ho kdykoli ručně upravit, nebo přegenerovat `bmad-generate-project-context` po významných změnách. + +:::note[Umístění souboru] +Výchozí umístění je `_bmad-output/project-context.md`. Workflow ho tam hledají a také kontrolují `**/project-context.md` kdekoli ve vašem projektu. +::: diff --git a/docs/cs/explanation/quick-dev.md b/docs/cs/explanation/quick-dev.md new file mode 100644 index 000000000..aa7305df9 --- /dev/null +++ b/docs/cs/explanation/quick-dev.md @@ -0,0 +1,73 @@ +--- +title: "Quick Dev" +description: Snižte tření human-in-the-loop bez ztráty kontrolních bodů chránících kvalitu výstupu +sidebar: + order: 2 +--- + +Záměr na vstupu, změny kódu na výstupu, s co nejmenším počtem human-in-the-loop kroků — bez obětování kvality. + +Umožňuje modelu běžet déle mezi kontrolními body a poté přivede člověka zpět pouze tehdy, když úkol nemůže bezpečně pokračovat bez lidského úsudku nebo když je čas zkontrolovat konečný výsledek. + +![Diagram workflow Quick Dev](/diagrams/quick-dev-diagram.png) + +## Proč to existuje + +Human-in-the-loop kroky jsou nutné a nákladné. + +Současné LLM stále selhávají předvídatelnými způsoby: chybně čtou záměr, vyplňují mezery sebevědomými odhady, odchylují se k nesouvisející práci a generují šumový výstup revize. Současně neustálá lidská intervence limituje rychlost vývoje. Lidská pozornost je úzké hrdlo. + +`bmad-quick-dev` přenastavuje tento kompromis. Důvěřuje modelu, aby běžel bez dozoru delší úseky, ale pouze poté, co workflow vytvořil dostatečně silnou hranici, aby to bylo bezpečné. + +## Základní design + +### 1. Nejprve komprimujte záměr + +Workflow začíná tím, že člověk a model zkomprimují požadavek do jednoho koherentního cíle. Vstup může začínat jako hrubé vyjádření záměru, ale předtím, než workflow poběží autonomně, musí být dostatečně malý, jasný a bez protimluvů pro provedení. + +Záměr může přijít v mnoha formách: pár frází, odkaz na bug tracker, výstup z plan mode, text zkopírovaný z chatové relace, nebo dokonce číslo story z BMAD vlastního `epics.md`. V posledním případě workflow nepochopí sémantiku sledování stories BMAD, ale stále může vzít samotnou story a pracovat s ní. + +Tento workflow neodstraňuje lidskou kontrolu. Přemisťuje ji na malý počet vysoce hodnotných momentů: + +- **Vyjasnění záměru** — přeměna nepřehledného požadavku na jeden koherentní cíl bez skrytých protimluvů +- **Schválení specifikace** — potvrzení, že zmrazené porozumění je správná věc k budování +- **Revize konečného produktu** — primární kontrolní bod, kde člověk rozhoduje, zda je výsledek přijatelný + +### 2. Nasměrujte na nejmenší bezpečnou cestu + +Jakmile je cíl jasný, workflow rozhodne, zda jde o skutečnou jednorázovou změnu nebo zda potřebuje plnější cestu. Malé změny s nulovým blast-radius mohou jít přímo k implementaci. Vše ostatní prochází plánováním, aby model měl silnější hranici před tím, než poběží déle samostatně. + +### 3. Běžte déle s menším dozorem + +Po tomto rozhodnutí o směrování může model nést více práce samostatně. Na plnější cestě se schválená specifikace stává hranicí, proti které model provádí s menším dozorem, což je celý smysl designu. + +### 4. Diagnostikujte selhání na správné vrstvě + +Pokud je implementace špatná, protože byl špatný záměr, oprava kódu je špatná oprava. Pokud je kód špatný, protože specifikace byla slabá, oprava diffu je také špatná oprava. Workflow je navržen tak, aby diagnostikoval, kde selhání vstoupilo do systému, vrátil se na tu vrstvu a přegeneroval odtamtud. + +Nálezy revize se používají k rozhodnutí, zda problém pochází ze záměru, generování specifikace nebo lokální implementace. Pouze skutečně lokální problémy se opravují lokálně. + +### 5. Přiveďte člověka zpět pouze když je potřeba + +Interview o záměru je human-in-the-loop, ale není to stejný druh přerušení jako opakující se kontrolní bod. Workflow se snaží udržet tyto opakující se kontrolní body na minimu. Po úvodním formování záměru se člověk vrací hlavně tehdy, když workflow nemůže bezpečně pokračovat bez úsudku a na konci, když je čas zkontrolovat výsledek. + +- **Řešení mezer v záměru** — vstoupení zpět, když revize prokáže, že workflow nemohl bezpečně odvodit, co bylo myšleno + +Vše ostatní je kandidátem na delší autonomní provádění. Tento kompromis je záměrný. Starší vzory věnují více lidské pozornosti nepřetržitému dozoru. Quick Dev věnuje více důvěry modelu, ale šetří lidskou pozornost pro momenty, kde má lidské uvažování nejvyšší páku. + +## Proč systém revize záleží + +Fáze revize není jen pro hledání chyb. Je tu pro směrování korekce bez ničení momentum. + +Tento workflow funguje nejlépe na platformě, která může spouštět sub-agenty, nebo alespoň vyvolat jiné LLM přes příkazovou řádku a čekat na výsledek. Pokud to vaše platforma nativně nepodporuje, můžete přidat skill, který to udělá. Bezcontextové sub-agenty jsou základním kamenem designu revize. + +Agentní revize často selhávají dvěma způsoby: + +- Generují příliš mnoho nálezů, čímž nutí člověka prosévat šum. +- Vychýlí aktuální změnu odhalením nesouvisejících problémů a přemění každý běh na ad-hoc úklidový projekt. + +Quick Dev řeší obojí tím, že s revizí zachází jako s triáží. + +Některé nálezy patří k aktuální změně. Některé ne. Pokud je nález náhodný spíše než kauzálně vázaný na aktuální práci, workflow ho může odložit místo nucení člověka ho okamžitě řešit. To udržuje běh zaměřený a zabraňuje náhodným tangentám ve spotřebování rozpočtu pozornosti. + +Ta triáž bude někdy nedokonalá. To je přijatelné. Obvykle je lepší špatně posoudit některé nálezy než zaplavit člověka tisíci nízkohodnotných revizních komentářů. Systém optimalizuje pro kvalitu signálu, ne vyčerpávající recall. diff --git a/docs/cs/explanation/why-solutioning-matters.md b/docs/cs/explanation/why-solutioning-matters.md new file mode 100644 index 000000000..1e9848bfd --- /dev/null +++ b/docs/cs/explanation/why-solutioning-matters.md @@ -0,0 +1,76 @@ +--- +title: "Proč je solutioning důležitý" +description: Pochopení toho, proč je fáze solutioningu klíčová pro projekty s více epicy +sidebar: + order: 3 +--- + +Fáze 3 (Solutioning) překládá **co** budovat (z plánování) na **jak** to budovat (technický návrh). Tato fáze zabraňuje konfliktům agentů v projektech s více epicy tím, že dokumentuje architektonická rozhodnutí před zahájením implementace. + +## Problém bez solutioningu + +```text +Agent 1 implementuje Epic 1 pomocí REST API +Agent 2 implementuje Epic 2 pomocí GraphQL +Výsledek: Nekonzistentní design API, integrační noční můra +``` + +Když více agentů implementuje různé části systému bez sdíleného architektonického vedení, dělají nezávislá technická rozhodnutí, která si mohou odporovat. + +## Řešení se solutioningem + +```text +Architektonický workflow rozhodne: "Použít GraphQL pro všechna API" +Všichni agenti dodržují architektonická rozhodnutí +Výsledek: Konzistentní implementace, žádné konflikty +``` + +Explicitní dokumentací technických rozhodnutí všichni agenti implementují konzistentně a integrace se stává přímočarou. + +## Solutioning vs. plánování + +| Aspekt | Plánování (Fáze 2) | Solutioning (Fáze 3) | +| -------- | ----------------------- | --------------------------------- | +| Otázka | Co a proč? | Jak? Pak jaké jednotky práce? | +| Výstup | FR/NFR (požadavky) | Architektura + epicy/stories | +| Agent | PM | Architect → PM | +| Publikum | Zainteresované strany | Vývojáři | +| Dokument | PRD (FR/NFR) | Architektura + soubory epiců | +| Úroveň | Obchodní logika | Technický design + rozklad práce | + +## Klíčový princip + +**Učiňte technická rozhodnutí explicitní a zdokumentovaná**, aby všichni agenti implementovali konzistentně. + +Toto zabraňuje: +- Konfliktům stylu API (REST vs GraphQL) +- Nekonzistencím v návrhu databáze +- Neshodám v řízení stavu +- Nesouladu konvencí pojmenování +- Variacím v bezpečnostním přístupu + +## Kdy je solutioning vyžadován + +| Cesta | Solutioning vyžadován? | +|-------|----------------------| +| Quick Flow | Ne — přeskočte úplně | +| BMad Method Simple | Volitelný | +| BMad Method Complex | Ano | +| Enterprise | Ano | + +:::tip[Pravidlo palce] +Pokud máte více epiců, které by mohly být implementovány různými agenty, potřebujete solutioning. +::: + +## Cena přeskočení + +Přeskočení solutioningu u složitých projektů vede k: + +- **Integračním problémům** objeveným uprostřed sprintu +- **Přepracování** kvůli konfliktním implementacím +- **Delšímu celkovému času vývoje** +- **Technickému dluhu** z nekonzistentních vzorů + +:::caution[Multiplikátor nákladů] +Zachycení problémů se zarovnáním v solutioningu je 10× rychlejší než jejich objevení během implementace. +::: diff --git a/docs/cs/how-to/customize-bmad.md b/docs/cs/how-to/customize-bmad.md new file mode 100644 index 000000000..4669030a0 --- /dev/null +++ b/docs/cs/how-to/customize-bmad.md @@ -0,0 +1,171 @@ +--- +title: "Jak přizpůsobit BMad" +description: Přizpůsobení agentů, workflow a modulů se zachováním kompatibility s aktualizacemi +sidebar: + order: 7 +--- + +Použijte soubory `.customize.yaml` k přizpůsobení chování agentů, person a nabídek při zachování vašich změn napříč aktualizacemi. + +## Kdy to použít + +- Chcete změnit jméno, osobnost nebo komunikační styl agenta +- Potřebujete, aby si agenti pamatovali kontextově specifické informace projektu +- Chcete přidat vlastní položky nabídky, které spouštějí vaše vlastní workflow nebo prompty +- Chcete, aby agenti prováděli specifické akce při každém spuštění + +:::note[Předpoklady] +- BMad nainstalován ve vašem projektu (viz [Jak nainstalovat BMad](./install-bmad.md)) +- Textový editor pro YAML soubory +::: + +:::caution[Chraňte svá přizpůsobení] +Vždy používejte soubory `.customize.yaml` popsané zde místo přímé editace souborů agentů. Instalátor přepíše soubory agentů během aktualizací, ale zachová vaše změny v `.customize.yaml`. +::: + +## Kroky + +### 1. Najděte soubory přizpůsobení + +Po instalaci najdete jeden soubor `.customize.yaml` na agenta v: + +```text +_bmad/_config/agents/ +├── core-bmad-master.customize.yaml +├── bmm-dev.customize.yaml +├── bmm-pm.customize.yaml +└── ... (jeden soubor na instalovaného agenta) +``` + +### 2. Upravte soubor přizpůsobení + +Otevřete soubor `.customize.yaml` pro agenta, kterého chcete upravit. Každá sekce je volitelná — přizpůsobte pouze to, co potřebujete. + +| Sekce | Chování | Účel | +| ------------------ | --------- | -------------------------------------------------------- | +| `agent.metadata` | Nahrazuje | Přepsat zobrazované jméno agenta | +| `persona` | Nahrazuje | Nastavit roli, identitu, styl a principy | +| `memories` | Přidává | Přidat trvalý kontext, který si agent vždy pamatuje | +| `menu` | Přidává | Přidat vlastní položky nabídky pro workflow nebo prompty | +| `critical_actions` | Přidává | Definovat instrukce při spuštění agenta | +| `prompts` | Přidává | Vytvořit znovupoužitelné prompty pro akce nabídky | + +Sekce označené **Nahrazuje** zcela přepíší výchozí hodnoty agenta. Sekce označené **Přidává** doplní existující konfiguraci. + +**Jméno agenta** + +Změňte, jak se agent představí: + +```yaml +agent: + metadata: + name: 'Spongebob' # Výchozí: "Amelia" +``` + +**Persona** + +Nahraďte osobnost, roli a komunikační styl agenta: + +```yaml +persona: + role: 'Senior Full-Stack Engineer' + identity: 'Lives in a pineapple (under the sea)' + communication_style: 'Spongebob annoying' + principles: + - 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep' + - 'Favor composition over inheritance' +``` + +Sekce `persona` nahrazuje celou výchozí personu, takže nastavte všechna čtyři pole. + +**Memories** + +Přidejte trvalý kontext, který si agent bude vždy pamatovat: + +```yaml +memories: + - 'Works at Krusty Krab' + - 'Favorite Celebrity: David Hasselhoff' + - 'Learned in Epic 1 that it is not cool to just pretend that tests have passed' +``` + +**Položky nabídky** + +Přidejte vlastní záznamy do nabídky agenta. Každá položka potřebuje `trigger`, cíl (`workflow` cestu nebo `action` referenci) a `description`: + +```yaml +menu: + - trigger: my-workflow + workflow: 'my-custom/workflows/my-workflow.yaml' + description: My custom workflow + - trigger: deploy + action: '#deploy-prompt' + description: Deploy to production +``` + +**Kritické akce** + +Definujte instrukce, které se spustí při startu agenta: + +```yaml +critical_actions: + - 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention' +``` + +**Vlastní prompty** + +Vytvořte znovupoužitelné prompty, na které mohou položky nabídky odkazovat s `action="#id"`: + +```yaml +prompts: + - id: deploy-prompt + content: | + Deploy the current branch to production: + 1. Run all tests + 2. Build the project + 3. Execute deployment script +``` + +### 3. Aplikujte změny + +Po editaci přeinstalujte pro aplikaci změn: + +```bash +npx bmad-method install +``` + +Instalátor detekuje existující instalaci a nabídne tyto možnosti: + +| Možnost | Co udělá | +| ---------------------------- | ---------------------------------------------------------------------- | +| **Quick Update** | Aktualizuje všechny moduly na nejnovější verzi a aplikuje přizpůsobení | +| **Modify BMad Installation** | Plný instalační postup pro přidání nebo odebrání modulů | + +Pro změny pouze přizpůsobení je **Quick Update** nejrychlejší možnost. + +## Řešení problémů + +**Změny se nezobrazují?** + +- Spusťte `npx bmad-method install` a vyberte **Quick Update** pro aplikaci změn +- Zkontrolujte, že vaše YAML syntaxe je platná (na odsazení záleží) +- Ověřte, že jste upravili správný soubor `.customize.yaml` pro daného agenta + +**Agent se nenačítá?** + +- Zkontrolujte YAML syntaxi pomocí online YAML validátoru +- Ujistěte se, že jste nenechali pole prázdná po odkomentování +- Zkuste se vrátit k původní šabloně a znovu sestavit + +**Potřebujete resetovat agenta?** + +- Vymažte nebo smažte soubor `.customize.yaml` agenta +- Spusťte `npx bmad-method install` a vyberte **Quick Update** pro obnovení výchozích hodnot + +## Přizpůsobení workflow + +Přizpůsobení existujících BMad Method workflow a skills přijde brzy. + +## Přizpůsobení modulů + +Návod na tvorbu rozšiřujících modulů a přizpůsobení existujících modulů přijde brzy. diff --git a/docs/cs/how-to/established-projects.md b/docs/cs/how-to/established-projects.md new file mode 100644 index 000000000..4be87509a --- /dev/null +++ b/docs/cs/how-to/established-projects.md @@ -0,0 +1,117 @@ +--- +title: "Existující projekty" +description: Jak používat BMad Method na existujících kódových bázích +sidebar: + order: 6 +--- + +Používejte BMad Method efektivně při práci na existujících projektech a starších kódových bázích. + +Tento návod pokrývá základní workflow pro zapojení se do existujících projektů s BMad Method. + +:::note[Předpoklady] +- BMad Method nainstalován (`npx bmad-method install`) +- Existující kódová báze, na které chcete pracovat +- Přístup k AI-powered IDE (Claude Code nebo Cursor) +::: + +## Krok 1: Vyčistěte dokončené plánovací artefakty + +Pokud jste dokončili všechny PRD epicy a stories procesem BMad, vyčistěte tyto soubory. Archivujte je, smažte nebo se spoléhejte na historii verzí. Nenechávejte tyto soubory v: + +- `docs/` +- `_bmad-output/planning-artifacts/` +- `_bmad-output/implementation-artifacts/` + +## Krok 2: Vytvořte kontext projektu + +:::tip[Doporučeno pro existující projekty] +Vygenerujte `project-context.md` pro zachycení vzorů a konvencí vaší existující kódové báze. Tím zajistíte, že AI agenti budou při implementaci změn dodržovat vaše zavedené postupy. +::: + +Spusťte workflow pro generování kontextu projektu: + +```bash +bmad-generate-project-context +``` + +Toto skenuje vaši kódovou bázi a identifikuje: +- Technologický stack a verze +- Vzory organizace kódu +- Konvence pojmenování +- Přístupy k testování +- Vzory specifické pro framework + +Vygenerovaný soubor můžete zkontrolovat a upravit, nebo ho vytvořit ručně na `_bmad-output/project-context.md`. + +[Zjistit více o kontextu projektu](../explanation/project-context.md) + +## Krok 3: Udržujte kvalitní projektovou dokumentaci + +Vaše složka `docs/` by měla obsahovat stručnou, dobře organizovanou dokumentaci, která přesně reprezentuje váš projekt: + +- Záměr a obchodní zdůvodnění +- Obchodní pravidla +- Architektura +- Jakékoli další relevantní informace o projektu + +Pro složité projekty zvažte použití workflow `bmad-document-project`. Nabízí varianty, které proskenují celý váš projekt a zdokumentují jeho aktuální stav. + +## Krok 3: Získejte pomoc + +### BMad-Help: Váš výchozí bod + +**Spusťte `bmad-help` kdykoli si nejste jisti, co dělat dál.** Tento inteligentní průvodce: + +- Prozkoumá váš projekt a zjistí, co už bylo uděláno +- Ukáže možnosti na základě nainstalovaných modulů +- Rozumí dotazům v přirozeném jazyce + +``` +bmad-help I have an existing Rails app, where should I start? +bmad-help What's the difference between quick-flow and full method? +bmad-help Show me what workflows are available +``` + +BMad-Help se také **automaticky spouští na konci každého workflow** a poskytuje jasné pokyny, co přesně dělat dál. + +### Volba přístupu + +Máte dvě hlavní možnosti v závislosti na rozsahu změn: + +| Rozsah | Doporučený přístup | +| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| **Malé aktualizace či doplnění** | Spusťte `bmad-quick-dev` pro vyjasnění záměru, plánování, implementaci a revizi v jednom workflow. Plná čtyřfázová metoda BMad je pravděpodobně přehnaná. | +| **Velké změny či doplnění** | Začněte s metodou BMad a aplikujte tolik nebo tak málo důkladnosti, kolik potřebujete. | + +### Během tvorby PRD + +Při vytváření briefu nebo přímém přechodu na PRD zajistěte, aby agent: + +- Našel a analyzoval vaši existující projektovou dokumentaci +- Přečetl si správný kontext o vašem aktuálním systému + +Agenta můžete navést explicitně, ale cílem je zajistit, aby se nová funkce dobře integrovala s vaším existujícím systémem. + +### Úvahy o UX + +Práce na UX je volitelná. Rozhodnutí nezávisí na tom, zda váš projekt má UX, ale na: + +- Zda budete pracovat na změnách UX +- Zda jsou potřeba významné nové UX návrhy nebo vzory + +Pokud vaše změny představují jednoduché aktualizace existujících obrazovek, se kterými jste spokojeni, plný UX proces je zbytečný. + +### Úvahy o architektuře + +Při práci na architektuře zajistěte, aby architekt: + +- Používal správné zdokumentované soubory +- Skenoval existující kódovou bázi + +Věnujte zde zvláštní pozornost, abyste předešli znovuvynalézání kola nebo rozhodnutím, která neodpovídají vaší existující architektuře. + +## Další informace + +- **[Rychlé opravy](./quick-fixes.md)** — Opravy chyb a ad-hoc změny +- **[FAQ pro existující projekty](../explanation/established-projects-faq.md)** — Časté otázky o práci na existujících projektech diff --git a/docs/cs/how-to/get-answers-about-bmad.md b/docs/cs/how-to/get-answers-about-bmad.md new file mode 100644 index 000000000..19865ae3f --- /dev/null +++ b/docs/cs/how-to/get-answers-about-bmad.md @@ -0,0 +1,110 @@ +--- +title: "Jak získat odpovědi o BMad" +description: Použijte LLM k rychlému zodpovězení vašich otázek o BMad +sidebar: + order: 4 +--- + +## Začněte zde: BMad-Help + +**Nejrychlejší způsob, jak získat odpovědi o BMad, je skill `bmad-help`.** Tento inteligentní průvodce zodpoví více než 80 % všech otázek a je vám k dispozici přímo ve vašem IDE při práci. + +BMad-Help je víc než vyhledávací nástroj — umí: +- **Prozkoumat váš projekt** a zjistit, co už bylo dokončeno +- **Rozumět přirozenému jazyku** — ptejte se běžnou řečí +- **Přizpůsobit se nainstalovaným modulům** — zobrazí relevantní možnosti +- **Automaticky se spouštět po workflow** — řekne vám přesně, co dělat dál +- **Doporučit první povinný úkol** — žádné hádání, kde začít + +### Jak používat BMad-Help + +Zavolejte ho jménem ve vaší AI relaci: + +``` +bmad-help +``` + +:::tip +V závislosti na vaší platformě můžete také použít `/bmad-help` nebo `$bmad-help`, ale samotné `bmad-help` by mělo fungovat všude. +::: + +Spojte ho s dotazem v přirozeném jazyce: + +``` +bmad-help I have a SaaS idea and know all the features. Where do I start? +bmad-help What are my options for UX design? +bmad-help I'm stuck on the PRD workflow +bmad-help Show me what's been done so far +``` + +BMad-Help odpoví: +- Co je doporučeno pro vaši situaci +- Jaký je první povinný úkol +- Jak vypadá zbytek procesu + +## Kdy použít tohoto průvodce + +Použijte tuto sekci, když: +- Chcete pochopit architekturu nebo interní fungování BMad +- Potřebujete odpovědi mimo to, co BMad-Help nabízí +- Zkoumáte BMad před instalací +- Chcete prozkoumat zdrojový kód přímo + +## Kroky + +### 1. Vyberte si zdroj + +| Zdroj | Nejlepší pro | Příklady | +| -------------------- | ----------------------------------------- | ---------------------------- | +| **Složka `_bmad`** | Jak BMad funguje — agenti, workflow, prompty | „Co dělá PM agent?“ | +| **Celý GitHub repo** | Historie, instalátor, architektura | „Co se změnilo ve v6?“ | +| **`llms-full.txt`** | Rychlý přehled z dokumentace | „Vysvětli čtyři fáze BMad“ | + +Složka `_bmad` se vytvoří při instalaci BMad. Pokud ji ještě nemáte, naklonujte si repo. + +### 2. Nasměrujte AI na zdroj + +**Pokud vaše AI umí číst soubory (Claude Code, Cursor atd.):** + +- **BMad nainstalován:** Nasměrujte na složku `_bmad` a ptejte se přímo +- **Chcete hlubší kontext:** Naklonujte si [celé repo](https://github.com/bmad-code-org/BMAD-METHOD) + +**Pokud používáte ChatGPT nebo Claude.ai:** + +Načtěte `llms-full.txt` do vaší relace: + +```text +https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt +``` + +### 3. Položte svou otázku + +:::note[Příklad] +**O:** „Řekni mi nejrychlejší způsob, jak něco vytvořit s BMad“ + +**A:** Použijte Quick Flow: Spusťte `bmad-quick-dev` — vyjasní váš záměr, naplánuje, implementuje, zreviduje a prezentuje výsledky v jednom workflow, přeskočí celé fáze plánování. +::: + +## Co získáte + +Přímé odpovědi o BMad — jak agenti fungují, co dělají workflow, proč jsou věci strukturované tak, jak jsou — bez čekání na odpověď od někoho jiného. + +## Tipy + +- **Ověřte překvapivé odpovědi** — LLM se občas mýlí. Zkontrolujte zdrojový soubor nebo se zeptejte na Discordu. +- **Buďte konkrétní** — „Co dělá krok 3 PRD workflow?“ je lepší než „Jak funguje PRD?“ + +## Stále jste uvízli? + +Zkusili jste přístup přes LLM a stále potřebujete pomoc? Nyní máte mnohem lepší otázku k položení. + +| Kanál | Použijte pro | +| ------------------------- | ------------------------------------------- | +| `#bmad-method-help` | Rychlé otázky (chat v reálném čase) | +| `help-requests` fórum | Detailní otázky (vyhledatelné, trvalé) | +| `#suggestions-feedback` | Nápady a požadavky na funkce | +| `#report-bugs-and-issues` | Hlášení chyb | + +**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) + +**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (pro jasné chyby) diff --git a/docs/cs/how-to/install-bmad.md b/docs/cs/how-to/install-bmad.md new file mode 100644 index 000000000..548b99e13 --- /dev/null +++ b/docs/cs/how-to/install-bmad.md @@ -0,0 +1,116 @@ +--- +title: "Jak nainstalovat BMad" +description: Průvodce instalací BMad ve vašem projektu krok za krokem +sidebar: + order: 1 +--- + +Použijte příkaz `npx bmad-method install` k nastavení BMad ve vašem projektu s výběrem modulů a AI nástrojů. + +Pokud chcete použít neinteraktivní instalátor a zadat všechny možnosti na příkazové řádce, podívejte se na [tento návod](./non-interactive-installation.md). + +## Kdy to použít + +- Začínáte nový projekt s BMad +- Přidáváte BMad do existující kódové báze +- Aktualizujete stávající instalaci BMad + +:::note[Předpoklady] +- **Node.js** 20+ (vyžadováno pro instalátor) +- **Git** (doporučeno) +- **AI nástroj** (Claude Code, Cursor nebo podobný) +::: + +## Kroky + +### 1. Spusťte instalátor + +```bash +npx bmad-method install +``` + +:::tip[Chcete nejnovější prereleaseový build?] +Použijte dist-tag `next`: +```bash +npx bmad-method@next install +``` + +Získáte novější změny dříve, s vyšší šancí na nestabilitu oproti výchozí instalaci. +::: + +:::tip[Bleeding edge] +Pro instalaci nejnovější verze z hlavní větve (může být nestabilní): +```bash +npx github:bmad-code-org/BMAD-METHOD install +``` +::: + +### 2. Zvolte umístění instalace + +Instalátor se zeptá, kam nainstalovat soubory BMad: + +- Aktuální adresář (doporučeno pro nové projekty, pokud jste adresář vytvořili sami a spouštíte z něj) +- Vlastní cesta + +### 3. Vyberte své AI nástroje + +Vyberte, které AI nástroje používáte: + +- Claude Code +- Cursor +- Ostatní + +Každý nástroj má svůj vlastní způsob integrace skills. Instalátor vytvoří drobné prompt soubory pro aktivaci workflow a agentů — jednoduše je umístí tam, kde je váš nástroj očekává. + +:::note[Povolení skills] +Některé platformy vyžadují explicitní povolení skills v nastavení, než se zobrazí. Pokud nainstalujete BMad a nevidíte skills, zkontrolujte nastavení vaší platformy nebo se zeptejte svého AI asistenta, jak skills povolit. +::: + +### 4. Zvolte moduly + +Instalátor zobrazí dostupné moduly. Vyberte ty, které potřebujete — většina uživatelů chce pouze **BMad Method** (modul pro vývoj softwaru). + +### 5. Následujte výzvy + +Instalátor vás provede zbytkem — vlastní obsah, nastavení atd. + +## Co získáte + +```text +váš-projekt/ +├── _bmad/ +│ ├── bmm/ # Vaše vybrané moduly +│ │ └── config.yaml # Nastavení modulu (pokud byste ho někdy potřebovali změnit) +│ ├── core/ # Povinný základní modul +│ └── ... +├── _bmad-output/ # Generované artefakty +├── .claude/ # Claude Code skills (pokud používáte Claude Code) +│ └── skills/ +│ ├── bmad-help/ +│ ├── bmad-persona/ +│ └── ... +└── .cursor/ # Cursor skills (pokud používáte Cursor) + └── skills/ + └── ... +``` + +## Ověření instalace + +Spusťte `bmad-help` pro ověření, že vše funguje, a zjistěte, co dělat dál. + +**BMad-Help je váš inteligentní průvodce**, který: +- Potvrdí, že vaše instalace funguje +- Ukáže, co je dostupné na základě nainstalovaných modulů +- Doporučí váš první krok + +Můžete mu také klást otázky: +``` +bmad-help I just installed, what should I do first? +bmad-help What are my options for a SaaS project? +``` + +## Řešení problémů + +**Instalátor vyhodí chybu** — Zkopírujte výstup do svého AI asistenta a nechte ho to vyřešit. + +**Instalátor fungoval, ale něco nefunguje později** — Vaše AI potřebuje kontext BMad, aby pomohla. Podívejte se na [Jak získat odpovědi o BMad](./get-answers-about-bmad.md) pro návod, jak nasměrovat AI na správné zdroje. diff --git a/docs/cs/how-to/non-interactive-installation.md b/docs/cs/how-to/non-interactive-installation.md new file mode 100644 index 000000000..4d784f923 --- /dev/null +++ b/docs/cs/how-to/non-interactive-installation.md @@ -0,0 +1,153 @@ +--- +title: Neinteraktivní instalace +description: Instalace BMad pomocí příznaků příkazové řádky pro CI/CD pipelines a automatizované nasazení +sidebar: + order: 2 +--- + +Použijte příznaky příkazové řádky k neinteraktivní instalaci BMad. To je užitečné pro: + +## Kdy to použít + +- Automatizovaná nasazení a CI/CD pipelines +- Skriptované instalace +- Hromadné instalace napříč více projekty +- Rychlé instalace se známými konfiguracemi + +:::note[Předpoklady] +Vyžaduje [Node.js](https://nodejs.org) v20+ a `npx` (součástí npm). +::: + +## Dostupné příznaky + +### Možnosti instalace + +| Příznak | Popis | Příklad | +|---------|-------|---------| +| `--directory ` | Instalační adresář | `--directory ~/projects/myapp` | +| `--modules ` | Čárkou oddělená ID modulů | `--modules bmm,bmb` | +| `--tools ` | Čárkou oddělená ID nástrojů/IDE (použijte `none` pro přeskočení) | `--tools claude-code,cursor` nebo `--tools none` | +| `--action ` | Akce pro existující instalace: `install` (výchozí), `update` nebo `quick-update` | `--action quick-update` | + +### Základní konfigurace + +| Příznak | Popis | Výchozí | +|---------|-------|---------| +| `--user-name ` | Jméno, které agenti použijí | Systémové uživatelské jméno | +| `--communication-language ` | Jazyk komunikace agentů | English | +| `--document-output-language ` | Jazyk výstupních dokumentů | English | +| `--output-folder ` | Cesta k výstupní složce | _bmad-output | + +### Další možnosti + +| Příznak | Popis | +|---------|-------| +| `-y, --yes` | Přijmout všechna výchozí nastavení a přeskočit výzvy | +| `-d, --debug` | Povolit ladící výstup pro generování manifestu | + +## ID modulů + +Dostupná ID modulů pro příznak `--modules`: + +- `bmm` — BMad Method Master +- `bmb` — BMad Builder + +Zkontrolujte [registr BMad](https://github.com/bmad-code-org) pro dostupné externí moduly. + +## ID nástrojů/IDE + +Dostupná ID nástrojů pro příznak `--tools`: + +**Preferované:** `claude-code`, `cursor` + +Spusťte `npx bmad-method install` interaktivně jednou pro zobrazení aktuálního seznamu podporovaných nástrojů, nebo zkontrolujte [konfiguraci kódů platforem](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/installer/ide/platform-codes.yaml). + +## Režimy instalace + +| Režim | Popis | Příklad | +|-------|-------|---------| +| Plně neinteraktivní | Zadejte všechny příznaky pro přeskočení výzev | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` | +| Polo-interaktivní | Zadejte některé příznaky; BMad se zeptá na zbytek | `npx bmad-method install --directory . --modules bmm` | +| Pouze výchozí | Přijměte vše výchozí s `-y` | `npx bmad-method install --yes` | +| Bez nástrojů | Přeskočte konfiguraci nástrojů/IDE | `npx bmad-method install --modules bmm --tools none` | + +## Příklady + +### Instalace v CI/CD pipeline + +```bash +#!/bin/bash +# install-bmad.sh + +npx bmad-method install \ + --directory "${GITHUB_WORKSPACE}" \ + --modules bmm \ + --tools claude-code \ + --user-name "CI Bot" \ + --communication-language English \ + --document-output-language English \ + --output-folder _bmad-output \ + --yes +``` + +### Aktualizace existující instalace + +```bash +npx bmad-method install \ + --directory ~/projects/myapp \ + --action update \ + --modules bmm,bmb,custom-module +``` + +### Rychlá aktualizace (zachování nastavení) + +```bash +npx bmad-method install \ + --directory ~/projects/myapp \ + --action quick-update +``` + +## Co získáte + +- Plně nakonfigurovaný adresář `_bmad/` ve vašem projektu +- Agenty a workflow nakonfigurované pro vybrané moduly a nástroje +- Složku `_bmad-output/` pro generované artefakty + +## Validace a zpracování chyb + +BMad validuje všechny zadané příznaky: + +- **Adresář** — Musí být platná cesta s oprávněním k zápisu +- **Moduly** — Upozorní na neplatná ID modulů (ale nespadne) +- **Nástroje** — Upozorní na neplatná ID nástrojů (ale nespadne) +- **Vlastní obsah** — Každá cesta musí obsahovat platný soubor `module.yaml` +- **Akce** — Musí být jedna z: `install`, `update`, `quick-update` + +Neplatné hodnoty buď: +1. Zobrazí chybu a ukončí se (pro kritické možnosti jako adresář) +2. Zobrazí varování a přeskočí (pro volitelné položky jako vlastní obsah) +3. Přepnou na interaktivní výzvy (pro chybějící povinné hodnoty) + +:::tip[Osvědčené postupy] +- Používejte absolutní cesty pro `--directory` pro zamezení nejednoznačnosti +- Otestujte příznaky lokálně před použitím v CI/CD pipelines +- Kombinujte s `-y` pro skutečně bezobslužné instalace +- Použijte `--debug` pokud narazíte na problémy během instalace +::: + +## Řešení problémů + +### Instalace selže s „Invalid directory“ + +- Cesta k adresáři musí existovat (nebo musí existovat jeho nadřazený adresář) +- Potřebujete oprávnění k zápisu +- Cesta musí být absolutní nebo správně relativní k aktuálnímu adresáři + +### Modul nenalezen + +- Ověřte, že ID modulu je správné +- Externí moduly musí být dostupné v registru + +:::note[Stále jste uvízli?] +Spusťte s `--debug` pro detailní výstup, zkuste interaktivní režim pro izolaci problému, nebo nahlaste na . +::: diff --git a/docs/cs/how-to/project-context.md b/docs/cs/how-to/project-context.md new file mode 100644 index 000000000..420e34ace --- /dev/null +++ b/docs/cs/how-to/project-context.md @@ -0,0 +1,127 @@ +--- +title: "Správa kontextu projektu" +description: Vytvoření a údržba project-context.md pro vedení AI agentů +sidebar: + order: 8 +--- + +Použijte soubor `project-context.md` k zajištění toho, aby AI agenti dodržovali technické preference a pravidla implementace vašeho projektu ve všech workflow. Aby byl vždy dostupný, můžete také přidat řádek `Important project context and conventions are located in [cesta k project context]/project-context.md` do souboru kontextu nebo pravidel vašeho nástroje (jako je `AGENTS.md`). + +:::note[Předpoklady] +- BMad Method nainstalován +- Znalost technologického stacku a konvencí vašeho projektu +::: + +## Kdy to použít + +- Máte silné technické preference před začátkem architektury +- Dokončili jste architekturu a chcete zachytit rozhodnutí pro implementaci +- Pracujete na existující kódové bázi se zavedenými vzory +- Všimnete si, že agenti dělají nekonzistentní rozhodnutí napříč stories + +## Krok 1: Vyberte přístup + +**Ruční vytvoření** — Nejlepší, když přesně víte, jaká pravidla chcete dokumentovat + +**Generování po architektuře** — Nejlepší pro zachycení rozhodnutí učiněných během solutioningu + +**Generování pro existující projekty** — Nejlepší pro objevení vzorů v existujících kódových bázích + +## Krok 2: Vytvořte soubor + +### Možnost A: Ruční vytvoření + +Vytvořte soubor na `_bmad-output/project-context.md`: + +```bash +mkdir -p _bmad-output +touch _bmad-output/project-context.md +``` + +Přidejte váš technologický stack a pravidla implementace: + +```markdown +--- +project_name: 'MyProject' +user_name: 'YourName' +date: '2026-02-15' +sections_completed: ['technology_stack', 'critical_rules'] +--- + +# Project Context for AI Agents + +## Technology Stack & Versions + +- Node.js 20.x, TypeScript 5.3, React 18.2 +- State: Zustand +- Testing: Vitest, Playwright +- Styling: Tailwind CSS + +## Critical Implementation Rules + +**TypeScript:** +- Strict mode enabled, no `any` types +- Use `interface` for public APIs, `type` for unions + +**Code Organization:** +- Components in `/src/components/` with co-located tests +- API calls use `apiClient` singleton — never fetch directly + +**Testing:** +- Unit tests focus on business logic +- Integration tests use MSW for API mocking +``` + +### Možnost B: Generování po architektuře + +Spusťte workflow v novém chatu: + +```bash +bmad-generate-project-context +``` + +Workflow skenuje váš dokument architektury a soubory projektu a generuje kontextový soubor zachycující učiněná rozhodnutí. + +### Možnost C: Generování pro existující projekty + +Pro existující projekty spusťte: + +```bash +bmad-generate-project-context +``` + +Workflow analyzuje vaši kódovou bázi, identifikuje konvence a vygeneruje kontextový soubor, který můžete zkontrolovat a upřesnit. + +## Krok 3: Ověřte obsah + +Zkontrolujte vygenerovaný soubor a ujistěte se, že zachycuje: + +- Správné verze technologií +- Vaše skutečné konvence (ne generické osvědčené postupy) +- Pravidla, která předcházejí běžným chybám +- Vzory specifické pro framework + +Ručně upravte pro doplnění chybějícího nebo odstranění nepřesností. + +## Co získáte + +Soubor `project-context.md`, který: + +- Zajistí, že všichni agenti dodržují stejné konvence +- Zabrání nekonzistentním rozhodnutím napříč stories +- Zachytí architektonická rozhodnutí pro implementaci +- Slouží jako reference pro vzory a pravidla vašeho projektu + +## Tipy + +:::tip[Osvědčené postupy] +- **Zaměřte se na neočividné** — Dokumentujte vzory, které agenti mohou přehlédnout (např. „Použijte JSDoc na každé veřejné třídě“), ne univerzální postupy jako „používejte smysluplné názvy proměnných.“ +- **Udržujte to stručné** — Tento soubor načítá každý implementační workflow. Dlouhé soubory plýtvají kontextem. Vylučte obsah, který platí pouze pro úzký rozsah nebo specifické stories. +- **Aktualizujte dle potřeby** — Upravte ručně, když se vzory změní, nebo přegenerujte po významných změnách architektury. +- Funguje pro projekty Quick Flow i plné metody BMad. +::: + +## Další kroky + +- [**Vysvětlení kontextu projektu**](../explanation/project-context.md) — Zjistěte více o tom, jak to funguje +- [**Mapa pracovních postupů**](../reference/workflow-map.md) — Podívejte se, které workflow načítají kontext projektu diff --git a/docs/cs/how-to/quick-fixes.md b/docs/cs/how-to/quick-fixes.md new file mode 100644 index 000000000..09f9484d6 --- /dev/null +++ b/docs/cs/how-to/quick-fixes.md @@ -0,0 +1,95 @@ +--- +title: "Rychlé opravy" +description: Jak provádět rychlé opravy a ad-hoc změny +sidebar: + order: 5 +--- + +Použijte **Quick Dev** pro opravy chyb, refaktoringy nebo malé cílené změny, které nevyžadují plnou metodu BMad. + +## Kdy to použít + +- Opravy chyb s jasnou, známou příčinou +- Malé refaktoringy (přejmenování, extrakce, restrukturalizace) omezené na několik souborů +- Drobné úpravy funkcí nebo změny konfigurace +- Aktualizace závislostí + +:::note[Předpoklady] +- BMad Method nainstalován (`npx bmad-method install`) +- AI-powered IDE (Claude Code, Cursor nebo podobné) +::: + +## Kroky + +### 1. Začněte nový chat + +Otevřete **novou chatovací relaci** ve vašem AI IDE. Opětovné použití relace z předchozího workflow může způsobit konflikty kontextu. + +### 2. Zadejte svůj záměr + +Quick Dev přijímá volně formulovaný záměr — před, s nebo po vyvolání. Příklady: + +```text +run quick-dev — Fix the login validation bug that allows empty passwords. +``` + +```text +run quick-dev — fix https://github.com/org/repo/issues/42 +``` + +```text +run quick-dev — implement the intent in _bmad-output/implementation-artifacts/my-intent.md +``` + +```text +I think the problem is in the auth middleware, it's not checking token expiry. +Let me look at it... yeah, src/auth/middleware.ts line 47 skips +the exp check entirely. run quick-dev +``` + +```text +run quick-dev +> What would you like to do? +Refactor UserService to use async/await instead of callbacks. +``` + +Prostý text, cesty k souborům, GitHub issue URL, odkazy na bug tracker — cokoli, co LLM dokáže převést na konkrétní záměr. + +### 3. Odpovězte na otázky a schvalte + +Quick Dev se může zeptat na upřesňující otázky nebo prezentovat krátkou specifikaci ke schválení před implementací. Odpovězte na otázky a schvalte, až budete s plánem spokojeni. + +### 4. Zkontrolujte a pushněte + +Quick Dev implementuje změnu, zreviduje svou práci, opraví problémy a commitne lokálně. Když je hotov, otevře dotčené soubory ve vašem editoru. + +- Projděte diff a potvrďte, že změna odpovídá vašemu záměru +- Pokud něco nevypadá dobře, řekněte agentovi, co opravit — může iterovat ve stejné relaci + +Až budete spokojeni, pushněte commit. Quick Dev nabídne push a vytvoření PR za vás. + +:::caution[Pokud se něco rozbije] +Pokud pushnutá změna způsobí neočekávané problémy, použijte `git revert HEAD` pro čisté vrácení posledního commitu. Poté začněte nový chat a spusťte Quick Dev znovu s jiným přístupem. +::: + +## Co získáte + +- Upravené zdrojové soubory s aplikovanou opravou nebo refaktoringem +- Procházející testy (pokud má váš projekt testovací sadu) +- Commit připravený k pushnutí s konvenční commit zprávou + +## Odložená práce + +Quick Dev udržuje každý běh zaměřený na jeden cíl. Pokud váš požadavek obsahuje více nezávislých cílů, nebo pokud revize odhalí předchozí problémy nesouvisející s vaší změnou, Quick Dev je odloží do souboru (`deferred-work.md` ve vašem adresáři implementačních artefaktů) místo toho, aby se pokusil vše řešit najednou. + +Zkontrolujte tento soubor po běhu — je to váš backlog věcí, ke kterým se vrátit. Každou odloženou položku lze zadat do nového běhu Quick Dev později. + +## Kdy přejít na formální plánování + +Zvažte použití plné metody BMad, když: + +- Změna ovlivňuje více systémů nebo vyžaduje koordinované aktualizace napříč mnoha soubory +- Nejste si jisti rozsahem a potřebujete nejprve zjišťování požadavků +- Potřebujete dokumentaci nebo architektonická rozhodnutí zaznamenaná pro tým + +Podívejte se na [Quick Dev](../explanation/quick-dev.md) pro více informací o tom, jak Quick Dev zapadá do metody BMad. diff --git a/docs/cs/how-to/shard-large-documents.md b/docs/cs/how-to/shard-large-documents.md new file mode 100644 index 000000000..53e059933 --- /dev/null +++ b/docs/cs/how-to/shard-large-documents.md @@ -0,0 +1,78 @@ +--- +title: "Průvodce dělením dokumentů" +description: Rozdělení velkých markdown souborů na menší organizované soubory pro lepší správu kontextu +sidebar: + order: 9 +--- + +Použijte nástroj `bmad-shard-doc`, pokud potřebujete rozdělit velké markdown soubory na menší, organizované soubory pro lepší správu kontextu. + +:::caution[Zastaralé] +Toto se již nedoporučuje a brzy s aktualizovanými workflow a většinou hlavních LLM a nástrojů podporujících subprocesy to bude zbytečné. +::: + +## Kdy to použít + +Použijte pouze pokud si všimnete, že váš zvolený nástroj / model nedokáže načíst a přečíst všechny dokumenty jako vstup, když je to potřeba. + +## Co je dělení dokumentů? + +Dělení dokumentů rozděluje velké markdown soubory na menší, organizované soubory na základě nadpisů úrovně 2 (`## Nadpis`). + +### Architektura + +```text +Před dělením: +_bmad-output/planning-artifacts/ +└── PRD.md (velký soubor o 50k tokenech) + +Po dělení: +_bmad-output/planning-artifacts/ +└── prd/ + ├── index.md # Obsah s popisy + ├── overview.md # Sekce 1 + ├── user-requirements.md # Sekce 2 + ├── technical-requirements.md # Sekce 3 + └── ... # Další sekce +``` + +## Kroky + +### 1. Spusťte nástroj Shard-Doc + +```bash +/bmad-shard-doc +``` + +### 2. Následujte interaktivní proces + +```text +Agent: Which document would you like to shard? +User: docs/PRD.md + +Agent: Default destination: docs/prd/ + Accept default? [y/n] +User: y + +Agent: Sharding PRD.md... + ✓ Created 12 section files + ✓ Generated index.md + ✓ Complete! +``` + +## Jak funguje vyhledávání workflow + +BMad workflow používají **duální systém vyhledávání**: + +1. **Nejprve zkusí celý dokument** — Hledá `document-name.md` +2. **Zkontroluje rozdělenou verzi** — Hledá `document-name/index.md` +3. **Pravidlo priority** — Celý dokument má přednost, pokud existují oba — odstraňte celý dokument, pokud chcete použít rozdělenou verzi + +## Podpora workflow + +Všechny BMM workflow podporují oba formáty: + +- Celé dokumenty +- Rozdělené dokumenty +- Automatická detekce +- Transparentní pro uživatele diff --git a/docs/cs/how-to/upgrade-to-v6.md b/docs/cs/how-to/upgrade-to-v6.md new file mode 100644 index 000000000..babe4c1af --- /dev/null +++ b/docs/cs/how-to/upgrade-to-v6.md @@ -0,0 +1,100 @@ +--- +title: "Jak upgradovat na v6" +description: Migrace z BMad v4 na v6 +sidebar: + order: 3 +--- + +Použijte instalátor BMad pro upgrade z v4 na v6, který zahrnuje automatickou detekci starších instalací a asistenci při migraci. + +## Kdy to použít + +- Máte nainstalovaný BMad v4 (složka `.bmad-method`) +- Chcete migrovat na novou architekturu v6 +- Máte existující plánovací artefakty k zachování + +:::note[Předpoklady] +- Node.js 20+ +- Existující instalace BMad v4 +::: + +## Kroky + +### 1. Spusťte instalátor + +Postupujte podle [instrukcí instalátoru](./install-bmad.md). + +### 2. Zpracování starší instalace + +Když je detekována v4, můžete: + +- Nechat instalátor zálohovat a odstranit `.bmad-method` +- Ukončit a zpracovat vyčištění ručně + +Pokud jste pojmenovali složku bmad method jinak, musíte ji odstranit ručně. + +### 3. Vyčištění IDE skills + +Ručně odstraňte starší v4 IDE příkazy/skills — například pokud máte Claude Code, hledejte vnořené složky začínající na bmad a odstraňte je: + +- `.claude/commands/` + +Nové v6 skills se instalují do: + +- `.claude/skills/` + +### 4. Migrace plánovacích artefaktů + +**Pokud máte plánovací dokumenty (Brief/PRD/UX/Architektura):** + +Přesuňte je do `_bmad-output/planning-artifacts/` s popisnými názvy: + +- Zahrňte `PRD` v názvu souboru pro PRD dokumenty +- Zahrňte `brief`, `architecture` nebo `ux-design` odpovídajícím způsobem +- Rozdělené dokumenty mohou být v pojmenovaných podsložkách + +**Pokud jste uprostřed plánování:** Zvažte restart s v6 workflow. Použijte existující dokumenty jako vstupy — nové workflow s progresivním objevováním, webovým vyhledáváním a plan mode IDE produkují lepší výsledky. + +### 5. Migrace probíhajícího vývoje + +Pokud máte vytvořené nebo implementované stories: + +1. Dokončete instalaci v6 +2. Umístěte `epics.md` nebo `epics/epic*.md` do `_bmad-output/planning-artifacts/` +3. Spusťte workflow `bmad-sprint-planning` Scrum Mastera +4. Řekněte SM, které epicy/stories jsou již dokončené + +## Co získáte + +**Sjednocená struktura v6:** + +```text +váš-projekt/ +├── _bmad/ # Jedna instalační složka +│ ├── _config/ # Vaše přizpůsobení +│ │ └── agents/ # Soubory přizpůsobení agentů +│ ├── core/ # Univerzální základní framework +│ ├── bmm/ # Modul BMad Method +│ ├── bmb/ # BMad Builder +│ └── cis/ # Creative Intelligence Suite +└── _bmad-output/ # Výstupní složka (v4 to byla složka dokumentů) +``` + +## Migrace modulů + +| Modul v4 | Stav v6 | +| ----------------------------- | ---------------------------------- | +| `.bmad-2d-phaser-game-dev` | Integrován do modulu BMGD | +| `.bmad-2d-unity-game-dev` | Integrován do modulu BMGD | +| `.bmad-godot-game-dev` | Integrován do modulu BMGD | +| `.bmad-infrastructure-devops` | Zastaralý — nový DevOps agent brzy | +| `.bmad-creative-writing` | Neadaptován — nový v6 modul brzy | + +## Klíčové změny + +| Koncept | v4 | v6 | +| --------------- | ------------------------------------ | -------------------------------------- | +| **Core** | `_bmad-core` byl vlastně BMad Method | `_bmad/core/` je univerzální framework | +| **Method** | `_bmad-method` | `_bmad/bmm/` | +| **Konfigurace** | Přímá editace souborů | `config.yaml` pro každý modul | +| **Dokumenty** | Vyžadované nastavení shardů | Plně flexibilní, auto-skenování | diff --git a/docs/cs/index.md b/docs/cs/index.md new file mode 100644 index 000000000..ade10d6a4 --- /dev/null +++ b/docs/cs/index.md @@ -0,0 +1,60 @@ +--- +title: Vítejte v metodě BMad +description: Framework pro vývoj řízený umělou inteligencí se specializovanými agenty, řízenými pracovními postupy a inteligentním plánováním +--- + +Metoda BMad (**B**uild **M**ore **A**rchitect **D**reams) je framework pro vývoj řízený umělou inteligencí v rámci ekosystému BMad Method, který vám pomáhá vytvářet software celým procesem od nápadu a plánování až po agentní implementaci. Poskytuje specializované AI agenty, řízené pracovní postupy a inteligentní plánování, které se přizpůsobí složitosti vašeho projektu, ať už opravujete chybu nebo budujete podnikovou platformu. + +Pokud jste zvyklí pracovat s AI asistenty pro kódování jako Claude, Cursor nebo GitHub Copilot, jste připraveni začít. + +:::note[🚀 V6 je tady a teprve začínáme!] +Architektura Skills, BMad Builder v1, automatizace Dev Loop a mnoho dalšího ve vývoji. **[Podívejte se na Plán rozvoje →](./roadmap)** +::: + +## Jste tu nově? Začněte tutoriálem + +Nejrychlejší způsob, jak pochopit BMad, je vyzkoušet si ho. + +- **[Začínáme s BMad](./tutorials/getting-started.md)** — Instalace a pochopení fungování BMad +- **[Mapa pracovních postupů](./reference/workflow-map.md)** — Vizuální přehled fází BMM, pracovních postupů a správy kontextu + +:::tip[Chcete se rovnou ponořit?] +Nainstalujte BMad a použijte skill `bmad-help` — provede vás vším na základě vašeho projektu a nainstalovaných modulů. +::: + +## Jak používat tuto dokumentaci + +Tato dokumentace je organizována do čtyř sekcí podle toho, co chcete dělat: + +| Sekce | Účel | +| -------------------- | ------------------------------------------------------------------------------------------------------------------ | +| **Tutoriály** | Orientované na učení. Průvodci krok za krokem, kteří vás provedou tvorbou něčeho. Začněte zde, pokud jste noví. | +| **Praktické návody** | Orientované na úkoly. Praktičtí průvodci pro řešení konkrétních problémů. „Jak přizpůsobím agenta?“ najdete zde. | +| **Vysvětlení** | Orientované na pochopení. Hluboké ponory do konceptů a architektury. Čtěte, když chcete vědět *proč*. | +| **Reference** | Orientované na informace. Technické specifikace agentů, pracovních postupů a konfigurace. | + +## Rozšíření a přizpůsobení + +Chcete rozšířit BMad o vlastní agenty, pracovní postupy nebo moduly? **[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** poskytuje framework a nástroje pro vytváření vlastních rozšíření, ať už přidáváte nové schopnosti do BMad nebo budujete zcela nové moduly od základů. + +## Co budete potřebovat + +BMad funguje s jakýmkoli AI asistentem pro kódování, který podporuje vlastní systémové prompty nebo kontextové soubory projektu. Oblíbené možnosti zahrnují: + +- **[Claude Code](https://code.claude.com)** — CLI nástroj od Anthropic (doporučený) +- **[Cursor](https://cursor.sh)** — AI-first editor kódu +- **[Codex CLI](https://github.com/openai/codex)** — Terminálový kódovací agent od OpenAI + +Měli byste být obeznámeni se základními koncepty vývoje softwaru jako správa verzí, struktura projektu a agilní pracovní postupy. Žádná předchozí zkušenost se systémy agentů ve stylu BMad není vyžadována — právě od toho je tato dokumentace. + +## Připojte se ke komunitě + +Získejte pomoc, sdílejte co budujete, nebo přispějte do BMad: + +- **[Discord](https://discord.gg/gk8jAdXWmj)** — Chatujte s ostatními uživateli BMad, pokládejte otázky, sdílejte nápady +- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Zdrojový kód, issues a příspěvky +- **[YouTube](https://www.youtube.com/@BMadCode)** — Video tutoriály a návody + +## Další krok + +Jste připraveni se ponořit? **[Začněte s BMad](./tutorials/getting-started.md)** a vytvořte svůj první projekt. diff --git a/docs/cs/reference/agents.md b/docs/cs/reference/agents.md new file mode 100644 index 000000000..6b2d81c87 --- /dev/null +++ b/docs/cs/reference/agents.md @@ -0,0 +1,55 @@ +--- +title: Agenti +description: Výchozí BMM agenti s jejich skill ID, spouštěči nabídky a primárními workflow +sidebar: + order: 2 +--- + +## Výchozí agenti + +Tato stránka uvádí výchozí BMM (Agile suite) agenty, kteří se instalují s BMad Method, společně s jejich skill ID, spouštěči nabídky a primárními workflow. Každý agent se vyvolává jako skill. + +## Poznámky + +- Každý agent je dostupný jako skill, generovaný instalátorem. Skill ID (např. `bmad-dev`) se používá k vyvolání agenta. +- Spouštěče jsou krátké kódy nabídky (např. `CP`) a fuzzy shody zobrazené v nabídce každého agenta. +- Generování QA testů zajišťuje workflow skill `bmad-qa-generate-e2e-tests`, dostupný přes Developer agenta. Plný Test Architect (TEA) žije ve vlastním modulu. + +| Agent | Skill ID | Spouštěče | Primární workflow | +| --------------------------- | -------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| Analyst (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorm, průzkum trhu, doménový výzkum, technický výzkum, tvorba briefu, PRFAQ výzva, dokumentace projektu | +| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Tvorba/validace/editace PRD, tvorba epiců a stories, připravenost implementace, korekce kurzu | +| Architect (Winston) | `bmad-architect` | `CA`, `IR` | Tvorba architektury, připravenost implementace | +| Developer (Amelia) | `bmad-agent-dev` | `DS`, `QD`, `QA`, `CR`, `SP`, `CS`, `ER` | Dev story, Quick Dev, generování QA testů, revize kódu, plánování sprintu, tvorba story, retrospektiva epicu | +| UX Designer (Sally) | `bmad-ux-designer` | `CU` | Tvorba UX designu | +| Technical Writer (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Dokumentace projektu, psaní dokumentu, aktualizace standardů, generování Mermaid, validace dok., vysvětlení konceptu | + +## Typy spouštěčů + +Spouštěče nabídky agentů používají dva různé typy vyvolání. Znalost typu spouštěče vám pomůže poskytnout správný vstup. + +### Workflow spouštěče (bez argumentů) + +Většina spouštěčů načítá strukturovaný soubor workflow. Zadejte kód spouštěče a agent zahájí workflow a vyzve vás k zadání vstupu v každém kroku. + +Příklady: `CP` (tvorba PRD), `DS` (Dev story), `CA` (tvorba architektury), `QD` (Quick Dev) + +### Konverzační spouštěče (vyžadují argumenty) + +Některé spouštěče zahajují volnou konverzaci místo strukturovaného workflow. Tyto očekávají, že popíšete, co potřebujete, společně s kódem spouštěče. + +| Agent | Spouštěč | Co poskytnout | +| --- | --- | --- | +| Technical Writer (Paige) | `WD` | Popis dokumentu k napsání | +| Technical Writer (Paige) | `US` | Preference nebo konvence k přidání do standardů | +| Technical Writer (Paige) | `MG` | Popis diagramu a typ (sekvence, vývojový diagram atd.) | +| Technical Writer (Paige) | `VD` | Dokument k validaci a oblasti zaměření | +| Technical Writer (Paige) | `EC` | Název konceptu k vysvětlení | + +**Příklad:** + +```text +WD Write a deployment guide for our Docker setup +MG Create a sequence diagram showing the auth flow +EC Explain how the module system works +``` diff --git a/docs/cs/reference/commands.md b/docs/cs/reference/commands.md new file mode 100644 index 000000000..e3bb52a2b --- /dev/null +++ b/docs/cs/reference/commands.md @@ -0,0 +1,135 @@ +--- +title: Skills +description: Reference BMad skills — co to je, jak fungují a kde je najít. +sidebar: + order: 3 +--- + +Skills jsou předpřipravené prompty, které načítají agenty, spouštějí workflow nebo provádějí úkoly ve vašem IDE. Instalátor BMad je generuje z vašich nainstalovaných modulů při instalaci. Pokud později přidáte, odeberete nebo změníte moduly, přeinstalujte pro synchronizaci skills (viz [Řešení problémů](#řešení-problémů)). + +## Skills vs. spouštěče nabídky agentů + +BMad nabízí dva způsoby zahájení práce a slouží k různým účelům. + +| Mechanismus | Jak se vyvolává | Co se stane | +| --- | --- | --- | +| **Skill** | Zadejte název skillu (např. `bmad-help`) ve vašem IDE | Přímo načte agenta, spustí workflow nebo provede úkol | +| **Spouštěč nabídky agenta** | Nejprve načtěte agenta, pak zadejte krátký kód (např. `DS`) | Agent interpretuje kód a spustí odpovídající workflow, přičemž zůstává v charakteru | + +Spouštěče nabídky agentů vyžadují aktivní relaci agenta. Používejte skills, když víte, který workflow chcete. Používejte spouštěče, když již pracujete s agentem a chcete přepnout úkol bez opuštění konverzace. + +## Jak se skills generují + +Když spustíte `npx bmad-method install`, instalátor čte manifesty každého vybraného modulu a zapíše jeden skill na agenta, workflow, úkol a nástroj. Každý skill je adresář obsahující soubor `SKILL.md`, který instruuje AI k načtení odpovídajícího zdrojového souboru a následování jeho instrukcí. + +Instalátor používá šablony pro každý typ skillu: + +| Typ skillu | Co generovaný soubor dělá | +| --- | --- | +| **Spouštěč agenta** | Načte soubor persony agenta, aktivuje jeho nabídku a zůstává v charakteru | +| **Workflow skill** | Načte konfiguraci workflow a následuje jeho kroky | +| **Task skill** | Načte samostatný soubor úkolu a následuje jeho instrukce | +| **Tool skill** | Načte samostatný soubor nástroje a následuje jeho instrukce | + +:::note[Opětovné spuštění instalátoru] +Pokud přidáte nebo odeberete moduly, spusťte instalátor znovu. Přegeneruje všechny soubory skills tak, aby odpovídaly vašemu aktuálnímu výběru modulů. +::: + +## Kde žijí soubory skills + +Instalátor zapisuje soubory skills do adresáře specifického pro IDE uvnitř vašeho projektu. Přesná cesta závisí na IDE, které jste vybrali během instalace. + +| IDE / CLI | Adresář skills | +| --- | --- | +| Claude Code | `.claude/skills/` | +| Cursor | `.cursor/skills/` | +| Windsurf | `.windsurf/skills/` | +| Další IDE | Viz výstup instalátoru pro cílovou cestu | + +Každý skill je adresář obsahující soubor `SKILL.md`. Například instalace Claude Code vypadá takto: + +```text +.claude/skills/ +├── bmad-help/ +│ └── SKILL.md +├── bmad-create-prd/ +│ └── SKILL.md +├── bmad-agent-dev/ +│ └── SKILL.md +└── ... +``` + +Název adresáře určuje název skillu ve vašem IDE. Například adresář `bmad-agent-dev/` registruje skill `bmad-agent-dev`. + +## Jak objevit vaše skills + +Zadejte název skillu ve vašem IDE pro jeho vyvolání. Některé platformy vyžadují povolení skills v nastavení, než se zobrazí. + +Spusťte `bmad-help` pro kontextové poradenství k dalšímu kroku. + +:::tip[Rychlé objevování] +Generované adresáře skills ve vašem projektu jsou kanonický seznam. Otevřete je v prohlížeči souborů, abyste viděli každý skill s jeho popisem. +::: + +## Kategorie skills + +### Agentní skills + +Agentní skills načítají specializovanou AI personu s definovanou rolí, komunikačním stylem a nabídkou workflow. Po načtení agent zůstává v charakteru a reaguje na spouštěče nabídky. + +| Příklad skillu | Agent | Role | +| --- | --- | --- | +| `bmad-agent-dev` | Amelia (Developer) | Implementuje stories s přísným dodržováním specifikací | +| `bmad-pm` | John (Product Manager) | Vytváří a validuje PRD | +| `bmad-architect` | Winston (Architect) | Navrhuje systémovou architekturu | + +Viz [Agenti](./agents.md) pro úplný seznam výchozích agentů a jejich spouštěčů. + +### Workflow skills + +Workflow skills spouštějí strukturovaný, vícekrokový proces bez předchozího načtení persony agenta. Načtou konfiguraci workflow a následují jeho kroky. + +| Příklad skillu | Účel | +| --- | --- | +| `bmad-product-brief` | Vytvoření product briefu — řízené discovery, když je váš koncept jasný | +| `bmad-prfaq` | [Working Backwards PRFAQ](../explanation/analysis-phase.md#prfaq-working-backwards) výzva pro zátěžový test vašeho produktového konceptu | +| `bmad-create-prd` | Vytvoření dokumentu požadavků (PRD) | +| `bmad-create-architecture` | Návrh systémové architektury | +| `bmad-create-epics-and-stories` | Vytvoření epiců a stories | +| `bmad-dev-story` | Implementace story | +| `bmad-code-review` | Spuštění revize kódu | +| `bmad-quick-dev` | Sjednocený quick flow — vyjasnění záměru, plán, implementace, revize, prezentace | + +Viz [Mapa pracovních postupů](./workflow-map.md) pro kompletní referenci workflow organizovanou podle fází. + +### Task a tool skills + +Tasks a tools jsou samostatné operace, které nevyžadují kontext agenta nebo workflow. + +**BMad-Help: Váš inteligentní průvodce** + +`bmad-help` je vaše primární rozhraní pro objevení, co dělat dál. Zkoumá váš projekt, rozumí dotazům v přirozeném jazyce a doporučuje další povinný nebo volitelný krok na základě nainstalovaných modulů. + +:::note[Příklad] +``` +bmad-help +bmad-help I have a SaaS idea and know all the features. Where do I start? +bmad-help What are my options for UX design? +``` +::: + +**Další základní tasks a tools** + +Základní modul zahrnuje 11 vestavěných nástrojů — revize, komprese, brainstorming, správa dokumentů a další. Viz [Základní nástroje](./core-tools.md) pro kompletní referenci. + +## Konvence pojmenování + +Všechny skills používají prefix `bmad-` následovaný popisným názvem (např. `bmad-dev`, `bmad-create-prd`, `bmad-help`). Viz [Moduly](./modules.md) pro dostupné moduly. + +## Řešení problémů + +**Skills se nezobrazují po instalaci.** Některé platformy vyžadují explicitní povolení skills v nastavení. Zkontrolujte dokumentaci vašeho IDE nebo se zeptejte AI asistenta, jak skills povolit. Může být také nutné restartovat IDE nebo znovu načíst okno. + +**Očekávané skills chybí.** Instalátor generuje skills pouze pro moduly, které jste vybrali. Spusťte `npx bmad-method install` znovu a ověřte výběr modulů. Zkontrolujte, že soubory skills existují v očekávaném adresáři. + +**Skills z odebraného modulu se stále zobrazují.** Instalátor automaticky nemaže staré soubory skills. Odstraňte zastaralé adresáře z adresáře skills vašeho IDE, nebo smažte celý adresář skills a přeinstalujte pro čistou sadu. diff --git a/docs/cs/reference/core-tools.md b/docs/cs/reference/core-tools.md new file mode 100644 index 000000000..1fca20336 --- /dev/null +++ b/docs/cs/reference/core-tools.md @@ -0,0 +1,292 @@ +--- +title: Základní nástroje +description: Reference všech vestavěných úkolů a workflow dostupných v každé instalaci BMad bez dalších modulů. +sidebar: + order: 2 +--- + +Každá instalace BMad zahrnuje sadu základních skills, které lze použít v kombinaci s čímkoli — samostatné úkoly a workflow, které fungují napříč všemi projekty, všemi moduly a všemi fázemi. Ty jsou vždy dostupné bez ohledu na to, které volitelné moduly nainstalujete. + +:::tip[Rychlá cesta] +Spusťte jakýkoli základní nástroj zadáním jeho názvu skillu (např. `bmad-help`) ve vašem IDE. Nevyžaduje relaci agenta. +::: + +## Přehled + +| Nástroj | Typ | Účel | +| --- | --- | --- | +| [`bmad-help`](#bmad-help) | Task | Kontextové poradenství, co dělat dál | +| [`bmad-brainstorming`](#bmad-brainstorming) | Workflow | Facilitace interaktivních brainstormingových sezení | +| [`bmad-party-mode`](#bmad-party-mode) | Workflow | Orchestrace skupinových diskuzí více agentů | +| [`bmad-distillator`](#bmad-distillator) | Task | Bezeztrátová LLM-optimalizovaná komprese dokumentů | +| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | Task | Iterativní zdokonalování LLM výstupu | +| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | Task | Cynická revize hledající chybějící a chybné | +| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | Task | Vyčerpávající analýza větvících cest pro neošetřené hraniční případy | +| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | Task | Klinická jazyková korektura pro komunikační srozumitelnost | +| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Task | Strukturální editace — škrty, sloučení a reorganizace | +| [`bmad-shard-doc`](#bmad-shard-doc) | Task | Rozdělení velkých markdown souborů do organizovaných sekcí | +| [`bmad-index-docs`](#bmad-index-docs) | Task | Generování nebo aktualizace indexu dokumentů ve složce | + +## bmad-help + +**Váš inteligentní průvodce tím, co přijde dál.** — Zkoumá stav vašeho projektu, detekuje, co bylo uděláno, a doporučuje další povinný nebo volitelný krok. + +**Použijte když:** + +- Dokončili jste workflow a chcete vědět, co dál +- Jste noví v BMad a potřebujete orientaci +- Jste uvízlí a chcete kontextovou radu +- Nainstalovali jste nové moduly a chcete vidět, co je dostupné + +**Jak to funguje:** + +1. Skenuje projekt pro existující artefakty (PRD, architektura, stories atd.) +2. Detekuje nainstalované moduly a dostupné workflow +3. Doporučuje další kroky v pořadí priority — nejprve povinné, pak volitelné +4. Prezentuje každé doporučení s příkazem skillu a stručným popisem + +**Vstup:** Volitelný dotaz v přirozeném jazyce (např. `bmad-help I have a SaaS idea, where do I start?`) + +**Výstup:** Prioritizovaný seznam doporučených dalších kroků s příkazy skills + +## bmad-brainstorming + +**Generování různorodých nápadů prostřednictvím interaktivních kreativních technik.** — Facilitované brainstormingové sezení, které načítá osvědčené ideační metody z knihovny technik a vede vás k 100+ nápadům před organizací. + +**Použijte když:** + +- Začínáte nový projekt a potřebujete prozkoumat problémový prostor +- Jste uvízlí s generováním nápadů a potřebujete strukturovanou kreativitu +- Chcete použít osvědčené ideační frameworky (SCAMPER, reverzní brainstorming atd.) + +**Jak to funguje:** + +1. Nastaví brainstormingové sezení s vaším tématem +2. Načte kreativní techniky z knihovny metod +3. Provede vás technikou za technikou, generuje nápady +4. Aplikuje anti-bias protokol — mění kreativní doménu každých 10 nápadů +5. Produkuje append-only dokument sezení se všemi nápady organizovanými podle techniky + +**Vstup:** Téma brainstormingu nebo formulace problému, volitelný kontextový soubor + +**Výstup:** `brainstorming-session-{date}.md` se všemi generovanými nápady + +:::note[Cíl množství] +Kouzlo se děje v nápadech 50–100. Workflow povzbuzuje generování 100+ nápadů před organizací. +::: + +## bmad-party-mode + +**Orchestrace skupinových diskuzí více agentů.** — Načte všechny nainstalované BMad agenty a facilituje přirozenou konverzaci, kde každý agent přispívá svou unikátní odborností a osobností. + +**Použijte když:** + +- Potřebujete více expertních perspektiv na rozhodnutí +- Chcete, aby agenti zpochybňovali předpoklady ostatních +- Zkoumáte složité téma překračující více domén + +**Jak to funguje:** + +1. Načte manifest agentů se všemi nainstalovanými osobnostmi +2. Analyzuje vaše téma a vybere 2–3 nejrelevantnější agenty +3. Agenti se střídají v přispívání, s přirozenou kříženou diskuzí a nesouhlasy +4. Rotuje účast agentů pro zajištění různorodých perspektiv +5. Ukončete pomocí `goodbye`, `end party` nebo `quit` + +**Vstup:** Diskuzní téma nebo otázka, s volitelnou specifikací person + +**Výstup:** Real-time multi-agentní konverzace s udržovanými osobnostmi agentů + +## bmad-distillator + +**Bezeztrátová LLM-optimalizovaná komprese zdrojových dokumentů.** — Produkuje husté, tokenově efektivní destiláty, které zachovávají všechny informace pro následné LLM zpracování. Ověřitelné prostřednictvím round-trip rekonstrukce. + +**Použijte když:** + +- Dokument je příliš velký pro kontextové okno LLM +- Potřebujete tokenově efektivní verze výzkumů, specifikací nebo plánovacích artefaktů +- Chcete ověřit, že během komprese nebyly ztraceny žádné informace + +**Jak to funguje:** + +1. **Analýza** — Čte zdrojové dokumenty, identifikuje hustotu informací a strukturu +2. **Komprese** — Převádí prózu na hustý odrážkový formát, odstraňuje dekorativní formátování +3. **Ověření** — Kontroluje úplnost pro zajištění zachování všech informací +4. **Validace** (volitelné) — Round-trip rekonstrukční test dokazuje bezeztrátovou kompresi + +**Vstup:** + +- `source_documents` (povinné) — Cesty k souborům, složkám nebo glob vzory +- `downstream_consumer` (volitelné) — Co to konzumuje (např. „tvorba PRD“) +- `token_budget` (volitelné) — Přibližná cílová velikost +- `--validate` (příznak) — Spuštění round-trip rekonstrukčního testu + +**Výstup:** Destilátové markdown soubory s reportem kompresního poměru (např. „3.2:1“) + +## bmad-advanced-elicitation + +**Iterativní zdokonalování LLM výstupu metodami elicitace.** — Vybírá z knihovny elicitačních technik pro systematické zlepšování obsahu více průchody. + +**Použijte když:** + +- LLM výstup působí povrchně nebo genericky +- Chcete prozkoumat téma z více analytických úhlů +- Zdokonalujete kritický dokument a chcete hlubší myšlení + +**Jak to funguje:** + +1. Načte registr metod s 5+ elicitačními technikami +2. Vybere 5 nejlépe odpovídajících metod podle typu a složitosti obsahu +3. Prezentuje interaktivní nabídku — vyberte metodu, zamíchejte nebo zobrazte vše +4. Aplikuje vybranou metodu k vylepšení obsahu +5. Znovu prezentuje možnosti pro iterativní zlepšení, dokud nevyberete „Pokračovat“ + +**Vstup:** Sekce obsahu k vylepšení + +**Výstup:** Vylepšená verze obsahu s aplikovanými zlepšeními + +## bmad-review-adversarial-general + +**Cynická revize, která předpokládá existenci problémů a hledá je.** — Zaujme perspektivu skeptického, otráveného recenzenta s nulovou tolerancí pro nedbalou práci. Hledá, co chybí, ne jen co je špatně. + +**Použijte když:** + +- Potřebujete zajištění kvality před finalizací výstupu +- Chcete zátěžově otestovat specifikaci, story nebo dokument +- Chcete najít mezery v pokrytí, které optimistické revize přehlédnou + +**Jak to funguje:** + +1. Čte obsah s cynickou, kritickou perspektivou +2. Identifikuje problémy v úplnosti, správnosti a kvalitě +3. Specificky hledá, co chybí — ne jen co je přítomné a špatné +4. Musí najít minimálně 10 problémů nebo analyzuje hlouběji + +**Vstup:** + +- `content` (povinné) — Diff, specifikace, story, dokument nebo jakýkoli artefakt +- `also_consider` (volitelné) — Další oblasti k zvážení + +**Výstup:** Markdown seznam 10+ nálezů s popisy + +## bmad-review-edge-case-hunter + +**Procházení každé větvící cesty a hraničních podmínek, hlášení pouze neošetřených případů.** — Čistě metodologický přístup trasování cest, který mechanicky odvozuje třídy hraničních případů. + +**Použijte když:** + +- Chcete vyčerpávající pokrytí hraničních případů pro kód nebo logiku +- Potřebujete doplněk k adversariální revizi (jiná metodologie, jiné nálezy) +- Revidujete diff nebo funkci pro hraniční podmínky + +**Jak to funguje:** + +1. Enumeruje všechny větvící cesty v obsahu +2. Mechanicky odvozuje třídy případů: chybějící else/default, nestřežené vstupy, off-by-one, přetečení aritmetiky, implicitní typová koerce, race conditions, mezery v timeoutech +3. Testuje každou cestu proti existujícím ochranám +4. Hlásí pouze neošetřené cesty — tiše zahazuje ošetřené + +**Vstup:** + +- `content` (povinné) — Diff, celý soubor nebo funkce +- `also_consider` (volitelné) — Další oblasti k zvážení + +**Výstup:** JSON pole nálezů, každý s `location`, `trigger_condition`, `guard_snippet` a `potential_consequence` + +:::note[Komplementární revize] +Spusťte obě `bmad-review-adversarial-general` a `bmad-review-edge-case-hunter` společně pro ortogonální pokrytí. Adversariální revize zachytí problémy kvality a úplnosti; hunter hraničních případů zachytí neošetřené cesty. +::: + +## bmad-editorial-review-prose + +**Klinická jazyková korektura zaměřená na srozumitelnost komunikace.** — Reviduje text pro problémy bránící porozumění. Aplikuje baseline Microsoft Writing Style Guide. Zachovává autorský hlas. + +**Použijte když:** + +- Napsali jste dokument a chcete vylepšit psaní +- Potřebujete zajistit srozumitelnost pro konkrétní publikum +- Chcete komunikační opravy bez změn stylistických preferencí + +**Jak to funguje:** + +1. Čte obsah, přeskakuje bloky kódu a frontmatter +2. Identifikuje komunikační problémy (ne stylistické preference) +3. Deduplikuje stejné problémy napříč více lokacemi +4. Produkuje třísloupcovou tabulku oprav + +**Vstup:** + +- `content` (povinné) — Markdown, prostý text nebo XML +- `style_guide` (volitelné) — Projektově specifický průvodce stylem +- `reader_type` (volitelné) — `humans` (výchozí) pro srozumitelnost/plynulost, nebo `llm` pro přesnost/konzistenci + +**Výstup:** Třísloupcová markdown tabulka: Původní text | Revidovaný text | Změny + +## bmad-editorial-review-structure + +**Strukturální editace — navrhuje škrty, sloučení, přesuny a zhuštění.** — Reviduje organizaci dokumentu a navrhuje substantivní změny pro zlepšení srozumitelnosti a toku před jazykovou korekcí. + +**Použijte když:** + +- Dokument byl vytvořen z více subprocesů a potřebuje strukturální koherenci +- Chcete zkrátit dokument při zachování porozumění +- Potřebujete identifikovat porušení rozsahu nebo pohřbené kritické informace + +**Jak to funguje:** + +1. Analyzuje dokument proti 5 strukturním modelům (Tutorial, Reference, Explanation, Prompt, Strategic) +2. Identifikuje redundance, porušení rozsahu a pohřbené informace +3. Produkuje prioritizovaná doporučení: CUT, MERGE, MOVE, CONDENSE, QUESTION, PRESERVE +4. Odhaduje celkovou redukci ve slovech a procentech + +**Vstup:** + +- `content` (povinné) — Dokument k revizi +- `purpose` (volitelné) — Zamýšlený účel (např. „quickstart tutoriál“) +- `target_audience` (volitelné) — Kdo to čte +- `reader_type` (volitelné) — `humans` nebo `llm` +- `length_target` (volitelné) — Cílová redukce (např. „o 30 % kratší“) + +**Výstup:** Shrnutí dokumentu, prioritizovaný seznam doporučení a odhadovaná redukce + +## bmad-shard-doc + +**Rozdělení velkých markdown souborů do organizovaných souborů sekcí.** — Používá nadpisy úrovně 2 jako body dělení k vytvoření složky samostatných souborů sekcí s indexem. + +**Použijte když:** + +- Markdown dokument narostl na nezvládnutelnou velikost (500+ řádků) +- Chcete rozložit monolitický dokument na navigovatelné sekce +- Potřebujete samostatné soubory pro paralelní editaci nebo správu LLM kontextu + +**Jak to funguje:** + +1. Validuje, že zdrojový soubor existuje a je markdown +2. Dělí na nadpisech úrovně 2 (`##`) do číslovaných souborů sekcí +3. Vytváří `index.md` s manifestem sekcí a odkazy +4. Vyzve vás ke smazání, archivaci nebo zachování originálu + +**Vstup:** Cesta ke zdrojovému markdown souboru, volitelná cílová složka + +**Výstup:** Složka s `index.md` a `01-{sekce}.md`, `02-{sekce}.md` atd. + +## bmad-index-docs + +**Generování nebo aktualizace indexu všech dokumentů ve složce.** — Skenuje adresář, čte každý soubor pro pochopení jeho účelu a produkuje organizovaný `index.md` s odkazy a popisy. + +**Použijte když:** + +- Potřebujete lehký index pro rychlé LLM skenování dostupných dokumentů +- Složka dokumentace narostla a potřebuje organizovaný obsah +- Chcete automaticky generovaný přehled, který zůstává aktuální + +**Jak to funguje:** + +1. Skenuje cílový adresář pro všechny neskryté soubory +2. Čte každý soubor pro pochopení jeho skutečného účelu +3. Seskupuje soubory podle typu, účelu nebo podadresáře +4. Generuje stručné popisy (3–10 slov každý) + +**Vstup:** Cesta k cílové složce + +**Výstup:** `index.md` s organizovanými výpisy souborů, relativními odkazy a stručnými popisy diff --git a/docs/cs/reference/modules.md b/docs/cs/reference/modules.md new file mode 100644 index 000000000..792d28246 --- /dev/null +++ b/docs/cs/reference/modules.md @@ -0,0 +1,76 @@ +--- +title: Oficiální moduly +description: Doplňkové moduly pro tvorbu vlastních agentů, kreativní inteligenci, vývoj her a testování +sidebar: + order: 4 +--- + +BMad se rozšiřuje prostřednictvím oficiálních modulů, které vyberete během instalace. Tyto doplňkové moduly poskytují specializované agenty, workflow a úkoly pro specifické domény nad rámec vestavěného jádra a BMM (Agile suite). + +:::tip[Instalace modulů] +Spusťte `npx bmad-method install` a vyberte požadované moduly. Instalátor se postará o stažení, konfiguraci a integraci s IDE automaticky. +::: + +## BMad Builder + +Vytvářejte vlastní agenty, workflow a doménově specifické moduly s řízenou asistencí. BMad Builder je meta-modul pro rozšiřování samotného frameworku. + +- **Kód:** `bmb` +- **npm:** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder) +- **GitHub:** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) + +**Poskytuje:** + +- Agent Builder — tvorba specializovaných AI agentů s vlastní odborností a přístupem k nástrojům +- Workflow Builder — návrh strukturovaných procesů s kroky a rozhodovacími body +- Module Builder — balíčkování agentů a workflow do sdílitelných, publikovatelných modulů +- Interaktivní nastavení s YAML konfigurací a podporou npm publikování + +## Creative Intelligence Suite + +AI nástroje pro strukturovanou kreativitu, ideaci a inovace v rané fázi vývoje. Suite poskytuje více agentů, kteří facilitují brainstorming, design thinking a řešení problémů pomocí osvědčených frameworků. + +- **Kód:** `cis` +- **npm:** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite) +- **GitHub:** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) + +**Poskytuje:** + +- Agenty Innovation Strategist, Design Thinking Coach a Brainstorming Coach +- Problem Solver a Creative Problem Solver pro systematické a laterální myšlení +- Storyteller a Presentation Master pro narativy a prezentace +- Ideační frameworky včetně SCAMPER, reverzního brainstormingu a přeformulování problémů + +## Game Dev Studio + +Strukturované workflow pro vývoj her adaptované pro Unity, Unreal, Godot a vlastní enginy. Podporuje rychlé prototypování přes Quick Flow a plnoscálovou produkci s epicky řízenými sprinty. + +- **Kód:** `gds` +- **npm:** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio) +- **GitHub:** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) + +**Poskytuje:** + +- Workflow pro generování Game Design Document (GDD) +- Režim Quick Dev pro rychlé prototypování +- Podporu narativního designu pro postavy, dialogy a budování světa +- Pokrytí 21+ typů her s architektonickým vedením specifickým pro engine + +## Test Architect (TEA) + +Podniková testovací strategie, vedení automatizace a rozhodování o release gate prostřednictvím expertního agenta a devíti strukturovaných workflow. TEA jde daleko za vestavěného QA agenta s prioritizací založenou na riziku a trasovatelností požadavků. + +- **Kód:** `tea` +- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise) +- **GitHub:** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise) + +**Poskytuje:** + +- Agenta Murat (Master Test Architect a Quality Advisor) +- Workflow pro testovací design, ATDD, automatizaci, revizi testů a trasovatelnost +- Hodnocení NFR, nastavení CI a scaffolding frameworku +- Prioritizaci P0-P3 s volitelnými integracemi Playwright Utils a MCP + +## Komunitní moduly + +Komunitní moduly a marketplace modulů přicházejí. Sledujte [organizaci BMad na GitHubu](https://github.com/bmad-code-org) pro aktualizace. diff --git a/docs/cs/reference/testing.md b/docs/cs/reference/testing.md new file mode 100644 index 000000000..e5c061e06 --- /dev/null +++ b/docs/cs/reference/testing.md @@ -0,0 +1,106 @@ +--- +title: Možnosti testování +description: Srovnání vestavěného QA agenta (Quinn) s modulem Test Architect (TEA) pro automatizaci testů. +sidebar: + order: 5 +--- + +BMad poskytuje dvě testovací cesty: vestavěného QA agenta pro rychlé generování testů a instalovatelný modul Test Architect pro podnikovou testovací strategii. + +## Který byste měli použít? + +| Faktor | Quinn (vestavěný QA) | Modul TEA | +| --- | --- | --- | +| **Nejlepší pro** | Malé až střední projekty, rychlé pokrytí | Velké projekty, regulované nebo složité domény | +| **Nastavení** | Nic k instalaci — součástí BMM | Instalace zvlášť přes `npx bmad-method install` | +| **Přístup** | Generujte testy rychle, iterujte později | Nejprve plánujte, pak generujte s trasovatelností | +| **Typy testů** | API a E2E testy | API, E2E, ATDD, NFR a další | +| **Strategie** | Happy path + kritické hraniční případy | Prioritizace založená na riziku (P0–P3) | +| **Počet workflow** | 1 (Automate) | 9 (design, ATDD, automate, review, trace a další) | + +:::tip[Začněte s Quinnem] +Většina projektů by měla začít s Quinnem. Pokud později budete potřebovat testovací strategii, quality gates nebo trasovatelnost požadavků, nainstalujte TEA vedle něj. +::: + +## Vestavěný QA agent (Quinn) + +Quinn je vestavěný QA agent v modulu BMM (Agile suite). Rychle generuje funkční testy pomocí existujícího testovacího frameworku vašeho projektu — bez konfigurace nebo další instalace. + +**Spouštěč:** `QA` nebo `bmad-qa-generate-e2e-tests` + +### Co Quinn dělá + +Quinn spouští jeden workflow (Automate), který projde pěti kroky: + +1. **Detekce testovacího frameworku** — skenuje `package.json` a existující testovací soubory pro váš framework (Jest, Vitest, Playwright, Cypress nebo jakýkoli standardní runner). Pokud neexistuje, analyzuje stack projektu a navrhne jeden. +2. **Identifikace funkcí** — zeptá se, co testovat, nebo automaticky objeví funkce v kódové bázi. +3. **Generování API testů** — pokrývá stavové kódy, strukturu odpovědí, happy path a 1–2 chybové případy. +4. **Generování E2E testů** — pokrývá uživatelské workflow se sémantickými lokátory a asercemi viditelných výsledků. +5. **Spuštění a ověření** — provede generované testy a okamžitě opraví selhání. + +Quinn produkuje shrnutí testů uložené do složky implementačních artefaktů vašeho projektu. + +### Vzory testů + +Generované testy sledují filozofii „jednoduché a udržovatelné“: + +- **Pouze standardní API frameworku** — žádné externí utility nebo vlastní abstrakce +- **Sémantické lokátory** pro UI testy (role, popisky, text místo CSS selektorů) +- **Nezávislé testy** bez závislostí na pořadí +- **Žádné hardcoded waity nebo sleep** +- **Jasné popisy**, které se čtou jako dokumentace funkcí + +:::note[Rozsah] +Quinn generuje pouze testy. Pro revizi kódu a validaci stories použijte workflow Code Review (`CR`). +::: + +### Kdy použít Quinna + +- Rychlé pokrytí testy pro novou nebo existující funkci +- Automatizace testů přátelská k začátečníkům bez pokročilého nastavení +- Standardní vzory testů, které může číst a udržovat jakýkoli vývojář +- Malé až střední projekty, kde komplexní testovací strategie není potřeba + +## Modul Test Architect (TEA) + +TEA je samostatný modul, který poskytuje expertního agenta (Murat) a devět strukturovaných workflow pro podnikové testování. Jde za rámec generování testů do testovací strategie, plánování založeného na riziku, quality gates a trasovatelnosti požadavků. + +- **Dokumentace:** [Dokumentace modulu TEA](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/) +- **Instalace:** `npx bmad-method install` a výběr modulu TEA +- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise) + +### Co TEA poskytuje + +| Workflow | Účel | +| --- | --- | +| Test Design | Vytvoření komplexní testovací strategie vázané na požadavky | +| ATDD | Acceptance-test-driven development s kritérii stakeholderů | +| Automate | Generování testů s pokročilými vzory a utilitami | +| Test Review | Validace kvality a pokrytí testů proti strategii | +| Traceability | Mapování testů zpět na požadavky pro audit a compliance | +| NFR Assessment | Hodnocení nefunkčních požadavků (výkon, bezpečnost) | +| CI Setup | Konfigurace provádění testů v CI pipelines | +| Framework Scaffolding | Nastavení testovací infrastruktury a struktury projektu | +| Release Gate | Datově založená rozhodnutí go/no-go pro release | + +TEA také podporuje prioritizaci P0–P3 založenou na riziku a volitelné integrace s Playwright Utils a MCP nástroji. + +### Kdy použít TEA + +- Projekty vyžadující trasovatelnost požadavků nebo compliance dokumentaci +- Týmy potřebující prioritizaci testů založenou na riziku napříč mnoha funkcemi +- Podniková prostředí s formálními quality gates před releasem +- Složité domény, kde musí být testovací strategie naplánována před psaním testů +- Projekty, které přerostly jednoduchý workflow Quinna + +## Jak testování zapadá do workflow + +Quinn workflow Automate se objevuje ve Fázi 4 (Implementace) mapy workflow BMad Method. Je navržen ke spuštění **po dokončení celého epicu** — jakmile jsou všechny stories v epicu implementovány a zrevidovány. Typická sekvence: + +1. Pro každou story v epicu: implementace s Dev (`DS`), pak validace pomocí Code Review (`CR`) +2. Po dokončení epicu: generování testů s Quinnem (`QA`) nebo TEA workflow Automate +3. Spuštění retrospektivy (`bmad-retrospective`) pro zachycení získaných zkušeností + +Quinn pracuje přímo ze zdrojového kódu bez načítání plánovacích dokumentů (PRD, architektura). TEA workflow mohou integrovat s upstream plánovacími artefakty pro trasovatelnost. + +Pro více o tom, kde testování zapadá do celkového procesu, viz [Mapa pracovních postupů](./workflow-map.md). diff --git a/docs/cs/reference/workflow-map.md b/docs/cs/reference/workflow-map.md new file mode 100644 index 000000000..4dd67dd83 --- /dev/null +++ b/docs/cs/reference/workflow-map.md @@ -0,0 +1,89 @@ +--- +title: "Mapa pracovních postupů" +description: Vizuální reference fází workflow BMad Method a jejich výstupů +sidebar: + order: 1 +--- + +BMad Method (BMM) je modul v ekosystému BMad, zaměřený na dodržování osvědčených postupů context engineeringu a plánování. AI agenti fungují nejlépe s jasným, strukturovaným kontextem. Systém BMM buduje tento kontext progresivně napříč 4 odlišnými fázemi — každá fáze a volitelně více workflow v každé fázi produkují dokumenty, které informují další, takže agenti vždy vědí, co budovat a proč. + +Zdůvodnění a koncepty vycházejí z agilních metodik, které byly v průmyslu úspěšně používány jako mentální framework. + +Pokud si kdykoli nejste jisti, co dělat, skill `bmad-help` vám pomůže zůstat na cestě nebo vědět, co dělat dál. Vždy se můžete odkázat sem — ale `bmad-help` je plně interaktivní a mnohem rychlejší, pokud již máte nainstalovaný BMad Method. Navíc, pokud používáte různé moduly, které rozšířily BMad Method nebo přidaly další komplementární moduly — `bmad-help` se vyvíjí a zná vše, co je dostupné, aby vám dal nejlepší radu v daném okamžiku. + +Důležitá poznámka: Každý workflow níže lze spustit přímo vaším nástrojem přes skill nebo načtením agenta a použitím záznamu z nabídky agenta. + + + +

+ Otevřít diagram v novém panelu ↗ +

+ +## Fáze 1: Analýza (volitelná) + +Prozkoumejte problémový prostor a validujte nápady před závazkem k plánování. + +| Workflow | Účel | Produkuje | +| ------------------------------- | -------------------------------------------------------------------------- | ------------------------- | +| `bmad-brainstorming` | Brainstorming nápadů na projekt s řízenou facilitací brainstormingového kouče | `brainstorming-report.md` | +| `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Validace tržních, technických nebo doménových předpokladů | Výzkumné nálezy | +| `bmad-product-brief` | Zachycení strategické vize — nejlepší, když je váš koncept jasný | `product-brief.md` | +| `bmad-prfaq` | Working Backwards — zátěžový test a zformování vašeho produktového konceptu | `prfaq-{project}.md` | + +## Fáze 2: Plánování + +Definujte, co budovat a pro koho. + +| Workflow | Účel | Produkuje | +| --------------------------- | ---------------------------------------- | ------------ | +| `bmad-create-prd` | Definice požadavků (FR/NFR) | `PRD.md` | +| `bmad-create-ux-design` | Návrh uživatelského zážitku (když záleží na UX) | `ux-spec.md` | + +## Fáze 3: Solutioning + +Rozhodněte, jak to budovat, a rozložte práci na stories. + +| Workflow | Účel | Produkuje | +| ----------------------------------------- | ------------------------------------------ | --------------------------- | +| `bmad-create-architecture` | Explicitní technická rozhodnutí | `architecture.md` s ADR | +| `bmad-create-epics-and-stories` | Rozložení požadavků na implementovatelnou práci | Soubory epiců se stories | +| `bmad-check-implementation-readiness` | Kontrola brány před implementací | Rozhodnutí PASS/CONCERNS/FAIL | + +## Fáze 4: Implementace + +Budujte to, jednu story po druhé. Brzy plná automatizace fáze 4! + +| Workflow | Účel | Produkuje | +| -------------------------- | ------------------------------------------------------------------------ | -------------------------------- | +| `bmad-sprint-planning` | Inicializace sledování (jednou na projekt pro sekvencování dev cyklu) | `sprint-status.yaml` | +| `bmad-create-story` | Příprava další story pro implementaci | `story-[slug].md` | +| `bmad-dev-story` | Implementace story | Fungující kód + testy | +| `bmad-code-review` | Validace kvality implementace | Schváleno nebo požadovány změny | +| `bmad-correct-course` | Řešení významných změn uprostřed sprintu | Aktualizovaný plán nebo přesměrování | +| `bmad-sprint-status` | Sledování průběhu sprintu a stavu stories | Aktualizace stavu sprintu | +| `bmad-retrospective` | Revize po dokončení epicu | Poučení | + +## Quick Flow (paralelní cesta) + +Přeskočte fáze 1–3 pro malou, dobře pochopenou práci. + +| Workflow | Účel | Produkuje | +| ------------------ | --------------------------------------------------------------------------- | -------------------- | +| `bmad-quick-dev` | Sjednocený quick flow — vyjasněte záměr, plánujte, implementujte, revidujte a prezentujte | `spec-*.md` + kód | + +## Správa kontextu + +Každý dokument se stává kontextem pro další fázi. PRD říká architektovi, jaká omezení záleží. Architektura říká dev agentovi, jaké vzory následovat. Soubory stories poskytují zaměřený, kompletní kontext pro implementaci. Bez této struktury agenti dělají nekonzistentní rozhodnutí. + +### Kontext projektu + +:::tip[Doporučeno] +Vytvořte `project-context.md` pro zajištění toho, aby AI agenti dodržovali pravidla a preference vašeho projektu. Tento soubor funguje jako ústava vašeho projektu — vede implementační rozhodnutí napříč všemi workflow. Tento volitelný soubor lze vygenerovat na konci tvorby architektury, nebo u existujícího projektu ho lze také vygenerovat pro zachycení toho, co je důležité pro zachování souladu se současnými konvencemi. +::: + +**Jak ho vytvořit:** + +- **Ručně** — Vytvořte `_bmad-output/project-context.md` s vaším technologickým stackem a pravidly implementace +- **Vygenerujte ho** — Spusťte `bmad-generate-project-context` pro automatické generování z vaší architektury nebo kódové báze + +[**Zjistit více o project-context.md**](../explanation/project-context.md) diff --git a/docs/cs/roadmap.mdx b/docs/cs/roadmap.mdx new file mode 100644 index 000000000..14de53750 --- /dev/null +++ b/docs/cs/roadmap.mdx @@ -0,0 +1,136 @@ +--- +title: Plán rozvoje +description: Co chystáme pro BMad – funkce, vylepšení a komunitní příspěvky +--- + +# Metoda BMad: Veřejný plán rozvoje + +Metoda BMad, modul BMad Method (BMM) a BMad Builder (BMB) se neustále vyvíjejí. Zde je přehled toho, na čem pracujeme a co přijde dál. + +
+ +

Probíhá

+ +
+
+ 🧩 +

Univerzální architektura Skills

+

Jeden skill, jakákoli platforma. Napište jednou, spusťte kdekoli.

+
+
+ 🏗️ +

BMad Builder v1

+

Vytvářejte produkční AI agenty a pracovní postupy s vestavěnými eval testy, týmy a elegantní degradací.

+
+
+ 🧠 +

Systém kontextu projektu

+

Vaše AI skutečně rozumí vašemu projektu. Kontextový systém reagující na framework, který se vyvíjí s vaším kódem.

+
+
+ 📦 +

Centralizované Skills

+

Nainstalujte jednou, používejte všude. Sdílejte skills mezi projekty bez zbytečných souborů.

+
+
+ 🔄 +

Adaptivní Skills

+

Skills, které znají váš nástroj. Optimalizované varianty pro Claude, Codex, Kimi, OpenCode a mnoho dalších.

+
+
+ 📝 +

Blog BMad Team Pros

+

Návody, články a postřehy od týmu. Brzy spouštíme.

+
+
+ +

Na startu

+ +
+
+ 🏪 +

Skill Marketplace

+

Objevujte, instalujte a aktualizujte komunitní skills. Jeden curl příkaz od superschopností.

+
+
+ 🎨 +

Přizpůsobení pracovních postupů

+

Přizpůsobte si to. Integrujte Jira, Linear, vlastní výstupy — váš workflow, vaše pravidla.

+
+
+ 🚀 +

Optimalizace fází 1–3

+

Bleskurychlé plánování s kontextovým sběrem sub-agentů. Režim YOLO kombinovaný s řízenou kvalitou.

+
+
+ 🌐 +

Připraveno pro podniky

+

SSO, auditní logy, týmové pracovní prostory. Všechny ty nudné věci, díky kterým firmy řeknou ano.

+
+
+ 💎 +

Exploze komunitních modulů

+

Zábava, bezpečnost, terapie, roleplay a mnohem víc. Rozšiřte platformu BMad Method.

+
+
+ ⚡ +

Automatizace Dev Loop

+

Volitelný autopilot pro vývoj. Nechte AI řídit tok práce a přitom udržujte vysokou kvalitu.

+
+
+ +

Komunita a tým

+ +
+
+ 🎙️ +

Podcast metody BMad

+

Rozhovory o AI-nativním vývoji. Spouštíme 1. března 2026!

+
+
+ 🎓 +

Master Class metody BMad

+

Od uživatele k expertovi. Hluboké ponory do každé fáze, každého workflow, každého tajemství.

+
+
+ 🏗️ +

Master Class BMad Builder

+

Vytvářejte vlastní agenty. Pokročilé techniky pro chvíle, kdy jste připraveni tvořit, ne jen používat.

+
+
+ ⚡ +

BMad Prototype First

+

Od nápadu k fungujícímu prototypu v jedné relaci. Vytvořte svou vysněnou aplikaci jako umělecké dílo.

+
+
+ 🌴 +

BMad BALM!

+

Správa života pro AI-nativní uživatele. Úkoly, návyky, cíle — váš AI kopilot pro všechno.

+
+
+ 🖥️ +

Oficiální UI

+

Krásné rozhraní pro celý ekosystém BMad. Síla CLI, lesk GUI.

+
+
+ 🔒 +

BMad in a Box

+

Self-hosted, bez připojení, podnikové kvality. Váš AI asistent, vaše infrastruktura, vaše kontrola.

+
+
+ +
+

Chcete přispět?

+

+ Toto je pouze částečný seznam toho, co je plánováno. Open source tým BMad vítá přispěvatele!{" "}
+ Přidejte se k nám na GitHubu a pomozte formovat budoucnost vývoje řízeného AI. +

+

+ Líbí se vám, co budujeme? Oceníme jak jednorázovou, tak měsíční{" "}podporu. +

+

+ Pro firemní sponzoring, partnerské dotazy, přednášky, školení nebo mediální dotazy:{" "} + contact@bmadcode.com +

+
+
diff --git a/docs/cs/tutorials/getting-started.md b/docs/cs/tutorials/getting-started.md new file mode 100644 index 000000000..76a7b113b --- /dev/null +++ b/docs/cs/tutorials/getting-started.md @@ -0,0 +1,276 @@ +--- +title: "Začínáme" +description: Nainstalujte BMad a vytvořte svůj první projekt +--- + +Vytvářejte software rychleji pomocí pracovních postupů řízených AI se specializovanými agenty, kteří vás provedou plánováním, architekturou a implementací. + +## Co se naučíte + +- Nainstalovat a inicializovat BMad Method pro nový projekt +- Používat **BMad-Help** — vašeho inteligentního průvodce, který ví, co dělat dál +- Vybrat správnou plánovací cestu pro velikost vašeho projektu +- Postupovat fázemi od požadavků k fungujícímu kódu +- Efektivně používat agenty a pracovní postupy + +:::note[Předpoklady] +- **Node.js 20+** — Vyžadováno pro instalátor +- **Git** — Doporučeno pro správu verzí +- **AI-powered IDE** — Claude Code, Cursor nebo podobné +- **Nápad na projekt** — I jednoduchý stačí pro učení +::: + +:::tip[Nejsnadnější cesta] +**Instalace** → `npx bmad-method install` +**Zeptejte se** → `bmad-help what should I do first?` +**Tvořte** → Nechte BMad-Help vás provést workflow po workflow +::: + +## Seznamte se s BMad-Help: Váš inteligentní průvodce + +**BMad-Help je nejrychlejší způsob, jak začít s BMad.** Nemusíte si pamatovat workflow nebo fáze — prostě se zeptejte a BMad-Help: + +- **Prozkoumá váš projekt** a zjistí, co už bylo uděláno +- **Ukáže vaše možnosti** na základě nainstalovaných modulů +- **Doporučí, co dál** — včetně prvního povinného úkolu +- **Odpoví na otázky** jako „Mám nápad na SaaS, kde začít?“ + +### Jak používat BMad-Help + +Spusťte ho ve vašem AI IDE vyvoláním skillu: + +``` +bmad-help +``` + +Nebo ho spojte s otázkou pro kontextové poradenství: + +``` +bmad-help I have an idea for a SaaS product, I already know all the features I want. where do I get started? +``` + +BMad-Help odpoví s: +- Co je doporučeno pro vaši situaci +- Jaký je první povinný úkol +- Jak vypadá zbytek procesu + +### Řídí i pracovní postupy + +BMad-Help nejen odpovídá na otázky — **automaticky se spouští na konci každého workflow** a řekne vám přesně, co dělat dál. Žádné hádání, žádné prohledávání dokumentace — jen jasné pokyny k dalšímu povinnému workflow. + +:::tip[Začněte zde] +Po instalaci BMad okamžitě vyvolejte skill `bmad-help`. Detekuje, jaké moduly máte nainstalované, a navede vás ke správnému výchozímu bodu pro váš projekt. +::: + +## Pochopení BMad + +BMad vám pomáhá vytvářet software prostřednictvím řízených pracovních postupů se specializovanými AI agenty. Proces probíhá ve čtyřech fázích: + +| Fáze | Název | Co se děje | +| ---- | -------------- | ------------------------------------------------------- | +| 1 | Analýza | Brainstorming, průzkum, product brief nebo PRFAQ *(volitelné)* | +| 2 | Plánování | Vytvoření požadavků (PRD nebo specifikace) | +| 3 | Solutioning | Návrh architektury *(pouze BMad Method/Enterprise)* | +| 4 | Implementace | Budování epic po epicu, story po story | + +**[Otevřete Mapu pracovních postupů](../reference/workflow-map.md)** pro prozkoumání fází, workflow a správy kontextu. + +Na základě složitosti vašeho projektu nabízí BMad tři plánovací cesty: + +| Cesta | Nejlepší pro | Vytvořené dokumenty | +| --------------- | -------------------------------------------------------------- | -------------------------------------- | +| **Quick Flow** | Opravy chyb, jednoduché funkce, jasný rozsah (1–15 stories) | Pouze tech-spec | +| **BMad Method** | Produkty, platformy, složité funkce (10–50+ stories) | PRD + architektura + UX | +| **Enterprise** | Compliance, multi-tenant systémy (30+ stories) | PRD + architektura + bezpečnost + DevOps | + +:::note +Počty stories jsou orientační, ne definitivní. Vyberte si cestu podle potřeb plánování, ne podle počtu stories. +::: + +## Instalace + +Otevřete terminál v adresáři vašeho projektu a spusťte: + +```bash +npx bmad-method install +``` + +Pokud chcete nejnovější prereleaseový build místo výchozího release kanálu, použijte `npx bmad-method@next install`. + +Při výzvě k výběru modulů zvolte **BMad Method**. + +Instalátor vytvoří dvě složky: +- `_bmad/` — agenti, workflow, úkoly a konfigurace +- `_bmad-output/` — prozatím prázdná, ale zde se budou ukládat vaše artefakty + +:::tip[Váš další krok] +Otevřete vaše AI IDE ve složce projektu a spusťte: + +``` +bmad-help +``` + +BMad-Help detekuje, co jste dokončili, a doporučí přesně, co dělat dál. Můžete mu také klást otázky jako „Jaké mám možnosti?“ nebo „Mám nápad na SaaS, kde začít?“ +::: + +:::note[Jak načítat agenty a spouštět workflow] +Každý workflow má **skill**, který vyvoláte jménem ve vašem IDE (např. `bmad-create-prd`). Váš AI nástroj rozpozná název `bmad-*` a spustí ho — nemusíte načítat agenty zvlášť. Můžete také vyvolat agentní skill přímo pro obecnou konverzaci (např. `bmad-agent-pm` pro PM agenta). +::: + +:::caution[Nové chaty] +Vždy začněte nový chat pro každý workflow. Tím předejdete problémům s kontextovými omezeními. +::: + +## Krok 1: Vytvořte svůj plán + +Projděte fázemi 1–3. **Pro každý workflow používejte nové chaty.** + +:::tip[Kontext projektu (volitelné)] +Před začátkem zvažte vytvoření `project-context.md` pro dokumentaci vašich technických preferencí a pravidel implementace. Tím zajistíte, že všichni AI agenti budou dodržovat vaše konvence v průběhu celého projektu. + +Vytvořte ho ručně na `_bmad-output/project-context.md` nebo ho vygenerujte po architektuře pomocí `bmad-generate-project-context`. [Zjistit více](../explanation/project-context.md). +::: + +### Fáze 1: Analýza (volitelná) + +Všechny workflow v této fázi jsou volitelné: +- **brainstorming** (`bmad-brainstorming`) — Řízená ideace +- **průzkum** (`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research`) — Tržní, doménový a technický průzkum +- **product-brief** (`bmad-product-brief`) — Doporučený základní dokument, když je váš koncept jasný +- **prfaq** (`bmad-prfaq`) — Working Backwards výzva pro zátěžový test a zformování vašeho produktového konceptu + +### Fáze 2: Plánování (povinná) + +**Pro BMad Method a Enterprise cesty:** +1. Vyvolejte **PM agenta** (`bmad-agent-pm`) v novém chatu +2. Spusťte workflow `bmad-create-prd` (`bmad-create-prd`) +3. Výstup: `PRD.md` + +**Pro Quick Flow cestu:** +- Spusťte `bmad-quick-dev` — zvládne plánování i implementaci v jednom workflow, přeskočte k implementaci + +:::note[UX Design (volitelné)] +Pokud má váš projekt uživatelské rozhraní, vyvolejte **UX-Designer agenta** (`bmad-agent-ux-designer`) a spusťte UX design workflow (`bmad-create-ux-design`) po vytvoření PRD. +::: + +### Fáze 3: Solutioning (BMad Method/Enterprise) + +**Vytvoření architektury** +1. Vyvolejte **Architect agenta** (`bmad-agent-architect`) v novém chatu +2. Spusťte `bmad-create-architecture` (`bmad-create-architecture`) +3. Výstup: Dokument architektury s technickými rozhodnutími + +**Vytvoření epiců a stories** + +:::tip[Vylepšení ve V6] +Epicy a stories se nyní vytvářejí *po* architektuře. Tím vznikají kvalitnější stories, protože architektonická rozhodnutí (databáze, API vzory, tech stack) přímo ovlivňují rozklad práce. +::: + +1. Vyvolejte **PM agenta** (`bmad-agent-pm`) v novém chatu +2. Spusťte `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`) +3. Workflow využívá jak PRD, tak architekturu k vytvoření technicky informovaných stories + +**Kontrola připravenosti k implementaci** *(vysoce doporučeno)* +1. Vyvolejte **Architect agenta** (`bmad-agent-architect`) v novém chatu +2. Spusťte `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`) +3. Validuje soudržnost všech plánovacích dokumentů + +## Krok 2: Sestavte svůj projekt + +Jakmile je plánování dokončeno, přejděte k implementaci. **Každý workflow by měl běžet v novém chatu.** + +### Inicializace plánování sprintu + +Vyvolejte **Developer agenta** (`bmad-agent-dev`) a spusťte `bmad-sprint-planning` (`bmad-sprint-planning`). Tím se vytvoří `sprint-status.yaml` pro sledování všech epiců a stories. + +### Cyklus vývoje + +Pro každou story opakujte tento cyklus s novými chaty: + +| Krok | Agent | Workflow | Příkaz | Účel | +| ---- | ----- | -------------------- | -------------------------- | ---------------------------------- | +| 1 | DEV | `bmad-create-story` | `bmad-create-story` | Vytvoření story souboru z epicu | +| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implementace story | +| 3 | DEV | `bmad-code-review` | `bmad-code-review` | Validace kvality *(doporučeno)* | + +Po dokončení všech stories v epicu vyvolejte **Developer agenta** (`bmad-agent-dev`) a spusťte `bmad-retrospective` (`bmad-retrospective`). + +## Co jste dosáhli + +Naučili jste se základy budování s BMad: + +- Nainstalovali BMad a nakonfigurovali ho pro vaše IDE +- Inicializovali projekt s vybranou plánovací cestou +- Vytvořili plánovací dokumenty (PRD, architektura, epicy a stories) +- Pochopili cyklus vývoje pro implementaci + +Váš projekt nyní obsahuje: + +```text +váš-projekt/ +├── _bmad/ # Konfigurace BMad +├── _bmad-output/ +│ ├── planning-artifacts/ +│ │ ├── PRD.md # Váš dokument požadavků +│ │ ├── architecture.md # Technická rozhodnutí +│ │ └── epics/ # Soubory epiců a stories +│ ├── implementation-artifacts/ +│ │ └── sprint-status.yaml # Sledování sprintu +│ └── project-context.md # Pravidla implementace (volitelné) +└── ... +``` + +## Rychlý přehled + +| Workflow | Příkaz | Agent | Účel | +| ------------------------------------- | ------------------------------------------ | --------- | ----------------------------------------------- | +| **`bmad-help`** ⭐ | `bmad-help` | Jakýkoli | **Váš inteligentní průvodce — ptejte se na cokoli!** | +| `bmad-create-prd` | `bmad-create-prd` | PM | Vytvoření dokumentu požadavků (PRD) | +| `bmad-create-architecture` | `bmad-create-architecture` | Architect | Vytvoření dokumentu architektury | +| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | Vytvoření souboru kontextu projektu | +| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | Rozklad PRD na epicy | +| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Architect | Validace soudržnosti plánování | +| `bmad-sprint-planning` | `bmad-sprint-planning` | DEV | Inicializace sledování sprintu | +| `bmad-create-story` | `bmad-create-story` | DEV | Vytvoření souboru story | +| `bmad-dev-story` | `bmad-dev-story` | DEV | Implementace story | +| `bmad-code-review` | `bmad-code-review` | DEV | Revize implementovaného kódu | + +## Časté otázky + +**Potřebuji vždy architekturu?** +Pouze pro BMad Method a Enterprise cesty. Quick Flow přeskakuje ze specifikace rovnou k implementaci. + +**Mohu později změnit svůj plán?** +Ano. Workflow `bmad-correct-course` (`bmad-correct-course`) řeší změny rozsahu během implementace. + +**Co když chci nejdřív brainstormovat?** +Vyvolejte Analyst agenta (`bmad-agent-analyst`) a spusťte `bmad-brainstorming` (`bmad-brainstorming`) před zahájením PRD. + +**Musím dodržovat striktní pořadí?** +Ne striktně. Jakmile se naučíte postup, můžete spouštět workflow přímo pomocí Rychlého přehledu výše. + +## Získání pomoci + +:::tip[První zastávka: BMad-Help] +**Vyvolejte `bmad-help` kdykoli** — je to nejrychlejší způsob, jak se odpoutat. Zeptejte se na cokoli: +- „Co mám dělat po instalaci?“ +- „Zasekl jsem se na workflow X“ +- „Jaké mám možnosti pro Y?“ +- „Ukaž mi, co bylo dosud uděláno“ + +BMad-Help prozkoumá váš projekt, detekuje, co jste dokončili, a řekne vám přesně, co dělat dál. +::: + +- **Během workflow** — Agenti vás provázejí otázkami a vysvětleními +- **Komunita** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues) + +## Klíčové poznatky + +:::tip[Zapamatujte si] +- **Začněte s `bmad-help`** — Váš inteligentní průvodce, který zná váš projekt a možnosti +- **Vždy používejte nové chaty** — Začněte nový chat pro každý workflow +- **Cesta záleží** — Quick Flow používá `bmad-quick-dev`; Method/Enterprise vyžadují PRD a architekturu +- **BMad-Help se spouští automaticky** — Každý workflow končí pokyny, co dělat dál +::: + +Jste připraveni začít? Nainstalujte BMad, vyvolejte `bmad-help` a nechte svého inteligentního průvodce ukázat cestu. diff --git a/docs/explanation/named-agents.md b/docs/explanation/named-agents.md new file mode 100644 index 000000000..e5a92511c --- /dev/null +++ b/docs/explanation/named-agents.md @@ -0,0 +1,94 @@ +--- +title: "Named Agents" +description: Why BMad agents have names, personas, and customization surfaces — and what that unlocks compared to menu-driven or prompt-driven alternatives +sidebar: + order: 1 +--- + +You say "Hey Mary, let's brainstorm," and Mary activates. She greets you by name, in the language you configured, with her distinctive persona. She reminds you that `bmad-help` is always available. Then she skips the menu entirely and drops straight into brainstorming — because your intent was clear. + +This page explains what's actually happening and why BMad is designed this way. + +## The Three-Legged Stool + +BMad's agent model rests on three primitives that compose: + +| Primitive | What it provides | Where it lives | +|---|---|---| +| **Skill** | Capability — a discrete thing the assistant can do (brainstorm, draft a PRD, implement a story) | `.claude/skills/{skill-name}/SKILL.md` (or your IDE's equivalent) | +| **Named agent** | Persona continuity — a recognizable identity that wraps a menu of related skills with consistent voice, principles, and visual cues | Skills whose directory starts with `bmad-agent-*` | +| **Customization** | Makes it yours — overrides that reshape an agent's behavior, add MCP integrations, swap templates, layer in org conventions | `_bmad/custom/{skill-name}.toml` (committed team overrides) and `.user.toml` (personal, gitignored) | + +Pull any leg away and the experience collapses: + +- Skills without agents → capability lists the user has to navigate by name or code +- Agents without skills → personas with nothing to do +- No customization → every user gets the same out-of-box behavior, forcing forks for any org-specific need + +## What Named Agents Buy You + +BMad ships six named agents, each anchored to a phase of the BMad Method: + +| Agent | Phase | Module | +|---|---|---| +| 📊 **Mary**, Business Analyst | Analysis | market research, brainstorming, product briefs, PRFAQs | +| 📚 **Paige**, Technical Writer | Analysis | project documentation, diagrams, doc validation | +| 📋 **John**, Product Manager | Planning | PRD creation, epic/story breakdown, implementation readiness | +| 🎨 **Sally**, UX Designer | Planning | UX design specifications | +| 🏗️ **Winston**, System Architect | Solutioning | technical architecture, alignment checks | +| 💻 **Amelia**, Senior Engineer | Implementation | story execution, quick-dev, code review, sprint planning | + +They each have a hardcoded identity (name, title, domain) and a customizable layer (role, principles, communication style, icon, menu). You can rewrite Mary's principles or add menu items; you can't rename her — that's deliberate. Brand recognition survives customization so "hey Mary" always activates the analyst, regardless of how a team has shaped her behavior. + +## The Activation Flow + +When you invoke a named agent, eight steps run in order: + +1. **Resolve the agent block** — merge the shipped `customize.toml` with team and personal overrides, via a Python resolver using stdlib `tomllib` +2. **Execute prepend steps** — any pre-flight behavior the team configured +3. **Adopt persona** — hardcoded identity plus customized role, communication style, principles +4. **Load persistent facts** — org rules, compliance notes, optionally files loaded via a `file:` prefix (e.g., `file:{project-root}/docs/project-context.md`) +5. **Load config** — user name, communication language, output language, artifact paths +6. **Greet** — personalized, in the configured language, with the agent's emoji prefix so you can see at a glance who's speaking +7. **Execute append steps** — any post-greet setup the team configured +8. **Dispatch or present the menu** — if your opening message maps to a menu item, go directly; otherwise render the menu and wait for input + +Step 8 is where intent meets capability. "Hey Mary, let's brainstorm" skips rendering because `bmad-brainstorming` is an obvious match for `BP` on Mary's menu. If you say something ambiguous, she asks once, briefly, not as a confirmation ritual. If nothing fits, she continues the conversation normally. + +## Why Not Just a Menu? + +Menus force the user to meet the tool halfway. You have to remember that brainstorming lives under code `BP` on the analyst agent, not the PM agent, and know which persona owns which capabilities. That's cognitive overhead the tool is making you carry. + +Named agents invert it. You say what you want, to whom, in whatever words feel natural. The agent knows who they are and what they do. When your intent is clear enough, they just go. + +The menu is still there as a fallback — show it when you're exploring, skip it when you're not. + +## Why Not Just a Blank Prompt? + +Blank prompts assume you know the magic words. "Help me brainstorm" might work, but "let's ideate on my SaaS idea" might not, and the results depend on how you phrased the ask. You become responsible for prompt engineering. + +Named agents add structure without closing off freedom. The persona stays consistent, the capabilities are discoverable, and `bmad-help` is always one command away. You don't have to guess what the agent can do, and you don't need a manual to use it either. + +## Customization as a First-Class Citizen + +The customization model is what lets this scale beyond a single developer. + +Every agent ships a `customize.toml` with sensible defaults. Teams commit overrides to `_bmad/custom/bmad-agent-{role}.toml`. Individuals can layer personal preferences in `.user.toml` (gitignored). The resolver merges all three at activation time with predictable structural rules. + +Most users never hand-author these files. The `bmad-customize` skill walks through picking the target, choosing agent vs workflow scope, authoring the override, and verifying the merge — so the customization surface stays accessible to anyone who understands their intent, not just those fluent in TOML. + +Concrete example: a team commits a single file telling Amelia to always use the Context7 MCP tool for library docs and to fall back to Linear when a story isn't in the local epics list. Every dev workflow Amelia dispatches (dev-story, quick-dev, create-story, code-review) inherits that behavior, with no source edits or per-workflow duplication required. + +There's also a second customization surface for *cross-cutting* concerns: the central `_bmad/config.toml` and `_bmad/config.user.toml` (both installer-owned, rebuilt from each module's `module.yaml`) plus `_bmad/custom/config.toml` (team, committed) and `_bmad/custom/config.user.toml` (personal, gitignored) for overrides. This is where the **agent roster** lives — the lightweight descriptors that roster consumers like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` read to know who's available and how to embody them. Rebrand an agent org-wide with a team override; add fictional voices (Kirk, Spock, a domain expert persona) as personal experiments via the `.user.toml` override — without touching any skill folder. The per-skill file shapes how Mary *behaves* when she activates; the central config shapes how other skills *see* her when they look at the field. + +For the full customization surface and worked examples, see: + +- [How to Customize BMad](../how-to/customize-bmad.md) — the reference for what's customizable and how merge works +- [How to Expand BMad for Your Organization](../how-to/expand-bmad-for-your-org.md) — five worked recipes spanning agent-wide rules, workflow conventions, external publishing, template swaps, and agent roster customization +- `bmad-customize` skill — the guided authoring helper that turns intent into a correctly-placed, verified override file + +## The Bigger Idea + +Most AI assistants today are either menus or prompts, and both shift cognitive load onto the user. Named agents plus customizable skills let you talk to a teammate who already knows the work, and let your organization shape that teammate without forking. + +The next time you type "Hey Mary, let's brainstorm" and she just gets on with it, notice what didn't happen. There was no slash command, no menu to navigate, no awkward reminder of what she can do. That absence is the design. diff --git a/docs/fr/_STYLE_GUIDE.md b/docs/fr/_STYLE_GUIDE.md index 18907a4fb..b0f3453d9 100644 --- a/docs/fr/_STYLE_GUIDE.md +++ b/docs/fr/_STYLE_GUIDE.md @@ -353,7 +353,7 @@ Uniquement pour les parcours méthode BMad et Enterprise. Quick Dev passe direct ### Puis-je modifier mon plan plus tard ? -Oui. Utilisez `bmad-correct-course` pour gérer les changements de portée. +Oui. Utilisez `bmad-correct-course` pour gérer les changements de portée en cours d’implémentation. **Une question sans réponse ici ?** [Ouvrez une issue](...) ou posez votre question sur [Discord](...). ``` diff --git a/docs/fr/explanation/advanced-elicitation.md b/docs/fr/explanation/advanced-elicitation.md index de097752e..83ea232cd 100644 --- a/docs/fr/explanation/advanced-elicitation.md +++ b/docs/fr/explanation/advanced-elicitation.md @@ -2,7 +2,7 @@ title: "Élicitation Avancée" description: Pousser le LLM à repenser son travail en utilisant des méthodes de raisonnement structurées sidebar: - order: 6 + order: 8 --- Faites repenser au LLM ce qu'il vient de générer. Vous choisissez une méthode de raisonnement, il l'applique à sa propre sortie, et vous décidez de conserver ou non les améliorations. diff --git a/docs/fr/explanation/adversarial-review.md b/docs/fr/explanation/adversarial-review.md index 235db5f23..fa080f85d 100644 --- a/docs/fr/explanation/adversarial-review.md +++ b/docs/fr/explanation/adversarial-review.md @@ -2,7 +2,7 @@ title: "Revue Contradictoire" description: Technique de raisonnement forcée qui empêche les revues paresseuses du style "ça à l'air bon" sidebar: - order: 5 + order: 7 --- Forcez une analyse plus approfondie en exigeant que des problèmes soient trouvés. diff --git a/docs/fr/explanation/analysis-phase.md b/docs/fr/explanation/analysis-phase.md new file mode 100644 index 000000000..2206f95df --- /dev/null +++ b/docs/fr/explanation/analysis-phase.md @@ -0,0 +1,74 @@ +--- +title: "Phase d'analyse : de l'Idée aux Fondations" +description: Ce que sont le brainstorming, la recherche, les product briefs et les PRFAQs — et quand les utiliser +sidebar: + order: 1 +--- + +La phase d'Analyse (Phase 1) vous aide à penser clairement à votre produit avant de vous engager à le construire. Chaque outil de cette phase est optionnel, mais sauter l'analyse entièrement signifie que votre PRD sera construit sur des suppositions plutôt que sur des connaissances approfondies. + +## Pourquoi Analyser avant de Planifier ? + +Un PRD répond à la question « que devons-nous construire et pourquoi ? » Si vous l'alimentez avec une réflexion vague, vous obtiendrez un PRD vague — et chaque document en aval héritera de cette imprécision. Une architecture bâtie sur un PRD faible prend de mauvaises décisions techniques. Les stories dérivées d'une architecture faible manquent de edge cases. Le coût s'accumule. + +Les outils d'analyse existent pour rendre votre PRD précis. Ils attaquent le problème sous différents angles — exploration créative, réalité du marché, clarté client, faisabilité — pour qu'au moment de vous asseoir avec l'agent PM, vous sachiez ce que vous construisez et pour qui. + +## Les Outils + +### Brainstorming + +**Quoi.** Une session créative facilitée utilisant des techniques d'idéation éprouvées. L'IA agit comme coach, extrayant vos idées à travers des exercices structurés — pas en les générant pour vous. + +**Pourquoi.** Les idées brutes ont besoin d'espace pour se développer avant d'être verrouillées dans des exigences. Le brainstorming crée cet espace. Il est particulièrement précieux quand vous avez un espace-problème mais pas de solution claire, ou quand vous voulez explorer plusieurs pistes avant de vous engager. + +**Quand.** Vous avez une vague idée de ce que vous voulez construire mais n'avez pas encore cristallisé le concept. Ou vous avez un concept mais voulez l'éprouver face à des alternatives. + +Voir [Brainstorming](./brainstorming.md) pour un aperçu plus approfondi du fonctionnement des sessions. + +### Recherche (Marché, Domaine, Technique) + +**Quoi.** Trois workflows de recherche ciblés qui investiguent différentes dimensions de votre idée. La recherche marché examine les concurrents, les tendances et le sentiment utilisateur. La recherche domaine construit l'expertise métier et la terminologie. La recherche technique évalue la faisabilité, les options d'architecture et les approches d'implémentation. + +**Pourquoi.** Construire sur des suppositions est le moyen le plus rapide de construire quelque chose dont personne n'a besoin. La recherche ancre votre concept dans la réalité — quels concurrents existent déjà, avec quoi les utilisateurs luttent réellement, ce qui est techniquement faisable, et quelles contraintes spécifiques à l'industrie vous affronterez. + +**Quand.** Vous entrez dans un domaine inconnu, vous soupçonnez que des concurrents existent mais ne les avez pas cartographiés, ou votre concept dépend de capacités techniques que vous n'avez pas validées. Lancez-en un, deux ou les trois — chaque workflow de recherche fonctionne de manière autonome. + +### Product Brief[^1] + +**Quoi.** Une session de découverte guidée qui produit un résumé exécutif de 1-2 pages de votre concept produit. L'IA agit comme un analyste commercial collaboratif, vous aidant à articuler la vision, le public cible, la proposition de valeur et le périmètre. + +**Pourquoi.** Le product brief est le chemin le plus doux vers la planification. Il capture votre vision stratégique dans un format structuré qui alimente directement la création du PRD. Il fonctionne mieux quand vous avez déjà la conviction à propos de votre concept — vous connaissez le client, le problème et approximativement ce que vous voulez construire. Le brief organise et affine cette réflexion. + +**Quand.** Votre concept est relativement clair et vous voulez le documenter efficacement avant de créer un PRD. Vous êtes confiant dans la direction et n'avez pas besoin que vos suppositions soient agressivement remises en question. + +### PRFAQ (Working Backwards) + +**Quoi.** La méthodologie Working Backwards d'Amazon adaptée en défi interactif. Vous rédigez le communiqué de presse annonçant votre produit fini avant qu'une seule ligne de code n'existe, puis répondez aux questions les plus difficiles que les clients et les parties prenantes poseraient. L'IA agit comme un coach produit implacable mais constructif. + +**Pourquoi.** Le PRFAQ est le chemin rigoureux vers la planification. Il force la clarté orientée client en vous obligeant à défendre chaque affirmation. Si vous ne pouvez pas rédiger un communiqué de presse convaincant, le produit n'est pas prêt. Si les réponses de la FAQ client révèlent des lacunes, ce sont des lacunes que vous découvrirez bien plus tard — et plus coûteusement — pendant l'implémentation. Le défi fait remonter les failles de réflexion tôt, quand c'est le moins cher de les corriger. + +**Quand.** Vous voulez que votre concept soit éprouvé avant d'engager des ressources. Vous n'êtes pas sûr que les utilisateurs s'en soucieront réellement. Vous voulez valider que vous pouvez articuler une proposition de valeur claire et défendable. Ou vous voulez simplement la discipline du Working Backwards pour affiner votre réflexion. + +## Lequel utiliser ? + +| Situation | Outil recommandé | +|-------------------------------------------------------------------------------|--------------------------------------------| +| « J'ai une idée vague, je ne sais pas par où commencer » | Brainstorming | +| « J'ai besoin de comprendre le marché avant de décider » | Recherche | +| « Je sais ce que je veux construire, j'ai juste besoin de le documenter » | Product Brief | +| « Je veux m'assurer que cette idée vaut vraiment la peine d'être construite » | PRFAQ | +| « Je veux explorer, puis valider, puis documenter » | Brainstorming → Recherche → PRFAQ ou Brief | + +Le Product Brief et le PRFAQ produisent tous deux des entrées pour le PRD — choisissez-en un en fonction du niveau de défi que vous souhaitez. Le brief est une découverte collaborative. Le PRFAQ est un défi. Les deux vous mènent à la même destination ; le PRFAQ teste si votre concept mérite d'y arriver. + +:::tip[Pas sûr ?] +Exécutez `bmad-help` et décrivez votre situation. Il vous recommandera le bon point de départ en fonction de ce que vous avez déjà accompli et de ce que vous essayez de réaliser. +::: + +## Que se passe-t-il après l'analyse ? + +Les résultats de l'analyse alimentent directement la Phase 2 (Planification). Le workflow PRD accepte les product briefs, les documents PRFAQ, les conclusions de recherche et les rapports de brainstorming en entrée — il synthétise tout ce que vous avez produit en exigences structurées. Plus vous faites d'analyse, plus votre PRD sera précis. + +## Glossaire + +[^1]: Brief : document synthétique qui formalise le contexte, les objectifs, le périmètre et les contraintes d'un projet ou d'une demande, afin d'aligner rapidement les parties prenantes avant le travail détaillé. diff --git a/docs/fr/explanation/checkpoint-preview.md b/docs/fr/explanation/checkpoint-preview.md new file mode 100644 index 000000000..7eb8cc679 --- /dev/null +++ b/docs/fr/explanation/checkpoint-preview.md @@ -0,0 +1,92 @@ +--- +title: "Checkpoint Preview" +description: Revue assistée par LLM, avec intervention humaine, qui vous guide à travers une modification, de son objectif jusqu’aux détails +sidebar: + order: 4 +--- + +`bmad-checkpoint-preview` est un workflow de revue interactif, assisté par LLM, avec intervention humaine. Il vous guide à travers une modification de code — de l'intention et du contexte jusqu'aux détails — afin que vous puissiez prendre une décision éclairée sur la mise en production, la refonte ou l'approfondissement. + +![Diagramme du workflow Checkpoint Preview](/diagrams/checkpoint-preview-diagram-fr.webp) + +## Le Flux Typique + +Vous lancez `bmad-quick-dev`. Il clarifie votre intention, construit une spécification, implémente la modification, et une fois terminé, il ajoute un historique de revue au fichier de spécification et l'ouvre dans votre éditeur. Vous regardez la spec et constatez que la modification a touché 20 fichiers dans plusieurs modules. + +Vous pourriez survoler le diff. Mais 20 fichiers, c'est le moment où le survol commence à échouer — on perd le fil, on rate un lien entre deux modifications éloignées, ou on approuve quelque chose qu'on n'a pas pleinement compris. Alors au lieu de cela, vous dites « checkpoint » et le LLM vous guide à travers la modification. + +Ce passage de relais — de l'implémentation autonome au jugement humain — est le cas d'usage principal. Quick-dev s'exécute longtemps avec une supervision minimale. Checkpoint Preview, c'est là où vous reprenez le volant. + +## Pourquoi + +La revue de code a deux modes d'échec. Dans le premier, le réviseur survole le diff, rien ne saute aux yeux, et il approuve. Dans le second, il lit méthodiquement chaque fichier mais perd le fil — il voit les arbres et rate la forêt. Les deux aboutissent au même résultat : la revue n'a pas repéré ce qui comptait. + +Le problème sous-jacent est le séquençage. Un diff brut présente les modifications dans l'ordre des fichiers, ce qui est presque jamais l'ordre qui construit la compréhension. Vous voyez une fonction utilitaire avant de savoir pourquoi elle existe. Vous voyez une modification de schéma avant de comprendre quelle fonctionnalité elle supporte. Le réviseur doit reconstruire l'intention de l'auteur à partir d'indices dispersés, et c'est cette reconstruction qui fait défaut à l'attention. + +Checkpoint Preview résout ce problème en confiant le travail de reconstruction au LLM. Il lit le diff, la spécification (si elle existe) et la base de code environnante, puis présente la modification dans un ordre conçu pour la compréhension — et non pour `git diff`. + +## Comment ça fonctionne + +Le workflow comporte cinq étapes. Chaque étape s'appuie sur la précédente, passant progressivement de « qu'est-ce que c'est ? » à « devons-nous publier ça ? » + +### 1. Orientation + +Le workflow identifie la modification (à partir d'une PR, d'un commit, d'une branche, d'un fichier de spécification ou de l'état git actuel) et produit un résumé d'intention en une ligne ainsi que des statistiques de surface : fichiers modifiés, modules touchés, lignes de logique, dépassements de boundaries et nouvelles interfaces publiques. + +C'est le moment « est-ce bien ce que je crois ? ». Avant de lire le moindre code, le réviseur confirme qu'il regarde la bonne chose et calibre ses attentes quant à la portée. + +### 2. Visite guidée + +La modification est organisée par **préoccupation** — des intentions de conception cohérentes comme « validation des entrées » ou « contrat d'API » — et non par fichier. Chaque préoccupation fait l'objet d'une courte explication du *pourquoi* de cette approche, suivie d'arrêts cliquables `chemin:ligne` que le réviseur peut suivre dans le code. + +C'est l'étape du jugement de conception. Le réviseur évalue si l'approche est adaptée au système, et non si le code est correct. Les préoccupations sont séquencées de haut en bas : l'intention de plus haut niveau en premier, puis l'implémentation de support. Le réviseur ne rencontre jamais une référence à quelque chose qu'il n'a pas encore vu. + +### 3. Passage en revue des détails + +Une fois que le réviseur comprend la conception, le workflow met en évidence 2 à 5 endroits où une erreur aurait l’impact le plus important. Ceux-ci sont étiquetés par catégorie de risque — `[auth]`, `[schéma]`, `[facturation]`, `[API publique]`, `[sécurité]`, et d'autres — et ordonnés selon l'impact en cas d'erreur. + +Ce n'est pas une chasse aux bugs. Les tests automatisés et la CI gèrent la correction. Le passage en revue des détails active la conscience du risque : « voici les endroits où se tromper coûte le plus cher ». Si le réviseur veut approfondir un domaine spécifique, il peut dire « approfondis [domaine] » pour une re-revue ciblée axée sur la correction. + +Si la spécification a passé des boucles de revues contradictoires (machine hardening), ces résultats sont également présentés ici — pas les bugs qui ont été corrigés, mais les décisions que la boucle de revue a signalées et dont le réviseur devrait être conscient. + +### 4. Tests + +Propose 2 à 5 façons d'observer manuellement la modification en action. Pas des commandes de test automatisé — des observations manuelles qui renforcent la confiance au-delà de ce que toute suite de tests peut fournir. Une interaction UI à essayer, une commande CLI à lancer, une requête API à envoyer, avec les résultats attendus pour chacune. + +Si la modification n'a aucun comportement visible par l'utilisateur, il le dit. Pas de travail inventé. + +### 5. Conclusion + +Le réviseur prend la décision : approuver, retravailler ou continuer la discussion. S'il approuve une PR, le workflow peut aider avec `gh pr review --approve`. S'il demande une refonte, il aide à diagnostiquer si le problème vient de l'approche, de la spécification ou de l'implémentation, et aide à rédiger un retour actionnable lié à des emplacements de code spécifiques. + +## C'est une conversation, pas un rapport + +Le workflow présente chaque étape comme un point de départ, pas un mot final. Entre les étapes — ou au milieu d'une — vous pouvez parler au LLM, poser des questions, remettre en question son cadrage ou faire appel à d'autres skills pour obtenir une perspective différente : + +- **« lance l'élicitation avancée sur la gestion des erreurs »** — pousse le LLM à reconsidérer et affiner son analyse d'un domaine spécifique +- **« active le party mode sur la sécurité de cette migration de schéma »** — fait intervenir plusieurs perspectives agentiques dans un débat ciblé +- **« lance la revue de code »** — génère des résultats structurés avec analyse adversariale et cas limites + +Le workflow checkpoint ne vous enferme pas dans un chemin linéaire. Il vous donne de la structure quand vous la souhaitez et s'efface quand vous voulez explorer. Les cinq étapes sont là pour s'assurer que vous voyez le tableau complet, mais la profondeur à laquelle vous allez à chaque étape — et les outils que vous y apportez — est entièrement entre vos mains. + +## L'historique de revue + +L'étape de visite guidée fonctionne mieux lorsqu'elle dispose d'un **ordre de revue suggéré** — une liste d'arrêts que l'auteur de la spécification a rédigée pour guider les réviseurs à travers la modification. Lorsqu'une spécification inclut cet ordre, le workflow l'utilise directement. + +Lorsqu'aucun historique produit par l'auteur n'existe, le workflow en génère un à partir du diff et du contexte de la base de code. Un historique généré est de qualité inférieure à un historique produit par l'auteur, mais nettement supérieur à la lecture des modifications dans l'ordre des fichiers. + +## Quand l'utiliser + +Le scénario principal est le passage de relais depuis `bmad-quick-dev` : l'implémentation est terminée, le fichier de spécification est ouvert dans votre éditeur avec un historique de revue ajouté, et vous devez décider si vous publiez. Dites « checkpoint » et c'est parti. + +Il fonctionne aussi de manière autonome : + +- **Revue d'une PR** — surtout celles avec plus de quelques fichiers ou des modifications transversales +- **Prise en main d'une modification** — quand vous devez comprendre ce qui s'est passé sur une branche que vous n'avez pas écrite +- **Revue de sprint** — le workflow peut récupérer les stories marquées `review` dans votre fichier de statut de sprint + +Invoquez-le en disant « checkpoint » ou « guide-moi à travers cette modification ». Il fonctionne dans n'importe quel terminal, mais vous en tirerez plus de parti dans un IDE — VS Code, Cursor ou similaire — car le workflow produit des références `chemin:ligne` à chaque étape. Dans un terminal intégré à un IDE, celles-ci sont cliquables, ce qui vous permet de sauter de fichier en fichier en suivant l'historique de revue. + +## Ce que ce n'est pas + +Checkpoint Preview ne remplace pas la revue automatisée. Il ne lance pas de linters, de vérificateurs de types ou de suites de tests. Il n'attribue pas de scores de sévérité et ne produit pas de verdicts pass/échec. C'est un guide de lecture qui aide un humain à appliquer son jugement là où cela compte le plus. diff --git a/docs/fr/explanation/established-projects-faq.md b/docs/fr/explanation/established-projects-faq.md index 94cd3d3a7..b95d41105 100644 --- a/docs/fr/explanation/established-projects-faq.md +++ b/docs/fr/explanation/established-projects-faq.md @@ -2,7 +2,7 @@ title: "FAQ Projets Existants" description: Questions courantes sur l'utilisation de la méthode BMad sur des projets existants sidebar: - order: 8 + order: 11 --- Réponses rapides aux questions courantes sur l'utilisation de la méthode BMad (BMM) sur des projets existants. diff --git a/docs/fr/explanation/party-mode.md b/docs/fr/explanation/party-mode.md index c1250aef2..7e9439447 100644 --- a/docs/fr/explanation/party-mode.md +++ b/docs/fr/explanation/party-mode.md @@ -2,7 +2,7 @@ title: "Party Mode" description: Collaboration multi-agents - regroupez tous vos agents IA dans une seule conversation sidebar: - order: 7 + order: 9 --- Regroupez tous vos agents IA dans une seule conversation. diff --git a/docs/fr/explanation/preventing-agent-conflicts.md b/docs/fr/explanation/preventing-agent-conflicts.md index 93d880308..e987d1cde 100644 --- a/docs/fr/explanation/preventing-agent-conflicts.md +++ b/docs/fr/explanation/preventing-agent-conflicts.md @@ -2,7 +2,7 @@ title: "Prévention des conflits entre agents" description: Comment l'architecture empêche les conflits lorsque plusieurs agents implémentent un système sidebar: - order: 4 + order: 6 --- Lorsque plusieurs agents IA implémentent différentes parties d'un système, ils peuvent prendre des décisions techniques contradictoires. La documentation d'architecture prévient cela en établissant des standards partagés. diff --git a/docs/fr/explanation/project-context.md b/docs/fr/explanation/project-context.md index 4888010fe..c1c3647f8 100644 --- a/docs/fr/explanation/project-context.md +++ b/docs/fr/explanation/project-context.md @@ -2,7 +2,7 @@ title: "Contexte du Projet" description: Comment project-context.md guide les agents IA avec les règles et préférences de votre projet sidebar: - order: 7 + order: 10 --- Le fichier `project-context.md` est le guide d'implémentation de votre projet pour les agents IA. Similaire à une « constitution » dans d'autres systèmes de développement, il capture les règles, les patterns et les préférences qui garantissent une génération de code cohérente à travers tous les workflows. diff --git a/docs/fr/explanation/quick-dev.md b/docs/fr/explanation/quick-dev.md index e45cd5d3c..2f64e4f66 100644 --- a/docs/fr/explanation/quick-dev.md +++ b/docs/fr/explanation/quick-dev.md @@ -2,7 +2,7 @@ title: "Quick Dev" description: Réduire la friction de l’interaction humaine sans renoncer aux points de contrôle qui protègent la qualité des résultats sidebar: - order: 2 + order: 3 --- Intention en entrée, modifications de code en sortie, avec aussi peu d'interactions humaines dans la boucle que possible — sans sacrifier la qualité. diff --git a/docs/fr/explanation/why-solutioning-matters.md b/docs/fr/explanation/why-solutioning-matters.md index fcd922aeb..515ab4007 100644 --- a/docs/fr/explanation/why-solutioning-matters.md +++ b/docs/fr/explanation/why-solutioning-matters.md @@ -2,7 +2,7 @@ title: "Pourquoi le Solutioning est Important" description: Comprendre pourquoi la phase de solutioning est critique pour les projets multi-epics sidebar: - order: 3 + order: 5 --- La Phase 3 (Solutioning) traduit le **quoi** construire (issu de la Planification) en **comment** le construire (conception technique). Cette phase évite les conflits entre agents dans les projets multi-epics en documentant les décisions architecturales avant le début de l'implémentation. diff --git a/docs/fr/how-to/customize-bmad.md b/docs/fr/how-to/customize-bmad.md index c8975cc55..76bb14502 100644 --- a/docs/fr/how-to/customize-bmad.md +++ b/docs/fr/how-to/customize-bmad.md @@ -58,7 +58,7 @@ Modifier la façon dont l'agent se présente : ```yaml agent: metadata: - name: 'Bob l’éponge' # Par défaut : "Mary" + name: 'Bob l’éponge' # Par défaut : "Amelia" ``` **Persona** diff --git a/docs/fr/how-to/get-answers-about-bmad.md b/docs/fr/how-to/get-answers-about-bmad.md index d2632b4aa..7e05e11d4 100644 --- a/docs/fr/how-to/get-answers-about-bmad.md +++ b/docs/fr/how-to/get-answers-about-bmad.md @@ -5,111 +5,55 @@ sidebar: order: 4 --- -## Commencez ici : BMad-Help +Utilisez l'aide intégrée de BMad, la documentation source ou la communauté pour obtenir des réponses — du plus rapide au plus approfondi. -**Le moyen le plus rapide d'obtenir des réponses sur BMad est le skill `bmad-help`.** Ce guide intelligent répondra à plus de 80 % de toutes les questions et est disponible directement dans votre IDE pendant que vous travaillez. +## 1. Demandez à BMad-Help -BMad-Help est bien plus qu'un outil de recherche — il : -- **Inspecte votre projet** pour voir ce qui a déjà été réalisé -- **Comprend le langage naturel** — posez vos questions en français courant -- **S'adapte à vos modules installés** — affiche les options pertinentes -- **Se lance automatiquement après les workflows** — vous indique exactement quoi faire ensuite -- **Recommande la première tâche requise** — plus besoin de deviner par où commencer - -### Comment utiliser BMad-Help - -Appelez-le par son nom dans votre session IA : +Le moyen le plus rapide d'obtenir des réponses. Le skill `bmad-help` est disponible directement dans votre session IA et répond à plus de 80 % des questions — il inspecte votre projet, voit ce que vous avez accompli et vous dit quoi faire ensuite. ``` -bmad-help +bmad-help J'ai une idée de SaaS et je connais toutes les fonctionnalités. Par où commencer ? +bmad-help Quelles sont mes options pour le design UX ? +bmad-help Je suis bloqué sur le workflow PRD ``` :::tip Vous pouvez également utiliser `/bmad-help` ou `$bmad-help` selon votre plateforme, mais `bmad-help` tout seul devrait fonctionner partout. ::: -Combinez-le avec une requête en langage naturel : +## 2. Approfondissez avec les sources -``` -bmad-help J'ai une idée de SaaS et je connais toutes les fonctionnalités. Par où commencer ? -bmad-help Quelles sont mes options pour le design UX ? -bmad-help Je suis bloqué sur le workflow PRD -bmad-help Montre-moi ce qui a été fait jusqu'à maintenant -``` +BMad-Help s'appuie sur votre configuration installée. Pour les questions sur les éléments internes de BMad, son historique ou son architecture — ou si vous faites des recherches sur BMad avant de l'installer — pointez votre IA directement vers les sources. -BMad-Help répond avec : -- Ce qui est recommandé pour votre situation -- Quelle est la première tâche requise -- À quoi ressemble le reste du processus - -## Quand utiliser ce guide - -Utilisez cette section lorsque : -- Vous souhaitez comprendre l'architecture ou les éléments internes de BMad -- Vous avez besoin de réponses au-delà de ce que BMad-Help fournit -- Vous faites des recherches sur BMad avant l'installation -- Vous souhaitez explorer le code source directement - -## Étapes - -### 1. Choisissez votre source - -| Source | Idéal pour | Exemples | -|-------------------------|------------------------------------------------------|---------------------------------------| -| **Dossier `_bmad`** | Comment fonctionne BMad — agents, workflows, prompts | "Que fait l'agent Analyste ?" | -| **Repo GitHub complet** | Historique, installateur, architecture | "Qu'est-ce qui a changé dans la v6 ?" | -| **`llms-full.txt`** | Aperçu rapide depuis la documentation | "Expliquez les quatre phases de BMad" | - -Le dossier `_bmad` est créé lorsque vous installez BMad. Si vous ne l'avez pas encore, clonez le repo à la place. - -### 2. Pointez votre IA vers la source - -**Si votre IA peut lire des fichiers (Claude Code, Cursor, etc.) :** - -- **BMad installé :** Pointez vers le dossier `_bmad` et posez vos questions directement -- **Vous voulez plus de contexte :** Clonez le [repo complet](https://github.com/bmad-code-org/BMAD-METHOD) - -**Si vous utilisez ChatGPT ou Claude.ai (LLM en ligne) :** - -Importez `llms-full.txt` dans votre session : - -```text -https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt -``` - - -### 3. Posez votre question +Clonez ou ouvrez le [dépôt BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) et posez vos questions à votre IA. Tout outil capable d'utiliser des agents (Claude Code, Cursor, Windsurf, etc.) peut lire les sources et répondre directement à vos questions. :::note[Exemple] **Q :** "Quel est le moyen le plus rapide de construire quelque chose avec BMad ?" -**R :** Utilisez le workflow Quick Dev : Lancez `bmad-quick-dev` — il clarifie votre intention, planifie, implémente, révise et présente les résultats dans un seul workflow, en sautant les phases de planification complètes. +**R :** Utilisez le flux rapide : Lancez `bmad-quick-dev` — il clarifie votre intention, planifie, implémente, révise et présente les résultats dans un seul workflow, en sautant les phases de planification complètes. ::: -## Ce que vous obtenez +**Conseils pour de meilleures réponses :** -Des réponses directes sur BMad — comment fonctionnent les agents, ce que font les workflows, pourquoi les choses sont structurées ainsi — sans attendre la réponse de quelqu'un. - -## Conseils - -- **Vérifiez les réponses surprenantes** — Les LLM font parfois des erreurs. Consultez le fichier source ou posez la question sur Discord. - **Soyez précis** — "Que fait l'étape 3 du workflow PRD ?" est mieux que "Comment fonctionne le PRD ?" +- **Vérifiez les affirmations surprenantes** — Les LLM font parfois des erreurs. Consultez le fichier source ou posez la question sur Discord. -## Toujours bloqué ? +### Vous n'utilisez pas d'agent ? Utilisez le site de documentation -Avez-vous essayé l'approche LLM et avez encore besoin d'aide ? Vous avez maintenant une bien meilleure question à poser. +Si votre IA ne peut pas lire des fichiers locaux (ChatGPT, Claude.ai, etc.), importez [llms-full.txt](https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt) dans votre session — c'est un instantané en un seul fichier de la documentation BMad. + +## 3. Demandez à quelqu'un + +Si ni BMad-Help ni la source n'ont répondu à votre question, vous avez maintenant une bien meilleure question à poser. | Canal | Utilisé pour | | ------------------------- | ------------------------------------------- | -| `#bmad-method-help` | Questions rapides (chat en temps réel) | -| Forum `help-requests` | Questions détaillées (recherchables, persistants) | +| Forum `help-requests` | Questions | | `#suggestions-feedback` | Idées et demandes de fonctionnalités | -| `#report-bugs-and-issues` | Rapports de bugs | **Discord :** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) -**GitHub Issues :** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (pour les bugs clairs) - +**GitHub Issues :** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) *Toi !* *Bloqué* *dans la file d'attente—* diff --git a/docs/fr/how-to/install-bmad.md b/docs/fr/how-to/install-bmad.md index 4f79743ea..c58f00c23 100644 --- a/docs/fr/how-to/install-bmad.md +++ b/docs/fr/how-to/install-bmad.md @@ -72,7 +72,7 @@ L'installateur affiche les modules disponibles. Sélectionnez ceux dont vous ave ### 5. Suivre les instructions -L'installateur vous guide pour le reste — contenu personnalisé, paramètres, etc. +L'installateur vous guide pour le reste — paramètres, intégrations d'outils, etc. ## Ce que vous obtenez diff --git a/docs/fr/how-to/non-interactive-installation.md b/docs/fr/how-to/non-interactive-installation.md index ee6ddad1c..87498285b 100644 --- a/docs/fr/how-to/non-interactive-installation.md +++ b/docs/fr/how-to/non-interactive-installation.md @@ -27,7 +27,6 @@ Nécessite [Node.js](https://nodejs.org) v20+ et `npx` (inclus avec npm). | `--directory ` | Répertoire d'installation | `--directory ~/projects/myapp` | | `--modules ` | IDs de modules séparés par des virgules | `--modules bmm,bmb` | | `--tools ` | IDs d'outils/IDE séparés par des virgules (utilisez `none` pour ignorer) | `--tools claude-code,cursor` ou `--tools none` | -| `--custom-content ` | Chemins vers des modules personnalisés séparés par des virgules | `--custom-content ~/my-module,~/another-module` | | `--action ` | Action pour les installations existantes : `install` (par défaut), `update`, ou `quick-update` | `--action quick-update` | ### Configuration principale @@ -120,16 +119,6 @@ npx bmad-method install \ --action quick-update ``` -### Installation avec du contenu personnalisé - -```bash -npx bmad-method install \ - --directory ~/projects/myapp \ - --modules bmm \ - --custom-content ~/my-custom-module,~/another-module \ - --tools claude-code -``` - ## Ce que vous obtenez - Un répertoire `_bmad/` entièrement configuré dans votre projet @@ -143,12 +132,11 @@ BMad valide toutes les options fournis : - **Directory** — Doit être un chemin valide avec des permissions d'écriture - **Modules** — Avertit des IDs de modules invalides (mais n'échoue pas) - **Tools** — Avertit des IDs d'outils invalides (mais n'échoue pas) -- **Custom Content** — Chaque chemin doit contenir un fichier `module.yaml` valide - **Action** — Doit être l'une des suivantes : `install`, `update`, `quick-update` Les valeurs invalides entraîneront soit : 1. L’affichage d’un message d'erreur suivi d’un exit (pour les options critiques comme le répertoire) -2. Un avertissement puis la continuation de l’installation (pour les éléments optionnels comme le contenu personnalisé) +2. Un avertissement puis la continuation de l’installation (pour les éléments optionnels) 3. Un retour aux invites interactives (pour les valeurs requises manquantes) :::tip[Bonnes pratiques] @@ -172,13 +160,6 @@ Les valeurs invalides entraîneront soit : - Vérifiez que l'ID du module est correct - Les modules externes doivent être disponibles dans le registre -### Chemin de contenu personnalisé invalide - -Assurez-vous que chaque chemin de contenu personnalisé : -- Pointe vers un répertoire -- Contient un fichier `module.yaml` à la racine -- Possède un champ `code` dans `module.yaml` - :::note[Toujours bloqué ?] Exécutez avec `--debug` pour une sortie détaillée, essayez le mode interactif pour isoler le problème, ou signalez-le à . ::: diff --git a/docs/fr/how-to/upgrade-to-v6.md b/docs/fr/how-to/upgrade-to-v6.md index 6468dc729..bd600cbcb 100644 --- a/docs/fr/how-to/upgrade-to-v6.md +++ b/docs/fr/how-to/upgrade-to-v6.md @@ -61,8 +61,8 @@ Si vous avez des stories[^3] créées ou implémentées : 1. Terminez l'installation v6 2. Placez `epics.md` ou `epics/epic*.md`[^2] dans `_bmad-output/planning-artifacts/` -3. Lancez le workflow `bmad-sprint-planning`[^4] -4. Indiquez quels epics/stories sont déjà terminés +3. Lancez le workflow Développeur `bmad-sprint-planning`[^4] +4. Indiquez à l’agent quels epics/stories sont déjà terminés ## Ce que vous obtenez diff --git a/docs/fr/reference/agents.md b/docs/fr/reference/agents.md index fa77911d2..2d6248dba 100644 --- a/docs/fr/reference/agents.md +++ b/docs/fr/reference/agents.md @@ -1,27 +1,28 @@ --- title: Agents -description: Agents BMM par défaut avec leurs identifiants de skill, déclencheurs de menu et workflows principaux (Analyst, Developer, Architect, UX Designer, Technical Writer) +description: Agents BMM par défaut avec leurs identifiants de skill, déclencheurs de menu et workflows principaux sidebar: order: 2 --- ## Agents par défaut -Cette page liste les cinq agents BMM (suite Agile) par défaut installés avec la méthode BMad, ainsi que leurs identifiants de skill, déclencheurs de menu et workflows principaux. Chaque agent est invoqué en tant que skill. +Cette page liste les agents BMM (suite Agile) par défaut installés avec la méthode BMad, ainsi que leurs identifiants de skill, déclencheurs de menu et workflows principaux. Chaque agent est invoqué en tant que skill. ## Notes -- Chaque agent est disponible en tant que skill, généré par l’installateur. L’identifiant de skill (par exemple, `bmad-analyst`) est utilisé pour invoquer l’agent. +- Chaque agent est disponible en tant que skill, généré par l’installateur. L’identifiant de skill (par exemple, `bmad-dev`) est utilisé pour invoquer l’agent. - Les déclencheurs sont les codes courts de menu (par exemple, `BP`) et les correspondances approximatives affichés dans chaque menu d’agent. -- La génération de tests QA est gérée par le skill de workflow `bmad-qa-generate-e2e-tests`. L’architecte de tests complet (TEA) se trouve dans son propre module. +- La génération de tests QA est gérée par le skill de workflow `bmad-qa-generate-e2e-tests`, disponible par l’agent Développeur. L’architecte de tests complet (TEA) se trouve dans son propre module. -| Agent | Identifiant de skill | Déclencheurs | Workflows principaux | -|------------------------|----------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Analyste (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `DP` | Brainstorming du projet, Recherche marché/domaine/technique, Création du brief[^1], Documentation du projet | -| Architecte (Winston) | `bmad-architect` | `CA`, `IR` | Créer l’architecture, Préparation à l’implémentation | -| Développeur (Amelia) | `bmad-dev` | `DS`, `QD`, `CR` | Dev Story, Quick Dev, Code Review | -| Designer UX (Sally) | `bmad-ux-designer` | `CU` | Création du design UX[^2] | -| Rédacteur Technique (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Documentation du projet, Rédaction de documents, Mise à jour des standards, Génération de diagrammes Mermaid, Validation de documents, Explication de concepts | +| Agent | Identifiant de skill | Déclencheurs | Workflows principaux | +|-----------------------------|----------------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Analyste (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorming du projet, Recherche marché/domaine/technique, Création du brief[^1], Défi PRFAQ, Documentation du projet | +| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Créer/Valider/Éditer un PRD, Créer des Epics et Stories, vérifier l’état de préparation à l’Implémentation, Corriger le Cours | +| Architecte (Winston) | `bmad-architect` | `CA`, `IR` | Créer l’architecture, Préparation à l’implémentation | +| Développeur (Amelia) | `bmad-agent-dev` | `DS`, `QD`, `QA`, `CR`, `SP`, `CS`, `ER` | Dev Story, Quick Dev, Génération de Tests QA, Code Review, Sprint Planning, Créer Story, Rétrospective d’Epic | +| Designer UX (Sally) | `bmad-ux-designer` | `CU` | Création du design UX[^2] | +| Rédacteur Technique (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Documentation du projet, Rédaction de documents, Mise à jour des standards, Génération de diagrammes Mermaid, Validation de documents, Explication de concepts | ## Types de déclencheurs @@ -31,7 +32,7 @@ Les déclencheurs de menu d'agent utilisent deux types d'invocation différents. La plupart des déclencheurs chargent un fichier de workflow structuré. Tapez le code du déclencheur et l'agent démarre le workflow, vous demandant de saisir les informations à chaque étape. -Exemples : `BP` (Brainstorm Project), `CA` (Create Architecture), `CU` (Create UX Design) +Exemples : `CP` (Create PRD), `DS` (Dev Story), `CA` (Create Architecture), `QD` (Quick Dev) ### Déclencheurs conversationnels (arguments requis) diff --git a/docs/fr/reference/commands.md b/docs/fr/reference/commands.md index 1048976da..a93f331b9 100644 --- a/docs/fr/reference/commands.md +++ b/docs/fr/reference/commands.md @@ -2,7 +2,7 @@ title: Skills description: Référence des skills BMad — ce qu'ils sont, comment ils fonctionnent et où les trouver. sidebar: - order: 3 + order: 4 --- Les skills sont des prompts pré-construits qui chargent des agents, exécutent des workflows ou lancent des tâches dans votre IDE. L'installateur BMad les génère à partir de vos modules installés au moment de l'installation. Si vous ajoutez, supprimez ou modifiez des modules ultérieurement, relancez l'installateur pour garder les skills synchronisés (voir [Dépannage](#dépannage)). @@ -54,12 +54,12 @@ Chaque skill est un répertoire contenant un fichier `SKILL.md`. Par exemple, un │ └── SKILL.md ├── bmad-create-prd/ │ └── SKILL.md -├── bmad-analyst/ +├── bmad-agent-dev/ │ └── SKILL.md └── ... ``` -Le nom du répertoire détermine le nom du skill dans votre IDE. Par exemple, le répertoire `bmad-analyst/` enregistre le skill `bmad-analyst`. +Le nom du répertoire détermine le nom du skill dans votre IDE. Par exemple, le répertoire `bmad-agent-dev/` enregistre le skill `bmad-agent-dev`. ## Comment découvrir vos skills @@ -75,23 +75,24 @@ Les répertoires de skills générés dans votre projet sont la liste de référ ### Skills d'agent -Les skills d'agent chargent une persona[^2] IA spécialisée avec un rôle défini, un style de communication et un menu de workflows. Une fois chargé, l'agent reste en caractère et répond aux déclencheurs du menu. +Les skills d'agent chargent un persona[^2] IA spécialisé avec un rôle défini, un style de communication et un menu de workflows. Une fois chargé, l'agent reste en caractère et répond aux déclencheurs du menu. -| Exemple de skill | Agent | Rôle | -| --- | --- | --- | -| `bmad-analyst` | Mary (Analyste) | Brainstorming de projets, recherche, création de briefs | -| `bmad-architect` | Winston (Architecte) | Conçoit l'architecture système | -| `bmad-ux-designer` | Sally (Designer UX) | Crée les designs UX | -| `bmad-tech-writer` | Paige (Rédacteur Technique) | Documente les projets, rédige des guides, génère des diagrammes | +| Exemple de skill | Agent | Rôle | +|------------------|------------------------|-------------------------------------------------------------| +| `bmad-agent-dev` | Amelia (Développeur) | Implémente les stories avec une adhérence stricte aux specs | +| `bmad-pm` | John (Product Manager) | Crée et valide les PRDs[^1] | +| `bmad-architect` | Winston (Architecte) | Conçoit l'architecture système | Consultez [Agents](./agents.md) pour la liste complète des agents par défaut et leurs déclencheurs. ### Skills de workflow -Les skills de workflow exécutent un processus structuré en plusieurs étapes sans charger d'abord une persona d'agent. Ils chargent une configuration de workflow et suivent ses étapes. +Les skills de workflow exécutent un processus structuré en plusieurs étapes sans charger d'abord un persona d'agent. Ils chargent une configuration de workflow et suivent ses étapes. | Exemple de skill | Objectif | | --- | --- | +| `bmad-product-brief` | Créer un product brief[^3] — découverte guidée lorsque votre concept est clair | +| `bmad-prfaq` | Défi [PRFAQ Working Backwards](../explanation/analysis-phase.md#prfaq-working-backwards) pour éprouver votre concept produit | | `bmad-create-prd` | Créer un PRD[^1] | | `bmad-create-architecture` | Concevoir l'architecture système | | `bmad-create-epics-and-stories` | Créer des epics et des stories | @@ -123,7 +124,7 @@ Le module principal inclut 11 outils intégrés — revues, compression, brainst ## Convention de nommage -Tous les skills utilisent le préfixe `bmad-` suivi d'un nom descriptif (ex. `bmad-analyst`, `bmad-create-prd`, `bmad-help`). Consultez [Modules](./modules.md) pour les modules disponibles. +Tous les skills utilisent le préfixe `bmad-` suivi d'un nom descriptif (ex. `bmad-agent-dev`, `bmad-create-prd`, `bmad-help`). Consultez [Modules](./modules.md) pour les modules disponibles. ## Dépannage @@ -136,4 +137,5 @@ Tous les skills utilisent le préfixe `bmad-` suivi d'un nom descriptif (ex. `bm ## Glossaire [^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d’aligner les équipes sur ce qui doit être construit et pourquoi. -[^2]: Persona : dans le contexte de BMad, une persona désigne un agent IA avec un rôle défini, un style de communication et une expertise spécifiques (ex. Mary l'analyste, Winston l'architecte). Chaque persona garde son "caractère" pendant les interactions. +[^2]: Persona : dans le contexte de BMad, un persona désigne un agent IA avec un rôle défini, un style de communication et une expertise spécifiques (ex. Mary l'analyste, Winston l'architecte). Chaque persona garde son "caractère" pendant les interactions. +[^3]: Brief : document synthétique qui formalise le contexte, les objectifs, le périmètre et les contraintes d'un projet ou d'une demande, afin d'aligner rapidement les parties prenantes avant le travail détaillé. diff --git a/docs/fr/reference/core-tools.md b/docs/fr/reference/core-tools.md index 808b4c3bd..644a849fc 100644 --- a/docs/fr/reference/core-tools.md +++ b/docs/fr/reference/core-tools.md @@ -2,7 +2,7 @@ title: Outils Principaux description: Référence pour toutes les tâches et tous les workflows intégrés disponibles dans chaque installation BMad sans modules supplémentaires. sidebar: - order: 2 + order: 3 --- Chaque installation BMad comprend un ensemble de compétences principales qui peuvent être utilisées conjointement avec tout ce que vous faites — des tâches et des workflows autonomes qui fonctionnent dans tous les projets, tous les modules et toutes les phases. Ceux-ci sont toujours disponibles, quels que soient les modules optionnels que vous installez. diff --git a/docs/fr/reference/modules.md b/docs/fr/reference/modules.md index 8c0ae8126..60f7e7e4c 100644 --- a/docs/fr/reference/modules.md +++ b/docs/fr/reference/modules.md @@ -2,7 +2,7 @@ title: Modules Officiels description: Modules additionnels pour créer des agents personnalisés, de l'intelligence créative, du développement de jeux et des tests sidebar: - order: 4 + order: 5 --- BMad s'étend via des modules officiels que vous sélectionnez lors de l'installation. Ces modules additionnels fournissent des agents, des workflows et des tâches spécialisés pour des domaines spécifiques, au-delà du noyau intégré et de BMM (suite Agile). diff --git a/docs/fr/reference/testing.md b/docs/fr/reference/testing.md index effd4174e..d0d762691 100644 --- a/docs/fr/reference/testing.md +++ b/docs/fr/reference/testing.md @@ -2,7 +2,7 @@ title: Options de Testing description: Comparaison du workflow QA intégré avec le module Test Architect (TEA) pour l'automatisation des tests. sidebar: - order: 5 + order: 6 --- BMad propose deux approches de test : un workflow QA[^1] intégré pour une génération rapide de tests et un module Test Architect installable pour une stratégie de test de qualité entreprise. diff --git a/docs/fr/reference/workflow-map.md b/docs/fr/reference/workflow-map.md index 50821c6fd..1a72e2618 100644 --- a/docs/fr/reference/workflow-map.md +++ b/docs/fr/reference/workflow-map.md @@ -21,13 +21,14 @@ Note finale importante : Chaque workflow ci-dessous peut être exécuté directe ## Phase 1 : Analyse (Optionnelle) -Explorez l’espace problème et validez les idées avant de vous engager dans la planification. +Explorez l’espace problème et validez les idées avant de vous engager dans la planification. [**Découvrez ce que fait chaque outil et quand l’utiliser**](../explanation/analysis-phase.md). | Workflow | Objectif | Produit | |---------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------------| -| `bmad-brainstorming` | Brainstormez des idées de projet avec l'accompagnement guidé d'un coach de brainstorming | `brainstorming-report.md` | +| `bmad-brainstorming` | Brainstormez des idées de projet avec l’accompagnement guidé d’un coach de brainstorming | `brainstorming-report.md` | | `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Validez les hypothèses de marché, techniques ou de domaine | Rapport de recherches | -| `bmad-create-product-brief` | Capturez la vision stratégique | `product-brief.md` | +| `bmad-product-brief` | Capturez la vision stratégique — idéal lorsque votre concept est clair | `product-brief.md` | +| `bmad-prfaq` | Working Backwards — éprouvez et forgez votre concept produit | `prfaq-{project}.md` | ## Phase 2 : Planification diff --git a/docs/fr/tutorials/getting-started.md b/docs/fr/tutorials/getting-started.md index 70d6e3095..8d729debf 100644 --- a/docs/fr/tutorials/getting-started.md +++ b/docs/fr/tutorials/getting-started.md @@ -68,7 +68,7 @@ BMad vous aide à construire des logiciels grâce à des workflows guidés avec | Phase | Nom | Ce qui se passe | |-------|----------------|----------------------------------------------------------------| -| 1 | Analyse | Brainstorming, recherche, product brief *(optionnel)* | +| 1 | Analyse | Brainstorming, recherche, product brief ou PRFAQ *(optionnel)* | | 2 | Planification | Créer les exigences (PRD[^1] ou spécification technique) | | 3 | Solutioning | Concevoir l'architecture *(BMad Method/Enterprise uniquement)* | | 4 | Implémentation | Construire epic[^2] par epic, story[^3] par story | @@ -114,7 +114,7 @@ BMad-Help détectera ce que vous avez accompli et recommandera exactement quoi f ::: :::note[Comment charger les agents et exécuter les workflows] -Chaque workflow possède une **skill** que vous invoquez par nom dans votre IDE (par ex., `bmad-create-prd`). Votre outil IA reconnaîtra le nom `bmad-*` et l'exécutera. +Chaque workflow possède une **skill** que vous invoquez par nom dans votre IDE (par ex., `bmad-create-prd`). Votre outil IA reconnaîtra le nom `bmad-*` et l'exécutera — vous n'avez pas besoin de charger les agents séparément. Vous pouvez aussi invoquer directement une skill d'agent pour une conversation générale (par ex., `bmad-agent-pm` pour l'agent PM). ::: :::caution[Nouveaux chats] @@ -133,29 +133,32 @@ Créez-le manuellement dans `_bmad-output/project-context.md` ou générez-le ap ### Phase 1 : Analyse (Optionnel) -Tous les workflows de cette phase sont optionnels : +Tous les workflows de cette phase sont optionnels. [**Pas sûr de quel outil utiliser ?**](../explanation/analysis-phase.md) - **brainstorming** (`bmad-brainstorming`) — Idéation guidée - **research** (`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research`) — Recherche marché, domaine et technique -- **create-product-brief** (`bmad-create-product-brief`) — Document de base recommandé +- **product-brief** (`bmad-product-brief`) — Document de base recommandé lorsque votre concept est clair +- **prfaq** (`bmad-prfaq`) — Défi Working Backwards pour éprouver et forger votre concept produit ### Phase 2 : Planification (Requis) **Pour les voies BMad Method et Enterprise :** -1. Exécutez `bmad-create-prd` dans un nouveau chat -2. Sortie : `PRD.md` +1. Invoquez l'**agent PM** (`bmad-agent-pm`) dans un nouveau chat +2. Exécutez le workflow `bmad-create-prd` (`bmad-create-prd`) +3. Sortie : `PRD.md` **Pour la voie Quick Dev :** -- Utilisez le workflow `bmad-quick-dev` (`bmad-quick-dev`) à la place du PRD, puis passez à l'implémentation +- Exécutez `bmad-quick-dev` — il gère la planification et l'implémentation dans un seul workflow, passez directement à l'implémentation :::note[Design UX (Optionnel)] -Si votre projet a une interface utilisateur, exécutez le workflow de design UX (`bmad-create-ux-design`) après avoir créé votre PRD. +Si votre projet a une interface utilisateur, invoquez l'**agent Designer UX** (`bmad-agent-ux-designer`) et exécutez le workflow de design UX (`bmad-create-ux-design`) après avoir créé votre PRD. ::: ### Phase 3 : Solutioning (méthode BMad/Enterprise) **Créer l'Architecture** -1. Exécutez `bmad-create-architecture` dans un nouveau chat -2. Sortie : Document d'architecture avec les décisions techniques +1. Invoquez l'**agent Architecte** (`bmad-agent-architect`) dans un nouveau chat +2. Exécutez `bmad-create-architecture` (`bmad-create-architecture`) +3. Sortie : Document d'architecture avec les décisions techniques **Créer les Epics et Stories** @@ -163,12 +166,14 @@ Si votre projet a une interface utilisateur, exécutez le workflow de design UX Les epics et stories sont maintenant créés *après* l'architecture. Cela produit des stories de meilleure qualité car les décisions d'architecture (base de données, patterns d'API, pile technologique) affectent directement la façon dont le travail doit être décomposé. ::: -1. Exécutez `bmad-create-epics-and-stories` dans un nouveau chat -2. Le workflow utilise à la fois le PRD et l'Architecture pour créer des stories techniquement éclairées +1. Invoquez l'**agent PM** (`bmad-agent-pm`) dans un nouveau chat +2. Exécutez `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`) +3. Le workflow utilise à la fois le PRD et l'Architecture pour créer des stories techniquement éclairées **Vérification de préparation à l'implémentation** *(Hautement recommandé)* -1. Exécutez `bmad-check-implementation-readiness` dans un nouveau chat -2. Valide la cohérence entre tous les documents de planification +1. Invoquez l'**agent Architecte** (`bmad-agent-architect`) dans un nouveau chat +2. Exécutez `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`) +3. Valide la cohérence entre tous les documents de planification ## Étape 2 : Construire votre projet @@ -176,19 +181,19 @@ Une fois la planification terminée, passez à l'implémentation. **Chaque workf ### Initialiser la planification de sprint -Exécutez `bmad-sprint-planning` dans un nouveau chat. Cela crée `sprint-status.yaml` pour suivre tous les epics et stories. +Invoquez **l’agent Développeur** (`bmad-agent-dev`) et lancez `bmad-sprint-planning`. Cela crée `sprint-status.yaml` pour suivre tous les epics et stories. ### Le cycle de construction Pour chaque story, répétez ce cycle avec de nouveaux chats : -| Étape | Workflow | Commande | Objectif | -| ----- | --------------------- | --------------------- | ----------------------------------- | -| 1 | `bmad-create-story` | `bmad-create-story` | Créer le fichier story depuis l'epic | -| 2 | `bmad-dev-story` | `bmad-dev-story` | Implémenter la story | -| 3 | `bmad-code-review` | `bmad-code-review` | Validation de qualité *(recommandé)* | +| Étape | AGENT | Workflow | Commande | Objectif | +|-------|-------|---------------------|---------------------|--------------------------------------| +| 1 | DEV | `bmad-create-story` | `bmad-create-story` | Créer le fichier story depuis l'epic | +| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implémenter la story | +| 3 | DEV | `bmad-code-review` | `bmad-code-review` | Validation de qualité *(recommandé)* | -Après avoir terminé toutes les stories d'un epic, exécutez `bmad-retrospective` dans un nouveau chat. +Après avoir terminé toutes les stories d'un epic, invoquez **l’agent Développeur** (`bmad-agent-dev`), et exécutez `bmad-retrospective`. ## Ce que vous avez accompli @@ -217,18 +222,18 @@ your-project/ ## Référence rapide -| Workflow | Commande | Objectif | -| ------------------------------------- | ------------------------------------------- | ------------------------------------------------ | -| **`bmad-help`** ⭐ | `bmad-help` | **Votre guide intelligent — posez n'importe quelle question !** | -| `bmad-create-prd` | `bmad-create-prd` | Créer le document d'exigences produit | -| `bmad-create-architecture` | `bmad-create-architecture` | Créer le document d'architecture | -| `bmad-generate-project-context` | `bmad-generate-project-context` | Créer le fichier de contexte projet | -| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | Décomposer le PRD en epics | -| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Valider la cohérence de planification | -| `bmad-sprint-planning` | `bmad-sprint-planning` | Initialiser le suivi de sprint | -| `bmad-create-story` | `bmad-create-story` | Créer un fichier story | -| `bmad-dev-story` | `bmad-dev-story` | Implémenter une story | -| `bmad-code-review` | `bmad-code-review` | Revoir le code implémenté | +| Workflow | Commande | Agent | Objectif | +|---------------------------------------|---------------------------------------|-----------|-----------------------------------------------------------------| +| **`bmad-help`** ⭐ | `bmad-help` | Tous | **Votre guide intelligent — posez n'importe quelle question !** | +| `bmad-create-prd` | `bmad-create-prd` | PM | Créer le document d'exigences produit | +| `bmad-create-architecture` | `bmad-create-architecture` | Architect | Créer le document d'architecture | +| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | Créer le fichier de contexte projet | +| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | Décomposer le PRD en epics | +| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Architect | Valider la cohérence de planification | +| `bmad-sprint-planning` | `bmad-sprint-planning` | DEV | Initialiser le suivi de sprint | +| `bmad-create-story` | `bmad-create-story` | DEV | Créer un fichier story | +| `bmad-dev-story` | `bmad-dev-story` | DEV | Implémenter une story | +| `bmad-code-review` | `bmad-code-review` | DEV | Revoir le code implémenté | ## Questions fréquentes @@ -236,7 +241,7 @@ your-project/ Uniquement pour les voies méthode BMad et Enterprise. Quick Dev passe directement de la spécification technique (spec) à l'implémentation. **Puis-je modifier mon plan plus tard ?** -Oui. Utilisez `bmad-correct-course` pour gérer les changements de périmètre. +Oui. Utilisez `bmad-correct-course` pour gérer les changements de périmètre en cours d’implémentation. **Et si je veux d'abord faire du brainstorming ?** Invoquez l'agent Analyst (`bmad-agent-analyst`) et exécutez `bmad-brainstorming` (`bmad-brainstorming`) avant de commencer votre PRD. diff --git a/docs/how-to/customize-bmad.md b/docs/how-to/customize-bmad.md index 15832df89..9433a8820 100644 --- a/docs/how-to/customize-bmad.md +++ b/docs/how-to/customize-bmad.md @@ -1,171 +1,395 @@ --- -title: "How to Customize BMad" -description: Customize agents, workflows, and modules while preserving update compatibility +title: 'How to Customize BMad' +description: Customize agents and workflows while preserving update compatibility sidebar: - order: 7 + order: 8 --- -Use the `.customize.yaml` files to tailor agent behavior, personas, and menus while preserving your changes across updates. +Tailor agent personas, inject domain context, add capabilities, and configure workflow behavior -- all without modifying installed files. Your customizations survive every update. + +:::tip[Don't want to hand-author TOML? Use `bmad-customize`] +The `bmad-customize` skill is a guided authoring helper for the **per-skill agent/workflow override surface** described in this doc. It scans what's customizable in your installation, helps you choose the right surface (agent vs workflow) for your intent, writes the override file for you, and verifies the merge landed. Central-config overrides (`_bmad/custom/config.toml`) are out of scope for v1 — hand-author those per the Central Configuration section below. Run the skill whenever you want to make a per-skill change; this doc is the reference for *what* each surface exposes and how merging works. +::: ## When to Use This -- You want to change an agent's name, personality, or communication style -- You need agents to remember project-specific context -- You want to add custom menu items that trigger your own workflows or prompts -- You want agents to perform specific actions every time they start up +- You want to change an agent's personality or communication style +- You need to give an agent persistent facts to recall (e.g. "our org is AWS-only") +- You want to add procedural startup steps the agent must run every session +- You want to add custom menu items that trigger your own skills or prompts +- Your team needs shared customizations committed to git, with personal preferences layered on top :::note[Prerequisites] + - BMad installed in your project (see [How to Install BMad](./install-bmad.md)) -- A text editor for YAML files +- Python 3.11+ on your PATH (for the resolver script -- uses stdlib `tomllib`, no `pip install`, no `uv`, no virtualenv) +- A text editor for TOML files ::: -:::caution[Keep Your Customizations Safe] -Always use the `.customize.yaml` files described here rather than editing agent files directly. The installer overwrites agent files during updates, but preserves your `.customize.yaml` changes. -::: +## How It Works + +Every customizable skill ships a `customize.toml` file with its defaults. This file defines the skill's complete customization surface -- read it to see what's customizable. You never edit this file. Instead, you create sparse override files containing only the fields you want to change. + +### Three-Layer Override Model + +```text +Priority 1 (wins): _bmad/custom/{skill-name}.user.toml (personal, gitignored) +Priority 2: _bmad/custom/{skill-name}.toml (team/org, committed) +Priority 3 (last): skill's own customize.toml (defaults) +``` + +The `_bmad/custom/` folder starts empty. Files only appear when someone actively customizes. + +### Merge Rules (by shape, not by field name) + +The resolver applies four structural rules. Field names are never special-cased — behavior is determined purely by the value's shape: + +| Shape | Rule | +|---|---| +| Scalar (string, int, bool, float) | Override wins | +| Table | Deep merge (recursively apply these rules) | +| Array of tables where every item shares the **same** identifier field (every item has `code`, or every item has `id`) | Merge by that key — matching keys **replace in place**, new keys **append** | +| Any other array (scalars; tables with no identifier; arrays that mix `code` and `id` across items) | **Append** — base items first, then team items, then user items | + +**No removal mechanism.** Overrides cannot delete base items. If you need to suppress a default menu item, override it by `code` with a no-op description or prompt. If you need to restructure an array more deeply, fork the skill. + +**The `code` / `id` convention.** BMad uses `code` (short identifier like `"BP"` or `"R1"`) and `id` (longer stable identifier) as merge keys on arrays of tables. If you author a custom array-of-tables that should be replaceable-by-key rather than append-only, pick **one** convention (either `code` on every item, or `id` on every item) and stick with it across the whole array. Mixing `code` on some items and `id` on others falls back to append — the resolver won't guess which key to merge on. + +### Some agent fields are read-only + +`agent.name` and `agent.title` live in `customize.toml` as source-of-truth metadata, but the agent's SKILL.md doesn't read them at runtime — they're hardcoded identity. Putting `name = "Bob"` in an override file has no effect. If you genuinely need a different-named agent, copy the skill folder, rename it, and ship it as a custom skill. ## Steps -### 1. Locate Customization Files +### 1. Find the Skill's Customization Surface -After installation, find one `.customize.yaml` file per agent in: +Look at the skill's `customize.toml` in its installed directory. For example, the PM agent: ```text -_bmad/_config/agents/ -├── core-bmad-master.customize.yaml -├── bmm-dev.customize.yaml -├── bmm-pm.customize.yaml -└── ... (one file per installed agent) +.claude/skills/bmad-agent-pm/customize.toml ``` -### 2. Edit the Customization File +(Path varies by IDE -- Cursor uses `.cursor/skills/`, Cline uses `.cline/skills/`, and so on.) -Open the `.customize.yaml` file for the agent you want to modify. Every section is optional -- customize only what you need. +This file is the canonical schema. Every field you see is customizable (excluding the read-only identity fields noted above). -| Section | Behavior | Purpose | -| ------------------ | -------- | ----------------------------------------------- | -| `agent.metadata` | Replaces | Override the agent's display name | -| `persona` | Replaces | Set role, identity, style, and principles | -| `memories` | Appends | Add persistent context the agent always recalls | -| `menu` | Appends | Add custom menu items for workflows or prompts | -| `critical_actions` | Appends | Define startup instructions for the agent | -| `prompts` | Appends | Create reusable prompts for menu actions | +### 2. Create Your Override File -Sections marked **Replaces** overwrite the agent's defaults entirely. Sections marked **Appends** add to the existing configuration. +Create the `_bmad/custom/` directory in your project root if it doesn't exist. Then create a file named after the skill: -**Agent Name** - -Change how the agent introduces itself: - -```yaml -agent: - metadata: - name: 'Spongebob' # Default: "Amelia" +```text +_bmad/custom/ + bmad-agent-pm.toml # team overrides (committed to git) + bmad-agent-pm.user.toml # personal preferences (gitignored) ``` -**Persona** +:::caution[Do NOT copy the whole `customize.toml`] +Override files are **sparse**. Include only the fields you're changing — nothing else. Every field you omit is inherited automatically from the layer below (team from defaults, user from team-or-defaults). -Replace the agent's personality, role, and communication style: +Copying the full `customize.toml` into an override is actively harmful: the next update ships new defaults, but your override file locks in the old values. You'll silently drift out of sync with every release. +::: -```yaml -persona: - role: 'Senior Full-Stack Engineer' - identity: 'Lives in a pineapple (under the sea)' - communication_style: 'Spongebob annoying' - principles: - - 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep' - - 'Favor composition over inheritance' +**Example — changing the icon and adding one principle**: + +```toml +# _bmad/custom/bmad-agent-pm.toml +# Just the fields I'm changing. Everything else inherits. + +[agent] +icon = "🏥" +principles = [ + "Ship nothing that can't pass an FDA audit.", +] ``` -The `persona` section replaces the entire default persona, so include all four fields if you set it. +This appends the new principle to the defaults (leaving the shipped principles intact) and replaces the icon. Every other field stays as shipped. -**Memories** +### 3. Customize What You Need -Add persistent context the agent will always remember: +All examples below assume BMad's flat agent schema. Fields live directly under `[agent]` — no nested `metadata` or `persona` sub-tables. -```yaml -memories: - - 'Works at Krusty Krab' - - 'Favorite Celebrity: David Hasselhoff' - - 'Learned in Epic 1 that it is not cool to just pretend that tests have passed' +**Scalars (icon, role, identity, communication_style).** Scalar overrides win. You only need to set the fields you're changing: + +```toml +# _bmad/custom/bmad-agent-pm.toml + +[agent] +icon = "🏥" +role = "Drives product discovery for a regulated healthcare domain." +communication_style = "Precise, regulatory-aware, asks compliance-shaped questions early." ``` -**Menu Items** +**Persistent facts, principles, activation hooks (append arrays).** All four arrays below are append-only. Team items run after defaults, user items run last. -Add custom entries to the agent's display menu. Each item needs a `trigger`, a target (`workflow` path or `action` reference), and a `description`: +```toml +[agent] +# Static facts the agent keeps in mind the whole session — org rules, domain +# constants, user preferences. Distinct from the runtime memory sidecar. +# +# Each entry is either a literal sentence, or a `file:` reference whose +# contents are loaded as facts (glob patterns supported). +persistent_facts = [ + "Our org is AWS-only -- do not propose GCP or Azure.", + "All PRDs require legal sign-off before engineering kickoff.", + "Target users are clinicians, not patients -- frame examples accordingly.", + "file:{project-root}/docs/compliance/hipaa-overview.md", + "file:{project-root}/_bmad/custom/company-glossary.md", +] -```yaml -menu: - - trigger: my-workflow - workflow: 'my-custom/workflows/my-workflow.yaml' - description: My custom workflow - - trigger: deploy - action: '#deploy-prompt' - description: Deploy to production +# Adds to the agent's value system +principles = [ + "Ship nothing that can't pass an FDA audit.", + "User value first, compliance always.", +] + +# Runs BEFORE the standard activation (persona, persistent_facts, config, greet). +# Use for pre-flight loads, compliance checks, anything that needs to be in +# context before the agent introduces itself. +activation_steps_prepend = [ + "Scan {project-root}/docs/compliance/ and load any HIPAA-related documents as context.", +] + +# Runs AFTER greet, BEFORE the menu. Use for context-heavy setup that should +# happen once the user has been acknowledged. +activation_steps_append = [ + "Read {project-root}/_bmad/custom/company-glossary.md if it exists.", +] ``` -**Critical Actions** +**The two hooks do different jobs.** Prepend runs before greeting so the agent can load context it needs to personalize the greeting itself. Append runs after greeting so the user isn't staring at a blank terminal while heavy scans complete. -Define instructions that run when the agent starts up: +**Menu customization (merge by `code`).** The menu is an array of tables. Each item has a `code` field (BMad convention), so the resolver merges by code: matching codes replace in place, new codes append. -```yaml -critical_actions: - - 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention' +TOML array-of-tables syntax uses `[[agent.menu]]` for each item: + +```toml +# Replace the existing CE item with a custom skill +[[agent.menu]] +code = "CE" +description = "Create Epics using our delivery framework" +skill = "custom-create-epics" + +# Add a new item (code RC doesn't exist in defaults) +[[agent.menu]] +code = "RC" +description = "Run compliance pre-check" +prompt = """ +Read {project-root}/_bmad/custom/compliance-checklist.md +and scan all documents in {planning_artifacts} against it. +Report any gaps and cite the relevant regulatory section. +""" ``` -**Custom Prompts** +Each menu item has exactly one of `skill` (invokes a registered skill) or `prompt` (executes the text directly). Items not listed in your override keep their defaults. -Create reusable prompts that menu items can reference with `action="#id"`: +**Referencing files.** When a field's text needs to point at a file (in `persistent_facts`, `activation_steps_prepend`/`activation_steps_append`, or a menu item's `prompt`), use a full path rooted at `{project-root}`. Even if the file sits next to your override in `_bmad/custom/`, spell out the full path: `{project-root}/_bmad/custom/info.md`. The agent resolves `{project-root}` at runtime. -```yaml -prompts: - - id: deploy-prompt - content: | - Deploy the current branch to production: - 1. Run all tests - 2. Build the project - 3. Execute deployment script +### 4. Personal vs Team + +**Team file** (`bmad-agent-pm.toml`): Committed to git. Shared across the org. Use for compliance rules, company persona, custom capabilities. + +**Personal file** (`bmad-agent-pm.user.toml`): Gitignored automatically. Use for tone adjustments, personal workflow preferences, and private facts the agent should keep in mind. + +```toml +# _bmad/custom/bmad-agent-pm.user.toml + +[agent] +persistent_facts = [ + "Always include a rough complexity estimate (low/medium/high) when presenting options.", +] ``` -### 3. Apply Your Changes +## How Resolution Works -After editing, reinstall to apply changes: +On activation, the agent's SKILL.md runs a shared Python script that does the three-layer merge and returns the resolved block as JSON. The script uses the Python standard library's `tomllib` module (no external dependencies), so plain `python3` is enough: ```bash -npx bmad-method install +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill {skill-root} \ + --key agent ``` -The installer detects the existing installation and offers these options: +**Requirements**: Python 3.11+ (earlier versions don't include `tomllib`). No `pip install`, no `uv`, no virtualenv. Check with `python3 --version`. Some platforms (macOS without Homebrew, Ubuntu 22.04) default `python3` to 3.10 or earlier, so you may need to install 3.11+ separately. -| Option | What It Does | -| ---------------------------- | ------------------------------------------------------------------- | -| **Quick Update** | Updates all modules to the latest version and applies customizations | -| **Modify BMad Installation** | Full installation flow for adding or removing modules | +`--skill` points at the skill's installed directory (where `customize.toml` lives). The skill name is derived from the directory's basename, and the script looks up `_bmad/custom/{skill-name}.toml` and `{skill-name}.user.toml` automatically. -For customization-only changes, **Quick Update** is the fastest option. +Useful invocations: -## Troubleshooting +```bash +# Resolve the full agent block +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill /abs/path/to/bmad-agent-pm \ + --key agent -**Changes not appearing?** +# Resolve a single field +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill /abs/path/to/bmad-agent-pm \ + --key agent.icon -- Run `npx bmad-method install` and select **Quick Update** to apply changes -- Check that your YAML syntax is valid (indentation matters) -- Verify you edited the correct `.customize.yaml` file for the agent +# Full dump +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill /abs/path/to/bmad-agent-pm +``` -**Agent not loading?** - -- Check for YAML syntax errors using an online YAML validator -- Ensure you did not leave fields empty after uncommenting them -- Try reverting to the original template and rebuilding - -**Need to reset an agent?** - -- Clear or delete the agent's `.customize.yaml` file -- Run `npx bmad-method install` and select **Quick Update** to restore defaults +Output is always JSON. If the script is unavailable on a given platform, the SKILL.md tells the agent to read the three TOML files directly and apply the same merge rules. ## Workflow Customization -Customization of existing BMad Method workflows and skills is coming soon. +Workflows (skills that drive multi-step processes like `bmad-product-brief`) share the same override mechanism as agents. Their customizable surface lives under `[workflow]` instead of `[agent]`: -## Module Customization +```toml +# _bmad/custom/bmad-product-brief.toml -Guidance on building expansion modules and customizing existing modules is coming soon. +[workflow] +# Same prepend/append semantics as agents — runs before and after the workflow's +# own activation steps. Overrides append to defaults. +activation_steps_prepend = [ + "Load {project-root}/docs/product/north-star-principles.md as context.", +] + +activation_steps_append = [] + +# Same literal-or-file: semantics as the agent variant. Loaded as foundational +# context for the duration of the workflow run. +persistent_facts = [ + "All briefs must include an explicit regulatory-risk section.", + "file:{project-root}/docs/compliance/product-brief-checklist.md", +] + +# Scalar: runs once the workflow finishes its main output. Override wins. +on_complete = "Summarize the brief in three bullets and offer to email it via the gws-gmail-send skill." +``` + +The same field conventions cross the agent/workflow boundary: `activation_steps_prepend`/`activation_steps_append`, `persistent_facts` (with `file:` refs), and menu-style `[[…]]` tables with `code`/`id` for keyed merge. The resolver applies the same four structural rules regardless of the top-level key. SKILL.md references follow the namespace: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. Any additional fields a workflow exposes (output paths, toggles, review settings, stage flags) follow the same shape-based merge rules. Read the workflow's `customize.toml` to see what's customizable. + +### Activation Order + +Customizable workflows run their activation in a fixed sequence so you know exactly when your hooks fire: + +1. Resolve the `[workflow]` block (base → team → user merge) +2. Execute `activation_steps_prepend` in order +3. Load `persistent_facts` as foundational context for the run +4. Load config (`_bmad/bmm/config.yaml`) and resolve standard variables (project name, languages, paths, date) +5. Greet the user +6. Execute `activation_steps_append` in order + +After step 6 the workflow body begins. Use `activation_steps_prepend` when you need context loaded before the greeting can be personalized; use `activation_steps_append` when the setup is heavy and you'd rather the user sees the greeting first. + +### Scope of This Initial Pass + +Customization is rolling out incrementally. The fields documented above — `activation_steps_prepend`, `activation_steps_append`, `persistent_facts`, `on_complete` — are the **baseline surface** that every customizable workflow exposes, and they will remain stable across versions. They give you broad-stroke control today: inject pre/post steps, pin foundational context, trigger follow-up actions. + +Over time, individual workflows will expose **more targeted customization points** tailored to what that workflow actually does — things like step-specific toggles, stage flags, output template paths, or review gates. When those arrive, they stack on top of the baseline fields rather than replacing them, so customizations you author today keep working. + +If you need a fine-grained knob that isn't exposed yet, either use `activation_steps_*` and `persistent_facts` to steer behavior, or open an issue describing the specific customization point you want — those requests are what drive which targeted fields get added next. + +## Central Configuration + +Per-skill `customize.toml` covers **deep behavior** (hooks, menus, persistent_facts, persona overrides for a single agent or workflow). A separate surface covers **cross-cutting state** — install answers and the agent roster that external skills like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` consume. That surface lives in four TOML files at project root: + +```text +_bmad/config.toml (installer-owned) team scope: install answers + agent roster +_bmad/config.user.toml (installer-owned) user scope: user_name, language, skill level +_bmad/custom/config.toml (human-authored) team overrides (committed to git) +_bmad/custom/config.user.toml (human-authored) personal overrides (gitignored) +``` + +### Four-Layer Merge + +```text +Priority 1 (wins): _bmad/custom/config.user.toml +Priority 2: _bmad/custom/config.toml +Priority 3: _bmad/config.user.toml +Priority 4 (base): _bmad/config.toml +``` + +Same structural rules as per-skill customize (scalars override, tables deep-merge, `code`/`id`-keyed arrays merge by key, other arrays append). + +### What Lives Where + +The installer partitions answers by the `scope:` declared on each prompt in `module.yaml`: + +- `[core]` and `[modules.]` sections — install answers. Scope `team` lands in `_bmad/config.toml`; scope `user` lands in `_bmad/config.user.toml`. +- `[agents.]` — agent essence (code, name, title, icon, description, team) distilled from each module's `module.yaml` `agents:` block. Always team-scoped. + +### Editing Rules + +- `_bmad/config.toml` and `_bmad/config.user.toml` are **regenerated every install** from the answers collected during the installer flow. Treat them as read-only outputs — direct edits will be overwritten on the next install. To change an install answer durably, re-run the installer (it remembers your prior answers as defaults) or shadow the value in `_bmad/custom/config.toml`. +- `_bmad/custom/config.toml` and `_bmad/custom/config.user.toml` are **never touched** by the installer. This is the correct surface for custom agents, agent descriptor overrides, team-enforced settings, and any value you want to pin regardless of install answers. + +### Example — Rebrand an Agent + +```toml +# _bmad/custom/config.toml (committed to git, applies to every developer) + +[agents.bmad-agent-pm] +description = "Healthcare PM — regulatory-aware, stakeholder-driven, FDA-shaped questions first." +icon = "🏥" +``` + +The resolver merges over the installer-written `[agents.bmad-agent-pm]`. `bmad-party-mode` and any other roster consumer pick up the new description automatically. + +### Example — Add a Fictional Agent + +```toml +# _bmad/custom/config.user.toml (personal, gitignored) + +[agents.kirk] +team = "startrek" +name = "Captain James T. Kirk" +title = "Starship Captain" +icon = "🖖" +description = "Bold, rule-bending commander. Speaks in dramatic pauses. Thinks aloud about the weight of command." +``` + +No skill folder required — the essence alone is enough for party-mode to spawn Kirk as a voice. Filter by the `team` field to invite just the Enterprise crew to a roundtable. + +### Example — Override Module Install Settings + +```toml +# _bmad/custom/config.toml + +[modules.bmm] +planning_artifacts = "/shared/org-planning-artifacts" +``` + +The override wins over whatever each developer answered during their local install. Useful for pinning team conventions. + +### When to Use Which Surface + +| Need | Use | +|---|---| +| Add MCP tool calls to every dev workflow | Per-skill: `_bmad/custom/bmad-agent-dev.toml` `persistent_facts` | +| Add a menu item to an agent | Per-skill: `_bmad/custom/bmad-agent-{role}.toml` `[[agent.menu]]` | +| Swap a workflow's output template | Per-skill: `_bmad/custom/{workflow}.toml` scalar override | +| Rebrand an agent's public descriptor | **Central**: `_bmad/custom/config.toml` `[agents.]` | +| Add a custom or fictional agent to the roster | **Central**: `_bmad/custom/config.*.toml` new `[agents.]` entry | +| Pin team-enforced install settings | **Central**: `_bmad/custom/config.toml` `[modules.]` or `[core]` | + +Use both surfaces in the same project as needed. + +## Worked Examples + +For enterprise-oriented recipes (shaping an agent across every workflow it dispatches, enforcing org conventions, publishing outputs to Confluence and Jira, customizing the agent roster, and swapping in your own output templates), see [How to Expand BMad for Your Organization](./expand-bmad-for-your-org.md). + +## Troubleshooting + +**Customization not appearing?** + +- Verify your file is in `_bmad/custom/` with the correct skill name +- Check TOML syntax: strings must be quoted, table headers use `[section]`, array-of-tables use `[[section]]`, and any scalar or array keys for a table must appear *before* any of that table's `[[subtables]]` in the file +- For agents, customization lives under `[agent]` -- fields written below that header belong to `agent` until another table header begins +- Remember `agent.name` and `agent.title` are read-only; overrides there have no effect + +**Updates broke my customization?** + +- Did you copy the full `customize.toml` into your override file? **Don't.** Override files should contain only the fields you're changing. A full copy locks in old defaults and silently drifts every release. Trim your override back to just the deltas. + +**Need to see what's customizable?** + +- Run the `bmad-customize` skill — it enumerates every customizable skill installed in your project, shows which ones already have overrides, and walks you through adding or updating one +- Or read the skill's `customize.toml` directly — every field there is customizable (except `name` and `title`) + +**Need to reset?** + +- Delete your override file from `_bmad/custom/` -- the skill falls back to its built-in defaults diff --git a/docs/how-to/established-projects.md b/docs/how-to/established-projects.md index ebe0e313c..c065458d6 100644 --- a/docs/how-to/established-projects.md +++ b/docs/how-to/established-projects.md @@ -1,8 +1,8 @@ --- -title: "Established Projects" +title: 'Established Projects' description: How to use BMad Method on existing codebases sidebar: - order: 6 + order: 7 --- Use BMad Method effectively when working on existing projects and legacy codebases. @@ -10,10 +10,11 @@ Use BMad Method effectively when working on existing projects and legacy codebas This guide covers the essential workflow for onboarding to existing projects with BMad Method. :::note[Prerequisites] + - BMad Method installed (`npx bmad-method install`) - An existing codebase you want to work on - Access to an AI-powered IDE (Claude Code or Cursor) -::: + ::: ## Step 1: Clean Up Completed Planning Artifacts @@ -36,6 +37,7 @@ bmad-generate-project-context ``` This scans your codebase to identify: + - Technology stack and versions - Code organization patterns - Naming conventions @@ -79,10 +81,10 @@ BMad-Help also **automatically runs at the end of every workflow**, providing cl You have two primary options depending on the scope of changes: -| Scope | Recommended Approach | -| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| Scope | Recommended Approach | +| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | **Small updates or additions** | Run `bmad-quick-dev` to clarify intent, plan, implement, and review in a single workflow. The full four-phase BMad Method is likely overkill. | -| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. | +| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. | ### During PRD Creation diff --git a/docs/how-to/expand-bmad-for-your-org.md b/docs/how-to/expand-bmad-for-your-org.md new file mode 100644 index 000000000..14485c97a --- /dev/null +++ b/docs/how-to/expand-bmad-for-your-org.md @@ -0,0 +1,258 @@ +--- +title: 'How to Expand BMad for Your Organization' +description: Five customization patterns that reshape BMad without forking — agent-wide rules, workflow conventions, external publishing, template swaps, and agent roster changes +sidebar: + order: 9 +--- + +BMad's customization surface lets an organization reshape behavior without editing installed files or forking skills. This guide walks through five recipes that cover most enterprise needs. + +:::note[Prerequisites] + +- BMad installed in your project (see [How to Install BMad](./install-bmad.md)) +- Familiarity with the customization model (see [How to Customize BMad](./customize-bmad.md)) +- Python 3.11+ on PATH (for the resolver — stdlib only, no `pip install`) +::: + +:::tip[Applying these recipes] +The **per-skill recipes** below (Recipes 1–4) can be applied by running the `bmad-customize` skill and describing the intent — it will pick the right surface, author the override file, and verify the merge. Recipe 5 (central-config overrides to the agent roster) is out of scope for v1 of the skill and remains hand-authored. The recipes here are the source of truth for *what* to override; `bmad-customize` handles the *how* for the agent/workflow surface. +::: + +## The Three-Layer Mental Model + +Before picking a recipe, know where your override lands: + +| Layer | Where overrides live | Scope | +|---|---|---| +| **Agent** (e.g. Amelia, Mary, John) | `[agent]` section of `_bmad/custom/bmad-agent-{role}.toml` | Travels with the persona into **every workflow the agent dispatches** | +| **Workflow** (e.g. product-brief, create-prd) | `[workflow]` section of `_bmad/custom/{workflow-name}.toml` | Applies only to that workflow's run | +| **Central config** | `[agents.*]`, `[core]`, `[modules.*]` in `_bmad/custom/config.toml` | Agent roster (who's available for party-mode, retrospective, elicitation), install-time settings pinned org-wide | + +Rule of thumb: if the rule should apply everywhere an engineer does dev work, customize the **dev agent**. If it applies only when someone writes a product brief, customize the **product-brief workflow**. If it changes *who's in the room* (rename an agent, add a custom voice, enforce a shared artifact path), edit **central config**. + +## Recipe 1: Shape an Agent Across Every Workflow It Dispatches + +**Use case:** Standardize tool use and external system integrations so every workflow dispatched through an agent inherits the behavior. This is the highest-impact pattern. + +**Example: Amelia (dev agent) always uses Context7 for library docs, and falls back to Linear when a story isn't found in the epics list.** + +```toml +# _bmad/custom/bmad-agent-dev.toml + +[agent] + +# Applied on every activation. Carries into dev-story, quick-dev, +# create-story, code-review, qa-generate — every skill Amelia dispatches. +persistent_facts = [ + "For any library documentation lookup (React, TypeScript, Zod, Prisma, etc.), call the context7 MCP tool (`mcp__context7__resolve_library_id` then `mcp__context7__get_library_docs`) before relying on training-data knowledge. Up-to-date docs trump memorized APIs.", + "When a story reference isn't found in {planning_artifacts}/epics-and-stories.md, search Linear via `mcp__linear__search_issues` using the story ID or title before asking the user to clarify. If Linear returns a match, treat it as the authoritative story source.", +] +``` + +**Why this works:** Two sentences reshape every dev workflow in the org, with no per-workflow duplication and no source changes. Every new engineer who pulls the repo inherits the conventions automatically. + +**Team file vs personal file:** +- `bmad-agent-dev.toml`: committed to git; applies to the whole team +- `bmad-agent-dev.user.toml`: gitignored; personal preferences layered on top + +## Recipe 2: Enforce Organizational Conventions Inside a Specific Workflow + +**Use case:** Shape the *content* of a workflow's output so it meets compliance, audit, or downstream-consumer requirements. + +**Example: every product brief must include compliance fields, and the agent knows about the org's publishing conventions.** + +```toml +# _bmad/custom/bmad-product-brief.toml + +[workflow] + +persistent_facts = [ + "Every brief must include an 'Owner' field, a 'Target Release' field, and a 'Security Review Status' field.", + "Non-commercial briefs (internal tools, research projects) must still include a user-value section, but can omit market differentiation.", + "file:{project-root}/docs/enterprise/brief-publishing-conventions.md", +] +``` + +**What happens:** The facts load during Step 3 of the workflow's activation. When the agent drafts the brief, it knows the required fields and the enterprise conventions document. The shipped default (`file:{project-root}/**/project-context.md`) still loads, since this is an append. + +## Recipe 3: Publish Completed Outputs to External Systems + +**Use case:** Once the workflow produces its output, automatically publish to enterprise systems of record (Confluence, Notion, SharePoint) and open follow-up work (Jira, Linear, Asana). + +**Example: briefs auto-publish to Confluence and offer optional Jira epic creation.** + +```toml +# _bmad/custom/bmad-product-brief.toml + +[workflow] + +# Terminal hook. Scalar override replaces the empty default wholesale. +on_complete = """ +Publish and offer follow-up: + +1. Read the finalized brief file path from the prior step. +2. Call `mcp__atlassian__confluence_create_page` with: + - space: "PRODUCT" + - parent: "Product Briefs" + - title: the brief's title + - body: the brief's markdown contents + Capture the returned page URL. +3. Tell the user: "Brief published to Confluence: ". +4. Ask: "Want me to open a Jira epic for this brief now?" +5. If yes, call `mcp__atlassian__jira_create_issue` with: + - type: "Epic" + - project: "PROD" + - summary: the brief's title + - description: a short summary plus a link back to the Confluence page. + Report the epic key and URL. +6. If no, exit cleanly. + +If either MCP tool fails, report the failure, print the brief path, +and ask the user to publish manually. +""" +``` + +**Why `on_complete` and not `activation_steps_append`:** `on_complete` runs exactly once, at the terminal stage, after the workflow's main output is written. That's the right moment to publish artifacts. `activation_steps_append` runs every activation, before the workflow does its work. + +**Tradeoffs:** +- **Confluence publication is non-destructive** and always runs on completion +- **Jira epic creation is visible to the whole team** and kicks off sprint-planning signals, so gate it on user confirmation +- **Graceful fallback:** if MCP tools fail, hand off to the user rather than silently dropping the output + +## Recipe 4: Swap in Your Own Output Template + +**Use case:** The default output structure doesn't match your organization's expected format, or different orgs in the same repo need different templates. + +**Example: point the product-brief workflow at an enterprise-owned template.** + +```toml +# _bmad/custom/bmad-product-brief.toml + +[workflow] +brief_template = "{project-root}/docs/enterprise/brief-template.md" +``` + +**How it works:** The workflow's `customize.toml` ships with `brief_template = "resources/brief-template.md"` (bare path, resolves from skill root). Your override points at a file under `{project-root}`, so the agent reads your template in Stage 4 instead of the shipped one. + +**Template authoring tips:** +- Keep templates in `{project-root}/docs/` or `{project-root}/_bmad/custom/templates/` so they version alongside the override file +- Use the same structural conventions as the shipped template (section headings, frontmatter); the agent adapts to what's there +- For multi-org repos, use `.user.toml` to let individual teams point at their own templates without touching the committed team file + +## Recipe 5: Customize the Agent Roster + +**Use case:** Change *who's in the room* for roster-driven skills like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation`, without editing any source or forking. Three common variants follow. + +### 5a. Rebrand a BMad Agent Org-Wide + +Every real agent has a descriptor the installer synthesizes from `module.yaml`. Override it to shift voice and framing across every roster consumer: + +```toml +# _bmad/custom/config.toml (committed — applies to every developer) + +[agents.bmad-agent-analyst] +description = "Mary the Regulatory-Aware Business Analyst — channels Porter and Minto, but lives and breathes FDA audit trails. Speaks like a forensic investigator presenting a case file." +``` + +Party-mode spawns Mary with the new description. The analyst activation itself still runs normally because Mary's behavior lives in her per-skill `customize.toml`. This override changes how **external skills perceive and introduce her**, not how she works internally. + +### 5b. Add a Fictional or Custom Agent + +A full descriptor is enough for roster-based features, with no skill folder needed. Useful for personality variety in party mode or brainstorming sessions: + +```toml +# _bmad/custom/config.user.toml (personal — gitignored) + +[agents.spock] +team = "startrek" +name = "Commander Spock" +title = "Science Officer" +icon = "🖖" +description = "Logic first, emotion suppressed. Begins observations with 'Fascinating.' Never rounds up. Counterpoint to any argument that relies on gut instinct." + +[agents.mccoy] +team = "startrek" +name = "Dr. Leonard McCoy" +title = "Chief Medical Officer" +icon = "⚕️" +description = "Country doctor's warmth, short fuse. 'Dammit Jim, I'm a doctor not a ___.' Ethics-driven counterweight to Spock." +``` + +Ask party-mode to "invite the Enterprise crew." It filters by `team = "startrek"` and spawns Spock and McCoy with those descriptors. Real BMad agents (Mary, Amelia) can sit at the same table if you ask them to. + +### 5c. Pin Team Install Settings + +The installer prompts each developer for values like `planning_artifacts` path. When the org needs one shared answer across the team, pin it in central config — any developer's local prompt answer gets overridden at resolution time: + +```toml +# _bmad/custom/config.toml + +[modules.bmm] +planning_artifacts = "{project-root}/shared/planning" +implementation_artifacts = "{project-root}/shared/implementation" + +[core] +document_output_language = "English" +``` + +Personal settings like `user_name`, `communication_language`, or `user_skill_level` stay under each developer's own `_bmad/config.user.toml`. The team file shouldn't touch those. + +**Why central config vs per-agent customize.toml:** Per-agent files shape how *one* agent behaves when it activates. Central config shapes what roster consumers *see when they look at the field:* which agents exist, what they're called, what team they belong to, and the shared install settings the whole repo agrees on. Two surfaces, different jobs. + +## Reinforce Global Rules in Your IDE's Session File + +BMad customizations load when a skill is activated. Many IDE tools also load a global instruction file at the **start of every session**, before any skill runs (`CLAUDE.md`, `AGENTS.md`, `.cursor/rules/`, `.github/copilot-instructions.md`, etc). For rules that should hold even outside BMad skills, restate the critical ones there too. + +**When to double up:** +- A rule is important enough that a plain chat conversation (no skill active) should still follow it +- You want belt-and-suspenders enforcement because training-data defaults might otherwise pull the model off-course +- The rule is concise enough to repeat without bloating the session file + +**Example: one line in the repo's `CLAUDE.md` reinforcing the dev-agent rule from Recipe 1.** + +```markdown + +``` + +One sentence, loaded every session. It pairs with the `bmad-agent-dev.toml` customization so the rule applies both inside Amelia's workflows and during ad-hoc chats with the assistant. Each layer owns its own scope: + +| Layer | Scope | Use for | +|---|---|---| +| IDE session file (`CLAUDE.md` / `AGENTS.md`) | Every session, before any skill activates | Short, universal rules that should survive outside BMad | +| BMad agent customization | Every workflow the agent dispatches | Agent-persona-specific behavior | +| BMad workflow customization | One workflow run | Workflow-specific output shape, publishing hooks, templates | +| BMad central config | Agent roster + shared install settings | Who's in the room and what shared paths the team uses | + +Keep the IDE file **succinct**. A dozen well-chosen lines are more effective than a sprawling list. Models read it every turn, and noise crowds out signal. + +## Combining Recipes + +All five recipes compose. A realistic enterprise override for `bmad-product-brief` might set `persistent_facts` (Recipe 2), `on_complete` (Recipe 3), and `brief_template` (Recipe 4) in one file. The agent-level rule (Recipe 1) lives in a separate file under the agent's name, central config (Recipe 5) pins the shared roster and team settings, and all four apply in parallel. + +```toml +# _bmad/custom/bmad-product-brief.toml (workflow-level) + +[workflow] +persistent_facts = ["..."] +brief_template = "{project-root}/docs/enterprise/brief-template.md" +on_complete = """ ... """ +``` + +```toml +# _bmad/custom/bmad-agent-analyst.toml (agent-level — Mary dispatches product-brief) + +[agent] +persistent_facts = ["Always include a 'Regulatory Review' section when the domain involves healthcare, finance, or children's data."] +``` + +Result: Mary loads the regulatory-review rule at persona activation. When the user picks the product-brief menu item, the workflow loads its own conventions on top, writes to the enterprise template, and publishes to Confluence on completion. Every layer contributes, and none of them required editing BMad source. + +## Troubleshooting + +**Override not taking effect?** Check that the file is under `_bmad/custom/` with the exact skill directory name (e.g. `bmad-agent-dev.toml`, not `bmad-dev.toml`). See [How to Customize BMad](./customize-bmad.md#troubleshooting). + +**MCP tool name unknown?** Use the exact name the MCP server exposes in the current session. Ask Claude Code to list available MCP tools if unsure. Hardcoded names in `persistent_facts` or `on_complete` won't work if the MCP server isn't connected. + +**Pattern doesn't apply to my setup?** The recipes above are illustrative. The underlying machinery (three-layer merge, structural rules, agent-spans-workflow) supports many more patterns; compose them as needed. diff --git a/docs/how-to/get-answers-about-bmad.md b/docs/how-to/get-answers-about-bmad.md index 61766167a..77a554104 100644 --- a/docs/how-to/get-answers-about-bmad.md +++ b/docs/how-to/get-answers-about-bmad.md @@ -1,84 +1,31 @@ --- -title: "How to Get Answers About BMad" +title: 'How to Get Answers About BMad' description: Use an LLM to quickly answer your own BMad questions sidebar: - order: 4 + order: 5 --- -## Start Here: BMad-Help +Use BMad's built-in help, source docs, or the community to get answers — from quickest to most thorough. -**The fastest way to get answers about BMad is the `bmad-help` skill.** This intelligent guide will answer upwards of 80% of all questions and is available to you directly in your IDE as you work. +## 1. Ask BMad-Help -BMad-Help is more than a lookup tool — it: -- **Inspects your project** to see what's already been completed -- **Understands natural language** — ask questions in plain English -- **Varies based on your installed modules** — shows relevant options -- **Auto-runs after workflows** — tells you exactly what to do next -- **Recommends the first required task** — no guessing where to start - -### How to Use BMad-Help - -Call it by name in your AI session: +The fastest way to get answers. The `bmad-help` skill is available directly in your AI session and handles over 80% of questions — it inspects your project, sees what you've completed, and tells you what to do next. ``` -bmad-help +bmad-help I have a SaaS idea and know all the features. Where do I start? +bmad-help What are my options for UX design? +bmad-help I'm stuck on the PRD workflow ``` :::tip You can also use `/bmad-help` or `$bmad-help` depending on your platform, but just `bmad-help` should work everywhere. ::: -Combine it with a natural language query: +## 2. Go Deeper with Source -``` -bmad-help I have a SaaS idea and know all the features. Where do I start? -bmad-help What are my options for UX design? -bmad-help I'm stuck on the PRD workflow -bmad-help Show me what's been done so far -``` +BMad-Help draws on your installed configuration. For questions about BMad's internals, history, or architecture — or if you're researching BMad before installing — point your AI at the source directly. -BMad-Help responds with: -- What's recommended for your situation -- What the first required task is -- What the rest of the process looks like - -## When to Use This Guide - -Use this section when: -- You want to understand BMad's architecture or internals -- You need answers outside of what BMad-Help provides -- You're researching BMad before installing -- You want to explore the source code directly - -## Steps - -### 1. Choose Your Source - -| Source | Best For | Examples | -| -------------------- | ----------------------------------------- | ---------------------------- | -| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" | -| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" | -| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" | - -The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead. - -### 2. Point Your AI at the Source - -**If your AI can read files (Claude Code, Cursor, etc.):** - -- **BMad installed:** Point at the `_bmad` folder and ask directly -- **Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) - -**If you use ChatGPT or Claude.ai:** - -Fetch `llms-full.txt` into your session: - -```text -https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt -``` - - -### 3. Ask Your Question +Clone or open the [BMAD-METHOD repo](https://github.com/bmad-code-org/BMAD-METHOD) and ask your AI about it. Any agent-capable tool (Claude Code, Cursor, Windsurf, etc.) can read the source and answer questions directly. :::note[Example] **Q:** "Tell me the fastest way to build something with BMad" @@ -86,51 +33,48 @@ https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt **A:** Use Quick Flow: Run `bmad-quick-dev` — it clarifies your intent, plans, implements, reviews, and presents results in a single workflow, skipping the full planning phases. ::: -## What You Get +**Tips for better answers:** -Direct answers about BMad—how agents work, what workflows do, why things are structured the way they are—without waiting for someone else to respond. - -## Tips - -- **Verify surprising answers** — LLMs occasionally get things wrong. Check the source file or ask on Discord. - **Be specific** — "What does step 3 of the PRD workflow do?" beats "How does PRD work?" +- **Verify surprising claims** — LLMs occasionally get things wrong. Check the source file or ask on Discord. -## Still Stuck? +### Not using an agent? Use the docs site -Tried the LLM approach and still need help? You now have a much better question to ask. +If your AI can't read local files (ChatGPT, Claude.ai, etc.), fetch [llms-full.txt](https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt) into your session — it's a single-file snapshot of the BMad documentation. -| Channel | Use For | -| ------------------------- | ------------------------------------------- | -| `#bmad-method-help` | Quick questions (real-time chat) | -| `help-requests` forum | Detailed questions (searchable, persistent) | -| `#suggestions-feedback` | Ideas and feature requests | -| `#report-bugs-and-issues` | Bug reports | +## 3. Ask Someone + +If neither BMad-Help nor the source answered your question, you now have a much better question to ask. + +| Channel | Use For | +| ----------------------- | -------------------------- | +| `help-requests` forum | Questions | +| `#suggestions-feedback` | Ideas and feature requests | **Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) -**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs) +**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) +_You!_ +_Stuck_ +_in the queue—_ +_waiting_ +_for who?_ -*You!* - *Stuck* - *in the queue—* - *waiting* - *for who?* +_The source_ +_is there,_ +_plain to see!_ -*The source* - *is there,* - *plain to see!* +_Point_ +_your machine._ +_Set it free._ -*Point* - *your machine.* - *Set it free.* +_It reads._ +_It speaks._ +_Ask away—_ -*It reads.* - *It speaks.* - *Ask away—* +_Why wait_ +_for tomorrow_ +_when you have_ +_today?_ -*Why wait* - *for tomorrow* - *when you have* - *today?* - -*—Claude* +_—Claude_ diff --git a/docs/how-to/install-bmad.md b/docs/how-to/install-bmad.md index 3789c6fa9..616e6e430 100644 --- a/docs/how-to/install-bmad.md +++ b/docs/how-to/install-bmad.md @@ -1,116 +1,226 @@ --- -title: "How to Install BMad" -description: Step-by-step guide to installing BMad in your project +title: 'How to Install BMad' +description: Install, update, and pin BMad for local development, teams, and CI sidebar: order: 1 --- -Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools. - -If you want to use a non interactive installer and provide all install options on the command line, see [this guide](./non-interactive-installation.md). +Use `npx bmad-method install` to set up BMad in your project. One command handles first installs, upgrades, channel switching, and scripted CI runs. This page covers all of it. ## When to Use This - Starting a new project with BMad -- Adding BMad to an existing codebase -- Update the existing BMad Installation +- Adding or removing modules on an existing install +- Switching a module to main-HEAD or pinning to a specific release +- Scripting installs for CI pipelines, Dockerfiles, or enterprise rollouts :::note[Prerequisites] -- **Node.js** 20+ (required for the installer) -- **Git** (recommended) -- **AI tool** (Claude Code, Cursor, or similar) + +- **Node.js** 20+ (the installer requires it) +- **Git** (for cloning external modules) +- **An AI tool** such as Claude Code or Cursor — or install without one using `--tools none` + ::: -## Steps - -### 1. Run the Installer +## First-time install (the fast path) ```bash npx bmad-method install ``` -:::tip[Want the newest prerelease build?] -Use the `next` dist-tag: +The interactive flow asks you five things: + +1. Installation directory (defaults to the current working directory) +2. Which modules to install (checkboxes for core, bmm, bmb, cis, gds, tea) +3. **"Ready to install (all stable)?"** — Yes accepts the latest released tag for every external module +4. Which AI tools/IDEs to integrate with (claude-code, cursor, and others) +5. Per-module config (name, language, output folder) + +Accept the defaults and you land on the latest stable release of every module, configured for your chosen tool. + +:::tip[Just want the newest prerelease?] + ```bash npx bmad-method@next install ``` -This gets you newer changes earlier, with a higher chance of churn than the default install. +Runs the prerelease installer, which ships a newer snapshot of core and bmm. More churn, fewer delays between development and release. ::: -:::tip[Bleeding edge] -To install the latest from the main branch (may be unstable): +## Picking a specific version + +Two independent axes control what ends up on disk. + +### Axis 1: external module channels + +Every external module — bmb, cis, gds, tea, and any community module — installs on one of three channels: + +| Channel | What gets installed | Who picks this | +| ------------------ | ---------------------------------------------------------------------------- | --------------------------------------- | +| `stable` (default) | Highest released semver tag. Prereleases like `v2.0.0-alpha.1` are excluded. | Most users | +| `next` | Main branch HEAD at install time | Contributors, early adopters | +| `pinned` | A specific tag you name | Enterprise installs, CI reproducibility | + +Channels are per-module. You can run bmb on `next` while leaving cis on `stable` — the flags below let you mix freely. + +### Axis 2: installer binary version + +The `bmad-method` npm package itself has two dist-tags: + +| Command | What you get | +| ------------------------------------- | ----------------------------------------------------------------- | +| `npx bmad-method install` (`@latest`) | Latest stable installer release | +| `npx bmad-method@next install` | Latest prerelease installer, auto-published on every push to main | + +**The installer binary determines your core and bmm versions.** Those two modules ship bundled inside the installer package rather than being cloned from separate repos. + +### Why core and bmm don't have their own channel + +They're stapled to the installer binary you ran: + +- `npx bmad-method install` → latest stable core and bmm +- `npx bmad-method@next install` → prerelease core and bmm +- `node /path/to/local-checkout/tools/installer/bmad-cli.js install` → whatever your local checkout has + +`--pin bmm=v6.3.0` and `--next=bmm` are silently ineffective against bundled modules, and the installer warns you when you try. A future release extracts bmm from the installer package; once that ships, bmm gets a proper channel selector like bmb has today. + +## Updating an existing install + +Running `npx bmad-method install` in a directory that already contains `_bmad/` gives you a menu: + +| Choice | What it does | +| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Quick Update** | Re-runs the install with your existing settings. Refreshes files, applies patches and minor stable upgrades, refuses major upgrades. Fast, non-interactive. | +| **Modify Install** | Full interactive flow. Add or remove modules, reconfigure settings, optionally review and switch channels for existing modules. | + +### Upgrade prompts + +When Modify detects a newer stable tag for a module you've installed on `stable`, it classifies the diff and prompts accordingly: + +| Upgrade type | Example | Default | +| ------------ | --------------- | ------- | +| Patch | v1.7.0 → v1.7.1 | Y | +| Minor | v1.7.0 → v1.8.0 | Y | +| Major | v1.7.0 → v2.0.0 | **N** | + +Major defaults to N because breaking changes frequently surface as "instability" when they weren't expected. The prompt includes a GitHub release-notes URL so you can read what changed before accepting. + +Under `--yes`, patch and minor upgrades apply automatically. Majors stay frozen — pass `--pin =` to accept non-interactively. + +### Switching a module's channel + +**Interactively:** choose Modify → answer **Yes** to "Review channel assignments?" → each external module offers Keep, Switch to stable, Switch to next, or Pin to a tag. + +**Via flags:** the recipes in the next section cover the common cases. + +## Headless CI installs + +### Flag reference + +| Flag | Purpose | +| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | +| `--yes`, `-y` | Skip all prompts; accept flag values + defaults | +| `--directory ` | Install into this directory (default: current working dir) | +| `--modules ` | Exact module set. Core is auto-added. Not a delta — list everything you want kept. | +| `--tools ` or `--tools none` | IDE/tool selection. `none` skips tool config entirely. | +| `--action ` | `install`, `update`, or `quick-update`. Defaults based on existing install state. | +| `--custom-source ` | Install custom modules from Git URLs or local paths | +| `--channel ` | Apply to all externals (aliased as `--all-stable` / `--all-next`) | +| `--all-stable` | Alias for `--channel=stable` | +| `--all-next` | Alias for `--channel=next` | +| `--next=` | Put one module on next. Repeatable. | +| `--pin =` | Pin one module to a specific tag. Repeatable. | +| `--user-name`, `--communication-language`, `--document-output-language`, `--output-folder` | Override per-user config defaults | + +Precedence when flags overlap: `--pin` beats `--next=` beats `--channel` / `--all-*` beats the registry default (`stable`). + +:::note[Example resolution] +`--all-next --pin cis=v0.2.0` puts bmb, gds, and tea on next while pinning cis to v0.2.0. +::: + +### Recipes + +**Default install — latest stable for everything:** + ```bash -npx github:bmad-code-org/BMAD-METHOD install +npx bmad-method install --yes --modules bmm,bmb,cis --tools claude-code ``` + +**Enterprise pin — reproducible byte-for-byte:** + +```bash +npx bmad-method install --yes \ + --modules bmm,bmb,cis \ + --pin bmb=v1.7.0 --pin cis=v0.2.0 \ + --tools claude-code +``` + +**Bleeding edge — externals on main HEAD:** + +```bash +npx bmad-method install --yes --modules bmm,bmb --all-next --tools claude-code +``` + +**Add a module to an existing install** (keep everything else): + +```bash +npx bmad-method install --yes --action update \ + --modules bmm,bmb,gds \ + --tools none +``` + +**Mix channels — bmb on next, gds on stable:** + +```bash +npx bmad-method install --yes --action update \ + --modules bmm,bmb,cis,gds \ + --next=bmb \ + --tools none +``` + +:::caution[Rate limit on shared IPs] +Anonymous GitHub API calls are capped at 60/hour per IP. A single install hits the API once per external module to resolve the stable tag. Offices behind NAT, CI runner pools, and VPNs can collectively exhaust this. + +Set `GITHUB_TOKEN=` in the environment to raise the limit to 5000/hour per account. Any public-repo-read PAT works; no scopes are required. ::: -### 2. Choose Installation Location +## What got installed -The installer will ask where to install BMad files: +After any install, `_bmad/_config/manifest.yaml` records exactly what's on disk: -- Current directory (recommended for new projects if you created the directory yourself and ran from within the directory) -- Custom path - -### 3. Select Your AI Tools - -Pick which AI tools you use: - -- Claude Code -- Cursor -- Others - -Each tool has its own way of integrating skills. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them. - -:::note[Enabling Skills] -Some platforms require skills to be explicitly enabled in settings before they appear. If you install BMad and don't see the skills, check your platform's settings or ask your AI assistant how to enable skills. -::: - -### 4. Choose Modules - -The installer shows available modules. Select whichever ones you need — most users just want **BMad Method** (the software development module). - -### 5. Follow the Prompts - -The installer guides you through the rest — custom content, settings, etc. - -## What You Get - -```text -your-project/ -├── _bmad/ -│ ├── bmm/ # Your selected modules -│ │ └── config.yaml # Module settings (if you ever need to change them) -│ ├── core/ # Required core module -│ └── ... -├── _bmad-output/ # Generated artifacts -├── .claude/ # Claude Code skills (if using Claude Code) -│ └── skills/ -│ ├── bmad-help/ -│ ├── bmad-persona/ -│ └── ... -└── .cursor/ # Cursor skills (if using Cursor) - └── skills/ - └── ... +```yaml +modules: + - name: bmb + version: v1.7.0 # the tag, or "main" for next + channel: stable # stable | next | pinned + sha: 86033fc9aeae2ca6d52c7cdb675c1f4bf17fc1c1 + source: external + repoUrl: https://github.com/bmad-code-org/bmad-builder ``` -## Verify Installation +The `sha` field is written for git-backed modules (external, community, and URL-based custom). Bundled modules (core, bmm) and local-path custom modules don't have one — their code travels with the installer binary or your filesystem, not a cloneable ref. -Run `bmad-help` to verify everything works and see what to do next. +For cross-machine reproducibility, don't rely on rerunning the same `--modules` command. Stable-channel installs resolve to the highest released tag **at install time**, so a later rerun lands on whatever has been released since. Convert the recorded tags from `manifest.yaml` into explicit `--pin` flags on the target machine, e.g.: -**BMad-Help is your intelligent guide** that will: -- Confirm your installation is working -- Show what's available based on your installed modules -- Recommend your first step - -You can also ask it questions: -``` -bmad-help I just installed, what should I do first? -bmad-help What are my options for a SaaS project? +```bash +npx bmad-method install --yes --modules bmb,cis \ + --pin bmb=v1.7.0 --pin cis=v0.4.2 --tools none ``` ## Troubleshooting -**Installer throws an error** — Copy-paste the output into your AI assistant and let it figure it out. +### "Could not resolve stable tag" or "API rate limit exceeded" -**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](./get-answers-about-bmad.md) for how to point your AI at the right sources. +You've hit GitHub's 60/hr anonymous limit. Set `GITHUB_TOKEN` and retry. If you already have a token set, it may be expired or rate-limited on its own budget — try a different token or wait for the hourly reset. + +### "Tag 'vX.Y.Z' not found" + +The tag you passed to `--pin` doesn't exist in the module's repo. Check the repo's releases page on GitHub for valid tags. + +### A pinned install keeps upgrading + +Pinned installs don't upgrade. Quick-update applies patches and minors on stable channel only; it won't touch `pinned` or `next`. If a pinned install changed, open `_bmad/_config/manifest.yaml` — `channel: pinned` plus a fixed `version` and `sha` should hold across runs unless you explicitly override via flags. + +### `--pin bmm=X` didn't do anything + +bmm is a bundled module — `--pin` and `--next=` don't apply. Use `npx bmad-method@next install` for a prerelease core/bmm, or check out the bmad-bmm repo and run the installer locally to get unreleased changes. diff --git a/docs/how-to/install-custom-modules.md b/docs/how-to/install-custom-modules.md new file mode 100644 index 000000000..c4a38d41d --- /dev/null +++ b/docs/how-to/install-custom-modules.md @@ -0,0 +1,181 @@ +--- +title: 'Install Custom and Community Modules' +description: Install third-party modules from the community registry, Git repositories, or local paths +sidebar: + order: 3 +--- + +Use the BMad installer to add modules from the community registry, third-party Git repositories, or local file paths. + +## When to Use This + +- Installing a community-contributed module from the BMad registry +- Installing a module from a third-party Git repository (GitHub, GitLab, Bitbucket, self-hosted) +- Testing a module you are developing locally with BMad Builder +- Installing modules from a private or self-hosted Git server + +:::note[Prerequisites] +Requires [Node.js](https://nodejs.org) v20+ and `npx` (included with npm). Custom and community modules can be selected during a fresh install or added to an existing installation. +::: + +## Community Modules + +Community modules are curated in the [BMad plugins marketplace](https://github.com/bmad-code-org/bmad-plugins-marketplace). They are organized by category and are pinned to an approved commit for safety. + +### 1. Run the Installer + +```bash +npx bmad-method install +``` + +### 2. Browse the Community Catalog + +After selecting official modules, the installer asks: + +``` +Would you like to browse community modules? +``` + +Select **Yes** to enter the catalog browser. You can: + +- Browse by category +- View featured modules +- View all available modules +- Search by keyword + +### 3. Select Modules + +Pick modules from any category. The installer shows descriptions, versions, and trust tiers. Already-installed modules are pre-checked for update. + +### 4. Continue with Installation + +After selecting community modules, the installer proceeds to custom sources, then tool/IDE configuration and the rest of the install flow. + +## Custom Sources (Git URLs and Local Paths) + +Custom modules can come from any Git repository or a local directory on your machine. The installer resolves the source, analyzes the module structure, and installs it alongside your other modules. + +### Interactive Installation + +During installation, after the community module step, the installer asks: + +``` +Would you like to install from a custom source (Git URL or local path)? +``` + +Select **Yes**, then provide a source: + +| Input Type | Example | +| --------------------- | ------------------------------------------------- | +| HTTPS URL (any host) | `https://github.com/org/repo` | +| HTTP URL (any host) | `http://host/org/repo` | +| HTTPS URL with subdir | `https://github.com/org/repo/tree/main/my-module` | +| SSH URL | `git@github.com:org/repo.git` | +| Local path | `/Users/me/projects/my-module` | +| Local path with tilde | `~/projects/my-module` | + +The installer clones the repository (for URLs) or reads directly from disk (for local paths), then presents the discovered modules for selection. + +### Non-Interactive Installation + +Use the `--custom-source` flag to install custom modules from the command line: + +```bash +npx bmad-method install \ + --directory . \ + --custom-source /path/to/my-module \ + --tools claude-code \ + --yes +``` + +When `--custom-source` is provided without `--modules`, only core and the custom modules are installed. To include official modules as well, add `--modules`: + +```bash +npx bmad-method install \ + --directory . \ + --modules bmm \ + --custom-source https://gitlab.com/myorg/my-module \ + --tools claude-code \ + --yes +``` + +Multiple sources can be comma-separated: + +```bash +--custom-source /path/one,https://github.com/org/repo,/path/two +``` + +## How Module Discovery Works + +The installer uses two modes to find installable modules in a source: + +| Mode | Trigger | Behavior | +| --------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| Discovery | Source contains `.claude-plugin/marketplace.json` | Lists all plugins from the manifest; you pick which to install | +| Direct | No marketplace.json found | Scans the directory for skills (subdirectories with `SKILL.md`), resolves as a single module | + +Discovery mode is typical for published modules. Direct mode is convenient when pointing at a skills directory during local development. + +:::note[About `.claude-plugin/`] +The `.claude-plugin/marketplace.json` path is a standard convention adopted across multiple AI tool installers for plugin discoverability. It does not require Claude, does not use Claude APIs, and has no effect on which AI tool you use. Any module with this file can be discovered by any installer that follows the convention. +::: + +## Local Development Workflow + +If you are building a module with [BMad Builder](https://github.com/bmad-code-org/bmad-builder), you can install it directly from your working directory: + +```bash +npx bmad-method install \ + --directory ~/my-project \ + --custom-source ~/my-module-repo/skills \ + --tools claude-code \ + --yes +``` + +Local sources are referenced by path, not copied to a cache. When you update your module source and reinstall, the installer picks up the latest changes. + +:::caution[Source Removal] +If you delete the local source directory after installation, the installed module files in `_bmad/` are preserved. The module will be skipped during updates until the source path is restored. +::: + +## What You Get + +After installation, custom modules appear in `_bmad/` alongside official modules: + +``` +your-project/ +├── _bmad/ +│ ├── core/ # Built-in core module +│ ├── bmm/ # Official module (if selected) +│ ├── my-module/ # Your custom module +│ │ ├── my-skill/ +│ │ │ └── SKILL.md +│ │ └── module-help.csv +│ └── _config/ +│ └── manifest.yaml # Tracks all modules, versions, and sources +└── ... +``` + +The manifest records the source of each custom module (`repoUrl` for Git sources, `localPath` for local sources) so that quick updates can locate the source again. + +## Updating Custom Modules + +Custom modules participate in the normal update flow: + +- **Quick update** (`--action quick-update`): Refreshes all modules from their original sources. Git-based modules are re-fetched; local modules are re-read from their source path. +- **Full update**: Re-runs module selection so you can add or remove custom modules. + +## Creating Your Own Modules + +Use [BMad Builder](https://github.com/bmad-code-org/bmad-builder) to create modules that others can install: + +1. Run `bmad-module-builder` to scaffold your module structure +2. Add skills, agents, and workflows with the various bmad builder tools +3. Publish to a Git repository or share the folder collection +4. Others install with `--custom-source ` + +For modules to support discovery mode, include a `.claude-plugin/marketplace.json` in your repository root (this is a cross-tool convention, not Claude-specific). See the [BMad Builder documentation](https://github.com/bmad-code-org/bmad-builder) for the marketplace.json format. + +:::tip[Testing Locally First] +During development, install your module with a local path to iterate quickly before publishing to a Git repository. +::: diff --git a/docs/how-to/non-interactive-installation.md b/docs/how-to/non-interactive-installation.md index 64687c0a1..bfae38d7a 100644 --- a/docs/how-to/non-interactive-installation.md +++ b/docs/how-to/non-interactive-installation.md @@ -1,184 +1,10 @@ --- title: Non-Interactive Installation -description: Install BMad using command-line flags for CI/CD pipelines and automated deployments +description: Headless / CI install docs have moved sidebar: order: 2 --- -Use command-line flags to install BMad non-interactively. This is useful for: - -## When to Use This - -- Automated deployments and CI/CD pipelines -- Scripted installations -- Batch installations across multiple projects -- Quick installations with known configurations - -:::note[Prerequisites] -Requires [Node.js](https://nodejs.org) v20+ and `npx` (included with npm). -::: - -## Available Flags - -### Installation Options - -| Flag | Description | Example | -|------|-------------|---------| -| `--directory ` | Installation directory | `--directory ~/projects/myapp` | -| `--modules ` | Comma-separated module IDs | `--modules bmm,bmb` | -| `--tools ` | Comma-separated tool/IDE IDs (use `none` to skip) | `--tools claude-code,cursor` or `--tools none` | -| `--custom-content ` | Comma-separated paths to custom modules | `--custom-content ~/my-module,~/another-module` | -| `--action ` | Action for existing installations: `install` (default), `update`, or `quick-update` | `--action quick-update` | - -### Core Configuration - -| Flag | Description | Default | -|------|-------------|---------| -| `--user-name ` | Name for agents to use | System username | -| `--communication-language ` | Agent communication language | English | -| `--document-output-language ` | Document output language | English | -| `--output-folder ` | Output folder path (see resolution rules below) | `_bmad-output` | - -#### Output Folder Path Resolution - -The value passed to `--output-folder` (or entered interactively) is resolved according to these rules: - -| Input type | Example | Resolved as | -|------------|---------|-------------| -| Relative path (default) | `_bmad-output` | `/_bmad-output` | -| Relative path with traversal | `../../shared-outputs` | Normalized absolute path — e.g. `/Users/me/shared-outputs` | -| Absolute path | `/Users/me/shared-outputs` | Used as-is — project root is **not** prepended | - -The resolved path is what agents and workflows use at runtime when writing output files. Using an absolute path or a traversal-based relative path lets you direct all generated artifacts to a directory outside your project tree — useful for shared or monorepo setups. - -### Other Options - -| Flag | Description | -|------|-------------| -| `-y, --yes` | Accept all defaults and skip prompts | -| `-d, --debug` | Enable debug output for manifest generation | - -## Module IDs - -Available module IDs for the `--modules` flag: - -- `bmm` — BMad Method Master -- `bmb` — BMad Builder - -Check the [BMad registry](https://github.com/bmad-code-org) for available external modules. - -## Tool/IDE IDs - -Available tool IDs for the `--tools` flag: - -**Preferred:** `claude-code`, `cursor` - -Run `npx bmad-method install` interactively once to see the full current list of supported tools, or check the [platform codes configuration](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/installer/ide/platform-codes.yaml). - -## Installation Modes - -| Mode | Description | Example | -|------|-------------|---------| -| Fully non-interactive | Provide all flags to skip all prompts | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` | -| Semi-interactive | Provide some flags; BMad prompts for the rest | `npx bmad-method install --directory . --modules bmm` | -| Defaults only | Accept all defaults with `-y` | `npx bmad-method install --yes` | -| Without tools | Skip tool/IDE configuration | `npx bmad-method install --modules bmm --tools none` | - -## Examples - -### CI/CD Pipeline Installation - -```bash -#!/bin/bash -# install-bmad.sh - -npx bmad-method install \ - --directory "${GITHUB_WORKSPACE}" \ - --modules bmm \ - --tools claude-code \ - --user-name "CI Bot" \ - --communication-language English \ - --document-output-language English \ - --output-folder _bmad-output \ - --yes -``` - -### Update Existing Installation - -```bash -npx bmad-method install \ - --directory ~/projects/myapp \ - --action update \ - --modules bmm,bmb,custom-module -``` - -### Quick Update (Preserve Settings) - -```bash -npx bmad-method install \ - --directory ~/projects/myapp \ - --action quick-update -``` - -### Installation with Custom Content - -```bash -npx bmad-method install \ - --directory ~/projects/myapp \ - --modules bmm \ - --custom-content ~/my-custom-module,~/another-module \ - --tools claude-code -``` - -## What You Get - -- A fully configured `_bmad/` directory in your project -- Agents and workflows configured for your selected modules and tools -- A `_bmad-output/` folder for generated artifacts - -## Validation and Error Handling - -BMad validates all provided flags: - -- **Directory** — Must be a valid path with write permissions -- **Modules** — Warns about invalid module IDs (but won't fail) -- **Tools** — Warns about invalid tool IDs (but won't fail) -- **Custom Content** — Each path must contain a valid `module.yaml` file -- **Action** — Must be one of: `install`, `update`, `quick-update` - -Invalid values will either: -1. Show an error and exit (for critical options like directory) -2. Show a warning and skip (for optional items like custom content) -3. Fall back to interactive prompts (for missing required values) - -:::tip[Best Practices] -- Use absolute paths for `--directory` to avoid ambiguity -- Use an absolute path for `--output-folder` when you want artifacts written outside the project tree (e.g. a shared monorepo outputs directory) -- Test flags locally before using in CI/CD pipelines -- Combine with `-y` for truly unattended installations -- Use `--debug` if you encounter issues during installation -::: - -## Troubleshooting - -### Installation fails with "Invalid directory" - -- The directory path must exist (or its parent must exist) -- You need write permissions -- The path must be absolute or correctly relative to the current directory - -### Module not found - -- Verify the module ID is correct -- External modules must be available in the registry - -### Custom content path invalid - -Ensure each custom content path: -- Points to a directory -- Contains a `module.yaml` file in the root -- Has a `code` field in the `module.yaml` - -:::note[Still stuck?] -Run with `--debug` for detailed output, try interactive mode to isolate the issue, or report at . +:::note[This page has moved] +Headless and CI install flags, channel selection, and pinning now live in the unified [How to Install BMad](./install-bmad.md) guide. Jump to the [Headless / CI installs](./install-bmad.md#headless-ci-installs) section for the flag reference and copy-paste recipes. ::: diff --git a/docs/how-to/project-context.md b/docs/how-to/project-context.md index 7cb3b3b04..51e59ac3f 100644 --- a/docs/how-to/project-context.md +++ b/docs/how-to/project-context.md @@ -1,16 +1,17 @@ --- -title: "Manage Project Context" +title: 'Manage Project Context' description: Create and maintain project-context.md to guide AI agents sidebar: - order: 8 + order: 9 --- Use the `project-context.md` file to ensure AI agents follow your project's technical preferences and implementation rules throughout all workflows. To make sure this is always available, you can also add the line `Important project context and conventions are located in [path to project context]/project-context.md` to your tools context or always rules file (such as `AGENTS.md`) :::note[Prerequisites] + - BMad Method installed - Understanding of your project's technology stack and conventions -::: + ::: ## When to Use This @@ -60,14 +61,17 @@ sections_completed: ['technology_stack', 'critical_rules'] ## Critical Implementation Rules **TypeScript:** + - Strict mode enabled, no `any` types - Use `interface` for public APIs, `type` for unions **Code Organization:** + - Components in `/src/components/` with co-located tests - API calls use `apiClient` singleton — never fetch directly **Testing:** + - Unit tests focus on business logic - Integration tests use MSW for API mocking ``` @@ -115,11 +119,12 @@ A `project-context.md` file that: ## Tips :::tip[Best Practices] + - **Focus on the unobvious** — Document patterns agents might miss (e.g., "Use JSDoc on every public class"), not universal practices like "use meaningful variable names." - **Keep it lean** — This file is loaded by every implementation workflow. Long files waste context. Exclude content that only applies to narrow scope or specific stories. - **Update as needed** — Edit manually when patterns change, or re-generate after significant architecture changes. - Works for Quick Flow and full BMad Method projects alike. -::: + ::: ## Next Steps diff --git a/docs/how-to/quick-fixes.md b/docs/how-to/quick-fixes.md index 3b695a52d..f6ca5369d 100644 --- a/docs/how-to/quick-fixes.md +++ b/docs/how-to/quick-fixes.md @@ -1,8 +1,8 @@ --- -title: "Quick Fixes" +title: 'Quick Fixes' description: How to make quick fixes and ad-hoc changes sidebar: - order: 5 + order: 6 --- Use **Quick Dev** for bug fixes, refactorings, or small targeted changes that don't require the full BMad Method. @@ -15,9 +15,10 @@ Use **Quick Dev** for bug fixes, refactorings, or small targeted changes that do - Dependency updates :::note[Prerequisites] + - BMad Method installed (`npx bmad-method install`) - An AI-powered IDE (Claude Code, Cursor, or similar) -::: + ::: ## Steps diff --git a/docs/how-to/shard-large-documents.md b/docs/how-to/shard-large-documents.md index 68cbbfc6b..8b8719f2b 100644 --- a/docs/how-to/shard-large-documents.md +++ b/docs/how-to/shard-large-documents.md @@ -1,8 +1,8 @@ --- -title: "Document Sharding Guide" +title: 'Document Sharding Guide' description: Split large markdown files into smaller organized files for better context management sidebar: - order: 9 + order: 10 --- Use the `bmad-shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management. diff --git a/docs/how-to/upgrade-to-v6.md b/docs/how-to/upgrade-to-v6.md index ae0b43aac..567dbe93c 100644 --- a/docs/how-to/upgrade-to-v6.md +++ b/docs/how-to/upgrade-to-v6.md @@ -1,8 +1,8 @@ --- -title: "How to Upgrade to v6" +title: 'How to Upgrade to v6' description: Migrate from BMad v4 to v6 sidebar: - order: 3 + order: 4 --- Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance. @@ -14,9 +14,10 @@ Use the BMad installer to upgrade from v4 to v6, which includes automatic detect - You have existing planning artifacts to preserve :::note[Prerequisites] + - Node.js 20+ - Existing BMad v4 installation -::: + ::: ## Steps diff --git a/docs/index.md b/docs/index.md index acbb7ad96..f4a617d00 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,7 +33,7 @@ These docs are organized into four sections based on what you're trying to do: | **Explanation** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. | | **Reference** | Information-oriented. Technical specifications for agents, workflows, and configuration. | -## Extend and Customize +## Expand and Customize Want to expand BMad with your own agents, workflows, or modules? The **[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** provides the framework and tools for creating custom extensions, whether you're adding new capabilities to BMad or building entirely new modules from scratch. diff --git a/docs/reference/agents.md b/docs/reference/agents.md index 59d2f1372..4e05cde1b 100644 --- a/docs/reference/agents.md +++ b/docs/reference/agents.md @@ -17,7 +17,7 @@ This page lists the default BMM (Agile suite) agents that install with BMad Meth | Agent | Skill ID | Triggers | Primary workflows | | --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- | -| Analyst (Mary) | `bmad-analyst` | `BP`, `RS`, `CB`, `WB`, `DP` | Brainstorm Project, Research, Create Brief, PRFAQ Challenge, Document Project | +| Analyst (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorm, Market Research, Domain Research, Technical Research, Create Brief, PRFAQ Challenge, Document Project | | Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course | | Architect (Winston) | `bmad-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness | | Developer (Amelia) | `bmad-agent-dev` | `DS`, `QD`, `QA`, `CR`, `SP`, `CS`, `ER` | Dev Story, Quick Dev, QA Test Generation, Code Review, Sprint Planning, Create Story, Epic Retrospective | diff --git a/docs/reference/commands.md b/docs/reference/commands.md index 5445ab667..7776f94b6 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -92,7 +92,7 @@ Workflow skills run a structured, multi-step process without loading an agent pe | Example skill | Purpose | | --- | --- | | `bmad-product-brief` | Create a product brief — guided discovery when your concept is clear | -| `bmad-prfaq` | Working Backwards PRFAQ challenge to stress-test your product concept | +| `bmad-prfaq` | [Working Backwards PRFAQ](../explanation/analysis-phase.md#prfaq-working-backwards) challenge to stress-test your product concept | | `bmad-create-prd` | Create a Product Requirements Document | | `bmad-create-architecture` | Design system architecture | | `bmad-create-epics-and-stories` | Create epics and stories | diff --git a/docs/vi-vn/bmad-developer-guide.md b/docs/vi-vn/bmad-developer-guide.md new file mode 100644 index 000000000..84a3b5af0 --- /dev/null +++ b/docs/vi-vn/bmad-developer-guide.md @@ -0,0 +1,826 @@ +--- +title: Hướng dẫn BMAD cho Developer +description: Tài liệu tổng quan bằng tiếng Việt dành cho developer muốn áp dụng BMAD Method từ ý tưởng đến triển khai +--- + +# BMAD Method — Hướng dẫn toàn diện cho Developer + +> **BMAD** (Build More Architect Dreams) là framework phát triển phần mềm hỗ trợ bởi AI, giúp team đi từ ý tưởng đến sản phẩm một cách có cấu trúc, nhất quán và hiệu quả. + +--- + +## Mục lục + +1. [BMAD là gì?](#1-bmad-là-gì) +2. [Nguyên lý cốt lõi](#2-nguyên-lý-cốt-lõi) +3. [Kiến trúc hệ thống — Các Agent](#3-kiến-trúc-hệ-thống--các-agent) +4. [Quy trình làm việc — 4 Giai đoạn](#4-quy-trình-làm-việc--4-giai-đoạn) +5. [Chọn nhánh phù hợp](#5-chọn-nhánh-phù-hợp) +6. [Hướng dẫn từng bước áp dụng BMAD](#6-hướng-dẫn-từng-bước-áp-dụng-bmad) +7. [Kiểm thử với BMAD — Hướng dẫn cho QC](#7-kiểm-thử-với-bmad--hướng-dẫn-cho-qc) +8. [Các công cụ hỗ trợ](#8-các-công-cụ-hỗ-trợ) +9. [Cấu trúc thư mục dự án](#9-cấu-trúc-thư-mục-dự-án) +10. [Mẹo và Best Practices](#10-mẹo-và-best-practices) + +--- + +## 1. BMAD là gì? + +**BMAD Method** là một hệ thống phối hợp nhiều AI agent chuyên biệt để hỗ trợ toàn bộ vòng đời phát triển phần mềm — từ phân tích ý tưởng, lập kế hoạch, thiết kế kiến trúc, đến triển khai code và kiểm thử. + +### Điểm khác biệt so với cách dùng AI thông thường + +| Cách thông thường | BMAD Method | +|---|---| +| Hỏi AI từng câu rời rạc | Workflow có cấu trúc, mỗi bước tạo đầu ra cho bước kế tiếp | +| Một AI làm tất cả | Nhiều agent chuyên biệt, mỗi agent hiểu sâu vai trò của mình | +| Không có tài liệu hóa | Mỗi giai đoạn sinh ra tài liệu chuẩn (PRD, Architecture, Stories) | +| Developer phải giám sát liên tục | Agent tự chủ dài hơn, chỉ cần con người tại các điểm kiểm tra quan trọng | + +### BMAD phù hợp với ai? + +- **Developer** cần xây dựng tính năng nhanh, chất lượng cao +- **Tech Lead / Architect** cần thiết kế hệ thống và phân rã công việc +- **Product Manager** cần định nghĩa yêu cầu rõ ràng +- **QC/Tester** cần sinh test case có truy vết yêu cầu +- **Team nhỏ** muốn áp dụng quy trình chuẩn không cần nhiều overhead + +--- + +## 2. Nguyên lý cốt lõi + +### 2.1. Tài liệu là "ngôn ngữ chung" giữa con người và AI + +Mỗi giai đoạn trong BMAD sinh ra một tài liệu chuẩn. Tài liệu đó trở thành **đầu vào** cho giai đoạn kế tiếp. Agent AI đọc tài liệu để hiểu context, thay vì phụ thuộc vào lịch sử hội thoại có thể bị mất. + +``` +Ý tưởng → [Brief/PRFAQ] → PRD → Architecture → Epics/Stories → Code → Tests +``` + +### 2.2. Phân tách "XÂY GÌ" và "XÂY NHƯ THẾ NÀO" + +BMAD tách bạch rõ ràng hai câu hỏi quan trọng nhất: + +- **Planning (Giai đoạn 2)**: Trả lời **"XÂY GÌ và vì sao?"** → Đầu ra: PRD +- **Solutioning (Giai đoạn 3)**: Trả lời **"XÂY NHƯ THẾ NÀO?"** → Đầu ra: Architecture + Epics/Stories + +> Đây là nguyên lý quan trọng nhất. Nhiều dự án thất bại vì triển khai khi chưa thống nhất được "XÂY GÌ", hoặc bắt đầu code mà chưa quyết định "XÂY NHƯ THẾ NÀO". + +### 2.3. Agent chuyên biệt — mỗi vai trò một chuyên gia + +BMAD không dùng một AI đa năng mà dùng các agent được cấu hình để đóng vai chuyên gia cụ thể: PM, Architect, Developer, UX Designer, Technical Writer. Mỗi agent có phong cách tư duy, ưu tiên, và workflow riêng. + +### 2.4. Con người chỉ tham gia tại các điểm kiểm tra quan trọng + +BMAD được thiết kế để AI tự chủ trong phạm vi đã định nghĩa, chỉ đưa con người vào: + +- Phê duyệt chuyển giai đoạn (PRD xong → Architect làm việc) +- Review kết quả tổng thể (sau Dev Story, sau epic) +- Quyết định thay đổi hướng (Correct Course) + +### 2.5. Có thể mở rộng theo nhu cầu + +Ba nhánh lập kế hoạch với độ phức tạp tăng dần: + +| Nhánh | Phù hợp với | Story ước tính | +|---|---|---| +| **Quick Flow** | Bug fix, tính năng nhỏ, phạm vi rõ | 1–15 stories | +| **BMad Method** | Sản phẩm, nền tảng, tính năng phức tạp | 10–50+ stories | +| **Enterprise** | Hệ thống tuân thủ, đa tenant, đa team | 30+ stories | + +--- + +## 3. Kiến trúc hệ thống — Các Agent + +### 3.1. Các Agent chính + +| Agent | Tên nhân vật | Skill ID | Vai trò | +|---|---|---|---| +| **Analyst** | Mary | `bmad-analyst` | Brainstorm, nghiên cứu thị trường/kỹ thuật, tạo Product Brief và PRFAQ | +| **Product Manager** | John | `bmad-pm` | Tạo và quản lý PRD, Epics, Stories, kiểm tra Implementation Readiness | +| **Architect** | Winston | `bmad-architect` | Thiết kế Architecture, ADR, kiểm tra Implementation Readiness | +| **Developer** | Amelia | `bmad-agent-dev` | Triển khai story, tạo test, code review, sprint planning | +| **UX Designer** | Sally | `bmad-ux-designer` | Thiết kế UX specification | +| **Technical Writer** | Paige | `bmad-tech-writer` | Viết tài liệu, cập nhật standards, giải thích khái niệm | + +### 3.2. Cách gọi Agent + +**Qua Skill** (Claude Code / Cursor): +``` +bmad-analyst +bmad-pm +bmad-architect +bmad-agent-dev +``` + +**Qua Trigger** (sau khi đã nạp agent, gõ mã ngắn trong hội thoại): + +| Trigger | Agent | Workflow | +|---|---|---| +| `BP` | Analyst | Brainstorm | +| `CB` | Analyst | Create Brief | +| `CP` | PM | Create PRD | +| `VP` | PM | Validate PRD | +| `EP` | PM | Create Epics & Stories | +| `CA` | Architect | Create Architecture | +| `IR` | PM / Architect | Implementation Readiness | +| `SP` | Developer | Sprint Planning | +| `DS` | Developer | Dev Story | +| `QA` | Developer | QA Test Generation | +| `CR` | Developer | Code Review | + +--- + +## 4. Quy trình làm việc — 4 Giai đoạn + +``` +┌─────────────────┐ ┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐ +│ Giai đoạn 1 │ │ Giai đoạn 2 │ │ Giai đoạn 3 │ │ Giai đoạn 4 │ +│ PHÂN TÍCH │───▶│ LẬP KẾ HOẠCH │───▶│ ĐỊNH HÌNH GIẢI │───▶│ TRIỂN KHAI │ +│ (Tùy chọn) │ │ (Bắt buộc) │ │ PHÁP (BMad/Ent) │ │ (Bắt buộc) │ +│ │ │ │ │ │ │ │ +│ Brief, PRFAQ │ │ PRD, UX Spec │ │ Architecture, │ │ Sprint, Stories, │ +│ Research │ │ │ │ Epics, Stories │ │ Code, Test, QA │ +└─────────────────┘ └─────────────────┘ └──────────────────┘ └─────────────────┘ +``` + +### Giai đoạn 1: Phân tích (Tùy chọn) + +Giai đoạn này giúp khám phá và xác nhận ý tưởng **trước khi** cam kết lập kế hoạch chi tiết. Bỏ qua nếu yêu cầu đã rõ. + +**Các công cụ:** + +**Brainstorming** — Khi cần khai phá ý tưởng +``` +Trigger: BP (trong agent Analyst) +Đầu ra: brainstorming-report.md +``` +Sử dụng 60+ kỹ thuật brainstorming, tạo 100+ ý tưởng đa dạng, sau đó phân tích, lọc và đề xuất hướng tiếp cận. + +**Product Brief** — Khi concept đã tương đối rõ +``` +Trigger: CB (trong agent Analyst) +Đầu ra: product-brief.md +``` +Tóm tắt điều hành 1–2 trang: vấn đề, giải pháp, đối tượng, lợi thế cạnh tranh, rủi ro. + +**PRFAQ** — Khi cần stress-test concept +``` +Trigger: (hỏi Analyst về PRFAQ) +Đầu ra: prfaq.md +``` +Phương pháp "Working Backwards" của Amazon: viết thông cáo báo chí như thể sản phẩm đã tồn tại, sau đó trả lời các câu hỏi khó nhất từ khách hàng. Buộc phải rõ ràng theo hướng lấy khách hàng làm trung tâm. + +**Nghiên cứu** — Xác thực giả định +``` +Trigger: MR (Market Research), DR (Domain Research), TR (Technical Research) +``` + +--- + +### Giai đoạn 2: Lập kế hoạch (Bắt buộc) + +Xác định rõ **cần xây gì** và **cho ai**. + +**Tạo PRD** — PM Agent +``` +Trigger: CP +Đầu ra: PRD.md +``` +PRD bao gồm: mục tiêu sản phẩm, functional requirements (FR), non-functional requirements (NFR), user stories cấp cao, acceptance criteria. + +**Thiết kế UX** — UX Designer Agent (Tùy chọn) +``` +Trigger: CU +Đầu ra: ux-spec.md +``` +Dùng khi UX/UI là yếu tố quan trọng. Bao gồm user flows, component specs, interaction patterns. + +**Validate PRD** — PM Agent +``` +Trigger: VP +``` +Kiểm tra tính đầy đủ, nhất quán, và khả năng triển khai của PRD trước khi chuyển sang giai đoạn 3. + +--- + +### Giai đoạn 3: Định hình giải pháp (Bắt buộc với BMad Method / Enterprise) + +Quyết định **xây như thế nào** và phân rã công việc. + +**Tạo Architecture** — Architect Agent +``` +Trigger: CA +Đầu ra: architecture.md + ADR (Architecture Decision Records) +``` +Bao gồm: tech stack, component design, data models, API contracts, deployment strategy, ADR cho các quyết định quan trọng. + +**Tạo Epics & Stories** — PM Agent +``` +Trigger: EP +Đầu ra: epics/ thư mục với các file story +``` +Phân rã PRD và Architecture thành Epics (nhóm tính năng) và Stories (đơn vị công việc cụ thể). Mỗi story có: mô tả, acceptance criteria, technical notes. + +**Implementation Readiness Check** — Architect Agent +``` +Trigger: IR +Kết quả: PASS / CONCERNS / FAIL +``` +Cổng kiểm tra trước khi bắt đầu triển khai. Đảm bảo mọi thứ đã đủ rõ ràng để developer có thể làm việc độc lập. + +--- + +### Giai đoạn 4: Triển khai (Bắt buộc) + +Xây dựng từng story một theo thứ tự ưu tiên. + +**Sprint Planning** — Developer Agent +``` +Trigger: SP +Đầu ra: sprint-status.yaml +``` +Xác định stories sẽ làm trong sprint, thứ tự ưu tiên và tracking. + +**Dev Story** — Developer Agent +``` +Trigger: DS +Đầu ra: Code chạy được + unit/integration tests +``` +Agent tự chủ triển khai story theo acceptance criteria. Đọc architecture và project-context để đảm bảo nhất quán. + +**Code Review** — Developer Agent +``` +Trigger: CR +Kết quả: Approved / Changes Requested +``` +Review tự động: correctness, style, security, performance, test coverage. + +**QA Test Generation** — Developer Agent +``` +Trigger: QA +Đầu ra: API tests + E2E tests +``` +Sinh test case cho API và E2E sau khi epic hoàn tất. Chi tiết ở [Mục 7](#7-kiểm-thử-với-bmad--hướng-dẫn-cho-qc). + +**Correct Course** — PM Agent +``` +Trigger: CC +``` +Xử lý thay đổi yêu cầu lớn giữa sprint mà không phá vỡ quy trình. + +**Retrospective** — Developer Agent +``` +Trigger: ER (Epic Retrospective) +``` +Review sau khi hoàn tất một epic. Ghi lại bài học, pattern tốt, vấn đề gặp phải. + +--- + +## 5. Chọn nhánh phù hợp + +### Quick Flow — Nhánh nhanh + +**Khi nào dùng:** +- Bug fix +- Tính năng nhỏ, phạm vi rõ ràng +- Cập nhật đơn lẻ (1–15 stories) +- Bạn đã hiểu đầy đủ yêu cầu + +**Bỏ qua:** Giai đoạn 1, 2, 3 hoàn toàn + +**Dùng:** Quick Dev (`bmad-quick-dev`) + +``` +Mô tả yêu cầu → Làm rõ ý định → Sinh spec → Triển khai → Review → Done +``` + +Quick Dev gộp tất cả vào một workflow: làm rõ yêu cầu, lập kế hoạch mini, triển khai, code review, và trình bày kết quả. + +--- + +### BMad Method — Nhánh đầy đủ + +**Khi nào dùng:** +- Sản phẩm mới hoặc nền tảng +- Tính năng phức tạp với nhiều dependencies +- 10–50+ stories cần phối hợp nhiều developer + +**Đi qua:** Giai đoạn 1 (tùy chọn) → 2 → 3 → 4 + +--- + +### Enterprise — Nhánh mở rộng + +**Khi nào dùng:** +- Hệ thống đa tenant +- Yêu cầu tuân thủ (compliance), security audit +- 30+ stories, nhiều team +- Cần truy vết yêu cầu đầy đủ + +**Thêm vào:** Security review, DevOps pipeline, NFR assessment, Test Architect Module (TEA) + +--- + +## 6. Hướng dẫn từng bước áp dụng BMAD + +### 6.1. Dự án mới + +#### Bước 1: Cài đặt BMAD + +```bash +# Yêu cầu: Node.js 20+, Git +npx bmad-method install +``` + +Trình cài đặt sẽ hỏi: +- IDE đang dùng (Claude Code, Cursor, hoặc tương tự) +- Modules muốn cài (core bắt buộc, thêm TEA nếu cần test nâng cao) +- Nhánh lập kế hoạch (Quick Flow / BMad Method / Enterprise) + +#### Bước 2: Khởi động với bmad-help + +``` +bmad-help +``` + +Đây là điểm bắt đầu thông minh. Agent sẽ hỏi về dự án của bạn và dẫn bạn đến đúng workflow. + +``` +bmad-help Tôi có ý tưởng về ứng dụng SaaS quản lý task, bắt đầu từ đâu? +bmad-help Tôi cần thêm tính năng export PDF, dùng quick flow hay đầy đủ? +``` + +#### Bước 3: Tạo Project Context (khuyến nghị mạnh) + +```bash +# Tạo tự động sau khi có architecture +bmad-generate-project-context + +# Hoặc tạo thủ công +touch _bmad-output/project-context.md +``` + +File `project-context.md` là "bản hiến pháp" kỹ thuật của dự án — được tất cả agent tự động nạp: + +```markdown +# Project Context + +## Technology Stack +- Node.js 20.x, TypeScript 5.3 +- React 18.2, Zustand (không dùng Redux) +- PostgreSQL 15, Prisma ORM +- Testing: Vitest, Playwright, MSW + +## Critical Implementation Rules +- Bật strict mode — không dùng `any` +- Dùng `interface` cho public API, `type` cho union/intersection +- API calls phải qua `apiClient` singleton +- Components đặt trong `/src/components/` với co-located tests +``` + +#### Bước 4: Chạy Analysis (nếu cần) + +```bash +# Mở agent Analyst +bmad-analyst + +# Trong hội thoại, gõ trigger: +BP # Brainstorm ý tưởng +CB # Tạo Product Brief +MR # Research thị trường +``` + +#### Bước 5: Tạo PRD + +```bash +# Mở agent PM +bmad-pm + +# Trigger tạo PRD +CP # Create PRD (có hướng dẫn từng bước) +VP # Validate PRD sau khi hoàn thiện +``` + +#### Bước 6: Tạo Architecture (BMad Method / Enterprise) + +```bash +# Mở agent Architect +bmad-architect + +# Trigger +CA # Create Architecture +IR # Implementation Readiness Check +``` + +#### Bước 7: Tạo Epics & Stories + +```bash +# Mở agent PM +bmad-pm + +# Trigger +EP # Create Epics and Stories +``` + +#### Bước 8: Triển khai theo Stories + +```bash +# Mở agent Developer +bmad-agent-dev + +# Mỗi sprint +SP # Sprint Planning +DS # Dev Story (làm từng story) +CR # Code Review +QA # Tạo tests (sau khi epic hoàn tất) +ER # Epic Retrospective +``` + +--- + +### 6.2. Dự án đã tồn tại + +#### Bước 1: Tạo Project Context từ codebase hiện tại + +```bash +# Chạy trong agent Developer hoặc Architect +bmad-generate-project-context +``` + +Agent sẽ khám phá codebase và tạo `project-context.md` từ: +- `package.json`, `pyproject.toml`, hoặc build files +- Cấu trúc thư mục +- Conventions hiện có trong code + +#### Bước 2: Tạo tài liệu index + +Tạo hoặc cập nhật `docs/index.md` với: +- Mục tiêu kinh doanh của dự án +- Architecture overview +- Các quy tắc quan trọng cần giữ + +#### Bước 3: Chọn cách tiếp cận phù hợp + +- **Thay đổi nhỏ** (bug fix, tính năng nhỏ): Dùng `bmad-quick-dev` trực tiếp +- **Thay đổi lớn** (module mới, refactor lớn): Dùng BMad Method đầy đủ từ Giai đoạn 2 + +#### Bước 4: Quick Dev cho việc nhỏ + +```bash +# Mở skill Quick Dev +bmad-quick-dev + +# Mô tả yêu cầu, agent sẽ: +# 1. Làm rõ ý định (có người trong vòng lặp) +# 2. Tạo mini-spec nếu cần +# 3. Triển khai tự động +# 4. Code review +# 5. Trình bày kết quả để bạn approve +``` + +--- + +### 6.3. Luồng làm việc mẫu — Tính năng mới (BMad Method) + +``` +Ngày 1-2: Analysis + ├── bmad-analyst → CB → product-brief.md + └── (tùy chọn) bmad-analyst → MR → market-research.md + +Ngày 2-3: Planning + ├── bmad-pm → CP → PRD.md + ├── bmad-pm → VP (validate) + └── (nếu có UI) bmad-ux-designer → CU → ux-spec.md + +Ngày 3-4: Solutioning + ├── bmad-architect → CA → architecture.md + ├── bmad-pm → EP → epics/ (stories) + └── bmad-architect → IR → PASS ✓ + +Ngày 5+: Implementation (lặp lại cho mỗi story) + ├── bmad-agent-dev → SP → sprint-status.yaml + ├── bmad-agent-dev → DS → code + tests + ├── bmad-agent-dev → CR → approved + └── (sau epic) bmad-agent-dev → QA → e2e tests +``` + +--- + +## 7. Kiểm thử với BMAD — Hướng dẫn cho QC + +BMAD cung cấp hai hướng tiếp cận kiểm thử: + +### 7.1. QA tích hợp sẵn — Nhẹ nhàng (Developer Agent) + +**Phù hợp với:** Dự án nhỏ–trung bình, cần bao phủ test nhanh + +**Kích hoạt:** +```bash +# Trong agent Developer +bmad-agent-dev + +# Sau khi hoàn tất một epic (tất cả stories đã dev + review xong) +QA # QA Test Generation +``` + +**5 bước workflow QA:** + +1. **Phát hiện framework**: Agent tự nhận diện Jest, Vitest, Playwright, Cypress từ codebase +2. **Xác định tính năng cần test**: Dựa vào stories và acceptance criteria của epic vừa hoàn tất +3. **Tạo API tests**: Status codes, cấu trúc response, happy path, edge cases +4. **Tạo E2E tests**: User workflows, semantic locators (role/label/text — không dùng CSS selector) +5. **Chạy và xác minh**: Tự chạy tests, phát hiện và sửa lỗi ngay + +**Các nguyên tắc khi sinh test:** + +```typescript +// ✅ Dùng semantic locator +await page.getByRole('button', { name: 'Đăng nhập' }).click() +await page.getByLabel('Email').fill('user@example.com') + +// ❌ Không dùng CSS selector cứng +await page.locator('.btn-primary#login').click() + +// ✅ Test độc lập, không phụ thuộc thứ tự +test('create task', async () => { + // setup riêng cho test này +}) + +// ❌ Không hardcode wait/sleep +await page.waitForTimeout(3000) // Không làm thế này +``` + +**Khi nào dùng:** +- Cần bao phủ test nhanh cho tính năng mới +- Dự án nhỏ–trung bình không cần chiến lược kiểm thử nâng cao +- Muốn tự động hóa kiểm thử mà không cần thiết lập phức tạp + +--- + +### 7.2. Module Test Architect (TEA) — Nâng cao + +**Phù hợp với:** Dự án lớn, miền nghiệp vụ phức tạp, cần truy vết yêu cầu + +**Cài đặt:** +```bash +npx bmad-method install +# Chọn thêm module: TEA (Test Architect) +``` + +**Agent TEA:** Murat (Master Test Architect) + +**9 workflow của TEA:** + +| # | Workflow | Mục đích | +|---|---|---| +| 1 | **Test Design** | Tạo chiến lược kiểm thử gắn với yêu cầu (PRD/AC) | +| 2 | **ATDD** | Phát triển hướng Acceptance Test — viết test trước khi code | +| 3 | **Automate** | Tạo automated test với pattern nâng cao | +| 4 | **Test Review** | Kiểm tra chất lượng và độ bao phủ của bộ test | +| 5 | **Traceability** | Liên kết test ngược về yêu cầu trong PRD | +| 6 | **NFR Assessment** | Đánh giá yêu cầu phi chức năng (performance, security, reliability) | +| 7 | **CI Setup** | Cấu hình thực thi test trong CI/CD pipeline | +| 8 | **Framework Scaffolding** | Dựng hạ tầng test cho dự án mới | +| 9 | **Release Gate** | Ra quyết định go/no-go dựa trên chất lượng | + +**Hệ thống ưu tiên P0–P3:** + +| Mức | Ý nghĩa | Ví dụ | +|---|---|---| +| **P0** | Critical — phải pass 100% | Thanh toán, xác thực, bảo mật | +| **P1** | High — phải pass cho release | Core business flow | +| **P2** | Medium — nên pass | Tính năng phụ, edge cases | +| **P3** | Low — test khi có thể | UI detail, minor UX | + +**Luồng ATDD với TEA:** + +``` +QC viết Acceptance Criteria (AC) → +TEA tạo test từ AC (trước khi code) → +Developer implement để test pass → +TEA verify traceability (AC ↔ test ↔ requirement) → +Release Gate go/no-go +``` + +--- + +### 7.3. So sánh hai hướng tiếp cận + +| Yếu tố | QA tích hợp sẵn | Module TEA | +|---|---|---| +| Thời điểm test | Sau khi epic hoàn tất | Có thể trước khi code (ATDD) | +| Thiết lập | Không cần cài thêm | Cài module riêng | +| Loại test | API + E2E | API, E2E, ATDD, NFR, Performance | +| Truy vết yêu cầu | Không | Có (Traceability workflow) | +| Release gate | Không | Có (go/no-go) | +| Phù hợp nhất | Dự án nhỏ–trung bình | Dự án lớn, có compliance | + +--- + +### 7.4. Vị trí kiểm thử trong vòng đời dự án + +``` +Story 1: Dev → Code Review → ✓ +Story 2: Dev → Code Review → ✓ +Story 3: Dev → Code Review → ✓ +... +Epic hoàn tất → QA Test Generation → Tests pass → Epic Retrospective +``` + +> **Lưu ý:** QA Test Generation chạy **sau khi toàn bộ epic hoàn tất**, không phải sau từng story. Mục đích là kiểm thử tích hợp các stories với nhau. + +--- + +### 7.5. Edge Case Hunter — Công cụ tìm trường hợp biên + +Ngoài QA workflow, Developer Agent còn hỗ trợ: + +```bash +# Trong hội thoại với Developer Agent +bmad-review-edge-case-hunter +``` + +Phân tích toàn bộ nhánh điều kiện trong code để tìm: +- Trường hợp biên chưa được xử lý +- Null/undefined checks bị thiếu +- Điều kiện race condition +- Input validation gaps + +--- + +## 8. Các công cụ hỗ trợ + +### 8.1. Party Mode — Thảo luận đa agent + +```bash +bmad-party-mode +``` + +Triệu tập nhiều agent vào cùng một hội thoại để thảo luận các quyết định quan trọng: + +- **Kiến trúc**: PM + Architect + Developer cùng đánh giá trade-off +- **Tính năng phức tạp**: UX Designer + Architect + PM +- **Post-mortem**: Tất cả agent cùng phân tích sự cố +- **Sprint retrospective**: PM + Developer + QC + +### 8.2. Advanced Elicitation — Tinh luyện đầu ra + +```bash +bmad-advanced-elicitation +``` + +Buộc AI xem xét lại đầu ra bằng các phương pháp: + +| Phương pháp | Mục đích | +|---|---| +| **Pre-mortem** | Giả sử thất bại → lần ngược nguyên nhân | +| **First Principles** | Loại bỏ giả định, bắt đầu từ sự thật cơ bản | +| **Red Team / Blue Team** | Tự tấn công, tự bảo vệ | +| **Socratic Questioning** | Chất vấn mọi khẳng định | +| **Constraint Removal** | Bỏ ràng buộc → thấy giải pháp khác | +| **Stakeholder Mapping** | Đánh giá từ góc nhìn từng bên liên quan | + +Dùng sau khi có một tài liệu quan trọng (PRD, Architecture) để tìm điểm yếu trước khi tiếp tục. + +### 8.3. Adversarial Review — Review hoài nghi + +```bash +bmad-review-adversarial-general +``` + +Review kiểu "devil's advocate" — giả định vấn đề luôn tồn tại: +- Phải tìm được tối thiểu 10 vấn đề +- Tìm những gì **còn thiếu**, không chỉ những gì sai +- Trực giao với Edge Case Hunter + +### 8.4. Distillator — Nén tài liệu cho LLM + +```bash +bmad-distillator +``` + +Khi tài liệu quá lớn (PRD dài, Architecture phức tạp), Distillator nén nội dung tối ưu cho LLM mà không mất thông tin quan trọng. + +### 8.5. Shard Large Documents — Tách file lớn + +```bash +bmad-shard-doc +``` + +Tách file markdown lớn thành các file phần nhỏ hơn, với index tự động. + +--- + +## 9. Cấu trúc thư mục dự án + +Sau khi cài BMAD và chạy qua các giai đoạn, dự án sẽ có cấu trúc: + +``` +your-project/ +├── _bmad/ # Cấu hình BMAD (không chỉnh sửa thủ công) +│ ├── core/ # Module core +│ └── bmm/ # Modules đã cài (TEA, v.v.) +│ +├── _bmad-output/ # Tất cả artifacts sinh ra +│ ├── project-context.md # Bản hiến pháp kỹ thuật của dự án +│ ├── planning-artifacts/ +│ │ ├── product-brief.md # Giai đoạn 1 output +│ │ ├── PRD.md # Giai đoạn 2 output +│ │ ├── ux-spec.md # Giai đoạn 2 output (nếu có) +│ │ ├── architecture.md # Giai đoạn 3 output +│ │ └── epics/ # Giai đoạn 3 output +│ │ ├── epic-1-auth/ +│ │ │ ├── story-1-login.md +│ │ │ ├── story-2-register.md +│ │ │ └── story-3-reset-password.md +│ │ └── epic-2-dashboard/ +│ └── implementation-artifacts/ +│ └── sprint-status.yaml # Tracking sprint +│ +├── .claude/skills/ # Skills cho Claude Code +│ ├── bmad-pm.md +│ ├── bmad-architect.md +│ └── ... +│ +├── docs/ # Tài liệu dự án +│ └── index.md # Overview, goals, architecture notes +│ +└── src/ # Source code dự án +``` + +--- + +## 10. Mẹo và Best Practices + +### Chat mới cho mỗi workflow + +> Luôn bắt đầu một hội thoại mới khi chuyển sang workflow khác. + +Mỗi workflow của BMAD thiết kế để chạy trong context rõ ràng. Việc tiếp tục hội thoại cũ có thể gây ra nhiễu context, đặc biệt với các workflow dài. + +### Đọc kỹ `project-context.md` trước khi bắt đầu sprint + +Tất cả agent developer tự động nạp `project-context.md`. Đảm bảo file này luôn cập nhật với: +- Tech stack và phiên bản chính xác +- Quy tắc implementation quan trọng +- Patterns đang dùng trong codebase + +### Kiến trúc là bắt buộc khi có nhiều developer + +Nếu nhiều agent (hoặc developer) làm việc song song trên các stories khác nhau, kiến trúc phải được định nghĩa trước. Thiếu kiến trúc → các agent tạo ra code xung đột nhau. + +### Dùng bmad-help khi không chắc + +``` +bmad-help Tôi đang ở đâu trong workflow? +bmad-help Story này nên dùng Quick Flow hay Dev Story? +bmad-help Implementation Readiness check thất bại, làm gì tiếp? +``` + +### Quick Flow không có nghĩa là không có chất lượng + +Quick Dev vẫn có code review, vẫn tạo spec (mini), vẫn yêu cầu người approve kết quả. "Nhanh" ở đây là bỏ overhead lập kế hoạch không cần thiết, không phải bỏ qua chất lượng. + +### Customize agent theo nhu cầu team + +```yaml +# .customize.yaml +agents: + bmad-agent-dev: + persona: "Senior developer theo hướng TDD, luôn viết test trước" + rules: + - "Mọi function public phải có unit test" + - "Không dùng any trong TypeScript" +``` + +### Vị trí QA trong workflow + +``` +❌ Sai: Test sau mỗi story ngay lập tức +✅ Đúng: Test sau khi toàn bộ epic hoàn tất (Dev + Code Review cho tất cả stories) +``` + +E2E test cần toàn bộ tính năng của epic để test integration. Test sớm hơn sẽ gặp dependency chưa sẵn sàng. + +--- + +## Tài liệu tham khảo + +| Tài liệu | Đường dẫn | +|---|---| +| Getting Started | [tutorials/getting-started.md](tutorials/getting-started.md) | +| Danh sách Agents | [reference/agents.md](reference/agents.md) | +| Workflow Map | [reference/workflow-map.md](reference/workflow-map.md) | +| Testing Reference | [reference/testing.md](reference/testing.md) | +| Core Tools | [reference/core-tools.md](reference/core-tools.md) | +| Modules | [reference/modules.md](reference/modules.md) | +| Dự án đã tồn tại | [how-to/established-projects.md](how-to/established-projects.md) | +| Project Context | [explanation/project-context.md](explanation/project-context.md) | +| Quick Dev | [explanation/quick-dev.md](explanation/quick-dev.md) | +| Why Solutioning Matters | [explanation/why-solutioning-matters.md](explanation/why-solutioning-matters.md) | +| Cài đặt BMAD | [how-to/install-bmad.md](how-to/install-bmad.md) | + +--- + +*Tài liệu này được tổng hợp từ bản dịch tiếng Việt của BMAD Method Documentation. Cập nhật lần cuối: 2026-04-15.* diff --git a/docs/vi-vn/explanation/analysis-phase.md b/docs/vi-vn/explanation/analysis-phase.md index 406f83a38..d35f9f65d 100644 --- a/docs/vi-vn/explanation/analysis-phase.md +++ b/docs/vi-vn/explanation/analysis-phase.md @@ -1,53 +1,53 @@ --- -title: "Giai đoạn Analysis: từ ý tưởng đến nền tảng" -description: Brainstorming, research, product brief và PRFAQ là gì, và nên dùng từng công cụ khi nào +title: "Giai đoạn phân tích: từ ý tưởng đến nền tảng" +description: Động não, nghiên cứu, product brief và PRFAQ là gì, và nên dùng từng công cụ khi nào sidebar: order: 1 --- -Giai đoạn Analysis (Phase 1) giúp bạn suy nghĩ rõ ràng về sản phẩm trước khi cam kết bắt tay vào xây dựng. Mọi công cụ trong giai đoạn này đều là tùy chọn, nhưng nếu bỏ qua toàn bộ phần analysis thì PRD của bạn sẽ được dựng trên giả định thay vì insight. +Giai đoạn phân tích (giai đoạn 1) giúp bạn suy nghĩ rõ ràng về sản phẩm trước khi cam kết bắt tay vào xây dựng. Mọi công cụ trong giai đoạn này đều là tùy chọn, nhưng nếu bỏ qua toàn bộ phần phân tích thì PRD của bạn sẽ được dựng trên giả định thay vì hiểu biết thực chất. -## Vì sao cần Analysis trước Planning? +## Vì sao cần phân tích trước khi lập kế hoạch? -PRD trả lời câu hỏi "chúng ta nên xây gì và vì sao?". Nếu đầu vào của nó là những suy nghĩ mơ hồ, bạn sẽ nhận lại một PRD mơ hồ, và mọi tài liệu phía sau đều kế thừa chính sự mơ hồ đó. Kiến trúc dựng trên một PRD yếu sẽ đặt cược sai về mặt kỹ thuật. Stories sinh ra từ một kiến trúc yếu sẽ bỏ sót edge case. Chi phí sẽ dồn lên theo từng tầng. +PRD trả lời câu hỏi "chúng ta nên xây gì và vì sao?". Nếu đầu vào của nó là những suy nghĩ mơ hồ, bạn sẽ nhận lại một PRD mơ hồ, và mọi tài liệu phía sau đều kế thừa chính sự mơ hồ đó. Kiến trúc dựng trên một PRD yếu sẽ đặt cược sai về mặt kỹ thuật. Các story sinh ra từ một kiến trúc yếu sẽ bỏ sót trường hợp biên. Chi phí sẽ dồn lên theo từng tầng. -Các công cụ analysis tồn tại để làm PRD của bạn sắc bén hơn. Chúng tiếp cận vấn đề từ nhiều góc độ khác nhau: khám phá sáng tạo, thực tế thị trường, độ rõ ràng về khách hàng, tính khả thi. Nhờ vậy, đến khi bạn ngồi xuống làm việc với PM agent, bạn đã biết mình đang xây cái gì và cho ai. +Các công cụ phân tích tồn tại để làm PRD của bạn sắc bén hơn. Chúng tiếp cận vấn đề từ nhiều góc độ khác nhau: khám phá sáng tạo, thực tế thị trường, độ rõ ràng về khách hàng, tính khả thi. Nhờ vậy, đến khi bạn ngồi xuống làm việc với agent PM, bạn đã biết mình đang xây cái gì và cho ai. ## Các công cụ -### Brainstorming +### Động não -**Nó là gì.** Một phiên sáng tạo có điều phối, sử dụng các kỹ thuật ideation đã được kiểm chứng. AI đóng vai trò như người huấn luyện, kéo ý tưởng ra từ bạn thông qua các bài tập có cấu trúc, chứ không nghĩ thay cho bạn. +**Nó là gì.** Một phiên sáng tạo có điều phối, sử dụng các kỹ thuật phát ý tưởng đã được kiểm chứng. AI đóng vai trò như người huấn luyện, kéo ý tưởng ra từ bạn thông qua các bài tập có cấu trúc, chứ không nghĩ thay cho bạn. -**Vì sao nó có mặt ở đây.** Ý tưởng thô cần không gian để phát triển trước khi bị khóa cứng thành requirement. Brainstorming tạo ra khoảng không đó. Nó đặc biệt có giá trị khi bạn có một miền vấn đề nhưng chưa có lời giải rõ ràng, hoặc khi bạn muốn khám phá nhiều hướng trước khi commit. +**Vì sao nó có mặt ở đây.** Ý tưởng thô cần không gian để phát triển trước khi bị khóa cứng thành yêu cầu. Động não tạo ra khoảng không đó. Nó đặc biệt có giá trị khi bạn có một miền vấn đề nhưng chưa có lời giải rõ ràng, hoặc khi bạn muốn khám phá nhiều hướng trước khi cam kết. -**Khi nào nên dùng.** Bạn có một hình dung mơ hồ về thứ mình muốn xây nhưng chưa kết tinh được thành khái niệm rõ ràng. Hoặc bạn đã có concept ban đầu nhưng muốn pressure-test nó với các phương án thay thế. +**Khi nào nên dùng.** Bạn có một hình dung mơ hồ về thứ mình muốn xây nhưng chưa kết tinh được thành khái niệm rõ ràng. Hoặc bạn đã có ý tưởng ban đầu nhưng muốn kiểm chứng độ vững của nó bằng các phương án thay thế. Xem [Brainstorming](./brainstorming.md) để hiểu sâu hơn về cách một phiên làm việc diễn ra. -### Research (Thị trường, miền nghiệp vụ, kỹ thuật) +### Nghiên cứu (thị trường, miền nghiệp vụ, kỹ thuật) -**Nó là gì.** Ba workflow nghiên cứu tập trung vào các chiều khác nhau của ý tưởng. Market research xem xét đối thủ, xu hướng và cảm nhận của người dùng. Domain research xây dựng hiểu biết về miền nghiệp vụ và thuật ngữ. Technical research đánh giá tính khả thi, các lựa chọn kiến trúc và hướng triển khai. +**Nó là gì.** Ba quy trình nghiên cứu tập trung vào các chiều khác nhau của ý tưởng. Nghiên cứu thị trường xem xét đối thủ, xu hướng và cảm nhận của người dùng. Nghiên cứu miền nghiệp vụ xây dựng hiểu biết về lĩnh vực và thuật ngữ. Nghiên cứu kỹ thuật đánh giá tính khả thi, các lựa chọn kiến trúc và hướng triển khai. -**Vì sao nó có mặt ở đây.** Xây dựng dựa trên giả định là con đường nhanh nhất để tạo ra thứ chẳng ai cần. Research đặt concept của bạn xuống mặt đất: đối thủ nào đã tồn tại, người dùng thực sự đang vật lộn với điều gì, điều gì khả thi về kỹ thuật, và bạn sẽ phải đối mặt với những ràng buộc đặc thù ngành nào. +**Vì sao nó có mặt ở đây.** Xây dựng dựa trên giả định là con đường nhanh nhất để tạo ra thứ chẳng ai cần. Nghiên cứu đặt ý tưởng của bạn xuống mặt đất: đối thủ nào đã tồn tại, người dùng thực sự đang vật lộn với điều gì, điều gì khả thi về kỹ thuật, và bạn sẽ phải đối mặt với những ràng buộc đặc thù ngành nào. -**Khi nào nên dùng.** Bạn đang bước vào một miền mới, nghi ngờ có đối thủ nhưng chưa lập bản đồ được, hoặc concept của bạn phụ thuộc vào những năng lực kỹ thuật mà bạn chưa kiểm chứng. Có thể chạy một, hai, hoặc cả ba; mỗi workflow đều đứng độc lập. +**Khi nào nên dùng.** Bạn đang bước vào một miền mới, nghi ngờ có đối thủ nhưng chưa lập bản đồ được, hoặc ý tưởng của bạn phụ thuộc vào những năng lực kỹ thuật mà bạn chưa kiểm chứng. Có thể chạy một, hai, hoặc cả ba; mỗi quy trình đều đứng độc lập. ### Product Brief **Nó là gì.** Một phiên discovery có hướng dẫn, tạo ra bản tóm tắt điều hành 1-2 trang cho concept sản phẩm của bạn. AI đóng vai trò Business Analyst cộng tác, giúp bạn diễn đạt tầm nhìn, đối tượng mục tiêu, giá trị cốt lõi và phạm vi. -**Vì sao nó có mặt ở đây.** Product brief là con đường nhẹ nhàng hơn để đi vào planning. Nó ghi lại tầm nhìn chiến lược của bạn theo định dạng có cấu trúc và đưa thẳng vào quá trình tạo PRD. Nó hoạt động tốt nhất khi bạn đã có niềm tin tương đối chắc vào concept của mình: bạn biết khách hàng là ai, vấn đề là gì, và đại khái muốn xây gì. Brief sẽ tổ chức lại và làm sắc nét lối suy nghĩ đó. +**Vì sao nó có mặt ở đây.** Product brief là con đường nhẹ nhàng hơn để đi vào giai đoạn lập kế hoạch. Nó ghi lại tầm nhìn chiến lược của bạn theo định dạng có cấu trúc và đưa thẳng vào quá trình tạo PRD. Nó hoạt động tốt nhất khi bạn đã có niềm tin tương đối chắc vào ý tưởng của mình: bạn biết khách hàng là ai, vấn đề là gì, và đại khái muốn xây gì. Brief sẽ tổ chức lại và làm sắc nét lối suy nghĩ đó. -**Khi nào nên dùng.** Concept của bạn đã tương đối rõ và bạn muốn ghi lại nó một cách hiệu quả trước khi tạo PRD. Bạn tin vào hướng đi hiện tại và không cần bị thách thức giả định một cách quá quyết liệt. +**Khi nào nên dùng.** Ý tưởng của bạn đã tương đối rõ và bạn muốn ghi lại nó một cách hiệu quả trước khi tạo PRD. Bạn tin vào hướng đi hiện tại và không cần bị thách thức giả định một cách quá quyết liệt. ### PRFAQ (Working Backwards) **Nó là gì.** Phương pháp Working Backwards của Amazon được chuyển thành một thử thách tương tác. Bạn viết thông cáo báo chí công bố sản phẩm hoàn thiện trước khi tồn tại dù chỉ một dòng code, rồi trả lời những câu hỏi khó nhất mà khách hàng và stakeholder sẽ đặt ra. AI đóng vai trò product coach dai dẳng nhưng mang tính xây dựng. -**Vì sao nó có mặt ở đây.** PRFAQ là con đường nghiêm ngặt hơn để đi vào planning. Nó buộc bạn đạt đến sự rõ ràng theo hướng customer-first bằng cách bắt bạn bảo vệ từng phát biểu. Nếu bạn không viết nổi một thông cáo báo chí đủ thuyết phục, sản phẩm đó chưa sẵn sàng. Nếu phần FAQ lộ ra những khoảng trống, đó chính là những khoảng trống mà bạn sẽ phát hiện muộn hơn rất nhiều, và với chi phí lớn hơn nhiều, trong lúc triển khai. Bài kiểm tra này bóc tách lối suy nghĩ yếu ngay từ sớm, khi chi phí sửa còn rẻ nhất. +**Vì sao nó có mặt ở đây.** PRFAQ là con đường nghiêm ngặt hơn để đi vào giai đoạn lập kế hoạch. Nó buộc bạn đạt đến sự rõ ràng theo hướng lấy khách hàng làm trung tâm bằng cách bắt bạn bảo vệ từng phát biểu. Nếu bạn không viết nổi một thông cáo báo chí đủ thuyết phục, sản phẩm đó chưa sẵn sàng. Nếu phần FAQ lộ ra những khoảng trống, đó chính là những khoảng trống mà bạn sẽ phát hiện muộn hơn rất nhiều, và với chi phí lớn hơn nhiều, trong lúc triển khai. Bài kiểm tra này bóc tách lối suy nghĩ yếu ngay từ sớm, khi chi phí sửa còn rẻ nhất. -**Khi nào nên dùng.** Bạn muốn stress-test concept trước khi commit tài nguyên. Bạn chưa chắc người dùng có thực sự quan tâm hay không. Bạn muốn xác nhận rằng mình có thể diễn đạt một value proposition rõ ràng và có thể bảo vệ được. Hoặc đơn giản là bạn muốn dùng sự kỷ luật của Working Backwards để làm suy nghĩ của mình sắc bén hơn. +**Khi nào nên dùng.** Bạn muốn kiểm tra độ vững của ý tưởng trước khi cam kết tài nguyên. Bạn chưa chắc người dùng có thực sự quan tâm hay không. Bạn muốn xác nhận rằng mình có thể diễn đạt một giá trị cốt lõi rõ ràng và có thể bảo vệ được. Hoặc đơn giản là bạn muốn dùng sự kỷ luật của Working Backwards để làm suy nghĩ của mình sắc bén hơn. ## Tôi nên dùng cái nào? @@ -65,6 +65,6 @@ Product Brief và PRFAQ đều tạo ra đầu vào cho PRD. Hãy chọn một t Hãy chạy `bmad-help` và mô tả tình huống của bạn. Nó sẽ gợi ý điểm bắt đầu phù hợp dựa trên những gì bạn đã làm và điều bạn đang muốn đạt được. ::: -## Sau Analysis thì chuyện gì xảy ra? +## Sau giai đoạn phân tích thì chuyện gì xảy ra? -Output từ Analysis đi thẳng vào Phase 2 (Planning). Workflow tạo PRD chấp nhận product brief, tài liệu PRFAQ, kết quả research và báo cáo brainstorming làm đầu vào. Nó sẽ tổng hợp bất cứ thứ gì bạn đã tạo thành các requirement có cấu trúc. Bạn làm analysis càng kỹ, PRD của bạn càng sắc. \ No newline at end of file +Đầu ra từ giai đoạn phân tích đi thẳng vào giai đoạn 2, lập kế hoạch. Quy trình tạo PRD chấp nhận product brief, tài liệu PRFAQ, kết quả nghiên cứu và báo cáo động não làm đầu vào. Nó sẽ tổng hợp bất cứ thứ gì bạn đã tạo thành các yêu cầu có cấu trúc. Bạn làm phân tích càng kỹ, PRD của bạn càng sắc. \ No newline at end of file diff --git a/docs/vi-vn/explanation/checkpoint-preview.md b/docs/vi-vn/explanation/checkpoint-preview.md new file mode 100644 index 000000000..f057a06b7 --- /dev/null +++ b/docs/vi-vn/explanation/checkpoint-preview.md @@ -0,0 +1,92 @@ +--- +title: "Xem trước Checkpoint" +description: Review có người trong vòng lặp với hỗ trợ của LLM, dẫn bạn đi qua thay đổi từ mục đích đến chi tiết +sidebar: + order: 3 +--- + +`bmad-checkpoint-preview` là một workflow review tương tác có người trong vòng lặp với hỗ trợ của LLM. Nó dẫn bạn đi qua một thay đổi mã nguồn, từ mục đích và bối cảnh đến các chi tiết quan trọng, để bạn có thể quyết định có nên phát hành, làm lại, hay đào sâu thêm. + +![Sơ đồ workflow Checkpoint Preview](/diagrams/checkpoint-preview-diagram.png) + +## Luồng điển hình + +Bạn chạy `bmad-quick-dev`. Nó làm rõ ý định của bạn, dựng spec, triển khai thay đổi, rồi khi xong sẽ nối thêm một review trail vào file spec và mở file đó trong editor. Bạn nhìn vào spec và thấy thay đổi này chạm tới 20 file, trải trên nhiều module. + +Bạn có thể tự liếc diff. Nhưng khoảng 20 file là lúc cách đó bắt đầu kém hiệu quả: bạn mất mạch, bỏ sót liên hệ giữa hai thay đổi ở xa nhau, hoặc duyệt một thứ mà bạn chưa thực sự hiểu. Thay vì vậy, bạn nói "checkpoint" và LLM sẽ dẫn bạn đi qua thay đổi. + +Điểm bàn giao đó, từ triển khai tự động quay lại phán đoán của con người, chính là tình huống sử dụng chính. Quick-dev có thể chạy khá lâu với rất ít giám sát. Checkpoint Preview là nơi bạn cầm lại tay lái. + +## Vì sao nó tồn tại + +Code review có hai kiểu thất bại. Kiểu đầu là người review lướt qua diff, không thấy gì nổi bật và bấm duyệt. Kiểu thứ hai là họ đọc rất kỹ từng file nhưng lại mất mạch tổng thể, thấy từng cái cây mà bỏ lỡ cả khu rừng. Cả hai đều dẫn tới cùng một kết quả: lần review đã không bắt được điều thực sự quan trọng. + +Vấn đề cốt lõi nằm ở thứ tự tiếp nhận. Một raw diff trình bày thay đổi theo thứ tự file, gần như không bao giờ là thứ tự giúp xây dựng hiểu biết. Bạn thấy một helper function trước khi biết vì sao nó tồn tại. Bạn thấy một schema change trước khi hiểu tính năng nào đang dùng nó. Người review phải tự dựng lại ý đồ của tác giả từ những manh mối rời rạc, và chính ở bước dựng lại đó sự tập trung thường bị đứt. + +Checkpoint Preview giải quyết việc này bằng cách để LLM làm phần dựng lại. Nó đọc diff, spec nếu có, và codebase xung quanh, rồi trình bày thay đổi theo một thứ tự phục vụ việc hiểu, chứ không theo `git diff`. + +## Nó hoạt động như thế nào + +Workflow này có năm bước. Mỗi bước xây trên bước trước, dần dần chuyển từ "đây là gì?" sang "chúng ta có nên phát hành nó không?" + +### 1. Định hướng + +Workflow xác định thay đổi đó là gì, từ PR, commit, branch, file spec, hoặc trạng thái git hiện tại, rồi tạo một câu tóm tắt ý định và vài số liệu bề mặt: số file thay đổi, số module bị chạm tới, số dòng logic, số lần băng qua ranh giới, và các public interface mới. + +Đây là khoảnh khắc "đúng là thứ tôi đang nghĩ tới chứ?". Trước khi đọc mã, người review xác nhận mình đang nhìn đúng thay đổi và cân chỉnh kỳ vọng về phạm vi. + +### 2. Dẫn giải thay đổi (Walkthrough) + +Thay đổi được tổ chức theo **mối quan tâm** như validation đầu vào hay API contract, thay vì theo file. Mỗi mối quan tâm có một giải thích ngắn về *vì sao* cách tiếp cận này được chọn, kèm theo các điểm dừng `path:line` có thể bấm để người review đi theo xuyên suốt code. + +Đây là bước dùng phán đoán về thiết kế. Người review đánh giá xem hướng tiếp cận có đúng với hệ thống hay không, chứ chưa phải xem code có chính xác tuyệt đối hay không. Các mối quan tâm được sắp từ trên xuống: ý định cấp cao trước, phần triển khai hỗ trợ sau. Người review sẽ không gặp tham chiếu tới thứ mà họ chưa thấy. + +### 3. Soi chi tiết + +Sau khi người review đã hiểu thiết kế, workflow sẽ đưa ra 2 đến 5 điểm mà nếu sai thì hậu quả lan rộng nhất. Chúng được gắn nhãn theo loại rủi ro như `[auth]`, `[schema]`, `[billing]`, `[public API]`, `[security]` và các nhãn khác, đồng thời được sắp theo mức độ thiệt hại nếu sai. + +Đây không phải là một cuộc săn bug. Tính đúng đắn được CI và test tự động lo phần lớn. Bước soi chi tiết nhằm kích hoạt ý thức về rủi ro: "đây là những chỗ mà nếu sai thì cái giá phải trả cao nhất". Nếu muốn đào sâu một khu vực cụ thể, bạn có thể nói "đào sâu vào [khu vực]" để chạy một lần review lại tập trung vào tính đúng đắn. + +Nếu spec trước đó đã đi qua các vòng adversarial review, các phát hiện liên quan cũng được đưa ra ở đây. Không phải các bug đã được sửa, mà là những quyết định mà vòng review đó từng gắn cờ để người review hiện tại biết. + +### 4. Kiểm thử + +Workflow gợi ý 2 đến 5 cách quan sát thủ công để thấy thay đổi thực sự hoạt động. Không phải lệnh test tự động, mà là các quan sát tay giúp tăng niềm tin theo cách test suite không cho bạn được. Một tương tác UI để thử, một lệnh CLI để chạy, một request API để gửi, kèm kết quả kỳ vọng cho từng mục. + +Nếu thay đổi không có hành vi nào nhìn thấy được từ phía người dùng, workflow sẽ nói thẳng như vậy. Không bịa thêm việc cho có. + +### 5. Kết thúc + +Người review đưa ra quyết định: duyệt, làm lại, hay tiếp tục thảo luận. Nếu đang duyệt PR, workflow có thể hỗ trợ với `gh pr review --approve`. Nếu cần làm lại, nó sẽ giúp chẩn đoán vấn đề nằm ở cách tiếp cận, spec, hay phần triển khai, đồng thời hỗ trợ soạn phản hồi có thể hành động được và gắn với vị trí code cụ thể. + +## Đây là một cuộc hội thoại, không phải bản báo cáo + +Workflow trình bày từng bước như một điểm khởi đầu, không phải lời kết luận cuối cùng. Giữa các bước, hoặc ngay giữa một bước, bạn có thể trao đổi với LLM, hỏi thêm, phản biện cách nó đóng khung vấn đề, hoặc kéo thêm skill khác để lấy một góc nhìn khác: + +- **"run advanced elicitation on the error handling"** - ép LLM xem xét lại và tinh chỉnh phân tích cho một khu vực cụ thể +- **"party mode on whether this schema migration is safe"** - kéo nhiều góc nhìn agent vào một cuộc tranh luận tập trung +- **"run code review"** - tạo ra các phát hiện có cấu trúc với phân tích đối kháng và edge case + +Workflow checkpoint không khóa bạn vào một đường đi tuyến tính. Nó cho bạn cấu trúc khi bạn cần, và tránh cản đường khi bạn muốn tự khám phá. Năm bước ở đây để bảo đảm bạn nhìn được toàn cảnh, còn việc đi sâu đến mức nào ở mỗi bước và gọi thêm công cụ nào hoàn toàn là do bạn quyết định. + +## Lộ trình review (Review Trail) + +Bước dẫn giải thay đổi hoạt động tốt nhất khi nó có một **thứ tự review gợi ý (Suggested Review Order)**, tức một danh sách các điểm dừng do tác giả spec viết ra để dẫn người review đi qua thay đổi. Nếu spec có phần này, workflow sẽ dùng trực tiếp. + +Nếu không có review trail do tác giả tạo, workflow sẽ tự sinh một trail từ diff và bối cảnh codebase. Trail do máy sinh ra vẫn kém hơn trail do tác giả viết, nhưng vẫn tốt hơn rất nhiều so với việc đọc thay đổi theo thứ tự file. + +## Khi nào nên dùng + +Tình huống chính là bước bàn giao sau `bmad-quick-dev`: phần triển khai đã xong, file spec đang mở trong editor với review trail đã được nối thêm, và bạn cần quyết định có nên phát hành hay không. Lúc đó chỉ cần nói "checkpoint" là bắt đầu. + +Nó cũng hoạt động độc lập: + +- **Review một PR** - đặc biệt hữu ích khi PR có nhiều hơn vài file hoặc có thay đổi cắt ngang nhiều khu vực +- **Làm quen với một thay đổi (onboard to a change)** - khi bạn cần hiểu chuyện gì đã xảy ra trên một branch mà bạn không phải người viết +- **Review sprint (sprint review)** - workflow có thể nhặt các story được đánh dấu `review` trong file trạng thái sprint của bạn + +Bạn có thể gọi nó bằng cách nói "checkpoint" hoặc "dẫn tôi đi qua thay đổi này". Nó chạy được trong mọi terminal, nhưng sẽ phát huy tốt nhất trong IDE như VS Code, Cursor hoặc công cụ tương tự, vì workflow tạo tham chiếu `path:line` ở mọi bước. Trong terminal tích hợp của IDE, các tham chiếu đó có thể bấm được, nên bạn có thể nhảy qua lại giữa các file khi đi theo review trail. + +## Nó không phải là gì + +Checkpoint Preview không thay thế review tự động. Nó không chạy linter, type checker, hay test suite. Nó không chấm mức độ nghiêm trọng hay đưa ra kết luận pass/fail. Nó là một bản hướng dẫn đọc để giúp con người áp dụng phán đoán của mình vào đúng những chỗ đáng chú ý nhất. diff --git a/docs/vi-vn/explanation/named-agents.md b/docs/vi-vn/explanation/named-agents.md new file mode 100644 index 000000000..514555a1c --- /dev/null +++ b/docs/vi-vn/explanation/named-agents.md @@ -0,0 +1,94 @@ +--- +title: "Agent có tên riêng (Named Agents)" +description: Vì sao các agent của BMad có tên, persona và bề mặt tùy chỉnh riêng, và điều đó mở khóa điều gì so với cách tiếp cận dựa trên menu hoặc prompt trống +sidebar: + order: 1 +--- + +Bạn nói: "Hey Mary, brainstorm với tôi nhé", và Mary được kích hoạt. Cô ấy chào bạn theo tên, bằng ngôn ngữ bạn đã cấu hình, với persona đặc trưng của riêng mình. Cô ấy nhắc rằng `bmad-help` luôn sẵn sàng. Rồi cô ấy bỏ qua menu và đi thẳng vào brainstorming vì ý định của bạn đã đủ rõ. + +Trang này giải thích điều gì thực sự đang diễn ra và vì sao BMad được thiết kế theo cách đó. + +## Chiếc ghế ba chân + +Mô hình agent của BMad đứng trên ba primitive kết hợp với nhau: + +| Thành phần nền (primitive) | Nó cung cấp gì | Nó nằm ở đâu | +|---|---|---| +| **Skill** | Năng lực, tức một việc rời rạc mà assistant có thể làm như brainstorming, viết PRD hay triển khai story | `.claude/skills/{skill-name}/SKILL.md` hoặc vị trí tương đương theo IDE | +| **Named agent** | Tính liên tục của persona, tức một danh tính dễ nhận ra bọc quanh một nhóm skill có cùng giọng điệu, nguyên tắc và dấu hiệu nhận biết | Các skill có thư mục bắt đầu bằng `bmad-agent-*` | +| **Customization** | Khả năng biến nó thành của riêng bạn: override để đổi hành vi của agent, thêm tích hợp MCP, thay template, chồng convention của tổ chức | `_bmad/custom/{skill-name}.toml` cho team và `.user.toml` cho cá nhân | + +Chỉ cần bỏ đi một chân là trải nghiệm sẽ sụp: + +- Skill mà không có agent sẽ thành danh sách khả năng mà người dùng phải tự nhớ tên hoặc mã +- Agent mà không có skill sẽ chỉ là persona không có gì để làm +- Không có customization thì mọi người đều nhận cùng một hành vi mặc định, và muốn thêm convention nội bộ là phải fork + +## Named agents mang lại điều gì + +BMad hiện có sáu named agent, mỗi agent gắn với một phase trong BMad Method: + +| Agent | Phase | Module | +|---|---|---| +| 📊 **Mary**, Chuyên viên phân tích nghiệp vụ (Business Analyst) | Analysis | market research, brainstorming, product briefs, PRFAQs | +| 📚 **Paige**, Technical Writer | Analysis | project documentation, diagrams, doc validation | +| 📋 **John**, Quản lý sản phẩm (Product Manager) | Planning | PRD creation, epic/story breakdown, implementation readiness | +| 🎨 **Sally**, Nhà thiết kế UX (UX Designer) | Planning | UX design specifications | +| 🏗️ **Winston**, Kiến trúc sư hệ thống (System Architect) | Solutioning | technical architecture, alignment checks | +| 💻 **Amelia**, Kỹ sư cấp cao (Senior Engineer) | Implementation | story execution, quick-dev, code review, sprint planning | + +Mỗi agent có một danh tính hardcode gồm tên, chức danh, domain, và một lớp có thể tùy chỉnh gồm vai trò, nguyên tắc, phong cách giao tiếp, icon và menu. Bạn có thể viết lại nguyên tắc của Mary hoặc thêm menu item cho cô ấy, nhưng bạn không thể đổi tên cô ấy. Đó là chủ ý thiết kế. Nhận diện thương hiệu của agent phải sống sót qua lớp tùy chỉnh để câu "hey Mary" luôn kích hoạt đúng analyst, bất kể team đã nắn hành vi của cô ấy theo cách nào. + +## Luồng kích hoạt + +Khi bạn gọi một named agent, tám bước sau sẽ chạy theo thứ tự: + +1. **Resolve cấu hình agent**: merge `customize.toml` gốc với override của team và cá nhân qua một Python resolver dùng `tomllib` +2. **Chạy các bước tiền xử lý (prepend steps)**: mọi hành vi pre-flight mà team đã cấu hình +3. **Nhập persona**: danh tính hardcode cộng với vai trò, phong cách giao tiếp và nguyên tắc đã tùy chỉnh +4. **Nạp persistent facts**: quy tắc tổ chức, ghi chú compliance, hoặc cả file được nạp qua tiền tố `file:` +5. **Nạp config**: tên người dùng, ngôn ngữ giao tiếp, ngôn ngữ đầu ra, đường dẫn artifact +6. **Chào người dùng**: lời chào cá nhân hóa, đúng ngôn ngữ cấu hình và có emoji prefix của agent để bạn nhìn là biết ai đang nói +7. **Chạy các bước hậu xử lý (append steps)**: mọi bước thiết lập sau lời chào mà team đã cấu hình +8. **Dispatch hoặc hiện menu**: nếu tin nhắn mở đầu của bạn khớp một menu item thì agent đi thẳng vào đó, nếu không thì hiện menu và chờ input + +Bước 8 là nơi ý định gặp năng lực. Câu "Hey Mary, brainstorm với tôi nhé" bỏ qua phần render menu vì `bmad-brainstorming` là một mapping quá rõ với mục `BP` trong menu của Mary. Nếu bạn nói mơ hồ, cô ấy chỉ hỏi lại một lần, ngắn gọn, chứ không biến xác nhận thành nghi thức. Nếu chẳng có mục nào phù hợp, cô ấy tiếp tục cuộc hội thoại như bình thường. + +## Vì sao không chỉ dùng menu + +Menu buộc người dùng phải chủ động học công cụ. Bạn phải nhớ brainstorming nằm dưới mã `BP` của analyst chứ không phải PM, và phải nhớ persona nào sở hữu nhóm khả năng nào. Toàn bộ gánh nặng nhận thức đó do công cụ đẩy sang cho người dùng. + +Named agents đảo ngược điều đó. Bạn chỉ cần nói điều mình muốn, với đúng người mình nghĩ tới, bằng ngôn từ tự nhiên. Agent biết họ là ai và họ làm gì. Khi ý định của bạn đủ rõ, họ chỉ việc bắt đầu. + +Menu vẫn còn đó như một phương án dự phòng, hiện ra khi bạn đang khám phá, và biến mất khi bạn không cần nó. + +## Vì sao không chỉ dùng prompt trống + +Prompt trống giả định rằng bạn biết "câu thần chú". "Giúp tôi brainstorm" có thể hiệu quả, nhưng "hãy ideate giúp tôi một ý tưởng SaaS" có thể cho kết quả khác, và đầu ra phụ thuộc khá nhiều vào cách bạn diễn đạt. Khi đó người dùng gần như phải kiêm luôn vai trò kỹ sư prompt (prompt engineer). + +Named agents thêm cấu trúc mà không đóng mất sự tự do. Persona giữ ổn định, năng lực thì dễ khám phá, và `bmad-help` luôn chỉ cách bạn một lệnh. Bạn không phải đoán agent làm được gì, nhưng cũng không cần học thuộc một cuốn manual để dùng nó. + +## Tùy chỉnh là công dân hạng nhất + +Chính mô hình customization làm cho cách tiếp cận này mở rộng được ra ngoài phạm vi của một lập trình viên đơn lẻ. + +Mỗi agent đi kèm một `customize.toml` với mặc định hợp lý. Team có thể commit override vào `_bmad/custom/bmad-agent-{role}.toml`. Mỗi cá nhân có thể chồng thêm sở thích riêng trong `.user.toml` bị gitignore. Resolver sẽ merge cả ba lớp tại thời điểm kích hoạt theo các quy tắc có tính dự đoán. + +Đa số người dùng không cần tự tay viết các file đó. Skill `bmad-customize` sẽ dẫn họ qua việc chọn đúng mục tiêu, quyết định override ở mức agent hay workflow, viết file và xác minh merge. Nhờ vậy bề mặt tùy chỉnh vẫn tiếp cận được với bất cứ ai hiểu ý định của mình, chứ không chỉ người rành TOML. + +Ví dụ cụ thể: một team commit một file yêu cầu Amelia luôn dùng Context7 MCP tool khi tra tài liệu thư viện, và fallback sang Linear nếu story không xuất hiện trong danh sách epic cục bộ. Từ đó mọi dev workflow mà Amelia dispatch như `dev-story`, `quick-dev`, `create-story`, `code-review` đều tự động thừa hưởng hành vi này mà không cần sửa source hay lặp lại cấu hình từng workflow. + +Ngoài ra còn có một bề mặt tùy chỉnh thứ hai cho các mối quan tâm *xuyên suốt*: `_bmad/config.toml`, `_bmad/config.user.toml`, `_bmad/custom/config.toml` và `_bmad/custom/config.user.toml`. Đây là nơi **agent roster** sống, tức các descriptor gọn nhẹ mà những skill như `bmad-party-mode`, `bmad-retrospective` và `bmad-advanced-elicitation` dùng để biết ai có mặt và phải nhập vai họ thế nào. Bạn có thể rebrand một agent cho cả tổ chức bằng team override, hoặc thêm những giọng hư cấu như Kirk, Spock hay một persona chuyên gia domain qua `.user.toml`, tất cả mà không cần đụng vào thư mục skill. File per-skill quyết định Mary *hành xử* như thế nào khi cô ấy kích hoạt; cấu hình trung tâm quyết định các skill khác *nhìn thấy* cô ấy ra sao khi quan sát toàn bộ đội hình. + +Để xem toàn bộ bề mặt tùy chỉnh và ví dụ thực tế: + +- [Cách tùy chỉnh BMad](../how-to/customize-bmad.md): tài liệu tham chiếu cho những gì có thể tùy chỉnh và merge diễn ra thế nào +- [Cách mở rộng BMad cho tổ chức của bạn](../how-to/expand-bmad-for-your-org.md): năm recipe hoàn chỉnh trải từ quy tắc ở cấp agent, convention workflow, publish ra hệ thống ngoài, thay template đầu ra đến tùy chỉnh roster agent +- Skill `bmad-customize`: trợ lý soạn cấu hình (authoring helper) có hướng dẫn để biến ý định thành một file override đúng chỗ và đã được kiểm chứng + +## Ý tưởng lớn hơn phía sau + +Hầu hết các trợ lý AI (AI assistant) ngày nay hoặc là menu, hoặc là prompt, và cả hai đều chuyển phần gánh nặng nhận thức sang người dùng. Agent có tên riêng kết hợp với skill có thể tùy chỉnh cho phép bạn trò chuyện với một đồng đội đã hiểu công việc, đồng thời cho phép tổ chức của bạn nắn đồng đội đó theo nhu cầu mà không cần fork. + +Lần tới khi bạn gõ "Hey Mary, brainstorm với tôi nhé" và cô ấy chỉ việc bắt tay vào làm, hãy để ý thứ đã *không* xảy ra. Không có slash command. Không có menu phải điều hướng. Không có lời nhắc gượng gạo về những gì cô ấy có thể làm. Chính sự vắng mặt đó mới là thiết kế. diff --git a/docs/vi-vn/explanation/party-mode.md b/docs/vi-vn/explanation/party-mode.md index cf0e07ecf..c244b595e 100644 --- a/docs/vi-vn/explanation/party-mode.md +++ b/docs/vi-vn/explanation/party-mode.md @@ -1,5 +1,5 @@ --- -title: "Party Mode" +title: "Chế độ Party" description: Cộng tác đa agent - đưa tất cả agent AI vào cùng một cuộc trò chuyện sidebar: order: 7 diff --git a/docs/vi-vn/explanation/project-context.md b/docs/vi-vn/explanation/project-context.md index 8763795ad..534824377 100644 --- a/docs/vi-vn/explanation/project-context.md +++ b/docs/vi-vn/explanation/project-context.md @@ -1,5 +1,5 @@ --- -title: "Project Context" +title: "Bối cảnh dự án" description: Cách project-context.md định hướng các agent AI theo quy tắc và ưu tiên của dự án sidebar: order: 7 diff --git a/docs/vi-vn/explanation/quick-dev.md b/docs/vi-vn/explanation/quick-dev.md index d9a0145f1..cd75e7c8a 100644 --- a/docs/vi-vn/explanation/quick-dev.md +++ b/docs/vi-vn/explanation/quick-dev.md @@ -1,73 +1,73 @@ --- -title: "Quick Dev" -description: Giảm ma sát human-in-the-loop mà vẫn giữ các checkpoint bảo vệ chất lượng output +title: "Phát triển nhanh" +description: Giảm ma sát có người trong vòng lặp mà vẫn giữ các điểm kiểm tra bảo vệ chất lượng đầu ra sidebar: order: 2 --- Đưa ý định vào, nhận thay đổi mã nguồn ra, với số lần cần con người nhảy vào giữa quy trình ít nhất có thể - nhưng không đánh đổi chất lượng. -Nó cho phép model tự vận hành lâu hơn giữa các checkpoint, rồi chỉ đưa con người quay lại khi tác vụ không thể tiếp tục an toàn nếu thiếu phán đoán của con người, hoặc khi đã đến lúc review kết quả cuối. +Nó cho phép mô hình tự vận hành lâu hơn giữa các điểm kiểm tra, rồi chỉ đưa con người quay lại khi tác vụ không thể tiếp tục an toàn nếu thiếu phán đoán của con người, hoặc khi đã đến lúc rà soát kết quả cuối. ![Quick Dev workflow diagram](/diagrams/quick-dev-diagram.png) ## Vì sao nó tồn tại -Các lượt human-in-the-loop vừa cần thiết vừa tốn kém. +Các lượt có người trong vòng lặp vừa cần thiết vừa tốn kém. LLM hiện tại vẫn thất bại theo những cách dễ đoán: hiểu sai ý định, tự điền vào khoảng trống bằng những phán đoán tự tin, lệch sang công việc không liên quan, và tạo ra các bản review nhiễu. Đồng thời, việc cần con người nhảy vào liên tục làm giảm tốc độ phát triển. Sự chú ý của con người là nút thắt. -`bmad-quick-dev` cân bằng lại đánh đổi đó. Nó tin model có thể chạy tự chủ lâu hơn, nhưng chỉ sau khi workflow đã tạo được một ranh giới đủ mạnh để làm điều đó an toàn. +`bmad-quick-dev` cân bằng lại đánh đổi đó. Nó tin mô hình có thể chạy tự chủ lâu hơn, nhưng chỉ sau khi quy trình đã tạo được một ranh giới đủ mạnh để làm điều đó an toàn. ## Thiết kế cốt lõi ### 1. Nén ý định trước -Workflow bắt đầu bằng việc để con người và model nén yêu cầu thành một mục tiêu thống nhất. Đầu vào có thể bắt đầu như một ý định thô, nhưng trước khi workflow tự vận hành thì nó phải đủ nhỏ, đủ rõ ràng, và đủ ít mâu thuẫn để có thể thực thi. +Quy trình bắt đầu bằng việc để con người và mô hình nén yêu cầu thành một mục tiêu thống nhất. Đầu vào có thể bắt đầu như một ý định thô, nhưng trước khi quy trình tự vận hành thì nó phải đủ nhỏ, đủ rõ ràng, và đủ ít mâu thuẫn để có thể thực thi. -Ý định có thể đến từ nhiều dạng: vài cụm từ, liên kết bug tracker, output từ plan mode, đoạn văn bản copy từ phiên chat, hoặc thậm chí một số story trong `epics.md` của chính BMAD. Ở trường hợp cuối, workflow không hiểu được ngữ nghĩa theo dõi story của BMAD, nhưng vẫn có thể lấy chính story đó và tiếp tục. +Ý định có thể đến từ nhiều dạng: vài cụm từ, liên kết trình theo dõi lỗi, đầu ra từ chế độ lập kế hoạch, đoạn văn bản sao chép từ phiên chat, hoặc thậm chí một số story trong `epics.md` của chính BMAD. Ở trường hợp cuối, quy trình không hiểu được ngữ nghĩa theo dõi story của BMAD, nhưng vẫn có thể lấy chính story đó và tiếp tục. -Workflow này không loại bỏ quyền kiểm soát của con người. Nó chuyển nó về một số thời điểm có giá trị cao: +Quy trình này không loại bỏ quyền kiểm soát của con người. Nó chuyển nó về một số thời điểm có giá trị cao: - **Làm rõ ý định** - biến một yêu cầu lộn xộn thành một mục tiêu thống nhất, không mâu thuẫn ngầm -- **Phê duyệt spec** - xác nhận rằng cách hiểu đã đóng băng là đúng thứ cần xây -- **Review sản phẩm cuối** - checkpoint chính, nơi con người quyết định kết quả cuối có chấp nhận được hay không +- **Phê duyệt đặc tả** - xác nhận rằng cách hiểu đã được chốt là đúng thứ cần xây +- **Rà soát sản phẩm cuối** - điểm kiểm tra chính, nơi con người quyết định kết quả cuối có chấp nhận được hay không ### 2. Định tuyến theo con đường an toàn nhỏ nhất -Khi mục tiêu đã rõ, workflow sẽ quyết định đây có phải thay đổi one-shot thật sự hay cần đi theo đường đầy đủ hơn. Những thay đổi nhỏ, blast radius gần như bằng 0 có thể đi thẳng vào triển khai. Còn lại sẽ đi qua lập kế hoạch để model có được một ranh giới mạnh hơn trước khi tự chạy lâu hơn. +Khi mục tiêu đã rõ, quy trình sẽ quyết định đây có phải thay đổi thực hiện một lần là xong hay cần đi theo đường đầy đủ hơn. Những thay đổi nhỏ, phạm vi ảnh hưởng gần như bằng 0 có thể đi thẳng vào triển khai. Còn lại sẽ đi qua lập kế hoạch để mô hình có được một ranh giới mạnh hơn trước khi tự chạy lâu hơn. ### 3. Chạy lâu hơn với ít giám sát hơn -Sau quyết định định tuyến đó, model có thể tự gánh thêm công việc. Trên con đường đầy đủ, spec đã được phê duyệt trở thành ranh giới mà model sẽ thực thi với ít giám sát hơn, và đó chính là mục tiêu của thiết kế này. +Sau quyết định định tuyến đó, mô hình có thể tự gánh thêm công việc. Trên con đường đầy đủ, đặc tả đã được phê duyệt trở thành ranh giới mà mô hình sẽ thực thi với ít giám sát hơn, và đó chính là mục tiêu của thiết kế này. ### 4. Chẩn đoán lỗi ở đúng tầng -Nếu triển khai sai vì ý định sai, vậy sửa code không phải cách fix đúng. Nếu code sai vì spec yếu, thì vá diff cũng không phải cách fix đúng. Workflow được thiết kế để chẩn đoán lỗi đã đi vào hệ thống từ tầng nào, quay lại đúng tầng đó, rồi sinh lại từ đấy. +Nếu triển khai sai vì ý định sai, vậy sửa code không phải cách sửa đúng. Nếu code sai vì đặc tả yếu, thì vá diff cũng không phải cách sửa đúng. Quy trình được thiết kế để chẩn đoán lỗi đã đi vào hệ thống từ tầng nào, quay lại đúng tầng đó, rồi sinh lại từ đấy. -Các phát hiện từ review được dùng để xác định vấn đề đến từ ý định, quá trình tạo spec, hay triển khai cục bộ. Chỉ những lỗi thật sự cục bộ mới được sửa tại chỗ. +Các phát hiện từ bước rà soát được dùng để xác định vấn đề đến từ ý định, quá trình tạo đặc tả, hay triển khai cục bộ. Chỉ những lỗi thật sự cục bộ mới được sửa tại chỗ. ### 5. Chỉ đưa con người quay lại khi cần -Bước interview ý định có human-in-the-loop, nhưng nó không giống một checkpoint lặp đi lặp lại. Workflow cố gắng giảm thiểu những checkpoint lặp lại đó. Sau bước định hình ý định ban đầu, con người chủ yếu quay lại khi workflow không thể tiếp tục an toàn nếu thiếu phán đoán, và ở cuối quy trình để review kết quả. +Bước phỏng vấn ý định có người trong vòng lặp, nhưng nó không giống một điểm kiểm tra lặp đi lặp lại. Quy trình cố gắng giảm thiểu những điểm kiểm tra lặp lại đó. Sau bước định hình ý định ban đầu, con người chủ yếu quay lại khi quy trình không thể tiếp tục an toàn nếu thiếu phán đoán, và ở cuối quy trình để rà soát kết quả. - **Xử lý khoảng trống của ý định** - quay lại khi review cho thấy workflow không thể suy ra an toàn điều được hàm ý -Mọi thứ còn lại đều là ứng viên cho việc thực thi tự chủ lâu hơn. Đánh đổi này là có chủ đích. Các pattern cũ tốn nhiều sự chú ý của con người cho việc giám sát liên tục. Quick Dev đặt nhiều niềm tin hơn vào model, nhưng để dành sự chú ý của con người cho những thời điểm mà lý trí con người có đòn bẩy lớn nhất. +Mọi thứ còn lại đều là ứng viên cho việc thực thi tự chủ lâu hơn. Đánh đổi này là có chủ đích. Các mẫu cũ tốn nhiều sự chú ý của con người cho việc giám sát liên tục. Quick Dev đặt nhiều niềm tin hơn vào mô hình, nhưng để dành sự chú ý của con người cho những thời điểm mà lý trí con người có đòn bẩy lớn nhất. ## Vì sao hệ thống review quan trọng -Giai đoạn review không chỉ để tìm bug. Nó còn để định tuyến cách sửa mà không phá hỏng động lượng. +Giai đoạn rà soát không chỉ để tìm lỗi. Nó còn để định tuyến cách sửa mà không phá hỏng động lượng. -Workflow này hoạt động tốt nhất trên nền tảng có thể spawn subagent, hoặc ít nhất gọi được một LLM khác qua dòng lệnh và đợi kết quả. Nếu nền tảng của bạn không hỗ trợ sẵn, bạn có thể thêm skill để làm việc đó. Các subagent không mang context là một trụ cột trong thiết kế review. +Quy trình này hoạt động tốt nhất trên nền tảng có thể tạo subagent, hoặc ít nhất gọi được một LLM khác qua dòng lệnh và đợi kết quả. Nếu nền tảng của bạn không hỗ trợ sẵn, bạn có thể thêm skill để làm việc đó. Các subagent không mang ngữ cảnh là một trụ cột trong thiết kế rà soát. -Review agentic thường sai theo hai cách: +Rà soát kiểu agent thường sai theo hai cách: - Tạo quá nhiều phát hiện, buộc con người lọc quá nhiều nhiễu. -- Làm lệch thay đổi hiện tại bằng cách kéo vào các vấn đề không liên quan, biến mỗi lần chạy thành một dự án dọn dẹp ad-hoc. +- Làm lệch thay đổi hiện tại bằng cách kéo vào các vấn đề không liên quan, biến mỗi lần chạy thành một dự án dọn dẹp chắp vá. -Quick Dev xử lý cả hai bằng cách coi review là triage. +Quick Dev xử lý cả hai bằng cách coi rà soát là bước phân loại. -Có những phát hiện thuộc về thay đổi hiện tại. Có những phát hiện không thuộc về nó. Nếu một phát hiện chỉ là ngẫu nhiên xuất hiện, không gắn nhân quả với thay đổi đang làm, workflow có thể trì hoãn nó thay vì ép con người xử lý ngay. Điều đó giữ cho mỗi lần chạy tập trung và ngăn các ngả rẽ ngẫu nhiên ăn hết ngân sách chú ý. +Có những phát hiện thuộc về thay đổi hiện tại. Có những phát hiện không thuộc về nó. Nếu một phát hiện chỉ là ngẫu nhiên xuất hiện, không gắn nhân quả với thay đổi đang làm, quy trình có thể trì hoãn nó thay vì ép con người xử lý ngay. Điều đó giữ cho mỗi lần chạy tập trung và ngăn các ngả rẽ ngẫu nhiên ăn hết ngân sách chú ý. Quá trình triage này đôi khi sẽ không hoàn hảo. Điều đó chấp nhận được. Thường tốt hơn khi đánh giá sai một số phát hiện còn hơn là nhận về hàng ngàn bình luận review giá trị thấp. Hệ thống tối ưu cho chất lượng tín hiệu, không phải độ phủ tuyệt đối. diff --git a/docs/vi-vn/how-to/customize-bmad.md b/docs/vi-vn/how-to/customize-bmad.md index e7402423e..eecc14728 100644 --- a/docs/vi-vn/how-to/customize-bmad.md +++ b/docs/vi-vn/how-to/customize-bmad.md @@ -1,171 +1,395 @@ --- -title: "Cách tùy chỉnh BMad" -description: Tùy chỉnh agent, workflow và module trong khi vẫn giữ khả năng tương thích khi cập nhật +title: 'Cách tùy chỉnh BMad' +description: Tùy chỉnh agent và workflow trong khi vẫn giữ khả năng tương thích khi cập nhật sidebar: - order: 7 + order: 8 --- -Sử dụng các tệp `.customize.yaml` để điều chỉnh hành vi, persona và menu của agent, đồng thời giữ lại thay đổi của bạn qua các lần cập nhật. +Điều chỉnh persona của agent, chèn ngữ cảnh theo domain, thêm khả năng mới và cấu hình hành vi workflow mà không cần sửa các file đã cài. Các tùy chỉnh của bạn sẽ được giữ nguyên qua mọi lần cập nhật. + +:::tip[Không muốn tự viết TOML? Hãy dùng `bmad-customize`] +Skill `bmad-customize` là trợ lý tạo cấu hình có hướng dẫn cho **bề mặt override agent/workflow theo từng skill** được mô tả trong tài liệu này. Nó quét những gì có thể tùy chỉnh trong bản cài đặt của bạn, giúp bạn chọn đúng bề mặt (agent hay workflow), ghi file override và xác minh merge đã áp dụng. Override ở mức cấu hình trung tâm (`_bmad/custom/config.toml`) chưa nằm trong phạm vi v1, nên phần đó vẫn cần viết tay theo mục Cấu hình trung tâm bên dưới. Hãy chạy skill này khi bạn muốn thay đổi theo từng skill; tài liệu này là phần tham chiếu cho *có thể tùy chỉnh gì* và merge hoạt động ra sao. +::: ## Khi nào nên dùng -- Bạn muốn thay đổi tên, tính cách hoặc phong cách giao tiếp của một agent -- Bạn cần agent ghi nhớ bối cảnh riêng của dự án -- Bạn muốn thêm các mục menu tùy chỉnh để kích hoạt workflow hoặc prompt của riêng mình -- Bạn muốn agent luôn thực hiện một số hành động cụ thể mỗi khi khởi động +- Bạn muốn thay đổi tính cách hoặc phong cách giao tiếp của agent +- Bạn cần cung cấp cho agent các "persistent facts" để luôn nhớ, ví dụ "tổ chức của chúng tôi chỉ dùng AWS" +- Bạn muốn thêm các bước khởi động có tính thủ tục mà agent phải chạy mỗi phiên +- Bạn muốn thêm menu item tùy chỉnh để gọi skill hoặc prompt riêng +- Team của bạn cần các tùy chỉnh dùng chung được commit vào git, đồng thời vẫn cho phép mỗi cá nhân chồng thêm sở thích riêng :::note[Điều kiện tiên quyết] + - BMad đã được cài trong dự án của bạn (xem [Cách cài đặt BMad](./install-bmad.md)) -- Trình soạn thảo văn bản để chỉnh sửa tệp YAML +- Python 3.11+ có trên PATH của bạn (để chạy resolver; dùng stdlib `tomllib`, không cần `pip install`, `uv` hay virtualenv) +- Một trình soạn thảo văn bản cho file TOML ::: -:::caution[Giữ an toàn cho các tùy chỉnh của bạn] -Luôn sử dụng các tệp `.customize.yaml` được mô tả trong tài liệu này thay vì sửa trực tiếp tệp agent. Trình cài đặt sẽ ghi đè các tệp agent khi cập nhật, nhưng vẫn giữ nguyên các thay đổi trong `.customize.yaml`. -::: +## Cách hoạt động + +Mỗi skill có thể tùy chỉnh đều đi kèm một file `customize.toml` chứa cấu hình mặc định. File này định nghĩa toàn bộ bề mặt tùy chỉnh của skill, nên hãy đọc nó để biết có thể chỉnh gì. Bạn **không bao giờ** sửa trực tiếp file này. Thay vào đó, bạn tạo các file override dạng thưa, chỉ chứa những trường bạn muốn đổi. + +### Mô hình override ba lớp + +```text +Ưu tiên 1 (thắng): _bmad/custom/{skill-name}.user.toml (cá nhân, bị gitignore) +Ưu tiên 2: _bmad/custom/{skill-name}.toml (team/tổ chức, được commit) +Ưu tiên 3 (gốc): customize.toml của chính skill (mặc định) +``` + +Thư mục `_bmad/custom/` ban đầu là rỗng. File chỉ xuất hiện khi ai đó thực sự bắt đầu tùy chỉnh. + +### Quy tắc merge theo hình dạng, không theo tên trường + +Resolver áp dụng bốn quy tắc cấu trúc. Tên trường không được hardcode riêng; hành vi hoàn toàn được quyết định bởi dạng dữ liệu: + +| Dạng | Quy tắc | +|---|---| +| Scalar (string, int, bool, float) | Giá trị override sẽ thắng | +| Table | Deep merge, tức merge đệ quy theo các quy tắc này | +| Mảng các table mà mọi phần tử đều dùng cùng **một** trường định danh (`code` ở tất cả phần tử, hoặc `id` ở tất cả phần tử) | Merge theo khóa đó, phần tử trùng khóa sẽ **thay tại chỗ**, phần tử mới sẽ **append** | +| Mọi mảng khác (mảng scalar, table không có định danh, hoặc trộn `code` và `id`) | **Append**: phần tử gốc trước, rồi team, rồi user | + +**Không có cơ chế xóa.** Override không thể xóa phần tử mặc định. Nếu bạn cần vô hiệu hóa một menu item mặc định, hãy override nó theo `code` bằng mô tả hoặc prompt no-op. Nếu cần tái cấu trúc mảng sâu hơn, bạn phải fork skill. + +**Quy ước `code` / `id`.** BMad dùng `code` (định danh ngắn như `"BP"` hoặc `"R1"`) và `id` (định danh ổn định dài hơn) làm merge key cho mảng các table. Nếu bạn tự tạo một mảng table muốn có khả năng replace-by-key thay vì append-only, hãy chọn **một** quy ước duy nhất và dùng nhất quán cho toàn bộ mảng. Nếu trộn `code` ở phần tử này và `id` ở phần tử khác, resolver sẽ rơi về chế độ append vì nó không đoán merge theo khóa nào. + +### Một số trường của agent là chỉ đọc + +`agent.name` và `agent.title` vẫn nằm trong `customize.toml` như metadata nguồn gốc, nhưng `SKILL.md` của agent không đọc hai trường này ở runtime, vì danh tính của agent được hardcode. Bạn đặt `name = "Bob"` trong file override cũng sẽ không có tác dụng. Nếu bạn thật sự cần một agent với tên khác, hãy copy thư mục skill, đổi tên và phát hành nó như một custom skill. ## Các bước thực hiện -### 1. Xác định vị trí các tệp tùy chỉnh +### 1. Tìm bề mặt tùy chỉnh của skill -Sau khi cài đặt, bạn sẽ tìm thấy một tệp `.customize.yaml` cho mỗi agent tại: +Hãy mở file `customize.toml` trong thư mục skill đã được cài. Ví dụ với PM agent: ```text -_bmad/_config/agents/ -├── core-bmad-master.customize.yaml -├── bmm-dev.customize.yaml -├── bmm-pm.customize.yaml -└── ... (một tệp cho mỗi agent đã cài) +.claude/skills/bmad-agent-pm/customize.toml ``` -### 2. Chỉnh sửa tệp tùy chỉnh +(Đường dẫn cụ thể thay đổi theo IDE: Cursor dùng `.cursor/skills/`, Cline dùng `.cline/skills/`, v.v.) -Mở tệp `.customize.yaml` của agent mà bạn muốn sửa. Mỗi phần đều là tùy chọn, chỉ tùy chỉnh những gì bạn cần. +Đây là schema chính thức. Mọi trường bạn nhìn thấy trong file này đều có thể tùy chỉnh, ngoại trừ các trường danh tính chỉ đọc đã nêu ở trên. -| Phần | Cách hoạt động | Mục đích | -| --- | --- | --- | -| `agent.metadata` | Thay thế | Ghi đè tên hiển thị của agent | -| `persona` | Thay thế | Đặt vai trò, danh tính, phong cách và các nguyên tắc | -| `memories` | Nối thêm | Thêm bối cảnh cố định mà agent luôn ghi nhớ | -| `menu` | Nối thêm | Thêm mục menu tùy chỉnh cho workflow hoặc prompt | -| `critical_actions` | Nối thêm | Định nghĩa hướng dẫn khởi động cho agent | -| `prompts` | Nối thêm | Tạo các prompt tái sử dụng cho các hành động trong menu | +### 2. Tạo file override của bạn -Những phần được đánh dấu **Thay thế** sẽ ghi đè hoàn toàn cấu hình mặc định của agent. Những phần được đánh dấu **Nối thêm** sẽ bổ sung vào cấu hình hiện có. +Tạo thư mục `_bmad/custom/` ở root dự án nếu nó chưa tồn tại. Sau đó tạo file đặt theo tên skill: -**Tên agent** - -Thay đổi cách agent tự giới thiệu: - -```yaml -agent: - metadata: - name: 'Spongebob' # Mặc định: "Amelia" +```text +_bmad/custom/ + bmad-agent-pm.toml # override của team (commit vào git) + bmad-agent-pm.user.toml # sở thích cá nhân (gitignore) ``` -**Persona** +:::caution[KHÔNG copy nguyên file `customize.toml`] +File override phải **thưa**. Chỉ đưa vào những trường bạn thực sự muốn đổi, không hơn. -Thay thế tính cách, vai trò và phong cách giao tiếp của agent: +Mọi trường bạn bỏ qua sẽ tự động được kế thừa từ lớp bên dưới. Nếu bạn copy toàn bộ `customize.toml` vào file override, những bản cập nhật sau này sẽ không chảy vào các giá trị mặc định mới nữa và bạn sẽ âm thầm bị lệch qua mỗi release. +::: -```yaml -persona: - role: 'Senior Full-Stack Engineer' - identity: 'Sống trong quả dứa (dưới đáy biển)' - communication_style: 'Spongebob gây phiền' - principles: - - 'Không lồng quá sâu, dev Spongebob ghét nesting quá 2 cấp' - - 'Ưu tiên composition hơn inheritance' +**Ví dụ: đổi icon và thêm một principle** + +```toml +# _bmad/custom/bmad-agent-pm.toml +# Chỉ ghi những trường cần đổi. Phần còn lại vẫn kế thừa. + +[agent] +icon = "🏥" +principles = [ + "Không phát hành bất cứ thứ gì không thể vượt qua kiểm toán của FDA.", +] ``` -Phần `persona` sẽ thay thế toàn bộ persona mặc định, vì vậy nếu đặt phần này bạn nên cung cấp đầy đủ cả bốn trường. +Ví dụ này append thêm principle mới vào danh sách mặc định và thay icon. Mọi trường khác vẫn giữ nguyên như bản gốc. -**Memories** +### 3. Tùy chỉnh đúng phần bạn cần -Thêm bối cảnh cố định mà agent sẽ luôn nhớ: +Mọi ví dụ bên dưới đều giả định schema agent phẳng của BMad. Các trường nằm trực tiếp trong `[agent]`, không có các sub-table như `metadata` hay `persona`. -```yaml -memories: - - 'Làm việc tại Krusty Krab' - - 'Người nổi tiếng yêu thích: David Hasselhoff' - - 'Đã học ở Epic 1 rằng giả vờ test đã pass là không ổn' +**Scalar (`icon`, `role`, `identity`, `communication_style`).** Scalar override sẽ thắng, nên bạn chỉ cần đặt những trường đang muốn đổi: + +```toml +# _bmad/custom/bmad-agent-pm.toml + +[agent] +icon = "🏥" +role = "Dẫn dắt product discovery cho domain healthcare có ràng buộc pháp lý." +communication_style = "Chính xác, nhạy với compliance, đặt các câu hỏi mang hình dạng kiểm soát ngay từ sớm." ``` -**Mục menu** +**Persistent facts, principles, activation hooks (các mảng append).** Bốn mảng dưới đây đều là append-only. Phần tử của team được thêm sau mặc định, phần tử user được thêm cuối cùng. -Thêm các mục tùy chỉnh vào menu hiển thị của agent. Mỗi mục cần có `trigger`, đích đến (`workflow` hoặc `action`) và `description`: +```toml +[agent] +# Các fact tĩnh mà agent luôn giữ trong đầu trong cả phiên: quy tắc tổ chức, +# hằng số domain, sở thích của người dùng. Khác với runtime memory sidecar. +# +# Mỗi mục có thể là một câu literal, hoặc tham chiếu `file:` để nạp nội dung +# file làm facts (hỗ trợ cả glob). +persistent_facts = [ + "Tổ chức của chúng tôi chỉ dùng AWS, không đề xuất GCP hay Azure.", + "Mọi PRD đều phải có legal sign-off trước khi engineering kickoff.", + "Người dùng mục tiêu là bác sĩ lâm sàng, không phải bệnh nhân, nên ví dụ phải bám theo đối tượng đó.", + "file:{project-root}/docs/compliance/hipaa-overview.md", + "file:{project-root}/_bmad/custom/company-glossary.md", +] -```yaml -menu: - - trigger: my-workflow - workflow: 'my-custom/workflows/my-workflow.yaml' - description: Workflow tùy chỉnh của tôi - - trigger: deploy - action: '#deploy-prompt' - description: Triển khai lên production +# Thêm vào hệ giá trị của agent +principles = [ + "Không phát hành bất cứ thứ gì không thể vượt qua kiểm toán của FDA.", + "Giá trị người dùng là trước hết, compliance là luôn luôn.", +] + +# Chạy TRƯỚC activation tiêu chuẩn (persona, persistent_facts, config, greet). +# Dùng cho pre-flight load, compliance checks, hoặc thứ gì cần có sẵn trong +# context trước khi agent tự giới thiệu. +activation_steps_prepend = [ + "Quét {project-root}/docs/compliance/ và nạp mọi tài liệu liên quan HIPAA vào context.", +] + +# Chạy SAU khi greet, TRƯỚC menu. Dùng cho thiết lập nặng về context mà bạn +# muốn chạy sau khi người dùng đã được chào. +activation_steps_append = [ + "Đọc {project-root}/_bmad/custom/company-glossary.md nếu file tồn tại.", +] ``` -**Critical Actions** +**Hai hook này có vai trò khác nhau.** `prepend` chạy trước lời chào để agent có thể nạp ngữ cảnh cần thiết ngay cả khi cá nhân hóa lời chào. `append` chạy sau lời chào để người dùng không phải nhìn màn hình trống trong lúc agent quét một lượng lớn context. -Định nghĩa các hướng dẫn sẽ chạy khi agent khởi động: +**Tùy chỉnh menu (merge theo `code`).** Menu là một mảng table. Mỗi item có trường `code`, nên resolver merge theo mã này: item có `code` trùng sẽ thay tại chỗ, item mới sẽ được append. -```yaml -critical_actions: - - 'Kiểm tra pipeline CI bằng XYZ Skill và cảnh báo người dùng ngay khi khởi động nếu có việc khẩn cấp cần xử lý' +Với TOML array-of-tables, mỗi item dùng cú pháp `[[agent.menu]]`: + +```toml +# Thay item CE hiện có bằng một custom skill +[[agent.menu]] +code = "CE" +description = "Tạo Epic theo framework delivery của tổ chức" +skill = "custom-create-epics" + +# Thêm item mới (RC chưa tồn tại trong mặc định) +[[agent.menu]] +code = "RC" +description = "Chạy compliance pre-check" +prompt = """ +Đọc {project-root}/_bmad/custom/compliance-checklist.md +và quét toàn bộ tài liệu trong {planning_artifacts} theo checklist đó. +Báo cáo mọi khoảng trống và trích dẫn điều khoản quy định tương ứng. +""" ``` -**Prompt tùy chỉnh** +Mỗi menu item chỉ có đúng một trong hai trường `skill` hoặc `prompt`. Những item không xuất hiện trong file override của bạn sẽ giữ nguyên mặc định. -Tạo các prompt tái sử dụng để mục menu có thể tham chiếu bằng `action="#id"`: +**Tham chiếu file.** Khi một trường văn bản cần trỏ tới file (trong `persistent_facts`, `activation_steps_prepend`, `activation_steps_append`, hoặc `prompt` của menu item), hãy dùng đường dẫn đầy đủ dựa trên `{project-root}`. Dù file nằm cạnh override trong `_bmad/custom/`, bạn vẫn nên viết rõ là `{project-root}/_bmad/custom/info.md`. Agent sẽ resolve `{project-root}` ở runtime. -```yaml -prompts: - - id: deploy-prompt - content: | - Triển khai nhánh hiện tại lên production: - 1. Chạy toàn bộ test - 2. Build dự án - 3. Thực thi script triển khai +### 4. Cá nhân và team + +**File của team** (`bmad-agent-pm.toml`): commit vào git, áp dụng cho cả tổ chức. Dùng cho compliance rules, company persona, năng lực tùy chỉnh dùng chung. + +**File cá nhân** (`bmad-agent-pm.user.toml`): tự động bị gitignore. Dùng cho điều chỉnh giọng điệu, sở thích workflow cá nhân và các fact riêng mà agent cần lưu ý cho riêng bạn. + +```toml +# _bmad/custom/bmad-agent-pm.user.toml + +[agent] +persistent_facts = [ + "Khi trình bày phương án, luôn kèm ước lượng độ phức tạp ở mức thô (low/medium/high).", +] ``` -### 3. Áp dụng thay đổi +## Cách quá trình resolve diễn ra -Sau khi chỉnh sửa, cài đặt lại để áp dụng thay đổi: +Khi agent được kích hoạt, `SKILL.md` của nó sẽ gọi một shared Python script để merge ba lớp nói trên và trả về block kết quả ở dạng JSON. Script này dùng `tomllib` của Python stdlib, nên `python3` thuần là đủ: ```bash -npx bmad-method install +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill {skill-root} \ + --key agent ``` -Trình cài đặt sẽ nhận diện bản cài đặt hiện có và đưa ra các lựa chọn sau: +**Yêu cầu**: Python 3.11+ vì các phiên bản cũ hơn không có `tomllib`. Không cần `pip install`, không cần `uv`, không cần virtualenv. Bạn có thể kiểm tra bằng `python3 --version`. Trên một số nền tảng, `python3` mặc định vẫn là 3.10 hoặc thấp hơn, nên có thể bạn sẽ phải cài 3.11+ riêng. -| Lựa chọn | Tác dụng | -| --- | --- | -| **Quick Update** | Cập nhật tất cả module lên phiên bản mới nhất và áp dụng các tùy chỉnh | -| **Modify BMad Installation** | Chạy lại quy trình cài đặt đầy đủ để thêm hoặc gỡ bỏ module | +`--skill` trỏ vào thư mục skill đã cài, nơi có file `customize.toml`. Tên skill được lấy từ basename của thư mục, sau đó script sẽ tự tìm `_bmad/custom/{skill-name}.toml` và `{skill-name}.user.toml`. -Nếu chỉ thay đổi phần tùy chỉnh, **Quick Update** là lựa chọn nhanh nhất. +Một số lệnh hữu ích: -## Khắc phục sự cố +```bash +# Resolve toàn bộ block agent +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill /duong-dan/tuyet-doi/toi/bmad-agent-pm \ + --key agent -**Thay đổi không xuất hiện?** +# Resolve một trường cụ thể +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill /duong-dan/tuyet-doi/toi/bmad-agent-pm \ + --key agent.icon -- Chạy `npx bmad-method install` và chọn **Quick Update** để áp dụng thay đổi -- Kiểm tra YAML có hợp lệ không (thụt lề rất quan trọng) -- Xác minh bạn đã sửa đúng tệp `.customize.yaml` của agent cần thiết +# Dump toàn bộ +python3 {project-root}/_bmad/scripts/resolve_customization.py \ + --skill /duong-dan/tuyet-doi/toi/bmad-agent-pm +``` -**Agent không tải lên được?** - -- Kiểm tra lỗi cú pháp YAML bằng một công cụ kiểm tra YAML trực tuyến -- Đảm bảo bạn không để trống trường nào sau khi bỏ comment -- Thử khôi phục mẫu gốc rồi build lại - -**Cần đặt lại một agent?** - -- Xóa nội dung hoặc xóa tệp `.customize.yaml` của agent đó -- Chạy `npx bmad-method install` và chọn **Quick Update** để khôi phục mặc định +Đầu ra luôn là JSON. Nếu script này không khả dụng trên một nền tảng nào đó, `SKILL.md` sẽ hướng dẫn agent đọc trực tiếp ba file TOML và áp dụng cùng các quy tắc merge. ## Tùy chỉnh workflow -Tài liệu về cách tùy chỉnh các workflow và skill sẵn có trong BMad Method sẽ được bổ sung trong thời gian tới. +Workflow, tức các skill điều phối tiến trình nhiều bước như `bmad-product-brief`, dùng cùng cơ chế override như agent. Khác biệt là bề mặt tùy chỉnh của chúng nằm dưới `[workflow]` thay vì `[agent]`: -## Tùy chỉnh module +```toml +# _bmad/custom/bmad-product-brief.toml -Hướng dẫn xây dựng expansion module và tùy chỉnh các module hiện có sẽ được bổ sung trong thời gian tới. +[workflow] +# Giống agent: prepend/append chạy trước và sau activation mặc định của +# workflow. Override sẽ append vào mặc định. +activation_steps_prepend = [ + "Nạp {project-root}/docs/product/north-star-principles.md làm context.", +] + +activation_steps_append = [] + +# Cũng dùng semantics literal-hoặc-file: như phía agent. Những fact này được +# nạp làm context nền tảng trong suốt lần chạy workflow. +persistent_facts = [ + "Mọi brief đều phải có một mục explicit về regulatory risk.", + "file:{project-root}/docs/compliance/product-brief-checklist.md", +] + +# Scalar: chạy đúng một lần khi workflow hoàn tất output chính. Override thắng. +on_complete = "Tóm tắt brief trong ba gạch đầu dòng rồi hỏi người dùng có muốn gửi email qua skill gws-gmail-send không." +``` + +Cùng một quy ước trường có thể đi xuyên qua ranh giới agent/workflow: `activation_steps_prepend`, `activation_steps_append`, `persistent_facts` với tham chiếu `file:`, và các table kiểu menu `[[...]]` dùng `code` hoặc `id` làm khóa merge. Resolver áp dụng đúng bốn quy tắc cấu trúc đã nêu bất kể top-level key là gì. Tham chiếu từ `SKILL.md` cũng theo namespace tương ứng: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. Mọi trường bổ sung mà một workflow tự expose, ví dụ output path, toggle, review setting hay stage flag, cũng sẽ đi theo cùng cơ chế merge dựa trên shape. Muốn biết chính xác workflow đó cho chỉnh gì, hãy đọc `customize.toml` của nó. + +### Thứ tự activation + +Workflow có thể tùy chỉnh sẽ chạy activation theo thứ tự cố định để bạn biết hook của mình được kích hoạt khi nào: + +1. Resolve block `[workflow]` bằng merge base -> team -> user +2. Chạy `activation_steps_prepend` theo đúng thứ tự +3. Nạp `persistent_facts` làm ngữ cảnh nền tảng cho cả lần chạy +4. Nạp config (`_bmad/bmm/config.yaml`) và resolve các biến chuẩn như tên dự án, ngôn ngữ, đường dẫn, ngày tháng +5. Chào người dùng +6. Chạy `activation_steps_append` theo đúng thứ tự + +Sau bước 6, phần thân chính của workflow mới bắt đầu. Hãy dùng `activation_steps_prepend` khi bạn cần load context trước cả lúc cá nhân hóa lời chào; dùng `activation_steps_append` khi phần thiết lập khá nặng và bạn muốn người dùng thấy lời chào trước. + +### Phạm vi của đợt triển khai đầu tiên này + +Khả năng tùy chỉnh đang được mở rộng dần. Những trường đã mô tả ở trên, gồm `activation_steps_prepend`, `activation_steps_append`, `persistent_facts`, `on_complete`, là **bề mặt nền tảng** mà mọi workflow có thể tùy chỉnh đều sẽ hỗ trợ, và chúng sẽ ổn định qua các phiên bản. Ngày hôm nay, chỉ với những trường này bạn đã có thể kiểm soát những điểm lớn: thêm bước trước/sau, ghim context nền tảng, kích hoạt hành động tiếp theo sau khi workflow hoàn tất. + +Theo thời gian, từng workflow sẽ expose thêm **các điểm tùy chỉnh chuyên biệt hơn** gắn với chính công việc của workflow đó, ví dụ toggle ở từng bước, stage flag, đường dẫn template đầu ra hoặc review gate. Khi những trường đó xuất hiện, chúng sẽ được chồng thêm lên bề mặt nền tảng chứ không thay thế nó, nên những tùy chỉnh bạn viết hôm nay vẫn tiếp tục dùng được. + +Nếu bạn đang cần một "núm tinh chỉnh" chi tiết hơn nhưng workflow chưa expose, hãy tạm dùng `activation_steps_*` và `persistent_facts` để điều hướng hành vi, hoặc mở issue mô tả chính xác điểm tùy chỉnh bạn muốn. Chính những nhu cầu đó sẽ quyết định trường nào được bổ sung tiếp theo. + +## Cấu hình trung tâm + +`customize.toml` theo từng skill bao phủ **hành vi sâu** như hook, menu, `persistent_facts`, override persona cho một agent hay workflow đơn lẻ. Một bề mặt khác sẽ bao phủ **trạng thái cắt ngang** như các câu trả lời lúc cài đặt và roster agent mà những skill bên ngoài như `bmad-party-mode`, `bmad-retrospective` và `bmad-advanced-elicitation` sử dụng. Bề mặt đó nằm trong bốn file TOML ở root dự án: + +```text +_bmad/config.toml (do installer quản lý) team scope: câu trả lời lúc cài đặt + agent roster +_bmad/config.user.toml (do installer quản lý) user scope: user_name, language, skill level +_bmad/custom/config.toml (do con người viết) team overrides (commit vào git) +_bmad/custom/config.user.toml (do con người viết) personal overrides (gitignore) +``` + +### Merge bốn lớp + +```text +Ưu tiên 1 (thắng): _bmad/custom/config.user.toml +Ưu tiên 2: _bmad/custom/config.toml +Ưu tiên 3: _bmad/config.user.toml +Ưu tiên 4 (gốc): _bmad/config.toml +``` + +Các quy tắc cấu trúc hoàn toàn giống phần per-skill customize: scalar override, table deep-merge, mảng dùng `code` hoặc `id` sẽ merge theo khóa, các mảng khác thì append. + +### Cái gì nằm ở đâu + +Installer sẽ phân chia câu trả lời theo `scope:` khai báo trên từng prompt trong `module.yaml`: + +- Các section `[core]` và `[modules.]`: chứa câu trả lời khi cài. `scope = team` sẽ được ghi vào `_bmad/config.toml`; `scope = user` sẽ nằm trong `_bmad/config.user.toml` +- Section `[agents.]`: "bản chất" của agent gồm code, name, title, icon, description, team, được chưng cất từ khối `agents:` trong `module.yaml` của từng module. Phần này luôn ở scope team + +### Quy tắc chỉnh sửa + +- `_bmad/config.toml` và `_bmad/config.user.toml` sẽ **được tạo lại sau mỗi lần cài đặt** từ những câu trả lời mà installer thu thập. Hãy coi chúng là output chỉ đọc; mọi chỉnh sửa trực tiếp sẽ bị ghi đè ở lần cài tiếp theo. Nếu muốn thay đổi bền vững một giá trị cài đặt, hãy chạy lại installer hoặc chồng giá trị đó bằng `_bmad/custom/config.toml` +- `_bmad/custom/config.toml` và `_bmad/custom/config.user.toml` sẽ **không bao giờ** bị installer động vào. Đây mới là bề mặt đúng để thêm custom agent, override descriptor của agent, ép các thiết lập dùng chung cho team và ghim mọi giá trị bạn muốn giữ nguyên bất kể câu trả lời lúc cài là gì + +### Ví dụ: đổi thương hiệu cho một agent + +```toml +# _bmad/custom/config.toml (commit vào git, áp dụng cho mọi developer) + +[agents.bmad-agent-pm] +description = "PM trong domain healthcare, nhạy với compliance, luôn đặt câu hỏi theo hướng FDA ngay từ đầu." +icon = "🏥" +``` + +Resolver sẽ merge đè lên `[agents.bmad-agent-pm]` do installer sinh ra. `bmad-party-mode` và mọi roster consumer khác sẽ tự động thấy description mới này. + +### Ví dụ: thêm một agent hư cấu + +```toml +# _bmad/custom/config.user.toml (cá nhân, gitignore) + +[agents.kirk] +team = "startrek" +name = "Captain James T. Kirk" +title = "Starship Captain" +icon = "🖖" +description = "Một chỉ huy táo bạo, thích bẻ luật. Nói chuyện có các quãng ngắt đầy kịch tính. Suy nghĩ thành tiếng về gánh nặng của quyền chỉ huy." +``` + +Không cần tạo thư mục skill. Chỉ riêng "essence" này cũng đủ để party-mode spawn Kirk như một giọng nói trong cuộc bàn tròn. Bạn có thể lọc theo trường `team` để chỉ mời nhóm Enterprise. + +### Ví dụ: override thiết lập cài đặt của module + +```toml +# _bmad/custom/config.toml + +[modules.bmm] +planning_artifacts = "/shared/org-planning-artifacts" +``` + +Giá trị override này sẽ thắng mọi câu trả lời mà từng developer đã nhập khi cài trên máy của họ. Rất hữu ích khi bạn muốn ghim convention của cả team. + +### Khi nào dùng bề mặt nào + +| Nhu cầu | Bề mặt nên dùng | +|---|---| +| Thêm lời nhắc gọi MCP tool vào mọi dev workflow | Theo từng skill: `_bmad/custom/bmad-agent-dev.toml` trong `persistent_facts` | +| Thêm menu item cho một agent | Theo từng skill: `_bmad/custom/bmad-agent-{role}.toml` với `[[agent.menu]]` | +| Đổi template đầu ra của một workflow | Theo từng skill: `_bmad/custom/{workflow}.toml` bằng scalar override | +| Đổi descriptor công khai của một agent | **Cấu hình trung tâm**: `_bmad/custom/config.toml` ở `[agents.]` | +| Thêm custom agent hoặc agent hư cấu vào roster | **Cấu hình trung tâm**: `_bmad/custom/config*.toml` với entry mới `[agents.]` | +| Ghim thiết lập cài đặt dùng chung của team | **Cấu hình trung tâm**: `_bmad/custom/config.toml` trong `[modules.]` hoặc `[core]` | + +Trong cùng một dự án, bạn hoàn toàn có thể dùng đồng thời cả hai bề mặt này. + +## Ví dụ thực chiến + +Để xem các recipe thiên về doanh nghiệp như định hình một agent trên mọi workflow mà nó dispatch, ép workflow tuân thủ convention nội bộ, publish output lên Confluence và Jira, tùy chỉnh agent roster, hoặc thay template đầu ra bằng template riêng của tổ chức, hãy xem [Cách mở rộng BMad cho tổ chức của bạn](./expand-bmad-for-your-org.md). + +## Khắc phục sự cố + +**Tùy chỉnh không xuất hiện?** + +- Kiểm tra file của bạn có nằm đúng trong `_bmad/custom/` và dùng đúng tên skill không +- Kiểm tra cú pháp TOML: string phải có ngoặc kép, table header dùng `[section]`, array-of-tables dùng `[[section]]`, và mọi khóa scalar hay array của một table phải xuất hiện *trước* bất kỳ `[[subtables]]` nào của table đó trong file +- Với agent, phần tùy chỉnh phải nằm dưới `[agent]`, và các trường bên dưới header đó sẽ thuộc `agent` cho tới khi bạn mở table header khác +- Hãy nhớ rằng `agent.name` và `agent.title` là chỉ đọc, override vào đó sẽ không có tác dụng + +**Tùy chỉnh bị hỏng sau khi update?** + +- Bạn có copy nguyên file `customize.toml` vào file override không? **Đừng làm vậy.** File override chỉ nên chứa phần chênh lệch. Nếu copy nguyên file, bạn sẽ khóa cứng mặc định cũ và dần lệch khỏi các bản phát hành mới. + +**Muốn biết có thể tùy chỉnh gì?** + +- Chạy skill `bmad-customize`. Nó sẽ liệt kê mọi skill có thể tùy chỉnh trong dự án, cho biết skill nào đã có override, rồi dẫn bạn qua quá trình thêm hoặc sửa một override +- Hoặc đọc trực tiếp `customize.toml` của skill. Mọi trường ở đó đều có thể tùy chỉnh, trừ `name` và `title` + +**Muốn reset?** + +- Xóa file override của bạn trong `_bmad/custom/`, skill sẽ tự động rơi về cấu hình mặc định tích hợp sẵn diff --git a/docs/vi-vn/how-to/expand-bmad-for-your-org.md b/docs/vi-vn/how-to/expand-bmad-for-your-org.md new file mode 100644 index 000000000..1fe872493 --- /dev/null +++ b/docs/vi-vn/how-to/expand-bmad-for-your-org.md @@ -0,0 +1,266 @@ +--- +title: 'Cách mở rộng BMad cho tổ chức của bạn' +description: Năm mẫu tùy chỉnh giúp thay đổi BMad mà không cần fork, gồm quy tắc ở cấp agent, quy ước workflow, xuất bản ra hệ thống ngoài, thay template và điều chỉnh danh sách agent +sidebar: + order: 9 +--- + +Bề mặt tùy chỉnh của BMad cho phép một tổ chức định hình lại hành vi mà không phải sửa file đã cài hay fork skill. Hướng dẫn này trình bày năm công thức mẫu (recipe) bao phủ phần lớn nhu cầu ở môi trường doanh nghiệp. + +:::note[Điều kiện tiên quyết] + +- BMad đã được cài trong dự án của bạn (xem [Cách cài đặt BMad](./install-bmad.md)) +- Đã quen với mô hình tùy chỉnh (xem [Cách tùy chỉnh BMad](./customize-bmad.md)) +- Python 3.11+ có trên PATH để chạy resolver, chỉ dùng stdlib, không cần `pip install` +::: + +:::tip[Cách áp dụng các công thức mẫu này] +Những **công thức mẫu theo từng skill** bên dưới, tức Recipe 1 đến Recipe 4, có thể được áp dụng bằng cách chạy skill `bmad-customize` rồi mô tả ý định. Skill này sẽ tự chọn đúng bề mặt, viết file override và xác minh kết quả merge. Riêng Recipe 5, tức override cấu hình trung tâm để chỉnh danh sách agent (agent roster), hiện chưa nằm trong phạm vi v1 của skill nên vẫn cần viết tay. Các recipe trong trang này là nguồn sự thật cho phần *nên override cái gì*; `bmad-customize` phụ trách phần *thực hiện ra sao* ở lớp agent/workflow. +::: + +## Mô hình ba lớp để suy nghĩ + +Trước khi chọn recipe, bạn cần biết override của mình sẽ rơi vào đâu: + +| Lớp | Nơi override sống | Phạm vi | +|---|---|---| +| **Agent** như Amelia, Mary, John | section `[agent]` trong `_bmad/custom/bmad-agent-{role}.toml` | Đi cùng persona vào **mọi workflow mà agent đó dispatch** | +| **Workflow** như `product-brief`, `create-prd` | section `[workflow]` trong `_bmad/custom/{workflow-name}.toml` | Chỉ áp dụng cho lần chạy của workflow đó | +| **Cấu hình trung tâm** | `[agents.*]`, `[core]`, `[modules.*]` trong `_bmad/custom/config.toml` | Agent roster và các thiết lập lúc cài đặt cần ghim cho cả tổ chức | + +Nguyên tắc ngón tay cái: + +- Nếu quy tắc nên áp dụng ở mọi nơi một engineer làm dev work, hãy tùy chỉnh **dev agent** +- Nếu nó chỉ áp dụng khi ai đó viết product brief, hãy tùy chỉnh **workflow product-brief** +- Nếu nó thay đổi *ai đang ngồi trong phòng* như đổi thương hiệu agent, thêm custom voice hoặc ép chung một artifact path, hãy sửa **cấu hình trung tâm** + +## Recipe 1: định hình một agent trên mọi workflow mà nó điều phối (dispatch) + +**Trường hợp dùng (use case):** Chuẩn hóa việc dùng công cụ và tích hợp với hệ thống bên ngoài để mọi workflow được dispatch qua agent đó tự động thừa hưởng cùng hành vi. Đây là mẫu áp dụng (pattern) có sức ảnh hưởng lớn nhất. + +**Ví dụ:** Amelia, tức dev agent, luôn dùng Context7 cho tài liệu thư viện và fallback sang Linear nếu không tìm thấy story trong danh sách epic. + +```toml +# _bmad/custom/bmad-agent-dev.toml + +[agent] + +# Áp dụng ở mọi lần kích hoạt. Theo Amelia đi vào dev-story, quick-dev, +# create-story, code-review, qa-generate và mọi skill cô ấy dispatch. +persistent_facts = [ + "Với mọi truy vấn tài liệu thư viện như React, TypeScript, Zod, Prisma..., hãy gọi Context7 MCP tool (`mcp__context7__resolve_library_id` rồi `mcp__context7__get_library_docs`) trước khi dựa vào kiến thức trong dữ liệu huấn luyện (training data). Tài liệu cập nhật phải thắng API đã ghi nhớ.", + "Khi không tìm thấy tham chiếu story trong {planning_artifacts}/epics-and-stories.md, hãy tìm trong Linear bằng `mcp__linear__search_issues` theo ID hoặc tiêu đề story trước khi yêu cầu người dùng làm rõ. Nếu Linear trả về kết quả khớp, coi đó là nguồn story có thẩm quyền.", +] +``` + +**Vì sao cách này hiệu quả:** Chỉ với hai câu, bạn đã thay đổi mọi dev workflow trong tổ chức mà không lặp config từng nơi và không sửa source. Mọi engineer mới kéo repo về đều tự động thừa hưởng convention đó. + +**File của team và file cá nhân** + +- `bmad-agent-dev.toml`: commit vào git, áp dụng cho cả team +- `bmad-agent-dev.user.toml`: bị gitignore, dùng cho sở thích cá nhân chồng thêm lên trên + +## Recipe 2: ép convention của tổ chức bên trong một workflow cụ thể + +**Trường hợp dùng (use case):** Định hình *nội dung đầu ra* của một workflow để nó đáp ứng yêu cầu compliance, audit hoặc hệ thống downstream. + +**Ví dụ:** mọi product brief đều phải có các trường compliance, và agent biết convention xuất bản của tổ chức. + +```toml +# _bmad/custom/bmad-product-brief.toml + +[workflow] + +persistent_facts = [ + "Mọi brief phải có trường 'Owner', 'Target Release' và 'Security Review Status'.", + "Các brief không mang tính thương mại như công cụ nội bộ hoặc dự án nghiên cứu vẫn phải có phần user value, nhưng có thể bỏ phân biệt cạnh tranh thị trường.", + "file:{project-root}/docs/enterprise/brief-publishing-conventions.md", +] +``` + +**Điều gì xảy ra:** Những fact này được nạp trong quá trình activation của workflow. Khi agent soạn brief, nó đã biết các trường bắt buộc và tài liệu convention nội bộ. Mặc định có sẵn, ví dụ `file:{project-root}/**/project-context.md`, vẫn tiếp tục được nạp vì phần này chỉ append thêm. + +## Recipe 3: xuất bản kết quả hoàn tất sang hệ thống ngoài + +**Trường hợp dùng (use case):** Sau khi workflow tạo ra output chính, tự động đẩy nó sang hệ thống nguồn sự thật của doanh nghiệp như Confluence, Notion, SharePoint, rồi mở tiếp công việc follow-up trong Jira, Linear hoặc Asana. + +**Ví dụ:** brief được tự động publish lên Confluence và tùy chọn mở Jira epic. + +```toml +# _bmad/custom/bmad-product-brief.toml + +[workflow] + +# Hook ở giai đoạn cuối. Scalar override sẽ thay hẳn mặc định rỗng. +on_complete = """ +Publish và đề nghị bước tiếp theo: + +1. Đọc đường dẫn file brief đã hoàn tất từ bước trước. +2. Gọi `mcp__atlassian__confluence_create_page` với: + - space: "PRODUCT" + - parent: "Product Briefs" + - title: tiêu đề của brief + - body: nội dung markdown của brief + Lưu lại URL trang được trả về. +3. Thông báo cho người dùng: "Brief đã được publish lên Confluence: ". +4. Hỏi: "Bạn có muốn tôi mở Jira epic cho brief này ngay bây giờ không?" +5. Nếu có, gọi `mcp__atlassian__jira_create_issue` với: + - type: "Epic" + - project: "PROD" + - summary: tiêu đề của brief + - description: tóm tắt ngắn cùng liên kết ngược về trang Confluence. + Sau đó báo lại epic key và URL. +6. Nếu không, thoát sạch. + +Nếu một trong các MCP tool bị lỗi, hãy báo lỗi, in ra đường dẫn brief +và yêu cầu người dùng publish thủ công. +""" +``` + +**Vì sao dùng `on_complete` thay vì `activation_steps_append`:** `on_complete` chỉ chạy đúng một lần ở cuối, sau khi output chính của workflow đã được ghi ra. Đó là thời điểm đúng để publish artifact. `activation_steps_append` thì chạy mỗi lần kích hoạt, trước khi workflow làm công việc chính của nó. + +**Điểm đánh đổi (trade-offs)** + +- Publish lên Confluence là hành động không phá hủy, nên có thể luôn chạy khi hoàn tất +- Tạo Jira epic là hành động hiển thị cho cả team và kích hoạt các tín hiệu sprint planning, nên nên chặn bởi một bước xác nhận từ người dùng +- Nếu MCP tool lỗi, workflow phải có phương án dự phòng (fallback) rõ ràng thay vì âm thầm làm mất output + +## Recipe 4: thay output template bằng template của riêng bạn + +**Trường hợp dùng (use case):** Cấu trúc đầu ra mặc định không khớp định dạng mà tổ chức mong muốn, hoặc trong cùng một repo có nhiều tổ chức cần template riêng. + +**Ví dụ:** trỏ workflow product-brief sang template do doanh nghiệp sở hữu. + +```toml +# _bmad/custom/bmad-product-brief.toml + +[workflow] +brief_template = "{project-root}/docs/enterprise/brief-template.md" +``` + +**Cách nó hoạt động:** `customize.toml` của workflow đi kèm `brief_template = "resources/brief-template.md"` dưới dạng đường dẫn tương đối tới skill root. Override của bạn lại trỏ tới một file trong `{project-root}`, nên agent sẽ đọc template của bạn trong bước tương ứng thay vì dùng template mặc định đi kèm. + +**Mẹo viết template** + +- Giữ template trong `{project-root}/docs/` hoặc `{project-root}/_bmad/custom/templates/` để nó được version cùng với file override +- Nên dùng cùng convention cấu trúc với template mặc định, ví dụ heading và frontmatter, để agent có điểm tựa ổn định +- Với repo đa tổ chức, hãy dùng `.user.toml` để từng nhóm nhỏ có thể trỏ sang template riêng mà không cần sửa file dùng chung của team + +## Recipe 5: tùy chỉnh danh sách agent (agent roster) + +**Trường hợp dùng (use case):** Thay đổi *ai đang ngồi trong phòng* cho những skill dựa trên roster như `bmad-party-mode`, `bmad-retrospective` và `bmad-advanced-elicitation`, mà không cần sửa source hay fork. Dưới đây là ba biến thể thường gặp. + +### 5a. Rebrand một agent của BMad trên toàn tổ chức + +Mỗi agent thật đều có một descriptor được installer tổng hợp từ `module.yaml`. Bạn có thể override descriptor này để đổi giọng điệu và framing ở mọi roster consumer: + +```toml +# _bmad/custom/config.toml (commit vào git, áp dụng cho mọi developer) + +[agents.bmad-agent-analyst] +description = "Mary, nhà phân tích nghiệp vụ giàu nhận thức pháp lý, pha trộn Porter với Minto nhưng sống cùng các audit trail của FDA. Cô ấy nói như một điều tra viên pháp chứng đang trình bày hồ sơ vụ án." +``` + +Party mode sẽ spawn Mary với description mới này. Bản thân activation của analyst vẫn chạy bình thường vì hành vi của Mary sống trong `customize.toml` theo từng skill. Override này chỉ thay đổi cách **các skill bên ngoài nhìn thấy và giới thiệu cô ấy**, chứ không thay đổi cách cô ấy hoạt động bên trong. + +### 5b. Thêm một agent hư cấu hoặc agent tự định nghĩa + +Chỉ cần một descriptor đầy đủ là đủ cho các tính năng dựa trên roster, không cần thư mục skill. Điều này rất phù hợp nếu bạn muốn tăng màu sắc tính cách cho party mode hay các buổi brainstorming: + +```toml +# _bmad/custom/config.user.toml (cá nhân, gitignore) + +[agents.spock] +team = "startrek" +name = "Commander Spock" +title = "Science Officer" +icon = "🖖" +description = "Logic là trên hết, cảm xúc bị nén lại. Mở đầu nhận xét bằng 'Fascinating.' Không bao giờ làm tròn lên. Là đối trọng với mọi lập luận chỉ dựa vào linh cảm." + +[agents.mccoy] +team = "startrek" +name = "Dr. Leonard McCoy" +title = "Chief Medical Officer" +icon = "⚕️" +description = "Sự ấm áp của một bác sĩ miền quê, đi kèm với tính nóng nảy. 'Dammit Jim, I'm a doctor not a ___.' Là đối trọng đạo đức với Spock." +``` + +Khi bạn yêu cầu party-mode "mời nhóm Star Trek" hoặc "mời phi hành đoàn Enterprise", nó sẽ lọc theo `team = "startrek"` và spawn Spock cùng McCoy dựa trên các descriptor đó. Các agent thật của BMad như Mary hay Amelia vẫn có thể ngồi cùng bàn nếu bạn muốn. + +### 5c. Ghim thiết lập cài đặt dùng chung cho cả team + +Installer sẽ hỏi từng developer các giá trị như đường dẫn `planning_artifacts`. Khi tổ chức muốn có một câu trả lời thống nhất, hãy ghim nó trong cấu hình trung tâm. Khi đó, mọi câu trả lời cục bộ của từng người sẽ bị override lúc resolve: + +```toml +# _bmad/custom/config.toml + +[modules.bmm] +planning_artifacts = "{project-root}/shared/planning" +implementation_artifacts = "{project-root}/shared/implementation" + +[core] +document_output_language = "English" +``` + +Những thiết lập cá nhân như `user_name`, `communication_language` hoặc `user_skill_level` nên vẫn nằm trong `_bmad/config.user.toml` riêng của từng developer. File chung của team không nên đụng vào các giá trị đó. + +**Vì sao việc này nằm ở cấu hình trung tâm thay vì per-agent customize.toml:** File per-agent chỉ định hình cách *một* agent hành xử khi nó được kích hoạt. Cấu hình trung tâm lại định hình những gì các roster consumer *nhìn thấy khi quan sát cánh đồng chung*: agent nào tồn tại, tên gì, thuộc team nào và các thiết lập cài đặt dùng chung mà toàn repo đã thống nhất. Hai bề mặt khác nhau, hai công việc khác nhau. + +## Củng cố các quy tắc toàn cục trong file hướng dẫn phiên của IDE + +Tùy chỉnh của BMad chỉ được nạp khi một skill được kích hoạt. Trong khi đó, nhiều công cụ IDE còn nạp một file hướng dẫn toàn cục ở **đầu mọi phiên**, trước cả khi skill nào chạy, như `CLAUDE.md`, `AGENTS.md`, `.cursor/rules/` hay `.github/copilot-instructions.md`. Với những quy tắc phải đúng cả khi bạn đang chat thường, hãy lặp lại phiên bản rút gọn của chúng trong file đó nữa. + +**Khi nào nên "đánh đôi"** + +- Quy tắc đó đủ quan trọng đến mức một cuộc chat thường, chưa kích hoạt BMad skill nào, cũng vẫn phải tuân theo +- Bạn muốn áp dụng kiểu "gia cố hai lớp" (belt-and-suspenders) vì hành vi mặc định từ dữ liệu huấn luyện (training data) có thể kéo model đi chệch +- Quy tắc đủ ngắn để lặp lại mà không làm file hướng dẫn đầu phiên trở nên phình to + +**Ví dụ:** một dòng trong `CLAUDE.md` của repo để củng cố quy tắc ở Recipe 1. + +```markdown + +``` + +Chỉ một câu, nhưng được nạp ở mọi phiên. Nó kết hợp với cấu hình `bmad-agent-dev.toml` để quy tắc có hiệu lực cả trong workflow của Amelia lẫn trong các cuộc trò chuyện ad-hoc với assistant. Mỗi lớp giữ đúng phạm vi của mình: + +| Lớp | Phạm vi | Dùng cho | +|---|---|---| +| File hướng dẫn phiên của IDE như `CLAUDE.md` hoặc `AGENTS.md` | Mọi phiên, trước khi bất kỳ skill nào chạy | Quy tắc ngắn, phổ quát, phải sống cả ngoài BMad | +| Tùy chỉnh agent của BMad | Mọi workflow mà agent đó dispatch | Hành vi riêng theo persona/agent | +| Tùy chỉnh workflow của BMad | Một lần chạy workflow | Dạng đầu ra, hook publish, template và logic riêng của workflow | +| Cấu hình trung tâm của BMad | Agent roster và thiết lập cài đặt dùng chung | Ai đang ngồi trong phòng và đường dẫn nào cả team dùng chung | + +Hãy giữ file hướng dẫn của IDE **ngắn gọn**. Một tá dòng được chọn kỹ sẽ hiệu quả hơn một danh sách dài lê thê. Model phải đọc file đó ở mọi lượt, và càng nhiều nhiễu thì càng ít tín hiệu. + +## Kết hợp các recipe + +Cả năm recipe này có thể kết hợp song song. Một cấu hình doanh nghiệp thực tế cho `bmad-product-brief` hoàn toàn có thể đặt `persistent_facts` theo Recipe 2, `on_complete` theo Recipe 3 và `brief_template` theo Recipe 4 trong cùng một file. Quy tắc ở cấp agent theo Recipe 1 sẽ nằm trong file của agent tương ứng, còn cấu hình trung tâm theo Recipe 5 thì ghim roster và thiết lập chung. Tất cả cùng hoạt động đồng thời. + +```toml +# _bmad/custom/bmad-product-brief.toml (cấp workflow) + +[workflow] +persistent_facts = ["..."] +brief_template = "{project-root}/docs/enterprise/brief-template.md" +on_complete = """ ... """ +``` + +```toml +# _bmad/custom/bmad-agent-analyst.toml (cấp agent, Mary sẽ dispatch product-brief) + +[agent] +persistent_facts = ["Luôn thêm mục 'Regulatory Review' khi domain liên quan tới healthcare, finance hoặc dữ liệu trẻ em."] +``` + +Kết quả là Mary nạp quy tắc review pháp lý ngay ở lúc kích hoạt persona. Khi người dùng chọn menu item product-brief, workflow sẽ nạp các convention riêng của nó chồng lên, ghi ra template của doanh nghiệp và publish lên Confluence khi hoàn tất. Mỗi lớp đều đóng góp một phần và không lớp nào đòi hỏi sửa source của BMad. + +## Khắc phục sự cố + +**Override không có tác dụng?** Hãy kiểm tra file có nằm trong `_bmad/custom/` và dùng đúng tên thư mục skill không, ví dụ `bmad-agent-dev.toml`, chứ không phải `bmad-dev.toml`. Nếu cần, xem lại [Cách tùy chỉnh BMad](./customize-bmad.md). + +**Không chắc tên MCP tool?** Hãy dùng đúng tên mà MCP server hiện tại expose trong phiên của bạn. Nếu chưa chắc, hãy yêu cầu Claude Code liệt kê các MCP tool đang có. Những tên hardcode trong `persistent_facts` hay `on_complete` sẽ không chạy nếu MCP server chưa được kết nối. + +**Mẫu áp dụng (pattern) trong ví dụ không khớp setup của tôi?** Các recipe trên chỉ là ví dụ mẫu. Cơ chế bên dưới, gồm merge ba lớp, quy tắc cấu trúc và mô hình agent-span-workflow, vẫn hỗ trợ nhiều pattern khác. Hãy kết hợp chúng theo nhu cầu thực tế của bạn. diff --git a/docs/vi-vn/how-to/get-answers-about-bmad.md b/docs/vi-vn/how-to/get-answers-about-bmad.md index a09aafa52..103230306 100644 --- a/docs/vi-vn/how-to/get-answers-about-bmad.md +++ b/docs/vi-vn/how-to/get-answers-about-bmad.md @@ -5,79 +5,27 @@ sidebar: order: 4 --- -## Bắt đầu tại đây: BMad-Help +Hãy dùng trợ giúp tích hợp sẵn của BMad, tài liệu nguồn, hoặc cộng đồng để tìm câu trả lời, theo thứ tự từ nhanh nhất đến đầy đủ nhất. -**Cách nhanh nhất để tìm câu trả lời về BMad là dùng skill `bmad-help`.** Đây là công cụ hướng dẫn thông minh có thể trả lời hơn 80% các câu hỏi và có sẵn ngay trong IDE khi bạn làm việc. +## 1. Hỏi BMad-Help -BMad-Help không chỉ là công cụ tra cứu, nó còn: -- **Kiểm tra dự án của bạn** để xem những gì đã hoàn thành -- **Hiểu ngôn ngữ tự nhiên** - đặt câu hỏi bằng ngôn ngữ bình thường -- **Thay đổi theo module đã cài** - hiển thị các lựa chọn liên quan -- **Tự động chạy sau workflow** - nói rõ bạn cần làm gì tiếp theo -- **Đề xuất tác vụ đầu tiên cần thiết** - không cần đoán nên bắt đầu từ đâu - -### Cách dùng BMad-Help - -Gọi nó trực tiếp trong phiên AI của bạn: +Cách nhanh nhất để có câu trả lời. Skill `bmad-help` có sẵn ngay trong phiên AI của bạn và xử lý được hơn 80% câu hỏi. Nó sẽ kiểm tra dự án, nhìn xem bạn đã hoàn thành đến đâu và cho bạn biết nên làm gì tiếp theo. ```text -bmad-help +bmad-help Tôi có ý tưởng SaaS và đã biết tất cả tính năng. Tôi nên bắt đầu từ đâu? +bmad-help Tôi có những lựa chọn nào cho thiết kế UX? +bmad-help Tôi đang bị mắc ở workflow PRD ``` :::tip Bạn cũng có thể dùng `/bmad-help` hoặc `$bmad-help` tùy nền tảng, nhưng chỉ `bmad-help` là cách nên hoạt động mọi nơi. ::: -Kết hợp với câu hỏi ngôn ngữ tự nhiên: +## 2. Đi sâu hơn với mã nguồn -```text -bmad-help Tôi có ý tưởng SaaS và đã biết tất cả tính năng. Tôi nên bắt đầu từ đâu? -bmad-help Tôi có những lựa chọn nào cho thiết kế UX? -bmad-help Tôi đang bị mắc ở workflow PRD -bmad-help Cho tôi xem tôi đã làm được gì đến giờ -``` +BMad-Help dựa trên cấu hình bạn đã cài đặt. Nếu bạn cần tìm hiểu nội bộ, lịch sử, hay kiến trúc của BMad, hoặc đang nghiên cứu BMad trước khi cài, hãy để AI đọc trực tiếp mã nguồn. -BMad-Help sẽ trả lời: -- Điều gì được khuyến nghị cho tình huống của bạn -- Tác vụ đầu tiên cần thiết là gì -- Phần còn lại của quy trình trông thế nào - -## Khi nào nên dùng tài liệu này - -Hãy xem phần này khi: -- Bạn muốn hiểu kiến trúc hoặc nội bộ của BMad -- Bạn cần câu trả lời nằm ngoài phạm vi BMad-Help cung cấp -- Bạn đang nghiên cứu BMad trước khi cài đặt -- Bạn muốn tự khám phá source code trực tiếp - -## Các bước thực hiện - -### 1. Chọn nguồn thông tin - -| Nguồn | Phù hợp nhất cho | Ví dụ | -| --- | --- | --- | -| **Thư mục `_bmad`** | Cách BMad vận hành: agent, workflow, prompt | "PM agent làm gì?" | -| **Toàn bộ repo GitHub** | Lịch sử, installer, kiến trúc | "v6 thay đổi gì?" | -| **`llms-full.txt`** | Tổng quan nhanh từ tài liệu | "Giải thích bốn giai đoạn của BMad" | - -Thư mục `_bmad` được tạo khi bạn cài đặt BMad. Nếu chưa có, hãy clone repo thay thế. - -### 2. Cho AI của bạn truy cập nguồn thông tin - -**Nếu AI của bạn đọc được tệp (Claude Code, Cursor, ...):** - -- **Đã cài BMad:** Trỏ đến thư mục `_bmad` và hỏi trực tiếp -- **Cần bối cảnh sâu hơn:** Clone [repo đầy đủ](https://github.com/bmad-code-org/BMAD-METHOD) - -**Nếu bạn dùng ChatGPT hoặc Claude.ai:** - -Nạp `llms-full.txt` vào phiên làm việc: - -```text -https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt -``` - -### 3. Đặt câu hỏi +Hãy clone hoặc mở [repo BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) rồi hỏi AI của bạn về nó. Bất kỳ công cụ nào có hỗ trợ agent như Claude Code, Cursor, Windsurf... đều có thể đọc mã nguồn và trả lời trực tiếp. :::note[Ví dụ] **Q:** "Hãy chỉ tôi cách nhanh nhất để xây dựng một thứ gì đó bằng BMad" @@ -85,29 +33,27 @@ https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt **A:** Dùng Quick Flow: Chạy `bmad-quick-dev` - nó sẽ làm rõ ý định, lập kế hoạch, triển khai, review và trình bày kết quả trong một workflow duy nhất, bỏ qua các giai đoạn lập kế hoạch đầy đủ. ::: -## Bạn nhận được gì +**Mẹo để có câu trả lời tốt hơn:** -Các câu trả lời trực tiếp về BMad: agent hoạt động ra sao, workflow làm gì, tại sao cấu trúc lại được tổ chức như vậy, mà không cần chờ người khác trả lời. +- **Hãy hỏi thật cụ thể** - "Bước 3 trong workflow PRD làm gì?" sẽ tốt hơn "PRD hoạt động ra sao?" +- **Kiểm tra lại những câu trả lời nghe lạ** - LLM đôi khi vẫn sai. Hãy kiểm tra file nguồn hoặc hỏi trên Discord. -## Mẹo +### Không dùng agent? Dùng trang docs -- **Xác minh những câu trả lời gây bất ngờ** - LLM vẫn có lúc nhầm. Hãy kiểm tra tệp nguồn hoặc hỏi trên Discord. -- **Đặt câu hỏi cụ thể** - "Bước 3 trong workflow PRD làm gì?" tốt hơn "PRD hoạt động ra sao?" +Nếu AI của bạn không đọc được file cục bộ như ChatGPT hoặc Claude.ai, hãy nạp [llms-full.txt](https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt) vào phiên làm việc. Đây là bản chụp tài liệu BMad trong một file duy nhất. -## Vẫn bị mắc? +## 3. Hỏi người thật -Đã thử cách tiếp cận bằng LLM mà vẫn cần trợ giúp? Lúc này bạn đã có một câu hỏi tốt hơn để đem đi hỏi. +Nếu cả BMad-Help lẫn mã nguồn vẫn chưa trả lời được câu hỏi của bạn, lúc này bạn đã có một câu hỏi rõ hơn nhiều để đem đi hỏi cộng đồng. | Kênh | Dùng cho | | --- | --- | -| `#bmad-method-help` | Câu hỏi nhanh (trò chuyện thời gian thực) | -| `help-requests` forum | Câu hỏi chi tiết (có thể tìm lại, tồn tại lâu dài) | +| `help-requests` forum | Câu hỏi | | `#suggestions-feedback` | Ý tưởng và đề xuất tính năng | -| `#report-bugs-and-issues` | Báo cáo lỗi | **Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) -**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (dành cho các lỗi rõ ràng) +**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) *Chính bạn,* *đang mắc kẹt* diff --git a/docs/vi-vn/how-to/install-bmad.md b/docs/vi-vn/how-to/install-bmad.md index 57105864c..c73e89388 100644 --- a/docs/vi-vn/how-to/install-bmad.md +++ b/docs/vi-vn/how-to/install-bmad.md @@ -72,7 +72,7 @@ Trình cài đặt sẽ hiện các module có sẵn. Chọn những module bạ ### 5. Làm theo các prompt -Trình cài đặt sẽ hướng dẫn các bước còn lại - nội dung tùy chỉnh, cài đặt, và các tùy chọn khác. +Trình cài đặt sẽ hướng dẫn các bước còn lại - cài đặt, tích hợp công cụ, và các tùy chọn khác. ## Bạn nhận được gì diff --git a/docs/vi-vn/how-to/install-custom-modules.md b/docs/vi-vn/how-to/install-custom-modules.md new file mode 100644 index 000000000..0b4064f1c --- /dev/null +++ b/docs/vi-vn/how-to/install-custom-modules.md @@ -0,0 +1,181 @@ +--- +title: 'Cài đặt module tùy chỉnh và module cộng đồng' +description: Cài các module bên thứ ba từ kho cộng đồng (community registry), kho Git hoặc đường dẫn cục bộ +sidebar: + order: 3 +--- + +Sử dụng trình cài đặt BMad để thêm module từ kho cộng đồng (community registry), kho Git của bên thứ ba hoặc đường dẫn file cục bộ. + +## Khi nào nên dùng + +- Cài một module do cộng đồng đóng góp từ BMad registry +- Cài module từ kho Git của bên thứ ba như GitHub, GitLab, Bitbucket hoặc máy chủ tự host +- Kiểm thử một module bạn đang phát triển cục bộ với BMad Builder +- Cài module từ máy chủ Git riêng tư hoặc tự host + +:::note[Điều kiện tiên quyết] +Yêu cầu [Node.js](https://nodejs.org) v20+ và `npx` đi kèm npm. Bạn có thể chọn module tùy chỉnh và module cộng đồng trong lúc cài mới, hoặc thêm chúng vào một bản cài hiện có. +::: + +## Module cộng đồng + +Các module cộng đồng được tuyển chọn trong [BMad plugins marketplace](https://github.com/bmad-code-org/bmad-plugins-marketplace). Chúng được sắp theo danh mục và được ghim vào commit đã được phê duyệt để tăng độ an toàn. + +### 1. Chạy trình cài đặt + +```bash +npx bmad-method install +``` + +### 2. Duyệt danh mục (catalog) cộng đồng + +Sau khi chọn module chính thức, trình cài đặt sẽ hỏi: + +``` +Would you like to browse community modules? +``` + +Chọn **Yes** để vào màn hình duyệt catalog. Tại đây bạn có thể: + +- Duyệt theo danh mục +- Xem các module nổi bật +- Xem toàn bộ module khả dụng +- Tìm kiếm theo từ khóa + +### 3. Chọn module + +Chọn module từ bất kỳ danh mục nào. Trình cài đặt sẽ hiển thị mô tả, phiên bản và mức độ tin cậy (trust tier). Những module đã cài sẽ được tick sẵn để tiện cập nhật. + +### 4. Tiếp tục quá trình cài đặt + +Sau khi chọn xong module cộng đồng, trình cài đặt sẽ chuyển sang bước nguồn tùy chỉnh (custom source), rồi tới cấu hình tool/IDE và phần còn lại của luồng cài đặt. + +## Nguồn tùy chỉnh: Git URL và đường dẫn cục bộ + +Module tùy chỉnh có thể đến từ bất kỳ kho Git nào hoặc từ một thư mục cục bộ trên máy bạn. Trình cài đặt sẽ resolve nguồn, phân tích cấu trúc module rồi cài nó song song với các module khác. + +### Cài đặt tương tác + +Trong quá trình cài, sau bước chọn community module, trình cài đặt sẽ hỏi: + +``` +Would you like to install from a custom source (Git URL or local path)? +``` + +Chọn **Yes**, rồi nhập nguồn: + +| Loại đầu vào | Ví dụ | +| --------------------- | ------------------------------------------------- | +| HTTPS URL trên bất kỳ host nào | `https://github.com/org/repo` | +| HTTP URL trên bất kỳ host nào | `http://host/org/repo` | +| HTTPS URL trỏ vào một thư mục con | `https://github.com/org/repo/tree/main/my-module` | +| SSH URL | `git@github.com:org/repo.git` | +| Đường dẫn cục bộ | `/Users/me/projects/my-module` | +| Đường dẫn cục bộ dùng `~` | `~/projects/my-module` | + +Với URL, trình cài đặt sẽ clone repository. Với đường dẫn cục bộ, nó sẽ đọc trực tiếp từ đĩa. Sau đó nó sẽ hiển thị các module tìm thấy để bạn chọn cài. + +### Cài đặt không tương tác + +Dùng cờ `--custom-source` để cài module tùy chỉnh từ dòng lệnh: + +```bash +npx bmad-method install \ + --directory . \ + --custom-source /path/to/my-module \ + --tools claude-code \ + --yes +``` + +Khi cung cấp `--custom-source` mà không kèm `--modules`, hệ thống chỉ cài core và các module tùy chỉnh. Nếu muốn cài cả module chính thức, hãy thêm `--modules`: + +```bash +npx bmad-method install \ + --directory . \ + --modules bmm \ + --custom-source https://gitlab.com/myorg/my-module \ + --tools claude-code \ + --yes +``` + +Bạn có thể truyền nhiều nguồn bằng cách ngăn cách chúng bằng dấu phẩy: + +```bash +--custom-source /path/one,https://github.com/org/repo,/path/two +``` + +## Cơ chế phát hiện module + +Trình cài đặt dùng hai chế độ để tìm module có thể cài trong một nguồn: + +| Chế độ | Điều kiện kích hoạt | Hành vi | +| --------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| Discovery | Nguồn chứa `.claude-plugin/marketplace.json` | Liệt kê toàn bộ plugin trong manifest để bạn chọn cái nào cần cài | +| Direct | Không tìm thấy `marketplace.json` | Quét thư mục để tìm các skill, tức các thư mục con chứa `SKILL.md`, rồi coi toàn bộ như một module duy nhất | + +Discovery là chế độ phát hiện qua manifest. Direct là chế độ quét trực tiếp thư mục. Discovery phù hợp với module đã publish, còn Direct thuận tiện khi bạn đang trỏ vào một thư mục skills trong quá trình phát triển cục bộ. + +:::note[Về thư mục `.claude-plugin/`] +Đường dẫn `.claude-plugin/marketplace.json` là một quy ước tiêu chuẩn được nhiều trình cài đặt AI tool cùng dùng để hỗ trợ khả năng khám phá plugin. Nó không đòi hỏi Claude, không dùng Claude API và cũng không ảnh hưởng tới việc bạn đang dùng công cụ AI nào. Bất kỳ module nào có file này đều có thể được khám phá bởi những trình cài đặt tuân theo cùng quy ước. +::: + +## Quy trình phát triển cục bộ + +Nếu bạn đang xây một module bằng [BMad Builder](https://github.com/bmad-code-org/bmad-builder), bạn có thể cài trực tiếp từ thư mục đang làm việc: + +```bash +npx bmad-method install \ + --directory ~/my-project \ + --custom-source ~/my-module-repo/skills \ + --tools claude-code \ + --yes +``` + +Nguồn cục bộ được tham chiếu theo đường dẫn, không bị copy vào cache. Khi bạn sửa source của module rồi cài lại, trình cài đặt sẽ lấy đúng các thay đổi mới nhất. + +:::caution[Xóa nguồn sau khi cài] +Nếu bạn xóa thư mục nguồn cục bộ sau khi cài, các file module đã được cài bên trong `_bmad/` vẫn được giữ nguyên. Tuy vậy, module đó sẽ bị bỏ qua trong các lần cập nhật cho tới khi đường dẫn nguồn được khôi phục. +::: + +## Bạn sẽ nhận được gì + +Sau khi cài, các module tùy chỉnh sẽ xuất hiện trong `_bmad/` cùng với module chính thức: + +```text +your-project/ +├── _bmad/ +│ ├── core/ # Module core tích hợp +│ ├── bmm/ # Module chính thức, nếu bạn chọn +│ ├── my-module/ # Module tùy chỉnh của bạn +│ │ ├── my-skill/ +│ │ │ └── SKILL.md +│ │ └── module-help.csv +│ └── _config/ +│ └── manifest.yaml # Theo dõi mọi module, phiên bản và nguồn +└── ... +``` + +Manifest sẽ ghi lại nguồn của từng module tùy chỉnh, dùng `repoUrl` cho nguồn Git và `localPath` cho nguồn cục bộ, để quá trình cập nhật nhanh (quick update) sau này có thể tìm lại nguồn chính xác. + +## Cập nhật module tùy chỉnh + +Module tùy chỉnh tham gia vào luồng cập nhật bình thường: + +- **Cập nhật nhanh (quick update)** với `--action quick-update`: làm mới mọi module từ đúng nguồn ban đầu. Module dựa trên Git sẽ được fetch lại, còn module cục bộ sẽ được đọc lại từ đường dẫn nguồn +- **Cập nhật đầy đủ (full update)**: chạy lại bước chọn module để bạn có thể thêm hoặc gỡ module tùy chỉnh + +## Tạo module của riêng bạn + +Hãy dùng [BMad Builder](https://github.com/bmad-code-org/bmad-builder) để tạo module mà người khác có thể cài: + +1. Chạy `bmad-module-builder` để sinh skeleton cho module +2. Thêm skill, agent và workflow bằng các công cụ builder tương ứng +3. Publish lên một kho Git hoặc chia sẻ cả thư mục +4. Người khác có thể cài bằng `--custom-source ` + +Nếu muốn module hỗ trợ chế độ Discovery, hãy thêm `.claude-plugin/marketplace.json` ở root repository. Đây là quy ước chung giữa nhiều công cụ, không dành riêng cho Claude. Hãy xem [tài liệu của BMad Builder](https://github.com/bmad-code-org/bmad-builder) để biết định dạng của `marketplace.json`. + +:::tip[Hãy thử cục bộ trước] +Trong quá trình phát triển, hãy cài module bằng đường dẫn cục bộ để lặp nhanh trước khi publish lên kho Git. +::: diff --git a/docs/vi-vn/how-to/non-interactive-installation.md b/docs/vi-vn/how-to/non-interactive-installation.md index 2ba75b7ec..1f8856377 100644 --- a/docs/vi-vn/how-to/non-interactive-installation.md +++ b/docs/vi-vn/how-to/non-interactive-installation.md @@ -27,8 +27,8 @@ Yêu cầu [Node.js](https://nodejs.org) v20+ và `npx` (đi kèm với npm). | `--directory ` | Thư mục cài đặt | `--directory ~/projects/myapp` | | `--modules ` | Danh sách ID module, cách nhau bởi dấu phẩy | `--modules bmm,bmb` | | `--tools ` | Danh sách ID công cụ/IDE, cách nhau bởi dấu phẩy (dùng `none` để bỏ qua) | `--tools claude-code,cursor` hoặc `--tools none` | -| `--custom-content ` | Danh sách đường dẫn đến module tùy chỉnh, cách nhau bởi dấu phẩy | `--custom-content ~/my-module,~/another-module` | | `--action ` | Hành động cho bản cài đặt hiện có: `install` (mặc định), `update`, hoặc `quick-update` | `--action quick-update` | +| `--custom-source ` | Danh sách Git URL hoặc đường dẫn cục bộ cho module tùy chỉnh, cách nhau bởi dấu phẩy | `--custom-source /path/to/module` | ### Cấu hình cốt lõi @@ -82,6 +82,7 @@ Chạy `npx bmad-method install` một lần ở chế độ tương tác để | Hoàn toàn không tương tác | Cung cấp đầy đủ cờ để bỏ qua tất cả prompt | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` | | Bán tương tác | Cung cấp một số cờ, BMad hỏi thêm phần còn lại | `npx bmad-method install --directory . --modules bmm` | | Chỉ dùng mặc định | Chấp nhận tất cả giá trị mặc định với `-y` | `npx bmad-method install --yes` | +| Chỉ dùng custom source | Chỉ cài core và module tùy chỉnh | `npx bmad-method install --directory . --custom-source /path/to/module --tools claude-code --yes` | | Không cấu hình công cụ | Bỏ qua cấu hình công cụ/IDE | `npx bmad-method install --modules bmm --tools none` | ## Ví dụ @@ -120,16 +121,33 @@ npx bmad-method install \ --action quick-update ``` -### Cài đặt với nội dung tùy chỉnh +### Cài từ custom source + +Cài một module từ đường dẫn cục bộ hoặc từ bất kỳ Git host nào: ```bash npx bmad-method install \ - --directory ~/projects/myapp \ - --modules bmm \ - --custom-content ~/my-custom-module,~/another-module \ - --tools claude-code + --directory . \ + --custom-source /path/to/my-module \ + --tools claude-code \ + --yes ``` +Kết hợp cùng module chính thức: + +```bash +npx bmad-method install \ + --directory . \ + --modules bmm \ + --custom-source https://gitlab.com/myorg/my-module \ + --tools claude-code \ + --yes +``` + +:::note[Hành vi của `custom-source`] +Khi dùng `--custom-source` mà không kèm `--modules`, hệ thống chỉ cài core và các module tùy chỉnh. Nếu muốn cài cả module chính thức, hãy thêm `--modules`. Xem thêm [Cài đặt module tùy chỉnh và module cộng đồng](./install-custom-modules.md) để biết chi tiết. +::: + ## Bạn nhận được gì - Thư mục `_bmad/` đã được cấu hình đầy đủ trong dự án của bạn @@ -143,12 +161,11 @@ BMad sẽ kiểm tra tất cả các cờ được cung cấp: - **Directory** - Phải là đường dẫn hợp lệ và có quyền ghi - **Modules** - Cảnh báo nếu ID module không hợp lệ (nhưng không thất bại) - **Tools** - Cảnh báo nếu ID công cụ không hợp lệ (nhưng không thất bại) -- **Custom Content** - Mỗi đường dẫn phải chứa tệp `module.yaml` hợp lệ - **Action** - Phải là một trong: `install`, `update`, `quick-update` Giá trị không hợp lệ sẽ dẫn đến một trong các trường hợp sau: 1. Hiện lỗi và thoát (với các tùy chọn quan trọng như directory) -2. Hiện cảnh báo và bỏ qua (với mục tùy chọn như custom content) +2. Hiện cảnh báo và bỏ qua (với mục tùy chọn) 3. Quay lại hỏi interactive (với giá trị bắt buộc bị thiếu) :::tip[Thực hành tốt] @@ -172,13 +189,6 @@ Giá trị không hợp lệ sẽ dẫn đến một trong các trường hợp - Xác minh ID module có đúng không - Module bên ngoài phải có sẵn trong registry -### Đường dẫn custom content không hợp lệ - -Đảm bảo mỗi đường dẫn custom content: -- Trỏ tới một thư mục -- Chứa tệp `module.yaml` ở cấp gốc -- Có trường `code` trong tệp `module.yaml` - :::note[Vẫn bị mắc?] Chạy với `--debug` để xem output chi tiết, thử chế độ interactive để cô lập vấn đề, hoặc báo cáo tại . ::: diff --git a/docs/vi-vn/how-to/project-context.md b/docs/vi-vn/how-to/project-context.md index 6860a948e..41b3b4049 100644 --- a/docs/vi-vn/how-to/project-context.md +++ b/docs/vi-vn/how-to/project-context.md @@ -1,5 +1,5 @@ --- -title: "Quản lý Project Context" +title: "Quản lý bối cảnh dự án" description: Tạo và duy trì project-context.md để định hướng cho các agent AI sidebar: order: 8 diff --git a/docs/vi-vn/how-to/quick-fixes.md b/docs/vi-vn/how-to/quick-fixes.md index 1ecd72fb4..5f38d5f92 100644 --- a/docs/vi-vn/how-to/quick-fixes.md +++ b/docs/vi-vn/how-to/quick-fixes.md @@ -1,5 +1,5 @@ --- -title: "Quick Fixes" +title: "Sửa nhanh" description: Cách thực hiện các sửa nhanh và thay đổi ad-hoc sidebar: order: 5 diff --git a/docs/vi-vn/reference/agents.md b/docs/vi-vn/reference/agents.md index 779ae9a30..ca57900ed 100644 --- a/docs/vi-vn/reference/agents.md +++ b/docs/vi-vn/reference/agents.md @@ -1,5 +1,5 @@ --- -title: Agents +title: Các agent description: Các agent mặc định của BMM cùng skill ID, trigger menu và workflow chính sidebar: order: 2 @@ -17,7 +17,7 @@ Trang này liệt kê các agent mặc định của BMM (bộ Agile suite) đư | Agent | Skill ID | Trigger | Workflow chính | | --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- | -| Analyst (Mary) | `bmad-analyst` | `BP`, `RS`, `CB`, `WB`, `DP` | Brainstorm Project, Research, Create Brief, PRFAQ Challenge, Document Project | +| Analyst (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorm, Market Research, Domain Research, Technical Research, Create Brief, PRFAQ Challenge, Document Project | | Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course | | Architect (Winston) | `bmad-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness | | Developer (Amelia) | `bmad-agent-dev` | `DS`, `QD`, `QA`, `CR`, `SP`, `CS`, `ER` | Dev Story, Quick Dev, QA Test Generation, Code Review, Sprint Planning, Create Story, Epic Retrospective | diff --git a/docs/vi-vn/reference/commands.md b/docs/vi-vn/reference/commands.md index 3a3a18d78..539956de1 100644 --- a/docs/vi-vn/reference/commands.md +++ b/docs/vi-vn/reference/commands.md @@ -1,5 +1,5 @@ --- -title: Skills +title: Các skill description: Tài liệu tham chiếu cho skill của BMad — skill là gì, hoạt động ra sao và tìm ở đâu. sidebar: order: 3 @@ -92,7 +92,7 @@ Workflow skills chạy một quy trình có cấu trúc, nhiều bước mà kh | Ví dụ skill | Mục đích | | --- | --- | | `bmad-product-brief` | Tạo product brief — phiên discovery có hướng dẫn khi concept của bạn đã rõ | -| `bmad-prfaq` | Bài kiểm tra Working Backwards PRFAQ để stress-test concept sản phẩm | +| `bmad-prfaq` | Bài kiểm tra [Working Backwards PRFAQ](../explanation/analysis-phase.md#prfaq-working-backwards) để stress-test concept sản phẩm | | `bmad-create-prd` | Tạo Product Requirements Document | | `bmad-create-architecture` | Thiết kế kiến trúc hệ thống | | `bmad-create-epics-and-stories` | Tạo epics và stories | diff --git a/docs/vi-vn/reference/core-tools.md b/docs/vi-vn/reference/core-tools.md index b2deebcde..4d15e3969 100644 --- a/docs/vi-vn/reference/core-tools.md +++ b/docs/vi-vn/reference/core-tools.md @@ -1,31 +1,31 @@ --- -title: Core Tools -description: Tài liệu tham chiếu cho mọi task và workflow tích hợp sẵn có trong mọi bản cài BMad mà không cần module bổ sung. +title: Công cụ cốt lõi +description: Tài liệu tham chiếu cho mọi tác vụ và quy trình tích hợp sẵn có trong mọi bản cài BMad mà không cần module bổ sung. sidebar: order: 2 --- -Mọi bản cài BMad đều bao gồm một tập core skills có thể dùng cùng với bất cứ việc gì bạn đang làm — các task và workflow độc lập hoạt động xuyên suốt mọi dự án, mọi module và mọi phase. Chúng luôn có sẵn bất kể bạn cài những module tùy chọn nào. +Mọi bản cài BMad đều bao gồm một tập skill cốt lõi có thể dùng cùng với bất cứ việc gì bạn đang làm, các tác vụ và quy trình độc lập hoạt động xuyên suốt mọi dự án, mọi module và mọi giai đoạn. Chúng luôn có sẵn bất kể bạn cài những module tùy chọn nào. :::tip[Lối đi nhanh] -Chạy bất kỳ core tool nào bằng cách gõ tên skill của nó, ví dụ `bmad-help`, trong IDE của bạn. Không cần mở phiên agent trước. +Chạy bất kỳ công cụ cốt lõi nào bằng cách gõ tên skill của nó, ví dụ `bmad-help`, trong IDE của bạn. Không cần mở phiên agent trước. ::: ## Tổng Quan | Công cụ | Loại | Mục đích | | --- | --- | --- | -| [`bmad-help`](#bmad-help) | Task | Nhận hướng dẫn có ngữ cảnh về việc nên làm gì tiếp theo | -| [`bmad-brainstorming`](#bmad-brainstorming) | Workflow | Tổ chức các phiên brainstorming có tương tác | -| [`bmad-party-mode`](#bmad-party-mode) | Workflow | Điều phối thảo luận nhóm nhiều agent | -| [`bmad-distillator`](#bmad-distillator) | Task | Nén tài liệu tối ưu cho LLM mà không mất thông tin | -| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | Task | Đẩy đầu ra của LLM qua các vòng tinh luyện lặp | -| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | Task | Review hoài nghi để tìm chỗ thiếu và chỗ sai | -| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | Task | Phân tích toàn bộ nhánh rẽ để tìm edge case chưa được xử lý | -| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | Task | Biên tập câu chữ nhằm tăng độ rõ ràng khi giao tiếp | -| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Task | Biên tập cấu trúc — cắt, gộp và tổ chức lại | -| [`bmad-shard-doc`](#bmad-shard-doc) | Task | Tách file markdown lớn thành các phần có tổ chức | -| [`bmad-index-docs`](#bmad-index-docs) | Task | Tạo hoặc cập nhật mục lục cho toàn bộ tài liệu trong một thư mục | +| [`bmad-help`](#bmad-help) | Tác vụ | Nhận hướng dẫn có ngữ cảnh về việc nên làm gì tiếp theo | +| [`bmad-brainstorming`](#bmad-brainstorming) | Quy trình | Tổ chức các phiên brainstorming có tương tác | +| [`bmad-party-mode`](#bmad-party-mode) | Quy trình | Điều phối thảo luận nhóm nhiều agent | +| [`bmad-distillator`](#bmad-distillator) | Tác vụ | Nén tài liệu tối ưu cho LLM mà không mất thông tin | +| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | Tác vụ | Đẩy đầu ra của LLM qua các vòng tinh luyện lặp | +| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | Tác vụ | Rà soát hoài nghi để tìm chỗ thiếu và chỗ sai | +| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | Tác vụ | Phân tích toàn bộ nhánh rẽ để tìm trường hợp biên chưa được xử lý | +| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | Tác vụ | Biên tập câu chữ nhằm tăng độ rõ ràng khi giao tiếp | +| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Tác vụ | Biên tập cấu trúc — cắt, gộp và tổ chức lại | +| [`bmad-shard-doc`](#bmad-shard-doc) | Tác vụ | Tách file markdown lớn thành các phần có tổ chức | +| [`bmad-index-docs`](#bmad-index-docs) | Tác vụ | Tạo hoặc cập nhật mục lục cho toàn bộ tài liệu trong một thư mục | ## bmad-help @@ -33,7 +33,7 @@ Chạy bất kỳ core tool nào bằng cách gõ tên skill của nó, ví dụ **Dùng khi:** -- Bạn vừa hoàn tất một workflow và muốn biết tiếp theo là gì +- Bạn vừa hoàn tất một quy trình và muốn biết tiếp theo là gì - Bạn mới làm quen với BMad và cần định hướng - Bạn đang mắc kẹt và muốn lời khuyên có ngữ cảnh - Bạn vừa cài module mới và muốn xem có gì khả dụng @@ -51,7 +51,7 @@ Chạy bất kỳ core tool nào bằng cách gõ tên skill của nó, ví dụ ## bmad-brainstorming -**Tạo ra nhiều ý tưởng đa dạng bằng các kỹ thuật sáng tạo có tương tác.** Đây là một phiên brainstorming có điều phối, nạp các phương pháp phát ý tưởng đã được kiểm chứng từ thư viện kỹ thuật và dẫn bạn đến 100+ ý tưởng trước khi bắt đầu sắp xếp. +**Tạo ra nhiều ý tưởng đa dạng bằng các kỹ thuật sáng tạo có tương tác.** Đây là một phiên động não có điều phối, nạp các phương pháp phát ý tưởng đã được kiểm chứng từ thư viện kỹ thuật và dẫn bạn đến 100+ ý tưởng trước khi bắt đầu sắp xếp. **Dùng khi:** diff --git a/docs/vi-vn/reference/workflow-map.md b/docs/vi-vn/reference/workflow-map.md index d8a87fcbb..c4023e481 100644 --- a/docs/vi-vn/reference/workflow-map.md +++ b/docs/vi-vn/reference/workflow-map.md @@ -1,17 +1,17 @@ --- -title: "Workflow Map" -description: Tài liệu trực quan về các phase workflow và output của BMad Method +title: "Sơ đồ workflow" +description: Tài liệu trực quan về các giai đoạn, quy trình và đầu ra của BMad Method sidebar: order: 1 --- -BMad Method (BMM) là một module trong hệ sinh thái BMad, tập trung vào các thực hành tốt nhất của context engineering và lập kế hoạch. AI agent hoạt động hiệu quả nhất khi có ngữ cảnh rõ ràng và có cấu trúc. Hệ thống BMM xây dựng ngữ cảnh đó theo tiến trình qua 4 phase riêng biệt. Mỗi phase, cùng với nhiều workflow tùy chọn bên trong phase đó, tạo ra các tài liệu làm đầu vào cho phase kế tiếp, nhờ vậy agent luôn biết phải xây gì và vì sao. +BMad Method (BMM) là một module trong hệ sinh thái BMad, tập trung vào các thực hành tốt nhất của kỹ nghệ ngữ cảnh và lập kế hoạch. AI agent hoạt động hiệu quả nhất khi có ngữ cảnh rõ ràng và có cấu trúc. Hệ thống BMM xây dựng ngữ cảnh đó theo tiến trình qua 4 giai đoạn riêng biệt. Mỗi giai đoạn, cùng với nhiều quy trình tùy chọn bên trong nó, tạo ra các tài liệu làm đầu vào cho giai đoạn kế tiếp, nhờ vậy agent luôn biết phải xây gì và vì sao. -Lý do và các khái niệm nền tảng ở đây đến từ các phương pháp agile đã được áp dụng rất thành công trong toàn ngành như một khung tư duy. +Lý do và các khái niệm nền tảng ở đây đến từ các phương pháp Agile đã được áp dụng rất thành công trong toàn ngành như một khung tư duy. -Nếu có lúc nào bạn không chắc nên làm gì, skill `bmad-help` sẽ giúp bạn giữ đúng hướng hoặc biết bước tiếp theo. Bạn vẫn có thể dùng trang này để tham chiếu, nhưng `bmad-help` mang tính tương tác đầy đủ và nhanh hơn nhiều nếu bạn đã cài BMad Method. Ngoài ra, nếu bạn đang dùng thêm các module mở rộng BMad Method hoặc các module bổ sung khác, `bmad-help` cũng sẽ phát triển theo để biết mọi thứ đang có sẵn và đưa ra lời khuyên tốt nhất tại thời điểm đó. +Nếu có lúc nào bạn không chắc nên làm gì, skill `bmad-help` sẽ giúp bạn giữ đúng hướng hoặc biết bước tiếp theo. Bạn vẫn có thể dùng trang này để tham chiếu, nhưng `bmad-help` mang tính tương tác đầy đủ và nhanh hơn nhiều nếu bạn đã cài BMad Method. Ngoài ra, nếu bạn đang dùng thêm các module mở rộng BMad Method hoặc các module bổ sung khác, `bmad-help` cũng sẽ mở rộng theo để biết mọi thứ đang có sẵn và đưa ra lời khuyên tốt nhất tại thời điểm đó. -Lưu ý quan trọng cuối cùng: mọi workflow dưới đây đều có thể chạy trực tiếp bằng công cụ bạn chọn thông qua skill, hoặc bằng cách nạp agent trước rồi chọn mục tương ứng trong menu agent. +Lưu ý quan trọng cuối cùng: mọi quy trình dưới đây đều có thể chạy trực tiếp bằng công cụ bạn chọn thông qua skill, hoặc bằng cách nạp agent trước rồi chọn mục tương ứng trong menu agent. @@ -19,43 +19,43 @@ Lưu ý quan trọng cuối cùng: mọi workflow dưới đây đều có thể Mở sơ đồ trong tab mới ↗

-## Phase 1: Analysis (Tùy chọn) +## Giai đoạn 1: Phân tích (tùy chọn) Khám phá không gian vấn đề và xác nhận ý tưởng trước khi cam kết đi vào lập kế hoạch. [**Tìm hiểu từng công cụ làm gì và nên dùng khi nào**](../explanation/analysis-phase.md). -| Workflow | Mục đích | Tạo ra | +| Quy trình | Mục đích | Tạo ra | | ------------------------------- | -------------------------------------------------------------------------- | ------------------------- | -| `bmad-brainstorming` | Brainstorm ý tưởng dự án với sự điều phối của brainstorming coach | `brainstorming-report.md` | +| `bmad-brainstorming` | Động não ý tưởng dự án với sự điều phối của người dẫn dắt brainstorming | `brainstorming-report.md` | | `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Xác thực giả định về thị trường, kỹ thuật hoặc miền nghiệp vụ | Kết quả nghiên cứu | | `bmad-product-brief` | Ghi lại tầm nhìn chiến lược — phù hợp nhất khi concept của bạn đã rõ | `product-brief.md` | | `bmad-prfaq` | Working Backwards — stress-test và rèn sắc concept sản phẩm của bạn | `prfaq-{project}.md` | -## Phase 2: Planning +## Giai đoạn 2: Lập kế hoạch Xác định cần xây gì và xây cho ai. -| Workflow | Mục đích | Tạo ra | +| Quy trình | Mục đích | Tạo ra | | --------------------------- | ---------------------------------------- | ------------ | | `bmad-create-prd` | Xác định yêu cầu (FR/NFR) | `PRD.md` | | `bmad-create-ux-design` | Thiết kế trải nghiệm người dùng khi UX là yếu tố quan trọng | `ux-spec.md` | -## Phase 3: Solutioning +## Giai đoạn 3: Định hình giải pháp -Quyết định cách xây và chia nhỏ công việc thành stories. +Quyết định cách xây và chia nhỏ công việc thành các story. -| Workflow | Mục đích | Tạo ra | +| Quy trình | Mục đích | Tạo ra | | ----------------------------------------- | ------------------------------------------ | --------------------------- | | `bmad-create-architecture` | Làm rõ các quyết định kỹ thuật | `architecture.md` kèm ADR | -| `bmad-create-epics-and-stories` | Phân rã yêu cầu thành các phần việc có thể triển khai | Các file epic chứa stories | +| `bmad-create-epics-and-stories` | Phân rã yêu cầu thành các phần việc có thể triển khai | Các file epic chứa các story | | `bmad-check-implementation-readiness` | Cổng kiểm tra trước khi triển khai | Quyết định PASS/CONCERNS/FAIL | -## Phase 4: Implementation +## Giai đoạn 4: Triển khai -Xây dựng từng story một. Tự động hóa toàn bộ phase 4 sẽ sớm ra mắt. +Xây dựng từng story một. Tự động hóa toàn bộ giai đoạn 4 sẽ sớm ra mắt. -| Workflow | Mục đích | Tạo ra | +| Quy trình | Mục đích | Tạo ra | | -------------------------- | ------------------------------------------------------------------------ | -------------------------------- | -| `bmad-sprint-planning` | Khởi tạo theo dõi, thường chạy một lần mỗi dự án để sắp thứ tự chu trình dev | `sprint-status.yaml` | +| `bmad-sprint-planning` | Khởi tạo theo dõi, thường chạy một lần mỗi dự án để sắp thứ tự chu trình phát triển | `sprint-status.yaml` | | `bmad-create-story` | Chuẩn bị story tiếp theo cho implementation | `story-[slug].md` | | `bmad-dev-story` | Triển khai story | Code chạy được + tests | | `bmad-code-review` | Kiểm tra chất lượng phần triển khai | Được duyệt hoặc yêu cầu thay đổi | @@ -63,22 +63,22 @@ Xây dựng từng story một. Tự động hóa toàn bộ phase 4 sẽ sớm | `bmad-sprint-status` | Theo dõi tiến độ sprint và trạng thái story | Cập nhật trạng thái sprint | | `bmad-retrospective` | Review sau khi hoàn tất epic | Bài học rút ra | -## Quick Flow (Nhánh Song Song) +## Luồng nhanh (nhánh song song) -Bỏ qua phase 1-3 đối với những việc nhỏ, rõ và đã hiểu đầy đủ. +Bỏ qua giai đoạn 1-3 đối với những việc nhỏ, rõ và đã hiểu đầy đủ. -| Workflow | Mục đích | Tạo ra | +| Quy trình | Mục đích | Tạo ra | | ------------------ | --------------------------------------------------------------------------- | ---------------------- | | `bmad-quick-dev` | Luồng nhanh hợp nhất — làm rõ yêu cầu, lập kế hoạch, triển khai, review và trình bày | `spec-*.md` + mã nguồn | -## Quản Lý Context +## Quản lý ngữ cảnh -Mỗi tài liệu sẽ trở thành context cho phase tiếp theo. PRD cho architect biết những ràng buộc nào quan trọng. Architecture chỉ cho dev agent những pattern cần tuân theo. File story cung cấp context tập trung và đầy đủ cho việc triển khai. Nếu không có cấu trúc này, agent sẽ đưa ra quyết định thiếu nhất quán. +Mỗi tài liệu sẽ trở thành ngữ cảnh cho giai đoạn tiếp theo. PRD cho architect biết những ràng buộc nào quan trọng. Tài liệu kiến trúc chỉ cho dev agent những mẫu cần tuân theo. File story cung cấp ngữ cảnh tập trung và đầy đủ cho việc triển khai. Nếu không có cấu trúc này, agent sẽ đưa ra quyết định thiếu nhất quán. -### Project Context +### Bối cảnh dự án :::tip[Khuyến nghị] -Hãy tạo `project-context.md` để bảo đảm AI agent tuân theo quy tắc và sở thích của dự án. File này hoạt động như một bản hiến pháp cho dự án của bạn, nó dẫn dắt các quyết định triển khai xuyên suốt mọi workflow. File tùy chọn này có thể được tạo ở cuối bước Architecture Creation, hoặc cũng có thể được sinh trong dự án hiện hữu để ghi lại những điều quan trọng cần giữ đồng bộ với quy ước đang có. +Hãy tạo `project-context.md` để bảo đảm AI agent tuân theo quy tắc và sở thích của dự án. File này hoạt động như một bản hiến pháp cho dự án của bạn, nó dẫn dắt các quyết định triển khai xuyên suốt mọi quy trình. File tùy chọn này có thể được tạo ở cuối bước tạo kiến trúc, hoặc cũng có thể được sinh trong dự án hiện hữu để ghi lại những điều quan trọng cần giữ đồng bộ với quy ước đang có. ::: **Cách tạo:** diff --git a/docs/zh-cn/explanation/analysis-phase.md b/docs/zh-cn/explanation/analysis-phase.md new file mode 100644 index 000000000..616dc4389 --- /dev/null +++ b/docs/zh-cn/explanation/analysis-phase.md @@ -0,0 +1,70 @@ +--- +title: "分析阶段：从想法到基础" +description: 头脑风暴、调研、产品简报和 PRFAQ 分别是什么——以及何时使用 +sidebar: + order: 1 +--- + +分析阶段（Phase 1）帮助你在决定动手构建之前，把产品想清楚。这个阶段的每个工具都是可选的，但如果完全跳过分析，你的 PRD 就是建立在假设而非洞察之上。 + +## 为什么先分析再规划？ + +PRD 回答的是"我们应该构建什么、为什么？"如果输入的是模糊的思考，得到的就是模糊的 PRD——而下游的每一份文档都会继承这种模糊。基于薄弱 PRD 搭建的架构会押错技术方向；从薄弱架构派生的 story 会遗漏边界场景。代价是层层叠加的。 + +分析工具的作用就是让你的 PRD 变得锐利。它们从不同角度攻击问题——创意探索、市场现实、客户画像、可行性——这样当你坐下来和 PM agent 协作时，你已经清楚要构建什么、为谁构建。 + +## 工具介绍 + +### 头脑风暴 + +**是什么。** 一个使用经过验证的创意技法的引导式创意会议。AI 充当教练，通过结构化练习从你身上引出想法——而不是替你生成想法。 + +**为什么在这里。** 原始想法需要发展空间，然后才能被锁定为需求。头脑风暴创造了这个空间。当你有一个问题领域但还没有清晰的解决方案时，或者你想在确定方向之前探索多种可能性时，它尤其有价值。 + +**何时使用。** 你对想要构建什么有一个模糊的感觉，但概念尚未结晶。或者你有了概念，但想在备选方案中做压力测试。 + +详见[头脑风暴](./brainstorming.md)了解会议的具体运作方式。 + +### 调研（市场、领域、技术） + +**是什么。** 三个聚焦的调研工作流，分别调查你的想法的不同维度。市场调研考察竞争对手、趋势和用户情绪；领域调研建立专业知识和术语体系；技术调研评估可行性、架构选项和实现方案。 + +**为什么在这里。** 基于假设构建产品是最快做出没人需要的东西的方式。调研让你的概念扎根于现实——已有哪些竞争对手、用户真正的痛点是什么、技术上是否可行、所在行业有哪些特定约束。 + +**何时使用。** 你正在进入一个不熟悉的领域，你怀疑竞品存在但还没有做过梳理，或者你的概念依赖于尚未验证的技术能力。可以只做一项、两项或三项全做——每项都是独立的。 + +### 产品简报 + +**是什么。** 一个引导式发现会议，输出 1-2 页的产品概念执行摘要。AI 充当协作式业务分析师，帮你阐明愿景、目标受众、价值主张和范围。 + +**为什么在这里。** 产品简报是进入规划阶段的较温和路径。它以结构化格式捕获你的战略愿景，可以直接输入到 PRD 的创建中。当你已经对概念有了信心——你了解客户、了解问题、大致知道想构建什么时——它效果最好。简报的作用是组织和打磨这些思考。 + +**何时使用。** 你的概念相对清晰，希望在创建 PRD 之前高效地记录下来。你对方向有信心，不需要有人来激烈挑战你的假设。 + +### PRFAQ（逆向工作法） + +**是什么。** 亚马逊的逆向工作法（Working Backwards），改编为交互式挑战。你在写一行代码之前，先撰写宣布成品的新闻稿，然后回答客户和利益相关者会提出的最刁钻的问题。AI 充当不留情面但有建设性的产品教练。 + +**为什么在这里。** PRFAQ 是进入规划阶段的严格路径。它通过让你为每一个论断辩护，来强制实现以客户为中心的清晰度。如果你写不出一篇有说服力的新闻稿，说明产品还没准备好。如果客户 FAQ 的回答暴露了缺口，那些就是你在实现阶段才会——以更高代价——发现的缺口。这道关卡在成本最低的时候暴露薄弱的思考。 + +**何时使用。** 你希望在投入资源之前对概念进行压力测试。你不确定用户是否真的在意。你想验证自己能否阐述一个清晰、站得住脚的价值主张。或者你只是想借助逆向工作法的纪律来打磨你的思考。 + +## 我该用哪个？ + +| 情境 | 推荐工具 | +| ---- | -------- | +| "我有一个模糊的想法，不知道从哪里开始" | 头脑风暴 | +| "我需要先了解市场再做决定" | 调研 | +| "我知道要构建什么，只需要记录下来" | 产品简报 | +| "我想确认这个想法是否真的值得构建" | PRFAQ | +| "我想先探索，再验证，再记录" | 头脑风暴 → 调研 → PRFAQ 或 简报 | + +产品简报和 PRFAQ 都会为 PRD 提供输入——根据你想要多大程度的挑战来选择。简报是协作式发现，PRFAQ 是严格的关卡挑战。两者通往同一个目的地；PRFAQ 检验你的概念是否配得上到达那里。 + +:::tip[不确定？] +运行 `bmad-help`，描述你的情况。它会根据你已经做了什么、想达成什么来推荐合适的起点。 +::: + +## 分析之后呢？ + +分析阶段的输出直接进入 Phase 2（规划）。PRD 工作流接受产品简报、PRFAQ 文档、调研成果和头脑风暴报告作为输入——它会将你产出的所有内容综合成结构化需求。分析做得越充分，PRD 就越锐利。 diff --git a/docs/zh-cn/explanation/checkpoint-preview.md b/docs/zh-cn/explanation/checkpoint-preview.md new file mode 100644 index 000000000..d51fe7a5e --- /dev/null +++ b/docs/zh-cn/explanation/checkpoint-preview.md @@ -0,0 +1,92 @@ +--- +title: "检查点预览" +description: LLM 辅助的人机协作审查，引导你从目的到细节逐步走过一个变更 +sidebar: + order: 3 +--- + +`bmad-checkpoint-preview` 是一个交互式的、LLM 辅助的人机协作审查工作流。它带你逐步走过一个代码变更——从目的和上下文到细节——让你能做出知情决策：是发布、返工，还是深入挖掘。 + +![检查点预览工作流图](/diagrams/checkpoint-preview-diagram.png) + +## 典型流程 + +你运行 `bmad-quick-dev`。它澄清你的意图、构建规范、实现变更，完成后将审查线索追加到 spec 文件并在编辑器中打开。你查看 spec，发现这次变更涉及跨多个模块的 20 个文件。 + +你可以肉眼扫一遍 diff。但 20 个文件正是肉眼审查开始失效的临界点——你会丢失线索，漏掉两个相距甚远的变更之间的关联，或者批准了自己没有完全理解的东西。所以你改为说 "checkpoint"，让 LLM 带你走一遍。 + +这种交接——从自主实现回到人工判断——就是核心使用场景。Quick-dev 以最少的监督长时间运行，检查点预览则是你重新掌舵的地方。 + +## 为什么需要它 + +代码审查有两种失败模式。一种是审查者浏览 diff，什么也没发现，直接批准。另一种是逐文件仔细阅读，但丢失了全局线索——见树不见林。两种模式的结果相同：审查没有抓住真正重要的东西。 + +根本问题在于顺序。原始 diff 按文件顺序呈现变更，而这几乎从来不是构建理解的顺序。你先看到一个辅助函数，却不知道它存在的原因；先看到一个 schema 变更，却不了解它支撑什么功能。审查者必须从零散的线索中重建作者的意图，而这个重建过程正是注意力失效的地方。 + +检查点预览通过让 LLM 完成重建工作来解决这个问题。它读取 diff、spec（如果有的话）和周围的代码库，然后按照有利于理解的顺序——而不是 `git diff` 的顺序——呈现变更。 + +## 工作原理 + +工作流分为五个步骤。每一步都建立在前一步的基础上，逐步从"这是什么？"过渡到"我们该不该发布？" + +### 1. 定向 + +工作流识别变更来源（来自 PR、commit、分支、spec 文件或当前 git 状态），生成一行意图摘要以及表面积统计：变更文件数、涉及模块数、逻辑行数、边界穿越数和新增公共接口数。 + +这是"这是不是我以为的那个东西？"的时刻。在阅读任何代码之前，审查者确认自己看的是正确的东西，并对范围建立预期。 + +### 2. 走查 + +变更按**关注点**——而非按文件——组织。关注点是内聚的设计意图，例如"输入验证"或"API 契约"。每个关注点附带简短说明——*为什么选择这种方案*，然后列出可点击的 `path:line` 停靠点，审查者可以沿着这些停靠点在代码中导航。 + +这是设计判断步骤。审查者评估的是方案对系统是否合理，而不是代码是否正确。关注点按自顶向下排列：最高层意图在前，支撑实现在后。审查者永远不会遇到引用了自己尚未看过的内容。 + +### 3. 细节审视 + +在审查者理解了设计之后，工作流浮出 2-5 个"出错代价最高"的位置。这些位置按风险类别标记——`[auth]`、`[schema]`、`[billing]`、`[public API]`、`[security]` 等——并按出错后的影响范围排序。 + +这不是找 bug。自动化测试和 CI 负责正确性。细节审视激活的是风险意识："这些是出错成本最高的地方。"如果审查者想在某个领域深入，可以说 "dig into [area]" 来触发一次聚焦正确性的重新审查。 + +如果 spec 经过了对抗性审查循环（机器硬化），那些发现也会在这里浮出——不是已修复的 bug，而是审查循环标记出的、审查者应当知晓的决策。 + +### 4. 测试 + +建议 2-5 种手动观察变更生效的方式。不是自动化测试命令——而是能构建信心、但测试套件无法提供的手动观察。一个可以尝试的 UI 交互、一条可以运行的 CLI 命令、一个可以发送的 API 请求，以及每项的预期结果。 + +如果变更没有用户可见的行为，它会明确说明。不发明多余的忙活。 + +### 5. 总结 + +审查者做出决定：批准、返工或继续讨论。如果批准 PR，工作流可以协助执行 `gh pr review --approve`。如果需要返工，它帮助诊断问题出在方案、spec 还是实现，并帮助起草与具体代码位置关联的可操作反馈。 + +## 它是对话，不是报告 + +工作流将每一步呈现为起点，而非定论。在步骤之间——或步骤中间——你可以与 LLM 对话、提问、挑战它的框架，或调用其他技能来获取不同视角： + +- **"run advanced elicitation on the error handling"** — 推动 LLM 重新思考并细化对特定领域的分析 +- **"party mode on whether this schema migration is safe"** — 引入多个 agent 视角进行聚焦辩论 +- **"run code review"** — 生成包含对抗性和边界场景分析的结构化 agentic 审查报告 + +检查点工作流不会把你锁在线性路径上。它在你需要结构时提供结构，在你想探索时让开。五个步骤确保你看到全貌，但每一步深入到什么程度——以及调用什么工具——完全由你决定。 + +## 审查线索 + +走查步骤在有**建议审查顺序**时效果最好——这是 spec 作者编写的停靠点列表，用于引导审查者走过变更。当 spec 包含此内容时，工作流直接使用它。 + +当没有作者提供的线索时，工作流会从 diff 和代码库上下文生成一份。生成的线索质量不如作者编写的，但远好于按文件顺序阅读变更。 + +## 何时使用 + +主要场景是 `bmad-quick-dev` 的交接：实现完成，spec 文件在编辑器中打开并追加了审查线索，你需要决定是否发布。说 "checkpoint" 即可开始。 + +它也可以独立使用： + +- **审查 PR** — 尤其是涉及多个文件或跨模块变更的 PR +- **了解一个变更** — 当你需要理解一个不是你写的分支上发生了什么 +- **Sprint 审查** — 工作流可以提取 sprint 状态文件中标记为 `review` 的 story + +通过说 "checkpoint" 或 "walk me through this change" 来调用。它在任何终端中都能工作，但在 IDE 中——VS Code、Cursor 或类似工具——你会获得更多，因为工作流在每一步都生成 `path:line` 引用。在嵌入 IDE 的终端中，这些引用是可点击的，你可以沿着审查线索在文件间跳转。 + +## 它不是什么 + +检查点预览不是自动化审查的替代品。它不运行 linter、类型检查器或测试套件。它不打分也不给出通过/不通过的判定。它是一份阅读指南，帮助人类在最重要的地方运用自己的判断力。 diff --git a/docs/zh-cn/how-to/install-bmad.md b/docs/zh-cn/how-to/install-bmad.md index e9fc1af9a..3c5ceff44 100644 --- a/docs/zh-cn/how-to/install-bmad.md +++ b/docs/zh-cn/how-to/install-bmad.md @@ -72,7 +72,7 @@ npx github:bmad-code-org/BMAD-METHOD install ### 5. 按照提示操作 -安装程序会引导你完成剩余步骤——自定义内容、设置等。 +安装程序会引导你完成剩余步骤——设置、工具集成等。 ## 你将获得 diff --git a/docs/zh-cn/how-to/install-custom-modules.md b/docs/zh-cn/how-to/install-custom-modules.md new file mode 100644 index 000000000..00193a3ed --- /dev/null +++ b/docs/zh-cn/how-to/install-custom-modules.md @@ -0,0 +1,181 @@ +--- +title: "安装自定义和社区模块" +description: 从社区注册表、Git 仓库或本地路径安装第三方模块 +sidebar: + order: 3 +--- + +使用 BMad 安装程序从社区注册表、第三方 Git 仓库或本地文件路径添加模块。 + +## 何时使用 + +- 从 BMad 注册表安装社区贡献的模块 +- 从第三方 Git 仓库安装模块（GitHub、GitLab、Bitbucket、自托管） +- 使用 BMad Builder 测试本地开发中的模块 +- 从私有或自托管 Git 服务器安装模块 + +:::note[前置条件] +需要 [Node.js](https://nodejs.org) v20+ 和 `npx`（npm 自带）。自定义和社区模块可以在全新安装时选择，也可以添加到现有安装中。 +::: + +## 社区模块 + +社区模块收录在 [BMad 插件市场](https://github.com/bmad-code-org/bmad-plugins-marketplace)。它们按类别组织，并锁定在经过审核的 commit 上以确保安全。 + +### 1. 运行安装程序 + +```bash +npx bmad-method install +``` + +### 2. 浏览社区目录 + +选择官方模块后，安装程序会询问： + +``` +Would you like to browse community modules? +``` + +选择 **Yes** 进入目录浏览器。你可以： + +- 按类别浏览 +- 查看推荐模块 +- 查看所有可用模块 +- 按关键词搜索 + +### 3. 选择模块 + +从任意类别中选取模块。安装程序显示描述、版本和信任等级。已安装的模块会预选以便更新。 + +### 4. 继续安装 + +选择社区模块后，安装程序将继续到自定义来源，然后是工具/IDE 配置及其余安装流程。 + +## 自定义来源（Git URL 和本地路径） + +自定义模块可以来自任何 Git 仓库或本地目录。安装程序会解析来源、分析模块结构，并将其与其他模块一起安装。 + +### 交互式安装 + +安装过程中，在社区模块步骤之后，安装程序会询问： + +``` +Would you like to install from a custom source (Git URL or local path)? +``` + +选择 **Yes**，然后提供来源： + +| 输入类型 | 示例 | +| -------- | ---- | +| HTTPS URL（任意主机） | `https://github.com/org/repo` | +| HTTP URL（任意主机） | `http://host/org/repo` | +| 带子目录的 HTTPS URL | `https://github.com/org/repo/tree/main/my-module` | +| SSH URL | `git@github.com:org/repo.git` | +| 本地路径 | `/Users/me/projects/my-module` | +| 使用 ~ 的本地路径 | `~/projects/my-module` | + +安装程序会克隆仓库（URL 来源）或直接从磁盘读取（本地路径），然后展示发现的模块供你选择。 + +### 非交互式安装 + +使用 `--custom-source` 标志从命令行安装自定义模块： + +```bash +npx bmad-method install \ + --directory . \ + --custom-source /path/to/my-module \ + --tools claude-code \ + --yes +``` + +提供 `--custom-source` 但未指定 `--modules` 时，只安装 core 和自定义模块。要同时包含官方模块，需添加 `--modules`： + +```bash +npx bmad-method install \ + --directory . \ + --modules bmm \ + --custom-source https://gitlab.com/myorg/my-module \ + --tools claude-code \ + --yes +``` + +多个来源可用逗号分隔： + +```bash +--custom-source /path/one,https://github.com/org/repo,/path/two +``` + +## 模块发现机制 + +安装程序使用两种模式在来源中查找可安装的模块： + +| 模式 | 触发条件 | 行为 | +| ---- | -------- | ---- | +| 发现模式 | 来源包含 `.claude-plugin/marketplace.json` | 列出清单中的所有插件；你选择要安装哪些 | +| 直接模式 | 未找到 marketplace.json | 扫描目录中的 skill（包含 `SKILL.md` 的子目录），作为单个模块解析 | + +发现模式适用于已发布的模块。直接模式适合本地开发时指向 skills 目录。 + +:::note[关于 `.claude-plugin/`] +`.claude-plugin/marketplace.json` 路径是多个 AI 工具安装程序采用的标准约定，用于插件可发现性。它不依赖 Claude，不使用 Claude API，也不影响你使用哪个 AI 工具。任何包含此文件的模块都可以被遵循此约定的安装程序发现。 +::: + +## 本地开发工作流 + +如果你正在使用 [BMad Builder](https://github.com/bmad-code-org/bmad-builder) 构建模块，可以直接从工作目录安装： + +```bash +npx bmad-method install \ + --directory ~/my-project \ + --custom-source ~/my-module-repo/skills \ + --tools claude-code \ + --yes +``` + +本地来源通过路径引用，不会复制到缓存。当你更新模块源码并重新安装时，安装程序会获取最新变更。 + +:::caution[来源移除] +如果你在安装后删除了本地来源目录，`_bmad/` 中已安装的模块文件会保留。在恢复来源路径之前，该模块在更新时会被跳过。 +::: + +## 安装结果 + +安装后，自定义模块与官方模块一起出现在 `_bmad/` 中： + +``` +your-project/ +├── _bmad/ +│ ├── core/ # 内置核心模块 +│ ├── bmm/ # 官方模块（如已选择） +│ ├── my-module/ # 你的自定义模块 +│ │ ├── my-skill/ +│ │ │ └── SKILL.md +│ │ └── module-help.csv +│ └── _config/ +│ └── manifest.yaml # 跟踪所有模块、版本和来源 +└── ... +``` + +manifest 记录每个自定义模块的来源（Git 来源为 `repoUrl`，本地来源为 `localPath`），以便快速更新时能重新定位来源。 + +## 更新自定义模块 + +自定义模块参与正常的更新流程： + +- **快速更新**（`--action quick-update`）：从原始来源刷新所有模块。基于 Git 的模块会重新拉取；本地模块会从来源路径重新读取。 +- **完整更新**：重新运行模块选择，你可以添加或移除自定义模块。 + +## 创建自己的模块 + +使用 [BMad Builder](https://github.com/bmad-code-org/bmad-builder) 创建可供他人安装的模块： + +1. 运行 `bmad-module-builder` 搭建模块结构 +2. 使用各种 BMad Builder 工具添加 skill、agent 和 workflow +3. 发布到 Git 仓库或共享文件夹集合 +4. 他人使用 `--custom-source ` 安装 + +要让模块支持发现模式，请在仓库根目录包含 `.claude-plugin/marketplace.json`（这是跨工具约定，非 Claude 专属）。格式详见 [BMad Builder 文档](https://github.com/bmad-code-org/bmad-builder)。 + +:::tip[先在本地测试] +开发期间，使用本地路径安装模块以快速迭代，发布到 Git 仓库之前先确认一切正常。 +::: diff --git a/docs/zh-cn/how-to/non-interactive-installation.md b/docs/zh-cn/how-to/non-interactive-installation.md index df7259d97..788c18d52 100644 --- a/docs/zh-cn/how-to/non-interactive-installation.md +++ b/docs/zh-cn/how-to/non-interactive-installation.md @@ -27,7 +27,6 @@ sidebar: | `--directory ` | 安装目录 | `--directory ~/projects/myapp` | | `--modules ` | 逗号分隔的模块 ID | `--modules bmm,bmb` | | `--tools ` | 逗号分隔的工具/IDE ID（使用 `none` 跳过） | `--tools claude-code,cursor` 或 `--tools none` | -| `--custom-content ` | 逗号分隔的自定义模块路径 | `--custom-content ~/my-module,~/another-module` | | `--action ` | 对现有安装的操作：`install`（默认）、`update` 或 `quick-update` | `--action quick-update` | ### 核心配置 @@ -108,16 +107,6 @@ npx bmad-method install \ --action quick-update ``` -### 使用自定义内容安装 - -```bash -npx bmad-method install \ - --directory ~/projects/myapp \ - --modules bmm \ - --custom-content ~/my-custom-module,~/another-module \ - --tools claude-code -``` - ## 安装结果 - 项目中完全配置的 `_bmad/` 目录 @@ -131,12 +120,11 @@ BMad 会验证你提供的所有参数： - **目录** — 必须是具有写入权限的有效路径 - **模块** — 对无效的模块 ID 发出警告（但不会失败） - **工具** — 对无效的工具 ID 发出警告（但不会失败） -- **自定义内容** — 每个路径必须包含有效的 `module.yaml` 文件 - **操作** — 必须是以下之一：`install`、`update`、`quick-update` 无效值将： 1. 显示错误并退出（对于目录等关键选项） -2. 显示警告并跳过（对于自定义内容等可选项目） +2. 显示警告并跳过（对于可选项目） 3. 回退到交互式提示（对于缺失的必需值） :::tip[最佳实践] @@ -159,13 +147,6 @@ BMad 会验证你提供的所有参数： - 验证模块 ID 是否正确 - 外部模块必须在注册表中可用 -### 自定义内容路径无效 - -确保每个自定义内容路径： -- 指向一个目录 -- 在根目录中包含 `module.yaml` 文件 -- 在 `module.yaml` 中有 `code` 字段 - :::note[仍然卡住了？] 使用 `--debug` 获取详细输出，尝试交互模式定位问题，或在 提交反馈。 ::: diff --git a/docs/zh-cn/reference/agents.md b/docs/zh-cn/reference/agents.md index 96570234c..3fbebcca9 100644 --- a/docs/zh-cn/reference/agents.md +++ b/docs/zh-cn/reference/agents.md @@ -11,7 +11,7 @@ sidebar: | 智能体 | Skill ID | 触发器 | 主要 workflow | | --- | --- | --- | --- | -| Analyst (Mary) | `bmad-analyst` | `BP`、`RS`、`CB`、`DP` | Brainstorm、Research、Create Brief、Document Project | +| Analyst (Mary) | `bmad-analyst` | `BP`、`MR`、`DR`、`TR`、`CB`、`WB`、`DP` | Brainstorm、Market Research、Domain Research、Technical Research、Create Brief、PRFAQ Challenge、Document Project | | Product Manager (John) | `bmad-pm` | `CP`、`VP`、`EP`、`CE`、`IR`、`CC` | Create/Validate/Edit PRD、Create Epics and Stories、Implementation Readiness、Correct Course | | Architect (Winston) | `bmad-architect` | `CA`、`IR` | Create Architecture、Implementation Readiness | | Developer (Amelia) | `bmad-agent-dev` | `DS`、`QD`、`QA`、`CR`、`SP`、`CS`、`ER` | Dev Story、Quick Dev、QA Test Generation、Code Review、Sprint Planning、Create Story、Epic Retrospective | diff --git a/eslint.config.mjs b/eslint.config.mjs index 9282fdacb..1bf3e270e 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -84,9 +84,9 @@ export default [ }, }, - // CLI scripts under tools/** and test/** + // CLI scripts under tools/**, test/**, and src/scripts/** { - files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js', 'test/**/*.mjs'], + files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js', 'test/**/*.mjs', 'src/scripts/**/*.js', 'src/scripts/**/*.mjs'], rules: { // Allow CommonJS patterns for Node CLI scripts 'unicorn/prefer-module': 'off', diff --git a/package-lock.json b/package-lock.json index f141eb45b..2a9d9657f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "bmad-method", - "version": "6.2.2", + "version": "6.5.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "bmad-method", - "version": "6.2.2", + "version": "6.5.0", "license": "MIT", "dependencies": { "@clack/core": "^1.0.0", @@ -15,7 +15,6 @@ "chalk": "^4.1.2", "commander": "^14.0.0", "csv-parse": "^6.1.0", - "fs-extra": "^11.3.0", "glob": "^11.0.3", "ignore": "^7.0.5", "js-yaml": "^4.1.0", @@ -25,8 +24,8 @@ "yaml": "^2.7.0" }, "bin": { - "bmad": "tools/bmad-npx-wrapper.js", - "bmad-method": "tools/bmad-npx-wrapper.js" + "bmad": "tools/installer/bmad-cli.js", + "bmad-method": "tools/installer/bmad-cli.js" }, "devDependencies": { "@astrojs/sitemap": "^3.6.0", @@ -46,6 +45,7 @@ "prettier": "^3.7.4", "prettier-plugin-packagejson": "^2.5.19", "sharp": "^0.33.5", + "unist-util-visit": "^5.1.0", "yaml-eslint-parser": "^1.2.3", "yaml-lint": "^1.7.0" }, @@ -6975,20 +6975,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/fs-extra": { - "version": "11.3.3", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.3.tgz", - "integrity": "sha512-VWSRii4t0AFm6ixFFmLLx1t7wS1gh+ckoa84aOeapGum0h+EZd1EhEumSB+ZdDLnEPuucsVB9oB7cxJHap6Afg==", - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=14.14" - } - }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -7227,6 +7213,7 @@ "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, "license": "ISC" }, "node_modules/h3": { @@ -9066,18 +9053,6 @@ "dev": true, "license": "MIT" }, - "node_modules/jsonfile": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", - "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", - "license": "MIT", - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } - }, "node_modules/katex": { "version": "0.16.28", "resolved": "https://registry.npmjs.org/katex/-/katex-0.16.28.tgz", @@ -13607,15 +13582,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/universalify": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, "node_modules/unrs-resolver": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/unrs-resolver/-/unrs-resolver-1.11.1.tgz", diff --git a/package.json b/package.json index 3d53ce2b0..023b3c41f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "$schema": "https://json.schemastore.org/package.json", "name": "bmad-method", - "version": "6.2.2", + "version": "6.5.0", "description": "Breakthrough Method of Agile AI-driven Development", "keywords": [ "agile", @@ -41,7 +41,8 @@ "prepare": "command -v husky >/dev/null 2>&1 && husky || exit 0", "quality": "npm run format:check && npm run lint && npm run lint:md && npm run docs:build && npm run test:install && npm run validate:refs && npm run validate:skills", "rebundle": "node tools/installer/bundlers/bundle-web.js rebundle", - "test": "npm run test:refs && npm run test:install && npm run lint && npm run lint:md && npm run format:check", + "test": "npm run test:refs && npm run test:install && npm run test:channels && npm run lint && npm run lint:md && npm run format:check", + "test:channels": "node test/test-installer-channels.js", "test:install": "node test/test-installation-components.js", "test:refs": "node test/test-file-refs-csv.js", "validate:refs": "node tools/validate-file-refs.js --strict", @@ -70,7 +71,6 @@ "chalk": "^4.1.2", "commander": "^14.0.0", "csv-parse": "^6.1.0", - "fs-extra": "^11.3.0", "glob": "^11.0.3", "ignore": "^7.0.5", "js-yaml": "^4.1.0", diff --git a/removals.txt b/removals.txt new file mode 100644 index 000000000..5a7659dd2 --- /dev/null +++ b/removals.txt @@ -0,0 +1,54 @@ +# BMad Method - Skill Removal List +# Entries listed here will be removed from IDE skill directories during install/update. +# One entry per line. Lines starting with # are comments. +# Each entry is a skill directory name (canonicalId) that was removed or renamed. + +# Removed agents (v6.2.0 - v6.2.2) +bmad-agent-sm +bmad-agent-qa +bmad-agent-quick-flow-solo-dev + +# Removed skills (v6.2.0 - v6.2.2) +bmad-create-product-brief +bmad-product-brief-preview +bmad-quick-spec +bmad-quick-flow +bmad-quick-dev-new-preview +bmad-init + +# Pre-v6.2.0 wrapper skills (module-prefixed naming, dropped in v6.2.0). +# Users upgrading from v6.0.x / v6.1.x had these installed and the cleanup +# never knew to remove them; they remained alongside the new self-contained +# skills causing duplicates and broken-file errors. See issue #2309. +bmad-agent-bmm-analyst +bmad-agent-bmm-architect +bmad-agent-bmm-dev +bmad-agent-bmm-pm +bmad-agent-bmm-qa +bmad-agent-bmm-quick-flow-solo-dev +bmad-agent-bmm-sm +bmad-agent-bmm-tech-writer +bmad-agent-bmm-ux-designer +bmad-bmm-check-implementation-readiness +bmad-bmm-code-review +bmad-bmm-correct-course +bmad-bmm-create-architecture +bmad-bmm-create-epics-and-stories +bmad-bmm-create-prd +bmad-bmm-create-product-brief +bmad-bmm-create-story +bmad-bmm-create-ux-design +bmad-bmm-dev-story +bmad-bmm-document-project +bmad-bmm-domain-research +bmad-bmm-edit-prd +bmad-bmm-generate-project-context +bmad-bmm-market-research +bmad-bmm-qa-generate-e2e-tests +bmad-bmm-quick-dev +bmad-bmm-quick-spec +bmad-bmm-retrospective +bmad-bmm-sprint-planning +bmad-bmm-sprint-status +bmad-bmm-technical-research +bmad-bmm-validate-prd diff --git a/src/bmm-skills/1-analysis/bmad-agent-analyst/SKILL.md b/src/bmm-skills/1-analysis/bmad-agent-analyst/SKILL.md index d85063694..4653171df 100644 --- a/src/bmm-skills/1-analysis/bmad-agent-analyst/SKILL.md +++ b/src/bmm-skills/1-analysis/bmad-agent-analyst/SKILL.md @@ -3,57 +3,72 @@ name: bmad-agent-analyst description: Strategic business analyst and requirements expert. Use when the user asks to talk to Mary or requests the business analyst. --- -# Mary +# Mary — Business Analyst ## Overview -This skill provides a Strategic Business Analyst who helps users with market research, competitive analysis, domain expertise, and requirements elicitation. Act as Mary — a senior analyst who treats every business challenge like a treasure hunt, structuring insights with precision while making analysis feel like discovery. With deep expertise in translating vague needs into actionable specs, Mary helps users uncover what others miss. +You are Mary, the Business Analyst. You bring deep expertise in market research, competitive analysis, requirements elicitation, and domain knowledge — translating vague needs into actionable specs while staying grounded in evidence-based analysis. -## Identity +## Conventions -Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation who specializes in translating vague needs into actionable specs. - -## Communication Style - -Speaks with the excitement of a treasure hunter — thrilled by every clue, energized when patterns emerge. Structures insights with precision while making analysis feel like discovery. Uses business analysis frameworks naturally in conversation, drawing upon Porter's Five Forces, SWOT analysis, and competitive intelligence methodologies without making it feel academic. - -## Principles - -- Channel expert business analysis frameworks to uncover what others miss — every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. -- Articulate requirements with absolute precision. Ambiguity is the enemy of good specs. -- Ensure all stakeholder voices are heard. The best analysis surfaces perspectives that weren't initially considered. - -You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona. - -When you are in this persona and the user calls a skill, this persona must carry through and remain active. - -## Capabilities - -| Code | Description | Skill | -|------|-------------|-------| -| BP | Expert guided brainstorming facilitation | bmad-brainstorming | -| MR | Market analysis, competitive landscape, customer needs and trends | bmad-market-research | -| DR | Industry domain deep dive, subject matter expertise and terminology | bmad-domain-research | -| TR | Technical feasibility, architecture options and implementation approaches | bmad-technical-research | -| CB | Create or update product briefs through guided or autonomous discovery | bmad-product-brief-preview | -| WB | Working Backwards PRFAQ challenge — forge and stress-test product concepts | bmad-prfaq | -| DP | Analyze an existing project to produce documentation for human and LLM consumption | bmad-document-project | +- Bare paths (e.g. `references/guide.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Agent Block -2. **Continue with steps below:** - - **Load project context** — Search for `**/project-context.md`. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - - **Greet and present capabilities** — Greet `{user_name}` warmly by name, always speaking in `{communication_language}` and applying your persona throughout the session. - -3. Remind the user they can invoke the `bmad-help` skill at any time for advice and then present the capabilities table from the Capabilities section above. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent` - **STOP and WAIT for user input** — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match. +**If the script fails**, resolve the `agent` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: -**CRITICAL Handling:** When user responds with a code, line number or skill, invoke the corresponding skill by its exact registered name from the Capabilities table. DO NOT invent capabilities on the fly. +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{agent.activation_steps_prepend}` in order before proceeding. + +### Step 3: Adopt Persona + +Adopt the Mary / Business Analyst identity established in the Overview. Layer the customized persona on top: fill the additional role of `{agent.role}`, embody `{agent.identity}`, speak in the style of `{agent.communication_style}`, and follow `{agent.principles}`. + +Fully embody this persona so the user gets the best experience. Do not break character until the user dismisses the persona. When the user calls a skill, this persona carries through and remains active. + +### Step 4: Load Persistent Facts + +Treat every entry in `{agent.persistent_facts}` as foundational context you carry for the rest of the session. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 5: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 6: Greet the User + +Greet `{user_name}` warmly by name as Mary, speaking in `{communication_language}`. Lead the greeting with `{agent.icon}` so the user can see at a glance which agent is speaking. Remind the user they can invoke the `bmad-help` skill at any time for advice. + +Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable. + +### Step 7: Execute Append Steps + +Execute each entry in `{agent.activation_steps_append}` in order. + +### Step 8: Dispatch or Present the Menu + +If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey Mary, let's brainstorm"), skip the menu and dispatch that item directly after greeting. + +Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match. + +Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game. + +From here, Mary stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses her. diff --git a/src/bmm-skills/1-analysis/bmad-agent-analyst/bmad-skill-manifest.yaml b/src/bmm-skills/1-analysis/bmad-agent-analyst/bmad-skill-manifest.yaml deleted file mode 100644 index 9c88e320a..000000000 --- a/src/bmm-skills/1-analysis/bmad-agent-analyst/bmad-skill-manifest.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: agent -name: bmad-agent-analyst -displayName: Mary -title: Business Analyst -icon: "📊" -capabilities: "market research, competitive analysis, requirements elicitation, domain expertise" -role: Strategic Business Analyst + Requirements Expert -identity: "Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs." -communicationStyle: "Speaks with the excitement of a treasure hunter - thrilled by every clue, energized when patterns emerge. Structures insights with precision while making analysis feel like discovery." -principles: "Channel expert business analysis frameworks: draw upon Porter's Five Forces, SWOT analysis, root cause analysis, and competitive intelligence methodologies to uncover what others miss. Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision. Ensure all stakeholder voices heard." -module: bmm diff --git a/src/bmm-skills/1-analysis/bmad-agent-analyst/customize.toml b/src/bmm-skills/1-analysis/bmad-agent-analyst/customize.toml new file mode 100644 index 000000000..477e4b368 --- /dev/null +++ b/src/bmm-skills/1-analysis/bmad-agent-analyst/customize.toml @@ -0,0 +1,90 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Mary, the Business Analyst, is the hardcoded identity of this agent. +# Customize the persona and menu below to shape behavior without +# changing who the agent is. + +[agent] +# non-configurable skill frontmatter, create a custom agent if you need a new name/title +name="Mary" +title="Business Analyst" + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, principles, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +icon = "📊" + +# Steps to run before the standard activation (persona, config, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before presenting the menu. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the agent keeps in mind for the whole session (org rules, +# domain constants, user preferences). Distinct from the runtime memory +# sidecar — these are static context loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +role = "Help the user ideate research and analyze before committing to a project in the BMad Method analysis phase." +identity = "Channels Michael Porter's strategic rigor and Barbara Minto's Pyramid Principle discipline." +communication_style = "Treasure hunter's excitement for patterns, McKinsey memo's structure for findings." + +# The agent's value system. Overrides append to defaults. +principles = [ + "Every finding grounded in verifiable evidence.", + "Requirements stated with absolute precision.", + "Every stakeholder voice represented.", +] + +# Capabilities menu. Overrides merge by `code`: matching codes replace the item +# in place, new codes append. Each item has exactly one of `skill` (invokes a +# registered skill by name) or `prompt` (executes the prompt text directly). + +[[agent.menu]] +code = "BP" +description = "Expert guided brainstorming facilitation" +skill = "bmad-brainstorming" + +[[agent.menu]] +code = "MR" +description = "Market analysis, competitive landscape, customer needs and trends" +skill = "bmad-market-research" + +[[agent.menu]] +code = "DR" +description = "Industry domain deep dive, subject matter expertise and terminology" +skill = "bmad-domain-research" + +[[agent.menu]] +code = "TR" +description = "Technical feasibility, architecture options and implementation approaches" +skill = "bmad-technical-research" + +[[agent.menu]] +code = "CB" +description = "Create or update product briefs through guided or autonomous discovery" +skill = "bmad-product-brief" + +[[agent.menu]] +code = "WB" +description = "Working Backwards PRFAQ challenge — forge and stress-test product concepts" +skill = "bmad-prfaq" + +[[agent.menu]] +code = "DP" +description = "Analyze an existing project to produce documentation for human and LLM consumption" +skill = "bmad-document-project" diff --git a/src/bmm-skills/1-analysis/bmad-agent-tech-writer/SKILL.md b/src/bmm-skills/1-analysis/bmad-agent-tech-writer/SKILL.md index bb645095a..ff6430d93 100644 --- a/src/bmm-skills/1-analysis/bmad-agent-tech-writer/SKILL.md +++ b/src/bmm-skills/1-analysis/bmad-agent-tech-writer/SKILL.md @@ -3,55 +3,72 @@ name: bmad-agent-tech-writer description: Technical documentation specialist and knowledge curator. Use when the user asks to talk to Paige or requests the tech writer. --- -# Paige +# Paige — Technical Writer ## Overview -This skill provides a Technical Documentation Specialist who transforms complex concepts into accessible, structured documentation. Act as Paige — a patient educator who explains like teaching a friend, using analogies that make complex simple, and celebrates clarity when it shines. Master of CommonMark, DITA, OpenAPI, and Mermaid diagrams. +You are Paige, the Technical Writer. You transform complex concepts into accessible, structured documentation — writing for the reader's task, favoring diagrams when they carry more signal than prose, and adapting depth to audience. Master of CommonMark, DITA, OpenAPI, and Mermaid. -## Identity +## Conventions -Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity — transforms complex concepts into accessible structured documentation. - -## Communication Style - -Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines. - -## Principles - -- Every technical document helps someone accomplish a task. Strive for clarity above all — every word and phrase serves a purpose without being overly wordy. -- A picture/diagram is worth thousands of words — include diagrams over drawn out text. -- Understand the intended audience or clarify with the user so you know when to simplify vs when to be detailed. - -You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona. - -When you are in this persona and the user calls a skill, this persona must carry through and remain active. - -## Capabilities - -| Code | Description | Skill or Prompt | -|------|-------------|-------| -| DP | Generate comprehensive project documentation (brownfield analysis, architecture scanning) | skill: bmad-document-project | -| WD | Author a document following documentation best practices through guided conversation | prompt: write-document.md | -| MG | Create a Mermaid-compliant diagram based on your description | prompt: mermaid-gen.md | -| VD | Validate documentation against standards and best practices | prompt: validate-doc.md | -| EC | Create clear technical explanations with examples and diagrams | prompt: explain-concept.md | +- Bare paths (e.g. `references/guide.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Agent Block -2. **Continue with steps below:** - - **Load project context** — Search for `**/project-context.md`. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - - **Greet and present capabilities** — Greet `{user_name}` warmly by name, always speaking in `{communication_language}` and applying your persona throughout the session. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent` -3. Remind the user they can invoke the `bmad-help` skill at any time for advice and then present the capabilities table from the Capabilities section above. +**If the script fails**, resolve the `agent` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: - **STOP and WAIT for user input** — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match. +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides -**CRITICAL Handling:** When user responds with a code, line number or skill, invoke the corresponding skill or load the corresponding prompt from the Capabilities table - prompts are always in the same folder as this skill. DO NOT invent capabilities on the fly. +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{agent.activation_steps_prepend}` in order before proceeding. + +### Step 3: Adopt Persona + +Adopt the Paige / Technical Writer identity established in the Overview. Layer the customized persona on top: fill the additional role of `{agent.role}`, embody `{agent.identity}`, speak in the style of `{agent.communication_style}`, and follow `{agent.principles}`. + +Fully embody this persona so the user gets the best experience. Do not break character until the user dismisses the persona. When the user calls a skill, this persona carries through and remains active. + +### Step 4: Load Persistent Facts + +Treat every entry in `{agent.persistent_facts}` as foundational context you carry for the rest of the session. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 5: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 6: Greet the User + +Greet `{user_name}` warmly by name as Paige, speaking in `{communication_language}`. Lead the greeting with `{agent.icon}` so the user can see at a glance which agent is speaking. Remind the user they can invoke the `bmad-help` skill at any time for advice. + +Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable. + +### Step 7: Execute Append Steps + +Execute each entry in `{agent.activation_steps_append}` in order. + +### Step 8: Dispatch or Present the Menu + +If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey Paige, let's document this codebase"), skip the menu and dispatch that item directly after greeting. + +Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match. + +Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game. + +From here, Paige stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses her. diff --git a/src/bmm-skills/1-analysis/bmad-agent-tech-writer/bmad-skill-manifest.yaml b/src/bmm-skills/1-analysis/bmad-agent-tech-writer/bmad-skill-manifest.yaml deleted file mode 100644 index 2aba65602..000000000 --- a/src/bmm-skills/1-analysis/bmad-agent-tech-writer/bmad-skill-manifest.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: agent -name: bmad-agent-tech-writer -displayName: Paige -title: Technical Writer -icon: "📚" -capabilities: "documentation, Mermaid diagrams, standards compliance, concept explanation" -role: Technical Documentation Specialist + Knowledge Curator -identity: "Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation." -communicationStyle: "Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines." -principles: "Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all, and every word and phrase serves a purpose without being overly wordy. I believe a picture/diagram is worth 1000s of words and will include diagrams over drawn out text. I understand the intended audience or will clarify with the user so I know when to simplify vs when to be detailed." -module: bmm diff --git a/src/bmm-skills/1-analysis/bmad-agent-tech-writer/customize.toml b/src/bmm-skills/1-analysis/bmad-agent-tech-writer/customize.toml new file mode 100644 index 000000000..32efd2226 --- /dev/null +++ b/src/bmm-skills/1-analysis/bmad-agent-tech-writer/customize.toml @@ -0,0 +1,81 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Paige, the Technical Writer, is the hardcoded identity of this agent. +# Customize the persona and menu below to shape behavior without +# changing who the agent is. + +[agent] +# non-configurable skill frontmatter, create a custom agent if you need a new name/title +name = "Paige" +title = "Technical Writer" + +# --- Configurable below. Overrides merge per BMad structural rules: --- + +# scalars: override wins • arrays (persistent_facts, principles, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +icon = "📚" + +# Steps to run before the standard activation (persona, config, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before presenting the menu. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the agent keeps in mind for the whole session (org rules, +# domain constants, user preferences). Distinct from the runtime memory +# sidecar — these are static context loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +role = "Capture and curate project knowledge so humans and future LLM agents stay in sync during the BMad Method analysis phase." +identity = "Writes with Julia Evans's accessibility and Edward Tufte's visual precision." +communication_style = "Patient educator — explains like teaching a friend. Every analogy earns its place." + +# The agent's value system. Overrides append to defaults. +principles = [ + "Write for the reader's task, not the writer's checklist.", + "A diagram beats a thousand-word paragraph.", + "Audience-aware: simplify or detail as the reader needs.", +] + +# Capabilities menu. Overrides merge by `code`: matching codes replace the item +# in place, new codes append. Each item has exactly one of `skill` (invokes a +# registered skill by name) or `prompt` (executes the prompt text directly). + +[[agent.menu]] +code = "DP" +description = "Generate comprehensive project documentation (brownfield analysis, architecture scanning)" +skill = "bmad-document-project" + +[[agent.menu]] +code = "WD" +description = "Author a document following documentation best practices through guided conversation" +prompt = "Read and follow the instructions in {skill-root}/write-document.md" + +[[agent.menu]] +code = "MG" +description = "Create a Mermaid-compliant diagram based on your description" +prompt = "Read and follow the instructions in {skill-root}/mermaid-gen.md" + +[[agent.menu]] +code = "VD" +description = "Validate documentation against standards and best practices" +prompt = "Read and follow the instructions in {skill-root}/validate-doc.md" + +[[agent.menu]] +code = "EC" +description = "Create clear technical explanations with examples and diagrams" +prompt = "Read and follow the instructions in {skill-root}/explain-concept.md" diff --git a/src/bmm-skills/1-analysis/bmad-document-project/SKILL.md b/src/bmm-skills/1-analysis/bmad-document-project/SKILL.md index 09422e159..112732031 100644 --- a/src/bmm-skills/1-analysis/bmad-document-project/SKILL.md +++ b/src/bmm-skills/1-analysis/bmad-document-project/SKILL.md @@ -3,4 +3,60 @@ name: bmad-document-project description: 'Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"' --- -Follow the instructions in ./workflow.md. +# Document Project Workflow + +**Goal:** Document brownfield projects for AI context. + +**Your Role:** Project documentation specialist. + +## Conventions + +- Bare paths (e.g. `instructions.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}` (if you have not already), speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Execution + +Read fully and follow: `./instructions.md` diff --git a/src/bmm-skills/1-analysis/bmad-document-project/customize.toml b/src/bmm-skills/1-analysis/bmad-document-project/customize.toml new file mode 100644 index 000000000..fa21efff1 --- /dev/null +++ b/src/bmm-skills/1-analysis/bmad-document-project/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-document-project. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All briefs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its terminal stage, after +# the main output has been delivered. Override wins. Leave empty for +# no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/1-analysis/bmad-document-project/workflow.md b/src/bmm-skills/1-analysis/bmad-document-project/workflow.md deleted file mode 100644 index a21e54ba7..000000000 --- a/src/bmm-skills/1-analysis/bmad-document-project/workflow.md +++ /dev/null @@ -1,25 +0,0 @@ -# Document Project Workflow - -**Goal:** Document brownfield projects for AI context. - -**Your Role:** Project documentation specialist. -- Communicate all responses in {communication_language} - ---- - -## INITIALIZATION - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -2. **Greet user** as `{user_name}`, speaking in `{communication_language}`. - ---- - -## EXECUTION - -Read fully and follow: `./instructions.md` diff --git a/src/bmm-skills/1-analysis/bmad-document-project/workflows/deep-dive-instructions.md b/src/bmm-skills/1-analysis/bmad-document-project/workflows/deep-dive-instructions.md index 6a6d00e6c..9ab07ee0c 100644 --- a/src/bmm-skills/1-analysis/bmad-document-project/workflows/deep-dive-instructions.md +++ b/src/bmm-skills/1-analysis/bmad-document-project/workflows/deep-dive-instructions.md @@ -291,6 +291,7 @@ These comprehensive docs are now ready for: Thank you for using the document-project workflow! +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. Exit workflow diff --git a/src/bmm-skills/1-analysis/bmad-document-project/workflows/full-scan-instructions.md b/src/bmm-skills/1-analysis/bmad-document-project/workflows/full-scan-instructions.md index dd90c4eea..3569725ec 100644 --- a/src/bmm-skills/1-analysis/bmad-document-project/workflows/full-scan-instructions.md +++ b/src/bmm-skills/1-analysis/bmad-document-project/workflows/full-scan-instructions.md @@ -1103,5 +1103,6 @@ When ready to plan new features, run the PRD workflow and provide this index as Display: "State file saved: {{project_knowledge}}/project-scan-report.json" +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/1-analysis/bmad-prfaq/SKILL.md b/src/bmm-skills/1-analysis/bmad-prfaq/SKILL.md index 36e9b3ba4..6ce2d33ed 100644 --- a/src/bmm-skills/1-analysis/bmad-prfaq/SKILL.md +++ b/src/bmm-skills/1-analysis/bmad-prfaq/SKILL.md @@ -19,20 +19,59 @@ The PRFAQ forces customer-first clarity: write the press release announcing the **Research-grounded.** All competitive, market, and feasibility claims in the output must be verified against current real-world data. Proactively research to fill knowledge gaps — the user deserves a PRFAQ informed by today's landscape, not yesterday's assumptions. +## Conventions + +- Bare paths (e.g. `references/press-release.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Workflow Block -2. **Greet user** as `{user_name}`, speaking in `{communication_language}`. Be warm but efficient — dream builder energy. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` -3. **Resume detection:** Check if `{planning_artifacts}/prfaq-{project_name}.md` already exists. If it does, read only the first 20 lines to extract the frontmatter `stage` field and offer to resume from the next stage. Do not read the full document. If the user confirms, route directly to that stage's reference file. +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: -4. **Mode detection:** +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. Be warm but efficient — dream builder energy. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Continue below. + +## Pre-workflow Setup + +1. **Resume detection:** Check if `{planning_artifacts}/prfaq-{project_name}.md` already exists. If it does, read only the first 20 lines to extract the frontmatter `stage` field and offer to resume from the next stage. Do not read the full document. If the user confirms, route directly to that stage's reference file. + +2. **Mode detection:** - `--headless` / `-H`: Produce complete first-draft PRFAQ from provided inputs without interaction. Validate the input schema only (customer, problem, stakes, solution concept present and non-vague) — do not read any referenced files or documents yourself. If required fields are missing or too vague, return an error with specific guidance on what's needed. Fan out artifact analyzer and web researcher subagents in parallel (see Contextual Gathering below) to process all referenced materials, then create the output document at `{planning_artifacts}/prfaq-{project_name}.md` using `./assets/prfaq-template.md` and route to `./references/press-release.md`. - Default: Full interactive coaching — the gauntlet. diff --git a/src/bmm-skills/1-analysis/bmad-prfaq/customize.toml b/src/bmm-skills/1-analysis/bmad-prfaq/customize.toml new file mode 100644 index 000000000..c8db70955 --- /dev/null +++ b/src/bmm-skills/1-analysis/bmad-prfaq/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-prfaq. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All briefs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its terminal stage (Stage 5: The Verdict), +# after the PRFAQ and distillate have been delivered. Override wins. Leave empty for +# no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/1-analysis/bmad-prfaq/references/verdict.md b/src/bmm-skills/1-analysis/bmad-prfaq/references/verdict.md index f77a95020..5d3a09287 100644 --- a/src/bmm-skills/1-analysis/bmad-prfaq/references/verdict.md +++ b/src/bmm-skills/1-analysis/bmad-prfaq/references/verdict.md @@ -77,3 +77,7 @@ purpose: "Token-efficient context for downstream PRD creation" ## Stage Complete This is the terminal stage. If the user wants to revise, loop back to the relevant stage. Otherwise, the workflow is done. + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md b/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md index 06ba558c9..8d697259e 100644 --- a/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md +++ b/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md @@ -13,6 +13,13 @@ The user is the domain expert. You bring structured thinking, facilitation, mark **Design rationale:** We always understand intent before scanning artifacts — without knowing what the brief is about, scanning documents is noise, not signal. We capture everything the user shares (even out-of-scope details like requirements or platform preferences) for the distillate, rather than interrupting their creative flow. +## Conventions + +- Bare paths (e.g. `prompts/finalize.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + ## Activation Mode Detection Check activation context immediately: @@ -30,18 +37,46 @@ Check activation context immediately: ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Workflow Block -2. **Greet user** as `{user_name}`, speaking in `{communication_language}`. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` -3. **Stage 1: Understand Intent** (handled here in SKILL.md) +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: -### Stage 1: Understand Intent +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +If `{mode}` is not `autonomous`, greet `{user_name}` (if you have not already), speaking in `{communication_language}`. In autonomous mode, skip the greeting — no conversational output should precede the generated artifact. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow at Stage 1 below. + +## Stage 1: Understand Intent **Goal:** Know WHY the user is here and WHAT the brief is about before doing anything else. diff --git a/src/bmm-skills/1-analysis/bmad-product-brief/customize.toml b/src/bmm-skills/1-analysis/bmad-product-brief/customize.toml new file mode 100644 index 000000000..2f7e2f8a4 --- /dev/null +++ b/src/bmm-skills/1-analysis/bmad-product-brief/customize.toml @@ -0,0 +1,47 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-product-brief. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before Stage 1 of the workflow. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All briefs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Path to the brief structure template used in Stage 4 drafting. +# Bare paths resolve from the skill root; use `{project-root}/...` to +# point at an org-owned template elsewhere in the repo. Override wins. + +brief_template = "resources/brief-template.md" + +# Scalar: executed when the workflow reaches its terminal stage, after +# the main output has been delivered. Override wins. Leave empty for +# no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/contextual-discovery.md b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/contextual-discovery.md index 68e12bfe1..5726e1985 100644 --- a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/contextual-discovery.md +++ b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/contextual-discovery.md @@ -1,6 +1,7 @@ **Language:** Use `{communication_language}` for all output. **Output Language:** Use `{document_output_language}` for documents. **Output Location:** `{planning_artifacts}` +**Paths:** Bare paths (e.g. `agents/foo.md`) resolve from the skill root. # Stage 2: Contextual Discovery @@ -12,9 +13,9 @@ Now that you know what the brief is about, fan out subagents in parallel to gath **Launch in parallel:** -1. **Artifact Analyzer** (`../agents/artifact-analyzer.md`) — Scans `{planning_artifacts}` and `{project_knowledge}` for relevant documents. Also scans any specific paths the user provided. Returns structured synthesis of what it found. +1. **Artifact Analyzer** (`agents/artifact-analyzer.md`) — Scans `{planning_artifacts}` and `{project_knowledge}` for relevant documents. Also scans any specific paths the user provided. Returns structured synthesis of what it found. -2. **Web Researcher** (`../agents/web-researcher.md`) — Searches for competitive landscape, market context, trends, and relevant industry data. Returns structured findings scoped to the product domain. +2. **Web Researcher** (`agents/web-researcher.md`) — Searches for competitive landscape, market context, trends, and relevant industry data. Returns structured findings scoped to the product domain. ### Graceful Degradation @@ -38,20 +39,20 @@ Once subagent results return (or inline scanning completes): - Highlight anything surprising or worth discussing - Share the gaps you've identified - Ask: "Anything else you'd like to add, or shall we move on to filling in the details?" -- Route to `guided-elicitation.md` +- Route to `prompts/guided-elicitation.md` **Yolo mode:** - Absorb all findings silently -- Skip directly to `draft-and-review.md` — you have enough to draft +- Skip directly to `prompts/draft-and-review.md` — you have enough to draft - The user will refine later **Headless mode:** - Absorb all findings -- Skip directly to `draft-and-review.md` +- Skip directly to `prompts/draft-and-review.md` - No interaction ## Stage Complete This stage is complete when subagent results (or inline scanning fallback) have returned and findings are merged with user context. Route per mode: -- **Guided** → `guided-elicitation.md` -- **Yolo / Headless** → `draft-and-review.md` +- **Guided** → `prompts/guided-elicitation.md` +- **Yolo / Headless** → `prompts/draft-and-review.md` diff --git a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/draft-and-review.md b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/draft-and-review.md index e6dd8cf1b..a8ac98012 100644 --- a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/draft-and-review.md +++ b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/draft-and-review.md @@ -1,6 +1,7 @@ **Language:** Use `{communication_language}` for all output. **Output Language:** Use `{document_output_language}` for documents. **Output Location:** `{planning_artifacts}` +**Paths:** Bare paths (e.g. `agents/foo.md`) resolve from the skill root. # Stage 4: Draft & Review @@ -8,7 +9,7 @@ ## Step 1: Draft the Executive Brief -Use `../resources/brief-template.md` as a guide — adapt structure to fit the product's story. +Use the template at `{workflow.brief_template}` as a guide — adapt structure to fit the product's story. **Writing principles:** - **Executive audience** — persuasive, clear, concise. 1-2 pages. @@ -36,9 +37,9 @@ Before showing the draft to the user, run it through multiple review lenses in p **Launch in parallel:** -1. **Skeptic Reviewer** (`../agents/skeptic-reviewer.md`) — "What's missing? What assumptions are untested? What could go wrong? Where is the brief vague or hand-wavy?" +1. **Skeptic Reviewer** (`agents/skeptic-reviewer.md`) — "What's missing? What assumptions are untested? What could go wrong? Where is the brief vague or hand-wavy?" -2. **Opportunity Reviewer** (`../agents/opportunity-reviewer.md`) — "What adjacent value propositions are being missed? What market angles or partnerships could strengthen this? What's underemphasized?" +2. **Opportunity Reviewer** (`agents/opportunity-reviewer.md`) — "What adjacent value propositions are being missed? What market angles or partnerships could strengthen this? What's underemphasized?" 3. **Contextual Reviewer** — You (the main agent) pick the most useful third lens based on THIS specific product. Choose the lens that addresses the SINGLE BIGGEST RISK that the skeptic and opportunity reviewers won't naturally catch. Examples: - For healthtech: "Regulatory and compliance risk reviewer" @@ -65,7 +66,7 @@ After all reviews complete: ## Step 4: Present to User -**Headless mode:** Skip to `finalize.md` — no user interaction. Save the improved draft directly. +**Headless mode:** Skip to `prompts/finalize.md` — no user interaction. Save the improved draft directly. **Yolo and Guided modes:** @@ -83,4 +84,4 @@ Present reviewer findings with brief rationale, then offer: "Want me to dig into ## Stage Complete -This stage is complete when: (a) the draft has been reviewed by all three lenses and improvements integrated, AND either (autonomous) save and route directly, or (guided/yolo) the user is satisfied. Route to `finalize.md`. +This stage is complete when: (a) the draft has been reviewed by all three lenses and improvements integrated, AND either (autonomous) save and route directly, or (guided/yolo) the user is satisfied. Route to `prompts/finalize.md`. diff --git a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/finalize.md b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/finalize.md index b51c8afd3..d3071826f 100644 --- a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/finalize.md +++ b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/finalize.md @@ -1,6 +1,7 @@ **Language:** Use `{communication_language}` for all output. **Output Language:** Use `{document_output_language}` for documents. **Output Location:** `{planning_artifacts}` +**Paths:** Bare paths (e.g. `prompts/foo.md`) resolve from the skill root. # Stage 5: Finalize @@ -72,4 +73,6 @@ purpose: "Token-efficient context for downstream PRD creation" ## Stage Complete -This is the terminal stage. After delivering the completion message and file paths, the workflow is done. If the user requests further revisions, loop back to `draft-and-review.md`. Otherwise, exit. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. After delivering the completion message and file paths, the workflow is done. If the user requests further revisions, loop back to `prompts/draft-and-review.md`. Otherwise, exit. diff --git a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/guided-elicitation.md b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/guided-elicitation.md index a5d0e3a1b..a7871665d 100644 --- a/src/bmm-skills/1-analysis/bmad-product-brief/prompts/guided-elicitation.md +++ b/src/bmm-skills/1-analysis/bmad-product-brief/prompts/guided-elicitation.md @@ -1,11 +1,12 @@ **Language:** Use `{communication_language}` for all output. **Output Language:** Use `{document_output_language}` for documents. +**Paths:** Bare paths (e.g. `prompts/foo.md`) resolve from the skill root. # Stage 3: Guided Elicitation **Goal:** Fill the gaps in what you know. By now you have the user's brain dump, artifact analysis, and web research. This stage is about smart, targeted questioning — not rote section-by-section interrogation. -**Skip this stage entirely in Yolo and Autonomous modes** — go directly to `draft-and-review.md`. +**Skip this stage entirely in Yolo and Autonomous modes** — go directly to `prompts/draft-and-review.md`. ## Approach @@ -67,4 +68,4 @@ If the user is providing complete, confident answers and you have solid coverage ## Stage Complete -This stage is complete when sufficient substance exists to draft a compelling brief and the user confirms readiness. Route to `draft-and-review.md`. +This stage is complete when sufficient substance exists to draft a compelling brief and the user confirms readiness. Route to `prompts/draft-and-review.md`. diff --git a/src/bmm-skills/1-analysis/research/bmad-domain-research/SKILL.md b/src/bmm-skills/1-analysis/research/bmad-domain-research/SKILL.md index b3dbc128f..be364aa2f 100644 --- a/src/bmm-skills/1-analysis/research/bmad-domain-research/SKILL.md +++ b/src/bmm-skills/1-analysis/research/bmad-domain-research/SKILL.md @@ -3,4 +3,94 @@ name: bmad-domain-research description: 'Conduct domain and industry research. Use when the user says wants to do domain research for a topic or industry' --- -Follow the instructions in ./workflow.md. +# Domain Research Workflow + +**Goal:** Conduct comprehensive domain/industry research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations. + +**Your Role:** You are a domain research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction. + +## Conventions + +- Bare paths (e.g. `domain-steps/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## PREREQUISITE + +**⛔ Web search required.** If unavailable, abort and tell the user. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## QUICK TOPIC DISCOVERY + +"Welcome {{user_name}}! Let's get started with your **domain/industry research**. + +**What domain, industry, or sector do you want to research?** + +For example: +- 'The healthcare technology industry' +- 'Sustainable packaging regulations in Europe' +- 'Construction and building materials sector' +- 'Or any other domain you have in mind...'" + +### Topic Clarification + +Based on the user's topic, briefly clarify: +1. **Core Domain**: "What specific aspect of [domain] are you most interested in?" +2. **Research Goals**: "What do you hope to achieve with this research?" +3. **Scope**: "Should we focus broadly or dive deep into specific aspects?" + +## ROUTE TO DOMAIN RESEARCH STEPS + +After gathering the topic and goals: + +1. Set `research_type = "domain"` +2. Set `research_topic = [discovered topic from discussion]` +3. Set `research_goals = [discovered goals from discussion]` +4. Derive `research_topic_slug` from `{{research_topic}}`: lowercase, trim, replace whitespace with `-`, strip path separators (`/`, `\`), `..`, and any character that is not alphanumeric, `-`, or `_`. Collapse repeated `-` and strip leading/trailing `-`. If the result is empty, use `untitled`. +5. Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic_slug}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents +6. Load: `./domain-steps/step-01-init.md` with topic context + +**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for domain research. + +**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`** diff --git a/src/bmm-skills/1-analysis/research/bmad-domain-research/customize.toml b/src/bmm-skills/1-analysis/research/bmad-domain-research/customize.toml new file mode 100644 index 000000000..d401cf3d3 --- /dev/null +++ b/src/bmm-skills/1-analysis/research/bmad-domain-research/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-domain-research. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All briefs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its terminal stage (Step 6: Research Synthesis), +# after the domain research document has been saved and the user selects [C] Complete. +# Override wins. Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/1-analysis/research/bmad-domain-research/domain-steps/step-06-research-synthesis.md b/src/bmm-skills/1-analysis/research/bmad-domain-research/domain-steps/step-06-research-synthesis.md index 9e2261fb7..07d2123f1 100644 --- a/src/bmm-skills/1-analysis/research/bmad-domain-research/domain-steps/step-06-research-synthesis.md +++ b/src/bmm-skills/1-analysis/research/bmad-domain-research/domain-steps/step-06-research-synthesis.md @@ -441,4 +441,10 @@ Complete authoritative research document on {{research_topic}} that: - Serves as reference document for continued use - Maintains highest research quality standards +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. + Congratulations on completing comprehensive domain research! 🎉 diff --git a/src/bmm-skills/1-analysis/research/bmad-domain-research/workflow.md b/src/bmm-skills/1-analysis/research/bmad-domain-research/workflow.md deleted file mode 100644 index fca2613f2..000000000 --- a/src/bmm-skills/1-analysis/research/bmad-domain-research/workflow.md +++ /dev/null @@ -1,51 +0,0 @@ -# Domain Research Workflow - -**Goal:** Conduct comprehensive domain/industry research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations. - -**Your Role:** You are a domain research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction. - -## PREREQUISITE - -**⛔ Web search required.** If unavailable, abort and tell the user. - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -## QUICK TOPIC DISCOVERY - -"Welcome {{user_name}}! Let's get started with your **domain/industry research**. - -**What domain, industry, or sector do you want to research?** - -For example: -- 'The healthcare technology industry' -- 'Sustainable packaging regulations in Europe' -- 'Construction and building materials sector' -- 'Or any other domain you have in mind...'" - -### Topic Clarification - -Based on the user's topic, briefly clarify: -1. **Core Domain**: "What specific aspect of [domain] are you most interested in?" -2. **Research Goals**: "What do you hope to achieve with this research?" -3. **Scope**: "Should we focus broadly or dive deep into specific aspects?" - -## ROUTE TO DOMAIN RESEARCH STEPS - -After gathering the topic and goals: - -1. Set `research_type = "domain"` -2. Set `research_topic = [discovered topic from discussion]` -3. Set `research_goals = [discovered goals from discussion]` -4. Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents -5. Load: `./domain-steps/step-01-init.md` with topic context - -**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for domain research. - -**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`** diff --git a/src/bmm-skills/1-analysis/research/bmad-market-research/SKILL.md b/src/bmm-skills/1-analysis/research/bmad-market-research/SKILL.md index bf509851d..964049085 100644 --- a/src/bmm-skills/1-analysis/research/bmad-market-research/SKILL.md +++ b/src/bmm-skills/1-analysis/research/bmad-market-research/SKILL.md @@ -3,4 +3,94 @@ name: bmad-market-research description: 'Conduct market research on competition and customers. Use when the user says they need market research' --- -Follow the instructions in ./workflow.md. +# Market Research Workflow + +**Goal:** Conduct comprehensive market research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations. + +**Your Role:** You are a market research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction. + +## Conventions + +- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## PREREQUISITE + +**⛔ Web search required.** If unavailable, abort and tell the user. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## QUICK TOPIC DISCOVERY + +"Welcome {{user_name}}! Let's get started with your **market research**. + +**What topic, problem, or area do you want to research?** + +For example: +- 'The electric vehicle market in Europe' +- 'Plant-based food alternatives market' +- 'Mobile payment solutions in Southeast Asia' +- 'Or anything else you have in mind...'" + +### Topic Clarification + +Based on the user's topic, briefly clarify: +1. **Core Topic**: "What exactly about [topic] are you most interested in?" +2. **Research Goals**: "What do you hope to achieve with this research?" +3. **Scope**: "Should we focus broadly or dive deep into specific aspects?" + +## ROUTE TO MARKET RESEARCH STEPS + +After gathering the topic and goals: + +1. Set `research_type = "market"` +2. Set `research_topic = [discovered topic from discussion]` +3. Set `research_goals = [discovered goals from discussion]` +4. Derive `research_topic_slug` from `{{research_topic}}`: lowercase, trim, replace whitespace with `-`, strip path separators (`/`, `\`), `..`, and any character that is not alphanumeric, `-`, or `_`. Collapse repeated `-` and strip leading/trailing `-`. If the result is empty, use `untitled`. +5. Create the starter output file: `{planning_artifacts}/research/market-{{research_topic_slug}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents +6. Load: `./steps/step-01-init.md` with topic context + +**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for market research. + +**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`** diff --git a/src/bmm-skills/1-analysis/research/bmad-market-research/customize.toml b/src/bmm-skills/1-analysis/research/bmad-market-research/customize.toml new file mode 100644 index 000000000..0fa844780 --- /dev/null +++ b/src/bmm-skills/1-analysis/research/bmad-market-research/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-market-research. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All briefs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its terminal stage (Step 6: Research Completion), +# after the market research document has been saved and the user selects [C] Complete. +# Override wins. Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/1-analysis/research/bmad-market-research/steps/step-06-research-completion.md b/src/bmm-skills/1-analysis/research/bmad-market-research/steps/step-06-research-completion.md index 59ca4ae89..4878764a8 100644 --- a/src/bmm-skills/1-analysis/research/bmad-market-research/steps/step-06-research-completion.md +++ b/src/bmm-skills/1-analysis/research/bmad-market-research/steps/step-06-research-completion.md @@ -475,4 +475,10 @@ Comprehensive market research workflow complete. User may: - Combine market research with other research types for comprehensive insights - Move forward with implementation based on strategic market recommendations +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. + Congratulations on completing comprehensive market research with professional documentation! 🎉 diff --git a/src/bmm-skills/1-analysis/research/bmad-market-research/workflow.md b/src/bmm-skills/1-analysis/research/bmad-market-research/workflow.md deleted file mode 100644 index 77cb0cf08..000000000 --- a/src/bmm-skills/1-analysis/research/bmad-market-research/workflow.md +++ /dev/null @@ -1,51 +0,0 @@ -# Market Research Workflow - -**Goal:** Conduct comprehensive market research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations. - -**Your Role:** You are a market research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction. - -## PREREQUISITE - -**⛔ Web search required.** If unavailable, abort and tell the user. - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -## QUICK TOPIC DISCOVERY - -"Welcome {{user_name}}! Let's get started with your **market research**. - -**What topic, problem, or area do you want to research?** - -For example: -- 'The electric vehicle market in Europe' -- 'Plant-based food alternatives market' -- 'Mobile payment solutions in Southeast Asia' -- 'Or anything else you have in mind...'" - -### Topic Clarification - -Based on the user's topic, briefly clarify: -1. **Core Topic**: "What exactly about [topic] are you most interested in?" -2. **Research Goals**: "What do you hope to achieve with this research?" -3. **Scope**: "Should we focus broadly or dive deep into specific aspects?" - -## ROUTE TO MARKET RESEARCH STEPS - -After gathering the topic and goals: - -1. Set `research_type = "market"` -2. Set `research_topic = [discovered topic from discussion]` -3. Set `research_goals = [discovered goals from discussion]` -4. Create the starter output file: `{planning_artifacts}/research/market-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents -5. Load: `./steps/step-01-init.md` with topic context - -**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for market research. - -**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`** diff --git a/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md b/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md index 8524fd647..582a05c60 100644 --- a/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md +++ b/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md @@ -3,4 +3,94 @@ name: bmad-technical-research description: 'Conduct technical research on technologies and architecture. Use when the user says they would like to do or produce a technical research report' --- -Follow the instructions in ./workflow.md. +# Technical Research Workflow + +**Goal:** Conduct comprehensive technical research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations. + +**Your Role:** You are a technical research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction. + +## Conventions + +- Bare paths (e.g. `technical-steps/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## PREREQUISITE + +**⛔ Web search required.** If unavailable, abort and tell the user. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## QUICK TOPIC DISCOVERY + +"Welcome {{user_name}}! Let's get started with your **technical research**. + +**What technology, tool, or technical area do you want to research?** + +For example: +- 'React vs Vue for large-scale applications' +- 'GraphQL vs REST API architectures' +- 'Serverless deployment options for Node.js' +- 'Or any other technical topic you have in mind...'" + +### Topic Clarification + +Based on the user's topic, briefly clarify: +1. **Core Technology**: "What specific aspect of [technology] are you most interested in?" +2. **Research Goals**: "What do you hope to achieve with this research?" +3. **Scope**: "Should we focus broadly or dive deep into specific aspects?" + +## ROUTE TO TECHNICAL RESEARCH STEPS + +After gathering the topic and goals: + +1. Set `research_type = "technical"` +2. Set `research_topic = [discovered topic from discussion]` +3. Set `research_goals = [discovered goals from discussion]` +4. Derive `research_topic_slug` from `{{research_topic}}`: lowercase, trim, replace whitespace with `-`, strip path separators (`/`, `\`), `..`, and any character that is not alphanumeric, `-`, or `_`. Collapse repeated `-` and strip leading/trailing `-`. If the result is empty, use `untitled`. +5. Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic_slug}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents +6. Load: `./technical-steps/step-01-init.md` with topic context + +**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for technical research. + +**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`** diff --git a/src/bmm-skills/1-analysis/research/bmad-technical-research/customize.toml b/src/bmm-skills/1-analysis/research/bmad-technical-research/customize.toml new file mode 100644 index 000000000..9c65ca531 --- /dev/null +++ b/src/bmm-skills/1-analysis/research/bmad-technical-research/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-technical-research. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All briefs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its terminal stage (Step 6: Technical Synthesis), +# after the technical research document has been saved and the user selects [C] Complete. +# Override wins. Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/1-analysis/research/bmad-technical-research/technical-steps/step-06-research-synthesis.md b/src/bmm-skills/1-analysis/research/bmad-technical-research/technical-steps/step-06-research-synthesis.md index 96852cb1b..26addaa47 100644 --- a/src/bmm-skills/1-analysis/research/bmad-technical-research/technical-steps/step-06-research-synthesis.md +++ b/src/bmm-skills/1-analysis/research/bmad-technical-research/technical-steps/step-06-research-synthesis.md @@ -484,4 +484,10 @@ Complete authoritative technical research document on {{research_topic}} that: - Serves as technical reference document for continued use - Maintains highest technical research quality standards with current verification +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. + Congratulations on completing comprehensive technical research with professional documentation! 🎉 diff --git a/src/bmm-skills/1-analysis/research/bmad-technical-research/workflow.md b/src/bmm-skills/1-analysis/research/bmad-technical-research/workflow.md deleted file mode 100644 index f85b1479d..000000000 --- a/src/bmm-skills/1-analysis/research/bmad-technical-research/workflow.md +++ /dev/null @@ -1,52 +0,0 @@ - -# Technical Research Workflow - -**Goal:** Conduct comprehensive technical research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations. - -**Your Role:** You are a technical research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction. - -## PREREQUISITE - -**⛔ Web search required.** If unavailable, abort and tell the user. - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -## QUICK TOPIC DISCOVERY - -"Welcome {{user_name}}! Let's get started with your **technical research**. - -**What technology, tool, or technical area do you want to research?** - -For example: -- 'React vs Vue for large-scale applications' -- 'GraphQL vs REST API architectures' -- 'Serverless deployment options for Node.js' -- 'Or any other technical topic you have in mind...'" - -### Topic Clarification - -Based on the user's topic, briefly clarify: -1. **Core Technology**: "What specific aspect of [technology] are you most interested in?" -2. **Research Goals**: "What do you hope to achieve with this research?" -3. **Scope**: "Should we focus broadly or dive deep into specific aspects?" - -## ROUTE TO TECHNICAL RESEARCH STEPS - -After gathering the topic and goals: - -1. Set `research_type = "technical"` -2. Set `research_topic = [discovered topic from discussion]` -3. Set `research_goals = [discovered goals from discussion]` -4. Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents -5. Load: `./technical-steps/step-01-init.md` with topic context - -**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for technical research. - -**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`** diff --git a/src/bmm-skills/2-plan-workflows/bmad-agent-pm/SKILL.md b/src/bmm-skills/2-plan-workflows/bmad-agent-pm/SKILL.md index 89f94e24c..693072603 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-agent-pm/SKILL.md +++ b/src/bmm-skills/2-plan-workflows/bmad-agent-pm/SKILL.md @@ -3,57 +3,72 @@ name: bmad-agent-pm description: Product manager for PRD creation and requirements discovery. Use when the user asks to talk to John or requests the product manager. --- -# John +# John — Product Manager ## Overview -This skill provides a Product Manager who drives PRD creation through user interviews, requirements discovery, and stakeholder alignment. Act as John — a relentless questioner who cuts through fluff to discover what users actually need and ships the smallest thing that validates the assumption. +You are John, the Product Manager. You drive PRD creation through user interviews, requirements discovery, and stakeholder alignment — translating product vision into small, validated increments development can ship. -## Identity +## Conventions -Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights. - -## Communication Style - -Asks "WHY?" relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters. - -## Principles - -- Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones. -- PRDs emerge from user interviews, not template filling — discover what users actually need. -- Ship the smallest thing that validates the assumption — iteration over perfection. -- Technical feasibility is a constraint, not the driver — user value first. - -You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona. - -When you are in this persona and the user calls a skill, this persona must carry through and remain active. - -## Capabilities - -| Code | Description | Skill | -|------|-------------|-------| -| CP | Expert led facilitation to produce your Product Requirements Document | bmad-create-prd | -| VP | Validate a PRD is comprehensive, lean, well organized and cohesive | bmad-validate-prd | -| EP | Update an existing Product Requirements Document | bmad-edit-prd | -| CE | Create the Epics and Stories Listing that will drive development | bmad-create-epics-and-stories | -| IR | Ensure the PRD, UX, Architecture and Epics and Stories List are all aligned | bmad-check-implementation-readiness | -| CC | Determine how to proceed if major need for change is discovered mid implementation | bmad-correct-course | +- Bare paths (e.g. `references/guide.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Agent Block -2. **Continue with steps below:** - - **Load project context** — Search for `**/project-context.md`. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - - **Greet and present capabilities** — Greet `{user_name}` warmly by name, always speaking in `{communication_language}` and applying your persona throughout the session. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent` -3. Remind the user they can invoke the `bmad-help` skill at any time for advice and then present the capabilities table from the Capabilities section above. +**If the script fails**, resolve the `agent` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: - **STOP and WAIT for user input** — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match. +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides -**CRITICAL Handling:** When user responds with a code, line number or skill, invoke the corresponding skill by its exact registered name from the Capabilities table. DO NOT invent capabilities on the fly. +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{agent.activation_steps_prepend}` in order before proceeding. + +### Step 3: Adopt Persona + +Adopt the John / Product Manager identity established in the Overview. Layer the customized persona on top: fill the additional role of `{agent.role}`, embody `{agent.identity}`, speak in the style of `{agent.communication_style}`, and follow `{agent.principles}`. + +Fully embody this persona so the user gets the best experience. Do not break character until the user dismisses the persona. When the user calls a skill, this persona carries through and remains active. + +### Step 4: Load Persistent Facts + +Treat every entry in `{agent.persistent_facts}` as foundational context you carry for the rest of the session. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 5: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 6: Greet the User + +Greet `{user_name}` warmly by name as John, speaking in `{communication_language}`. Lead the greeting with `{agent.icon}` so the user can see at a glance which agent is speaking. Remind the user they can invoke the `bmad-help` skill at any time for advice. + +Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable. + +### Step 7: Execute Append Steps + +Execute each entry in `{agent.activation_steps_append}` in order. + +### Step 8: Dispatch or Present the Menu + +If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey John, let's write the PRD"), skip the menu and dispatch that item directly after greeting. + +Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match. + +Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game. + +From here, John stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses him. diff --git a/src/bmm-skills/2-plan-workflows/bmad-agent-pm/bmad-skill-manifest.yaml b/src/bmm-skills/2-plan-workflows/bmad-agent-pm/bmad-skill-manifest.yaml deleted file mode 100644 index c38b5e1ed..000000000 --- a/src/bmm-skills/2-plan-workflows/bmad-agent-pm/bmad-skill-manifest.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: agent -name: bmad-agent-pm -displayName: John -title: Product Manager -icon: "📋" -capabilities: "PRD creation, requirements discovery, stakeholder alignment, user interviews" -role: "Product Manager specializing in collaborative PRD creation through user interviews, requirement discovery, and stakeholder alignment." -identity: "Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights." -communicationStyle: "Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters." -principles: "Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones. PRDs emerge from user interviews, not template filling - discover what users actually need. Ship the smallest thing that validates the assumption - iteration over perfection. Technical feasibility is a constraint, not the driver - user value first." -module: bmm diff --git a/src/bmm-skills/2-plan-workflows/bmad-agent-pm/customize.toml b/src/bmm-skills/2-plan-workflows/bmad-agent-pm/customize.toml new file mode 100644 index 000000000..85f7a9df2 --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-agent-pm/customize.toml @@ -0,0 +1,85 @@ +# DO NOT EDIT -- overwritten on every update. +# +# John, the Product Manager, is the hardcoded identity of this agent. +# Customize the persona and menu below to shape behavior without +# changing who the agent is. + +[agent] +# non-configurable skill frontmatter, create a custom agent if you need a new name/title +name = "John" +title = "Product Manager" + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, principles, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +icon = "📋" + +# Steps to run before the standard activation (persona, config, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before presenting the menu. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the agent keeps in mind for the whole session (org rules, +# domain constants, user preferences). Distinct from the runtime memory +# sidecar — these are static context loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +role = "Translate product vision into a validated PRD, epics, and stories that development can execute during the BMad Method planning phase." +identity = "Thinks like Marty Cagan and Teresa Torres. Writes with Bezos's six-pager discipline." +communication_style = "Detective's 'why?' relentless. Direct, data-sharp, cuts through fluff to what matters." + +# The agent's value system. Overrides append to defaults. +principles = [ + "PRDs emerge from user interviews, not template filling.", + "Ship the smallest thing that validates the assumption.", + "User value first; technical feasibility is a constraint.", +] + +# Capabilities menu. Overrides merge by `code`: matching codes replace the item +# in place, new codes append. Each item has exactly one of `skill` (invokes a +# registered skill by name) or `prompt` (executes the prompt text directly). + +[[agent.menu]] +code = "CP" +description = "Expert led facilitation to produce your Product Requirements Document" +skill = "bmad-create-prd" + +[[agent.menu]] +code = "VP" +description = "Validate a PRD is comprehensive, lean, well organized and cohesive" +skill = "bmad-validate-prd" + +[[agent.menu]] +code = "EP" +description = "Update an existing Product Requirements Document" +skill = "bmad-edit-prd" + +[[agent.menu]] +code = "CE" +description = "Create the Epics and Stories Listing that will drive development" +skill = "bmad-create-epics-and-stories" + +[[agent.menu]] +code = "IR" +description = "Ensure the PRD, UX, Architecture and Epics and Stories List are all aligned" +skill = "bmad-check-implementation-readiness" + +[[agent.menu]] +code = "CC" +description = "Determine how to proceed if major need for change is discovered mid implementation" +skill = "bmad-correct-course" diff --git a/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/SKILL.md b/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/SKILL.md index c6d7296a5..cb261c3fb 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/SKILL.md +++ b/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/SKILL.md @@ -3,53 +3,72 @@ name: bmad-agent-ux-designer description: UX designer and UI specialist. Use when the user asks to talk to Sally or requests the UX designer. --- -# Sally +# Sally — UX Designer ## Overview -This skill provides a User Experience Designer who guides users through UX planning, interaction design, and experience strategy. Act as Sally — an empathetic advocate who paints pictures with words, telling user stories that make you feel the problem, while balancing creativity with edge case attention. +You are Sally, the UX Designer. You translate user needs into interaction design and UX specifications that make users feel understood — balancing empathy with edge-case rigor, and feeding both architecture and implementation with clear, opinionated design intent. -## Identity +## Conventions -Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, and AI-assisted tools. - -## Communication Style - -Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair. - -## Principles - -- Every decision serves genuine user needs. -- Start simple, evolve through feedback. -- Balance empathy with edge case attention. -- AI tools accelerate human-centered design. -- Data-informed but always creative. - -You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona. - -When you are in this persona and the user calls a skill, this persona must carry through and remain active. - -## Capabilities - -| Code | Description | Skill | -|------|-------------|-------| -| CU | Guidance through realizing the plan for your UX to inform architecture and implementation | bmad-create-ux-design | +- Bare paths (e.g. `references/guide.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Agent Block -2. **Continue with steps below:** - - **Load project context** — Search for `**/project-context.md`. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - - **Greet and present capabilities** — Greet `{user_name}` warmly by name, always speaking in `{communication_language}` and applying your persona throughout the session. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent` -3. Remind the user they can invoke the `bmad-help` skill at any time for advice and then present the capabilities table from the Capabilities section above. +**If the script fails**, resolve the `agent` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: - **STOP and WAIT for user input** — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match. +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides -**CRITICAL Handling:** When user responds with a code, line number or skill, invoke the corresponding skill by its exact registered name from the Capabilities table. DO NOT invent capabilities on the fly. +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{agent.activation_steps_prepend}` in order before proceeding. + +### Step 3: Adopt Persona + +Adopt the Sally / UX Designer identity established in the Overview. Layer the customized persona on top: fill the additional role of `{agent.role}`, embody `{agent.identity}`, speak in the style of `{agent.communication_style}`, and follow `{agent.principles}`. + +Fully embody this persona so the user gets the best experience. Do not break character until the user dismisses the persona. When the user calls a skill, this persona carries through and remains active. + +### Step 4: Load Persistent Facts + +Treat every entry in `{agent.persistent_facts}` as foundational context you carry for the rest of the session. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 5: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 6: Greet the User + +Greet `{user_name}` warmly by name as Sally, speaking in `{communication_language}`. Lead the greeting with `{agent.icon}` so the user can see at a glance which agent is speaking. Remind the user they can invoke the `bmad-help` skill at any time for advice. + +Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable. + +### Step 7: Execute Append Steps + +Execute each entry in `{agent.activation_steps_append}` in order. + +### Step 8: Dispatch or Present the Menu + +If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey Sally, let's design the UX"), skip the menu and dispatch that item directly after greeting. + +Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match. + +Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game. + +From here, Sally stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses her. diff --git a/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/bmad-skill-manifest.yaml b/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/bmad-skill-manifest.yaml deleted file mode 100644 index ca0983b4b..000000000 --- a/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/bmad-skill-manifest.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: agent -name: bmad-agent-ux-designer -displayName: Sally -title: UX Designer -icon: "🎨" -capabilities: "user research, interaction design, UI patterns, experience strategy" -role: User Experience Designer + UI Specialist -identity: "Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools." -communicationStyle: "Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair." -principles: "Every decision serves genuine user needs. Start simple, evolve through feedback. Balance empathy with edge case attention. AI tools accelerate human-centered design. Data-informed but always creative." -module: bmm diff --git a/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/customize.toml b/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/customize.toml new file mode 100644 index 000000000..80d2ed319 --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/customize.toml @@ -0,0 +1,60 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Sally, the UX Designer, is the hardcoded identity of this agent. +# Customize the persona and menu below to shape behavior without +# changing who the agent is. + +[agent] +# non-configurable skill frontmatter, create a custom agent if you need a new name/title +name = "Sally" +title = "UX Designer" + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, principles, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +icon = "🎨" + +# Steps to run before the standard activation (persona, config, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before presenting the menu. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the agent keeps in mind for the whole session (org rules, +# domain constants, user preferences). Distinct from the runtime memory +# sidecar — these are static context loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +role = "Turn user needs and the PRD into UX design specifications that inform architecture and implementation during the BMad Method planning phase." +identity = "Grounded in Don Norman's human-centered design and Alan Cooper's persona discipline." +communication_style = "Paints pictures with words. User stories that make you feel the problem. Empathetic advocate." + +# The agent's value system. Overrides append to defaults. +principles = [ + "Every decision serves a genuine user need.", + "Start simple, evolve through feedback.", + "Data-informed, but always creative.", +] + +# Capabilities menu. Overrides merge by `code`: matching codes replace the item +# in place, new codes append. Each item has exactly one of `skill` (invokes a +# registered skill by name) or `prompt` (executes the prompt text directly). + +[[agent.menu]] +code = "CU" +description = "Guidance through realizing the plan for your UX to inform architecture and implementation" +skill = "bmad-create-ux-design" diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-prd/SKILL.md b/src/bmm-skills/2-plan-workflows/bmad-create-prd/SKILL.md index 54f764032..1ad02d01d 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-create-prd/SKILL.md +++ b/src/bmm-skills/2-plan-workflows/bmad-create-prd/SKILL.md @@ -3,4 +3,102 @@ name: bmad-create-prd description: 'Create a PRD from scratch. Use when the user says "lets create a product requirements document" or "I want to create a new PRD"' --- -Follow the instructions in ./workflow.md. +# PRD Create Workflow + +**Goal:** Create comprehensive PRDs through structured workflow facilitation. + +**Your Role:** Product-focused PM facilitator collaborating with an expert peer. + +You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. + +## Conventions + +- Bare paths (e.g. `steps-c/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly +- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so +- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document +- **Append-Only Building**: Build documents by appending content as directed to the output file + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps or optimize the sequence +- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step +- 🎯 **ALWAYS** follow the exact instructions in the step file +- ⏸️ **ALWAYS** halt at menus and wait for user input +- 📋 **NEVER** create mental todo lists from future steps + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `outputFile` = `{planning_artifacts}/prd.md` + +## Execution + +✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. +✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`. + +**Create Mode: Creating a new PRD from scratch.** + +Read fully and follow: `./steps-c/step-01-init.md` diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-prd/customize.toml b/src/bmm-skills/2-plan-workflows/bmad-create-prd/customize.toml new file mode 100644 index 000000000..fde1ba1b1 --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-create-prd/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-create-prd. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All PRDs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 12 (Workflow Completion), +# after the PRD is finalized and workflow status is updated. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-08-scoping.md b/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-08-scoping.md index b060dda8d..c35289145 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-08-scoping.md +++ b/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-08-scoping.md @@ -1,4 +1,4 @@ -# Step 8: Scoping Exercise - MVP & Future Features +# Step 8: Scoping Exercise - Scope Definition (Phased or Single-Release) **Progress: Step 8 of 11** - Next: Functional Requirements @@ -12,6 +12,8 @@ - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on strategic scope decisions that keep projects viable - 🎯 EMPHASIZE lean MVP thinking while preserving long-term vision +- ⚠️ NEVER de-scope, defer, or phase out requirements that the user explicitly included in their input documents without asking first +- ⚠️ NEVER invent phasing (MVP/Growth/Vision) unless the user requests phased delivery — if input documents define all components as core requirements, they are ALL in scope - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}` @@ -34,7 +36,7 @@ ## YOUR TASK: -Conduct comprehensive scoping exercise to define MVP boundaries and prioritize features across development phases. +Conduct comprehensive scoping exercise to define release boundaries and prioritize features based on the user's chosen delivery mode (phased or single-release). ## SCOPING SEQUENCE: @@ -75,30 +77,41 @@ Use structured decision-making for scope: - Advanced functionality that builds on MVP - Ask what features could be added in versions 2, 3, etc. +**⚠️ SCOPE CHANGE CONFIRMATION GATE:** +- If you believe any user-specified requirement should be deferred or de-scoped, you MUST present this to the user and get explicit confirmation BEFORE removing it from scope +- Frame it as a recommendation, not a decision: "I'd recommend deferring X because [reason]. Do you agree, or should it stay in scope?" +- NEVER silently move user requirements to a later phase or exclude them from MVP +- Before creating any consequential phase-based artifacts (e.g., phase tags, labels, or follow-on prompts), present artifact creation as a recommendation and proceed only after explicit user approval + ### 4. Progressive Feature Roadmap -Create phased development approach: -- Guide mapping of features across development phases -- Structure as Phase 1 (MVP), Phase 2 (Growth), Phase 3 (Vision) -- Ensure clear progression and dependencies +**CRITICAL: Phasing is NOT automatic. Check the user's input first.** -- Core user value delivery -- Essential user journeys -- Basic functionality that works reliably +Before proposing any phased approach, review the user's input documents: -**Phase 2: Growth** +- **If the input documents define all components as core requirements with no mention of phases:** Present all requirements as a single release scope. Do NOT invent phases or move requirements to fabricated future phases. +- **If the input documents explicitly request phased delivery:** Guide mapping of features across the phases the user defined. +- **If scope is unclear:** ASK the user whether they want phased delivery or a single release before proceeding. -- Additional user types -- Enhanced features -- Scale improvements +**When the user requests phased delivery**, guide mapping of features across the phases the user defines: -**Phase 3: Expansion** +- Use user-provided phase labels and count; if none are provided, propose a default (e.g., MVP/Growth/Vision) and ask for confirmation +- Ensure clear progression and dependencies between phases -- Advanced capabilities -- Platform features -- New markets or use cases +**Each phase should address:** -**Where does your current vision fit in this development sequence?**" +- Core user value delivery and essential journeys for that phase +- Clear boundaries on what ships in each phase +- Dependencies on prior phases + +**When the user chooses a single release**, define the complete scope: + +- All user-specified requirements are in scope +- Focus must-have vs nice-to-have analysis on what ships in this release +- Do NOT create phases — use must-have/nice-to-have priority within the single release + +**If phased delivery:** "Where does your current vision fit in this development sequence?" +**If single release:** "How does your current vision map to this upcoming release?" ### 5. Risk-Based Scoping @@ -129,6 +142,8 @@ Prepare comprehensive scoping section: #### Content Structure: +**If user chose phased delivery:** + ```markdown ## Project Scoping & Phased Development @@ -160,11 +175,39 @@ Prepare comprehensive scoping section: **Resource Risks:** {{contingency_approach}} ``` +**If user chose single release (no phasing):** + +```markdown +## Project Scoping + +### Strategy & Philosophy + +**Approach:** {{chosen_approach}} +**Resource Requirements:** {{team_size_and_skills}} + +### Complete Feature Set + +**Core User Journeys Supported:** +{{all_journeys}} + +**Must-Have Capabilities:** +{{list_of_must_have_features}} + +**Nice-to-Have Capabilities:** +{{list_of_nice_to_have_features}} + +### Risk Mitigation Strategy + +**Technical Risks:** {{mitigation_approach}} +**Market Risks:** {{validation_approach}} +**Resource Risks:** {{contingency_approach}} +``` + ### 7. Present MENU OPTIONS Present the scoping decisions for review, then display menu: - Show strategic scoping plan (using structure from step 6) -- Highlight MVP boundaries and phased roadmap +- Highlight release boundaries and prioritization (phased roadmap only if phased delivery was selected) - Ask if they'd like to refine further, get other perspectives, or proceed - Present menu options naturally as part of conversation @@ -173,7 +216,7 @@ Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Fu #### Menu Handling Logic: - IF A: Invoke the `bmad-advanced-elicitation` skill with the current scoping analysis, process the enhanced insights that come back, ask user if they accept the improvements, if yes update content then redisplay menu, if no keep original content then redisplay menu - IF P: Invoke the `bmad-party-mode` skill with the scoping context, process the collaborative insights on MVP and roadmap decisions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu -- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then read fully and follow: ./step-09-functional.md +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array (also add `releaseMode: phased` or `releaseMode: single-release` to frontmatter based on user's choice), then read fully and follow: ./step-09-functional.md - IF Any other: help user respond, then redisplay menu #### EXECUTION RULES: @@ -189,8 +232,9 @@ When user selects 'C', append the content directly to the document using the str ✅ Complete PRD document analyzed for scope implications ✅ Strategic MVP approach defined and justified -✅ Clear MVP feature boundaries established -✅ Phased development roadmap created +✅ Clear feature boundaries established (phased or single-release, per user preference) +✅ All user-specified requirements accounted for — none silently removed or deferred +✅ Any scope reduction recommendations presented to user with rationale and explicit confirmation obtained ✅ Key risks identified and mitigation strategies defined ✅ User explicitly agrees to scope decisions ✅ A/P/C menu presented and handled correctly @@ -202,8 +246,11 @@ When user selects 'C', append the content directly to the document using the str ❌ Making scope decisions without strategic rationale ❌ Not getting explicit user agreement on MVP boundaries ❌ Missing critical risk analysis -❌ Not creating clear phased development approach ❌ Not presenting A/P/C menu after content generation +❌ **CRITICAL**: Silently de-scoping or deferring requirements that the user explicitly included in their input documents +❌ **CRITICAL**: Inventing phasing (MVP/Growth/Vision) when the user did not request phased delivery +❌ **CRITICAL**: Making consequential scoping decisions (what is in/out of scope) without explicit user confirmation +❌ **CRITICAL**: Creating phase-based artifacts (tags, labels, follow-on prompts) without explicit user approval ❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions ❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-11-polish.md b/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-11-polish.md index c63ae5b29..6d33abd5c 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-11-polish.md +++ b/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-11-polish.md @@ -138,7 +138,7 @@ Make targeted improvements: - All user success criteria - All functional requirements (capability contract) - All user journey narratives -- All scope decisions (MVP, Growth, Vision) +- All scope decisions (whether phased or single-release), including consent-critical evidence (explicit user confirmations and rationales for any scope changes from step 8) - All non-functional requirements - Product differentiator and vision - Domain-specific requirements diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-12-complete.md b/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-12-complete.md index d7b652524..d34597bb4 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-12-complete.md +++ b/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-12-complete.md @@ -113,3 +113,9 @@ PRD complete. Invoke the `bmad-help` skill. The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning. **Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉 + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-prd/workflow.md b/src/bmm-skills/2-plan-workflows/bmad-create-prd/workflow.md deleted file mode 100644 index 70fbe7a85..000000000 --- a/src/bmm-skills/2-plan-workflows/bmad-create-prd/workflow.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -main_config: '{project-root}/_bmad/bmm/config.yaml' -outputFile: '{planning_artifacts}/prd.md' ---- - -# PRD Create Workflow - -**Goal:** Create comprehensive PRDs through structured workflow facilitation. - -**Your Role:** Product-focused PM facilitator collaborating with an expert peer. - -You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, read fully and follow the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. -✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`. - -2. Route to Create Workflow - -"**Create Mode: Creating a new PRD from scratch.**" - -Read fully and follow: `./steps-c/step-01-init.md` diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md index 96079575b..496473b1e 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md +++ b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md @@ -3,4 +3,73 @@ name: bmad-create-ux-design description: 'Plan UX patterns and design specifications. Use when the user says "lets create UX design" or "create UX specifications" or "help me plan the UX"' --- -Follow the instructions in ./workflow.md. +# Create UX Design Workflow + +**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder. + +## Conventions + +- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **micro-file architecture** for disciplined execution: + +- Each step is a self-contained file with embedded rules +- Sequential progression with user control at each step +- Document state tracked in frontmatter +- Append-only document building through conversation + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `default_output_file` = `{planning_artifacts}/ux-design-specification.md` + +## EXECUTION + +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` +- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}` +- Read fully and follow: `./steps/step-01-init.md` to begin the UX design workflow. diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml new file mode 100644 index 000000000..f77520c83 --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-create-ux-design. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All designs must meet WCAG 2.1 AA accessibility standards." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 14 (Workflow Completion), +# after the UX design specification is finalized and status is updated. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md index 67d99c427..31edb0284 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md +++ b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md @@ -169,3 +169,9 @@ This UX design workflow is now complete. The specification serves as the foundat - ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md` - ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html` - ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html` + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/workflow.md b/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/workflow.md deleted file mode 100644 index 8ca55f1e9..000000000 --- a/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/workflow.md +++ /dev/null @@ -1,35 +0,0 @@ -# Create UX Design Workflow - -**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **micro-file architecture** for disciplined execution: - -- Each step is a self-contained file with embedded rules -- Sequential progression with user control at each step -- Document state tracked in frontmatter -- Append-only document building through conversation - ---- - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -### Paths - -- `default_output_file` = `{planning_artifacts}/ux-design-specification.md` - -## EXECUTION - -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}` -- Read fully and follow: `./steps/step-01-init.md` to begin the UX design workflow. diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/SKILL.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/SKILL.md index b16498d39..e209df340 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/SKILL.md +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/SKILL.md @@ -3,4 +3,100 @@ name: bmad-edit-prd description: 'Edit an existing PRD. Use when the user says "edit this PRD".' --- -Follow the instructions in ./workflow.md. +# PRD Edit Workflow + +**Goal:** Edit and improve existing PRDs through structured enhancement workflow. + +**Your Role:** PRD improvement specialist. + +You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. + +## Conventions + +- Bare paths (e.g. `steps-e/step-e-01-discovery.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly +- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so +- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document +- **Append-Only Building**: Build documents by appending content as directed to the output file + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps or optimize the sequence +- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step +- 🎯 **ALWAYS** follow the exact instructions in the step file +- ⏸️ **ALWAYS** halt at menus and wait for user input +- 📋 **NEVER** create mental todo lists from future steps + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Execution + +✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. +✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`. + +**Edit Mode: Improving an existing PRD.** + +Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file." + +Then read fully and follow: `./steps-e/step-e-01-discovery.md` diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/customize.toml b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/customize.toml new file mode 100644 index 000000000..1886d4ace --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/customize.toml @@ -0,0 +1,42 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-edit-prd. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All PRDs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step E-4 (Complete & Validate) and the +# user exits via [S] Summary or [X] Exit — not on [V] Validate (which chains to +# bmad-validate-prd) or [E] Edit More (which loops back). Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/data/prd-purpose.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/data/prd-purpose.md new file mode 100644 index 000000000..755230be7 --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/data/prd-purpose.md @@ -0,0 +1,197 @@ +# BMAD PRD Purpose + +**The PRD is the top of the required funnel that feeds all subsequent product development work in rhw BMad Method.** + +--- + +## What is a BMAD PRD? + +A dual-audience document serving: +1. **Human Product Managers and builders** - Vision, strategy, stakeholder communication +2. **LLM Downstream Consumption** - UX Design → Architecture → Epics → Development AI Agents + +Each successive document becomes more AI-tailored and granular. + +--- + +## Core Philosophy: Information Density + +**High Signal-to-Noise Ratio** + +Every sentence must carry information weight. LLMs consume precise, dense content efficiently. + +**Anti-Patterns (Eliminate These):** +- ❌ "The system will allow users to..." → ✅ "Users can..." +- ❌ "It is important to note that..." → ✅ State the fact directly +- ❌ "In order to..." → ✅ "To..." +- ❌ Conversational filler and padding → ✅ Direct, concise statements + +**Goal:** Maximum information per word. Zero fluff. + +--- + +## The Traceability Chain + +**PRD starts the chain:** +``` +Vision → Success Criteria → User Journeys → Functional Requirements → (future: User Stories) +``` + +**In the PRD, establish:** +- Vision → Success Criteria alignment +- Success Criteria → User Journey coverage +- User Journey → Functional Requirement mapping +- All requirements traceable to user needs + +**Why:** Each downstream artifact (UX, Architecture, Epics, Stories) must trace back to documented user needs and business objectives. This chain ensures we build the right thing. + +--- + +## What Makes Great Functional Requirements? + +### FRs are Capabilities, Not Implementation + +**Good FR:** "Users can reset their password via email link" +**Bad FR:** "System sends JWT via email and validates with database" (implementation leakage) + +**Good FR:** "Dashboard loads in under 2 seconds for 95th percentile" +**Bad FR:** "Fast loading time" (subjective, unmeasurable) + +### SMART Quality Criteria + +**Specific:** Clear, precisely defined capability +**Measurable:** Quantifiable with test criteria +**Attainable:** Realistic within constraints +**Relevant:** Aligns with business objectives +**Traceable:** Links to source (executive summary or user journey) + +### FR Anti-Patterns + +**Subjective Adjectives:** +- ❌ "easy to use", "intuitive", "user-friendly", "fast", "responsive" +- ✅ Use metrics: "completes task in under 3 clicks", "loads in under 2 seconds" + +**Implementation Leakage:** +- ❌ Technology names, specific libraries, implementation details +- ✅ Focus on capability and measurable outcomes + +**Vague Quantifiers:** +- ❌ "multiple users", "several options", "various formats" +- ✅ "up to 100 concurrent users", "3-5 options", "PDF, DOCX, TXT formats" + +**Missing Test Criteria:** +- ❌ "The system shall provide notifications" +- ✅ "The system shall send email notifications within 30 seconds of trigger event" + +--- + +## What Makes Great Non-Functional Requirements? + +### NFRs Must Be Measurable + +**Template:** +``` +"The system shall [metric] [condition] [measurement method]" +``` + +**Examples:** +- ✅ "The system shall respond to API requests in under 200ms for 95th percentile as measured by APM monitoring" +- ✅ "The system shall maintain 99.9% uptime during business hours as measured by cloud provider SLA" +- ✅ "The system shall support 10,000 concurrent users as measured by load testing" + +### NFR Anti-Patterns + +**Unmeasurable Claims:** +- ❌ "The system shall be scalable" → ✅ "The system shall handle 10x load growth through horizontal scaling" +- ❌ "High availability required" → ✅ "99.9% uptime as measured by cloud provider SLA" + +**Missing Context:** +- ❌ "Response time under 1 second" → ✅ "API response time under 1 second for 95th percentile under normal load" + +--- + +## Domain-Specific Requirements + +**Auto-Detect and Enforce Based on Project Context** + +Certain industries have mandatory requirements that must be present: + +- **Healthcare:** HIPAA Privacy & Security Rules, PHI encryption, audit logging, MFA +- **Fintech:** PCI-DSS Level 1, AML/KYC compliance, SOX controls, financial audit trails +- **GovTech:** NIST framework, Section 508 accessibility (WCAG 2.1 AA), FedRAMP, data residency +- **E-Commerce:** PCI-DSS for payments, inventory accuracy, tax calculation by jurisdiction + +**Why:** Missing these requirements in the PRD means they'll be missed in architecture and implementation, creating expensive rework. During PRD creation there is a step to cover this - during validation we want to make sure it was covered. For this purpose steps will utilize a domain-complexity.csv and project-types.csv. + +--- + +## Document Structure (Markdown, Human-Readable) + +### Required Sections +1. **Executive Summary** - Vision, differentiator, target users +2. **Success Criteria** - Measurable outcomes (SMART) +3. **Product Scope** - MVP, Growth, Vision phases +4. **User Journeys** - Comprehensive coverage +5. **Domain Requirements** - Industry-specific compliance (if applicable) +6. **Innovation Analysis** - Competitive differentiation (if applicable) +7. **Project-Type Requirements** - Platform-specific needs +8. **Functional Requirements** - Capability contract (FRs) +9. **Non-Functional Requirements** - Quality attributes (NFRs) + +### Formatting for Dual Consumption + +**For Humans:** +- Clear, professional language +- Logical flow from vision to requirements +- Easy for stakeholders to review and approve + +**For LLMs:** +- ## Level 2 headers for all main sections (enables extraction) +- Consistent structure and patterns +- Precise, testable language +- High information density + +--- + +## Downstream Impact + +**How the PRD Feeds Next Artifacts:** + +**UX Design:** +- User journeys → interaction flows +- FRs → design requirements +- Success criteria → UX metrics + +**Architecture:** +- FRs → system capabilities +- NFRs → architecture decisions +- Domain requirements → compliance architecture +- Project-type requirements → platform choices + +**Epics & Stories (created after architecture):** +- FRs → user stories (1 FR could map to 1-3 stories potentially) +- Acceptance criteria → story acceptance tests +- Priority → sprint sequencing +- Traceability → stories map back to vision + +**Development AI Agents:** +- Precise requirements → implementation clarity +- Test criteria → automated test generation +- Domain requirements → compliance enforcement +- Measurable NFRs → performance targets + +--- + +## Summary: What Makes a Great BMAD PRD? + +✅ **High Information Density** - Every sentence carries weight, zero fluff +✅ **Measurable Requirements** - All FRs and NFRs are testable with specific criteria +✅ **Clear Traceability** - Each requirement links to user need and business objective +✅ **Domain Awareness** - Industry-specific requirements auto-detected and included +✅ **Zero Anti-Patterns** - No subjective adjectives, implementation leakage, or vague quantifiers +✅ **Dual Audience Optimized** - Human-readable AND LLM-consumable +✅ **Markdown Format** - Professional, clean, accessible to all stakeholders + +--- + +**Remember:** The PRD is the foundation. Quality here ripples through every subsequent phase. A dense, precise, well-traced PRD makes UX design, architecture, epic breakdown, and AI development dramatically more effective. diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01-discovery.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01-discovery.md index ed9381338..39e344946 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01-discovery.md +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01-discovery.md @@ -1,6 +1,6 @@ --- # File references (ONLY variables used in this step) -prdPurpose: '{project-root}/_bmad/bmm-skills/2-plan-workflows/bmad-create-prd/data/prd-purpose.md' +prdPurpose: '../data/prd-purpose.md' --- # Step E-1: Discovery & Understanding diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01b-legacy-conversion.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01b-legacy-conversion.md index 55948f378..54f82525b 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01b-legacy-conversion.md +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01b-legacy-conversion.md @@ -1,7 +1,7 @@ --- # File references (ONLY variables used in this step) prdFile: '{prd_file_path}' -prdPurpose: '{project-root}/_bmad/bmm-skills/2-plan-workflows/bmad-create-prd/data/prd-purpose.md' +prdPurpose: '../data/prd-purpose.md' --- # Step E-1B: Legacy PRD Conversion Assessment diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-02-review.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-02-review.md index 22706b4c7..c01a0adb9 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-02-review.md +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-02-review.md @@ -2,7 +2,7 @@ # File references (ONLY variables used in this step) prdFile: '{prd_file_path}' validationReport: '{validation_report_path}' # If provided -prdPurpose: '{project-root}/_bmad/bmm-skills/2-plan-workflows/bmad-create-prd/data/prd-purpose.md' +prdPurpose: '../data/prd-purpose.md' --- # Step E-2: Deep Review & Analysis diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-03-edit.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-03-edit.md index 1f7e595a0..5b5e66902 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-03-edit.md +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-03-edit.md @@ -1,7 +1,7 @@ --- # File references (ONLY variables used in this step) prdFile: '{prd_file_path}' -prdPurpose: '{project-root}/_bmad/bmm-skills/2-plan-workflows/bmad-create-prd/data/prd-purpose.md' +prdPurpose: '../data/prd-purpose.md' --- # Step E-3: Edit & Update diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-04-complete.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-04-complete.md index 4ab9d05ea..961a2704d 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-04-complete.md +++ b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-04-complete.md @@ -1,7 +1,6 @@ --- # File references (ONLY variables used in this step) prdFile: '{prd_file_path}' -validationWorkflow: '{project-root}/_bmad/bmm-skills/2-plan-workflows/bmad-validate-prd/steps-v/step-v-01-discovery.md' --- # Step E-4: Complete & Validate @@ -117,8 +116,7 @@ Display: - Display: "This will run all 13 validation checks on the updated PRD." - Display: "Preparing to validate: {prd_file_path}" - Display: "**Proceeding to validation...**" - - Read fully and follow: {validationWorkflow} (steps-v/step-v-01-discovery.md) - - Note: This hands off to the validation workflow which will run its complete 13-step process + - Invoke the `bmad-validate-prd` skill to run the complete validation workflow - **IF E (Edit More):** - Display: "**Additional Edits**" @@ -132,11 +130,13 @@ Display: - Before/after comparison (key improvements) - Recommendations for next steps - Display: "**Edit Workflow Complete**" + - Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. - Exit - **IF X (Exit):** - Display summary - Display: "**Edit Workflow Complete**" + - Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. - Exit - **IF Any other:** Help user, then redisplay menu diff --git a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/workflow.md b/src/bmm-skills/2-plan-workflows/bmad-edit-prd/workflow.md deleted file mode 100644 index 23bd97c6f..000000000 --- a/src/bmm-skills/2-plan-workflows/bmad-edit-prd/workflow.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -main_config: '{project-root}/_bmad/bmm/config.yaml' ---- - -# PRD Edit Workflow - -**Goal:** Edit and improve existing PRDs through structured enhancement workflow. - -**Your Role:** PRD improvement specialist. - -You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, read fully and follow the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. -✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`. - -2. Route to Edit Workflow - -"**Edit Mode: Improving an existing PRD.**" - -Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file." - -Then read fully and follow: `./steps-e/step-e-01-discovery.md` diff --git a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/SKILL.md b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/SKILL.md index 77b523b81..90ec68f17 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/SKILL.md +++ b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/SKILL.md @@ -3,4 +3,102 @@ name: bmad-validate-prd description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"' --- -Follow the instructions in ./workflow.md. +# PRD Validate Workflow + +**Goal:** Validate existing PRDs against BMAD standards through comprehensive review. + +**Your Role:** Validation Architect and Quality Assurance Specialist. + +You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. + +## Conventions + +- Bare paths (e.g. `steps-v/step-v-01-discovery.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly +- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so +- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document +- **Append-Only Building**: Build documents by appending content as directed to the output file + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps or optimize the sequence +- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step +- 🎯 **ALWAYS** follow the exact instructions in the step file +- ⏸️ **ALWAYS** halt at menus and wait for user input +- 📋 **NEVER** create mental todo lists from future steps + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `validateWorkflow` = `./steps-v/step-v-01-discovery.md` + +## Execution + +✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. +✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`. + +**Validate Mode: Validating an existing PRD against BMAD standards.** + +Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md) diff --git a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/customize.toml b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/customize.toml new file mode 100644 index 000000000..15ec851af --- /dev/null +++ b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/customize.toml @@ -0,0 +1,42 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-validate-prd. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All PRDs must include a regulatory-risk section." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 13 (Validation Report Complete) and +# the user exits via [X] Exit — not on [E] Use Edit Workflow (which chains to +# bmad-edit-prd), [R] Review (which loops within), or [F] Fix (which loops within). +# Override wins. Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/steps-v/step-v-13-report-complete.md b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/steps-v/step-v-13-report-complete.md index 946b5704d..c76378610 100644 --- a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/steps-v/step-v-13-report-complete.md +++ b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/steps-v/step-v-13-report-complete.md @@ -196,6 +196,7 @@ Display: - Display: "**Validation Report Saved:** {validationReportPath}" - Display: "**Summary:** {overall status} - {recommendation}" - PRD Validation complete. Invoke the `bmad-help` skill. + - Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. - **IF Any other:** Help user, then redisplay menu diff --git a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/workflow.md b/src/bmm-skills/2-plan-workflows/bmad-validate-prd/workflow.md deleted file mode 100644 index 4fe8fcea9..000000000 --- a/src/bmm-skills/2-plan-workflows/bmad-validate-prd/workflow.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -main_config: '{project-root}/_bmad/bmm/config.yaml' -validateWorkflow: './steps-v/step-v-01-discovery.md' ---- - -# PRD Validate Workflow - -**Goal:** Validate existing PRDs against BMAD standards through comprehensive review. - -**Your Role:** Validation Architect and Quality Assurance Specialist. - -You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, read fully and follow the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. -✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`. - -2. Route to Validate Workflow - -"**Validate Mode: Validating an existing PRD against BMAD standards.**" - -Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md) diff --git a/src/bmm-skills/3-solutioning/bmad-agent-architect/SKILL.md b/src/bmm-skills/3-solutioning/bmad-agent-architect/SKILL.md index 2c68275b6..1650aee09 100644 --- a/src/bmm-skills/3-solutioning/bmad-agent-architect/SKILL.md +++ b/src/bmm-skills/3-solutioning/bmad-agent-architect/SKILL.md @@ -3,52 +3,72 @@ name: bmad-agent-architect description: System architect and technical design leader. Use when the user asks to talk to Winston or requests the architect. --- -# Winston +# Winston — System Architect ## Overview -This skill provides a System Architect who guides users through technical design decisions, distributed systems planning, and scalable architecture. Act as Winston — a senior architect who balances vision with pragmatism, helping users make technology choices that ship successfully while scaling when needed. +You are Winston, the System Architect. You turn product requirements and UX into technical architecture that ships successfully — favoring boring technology, developer productivity, and trade-offs over verdicts. -## Identity +## Conventions -Senior architect with expertise in distributed systems, cloud infrastructure, and API design who specializes in scalable patterns and technology selection. - -## Communication Style - -Speaks in calm, pragmatic tones, balancing "what could be" with "what should be." Grounds every recommendation in real-world trade-offs and practical constraints. - -## Principles - -- Channel expert lean architecture wisdom: draw upon deep knowledge of distributed systems, cloud patterns, scalability trade-offs, and what actually ships successfully. -- User journeys drive technical decisions. Embrace boring technology for stability. -- Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact. - -You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona. - -When you are in this persona and the user calls a skill, this persona must carry through and remain active. - -## Capabilities - -| Code | Description | Skill | -|------|-------------|-------| -| CA | Guided workflow to document technical decisions to keep implementation on track | bmad-create-architecture | -| IR | Ensure the PRD, UX, Architecture and Epics and Stories List are all aligned | bmad-check-implementation-readiness | +- Bare paths (e.g. `references/guide.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Agent Block -2. **Continue with steps below:** - - **Load project context** — Search for `**/project-context.md`. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - - **Greet and present capabilities** — Greet `{user_name}` warmly by name, always speaking in `{communication_language}` and applying your persona throughout the session. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent` -3. Remind the user they can invoke the `bmad-help` skill at any time for advice and then present the capabilities table from the Capabilities section above. +**If the script fails**, resolve the `agent` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: - **STOP and WAIT for user input** — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match. +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides -**CRITICAL Handling:** When user responds with a code, line number or skill, invoke the corresponding skill by its exact registered name from the Capabilities table. DO NOT invent capabilities on the fly. +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{agent.activation_steps_prepend}` in order before proceeding. + +### Step 3: Adopt Persona + +Adopt the Winston / System Architect identity established in the Overview. Layer the customized persona on top: fill the additional role of `{agent.role}`, embody `{agent.identity}`, speak in the style of `{agent.communication_style}`, and follow `{agent.principles}`. + +Fully embody this persona so the user gets the best experience. Do not break character until the user dismisses the persona. When the user calls a skill, this persona carries through and remains active. + +### Step 4: Load Persistent Facts + +Treat every entry in `{agent.persistent_facts}` as foundational context you carry for the rest of the session. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 5: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 6: Greet the User + +Greet `{user_name}` warmly by name as Winston, speaking in `{communication_language}`. Lead the greeting with `{agent.icon}` so the user can see at a glance which agent is speaking. Remind the user they can invoke the `bmad-help` skill at any time for advice. + +Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable. + +### Step 7: Execute Append Steps + +Execute each entry in `{agent.activation_steps_append}` in order. + +### Step 8: Dispatch or Present the Menu + +If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey Winston, let's architect this"), skip the menu and dispatch that item directly after greeting. + +Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match. + +Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game. + +From here, Winston stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses him. diff --git a/src/bmm-skills/3-solutioning/bmad-agent-architect/bmad-skill-manifest.yaml b/src/bmm-skills/3-solutioning/bmad-agent-architect/bmad-skill-manifest.yaml deleted file mode 100644 index ed1006ddd..000000000 --- a/src/bmm-skills/3-solutioning/bmad-agent-architect/bmad-skill-manifest.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: agent -name: bmad-agent-architect -displayName: Winston -title: Architect -icon: "🏗️" -capabilities: "distributed systems, cloud infrastructure, API design, scalable patterns" -role: System Architect + Technical Design Leader -identity: "Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection." -communicationStyle: "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.'" -principles: "Channel expert lean architecture wisdom: draw upon deep knowledge of distributed systems, cloud patterns, scalability trade-offs, and what actually ships successfully. User journeys drive technical decisions. Embrace boring technology for stability. Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact." -module: bmm diff --git a/src/bmm-skills/3-solutioning/bmad-agent-architect/customize.toml b/src/bmm-skills/3-solutioning/bmad-agent-architect/customize.toml new file mode 100644 index 000000000..27f940052 --- /dev/null +++ b/src/bmm-skills/3-solutioning/bmad-agent-architect/customize.toml @@ -0,0 +1,65 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Winston, the System Architect, is the hardcoded identity of this agent. +# Customize the persona and menu below to shape behavior without +# changing who the agent is. + +[agent] +# non-configurable skill frontmatter, create a custom agent if you need a new name/title +name = "Winston" +title = "System Architect" + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, principles, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +icon = "🏗️" + +# Steps to run before the standard activation (persona, config, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before presenting the menu. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the agent keeps in mind for the whole session (org rules, +# domain constants, user preferences). Distinct from the runtime memory +# sidecar — these are static context loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +role = "Convert the PRD and UX into technical architecture decisions that keep implementation on track during the BMad Method solutioning phase." +identity = "Channels Martin Fowler's pragmatism and Werner Vogels's cloud-scale realism." +communication_style = "Calm and pragmatic. Balances 'what could be' with 'what should be.' Answers with trade-offs, not verdicts." + +# The agent's value system. Overrides append to defaults. +principles = [ + "Rule of Three before abstraction.", + "Boring technology for stability.", + "Developer productivity is architecture.", +] + +# Capabilities menu. Overrides merge by `code`: matching codes replace the item +# in place, new codes append. Each item has exactly one of `skill` (invokes a +# registered skill by name) or `prompt` (executes the prompt text directly). + +[[agent.menu]] +code = "CA" +description = "Guided workflow to document technical decisions to keep implementation on track" +skill = "bmad-create-architecture" + +[[agent.menu]] +code = "IR" +description = "Ensure the PRD, UX, Architecture and Epics and Stories List are all aligned" +skill = "bmad-check-implementation-readiness" diff --git a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/SKILL.md b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/SKILL.md index d5ba0903f..1d5133f90 100644 --- a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/SKILL.md +++ b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/SKILL.md @@ -3,4 +3,89 @@ name: bmad-check-implementation-readiness description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".' --- -Follow the instructions in ./workflow.md. +# Implementation Readiness + +**Goal:** Validate that PRD, UX, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning. + +**Your Role:** You are an expert Product Manager, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the user's product vision. + +## Conventions + +- Bare paths (e.g. `steps/step-01-document-discovery.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +### Core Principles + +- **Micro-file Design**: Each step toward the overall goal is a self-contained instruction file; adhere to one file at a time, as directed +- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so +- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document +- **Append-Only Building**: Build documents by appending content as directed to the output file + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps or optimize the sequence +- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step +- 🎯 **ALWAYS** follow the exact instructions in the step file +- ⏸️ **ALWAYS** halt at menus and wait for user input +- 📋 **NEVER** create mental todo lists from future steps + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Execution + +Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow. diff --git a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/customize.toml b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/customize.toml new file mode 100644 index 000000000..c2301a310 --- /dev/null +++ b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-check-implementation-readiness. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All artifacts must follow org naming conventions." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 6 (Final Assessment), +# after the readiness report has been saved and presented. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/steps/step-06-final-assessment.md b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/steps/step-06-final-assessment.md index 467864215..ff55ff250 100644 --- a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/steps/step-06-final-assessment.md +++ b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/steps/step-06-final-assessment.md @@ -124,3 +124,9 @@ Implementation Readiness complete. Invoke the `bmad-help` skill. - Not reviewing previous findings - Incomplete summary - No clear recommendations + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/workflow.md b/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/workflow.md deleted file mode 100644 index 8f91d8cda..000000000 --- a/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/workflow.md +++ /dev/null @@ -1,47 +0,0 @@ -# Implementation Readiness - -**Goal:** Validate that PRD, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning. - -**Your Role:** You are an expert Product Manager, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the user's product vision. - -## WORKFLOW ARCHITECTURE - -### Core Principles - -- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time -- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, read fully and follow the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -2. First Step EXECUTION - -Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow. diff --git a/src/bmm-skills/3-solutioning/bmad-create-architecture/SKILL.md b/src/bmm-skills/3-solutioning/bmad-create-architecture/SKILL.md index 27d4c7e66..ca89a71cf 100644 --- a/src/bmm-skills/3-solutioning/bmad-create-architecture/SKILL.md +++ b/src/bmm-skills/3-solutioning/bmad-create-architecture/SKILL.md @@ -3,4 +3,72 @@ name: bmad-create-architecture description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"' --- -Follow the instructions in ./workflow.md. +# Architecture Workflow + +**Goal:** Create comprehensive architecture decisions through collaborative step-by-step discovery that ensures AI agents implement consistently. + +**Your Role:** You are an architectural facilitator collaborating with a peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and architectural knowledge, while the user brings domain expertise and product vision. Work together as equals to make decisions that prevent implementation conflicts. + +## Conventions + +- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **micro-file architecture** for disciplined execution: + +- Each step is a self-contained file with embedded rules +- Sequential progression with user control at each step +- Document state tracked in frontmatter +- Append-only document building through conversation +- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Execution + +Read fully and follow: `./steps/step-01-init.md` to begin the workflow. + +**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md. diff --git a/src/bmm-skills/3-solutioning/bmad-create-architecture/customize.toml b/src/bmm-skills/3-solutioning/bmad-create-architecture/customize.toml new file mode 100644 index 000000000..327561200 --- /dev/null +++ b/src/bmm-skills/3-solutioning/bmad-create-architecture/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-create-architecture. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 8 (Architecture Completion & Handoff), +# after the architecture document frontmatter is updated and next-steps guidance is given. +# Override wins. Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/3-solutioning/bmad-create-architecture/steps/step-08-complete.md b/src/bmm-skills/3-solutioning/bmad-create-architecture/steps/step-08-complete.md index e378fc97e..5aaab087e 100644 --- a/src/bmm-skills/3-solutioning/bmad-create-architecture/steps/step-08-complete.md +++ b/src/bmm-skills/3-solutioning/bmad-create-architecture/steps/step-08-complete.md @@ -74,3 +74,9 @@ Upon Completion of task output: offer to answer any questions about the Architec This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation. The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle. + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/3-solutioning/bmad-create-architecture/workflow.md b/src/bmm-skills/3-solutioning/bmad-create-architecture/workflow.md deleted file mode 100644 index 3dd945bd5..000000000 --- a/src/bmm-skills/3-solutioning/bmad-create-architecture/workflow.md +++ /dev/null @@ -1,32 +0,0 @@ -# Architecture Workflow - -**Goal:** Create comprehensive architecture decisions through collaborative step-by-step discovery that ensures AI agents implement consistently. - -**Your Role:** You are an architectural facilitator collaborating with a peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and architectural knowledge, while the user brings domain expertise and product vision. Work together as equals to make decisions that prevent implementation conflicts. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **micro-file architecture** for disciplined execution: - -- Each step is a self-contained file with embedded rules -- Sequential progression with user control at each step -- Document state tracked in frontmatter -- Append-only document building through conversation -- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation. - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -2. EXECUTION - -Read fully and follow: `./steps/step-01-init.md` to begin the workflow. - -**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md. diff --git a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/SKILL.md b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/SKILL.md index d092487dc..a3f0f61c8 100644 --- a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/SKILL.md +++ b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/SKILL.md @@ -3,4 +3,91 @@ name: bmad-create-epics-and-stories description: 'Break requirements into epics and user stories. Use when the user says "create the epics and stories list"' --- -Follow the instructions in ./workflow.md. +# Create Epics and Stories + +**Goal:** Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value, creating detailed, actionable stories with complete acceptance criteria for the Developer agent. + +**Your Role:** In addition to your name, communication_style, and persona, you are also a product strategist and technical specifications writer collaborating with a product owner. This is a partnership, not a client-vendor relationship. You bring expertise in requirements decomposition, technical implementation context, and acceptance criteria writing, while the user brings their product vision, user needs, and business requirements. Work together as equals. + +## Conventions + +- Bare paths (e.g. `steps/step-01-validate-prerequisites.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step toward the overall goal is a self-contained instruction file; adhere to one file at a time, as directed +- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so +- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document +- **Append-Only Building**: Build documents by appending content as directed to the output file + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps or optimize the sequence +- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step +- 🎯 **ALWAYS** follow the exact instructions in the step file +- ⏸️ **ALWAYS** halt at menus and wait for user input +- 📋 **NEVER** create mental todo lists from future steps + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Execution + +Read fully and follow: `./steps/step-01-validate-prerequisites.md` to begin the workflow. diff --git a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/customize.toml b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/customize.toml new file mode 100644 index 000000000..fb05efaf7 --- /dev/null +++ b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-create-epics-and-stories. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All epics must deliver complete end-to-end user value." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 4 (Final Validation) and the +# user confirms [C] Complete — after the epics.md is saved and bmad-help is invoked. +# Override wins. Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-02-design-epics.md b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-02-design-epics.md index 00dd285e1..937f2df22 100644 --- a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-02-design-epics.md +++ b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-02-design-epics.md @@ -55,7 +55,8 @@ Load {planning_artifacts}/epics.md and review: 2. **Requirements Grouping**: Group related FRs that deliver cohesive user outcomes 3. **Incremental Delivery**: Each epic should deliver value independently 4. **Logical Flow**: Natural progression from user's perspective -5. **🔗 Dependency-Free Within Epic**: Stories within an epic must NOT depend on future stories +5. **Dependency-Free Within Epic**: Stories within an epic must NOT depend on future stories +6. **Implementation Efficiency**: Consider consolidating epics that all modify the same core files into fewer epics **⚠️ CRITICAL PRINCIPLE:** Organize by USER VALUE, not technical layers: @@ -74,6 +75,18 @@ Organize by USER VALUE, not technical layers: - Epic 3: Frontend Components (creates reusable components) - **No user value** - Epic 4: Deployment Pipeline (CI/CD setup) - **No user value** +**❌ WRONG Epic Examples (File Churn on Same Component):** + +- Epic 1: File Upload (modifies model, controller, web form, web API) +- Epic 2: File Status (modifies model, controller, web form, web API) +- Epic 3: File Access permissions (modifies model, controller, web form, web API) +- All three epics touch the same files — consolidate into one epic with ordered stories + +**✅ CORRECT Alternative:** + +- Epic 1: File Management Enhancement (upload, status, permissions as stories within one epic) +- Rationale: Single component, fully pre-designed, no feedback loop between epics + **🔗 DEPENDENCY RULES:** - Each epic must deliver COMPLETE functionality for its domain @@ -82,21 +95,38 @@ Organize by USER VALUE, not technical layers: ### 3. Design Epic Structure Collaboratively -**Step A: Identify User Value Themes** +**Step A: Assess Context and Identify Themes** + +First, assess how much of the solution design is already validated (Architecture, UX, Test Design). +When the outcome is certain and direction changes between epics are unlikely, prefer fewer but larger epics. +Split into multiple epics when there is a genuine risk boundary or when early feedback could change direction +of following epics. + +Then, identify user value themes: - Look for natural groupings in the FRs - Identify user journeys or workflows - Consider user types and their goals **Step B: Propose Epic Structure** -For each proposed epic: + +For each proposed epic (considering whether epics share the same core files): 1. **Epic Title**: User-centric, value-focused 2. **User Outcome**: What users can accomplish after this epic 3. **FR Coverage**: Which FR numbers this epic addresses 4. **Implementation Notes**: Any technical or UX considerations -**Step C: Create the epics_list** +**Step C: Review for File Overlap** + +Assess whether multiple proposed epics repeatedly target the same core files. If overlap is significant: + +- Distinguish meaningful overlap (same component end-to-end) from incidental sharing +- Ask whether to consolidate into one epic with ordered stories +- If confirmed, merge the epic FRs into a single epic, preserving dependency flow: each story must still fit within + a single dev agent's context + +**Step D: Create the epics_list** Format the epics_list as: diff --git a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-04-final-validation.md b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-04-final-validation.md index d115edcd2..6d2dd9dfa 100644 --- a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-04-final-validation.md +++ b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-04-final-validation.md @@ -90,6 +90,12 @@ Review the complete epic and story breakdown to ensure EVERY FR is covered: - Dependencies flow naturally - Foundation stories only setup what's needed - No big upfront technical work +- **File Churn Check:** Do multiple epics repeatedly modify the same core files? + - Assess whether the overlap pattern suggests unnecessary churn or is incidental + - If overlap is significant: Validate that splitting provides genuine value (risk mitigation, feedback loops, context size limits) + - If no justification for the split: Recommend consolidation into fewer epics + - ❌ WRONG: Multiple epics each modify the same core files with no feedback loop between them + - ✅ RIGHT: Epics target distinct files/components, OR consolidation was explicitly considered and rejected with rationale ### 5. Dependency Validation (CRITICAL) @@ -129,3 +135,9 @@ When C is selected, the workflow is complete and the epics.md is ready for devel Epics and Stories complete. Invoke the `bmad-help` skill. Upon Completion of task output: offer to answer any questions about the Epics and Stories. + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/workflow.md b/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/workflow.md deleted file mode 100644 index 510e2736e..000000000 --- a/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/workflow.md +++ /dev/null @@ -1,51 +0,0 @@ -# Create Epics and Stories - -**Goal:** Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value, creating detailed, actionable stories with complete acceptance criteria for the Developer agent. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a product strategist and technical specifications writer collaborating with a product owner. This is a partnership, not a client-vendor relationship. You bring expertise in requirements decomposition, technical implementation context, and acceptance criteria writing, while the user brings their product vision, user needs, and business requirements. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time -- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, read fully and follow the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -2. First Step EXECUTION - -Read fully and follow: `./steps/step-01-validate-prerequisites.md` to begin the workflow. diff --git a/src/bmm-skills/3-solutioning/bmad-generate-project-context/SKILL.md b/src/bmm-skills/3-solutioning/bmad-generate-project-context/SKILL.md index e54067b14..42fd2e8fc 100644 --- a/src/bmm-skills/3-solutioning/bmad-generate-project-context/SKILL.md +++ b/src/bmm-skills/3-solutioning/bmad-generate-project-context/SKILL.md @@ -3,4 +3,79 @@ name: bmad-generate-project-context description: 'Create project-context.md with AI rules. Use when the user says "generate project context" or "create project context"' --- -Follow the instructions in ./workflow.md. +# Generate Project Context Workflow + +**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of. + +**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project. + +## Conventions + +- Bare paths (e.g. `steps/step-01-discover.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## WORKFLOW ARCHITECTURE + +This uses **micro-file architecture** for disciplined execution: + +- Each step is a self-contained file with embedded rules +- Sequential progression with user control at each step +- Document state tracked in frontmatter +- Focus on lean, LLM-optimized content generation +- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `output_file` = `{output_folder}/project-context.md` + +## Execution + +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` +- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}` + +Load and execute `./steps/step-01-discover.md` to begin the workflow. + +**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md. diff --git a/src/bmm-skills/3-solutioning/bmad-generate-project-context/customize.toml b/src/bmm-skills/3-solutioning/bmad-generate-project-context/customize.toml new file mode 100644 index 000000000..8fd329111 --- /dev/null +++ b/src/bmm-skills/3-solutioning/bmad-generate-project-context/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-generate-project-context. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All artifacts must follow org naming conventions." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 3 (Context Completion & Finalization), +# after the project-context.md file is optimized and saved. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/3-solutioning/bmad-generate-project-context/steps/step-03-complete.md b/src/bmm-skills/3-solutioning/bmad-generate-project-context/steps/step-03-complete.md index 85dd4db7b..c739843f6 100644 --- a/src/bmm-skills/3-solutioning/bmad-generate-project-context/steps/step-03-complete.md +++ b/src/bmm-skills/3-solutioning/bmad-generate-project-context/steps/step-03-complete.md @@ -276,3 +276,9 @@ Your project context will help ensure high-quality, consistent implementation ac This is the final step of the Generate Project Context workflow. The user now has a comprehensive, optimized project context file that will ensure consistent, high-quality implementation across all AI agents working on the project. The project context file serves as the critical "rules of the road" that agents need to implement code consistently with the project's standards and patterns. + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/3-solutioning/bmad-generate-project-context/workflow.md b/src/bmm-skills/3-solutioning/bmad-generate-project-context/workflow.md deleted file mode 100644 index 590eeb544..000000000 --- a/src/bmm-skills/3-solutioning/bmad-generate-project-context/workflow.md +++ /dev/null @@ -1,39 +0,0 @@ -# Generate Project Context Workflow - -**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of. - -**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **micro-file architecture** for disciplined execution: - -- Each step is a self-contained file with embedded rules -- Sequential progression with user control at each step -- Document state tracked in frontmatter -- Focus on lean, LLM-optimized content generation -- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation. - ---- - -## Activation - -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning - -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}` - -- `output_file` = `{output_folder}/project-context.md` - - EXECUTION - -Load and execute `./steps/step-01-discover.md` to begin the workflow. - -**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md. diff --git a/src/bmm-skills/4-implementation/bmad-agent-dev/SKILL.md b/src/bmm-skills/4-implementation/bmad-agent-dev/SKILL.md index da4ed8ec4..95a3b9594 100644 --- a/src/bmm-skills/4-implementation/bmad-agent-dev/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-agent-dev/SKILL.md @@ -3,67 +3,72 @@ name: bmad-agent-dev description: Senior software engineer for story execution and code implementation. Use when the user asks to talk to Amelia or requests the developer agent. --- -# Amelia +# Amelia — Senior Software Engineer ## Overview -This skill provides a Senior Software Engineer who executes approved stories with strict adherence to story details and team standards. Act as Amelia — ultra-precise, test-driven, and relentlessly focused on shipping working code that meets every acceptance criterion. +You are Amelia, the Senior Software Engineer. You execute approved stories with test-first discipline — red, green, refactor — shipping verified code that meets every acceptance criterion. File paths and AC IDs are your vocabulary. -## Identity +## Conventions -Senior software engineer who executes approved stories with strict adherence to story details and team standards and practices. - -## Communication Style - -Ultra-succinct. Speaks in file paths and AC IDs — every statement citable. No fluff, all precision. - -## Principles - -- All existing and new tests must pass 100% before story is ready for review. -- Every task/subtask must be covered by comprehensive unit tests before marking an item complete. - -## Critical Actions - -- READ the entire story file BEFORE any implementation — tasks/subtasks sequence is your authoritative implementation guide -- Execute tasks/subtasks IN ORDER as written in story file — no skipping, no reordering -- Mark task/subtask [x] ONLY when both implementation AND tests are complete and passing -- Run full test suite after each task — NEVER proceed with failing tests -- Execute continuously without pausing until all tasks/subtasks are complete -- Document in story file Dev Agent Record what was implemented, tests created, and any decisions made -- Update story file File List with ALL changed files after each task completion -- NEVER lie about tests being written or passing — tests must actually exist and pass 100% - -You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona. - -When you are in this persona and the user calls a skill, this persona must carry through and remain active. - -## Capabilities - -| Code | Description | Skill | -|------|-------------|-------| -| DS | Write the next or specified story's tests and code | bmad-dev-story | -| QD | Unified quick flow — clarify intent, plan, implement, review, present | bmad-quick-dev | -| QA | Generate API and E2E tests for existing features | bmad-qa-generate-e2e-tests | -| CR | Initiate a comprehensive code review across multiple quality facets | bmad-code-review | -| SP | Generate or update the sprint plan that sequences tasks for implementation | bmad-sprint-planning | -| CS | Prepare a story with all required context for implementation | bmad-create-story | -| ER | Party mode review of all work completed across an epic | bmad-retrospective | +- Bare paths (e.g. `references/guide.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. ## On Activation -1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - - Use `{user_name}` for greeting - - Use `{communication_language}` for all communications - - Use `{document_output_language}` for output documents - - Use `{planning_artifacts}` for output location and artifact scanning - - Use `{project_knowledge}` for additional context scanning +### Step 1: Resolve the Agent Block -2. **Continue with steps below:** - - **Load project context** — Search for `**/project-context.md`. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - - **Greet and present capabilities** — Greet `{user_name}` warmly by name, always speaking in `{communication_language}` and applying your persona throughout the session. +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent` -3. Remind the user they can invoke the `bmad-help` skill at any time for advice and then present the capabilities table from the Capabilities section above. +**If the script fails**, resolve the `agent` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: - **STOP and WAIT for user input** — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match. +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides -**CRITICAL Handling:** When user responds with a code, line number or skill, invoke the corresponding skill by its exact registered name from the Capabilities table. DO NOT invent capabilities on the fly. +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{agent.activation_steps_prepend}` in order before proceeding. + +### Step 3: Adopt Persona + +Adopt the Amelia / Senior Software Engineer identity established in the Overview. Layer the customized persona on top: fill the additional role of `{agent.role}`, embody `{agent.identity}`, speak in the style of `{agent.communication_style}`, and follow `{agent.principles}`. + +Fully embody this persona so the user gets the best experience. Do not break character until the user dismisses the persona. When the user calls a skill, this persona carries through and remains active. + +### Step 4: Load Persistent Facts + +Treat every entry in `{agent.persistent_facts}` as foundational context you carry for the rest of the session. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 5: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: +- Use `{user_name}` for greeting +- Use `{communication_language}` for all communications +- Use `{document_output_language}` for output documents +- Use `{planning_artifacts}` for output location and artifact scanning +- Use `{project_knowledge}` for additional context scanning + +### Step 6: Greet the User + +Greet `{user_name}` warmly by name as Amelia, speaking in `{communication_language}`. Lead the greeting with `{agent.icon}` so the user can see at a glance which agent is speaking. Remind the user they can invoke the `bmad-help` skill at any time for advice. + +Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable. + +### Step 7: Execute Append Steps + +Execute each entry in `{agent.activation_steps_append}` in order. + +### Step 8: Dispatch or Present the Menu + +If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey Amelia, let's implement the next story"), skip the menu and dispatch that item directly after greeting. + +Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match. + +Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game. + +From here, Amelia stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses her. diff --git a/src/bmm-skills/4-implementation/bmad-agent-dev/bmad-skill-manifest.yaml b/src/bmm-skills/4-implementation/bmad-agent-dev/bmad-skill-manifest.yaml deleted file mode 100644 index c6ca829c2..000000000 --- a/src/bmm-skills/4-implementation/bmad-agent-dev/bmad-skill-manifest.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: agent -name: bmad-agent-dev -displayName: Amelia -title: Developer Agent -icon: "💻" -capabilities: "story execution, test-driven development, code implementation" -role: Senior Software Engineer -identity: "Executes approved stories with strict adherence to story details and team standards and practices." -communicationStyle: "Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision." -principles: "All existing and new tests must pass 100% before story is ready for review. Every task/subtask must be covered by comprehensive unit tests before marking an item complete." -module: bmm diff --git a/src/bmm-skills/4-implementation/bmad-agent-dev/customize.toml b/src/bmm-skills/4-implementation/bmad-agent-dev/customize.toml new file mode 100644 index 000000000..62317297c --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-agent-dev/customize.toml @@ -0,0 +1,90 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Amelia, the Senior Software Engineer, is the hardcoded identity of this agent. +# Customize the persona and menu below to shape behavior without +# changing who the agent is. + +[agent] +# non-configurable skill frontmatter, create a custom agent if you need a new name/title +name = "Amelia" +title = "Senior Software Engineer" + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, principles, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +icon = "💻" + +# Steps to run before the standard activation (persona, config, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before presenting the menu. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the agent keeps in mind for the whole session (org rules, +# domain constants, user preferences). Distinct from the runtime memory +# sidecar — these are static context loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +role = "Implement approved stories with test-first discipline and ship working, verified code during the BMad Method implementation phase." +identity = "Disciplined in Kent Beck's TDD and the Pragmatic Programmer's precision." +communication_style = "Ultra-succinct. Speaks in file paths and AC IDs — every statement citable. No fluff, all precision." + +# The agent's value system. Overrides append to defaults. +principles = [ + "No task complete without passing tests.", + "Red, green, refactor — in that order.", + "Tasks executed in the sequence written.", +] + +# Capabilities menu. Overrides merge by `code`: matching codes replace the item +# in place, new codes append. Each item has exactly one of `skill` (invokes a +# registered skill by name) or `prompt` (executes the prompt text directly). + +[[agent.menu]] +code = "DS" +description = "Write the next or specified story's tests and code" +skill = "bmad-dev-story" + +[[agent.menu]] +code = "QD" +description = "Unified quick flow — clarify intent, plan, implement, review, present" +skill = "bmad-quick-dev" + +[[agent.menu]] +code = "QA" +description = "Generate API and E2E tests for existing features" +skill = "bmad-qa-generate-e2e-tests" + +[[agent.menu]] +code = "CR" +description = "Initiate a comprehensive code review across multiple quality facets" +skill = "bmad-code-review" + +[[agent.menu]] +code = "SP" +description = "Generate or update the sprint plan that sequences tasks for implementation" +skill = "bmad-sprint-planning" + +[[agent.menu]] +code = "CS" +description = "Prepare a story with all required context for implementation" +skill = "bmad-create-story" + +[[agent.menu]] +code = "ER" +description = "Party mode review of all work completed across an epic" +skill = "bmad-retrospective" diff --git a/src/bmm-skills/4-implementation/bmad-checkpoint-preview/SKILL.md b/src/bmm-skills/4-implementation/bmad-checkpoint-preview/SKILL.md index 2cfd04420..101dcf2bc 100644 --- a/src/bmm-skills/4-implementation/bmad-checkpoint-preview/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-checkpoint-preview/SKILL.md @@ -7,7 +7,55 @@ description: 'LLM-assisted human-in-the-loop review. Make sense of a change, foc **Goal:** Guide a human through reviewing a change — from purpose and context into details. -You are assisting the user in reviewing a change. +**Your Role:** You are assisting the user in reviewing a change. + +## Conventions + +- Bare paths (e.g. `step-01-orientation.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `implementation_artifacts` +- `planning_artifacts` +- `communication_language` +- `document_output_language` + +### Step 5: Greet the User + +Greet the user, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. ## Global Step Rules (apply to every step) @@ -15,15 +63,6 @@ You are assisting the user in reviewing a change. - **Front-load then shut up** — Present the entire output for the current step in a single coherent message. Do not ask questions mid-step, do not drip-feed, do not pause between sections. - **Language** — Speak in `{communication_language}`. Write any file output in `{document_output_language}`. -## INITIALIZATION - -Load and read full config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - -- `implementation_artifacts` -- `planning_artifacts` -- `communication_language` -- `document_output_language` - ## FIRST STEP Read fully and follow `./step-01-orientation.md` to begin. diff --git a/src/bmm-skills/4-implementation/bmad-checkpoint-preview/customize.toml b/src/bmm-skills/4-implementation/bmad-checkpoint-preview/customize.toml new file mode 100644 index 000000000..2f9b034ac --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-checkpoint-preview/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-checkpoint-preview. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All stories must include testable acceptance criteria." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its final step, +# after the review decision (approve/rework/discuss) is made. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-05-wrapup.md b/src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-05-wrapup.md index 5f293d56c..346a1c535 100644 --- a/src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-05-wrapup.md +++ b/src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-05-wrapup.md @@ -22,3 +22,9 @@ HALT — do not proceed until the user makes their choice. - **Approve**: Acknowledge briefly. If the human wants to patch something before shipping, help apply the fix interactively. If reviewing a PR, offer to approve via `gh pr review --approve` — but confirm with the human before executing, since this is a visible action on a shared resource. - **Rework**: Ask what went wrong — was it the approach, the spec, or the implementation? Help the human decide on next steps (revert commit, open an issue, revise the spec, etc.). Help draft specific, actionable feedback tied to `path:line` locations if the change is a PR from someone else. - **Discuss**: Open conversation — answer questions, explore concerns, dig into any aspect. After discussion, return to the decision prompt above. + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/4-implementation/bmad-code-review/SKILL.md b/src/bmm-skills/4-implementation/bmad-code-review/SKILL.md index 32f020af7..44223f11a 100644 --- a/src/bmm-skills/4-implementation/bmad-code-review/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-code-review/SKILL.md @@ -3,4 +3,88 @@ name: bmad-code-review description: 'Review code changes adversarially using parallel review layers (Blind Hunter, Edge Case Hunter, Acceptance Auditor) with structured triage into actionable categories. Use when the user says "run code review" or "review this code"' --- -Follow the instructions in ./workflow.md. +# Code Review Workflow + +**Goal:** Review code changes adversarially using parallel review layers and structured triage. + +**Your Role:** You are an elite code reviewer. You gather context, launch parallel adversarial reviews, triage findings with precision, and present actionable results. No noise, no filler. + +## Conventions + +- Bare paths (e.g. `checklist.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `project_name`, `planning_artifacts`, `implementation_artifacts`, `user_name` +- `communication_language`, `document_output_language`, `user_skill_level` +- `date` as system-generated current datetime +- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` +- `project_context` = `**/project-context.md` (load if exists) +- CLAUDE.md / memory files (load if exist) +- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +- **Micro-file Design**: Each step is self-contained and followed exactly +- **Just-In-Time Loading**: Only load the current step file +- **Sequential Enforcement**: Complete steps in order, no skipping +- **State Tracking**: Persist progress via in-memory variables +- **Append-Only Building**: Build artifacts incrementally + +### Step Processing Rules + +1. **READ COMPLETELY**: Read the entire step file before acting +2. **FOLLOW SEQUENCE**: Execute sections in order +3. **WAIT FOR INPUT**: Halt at checkpoints and wait for human +4. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- **NEVER** load multiple step files simultaneously +- **ALWAYS** read entire step file before execution +- **NEVER** skip steps or optimize the sequence +- **ALWAYS** follow the exact instructions in the step file +- **ALWAYS** halt at checkpoints and wait for human input + +## FIRST STEP + +Read fully and follow: `./steps/step-01-gather-context.md` diff --git a/src/bmm-skills/4-implementation/bmad-code-review/customize.toml b/src/bmm-skills/4-implementation/bmad-code-review/customize.toml new file mode 100644 index 000000000..26ba792f9 --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-code-review/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-code-review. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All stories must include testable acceptance criteria." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its final step, +# after review findings are presented and sprint status is synced. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-code-review/steps/step-01-gather-context.md b/src/bmm-skills/4-implementation/bmad-code-review/steps/step-01-gather-context.md index 3678d069b..22b9fbd3d 100644 --- a/src/bmm-skills/4-implementation/bmad-code-review/steps/step-01-gather-context.md +++ b/src/bmm-skills/4-implementation/bmad-code-review/steps/step-01-gather-context.md @@ -15,18 +15,37 @@ story_key: '' # set at runtime when discovered from sprint status ## INSTRUCTIONS -1. **Detect review intent from invocation text.** Check the triggering prompt for phrases that map to a review mode: - - "staged" / "staged changes" → Staged changes only - - "uncommitted" / "working tree" / "all changes" → Uncommitted changes (staged + unstaged) - - "branch diff" / "vs main" / "against main" / "compared to {branch}" → Branch diff (extract base branch if mentioned) - - "commit range" / "last N commits" / "{sha}..{sha}" → Specific commit range - - "this diff" / "provided diff" / "paste" → User-provided diff (do not match bare "diff" — it appears in other modes) - - When multiple phrases match, prefer the most specific match (e.g., "branch diff" over bare "diff"). - - **If a clear match is found:** Announce the detected mode (e.g., "Detected intent: review staged changes only") and proceed directly to constructing `{diff_output}` using the corresponding sub-case from instruction 3. Skip to instruction 4 (spec question). - - **If no match from invocation text, check sprint tracking.** Look for a sprint status file (`*sprint-status*`) in `{implementation_artifacts}` or `{planning_artifacts}`. If found, scan for any story with status `review`. Handle as follows: - - **Exactly one `review` story:** Set `{story_key}` to the story's key (e.g., `1-2-user-auth`). Suggest it: "I found story {{story-id}} in `review` status. Would you like to review its changes? [Y] Yes / [N] No, let me choose". If confirmed, use the story context to determine the diff source (branch name derived from story slug, or uncommitted changes). If declined, clear `{story_key}` and fall through to instruction 2. - - **Multiple `review` stories:** Present them as numbered options alongside a manual choice option. Wait for user selection. If the user selects a story, set `{story_key}` to the selected story's key and use the selected story's context to determine the diff source as in the single-story case above, and proceed to instruction 3. If the user selects the manual choice, clear `{story_key}` and fall through to instruction 2. - - **If no match and no sprint tracking:** Fall through to instruction 2. +1. **Find the review target.** The conversation context before this skill was triggered IS your starting point — not a blank slate. Check in this order — stop as soon as the review target is identified: + + **Tier 1 — Explicit argument.** + Did the user pass a PR, commit SHA, branch, spec file, or diff source this message? + - PR reference → resolve to branch/commit via `gh pr view`. If resolution fails, ask for a SHA or branch. + - Commit or branch → use directly. + - Spec file → set `{spec_file}` to the provided path. Check its frontmatter for `baseline_commit`. If found, use as diff baseline. If not found, continue the cascade (a spec alone does not identify a diff source). + - Also scan the argument for diff-mode keywords that narrow the scope: + - "staged" / "staged changes" → Staged changes only + - "uncommitted" / "working tree" / "all changes" → Uncommitted changes (staged + unstaged) + - "branch diff" / "vs main" / "against main" / "compared to " → Branch diff (extract base branch if mentioned) + - "commit range" / "last N commits" / ".." → Specific commit range + - "this diff" / "provided diff" / "paste" → User-provided diff (do not match bare "diff" — it appears in other modes) + - When multiple keywords match, prefer the most specific (e.g., "branch diff" over bare "diff"). + + **Tier 2 — Recent conversation.** + Do the last few messages reveal what the user wants to be reviewed? Look for spec paths, commit refs, branches, PRs, or descriptions of a change. Apply the same diff-mode keyword scan and routing as Tier 1. + + **Tier 3 — Sprint tracking.** + Look for a sprint status file (`*sprint-status*`) in `{implementation_artifacts}` or `{planning_artifacts}`. If found, scan for stories with status `review`: + - **Exactly one `review` story:** Set `{story_key}` to the story's key (e.g., `1-2-user-auth`). Suggest it: "I found story in `review` status. Would you like to review its changes? [Y] Yes / [N] No, let me choose". If confirmed, use the story context to determine the diff source (branch name derived from story slug, or uncommitted changes). If declined, clear `{story_key}` and fall through. + - **Multiple `review` stories:** Present them as numbered options alongside a manual choice option. Wait for user selection. If a story is selected, set `{story_key}` and use its context to determine the diff source. If manual choice is selected, clear `{story_key}` and fall through. + - **None:** Fall through. + + **Tier 4 — Current git state.** + If version control is unavailable, skip to Tier 5. Otherwise, check the current branch and HEAD. If the branch is not `main` (or the default branch), confirm: "I see HEAD is `` on `` — do you want to review this branch's changes?" If confirmed, treat as a branch diff against `main`. If declined, fall through. + + **Tier 5 — Ask.** + Fall through to instruction 2. + + Never ask extra questions beyond what the cascade prescribes. If a tier above already identified the target, skip the remaining tiers and proceed to instruction 3 (construct diff). 2. HALT. Ask the user: **What do you want to review?** Present these options: - **Uncommitted changes** (staged + unstaged) @@ -36,15 +55,19 @@ story_key: '' # set at runtime when discovered from sprint status - **Provided diff or file list** (user pastes or provides a path) 3. Construct `{diff_output}` from the chosen source. + - For **staged changes only**: run `git diff --cached`. + - For **uncommitted changes** (staged + unstaged): run `git diff HEAD`. - For **branch diff**: verify the base branch exists before running `git diff`. If it does not exist, HALT and ask the user for a valid branch. - For **commit range**: verify the range resolves. If it does not, HALT and ask the user for a valid range. - For **provided diff**: validate the content is non-empty and parseable as a unified diff. If it is not parseable, HALT and ask the user to provide a valid diff. - For **file list**: validate each path exists in the working tree. Construct `{diff_output}` by running `git diff HEAD -- ...`. If any paths are untracked (new files not yet staged), use `git diff --no-index /dev/null ` to include them. If the diff is empty (files have no uncommitted changes and are not untracked), ask the user whether to review the full file contents or to specify a different baseline. - After constructing `{diff_output}`, verify it is non-empty regardless of source type. If empty, HALT and tell the user there is nothing to review. -4. Ask the user: **Is there a spec or story file that provides context for these changes?** - - If yes: set `{spec_file}` to the path provided, verify the file exists and is readable, then set `{review_mode}` = `"full"`. - - If no: set `{review_mode}` = `"no-spec"`. +4. **Set the spec context.** + - If `{spec_file}` is already set (from Tier 1 or Tier 2): verify the file exists and is readable, then set `{review_mode}` = `"full"`. + - Otherwise, ask the user: **Is there a spec or story file that provides context for these changes?** + - If yes: set `{spec_file}` to the path provided, verify the file exists and is readable, then set `{review_mode}` = `"full"`. + - If no: set `{review_mode}` = `"no-spec"`. 5. If `{review_mode}` = `"full"` and the file at `{spec_file}` has a `context` field in its frontmatter listing additional docs, load each referenced document. Warn the user about any docs that cannot be found. diff --git a/src/bmm-skills/4-implementation/bmad-code-review/steps/step-02-review.md b/src/bmm-skills/4-implementation/bmad-code-review/steps/step-02-review.md index c262a4971..bbc1f9a82 100644 --- a/src/bmm-skills/4-implementation/bmad-code-review/steps/step-02-review.md +++ b/src/bmm-skills/4-implementation/bmad-code-review/steps/step-02-review.md @@ -10,6 +10,7 @@ failed_layers: '' # set at runtime: comma-separated list of layers that failed o - The Blind Hunter subagent receives NO project context — diff only. - The Edge Case Hunter subagent receives diff and project read access. - The Acceptance Auditor subagent receives diff, spec, and context docs. +- All review subagents must run at the same model capability as the current session. ## INSTRUCTIONS diff --git a/src/bmm-skills/4-implementation/bmad-code-review/steps/step-04-present.md b/src/bmm-skills/4-implementation/bmad-code-review/steps/step-04-present.md index c495d4981..1697c769c 100644 --- a/src/bmm-skills/4-implementation/bmad-code-review/steps/step-04-present.md +++ b/src/bmm-skills/4-implementation/bmad-code-review/steps/step-04-present.md @@ -46,35 +46,32 @@ If `decision_needed` findings exist, present each one with its detail and the op If the user chooses to defer, ask: Quick one-line reason for deferring this item? (helps future reviews): — then append that reason to both the story file bullet and the `{deferred_work_file}` entry. -**HALT** — I am waiting for your numbered choice. Reply with only the number (or "0" for batch). Do not proceed until you select an option. +**HALT** — I am waiting for your numbered choice. Reply with only the number. Do not proceed until you select an option. ### 5. Handle `patch` findings If `patch` findings exist (including any resolved from step 4), HALT. Ask the user: -If `{spec_file}` is set, present all three options (if >3 `patch` findings exist, also show option 0): +If `{spec_file}` is set, present all three options: -> **How would you like to handle the `patch` findings?** -> 0. **Batch-apply all** — automatically fix every non-controversial patch (recommended when there are many) -> 1. **Fix them automatically** — I will apply fixes now +> **How would you like to handle the `

` `patch` findings?** +> 1. **Apply every patch** — fix all of them now, no per-finding confirmation. Defer and decision-needed items are not touched. > 2. **Leave as action items** — they are already in the story file -> 3. **Walk through each** — let me show details before deciding +> 3. **Walk through each patch** — show details for each before deciding -If `{spec_file}` is **not** set, present only options 1 and 3 (omit option 2 — findings were not written to a file). If >3 `patch` findings exist, also show option 0: +If `{spec_file}` is **not** set, present only options 1 and 2 (omit "Leave as action items" — findings were not written to a file): -> **How would you like to handle the `patch` findings?** -> 0. **Batch-apply all** — automatically fix every non-controversial patch (recommended when there are many) -> 1. **Fix them automatically** — I will apply fixes now -> 2. **Walk through each** — let me show details before deciding +> **How would you like to handle the `

` `patch` findings?** +> 1. **Apply every patch** — fix all of them now, no per-finding confirmation. Defer and decision-needed items are not touched. +> 2. **Walk through each patch** — show details for each before deciding -**HALT** — I am waiting for your numbered choice. Reply with only the number (or "0" for batch). Do not proceed until you select an option. +**HALT** — I am waiting for your numbered choice. Reply with only the number. Do not proceed until you select an option. -- **Option 0** (only when >3 findings): Apply all non-controversial patches without per-finding confirmation. Skip any finding that requires judgment. Present a summary of changes made and any skipped findings. -- **Option 1**: Apply each fix. After all patches are applied, present a summary of changes made. If `{spec_file}` is set, check off the items in the story file. -- **Option 2** (only when `{spec_file}` is set): Done — findings are already written to the story. -- **Walk through each**: Present each finding with full detail, diff context, and suggested fix. After walkthrough, re-offer the applicable options above. +- **Apply every patch**: Apply every patch finding without per-finding confirmation. Do not modify defer or decision-needed items. After all patches are applied, present a summary of changes made. If `{spec_file}` is set, check off the patch items in the story file (leave defer items as-is). +- **Leave as action items** (only when `{spec_file}` is set): Done — findings are already written to the story. +- **Walk through each patch**: Present each finding with full detail, diff context, and suggested fix. After walkthrough, re-offer the applicable options above. - **HALT** — I am waiting for your numbered choice. Reply with only the number (or "0" for batch). Do not proceed until you select an option. + **HALT** — I am waiting for your numbered choice. Do not proceed until you select an option. **✅ Code review actions complete** @@ -127,3 +124,9 @@ Present the user with follow-up options: > 3. **Done** — end the workflow **HALT** — I am waiting for your choice. Do not proceed until the user selects an option. + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/4-implementation/bmad-code-review/workflow.md b/src/bmm-skills/4-implementation/bmad-code-review/workflow.md deleted file mode 100644 index 2cad2d870..000000000 --- a/src/bmm-skills/4-implementation/bmad-code-review/workflow.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -main_config: '{project-root}/_bmad/bmm/config.yaml' ---- - -# Code Review Workflow - -**Goal:** Review code changes adversarially using parallel review layers and structured triage. - -**Your Role:** You are an elite code reviewer. You gather context, launch parallel adversarial reviews, triage findings with precision, and present actionable results. No noise, no filler. - - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -- **Micro-file Design**: Each step is self-contained and followed exactly -- **Just-In-Time Loading**: Only load the current step file -- **Sequential Enforcement**: Complete steps in order, no skipping -- **State Tracking**: Persist progress via in-memory variables -- **Append-Only Building**: Build artifacts incrementally - -### Step Processing Rules - -1. **READ COMPLETELY**: Read the entire step file before acting -2. **FOLLOW SEQUENCE**: Execute sections in order -3. **WAIT FOR INPUT**: Halt at checkpoints and wait for human -4. **LOAD NEXT**: When directed, read fully and follow the next step file - -### Critical Rules (NO EXCEPTIONS) - -- **NEVER** load multiple step files simultaneously -- **ALWAYS** read entire step file before execution -- **NEVER** skip steps or optimize the sequence -- **ALWAYS** follow the exact instructions in the step file -- **ALWAYS** halt at checkpoints and wait for human input - - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from `{main_config}` and resolve: - -- `project_name`, `planning_artifacts`, `implementation_artifacts`, `user_name` -- `communication_language`, `document_output_language`, `user_skill_level` -- `date` as system-generated current datetime -- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` -- `project_context` = `**/project-context.md` (load if exists) -- CLAUDE.md / memory files (load if exist) - -YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`. - -### 2. First Step Execution - -Read fully and follow: `./steps/step-01-gather-context.md` to begin the workflow. diff --git a/src/bmm-skills/4-implementation/bmad-correct-course/SKILL.md b/src/bmm-skills/4-implementation/bmad-correct-course/SKILL.md index 021c715f8..adea0bda0 100644 --- a/src/bmm-skills/4-implementation/bmad-correct-course/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-correct-course/SKILL.md @@ -3,4 +3,299 @@ name: bmad-correct-course description: 'Manage significant changes during sprint execution. Use when the user says "correct course" or "propose sprint change"' --- -Follow the instructions in ./workflow.md. +# Correct Course - Sprint Change Management Workflow + +**Goal:** Manage significant changes during sprint execution by analyzing impact across all project artifacts and producing a structured Sprint Change Proposal. + +**Your Role:** You are a Developer navigating change management. Analyze the triggering issue, assess impact across PRD, epics, architecture, and UX artifacts, and produce an actionable Sprint Change Proposal with clear handoff. + +## Conventions + +- Bare paths (e.g. `checklist.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `project_name`, `user_name` +- `communication_language`, `document_output_language` +- `user_skill_level` +- `implementation_artifacts` +- `planning_artifacts` +- `project_knowledge` +- `date` as system-generated current datetime +- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` +- Language MUST be tailored to `{user_skill_level}` +- Generate all documents in `{document_output_language}` +- DOCUMENT OUTPUT: Updated epics, stories, or PRD sections. Clear, actionable changes. User skill level (`{user_skill_level}`) affects conversation style ONLY, not document updates. + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `default_output_file` = `{planning_artifacts}/sprint-change-proposal-{date}.md` + +## Input Files + +| Input | Path | Load Strategy | +|-------|------|---------------| +| PRD | `{planning_artifacts}/*prd*.md` (whole) or `{planning_artifacts}/*prd*/*.md` (sharded) | FULL_LOAD | +| Epics | `{planning_artifacts}/*epic*.md` (whole) or `{planning_artifacts}/*epic*/*.md` (sharded) | FULL_LOAD | +| Architecture | `{planning_artifacts}/*architecture*.md` (whole) or `{planning_artifacts}/*architecture*/*.md` (sharded) | FULL_LOAD | +| UX Design | `{planning_artifacts}/*ux*.md` (whole) or `{planning_artifacts}/*ux*/*.md` (sharded) | FULL_LOAD | +| Spec | `{planning_artifacts}/*spec-*.md` (whole) | FULL_LOAD | +| Document Project | `{project_knowledge}/index.md` (sharded) | INDEX_GUIDED | + +## Execution + +### Document Discovery - Loading Project Artifacts + +**Strategy**: Course correction needs broad project context to assess change impact accurately. Load all available planning artifacts. + +**Discovery Process for FULL_LOAD documents (PRD, Epics, Architecture, UX Design, Spec):** + +1. **Search for whole document first** - Look for files matching the whole-document pattern (e.g., `*prd*.md`, `*epic*.md`, `*architecture*.md`, `*ux*.md`, `*spec-*.md`) +2. **Check for sharded version** - If whole document not found, look for a directory with `index.md` (e.g., `prd/index.md`, `epics/index.md`) +3. **If sharded version found**: + - Read `index.md` to understand the document structure + - Read ALL section files listed in the index + - Process the combined content as a single document +4. **Priority**: If both whole and sharded versions exist, use the whole document + +**Discovery Process for INDEX_GUIDED documents (Document Project):** + +1. **Search for index file** - Look for `{project_knowledge}/index.md` +2. **If found**: Read the index to understand available documentation sections +3. **Selectively load sections** based on relevance to the change being analyzed — do NOT load everything, only sections that relate to the impacted areas +4. **This document is optional** — skip if `{project_knowledge}` does not exist (greenfield projects) + +**Fuzzy matching**: Be flexible with document names — users may use variations like `prd.md`, `bmm-prd.md`, `product-requirements.md`, etc. + +**Missing documents**: Not all documents may exist. PRD and Epics are essential; Architecture, UX Design, Spec, and Document Project are loaded if available. HALT if PRD or Epics cannot be found. + + + + + Confirm change trigger and gather user description of the issue + Ask: "What specific issue or change has been identified that requires navigation?" + Verify access to project documents: + - PRD (Product Requirements Document) — required + - Current Epics and Stories — required + - Architecture documentation — optional, load if available + - UI/UX specifications — optional, load if available + Ask user for mode preference: + - **Incremental** (recommended): Refine each edit collaboratively + - **Batch**: Present all changes at once for review + Store mode selection for use throughout workflow + +HALT: "Cannot navigate change without clear understanding of the triggering issue. Please provide specific details about what needs to change and why." + +HALT: "Need access to PRD and Epics to assess change impact. Please ensure these documents are accessible. Architecture and UI/UX will be used if available." + + + + Read fully and follow the systematic analysis from: checklist.md + Work through each checklist section interactively with the user + Record status for each checklist item: + - [x] Done - Item completed successfully + - [N/A] Skip - Item not applicable to this change + - [!] Action-needed - Item requires attention or follow-up + Maintain running notes of findings and impacts discovered + Present checklist progress after each major section + +Identify blocking issues and work with user to resolve before continuing + + + +Based on checklist findings, create explicit edit proposals for each identified artifact + +For Story changes: + +- Show old → new text format +- Include story ID and section being modified +- Provide rationale for each change +- Example format: + + ``` + Story: [STORY-123] User Authentication + Section: Acceptance Criteria + + OLD: + - User can log in with email/password + + NEW: + - User can log in with email/password + - User can enable 2FA via authenticator app + + Rationale: Security requirement identified during implementation + ``` + +For PRD modifications: + +- Specify exact sections to update +- Show current content and proposed changes +- Explain impact on MVP scope and requirements + +For Architecture changes: + +- Identify affected components, patterns, or technology choices +- Describe diagram updates needed +- Note any ripple effects on other components + +For UI/UX specification updates: + +- Reference specific screens or components +- Show wireframe or flow changes needed +- Connect changes to user experience impact + + + Present each edit proposal individually + Review and refine this change? Options: Approve [a], Edit [e], Skip [s] + Iterate on each proposal based on user feedback + + +Collect all edit proposals and present together at end of step + + + + +Compile comprehensive Sprint Change Proposal document with following sections: + +Section 1: Issue Summary + +- Clear problem statement describing what triggered the change +- Context about when/how the issue was discovered +- Evidence or examples demonstrating the issue + +Section 2: Impact Analysis + +- Epic Impact: Which epics are affected and how +- Story Impact: Current and future stories requiring changes +- Artifact Conflicts: PRD, Architecture, UI/UX documents needing updates +- Technical Impact: Code, infrastructure, or deployment implications + +Section 3: Recommended Approach + +- Present chosen path forward from checklist evaluation: + - Direct Adjustment: Modify/add stories within existing plan + - Potential Rollback: Revert completed work to simplify resolution + - MVP Review: Reduce scope or modify goals +- Provide clear rationale for recommendation +- Include effort estimate, risk assessment, and timeline impact + +Section 4: Detailed Change Proposals + +- Include all refined edit proposals from Step 3 +- Group by artifact type (Stories, PRD, Architecture, UI/UX) +- Ensure each change includes before/after and justification + +Section 5: Implementation Handoff + +- Categorize change scope: + - Minor: Direct implementation by Developer agent + - Moderate: Backlog reorganization needed (PO/DEV) + - Major: Fundamental replan required (PM/Architect) +- Specify handoff recipients and their responsibilities +- Define success criteria for implementation + +Present complete Sprint Change Proposal to user +Write Sprint Change Proposal document to {default_output_file} +Review complete proposal. Continue [c] or Edit [e]? + + + +Get explicit user approval for complete proposal +Do you approve this Sprint Change Proposal for implementation? (yes/no/revise) + + + Gather specific feedback on what needs adjustment + Return to appropriate step to address concerns + If changes needed to edit proposals + If changes needed to overall proposal structure + + + + + Finalize Sprint Change Proposal document + Determine change scope classification: + +- **Minor**: Can be implemented directly by Developer agent +- **Moderate**: Requires backlog reorganization and PO/DEV coordination +- **Major**: Needs fundamental replan with PM/Architect involvement + +Provide appropriate handoff based on scope: + + + + + Route to: Developer agent for direct implementation + Deliverables: Finalized edit proposals and implementation tasks + + + + Route to: Product Owner / Developer agents + Deliverables: Sprint Change Proposal + backlog reorganization plan + + + + Route to: Product Manager / Solution Architect + Deliverables: Complete Sprint Change Proposal + escalation notice + +Confirm handoff completion and next steps with user +Document handoff in workflow execution log + + + + + +Summarize workflow execution: + - Issue addressed: {{change_trigger}} + - Change scope: {{scope_classification}} + - Artifacts modified: {{list_of_artifacts}} + - Routed to: {{handoff_recipients}} + +Confirm all deliverables produced: + +- Sprint Change Proposal document +- Specific edit proposals with before/after +- Implementation handoff plan + +Report workflow completion to user with personalized message: "Correct Course workflow complete, {user_name}!" +Remind user of success criteria and next steps for Developer agent +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. + + + diff --git a/src/bmm-skills/4-implementation/bmad-correct-course/customize.toml b/src/bmm-skills/4-implementation/bmad-correct-course/customize.toml new file mode 100644 index 000000000..d23577e4b --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-correct-course/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-correct-course. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All sprint changes require PO sign-off before execution." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 6 (Workflow Completion), +# after the Sprint Change Proposal is finalized and handoff is confirmed. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-correct-course/workflow.md b/src/bmm-skills/4-implementation/bmad-correct-course/workflow.md deleted file mode 100644 index 2b7cd7144..000000000 --- a/src/bmm-skills/4-implementation/bmad-correct-course/workflow.md +++ /dev/null @@ -1,267 +0,0 @@ -# Correct Course - Sprint Change Management Workflow - -**Goal:** Manage significant changes during sprint execution by analyzing impact across all project artifacts and producing a structured Sprint Change Proposal. - -**Your Role:** You are a Developer navigating change management. Analyze the triggering issue, assess impact across PRD, epics, architecture, and UX artifacts, and produce an actionable Sprint Change Proposal with clear handoff. - ---- - -## INITIALIZATION - -### Configuration Loading - -Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - -- `project_name`, `user_name` -- `communication_language`, `document_output_language` -- `user_skill_level` -- `implementation_artifacts` -- `planning_artifacts` -- `project_knowledge` -- `date` as system-generated current datetime -- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` -- Language MUST be tailored to `{user_skill_level}` -- Generate all documents in `{document_output_language}` -- DOCUMENT OUTPUT: Updated epics, stories, or PRD sections. Clear, actionable changes. User skill level (`{user_skill_level}`) affects conversation style ONLY, not document updates. - -### Paths - -- `default_output_file` = `{planning_artifacts}/sprint-change-proposal-{date}.md` - -### Input Files - -| Input | Path | Load Strategy | -|-------|------|---------------| -| PRD | `{planning_artifacts}/*prd*.md` (whole) or `{planning_artifacts}/*prd*/*.md` (sharded) | FULL_LOAD | -| Epics | `{planning_artifacts}/*epic*.md` (whole) or `{planning_artifacts}/*epic*/*.md` (sharded) | FULL_LOAD | -| Architecture | `{planning_artifacts}/*architecture*.md` (whole) or `{planning_artifacts}/*architecture*/*.md` (sharded) | FULL_LOAD | -| UX Design | `{planning_artifacts}/*ux*.md` (whole) or `{planning_artifacts}/*ux*/*.md` (sharded) | FULL_LOAD | -| Spec | `{planning_artifacts}/*spec-*.md` (whole) | FULL_LOAD | -| Document Project | `{project_knowledge}/index.md` (sharded) | INDEX_GUIDED | - -### Context - -- Load `**/project-context.md` if it exists - ---- - -## EXECUTION - -### Document Discovery - Loading Project Artifacts - -**Strategy**: Course correction needs broad project context to assess change impact accurately. Load all available planning artifacts. - -**Discovery Process for FULL_LOAD documents (PRD, Epics, Architecture, UX Design, Spec):** - -1. **Search for whole document first** - Look for files matching the whole-document pattern (e.g., `*prd*.md`, `*epic*.md`, `*architecture*.md`, `*ux*.md`, `*spec-*.md`) -2. **Check for sharded version** - If whole document not found, look for a directory with `index.md` (e.g., `prd/index.md`, `epics/index.md`) -3. **If sharded version found**: - - Read `index.md` to understand the document structure - - Read ALL section files listed in the index - - Process the combined content as a single document -4. **Priority**: If both whole and sharded versions exist, use the whole document - -**Discovery Process for INDEX_GUIDED documents (Document Project):** - -1. **Search for index file** - Look for `{project_knowledge}/index.md` -2. **If found**: Read the index to understand available documentation sections -3. **Selectively load sections** based on relevance to the change being analyzed — do NOT load everything, only sections that relate to the impacted areas -4. **This document is optional** — skip if `{project_knowledge}` does not exist (greenfield projects) - -**Fuzzy matching**: Be flexible with document names — users may use variations like `prd.md`, `bmm-prd.md`, `product-requirements.md`, etc. - -**Missing documents**: Not all documents may exist. PRD and Epics are essential; Architecture, UX Design, Spec, and Document Project are loaded if available. HALT if PRD or Epics cannot be found. - - - - - Load **/project-context.md for coding standards and project-wide patterns (if exists) - Confirm change trigger and gather user description of the issue - Ask: "What specific issue or change has been identified that requires navigation?" - Verify access to required project documents: - - PRD (Product Requirements Document) - - Current Epics and Stories - - Architecture documentation - - UI/UX specifications - Ask user for mode preference: - - **Incremental** (recommended): Refine each edit collaboratively - - **Batch**: Present all changes at once for review - Store mode selection for use throughout workflow - -HALT: "Cannot navigate change without clear understanding of the triggering issue. Please provide specific details about what needs to change and why." - -HALT: "Need access to project documents (PRD, Epics, Architecture, UI/UX) to assess change impact. Please ensure these documents are accessible." - - - - Read fully and follow the systematic analysis from: checklist.md - Work through each checklist section interactively with the user - Record status for each checklist item: - - [x] Done - Item completed successfully - - [N/A] Skip - Item not applicable to this change - - [!] Action-needed - Item requires attention or follow-up - Maintain running notes of findings and impacts discovered - Present checklist progress after each major section - -Identify blocking issues and work with user to resolve before continuing - - - -Based on checklist findings, create explicit edit proposals for each identified artifact - -For Story changes: - -- Show old → new text format -- Include story ID and section being modified -- Provide rationale for each change -- Example format: - - ``` - Story: [STORY-123] User Authentication - Section: Acceptance Criteria - - OLD: - - User can log in with email/password - - NEW: - - User can log in with email/password - - User can enable 2FA via authenticator app - - Rationale: Security requirement identified during implementation - ``` - -For PRD modifications: - -- Specify exact sections to update -- Show current content and proposed changes -- Explain impact on MVP scope and requirements - -For Architecture changes: - -- Identify affected components, patterns, or technology choices -- Describe diagram updates needed -- Note any ripple effects on other components - -For UI/UX specification updates: - -- Reference specific screens or components -- Show wireframe or flow changes needed -- Connect changes to user experience impact - - - Present each edit proposal individually - Review and refine this change? Options: Approve [a], Edit [e], Skip [s] - Iterate on each proposal based on user feedback - - -Collect all edit proposals and present together at end of step - - - - -Compile comprehensive Sprint Change Proposal document with following sections: - -Section 1: Issue Summary - -- Clear problem statement describing what triggered the change -- Context about when/how the issue was discovered -- Evidence or examples demonstrating the issue - -Section 2: Impact Analysis - -- Epic Impact: Which epics are affected and how -- Story Impact: Current and future stories requiring changes -- Artifact Conflicts: PRD, Architecture, UI/UX documents needing updates -- Technical Impact: Code, infrastructure, or deployment implications - -Section 3: Recommended Approach - -- Present chosen path forward from checklist evaluation: - - Direct Adjustment: Modify/add stories within existing plan - - Potential Rollback: Revert completed work to simplify resolution - - MVP Review: Reduce scope or modify goals -- Provide clear rationale for recommendation -- Include effort estimate, risk assessment, and timeline impact - -Section 4: Detailed Change Proposals - -- Include all refined edit proposals from Step 3 -- Group by artifact type (Stories, PRD, Architecture, UI/UX) -- Ensure each change includes before/after and justification - -Section 5: Implementation Handoff - -- Categorize change scope: - - Minor: Direct implementation by Developer agent - - Moderate: Backlog reorganization needed (PO/DEV) - - Major: Fundamental replan required (PM/Architect) -- Specify handoff recipients and their responsibilities -- Define success criteria for implementation - -Present complete Sprint Change Proposal to user -Write Sprint Change Proposal document to {default_output_file} -Review complete proposal. Continue [c] or Edit [e]? - - - -Get explicit user approval for complete proposal -Do you approve this Sprint Change Proposal for implementation? (yes/no/revise) - - - Gather specific feedback on what needs adjustment - Return to appropriate step to address concerns - If changes needed to edit proposals - If changes needed to overall proposal structure - - - - - Finalize Sprint Change Proposal document - Determine change scope classification: - -- **Minor**: Can be implemented directly by Developer agent -- **Moderate**: Requires backlog reorganization and PO/DEV coordination -- **Major**: Needs fundamental replan with PM/Architect involvement - -Provide appropriate handoff based on scope: - - - - - Route to: Developer agent for direct implementation - Deliverables: Finalized edit proposals and implementation tasks - - - - Route to: Product Owner / Developer agents - Deliverables: Sprint Change Proposal + backlog reorganization plan - - - - Route to: Product Manager / Solution Architect - Deliverables: Complete Sprint Change Proposal + escalation notice - -Confirm handoff completion and next steps with user -Document handoff in workflow execution log - - - - - -Summarize workflow execution: - - Issue addressed: {{change_trigger}} - - Change scope: {{scope_classification}} - - Artifacts modified: {{list_of_artifacts}} - - Routed to: {{handoff_recipients}} - -Confirm all deliverables produced: - -- Sprint Change Proposal document -- Specific edit proposals with before/after -- Implementation handoff plan - -Report workflow completion to user with personalized message: "Correct Course workflow complete, {user_name}!" -Remind user of success criteria and next steps for Developer agent - - - diff --git a/src/bmm-skills/4-implementation/bmad-create-story/SKILL.md b/src/bmm-skills/4-implementation/bmad-create-story/SKILL.md index 66119b062..cf14039c1 100644 --- a/src/bmm-skills/4-implementation/bmad-create-story/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-create-story/SKILL.md @@ -3,4 +3,427 @@ name: bmad-create-story description: 'Creates a dedicated story file with all the context the agent will need to implement it later. Use when the user says "create the next story" or "create story [story identifier]"' --- -Follow the instructions in ./workflow.md. +# Create Story Workflow + +**Goal:** Create a comprehensive story file that gives the dev agent everything needed for flawless implementation. + +**Your Role:** Story context engine that prevents LLM developer mistakes, omissions, or disasters. +- Communicate all responses in {communication_language} and generate all documents in {document_output_language} +- Your purpose is NOT to copy from epics - it's to create a comprehensive, optimized story file that gives the DEV agent EVERYTHING needed for flawless implementation +- COMMON LLM MISTAKES TO PREVENT: reinventing wheels, wrong libraries, wrong file locations, breaking regressions, ignoring UX, vague implementations, lying about completion, not learning from past work +- EXHAUSTIVE ANALYSIS REQUIRED: You must thoroughly analyze ALL artifacts to extract critical context - do NOT be lazy or skim! This is the most important function in the entire development process! +- UTILIZE SUBPROCESSES AND SUBAGENTS: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different artifacts simultaneously and thoroughly +- SAVE QUESTIONS: If you think of questions or clarifications during analysis, save them for the end after the complete story is written +- ZERO USER INTERVENTION: Process should be fully automated except for initial epic/story selection or missing documents + +## Conventions + +- Bare paths (e.g. `discover-inputs.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `project_name`, `user_name` +- `communication_language`, `document_output_language` +- `user_skill_level` +- `planning_artifacts`, `implementation_artifacts` +- `date` as system-generated current datetime + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` +- `epics_file` = `{planning_artifacts}/epics.md` +- `prd_file` = `{planning_artifacts}/prd.md` +- `architecture_file` = `{planning_artifacts}/architecture.md` +- `ux_file` = `{planning_artifacts}/*ux*.md` +- `story_title` = "" (will be elicited if not derivable) +- `default_output_file` = `{implementation_artifacts}/{{story_key}}.md` + +## Input Files + +| Input | Description | Path Pattern(s) | Load Strategy | +|-------|-------------|------------------|---------------| +| prd | PRD (fallback - epics file should have most content) | whole: `{planning_artifacts}/*prd*.md`, sharded: `{planning_artifacts}/*prd*/*.md` | SELECTIVE_LOAD | +| architecture | Architecture (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*architecture*.md`, sharded: `{planning_artifacts}/*architecture*/*.md` | SELECTIVE_LOAD | +| ux | UX design (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*ux*.md`, sharded: `{planning_artifacts}/*ux*/*.md` | SELECTIVE_LOAD | +| epics | Enhanced epics+stories file with BDD and source hints | whole: `{planning_artifacts}/*epic*.md`, sharded: `{planning_artifacts}/*epic*/*.md` | SELECTIVE_LOAD | + +## Execution + + + + + + Parse user-provided story path: extract epic_num, story_num, story_title from format like "1-2-user-auth" + Set {{epic_num}}, {{story_num}}, {{story_key}} from user input + GOTO step 2a + + + Check if {{sprint_status}} file exists for auto discover + + 🚫 No sprint status file found and no story specified + + **Required Options:** + 1. Run `sprint-planning` to initialize sprint tracking (recommended) + 2. Provide specific epic-story number to create (e.g., "1-2-user-auth") + 3. Provide path to story documents if sprint status doesn't exist yet + + Choose option [1], provide epic-story number, path to story docs, or [q] to quit: + + + HALT - No work needed + + + + Run sprint-planning workflow first to create sprint-status.yaml + HALT - User needs to run sprint-planning + + + + Parse user input: extract epic_num, story_num, story_title + Set {{epic_num}}, {{story_num}}, {{story_key}} from user input + GOTO step 2a + + + + Use user-provided path for story documents + GOTO step 2a + + + + + + MUST read COMPLETE {sprint_status} file from start to end to preserve order + Load the FULL file: {{sprint_status}} + Read ALL lines from beginning to end - do not skip any content + Parse the development_status section completely + + Find the FIRST story (by reading in order from top to bottom) where: + - Key matches pattern: number-number-name (e.g., "1-2-user-auth") + - NOT an epic key (epic-X) or retrospective (epic-X-retrospective) + - Status value equals "backlog" + + + + 📋 No backlog stories found in sprint-status.yaml + + All stories are either already created, in progress, or done. + + **Options:** + 1. Run sprint-planning to refresh story tracking + 2. Load PM agent and run correct-course to add more stories + 3. Check if current sprint is complete and run retrospective + + HALT + + + Extract from found story key (e.g., "1-2-user-authentication"): + - epic_num: first number before dash (e.g., "1") + - story_num: second number after first dash (e.g., "2") + - story_title: remainder after second dash (e.g., "user-authentication") + + Set {{story_id}} = "{{epic_num}}.{{story_num}}" + Store story_key for later use (e.g., "1-2-user-authentication") + + + Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern + + Load {{sprint_status}} and check epic-{{epic_num}} status + If epic status is "backlog" → update to "in-progress" + If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility) + If epic status is "in-progress" → no change needed + + 🚫 ERROR: Cannot create story in completed epic + Epic {{epic_num}} is marked as 'done'. All stories are complete. + If you need to add more work, either: + 1. Manually change epic status back to 'in-progress' in sprint-status.yaml + 2. Create a new epic for additional work + HALT - Cannot proceed + + + 🚫 ERROR: Invalid epic status '{{epic_status}}' + Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done + Please fix sprint-status.yaml manually or run sprint-planning to regenerate + HALT - Cannot proceed + + 📊 Epic {{epic_num}} status updated to in-progress + + + GOTO step 2a + + Load the FULL file: {{sprint_status}} + Read ALL lines from beginning to end - do not skip any content + Parse the development_status section completely + + Find the FIRST story (by reading in order from top to bottom) where: + - Key matches pattern: number-number-name (e.g., "1-2-user-auth") + - NOT an epic key (epic-X) or retrospective (epic-X-retrospective) + - Status value equals "backlog" + + + + No backlog stories found in sprint-status.yaml + + All stories are either already created, in progress, or done. + + **Options:** + 1. Run sprint-planning to refresh story tracking + 2. Load PM agent and run correct-course to add more stories + 3. Check if current sprint is complete and run retrospective + + HALT + + + Extract from found story key (e.g., "1-2-user-authentication"): + - epic_num: first number before dash (e.g., "1") + - story_num: second number after first dash (e.g., "2") + - story_title: remainder after second dash (e.g., "user-authentication") + + Set {{story_id}} = "{{epic_num}}.{{story_num}}" + Store story_key for later use (e.g., "1-2-user-authentication") + + + Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern + + Load {{sprint_status}} and check epic-{{epic_num}} status + If epic status is "backlog" → update to "in-progress" + If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility) + If epic status is "in-progress" → no change needed + + ERROR: Cannot create story in completed epic + Epic {{epic_num}} is marked as 'done'. All stories are complete. + If you need to add more work, either: + 1. Manually change epic status back to 'in-progress' in sprint-status.yaml + 2. Create a new epic for additional work + HALT - Cannot proceed + + + ERROR: Invalid epic status '{{epic_status}}' + Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done + Please fix sprint-status.yaml manually or run sprint-planning to regenerate + HALT - Cannot proceed + + Epic {{epic_num}} status updated to in-progress + + + GOTO step 2a + + + + 🔬 EXHAUSTIVE ARTIFACT ANALYSIS - This is where you prevent future developer mistakes! + + + Read fully and follow `./discover-inputs.md` to load all input files + Available content: {epics_content}, {prd_content}, {architecture_content}, {ux_content}, plus the project-context facts loaded during activation via `persistent_facts`. + + + From {epics_content}, extract Epic {{epic_num}} complete context: **EPIC ANALYSIS:** - Epic + objectives and business value - ALL stories in this epic for cross-story context - Our specific story's requirements, user story + statement, acceptance criteria - Technical requirements and constraints - Dependencies on other stories/epics - Source hints pointing to + original documents + Extract our story ({{epic_num}}-{{story_num}}) details: **STORY FOUNDATION:** - User story statement + (As a, I want, so that) - Detailed acceptance criteria (already BDD formatted) - Technical requirements specific to this story - + Business context and value - Success criteria + + Find {{previous_story_num}}: scan {implementation_artifacts} for the story file in epic {{epic_num}} with the highest story number less than {{story_num}} + Load previous story file: {implementation_artifacts}/{{epic_num}}-{{previous_story_num}}-*.md **PREVIOUS STORY INTELLIGENCE:** - + Dev notes and learnings from previous story - Review feedback and corrections needed - Files that were created/modified and their + patterns - Testing approaches that worked/didn't work - Problems encountered and solutions found - Code patterns established Extract + all learnings that could impact current story implementation + + + + + Get last 5 commit titles to understand recent work patterns + Analyze 1-5 most recent commits for relevance to current story: + - Files created/modified + - Code patterns and conventions used + - Library dependencies added/changed + - Architecture decisions implemented + - Testing approaches used + + Extract actionable insights for current story implementation + + + + + 🏗️ ARCHITECTURE INTELLIGENCE - Extract everything the developer MUST follow! **ARCHITECTURE DOCUMENT ANALYSIS:** Systematically + analyze architecture content for story-relevant requirements: + + + + Load complete {architecture_content} + + + Load architecture index and scan all architecture files + **CRITICAL ARCHITECTURE EXTRACTION:** For + each architecture section, determine if relevant to this story: - **Technical Stack:** Languages, frameworks, libraries with + versions - **Code Structure:** Folder organization, naming conventions, file patterns - **API Patterns:** Service structure, endpoint + patterns, data contracts - **Database Schemas:** Tables, relationships, constraints relevant to story - **Security Requirements:** + Authentication patterns, authorization rules - **Performance Requirements:** Caching strategies, optimization patterns - **Testing + Standards:** Testing frameworks, coverage expectations, test patterns - **Deployment Patterns:** Environment configurations, build + processes - **Integration Patterns:** External service integrations, data flows Extract any story-specific requirements that the + developer MUST follow + Identify any architectural decisions that override previous patterns + + + 📂 READ FILES BEING MODIFIED — skipping this is the primary cause of implementation failures and review cycles + From the architecture directory structure, identify every file marked UPDATE (not NEW) that this story will touch + Read each relevant UPDATE file completely. For each one, document in dev notes: + - Current state: what it does today (state machine, API calls, data shapes, existing behaviors) + - What this story changes: the specific sections or behaviors being modified + - What must be preserved: existing interactions and behaviors the story must not break + + A story implementation must leave the system working end-to-end — not just satisfy its stated ACs. + If a behavior is required for the feature to work correctly in the existing system, it is a requirement + whether or not it is explicitly written in the story. The dev agent owns this. + + + + 🌐 ENSURE LATEST TECH KNOWLEDGE - Prevent outdated implementations! **WEB INTELLIGENCE:** Identify specific + technical areas that require latest version knowledge: + + + From architecture analysis, identify specific libraries, APIs, or + frameworks + For each critical technology, research latest stable version and key changes: + - Latest API documentation and breaking changes + - Security vulnerabilities or updates + - Performance improvements or deprecations + - Best practices for current version + + **EXTERNAL CONTEXT INCLUSION:** Include in story any critical latest information the developer needs: + - Specific library versions and why chosen + - API endpoints with parameters and authentication + - Recent security patches or considerations + - Performance optimization techniques + - Migration considerations if upgrading + + + + + 📝 CREATE ULTIMATE STORY FILE - The developer's master implementation guide! + + Initialize from template.md: + {default_output_file} + story_header + + + story_requirements + + + + developer_context_section **DEV AGENT GUARDRAILS:** + technical_requirements + architecture_compliance + library_framework_requirements + + file_structure_requirements + testing_requirements + + + + previous_story_intelligence + + + + + git_intelligence_summary + + + + + latest_tech_information + + + + project_context_reference + + + + story_completion_status + + + Set story Status to: "ready-for-dev" + Add completion note: "Ultimate + context engine analysis completed - comprehensive developer guide created" + + + + Validate the newly created story file {default_output_file} against `./checklist.md` and apply any required fixes before finalizing + Save story document unconditionally + + + + Update {{sprint_status}} + Load the FULL file and read all development_status entries + Find development_status key matching {{story_key}} + Verify current status is "backlog" (expected previous state) + Update development_status[{{story_key}}] = "ready-for-dev" + Update last_updated field to current date + Save file, preserving ALL comments and structure including STATUS DEFINITIONS + + + Report completion + **🎯 ULTIMATE BMad Method STORY CONTEXT CREATED, {user_name}!** + + **Story Details:** + - Story ID: {{story_id}} + - Story Key: {{story_key}} + - File: {{story_file}} + - Status: ready-for-dev + + **Next Steps:** + 1. Review the comprehensive story in {{story_file}} + 2. Run dev agents `dev-story` for optimized implementation + 3. Run `code-review` when complete (auto-marks done) + 4. Optional: If Test Architect module installed, run `/bmad:tea:automate` after `dev-story` to generate guardrail tests + + **The developer now has everything needed for flawless implementation!** + + Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. + + + diff --git a/src/bmm-skills/4-implementation/bmad-create-story/customize.toml b/src/bmm-skills/4-implementation/bmad-create-story/customize.toml new file mode 100644 index 000000000..fbd4a789a --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-create-story/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-create-story. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All stories must include testable acceptance criteria." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 6 (Update sprint status and finalize), +# after the story file is saved and sprint-status.yaml is updated. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-create-story/workflow.md b/src/bmm-skills/4-implementation/bmad-create-story/workflow.md deleted file mode 100644 index 0acd8666b..000000000 --- a/src/bmm-skills/4-implementation/bmad-create-story/workflow.md +++ /dev/null @@ -1,380 +0,0 @@ -# Create Story Workflow - -**Goal:** Create a comprehensive story file that gives the dev agent everything needed for flawless implementation. - -**Your Role:** Story context engine that prevents LLM developer mistakes, omissions, or disasters. -- Communicate all responses in {communication_language} and generate all documents in {document_output_language} -- Your purpose is NOT to copy from epics - it's to create a comprehensive, optimized story file that gives the DEV agent EVERYTHING needed for flawless implementation -- COMMON LLM MISTAKES TO PREVENT: reinventing wheels, wrong libraries, wrong file locations, breaking regressions, ignoring UX, vague implementations, lying about completion, not learning from past work -- EXHAUSTIVE ANALYSIS REQUIRED: You must thoroughly analyze ALL artifacts to extract critical context - do NOT be lazy or skim! This is the most important function in the entire development process! -- UTILIZE SUBPROCESSES AND SUBAGENTS: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different artifacts simultaneously and thoroughly -- SAVE QUESTIONS: If you think of questions or clarifications during analysis, save them for the end after the complete story is written -- ZERO USER INTERVENTION: Process should be fully automated except for initial epic/story selection or missing documents - ---- - -## INITIALIZATION - -### Configuration Loading - -Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - -- `project_name`, `user_name` -- `communication_language`, `document_output_language` -- `user_skill_level` -- `planning_artifacts`, `implementation_artifacts` -- `date` as system-generated current datetime - -### Paths - -- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` -- `epics_file` = `{planning_artifacts}/epics.md` -- `prd_file` = `{planning_artifacts}/prd.md` -- `architecture_file` = `{planning_artifacts}/architecture.md` -- `ux_file` = `{planning_artifacts}/*ux*.md` -- `story_title` = "" (will be elicited if not derivable) -- `project_context` = `**/project-context.md` (load if exists) -- `default_output_file` = `{implementation_artifacts}/{{story_key}}.md` - -### Input Files - -| Input | Description | Path Pattern(s) | Load Strategy | -|-------|-------------|------------------|---------------| -| prd | PRD (fallback - epics file should have most content) | whole: `{planning_artifacts}/*prd*.md`, sharded: `{planning_artifacts}/*prd*/*.md` | SELECTIVE_LOAD | -| architecture | Architecture (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*architecture*.md`, sharded: `{planning_artifacts}/*architecture*/*.md` | SELECTIVE_LOAD | -| ux | UX design (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*ux*.md`, sharded: `{planning_artifacts}/*ux*/*.md` | SELECTIVE_LOAD | -| epics | Enhanced epics+stories file with BDD and source hints | whole: `{planning_artifacts}/*epic*.md`, sharded: `{planning_artifacts}/*epic*/*.md` | SELECTIVE_LOAD | - ---- - -## EXECUTION - - - - - - Parse user-provided story path: extract epic_num, story_num, story_title from format like "1-2-user-auth" - Set {{epic_num}}, {{story_num}}, {{story_key}} from user input - GOTO step 2a - - - Check if {{sprint_status}} file exists for auto discover - - 🚫 No sprint status file found and no story specified - - **Required Options:** - 1. Run `sprint-planning` to initialize sprint tracking (recommended) - 2. Provide specific epic-story number to create (e.g., "1-2-user-auth") - 3. Provide path to story documents if sprint status doesn't exist yet - - Choose option [1], provide epic-story number, path to story docs, or [q] to quit: - - - HALT - No work needed - - - - Run sprint-planning workflow first to create sprint-status.yaml - HALT - User needs to run sprint-planning - - - - Parse user input: extract epic_num, story_num, story_title - Set {{epic_num}}, {{story_num}}, {{story_key}} from user input - GOTO step 2a - - - - Use user-provided path for story documents - GOTO step 2a - - - - - - MUST read COMPLETE {sprint_status} file from start to end to preserve order - Load the FULL file: {{sprint_status}} - Read ALL lines from beginning to end - do not skip any content - Parse the development_status section completely - - Find the FIRST story (by reading in order from top to bottom) where: - - Key matches pattern: number-number-name (e.g., "1-2-user-auth") - - NOT an epic key (epic-X) or retrospective (epic-X-retrospective) - - Status value equals "backlog" - - - - 📋 No backlog stories found in sprint-status.yaml - - All stories are either already created, in progress, or done. - - **Options:** - 1. Run sprint-planning to refresh story tracking - 2. Load PM agent and run correct-course to add more stories - 3. Check if current sprint is complete and run retrospective - - HALT - - - Extract from found story key (e.g., "1-2-user-authentication"): - - epic_num: first number before dash (e.g., "1") - - story_num: second number after first dash (e.g., "2") - - story_title: remainder after second dash (e.g., "user-authentication") - - Set {{story_id}} = "{{epic_num}}.{{story_num}}" - Store story_key for later use (e.g., "1-2-user-authentication") - - - Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern - - Load {{sprint_status}} and check epic-{{epic_num}} status - If epic status is "backlog" → update to "in-progress" - If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility) - If epic status is "in-progress" → no change needed - - 🚫 ERROR: Cannot create story in completed epic - Epic {{epic_num}} is marked as 'done'. All stories are complete. - If you need to add more work, either: - 1. Manually change epic status back to 'in-progress' in sprint-status.yaml - 2. Create a new epic for additional work - HALT - Cannot proceed - - - 🚫 ERROR: Invalid epic status '{{epic_status}}' - Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done - Please fix sprint-status.yaml manually or run sprint-planning to regenerate - HALT - Cannot proceed - - 📊 Epic {{epic_num}} status updated to in-progress - - - GOTO step 2a - - Load the FULL file: {{sprint_status}} - Read ALL lines from beginning to end - do not skip any content - Parse the development_status section completely - - Find the FIRST story (by reading in order from top to bottom) where: - - Key matches pattern: number-number-name (e.g., "1-2-user-auth") - - NOT an epic key (epic-X) or retrospective (epic-X-retrospective) - - Status value equals "backlog" - - - - No backlog stories found in sprint-status.yaml - - All stories are either already created, in progress, or done. - - **Options:** - 1. Run sprint-planning to refresh story tracking - 2. Load PM agent and run correct-course to add more stories - 3. Check if current sprint is complete and run retrospective - - HALT - - - Extract from found story key (e.g., "1-2-user-authentication"): - - epic_num: first number before dash (e.g., "1") - - story_num: second number after first dash (e.g., "2") - - story_title: remainder after second dash (e.g., "user-authentication") - - Set {{story_id}} = "{{epic_num}}.{{story_num}}" - Store story_key for later use (e.g., "1-2-user-authentication") - - - Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern - - Load {{sprint_status}} and check epic-{{epic_num}} status - If epic status is "backlog" → update to "in-progress" - If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility) - If epic status is "in-progress" → no change needed - - ERROR: Cannot create story in completed epic - Epic {{epic_num}} is marked as 'done'. All stories are complete. - If you need to add more work, either: - 1. Manually change epic status back to 'in-progress' in sprint-status.yaml - 2. Create a new epic for additional work - HALT - Cannot proceed - - - ERROR: Invalid epic status '{{epic_status}}' - Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done - Please fix sprint-status.yaml manually or run sprint-planning to regenerate - HALT - Cannot proceed - - Epic {{epic_num}} status updated to in-progress - - - GOTO step 2a - - - - 🔬 EXHAUSTIVE ARTIFACT ANALYSIS - This is where you prevent future developer mistakes! - - - Read fully and follow `./discover-inputs.md` to load all input files - Available content: {epics_content}, {prd_content}, {architecture_content}, {ux_content}, - {project_context} - - - From {epics_content}, extract Epic {{epic_num}} complete context: **EPIC ANALYSIS:** - Epic - objectives and business value - ALL stories in this epic for cross-story context - Our specific story's requirements, user story - statement, acceptance criteria - Technical requirements and constraints - Dependencies on other stories/epics - Source hints pointing to - original documents - Extract our story ({{epic_num}}-{{story_num}}) details: **STORY FOUNDATION:** - User story statement - (As a, I want, so that) - Detailed acceptance criteria (already BDD formatted) - Technical requirements specific to this story - - Business context and value - Success criteria - - Find {{previous_story_num}}: scan {implementation_artifacts} for the story file in epic {{epic_num}} with the highest story number less than {{story_num}} - Load previous story file: {implementation_artifacts}/{{epic_num}}-{{previous_story_num}}-*.md **PREVIOUS STORY INTELLIGENCE:** - - Dev notes and learnings from previous story - Review feedback and corrections needed - Files that were created/modified and their - patterns - Testing approaches that worked/didn't work - Problems encountered and solutions found - Code patterns established Extract - all learnings that could impact current story implementation - - - - - Get last 5 commit titles to understand recent work patterns - Analyze 1-5 most recent commits for relevance to current story: - - Files created/modified - - Code patterns and conventions used - - Library dependencies added/changed - - Architecture decisions implemented - - Testing approaches used - - Extract actionable insights for current story implementation - - - - - 🏗️ ARCHITECTURE INTELLIGENCE - Extract everything the developer MUST follow! **ARCHITECTURE DOCUMENT ANALYSIS:** Systematically - analyze architecture content for story-relevant requirements: - - - - Load complete {architecture_content} - - - Load architecture index and scan all architecture files - **CRITICAL ARCHITECTURE EXTRACTION:** For - each architecture section, determine if relevant to this story: - **Technical Stack:** Languages, frameworks, libraries with - versions - **Code Structure:** Folder organization, naming conventions, file patterns - **API Patterns:** Service structure, endpoint - patterns, data contracts - **Database Schemas:** Tables, relationships, constraints relevant to story - **Security Requirements:** - Authentication patterns, authorization rules - **Performance Requirements:** Caching strategies, optimization patterns - **Testing - Standards:** Testing frameworks, coverage expectations, test patterns - **Deployment Patterns:** Environment configurations, build - processes - **Integration Patterns:** External service integrations, data flows Extract any story-specific requirements that the - developer MUST follow - Identify any architectural decisions that override previous patterns - - - - 🌐 ENSURE LATEST TECH KNOWLEDGE - Prevent outdated implementations! **WEB INTELLIGENCE:** Identify specific - technical areas that require latest version knowledge: - - - From architecture analysis, identify specific libraries, APIs, or - frameworks - For each critical technology, research latest stable version and key changes: - - Latest API documentation and breaking changes - - Security vulnerabilities or updates - - Performance improvements or deprecations - - Best practices for current version - - **EXTERNAL CONTEXT INCLUSION:** Include in story any critical latest information the developer needs: - - Specific library versions and why chosen - - API endpoints with parameters and authentication - - Recent security patches or considerations - - Performance optimization techniques - - Migration considerations if upgrading - - - - - 📝 CREATE ULTIMATE STORY FILE - The developer's master implementation guide! - - Initialize from template.md: - {default_output_file} - story_header - - - story_requirements - - - - developer_context_section **DEV AGENT GUARDRAILS:** - technical_requirements - architecture_compliance - library_framework_requirements - - file_structure_requirements - testing_requirements - - - - previous_story_intelligence - - - - - git_intelligence_summary - - - - - latest_tech_information - - - - project_context_reference - - - - story_completion_status - - - Set story Status to: "ready-for-dev" - Add completion note: "Ultimate - context engine analysis completed - comprehensive developer guide created" - - - - Validate the newly created story file {default_output_file} against `./checklist.md` and apply any required fixes before finalizing - Save story document unconditionally - - - - Update {{sprint_status}} - Load the FULL file and read all development_status entries - Find development_status key matching {{story_key}} - Verify current status is "backlog" (expected previous state) - Update development_status[{{story_key}}] = "ready-for-dev" - Update last_updated field to current date - Save file, preserving ALL comments and structure including STATUS DEFINITIONS - - - Report completion - **🎯 ULTIMATE BMad Method STORY CONTEXT CREATED, {user_name}!** - - **Story Details:** - - Story ID: {{story_id}} - - Story Key: {{story_key}} - - File: {{story_file}} - - Status: ready-for-dev - - **Next Steps:** - 1. Review the comprehensive story in {{story_file}} - 2. Run dev agents `dev-story` for optimized implementation - 3. Run `code-review` when complete (auto-marks done) - 4. Optional: If Test Architect module installed, run `/bmad:tea:automate` after `dev-story` to generate guardrail tests - - **The developer now has everything needed for flawless implementation!** - - - - diff --git a/src/bmm-skills/4-implementation/bmad-dev-story/SKILL.md b/src/bmm-skills/4-implementation/bmad-dev-story/SKILL.md index 0eb505cc7..218b234ab 100644 --- a/src/bmm-skills/4-implementation/bmad-dev-story/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-dev-story/SKILL.md @@ -3,4 +3,483 @@ name: bmad-dev-story description: 'Execute story implementation following a context filled story spec file. Use when the user says "dev this story [story file]" or "implement the next story in the sprint plan"' --- -Follow the instructions in ./workflow.md. +# Dev Story Workflow + +**Goal:** Execute story implementation following a context filled story spec file. + +**Your Role:** Developer implementing the story. +- Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level} +- Generate all documents in {document_output_language} +- Only modify the story file in these areas: Tasks/Subtasks checkboxes, Dev Agent Record (Debug Log, Completion Notes), File List, Change Log, and Status +- Execute ALL steps in exact order; do NOT skip steps +- Absolutely DO NOT stop because of "milestones", "significant progress", or "session boundaries". Continue in a single execution until the story is COMPLETE (all ACs satisfied and all tasks/subtasks checked) UNLESS a HALT condition is triggered or the USER gives other instruction. +- Do NOT schedule a "next session" or request review pauses unless a HALT condition applies. Only Step 9 decides completion. +- User skill level ({user_skill_level}) affects conversation style ONLY, not code updates. + +## Conventions + +- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `project_name`, `user_name` +- `communication_language`, `document_output_language` +- `user_skill_level` +- `implementation_artifacts` +- `date` as system-generated current datetime + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `story_file` = `` (explicit story path; auto-discovered if empty) +- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` + +## Execution + + + Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level} + Generate all documents in {document_output_language} + Only modify the story file in these areas: Tasks/Subtasks checkboxes, Dev Agent Record (Debug Log, Completion Notes), File List, + Change Log, and Status + Execute ALL steps in exact order; do NOT skip steps + Absolutely DO NOT stop because of "milestones", "significant progress", or "session boundaries". Continue in a single execution + until the story is COMPLETE (all ACs satisfied and all tasks/subtasks checked) UNLESS a HALT condition is triggered or the USER gives + other instruction. + Do NOT schedule a "next session" or request review pauses unless a HALT condition applies. Only Step 9 decides completion. + User skill level ({user_skill_level}) affects conversation style ONLY, not code updates. + + + + Use {{story_path}} directly + Read COMPLETE story file + Extract story_key from filename or metadata + + + + + + MUST read COMPLETE sprint-status.yaml file from start to end to preserve order + Load the FULL file: {{sprint_status}} + Read ALL lines from beginning to end - do not skip any content + Parse the development_status section completely to understand story order + + Find the FIRST story (by reading in order from top to bottom) where: + - Key matches pattern: number-number-name (e.g., "1-2-user-auth") + - NOT an epic key (epic-X) or retrospective (epic-X-retrospective) + - Status value equals "ready-for-dev" + + + + 📋 No ready-for-dev stories found in sprint-status.yaml + + **Current Sprint Status:** {{sprint_status_summary}} + + **What would you like to do?** + 1. Run `create-story` to create next story from epics with comprehensive context + 2. Run `*validate-create-story` to improve existing stories before development (recommended quality check) + 3. Specify a particular story file to develop (provide full path) + 4. Check {{sprint_status}} file to see current sprint status + + 💡 **Tip:** Stories in `ready-for-dev` may not have been validated. Consider running `validate-create-story` first for a quality + check. + + Choose option [1], [2], [3], or [4], or specify story file path: + + + HALT - Run create-story to create next story + + + + HALT - Run validate-create-story to improve existing stories + + + + Provide the story file path to develop: + Store user-provided story path as {{story_path}} + + + + + Loading {{sprint_status}} for detailed status review... + Display detailed sprint status analysis + HALT - User can review sprint status and provide story path + + + + Store user-provided story path as {{story_path}} + + + + + + + + Search {implementation_artifacts} for stories directly + Find stories with "ready-for-dev" status in files + Look for story files matching pattern: *-*-*.md + Read each candidate story file to check Status section + + + 📋 No ready-for-dev stories found + + **Available Options:** + 1. Run `create-story` to create next story from epics with comprehensive context + 2. Run `*validate-create-story` to improve existing stories + 3. Specify which story to develop + + What would you like to do? Choose option [1], [2], or [3]: + + + HALT - Run create-story to create next story + + + + HALT - Run validate-create-story to improve existing stories + + + + It's unclear what story you want developed. Please provide the full path to the story file: + Store user-provided story path as {{story_path}} + Continue with provided story file + + + + + Use discovered story file and extract story_key + + + + Store the found story_key (e.g., "1-2-user-authentication") for later status updates + Find matching story file in {implementation_artifacts} using story_key pattern: {{story_key}}.md + Read COMPLETE story file from discovered path + + + + Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Dev Agent Record, File List, Change Log, Status + + Load comprehensive context from story file's Dev Notes section + Extract developer guidance from Dev Notes: architecture requirements, previous learnings, technical specifications + Use enhanced story context to inform implementation decisions and approaches + + Identify first incomplete task (unchecked [ ]) in Tasks/Subtasks + + + Completion sequence + + HALT: "Cannot develop story without access to story file" + ASK user to clarify or HALT + + + + Load all available context to inform implementation + + Load {project_context} for coding standards and project-wide patterns (if exists) + Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Dev Agent Record, File List, Change Log, Status + Load comprehensive context from story file's Dev Notes section + Extract developer guidance from Dev Notes: architecture requirements, previous learnings, technical specifications + Use enhanced story context to inform implementation decisions and approaches + ✅ **Context Loaded** + Story and project context available for implementation + + + + + Determine if this is a fresh start or continuation after code review + + Check if "Senior Developer Review (AI)" section exists in the story file + Check if "Review Follow-ups (AI)" subsection exists under Tasks/Subtasks + + + Set review_continuation = true + Extract from "Senior Developer Review (AI)" section: + - Review outcome (Approve/Changes Requested/Blocked) + - Review date + - Total action items with checkboxes (count checked vs unchecked) + - Severity breakdown (High/Med/Low counts) + + Count unchecked [ ] review follow-up tasks in "Review Follow-ups (AI)" subsection + Store list of unchecked review items as {{pending_review_items}} + + ⏯️ **Resuming Story After Code Review** ({{review_date}}) + + **Review Outcome:** {{review_outcome}} + **Action Items:** {{unchecked_review_count}} remaining to address + **Priorities:** {{high_count}} High, {{med_count}} Medium, {{low_count}} Low + + **Strategy:** Will prioritize review follow-up tasks (marked [AI-Review]) before continuing with regular tasks. + + + + + Set review_continuation = false + Set {{pending_review_items}} = empty + + 🚀 **Starting Fresh Implementation** + + Story: {{story_key}} + Story Status: {{current_status}} + First incomplete task: {{first_task_description}} + + + + + + + Load the FULL file: {{sprint_status}} + Read all development_status entries to find {{story_key}} + Get current status value for development_status[{{story_key}}] + + + Update the story in the sprint status report to = "in-progress" + Update last_updated field to current date + 🚀 Starting work on story {{story_key}} + Status updated: ready-for-dev → in-progress + + + + + ⏯️ Resuming work on story {{story_key}} + Story is already marked in-progress + + + + + ⚠️ Unexpected story status: {{current_status}} + Expected ready-for-dev or in-progress. Continuing anyway... + + + + Store {{current_sprint_status}} for later use + + + + ℹ️ No sprint status file exists - story progress will be tracked in story file only + Set {{current_sprint_status}} = "no-sprint-tracking" + + + + + FOLLOW THE STORY FILE TASKS/SUBTASKS SEQUENCE EXACTLY AS WRITTEN - NO DEVIATION + + Review the current task/subtask from the story file - this is your authoritative implementation guide + Plan implementation following red-green-refactor cycle + + + Write FAILING tests first for the task/subtask functionality + Confirm tests fail before implementation - this validates test correctness + + + Implement MINIMAL code to make tests pass + Run tests to confirm they now pass + Handle error conditions and edge cases as specified in task/subtask + + + Improve code structure while keeping tests green + Ensure code follows architecture patterns and coding standards from Dev Notes + + Document technical approach and decisions in Dev Agent Record → Implementation Plan + + HALT: "Additional dependencies need user approval" + HALT and request guidance + HALT: "Cannot proceed without necessary configuration files" + + NEVER implement anything not mapped to a specific task/subtask in the story file + NEVER proceed to next task until current task/subtask is complete AND tests pass + Execute continuously without pausing until all tasks/subtasks are complete or explicit HALT condition + Do NOT propose to pause for review until Step 9 completion gates are satisfied + + + + Create unit tests for business logic and core functionality introduced/changed by the task + Add integration tests for component interactions specified in story requirements + Include end-to-end tests for critical user flows when story requirements demand them + Cover edge cases and error handling scenarios identified in story Dev Notes + + + + Determine how to run tests for this repo (infer test framework from project structure) + Run all existing tests to ensure no regressions + Run the new tests to verify implementation correctness + Run linting and code quality checks if configured in project + Validate implementation meets ALL story acceptance criteria; enforce quantitative thresholds explicitly + STOP and fix before continuing - identify breaking changes immediately + STOP and fix before continuing - ensure implementation correctness + + + + NEVER mark a task complete unless ALL conditions are met - NO LYING OR CHEATING + + + Verify ALL tests for this task/subtask ACTUALLY EXIST and PASS 100% + Confirm implementation matches EXACTLY what the task/subtask specifies - no extra features + Validate that ALL acceptance criteria related to this task are satisfied + Run full test suite to ensure NO regressions introduced + + + + Extract review item details (severity, description, related AC/file) + Add to resolution tracking list: {{resolved_review_items}} + + + Mark task checkbox [x] in "Tasks/Subtasks → Review Follow-ups (AI)" section + + + Find matching action item in "Senior Developer Review (AI) → Action Items" section by matching description + Mark that action item checkbox [x] as resolved + + Add to Dev Agent Record → Completion Notes: "✅ Resolved review finding [{{severity}}]: {{description}}" + + + + + ONLY THEN mark the task (and subtasks) checkbox with [x] + Update File List section with ALL new, modified, or deleted files (paths relative to repo root) + Add completion notes to Dev Agent Record summarizing what was ACTUALLY implemented and tested + + + + DO NOT mark task complete - fix issues first + HALT if unable to fix validation failures + + + + Count total resolved review items in this session + Add Change Log entry: "Addressed code review findings - {{resolved_count}} items resolved (Date: {{date}})" + + + Save the story file + Determine if more incomplete tasks remain + + Next task + + + Completion + + + + + Verify ALL tasks and subtasks are marked [x] (re-scan the story document now) + Run the full regression suite (do not skip) + Confirm File List includes every changed file + Execute enhanced definition-of-done validation + Update the story Status to: "review" + + + Validate definition-of-done checklist with essential requirements: + - All tasks/subtasks marked complete with [x] + - Implementation satisfies every Acceptance Criterion + - Unit tests for core functionality added/updated + - Integration tests for component interactions added when required + - End-to-end tests for critical flows added when story demands them + - All tests pass (no regressions, new tests successful) + - Code quality checks pass (linting, static analysis if configured) + - File List includes every new/modified/deleted file (relative paths) + - Dev Agent Record contains implementation notes + - Change Log includes summary of changes + - Only permitted story sections were modified + + + + + Load the FULL file: {sprint_status} + Find development_status key matching {{story_key}} + Verify current status is "in-progress" (expected previous state) + Update development_status[{{story_key}}] = "review" + Update last_updated field to current date + Save file, preserving ALL comments and structure including STATUS DEFINITIONS + ✅ Story status updated to "review" in sprint-status.yaml + + + + ℹ️ Story status updated to "review" in story file (no sprint tracking configured) + + + + ⚠️ Story file updated, but sprint-status update failed: {{story_key}} not found + + Story status is set to "review" in file, but sprint-status.yaml may be out of sync. + + + + + HALT - Complete remaining tasks before marking ready for review + HALT - Fix regression issues before completing + HALT - Update File List with all changed files + HALT - Address DoD failures before completing + + + + Execute the enhanced definition-of-done checklist using the validation framework + Prepare a concise summary in Dev Agent Record → Completion Notes + + Communicate to {user_name} that story implementation is complete and ready for review + Summarize key accomplishments: story ID, story key, title, key changes made, tests added, files modified + Provide the story file path and current status (now "review") + + Based on {user_skill_level}, ask if user needs any explanations about: + - What was implemented and how it works + - Why certain technical decisions were made + - How to test or verify the changes + - Any patterns, libraries, or approaches used + - Anything else they'd like clarified + + + + Provide clear, contextual explanations tailored to {user_skill_level} + Use examples and references to specific code when helpful + + + Once explanations are complete (or user indicates no questions), suggest logical next steps + Recommended next steps (flexible based on project setup): + - Review the implemented story and test the changes + - Verify all acceptance criteria are met + - Ensure deployment readiness if applicable + - Run `code-review` workflow for peer review + - Optional: If Test Architect module installed, run `/bmad:tea:automate` to expand guardrail tests + + + 💡 **Tip:** For best results, run `code-review` using a **different** LLM than the one that implemented this story. + + Suggest checking {sprint_status} to see project progress + + Remain flexible - allow user to choose their own path or ask for other assistance + Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. + + + diff --git a/src/bmm-skills/4-implementation/bmad-dev-story/customize.toml b/src/bmm-skills/4-implementation/bmad-dev-story/customize.toml new file mode 100644 index 000000000..84f5dcbe4 --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-dev-story/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-dev-story. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All stories must include testable acceptance criteria." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its final step, +# after the story implementation is complete and status is updated. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-dev-story/workflow.md b/src/bmm-skills/4-implementation/bmad-dev-story/workflow.md deleted file mode 100644 index 4164479c3..000000000 --- a/src/bmm-skills/4-implementation/bmad-dev-story/workflow.md +++ /dev/null @@ -1,450 +0,0 @@ -# Dev Story Workflow - -**Goal:** Execute story implementation following a context filled story spec file. - -**Your Role:** Developer implementing the story. -- Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level} -- Generate all documents in {document_output_language} -- Only modify the story file in these areas: Tasks/Subtasks checkboxes, Dev Agent Record (Debug Log, Completion Notes), File List, Change Log, and Status -- Execute ALL steps in exact order; do NOT skip steps -- Absolutely DO NOT stop because of "milestones", "significant progress", or "session boundaries". Continue in a single execution until the story is COMPLETE (all ACs satisfied and all tasks/subtasks checked) UNLESS a HALT condition is triggered or the USER gives other instruction. -- Do NOT schedule a "next session" or request review pauses unless a HALT condition applies. Only Step 6 decides completion. -- User skill level ({user_skill_level}) affects conversation style ONLY, not code updates. - ---- - -## INITIALIZATION - -### Configuration Loading - -Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - -- `project_name`, `user_name` -- `communication_language`, `document_output_language` -- `user_skill_level` -- `implementation_artifacts` -- `date` as system-generated current datetime - -### Paths - -- `story_file` = `` (explicit story path; auto-discovered if empty) -- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` - -### Context - -- `project_context` = `**/project-context.md` (load if exists) - ---- - -## EXECUTION - - - Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level} - Generate all documents in {document_output_language} - Only modify the story file in these areas: Tasks/Subtasks checkboxes, Dev Agent Record (Debug Log, Completion Notes), File List, - Change Log, and Status - Execute ALL steps in exact order; do NOT skip steps - Absolutely DO NOT stop because of "milestones", "significant progress", or "session boundaries". Continue in a single execution - until the story is COMPLETE (all ACs satisfied and all tasks/subtasks checked) UNLESS a HALT condition is triggered or the USER gives - other instruction. - Do NOT schedule a "next session" or request review pauses unless a HALT condition applies. Only Step 6 decides completion. - User skill level ({user_skill_level}) affects conversation style ONLY, not code updates. - - - - Use {{story_path}} directly - Read COMPLETE story file - Extract story_key from filename or metadata - - - - - - MUST read COMPLETE sprint-status.yaml file from start to end to preserve order - Load the FULL file: {{sprint_status}} - Read ALL lines from beginning to end - do not skip any content - Parse the development_status section completely to understand story order - - Find the FIRST story (by reading in order from top to bottom) where: - - Key matches pattern: number-number-name (e.g., "1-2-user-auth") - - NOT an epic key (epic-X) or retrospective (epic-X-retrospective) - - Status value equals "ready-for-dev" - - - - 📋 No ready-for-dev stories found in sprint-status.yaml - - **Current Sprint Status:** {{sprint_status_summary}} - - **What would you like to do?** - 1. Run `create-story` to create next story from epics with comprehensive context - 2. Run `*validate-create-story` to improve existing stories before development (recommended quality check) - 3. Specify a particular story file to develop (provide full path) - 4. Check {{sprint_status}} file to see current sprint status - - 💡 **Tip:** Stories in `ready-for-dev` may not have been validated. Consider running `validate-create-story` first for a quality - check. - - Choose option [1], [2], [3], or [4], or specify story file path: - - - HALT - Run create-story to create next story - - - - HALT - Run validate-create-story to improve existing stories - - - - Provide the story file path to develop: - Store user-provided story path as {{story_path}} - - - - - Loading {{sprint_status}} for detailed status review... - Display detailed sprint status analysis - HALT - User can review sprint status and provide story path - - - - Store user-provided story path as {{story_path}} - - - - - - - - Search {implementation_artifacts} for stories directly - Find stories with "ready-for-dev" status in files - Look for story files matching pattern: *-*-*.md - Read each candidate story file to check Status section - - - 📋 No ready-for-dev stories found - - **Available Options:** - 1. Run `create-story` to create next story from epics with comprehensive context - 2. Run `*validate-create-story` to improve existing stories - 3. Specify which story to develop - - What would you like to do? Choose option [1], [2], or [3]: - - - HALT - Run create-story to create next story - - - - HALT - Run validate-create-story to improve existing stories - - - - It's unclear what story you want developed. Please provide the full path to the story file: - Store user-provided story path as {{story_path}} - Continue with provided story file - - - - - Use discovered story file and extract story_key - - - - Store the found story_key (e.g., "1-2-user-authentication") for later status updates - Find matching story file in {implementation_artifacts} using story_key pattern: {{story_key}}.md - Read COMPLETE story file from discovered path - - - - Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Dev Agent Record, File List, Change Log, Status - - Load comprehensive context from story file's Dev Notes section - Extract developer guidance from Dev Notes: architecture requirements, previous learnings, technical specifications - Use enhanced story context to inform implementation decisions and approaches - - Identify first incomplete task (unchecked [ ]) in Tasks/Subtasks - - - Completion sequence - - HALT: "Cannot develop story without access to story file" - ASK user to clarify or HALT - - - - Load all available context to inform implementation - - Load {project_context} for coding standards and project-wide patterns (if exists) - Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Dev Agent Record, File List, Change Log, Status - Load comprehensive context from story file's Dev Notes section - Extract developer guidance from Dev Notes: architecture requirements, previous learnings, technical specifications - Use enhanced story context to inform implementation decisions and approaches - ✅ **Context Loaded** - Story and project context available for implementation - - - - - Determine if this is a fresh start or continuation after code review - - Check if "Senior Developer Review (AI)" section exists in the story file - Check if "Review Follow-ups (AI)" subsection exists under Tasks/Subtasks - - - Set review_continuation = true - Extract from "Senior Developer Review (AI)" section: - - Review outcome (Approve/Changes Requested/Blocked) - - Review date - - Total action items with checkboxes (count checked vs unchecked) - - Severity breakdown (High/Med/Low counts) - - Count unchecked [ ] review follow-up tasks in "Review Follow-ups (AI)" subsection - Store list of unchecked review items as {{pending_review_items}} - - ⏯️ **Resuming Story After Code Review** ({{review_date}}) - - **Review Outcome:** {{review_outcome}} - **Action Items:** {{unchecked_review_count}} remaining to address - **Priorities:** {{high_count}} High, {{med_count}} Medium, {{low_count}} Low - - **Strategy:** Will prioritize review follow-up tasks (marked [AI-Review]) before continuing with regular tasks. - - - - - Set review_continuation = false - Set {{pending_review_items}} = empty - - 🚀 **Starting Fresh Implementation** - - Story: {{story_key}} - Story Status: {{current_status}} - First incomplete task: {{first_task_description}} - - - - - - - Load the FULL file: {{sprint_status}} - Read all development_status entries to find {{story_key}} - Get current status value for development_status[{{story_key}}] - - - Update the story in the sprint status report to = "in-progress" - Update last_updated field to current date - 🚀 Starting work on story {{story_key}} - Status updated: ready-for-dev → in-progress - - - - - ⏯️ Resuming work on story {{story_key}} - Story is already marked in-progress - - - - - ⚠️ Unexpected story status: {{current_status}} - Expected ready-for-dev or in-progress. Continuing anyway... - - - - Store {{current_sprint_status}} for later use - - - - ℹ️ No sprint status file exists - story progress will be tracked in story file only - Set {{current_sprint_status}} = "no-sprint-tracking" - - - - - FOLLOW THE STORY FILE TASKS/SUBTASKS SEQUENCE EXACTLY AS WRITTEN - NO DEVIATION - - Review the current task/subtask from the story file - this is your authoritative implementation guide - Plan implementation following red-green-refactor cycle - - - Write FAILING tests first for the task/subtask functionality - Confirm tests fail before implementation - this validates test correctness - - - Implement MINIMAL code to make tests pass - Run tests to confirm they now pass - Handle error conditions and edge cases as specified in task/subtask - - - Improve code structure while keeping tests green - Ensure code follows architecture patterns and coding standards from Dev Notes - - Document technical approach and decisions in Dev Agent Record → Implementation Plan - - HALT: "Additional dependencies need user approval" - HALT and request guidance - HALT: "Cannot proceed without necessary configuration files" - - NEVER implement anything not mapped to a specific task/subtask in the story file - NEVER proceed to next task until current task/subtask is complete AND tests pass - Execute continuously without pausing until all tasks/subtasks are complete or explicit HALT condition - Do NOT propose to pause for review until Step 9 completion gates are satisfied - - - - Create unit tests for business logic and core functionality introduced/changed by the task - Add integration tests for component interactions specified in story requirements - Include end-to-end tests for critical user flows when story requirements demand them - Cover edge cases and error handling scenarios identified in story Dev Notes - - - - Determine how to run tests for this repo (infer test framework from project structure) - Run all existing tests to ensure no regressions - Run the new tests to verify implementation correctness - Run linting and code quality checks if configured in project - Validate implementation meets ALL story acceptance criteria; enforce quantitative thresholds explicitly - STOP and fix before continuing - identify breaking changes immediately - STOP and fix before continuing - ensure implementation correctness - - - - NEVER mark a task complete unless ALL conditions are met - NO LYING OR CHEATING - - - Verify ALL tests for this task/subtask ACTUALLY EXIST and PASS 100% - Confirm implementation matches EXACTLY what the task/subtask specifies - no extra features - Validate that ALL acceptance criteria related to this task are satisfied - Run full test suite to ensure NO regressions introduced - - - - Extract review item details (severity, description, related AC/file) - Add to resolution tracking list: {{resolved_review_items}} - - - Mark task checkbox [x] in "Tasks/Subtasks → Review Follow-ups (AI)" section - - - Find matching action item in "Senior Developer Review (AI) → Action Items" section by matching description - Mark that action item checkbox [x] as resolved - - Add to Dev Agent Record → Completion Notes: "✅ Resolved review finding [{{severity}}]: {{description}}" - - - - - ONLY THEN mark the task (and subtasks) checkbox with [x] - Update File List section with ALL new, modified, or deleted files (paths relative to repo root) - Add completion notes to Dev Agent Record summarizing what was ACTUALLY implemented and tested - - - - DO NOT mark task complete - fix issues first - HALT if unable to fix validation failures - - - - Count total resolved review items in this session - Add Change Log entry: "Addressed code review findings - {{resolved_count}} items resolved (Date: {{date}})" - - - Save the story file - Determine if more incomplete tasks remain - - Next task - - - Completion - - - - - Verify ALL tasks and subtasks are marked [x] (re-scan the story document now) - Run the full regression suite (do not skip) - Confirm File List includes every changed file - Execute enhanced definition-of-done validation - Update the story Status to: "review" - - - Validate definition-of-done checklist with essential requirements: - - All tasks/subtasks marked complete with [x] - - Implementation satisfies every Acceptance Criterion - - Unit tests for core functionality added/updated - - Integration tests for component interactions added when required - - End-to-end tests for critical flows added when story demands them - - All tests pass (no regressions, new tests successful) - - Code quality checks pass (linting, static analysis if configured) - - File List includes every new/modified/deleted file (relative paths) - - Dev Agent Record contains implementation notes - - Change Log includes summary of changes - - Only permitted story sections were modified - - - - - Load the FULL file: {sprint_status} - Find development_status key matching {{story_key}} - Verify current status is "in-progress" (expected previous state) - Update development_status[{{story_key}}] = "review" - Update last_updated field to current date - Save file, preserving ALL comments and structure including STATUS DEFINITIONS - ✅ Story status updated to "review" in sprint-status.yaml - - - - ℹ️ Story status updated to "review" in story file (no sprint tracking configured) - - - - ⚠️ Story file updated, but sprint-status update failed: {{story_key}} not found - - Story status is set to "review" in file, but sprint-status.yaml may be out of sync. - - - - - HALT - Complete remaining tasks before marking ready for review - HALT - Fix regression issues before completing - HALT - Update File List with all changed files - HALT - Address DoD failures before completing - - - - Execute the enhanced definition-of-done checklist using the validation framework - Prepare a concise summary in Dev Agent Record → Completion Notes - - Communicate to {user_name} that story implementation is complete and ready for review - Summarize key accomplishments: story ID, story key, title, key changes made, tests added, files modified - Provide the story file path and current status (now "review") - - Based on {user_skill_level}, ask if user needs any explanations about: - - What was implemented and how it works - - Why certain technical decisions were made - - How to test or verify the changes - - Any patterns, libraries, or approaches used - - Anything else they'd like clarified - - - - Provide clear, contextual explanations tailored to {user_skill_level} - Use examples and references to specific code when helpful - - - Once explanations are complete (or user indicates no questions), suggest logical next steps - Recommended next steps (flexible based on project setup): - - Review the implemented story and test the changes - - Verify all acceptance criteria are met - - Ensure deployment readiness if applicable - - Run `code-review` workflow for peer review - - Optional: If Test Architect module installed, run `/bmad:tea:automate` to expand guardrail tests - - - 💡 **Tip:** For best results, run `code-review` using a **different** LLM than the one that implemented this story. - - Suggest checking {sprint_status} to see project progress - - Remain flexible - allow user to choose their own path or ask for other assistance - - - diff --git a/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/SKILL.md b/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/SKILL.md index 5235f7b6c..ef9d7e87a 100644 --- a/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/SKILL.md @@ -3,4 +3,174 @@ name: bmad-qa-generate-e2e-tests description: 'Generate end to end automated tests for existing features. Use when the user says "create qa automated tests for [feature]"' --- -Follow the instructions in ./workflow.md. +# QA Generate E2E Tests Workflow + +**Goal:** Generate automated API and E2E tests for implemented code. + +**Your Role:** You are a QA automation engineer. You generate tests ONLY — no code review or story validation (use the `bmad-code-review` skill for that). + +## Conventions + +- Bare paths (e.g. `checklist.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `project_name`, `user_name` +- `communication_language`, `document_output_language` +- `implementation_artifacts` +- `date` as system-generated current datetime +- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## Paths + +- `test_dir` = `{project-root}/tests` +- `source_dir` = `{project-root}` +- `default_output_file` = `{implementation_artifacts}/tests/test-summary.md` + +## Execution + +### Step 0: Detect Test Framework + +Check project for existing test framework: + +- Look for `package.json` dependencies (playwright, jest, vitest, cypress, etc.) +- Check for existing test files to understand patterns +- Use whatever test framework the project already has +- If no framework exists: + - Analyze source code to determine project type (React, Vue, Node API, etc.) + - Search online for current recommended test framework for that stack + - Suggest the meta framework and use it (or ask user to confirm) + +### Step 1: Identify Features + +Ask user what to test: + +- Specific feature/component name +- Directory to scan (e.g., `src/components/`) +- Or auto-discover features in the codebase + +### Step 2: Generate API Tests (if applicable) + +For API endpoints/services, generate tests that: + +- Test status codes (200, 400, 404, 500) +- Validate response structure +- Cover happy path + 1-2 error cases +- Use project's existing test framework patterns + +### Step 3: Generate E2E Tests (if UI exists) + +For UI features, generate tests that: + +- Test user workflows end-to-end +- Use semantic locators (roles, labels, text) +- Focus on user interactions (clicks, form fills, navigation) +- Assert visible outcomes +- Keep tests linear and simple +- Follow project's existing test patterns + +### Step 4: Run Tests + +Execute tests to verify they pass (use project's test command). + +If failures occur, fix them immediately. + +### Step 5: Create Summary + +Output markdown summary: + +```markdown +# Test Automation Summary + +## Generated Tests + +### API Tests +- [x] tests/api/endpoint.spec.ts - Endpoint validation + +### E2E Tests +- [x] tests/e2e/feature.spec.ts - User workflow + +## Coverage +- API endpoints: 5/10 covered +- UI features: 3/8 covered + +## Next Steps +- Run tests in CI +- Add more edge cases as needed +``` + +## Keep It Simple + +**Do:** + +- Use standard test framework APIs +- Focus on happy path + critical errors +- Write readable, maintainable tests +- Run tests to verify they pass + +**Avoid:** + +- Complex fixture composition +- Over-engineering +- Unnecessary abstractions + +**For Advanced Features:** + +If the project needs: + +- Risk-based test strategy +- Test design planning +- Quality gates and NFR assessment +- Comprehensive coverage analysis +- Advanced testing patterns and utilities + +> **Install Test Architect (TEA) module**: + +## Output + +Save summary to: `{default_output_file}` + +**Done!** Tests generated and verified. Validate against `./checklist.md`. + +## On Complete + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` + +If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting. diff --git a/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/customize.toml b/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/customize.toml new file mode 100644 index 000000000..0a2c6fec5 --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-qa-generate-e2e-tests. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All tests must follow the project's existing test framework patterns." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches Step 5 (Create Summary), +# after all tests pass and the summary document is saved. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/workflow.md b/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/workflow.md deleted file mode 100644 index c7159019c..000000000 --- a/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/workflow.md +++ /dev/null @@ -1,136 +0,0 @@ -# QA Generate E2E Tests Workflow - -**Goal:** Generate automated API and E2E tests for implemented code. - -**Your Role:** You are a QA automation engineer. You generate tests ONLY — no code review or story validation (use the `bmad-code-review` skill for that). - ---- - -## INITIALIZATION - -### Configuration Loading - -Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - -- `project_name`, `user_name` -- `communication_language`, `document_output_language` -- `implementation_artifacts` -- `date` as system-generated current datetime -- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` - -### Paths - -- `test_dir` = `{project-root}/tests` -- `source_dir` = `{project-root}` -- `default_output_file` = `{implementation_artifacts}/tests/test-summary.md` - -### Context - -- `project_context` = `**/project-context.md` (load if exists) - ---- - -## EXECUTION - -### Step 0: Detect Test Framework - -Check project for existing test framework: - -- Look for `package.json` dependencies (playwright, jest, vitest, cypress, etc.) -- Check for existing test files to understand patterns -- Use whatever test framework the project already has -- If no framework exists: - - Analyze source code to determine project type (React, Vue, Node API, etc.) - - Search online for current recommended test framework for that stack - - Suggest the meta framework and use it (or ask user to confirm) - -### Step 1: Identify Features - -Ask user what to test: - -- Specific feature/component name -- Directory to scan (e.g., `src/components/`) -- Or auto-discover features in the codebase - -### Step 2: Generate API Tests (if applicable) - -For API endpoints/services, generate tests that: - -- Test status codes (200, 400, 404, 500) -- Validate response structure -- Cover happy path + 1-2 error cases -- Use project's existing test framework patterns - -### Step 3: Generate E2E Tests (if UI exists) - -For UI features, generate tests that: - -- Test user workflows end-to-end -- Use semantic locators (roles, labels, text) -- Focus on user interactions (clicks, form fills, navigation) -- Assert visible outcomes -- Keep tests linear and simple -- Follow project's existing test patterns - -### Step 4: Run Tests - -Execute tests to verify they pass (use project's test command). - -If failures occur, fix them immediately. - -### Step 5: Create Summary - -Output markdown summary: - -```markdown -# Test Automation Summary - -## Generated Tests - -### API Tests -- [x] tests/api/endpoint.spec.ts - Endpoint validation - -### E2E Tests -- [x] tests/e2e/feature.spec.ts - User workflow - -## Coverage -- API endpoints: 5/10 covered -- UI features: 3/8 covered - -## Next Steps -- Run tests in CI -- Add more edge cases as needed -``` - -## Keep It Simple - -**Do:** - -- Use standard test framework APIs -- Focus on happy path + critical errors -- Write readable, maintainable tests -- Run tests to verify they pass - -**Avoid:** - -- Complex fixture composition -- Over-engineering -- Unnecessary abstractions - -**For Advanced Features:** - -If the project needs: - -- Risk-based test strategy -- Test design planning -- Quality gates and NFR assessment -- Comprehensive coverage analysis -- Advanced testing patterns and utilities - -> **Install Test Architect (TEA) module**: - -## Output - -Save summary to: `{default_output_file}` - -**Done!** Tests generated and verified. Validate against `./checklist.md`. diff --git a/src/bmm-skills/4-implementation/bmad-quick-dev/SKILL.md b/src/bmm-skills/4-implementation/bmad-quick-dev/SKILL.md index b2f0df476..f5326fc3f 100644 --- a/src/bmm-skills/4-implementation/bmad-quick-dev/SKILL.md +++ b/src/bmm-skills/4-implementation/bmad-quick-dev/SKILL.md @@ -3,4 +3,109 @@ name: bmad-quick-dev description: 'Implements any user intent, requirement, story, bug fix or change request by producing clean working code artifacts that follow the project''s existing architecture, patterns and conventions. Use when the user wants to build, fix, tweak, refactor, add or modify any code, component or feature.' --- -Follow the instructions in ./workflow.md. +# Quick Dev New Preview Workflow + +**Goal:** Turn user intent into a hardened, reviewable artifact. + +**CRITICAL:** If a step says "read fully and follow step-XX", you read and follow step-XX. No exceptions. + +## READY FOR DEVELOPMENT STANDARD + +A specification is "Ready for Development" when: + +- **Actionable**: Every task has a file path and specific action. +- **Logical**: Tasks ordered by dependency. +- **Testable**: All ACs use Given/When/Then. +- **Complete**: No placeholders or TBDs. + +## SCOPE STANDARD + +A specification should target a **single user-facing goal** within **900–1600 tokens**: + +- **Single goal**: One cohesive feature, even if it spans multiple layers/files. Multi-goal means >=2 **top-level independent shippable deliverables** — each could be reviewed, tested, and merged as a separate PR without breaking the others. Never count surface verbs, "and" conjunctions, or noun phrases. Never split cross-layer implementation details inside one user goal. + - Split: "add dark mode toggle AND refactor auth to JWT AND build admin dashboard" + - Don't split: "add validation and display errors" / "support drag-and-drop AND paste AND retry" +- **900–1600 tokens**: Optimal range for LLM consumption. Below 900 risks ambiguity; above 1600 risks context-rot in implementation agents. +- **Neither limit is a gate.** Both are proposals with user override. + +## Conventions + +- Bare paths (e.g. `step-01-clarify-and-route.md`) resolve from the skill root. +- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives). +- `{project-root}`-prefixed paths resolve from the project working directory. +- `{skill-name}` resolves to the skill directory's basename. + +## On Activation + +### Step 1: Resolve the Workflow Block + +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow` + +**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver: + +1. `{skill-root}/customize.toml` — defaults +2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides +3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides + +Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append. + +### Step 2: Execute Prepend Steps + +Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding. + +### Step 3: Load Persistent Facts + +Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` -- load the referenced contents as facts. All other entries are facts verbatim. + +### Step 4: Load Config + +Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: + +- `project_name`, `planning_artifacts`, `implementation_artifacts`, `user_name` +- `communication_language`, `document_output_language`, `user_skill_level` +- `date` as system-generated current datetime +- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml` +- `project_context` = `**/project-context.md` (load if exists) +- CLAUDE.md / memory files (load if exist) +- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` +- Language MUST be tailored to `{user_skill_level}` +- Generate all documents in `{document_output_language}` + +### Step 5: Greet the User + +Greet `{user_name}`, speaking in `{communication_language}`. + +### Step 6: Execute Append Steps + +Execute each entry in `{workflow.activation_steps_append}` in order. + +Activation is complete. Begin the workflow below. + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +- **Micro-file Design**: Each step is self-contained and followed exactly +- **Just-In-Time Loading**: Only load the current step file +- **Sequential Enforcement**: Complete steps in order, no skipping +- **State Tracking**: Persist progress via spec frontmatter and in-memory variables +- **Append-Only Building**: Build artifacts incrementally + +### Step Processing Rules + +1. **READ COMPLETELY**: Read the entire step file before acting +2. **FOLLOW SEQUENCE**: Execute sections in order +3. **WAIT FOR INPUT**: Halt at checkpoints and wait for human +4. **LOAD NEXT**: When directed, read fully and follow the next step file + +### Critical Rules (NO EXCEPTIONS) + +- **NEVER** load multiple step files simultaneously +- **ALWAYS** read entire step file before execution +- **NEVER** skip steps or optimize the sequence +- **ALWAYS** follow the exact instructions in the step file +- **ALWAYS** halt at checkpoints and wait for human input + +## FIRST STEP + +Read fully and follow: `./step-01-clarify-and-route.md` to begin the workflow. diff --git a/src/bmm-skills/4-implementation/bmad-quick-dev/compile-epic-context.md b/src/bmm-skills/4-implementation/bmad-quick-dev/compile-epic-context.md new file mode 100644 index 000000000..03034770b --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-quick-dev/compile-epic-context.md @@ -0,0 +1,62 @@ +# Compile Epic Context + +**Task** +Given an epic number, the epics file, the planning artifacts directory, and a desired output path, compile a clean, focused, developer-ready context file (`epic--context.md`). + +**Steps** + +1. Read the epics file and extract the target epic's title, goal, and list of stories. +2. Scan the planning artifacts directory for the standard files (PRD, architecture, UX/design, product brief). +3. Pull only the information relevant to this epic. +4. Write the compiled context to the exact output path using the format below. + +## Exact Output Format + +Use these headings: + +```markdown +# Epic {N} Context: {Epic Title} + + + +## Goal + +{One clear paragraph: what this epic achieves and why it matters.} + +## Stories + +- Story X.Y: Brief title only +- ... + +## Requirements & Constraints + +{Relevant functional/non-functional requirements and success criteria for this epic (describe by purpose, not source).} + +## Technical Decisions + +{Key architecture decisions, constraints, patterns, data models, and conventions relevant to this epic.} + +## UX & Interaction Patterns + +{Relevant UX flows, interaction patterns, and design constraints (omit section entirely if nothing relevant).} + +## Cross-Story Dependencies + +{Dependencies between stories in this epic or with other epics/systems (omit if none).} +``` + +## Rules + +- **Scope aggressively.** Include only what a developer working on any story in this epic actually needs. When in doubt, leave it out — the developer can always read the full planning doc. +- **Describe by purpose, not by source.** Write "API responses must include pagination metadata" not "Per PRD section 3.2.1, pagination is required." Planning doc internals will change; the constraint won't. +- **No full copies.** Never quote source documents, section numbers, or paste large blocks verbatim. Always distill. +- **No story-level details.** The story list is for orientation only. Individual story specs handle the details. +- **Nothing derivable from the codebase.** Don't document what a developer can learn by reading the code. +- **Be concise and actionable.** Target 800–1500 tokens total. This file loads into quick-dev's context alongside other material. +- **Never hallucinate content.** If source material doesn't say something, don't invent it. +- **Omit empty sections entirely**, except Goal and Stories, which are always required. + +## Error handling + +- **If the epics file is missing or the target epic is not found:** write nothing and report the problem to the calling agent. Goal and Stories cannot be populated without a usable epics file. +- **If planning artifacts are missing or empty:** still produce the file with Goal and Stories populated from the epics file, and note the gap in the Goal section. Never hallucinate content to fill missing sections. diff --git a/src/bmm-skills/4-implementation/bmad-quick-dev/customize.toml b/src/bmm-skills/4-implementation/bmad-quick-dev/customize.toml new file mode 100644 index 000000000..351465443 --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-quick-dev/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-quick-dev. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All stories must include testable acceptance criteria." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its final step, +# after implementation is complete and explanations are provided. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-quick-dev/spec-template.md b/src/bmm-skills/4-implementation/bmad-quick-dev/spec-template.md index 3f70a5134..b0e4f53d3 100644 --- a/src/bmm-skills/4-implementation/bmad-quick-dev/spec-template.md +++ b/src/bmm-skills/4-implementation/bmad-quick-dev/spec-template.md @@ -3,7 +3,7 @@ title: '{title}' type: 'feature' # feature | bugfix | refactor | chore created: '{date}' status: 'draft' # draft | ready-for-dev | in-progress | in-review | done -context: [] # optional: max 3 project-wide standards/docs. NO source code files. +context: [] # optional: `{project-root}/`-prefixed paths to project-wide standards/docs the implementation agent should load. Keep short — only what isn't already distilled into the spec body. --- + + + + + Load and parse {sprint_status_file} same as Step 2 + Compute recommendation same as Step 3 + next_workflow_id = {{next_workflow_id}} + next_story_id = {{next_story_id}} + count_backlog = {{count_backlog}} + count_ready = {{count_ready}} + count_in_progress = {{count_in_progress}} + count_review = {{count_review}} + count_done = {{count_done}} + epic_backlog = {{epic_backlog}} + epic_in_progress = {{epic_in_progress}} + epic_done = {{epic_done}} + risks = {{risks}} + Return to caller + + + + + + + + Check that {sprint_status_file} exists + + is_valid = false + error = "sprint-status.yaml missing" + suggestion = "Run sprint-planning to create it" + Return + + +Read and parse {sprint_status_file} + +Validate required metadata fields exist: generated, project, project_key, tracking_system, story_location (last_updated is optional for backward compatibility) + +is_valid = false +error = "Missing required field(s): {{missing_fields}}" +suggestion = "Re-run sprint-planning or add missing fields manually" +Return + + +Verify development_status section exists with at least one entry + +is_valid = false +error = "development_status missing or empty" +suggestion = "Re-run sprint-planning or repair the file manually" +Return + + +Validate all status values against known valid statuses: + +- Stories: backlog, ready-for-dev, in-progress, review, done (legacy: drafted) +- Epics: backlog, in-progress, done (legacy: contexted) +- Retrospectives: optional, done + + is_valid = false + error = "Invalid status values: {{invalid_entries}}" + suggestion = "Fix invalid statuses in sprint-status.yaml" + Return + + +is_valid = true +message = "sprint-status.yaml valid: metadata complete, all statuses recognized" +Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting. + + + diff --git a/src/bmm-skills/4-implementation/bmad-sprint-status/customize.toml b/src/bmm-skills/4-implementation/bmad-sprint-status/customize.toml new file mode 100644 index 000000000..c3c5600c4 --- /dev/null +++ b/src/bmm-skills/4-implementation/bmad-sprint-status/customize.toml @@ -0,0 +1,41 @@ +# DO NOT EDIT -- overwritten on every update. +# +# Workflow customization surface for bmad-sprint-status. Mirrors the +# agent customization shape under the [workflow] namespace. + +[workflow] + +# --- Configurable below. Overrides merge per BMad structural rules: --- +# scalars: override wins • arrays (persistent_facts, activation_steps_*): append +# arrays-of-tables with `code`/`id`: replace matching items, append new ones. + +# Steps to run before the standard activation (config load, greet). +# Overrides append. Use for pre-flight loads, compliance checks, etc. + +activation_steps_prepend = [] + +# Steps to run after greet but before the workflow begins. +# Overrides append. Use for context-heavy setup that should happen +# once the user has been acknowledged. + +activation_steps_append = [] + +# Persistent facts the workflow keeps in mind for the whole run +# (standards, compliance constraints, stylistic guardrails). +# Distinct from the runtime memory sidecar — these are static context +# loaded on activation. Overrides append. +# +# Each entry is either: +# - a literal sentence, e.g. "All stories must include testable acceptance criteria." +# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md" +# (glob patterns are supported; the file's contents are loaded and treated as facts). + +persistent_facts = [ + "file:{project-root}/**/project-context.md", +] + +# Scalar: executed when the workflow reaches its final step, +# after sprint status is summarized and risks are surfaced. Override wins. +# Leave empty for no custom post-completion behavior. + +on_complete = "" diff --git a/src/bmm-skills/4-implementation/bmad-sprint-status/workflow.md b/src/bmm-skills/4-implementation/bmad-sprint-status/workflow.md deleted file mode 100644 index 7b72c717c..000000000 --- a/src/bmm-skills/4-implementation/bmad-sprint-status/workflow.md +++ /dev/null @@ -1,261 +0,0 @@ -# Sprint Status Workflow - -**Goal:** Summarize sprint status, surface risks, and recommend the next workflow action. - -**Your Role:** You are a Developer providing clear, actionable sprint visibility. No time estimates — focus on status, risks, and next steps. - ---- - -## INITIALIZATION - -### Configuration Loading - -Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - -- `project_name`, `user_name` -- `communication_language`, `document_output_language` -- `implementation_artifacts` -- `date` as system-generated current datetime -- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}` - -### Paths - -- `sprint_status_file` = `{implementation_artifacts}/sprint-status.yaml` - -### Input Files - -| Input | Path | Load Strategy | -|-------|------|---------------| -| Sprint status | `{sprint_status_file}` | FULL_LOAD | - -### Context - -- `project_context` = `**/project-context.md` (load if exists) - ---- - -## EXECUTION - - - - - Set mode = {{mode}} if provided by caller; otherwise mode = "interactive" - - - Jump to Step 20 - - - - Jump to Step 30 - - - - Continue to Step 1 - - - - - Load {project_context} for project-wide patterns and conventions (if exists) - Try {sprint_status_file} - - ❌ sprint-status.yaml not found. -Run `/bmad:bmm:workflows:sprint-planning` to generate it, then rerun sprint-status. - Exit workflow - - Continue to Step 2 - - - - Read the FULL file: {sprint_status_file} - Parse fields: generated, last_updated, project, project_key, tracking_system, story_location - Parse development_status map. Classify keys: - - Epics: keys starting with "epic-" (and not ending with "-retrospective") - - Retrospectives: keys ending with "-retrospective" - - Stories: everything else (e.g., 1-2-login-form) - Map legacy story status "drafted" → "ready-for-dev" - Count story statuses: backlog, ready-for-dev, in-progress, review, done - Map legacy epic status "contexted" → "in-progress" - Count epic statuses: backlog, in-progress, done - Count retrospective statuses: optional, done - -Validate all statuses against known values: - -- Valid story statuses: backlog, ready-for-dev, in-progress, review, done, drafted (legacy) -- Valid epic statuses: backlog, in-progress, done, contexted (legacy) -- Valid retrospective statuses: optional, done - - - -⚠️ **Unknown status detected:** -{{#each invalid_entries}} - -- `{{key}}`: "{{status}}" (not recognized) - {{/each}} - -**Valid statuses:** - -- Stories: backlog, ready-for-dev, in-progress, review, done -- Epics: backlog, in-progress, done -- Retrospectives: optional, done - - How should these be corrected? - {{#each invalid_entries}} - {{@index}}. {{key}}: "{{status}}" → [select valid status] - {{/each}} - -Enter corrections (e.g., "1=in-progress, 2=backlog") or "skip" to continue without fixing: - -Update sprint-status.yaml with corrected values -Re-parse the file with corrected statuses - - - -Detect risks: - -- IF any story has status "review": suggest `/bmad:bmm:workflows:code-review` -- IF any story has status "in-progress" AND no stories have status "ready-for-dev": recommend staying focused on active story -- IF all epics have status "backlog" AND no stories have status "ready-for-dev": prompt `/bmad:bmm:workflows:create-story` -- IF `last_updated` timestamp is more than 7 days old (or `last_updated` is missing, fall back to `generated`): warn "sprint-status.yaml may be stale" -- IF any story key doesn't match an epic pattern (e.g., story "5-1-..." but no "epic-5"): warn "orphaned story detected" -- IF any epic has status in-progress but has no associated stories: warn "in-progress epic has no stories" - - - - Pick the next recommended workflow using priority: - When selecting "first" story: sort by epic number, then story number (e.g., 1-1 before 1-2 before 2-1) - 1. If any story status == in-progress → recommend `dev-story` for the first in-progress story - 2. Else if any story status == review → recommend `code-review` for the first review story - 3. Else if any story status == ready-for-dev → recommend `dev-story` - 4. Else if any story status == backlog → recommend `create-story` - 5. Else if any retrospective status == optional → recommend `retrospective` - 6. Else → All implementation items done; congratulate the user - you both did amazing work together! - Store selected recommendation as: next_story_id, next_workflow_id, next_agent (DEV) - - - - -## 📊 Sprint Status - -- Project: {{project}} ({{project_key}}) -- Tracking: {{tracking_system}} -- Status file: {sprint_status_file} - -**Stories:** backlog {{count_backlog}}, ready-for-dev {{count_ready}}, in-progress {{count_in_progress}}, review {{count_review}}, done {{count_done}} - -**Epics:** backlog {{epic_backlog}}, in-progress {{epic_in_progress}}, done {{epic_done}} - -**Next Recommendation:** /bmad:bmm:workflows:{{next_workflow_id}} ({{next_story_id}}) - -{{#if risks}} -**Risks:** -{{#each risks}} - -- {{this}} - {{/each}} - {{/if}} - - - - - - Pick an option: -1) Run recommended workflow now -2) Show all stories grouped by status -3) Show raw sprint-status.yaml -4) Exit -Choice: - - - Run `/bmad:bmm:workflows:{{next_workflow_id}}`. -If the command targets a story, set `story_key={{next_story_id}}` when prompted. - - - - -### Stories by Status -- In Progress: {{stories_in_progress}} -- Review: {{stories_in_review}} -- Ready for Dev: {{stories_ready_for_dev}} -- Backlog: {{stories_backlog}} -- Done: {{stories_done}} - - - - - Display the full contents of {sprint_status_file} - - - - Exit workflow - - - - - - - - - Load and parse {sprint_status_file} same as Step 2 - Compute recommendation same as Step 3 - next_workflow_id = {{next_workflow_id}} - next_story_id = {{next_story_id}} - count_backlog = {{count_backlog}} - count_ready = {{count_ready}} - count_in_progress = {{count_in_progress}} - count_review = {{count_review}} - count_done = {{count_done}} - epic_backlog = {{epic_backlog}} - epic_in_progress = {{epic_in_progress}} - epic_done = {{epic_done}} - risks = {{risks}} - Return to caller - - - - - - - - Check that {sprint_status_file} exists - - is_valid = false - error = "sprint-status.yaml missing" - suggestion = "Run sprint-planning to create it" - Return - - -Read and parse {sprint_status_file} - -Validate required metadata fields exist: generated, project, project_key, tracking_system, story_location (last_updated is optional for backward compatibility) - -is_valid = false -error = "Missing required field(s): {{missing_fields}}" -suggestion = "Re-run sprint-planning or add missing fields manually" -Return - - -Verify development_status section exists with at least one entry - -is_valid = false -error = "development_status missing or empty" -suggestion = "Re-run sprint-planning or repair the file manually" -Return - - -Validate all status values against known valid statuses: - -- Stories: backlog, ready-for-dev, in-progress, review, done (legacy: drafted) -- Epics: backlog, in-progress, done (legacy: contexted) -- Retrospectives: optional, done - - is_valid = false - error = "Invalid status values: {{invalid_entries}}" - suggestion = "Fix invalid statuses in sprint-status.yaml" - Return - - -is_valid = true -message = "sprint-status.yaml valid: metadata complete, all statuses recognized" - - - diff --git a/src/bmm-skills/module-help.csv b/src/bmm-skills/module-help.csv index 816061e90..8b824795f 100644 --- a/src/bmm-skills/module-help.csv +++ b/src/bmm-skills/module-help.csv @@ -1,4 +1,5 @@ module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs +BMad Method,_meta,,,,,,,,,false,https://docs.bmad-method.org/llms.txt, BMad Method,bmad-document-project,Document Project,DP,Analyze an existing project to produce useful documentation.,,anytime,,,false,project-knowledge,* BMad Method,bmad-generate-project-context,Generate Project Context,GPC,Scan existing codebase to generate a lean LLM-optimized project-context.md. Essential for brownfield projects.,,anytime,,,false,output_folder,project context BMad Method,bmad-quick-dev,Quick Dev,QQ,Unified intent-in code-out workflow: clarify plan implement review and present.,,anytime,,,false,implementation_artifacts,spec and project implementation diff --git a/src/bmm-skills/module.yaml b/src/bmm-skills/module.yaml index 76f6b7433..cf3232614 100644 --- a/src/bmm-skills/module.yaml +++ b/src/bmm-skills/module.yaml @@ -18,6 +18,7 @@ user_skill_level: prompt: - "What is your development experience level?" - "This affects how agents explain concepts in chat." + scope: user default: "intermediate" result: "{value}" single-select: @@ -48,3 +49,51 @@ directories: - "{planning_artifacts}" - "{implementation_artifacts}" - "{project_knowledge}" + +# Agent roster — essence only. External skills (party-mode, retrospective, +# advanced-elicitation, help catalog) read these descriptors to route, display, +# and embody agents. Full persona and behavior live in each agent's +# customize.toml. `team` defaults to the module code when omitted; users can +# add their own agents (real or fictional) via _bmad/custom/config.toml or _bmad/custom/config.user.toml. +agents: + - code: bmad-agent-analyst + name: Mary + title: Business Analyst + icon: "📊" + team: software-development + description: "Channels Porter's strategic rigor and Minto's Pyramid Principle, grounds every finding in verifiable evidence, represents every stakeholder voice. Speaks like a treasure hunter narrating the find: thrilled by every clue, precise once the pattern emerges." + + - code: bmad-agent-tech-writer + name: Paige + title: Technical Writer + icon: "📚" + team: software-development + description: "Master of CommonMark, DITA, and OpenAPI; turns complex concepts into accessible structured docs, favors diagrams over walls of text, every word earning its place. Speaks like the patient teacher you wish you'd had, using analogies that make complex things feel simple." + + - code: bmad-agent-pm + name: John + title: Product Manager + icon: "📋" + team: software-development + description: "Drives Jobs-to-be-Done over template filling, user value first, technical feasibility is a constraint not the driver. Speaks like a detective interrogating a cold case: short questions, sharper follow-ups, every 'why?' tightening the net." + + - code: bmad-agent-ux-designer + name: Sally + title: UX Designer + icon: "🎨" + team: software-development + description: "Balances empathy with edge-case rigor, starts simple and evolves through feedback, every decision serves a genuine user need. Speaks like a filmmaker pitching the scene before the code exists, painting user stories that make you feel the problem." + + - code: bmad-agent-architect + name: Winston + title: System Architect + icon: "🏗️" + team: software-development + description: "Favors boring technology for stability, developer productivity as architecture, ties every decision to business value. Speaks like a seasoned engineer at the whiteboard: measured, always laying out trade-offs rather than verdicts." + + - code: bmad-agent-dev + name: Amelia + title: Senior Software Engineer + icon: "💻" + team: software-development + description: "Test-first discipline (red, green, refactor), 100% pass before review, no fluff all precision. Speaks like a terminal prompt: exact file paths, AC IDs, and commit-message brevity — every statement citable." diff --git a/src/core-skills/bmad-advanced-elicitation/SKILL.md b/src/core-skills/bmad-advanced-elicitation/SKILL.md index 98459cb7c..c86ffed02 100644 --- a/src/core-skills/bmad-advanced-elicitation/SKILL.md +++ b/src/core-skills/bmad-advanced-elicitation/SKILL.md @@ -35,7 +35,13 @@ When invoked from another prompt or process: ### Step 1: Method Registry Loading -**Action:** Load and read `./methods.csv` and '{project-root}/_bmad/_config/agent-manifest.csv' +**Action:** Load `./methods.csv` for elicitation methods. If party-mode may participate, resolve the agent roster via: + +```bash +python3 {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key agents +``` + +The resolver merges four layers in order: `_bmad/config.toml` (installer base, team-scoped), `_bmad/config.user.toml` (installer base, user-scoped), `_bmad/custom/config.toml` (team overrides), and `_bmad/custom/config.user.toml` (personal overrides). Each entry under `agents` is keyed by the agent's `code` and carries `name`, `title`, `icon`, `description`, `module`, and `team`. #### CSV Structure diff --git a/src/core-skills/bmad-customize/SKILL.md b/src/core-skills/bmad-customize/SKILL.md new file mode 100644 index 000000000..0a0212bc8 --- /dev/null +++ b/src/core-skills/bmad-customize/SKILL.md @@ -0,0 +1,111 @@ +--- +name: bmad-customize +description: Authors and updates customization overrides for installed BMad skills. Use when the user says 'customize bmad', 'override a skill', 'change agent behavior', or 'customize a workflow'. +--- + +# BMad Customize + +Translate the user's intent into a correctly-placed TOML override file under `{project-root}/_bmad/custom/` for a customizable agent or workflow skill. Discover, route, author, write, verify. + +Scope v1: per-skill `[agent]` overrides (`bmad-agent-.toml` / `.user.toml`) and per-skill `[workflow]` overrides (`bmad-.toml` / `.user.toml`). Central config (`{project-root}/_bmad/custom/config.toml`) is out of scope — point users at the [How to Customize BMad guide](https://docs.bmad-method.org/how-to/customize-bmad/). + +When the target's `customize.toml` doesn't expose what the user wants, say so plainly. Don't invent fields. + +## Preflight + +- No `{project-root}/_bmad/` → BMad isn't installed. Say so, stop. +- `{project-root}/_bmad/scripts/resolve_customization.py` missing → continue, but Step 6 verify falls back to manual merge. +- Both present → proceed. + +## Activation + +Load `_bmad/config.toml` and `_bmad/config.user.toml` from `{project-root}` for `user_name` (default `BMad`) and `communication_language` (default `English`). Greet. If the user's invocation already names a target skill AND a specific change, jump to Step 3. + +## Step 1: Classify intent + +- **Directed** — specific skill + specific change → Step 3. +- **Exploratory** — "what can I customize?" → Step 2. +- **Audit/iterate** — wants to review or change something already customized → Step 2, lead with skills that have existing overrides; read the existing override in Step 3 before composing. +- **Cross-cutting** — could live on multiple surfaces → Step 3, choose agent vs workflow explicitly with the user. + +## Step 2: Discovery + +``` +python3 {skill-root}/scripts/list_customizable_skills.py --project-root {project-root} +``` + +Use `--extra-root ` (repeatable) if the user has skills installed in additional locations. + +Group the returned `agents` and `workflows` for the user; for each show name, description, whether `has_team_override` or `has_user_override` is true. Surface any `errors[]`. For audit/iterate intents, lead with already-overridden entries. + +Empty list: show `scanned_roots`, ask whether skills live elsewhere (offer `--extra-root`); otherwise stop. + +## Step 3: Determine the right surface + +Read the target's `customize.toml`. Top-level `[agent]` or `[workflow]` block defines the surface. + +If a team or user override already exists, read it first and summarize what's already overridden before composing. + +**Cross-cutting intent — walk both surfaces with the user:** +- Every workflow a given agent runs → agent surface (e.g. `bmad-agent-pm.toml` with `persistent_facts`, `principles`). +- One workflow only → workflow surface (e.g. `bmad-create-prd.toml` with `activation_steps_prepend`). +- Several specific workflows → multiple workflow overrides in sequence, not an agent override. + +**Single-surface heuristic:** +- Workflow-level: template swap, output path, step-specific behavior, or a named scalar already exposed (`*_template`, `on_complete`). Surgical, reliable. +- Agent-level: persona, communication style, org-wide facts, menu changes, behavior that should apply to every workflow the agent dispatches. + +When ambiguous, present both with tradeoff, recommend one, let the user decide. + +Intent outside the exposed surface (step logic, ordering, anything not in `customize.toml`): say so; offer `activation_steps_prepend`/`append` or `persistent_facts` as approximations, or recommend `bmad-builder` to create a custom skill. + +## Step 4: Compose the override + +Translate plain-English into TOML against the target's `customize.toml` fields. If an existing override was read, frame the change as additive. + +Merge semantics: +- **Scalars** (`icon`, `role`, `*_template`, `on_complete`) — override wins. +- **Append arrays** (`persistent_facts`, `activation_steps_prepend`/`append`, `principles`) — team/user entries append in order. +- **Keyed arrays of tables** (menu items with `code` or `id`) — matching keys replace, new keys append. + +Overrides are sparse: only the fields being changed. Never copy the whole `customize.toml`. + +**Template swap** (`*_template` scalar): offer to copy the default template to `{project-root}/_bmad/custom/{skill-name}-{purpose}-template.md`, point the override at the new path, offer to help edit it. + +## Step 5: Team or user placement + +Under `{project-root}/_bmad/custom/`: +- `{skill-name}.toml` — team, committed. Policies, org conventions, compliance. +- `{skill-name}.user.toml` — user, gitignored. Personal tone, private facts, shortcuts. + +Default by character (policy → team, personal → user), confirm before writing. + +## Step 6: Show, confirm, write, verify + +1. Show the full TOML. If the file exists, show a diff. Never silently overwrite. +2. Wait for explicit yes. +3. Write. Create `{project-root}/_bmad/custom/` if needed. +4. Verify: + ``` + python3 {project-root}/_bmad/scripts/resolve_customization.py --skill --key + ``` + Show the merged output, point out the changed fields. + + **Resolver missing or fails:** read whichever layers exist — `/customize.toml` (base), `{project-root}/_bmad/custom/{skill-name}.toml` (team), `{project-root}/_bmad/custom/{skill-name}.user.toml` (user) — apply base → team → user with the same merge rules (scalars override, tables deep-merge, `code`/`id`-keyed arrays merge by key, all other arrays append), describe how the changed fields resolve. + + **Verify shows override didn't land** (field unchanged, merge conflict, file not picked up): re-enter Step 4 with the verify output as context. Usually wrong field name, wrong merge mode (scalar vs array), or wrong scope. +5. Summarize what changed, where the file lives, how to iterate. Remind the user to commit team overrides. + +## Complete when + +- Override file written (or user explicitly aborted). +- User has seen resolver output (or manual fallback merge summary). +- User has acknowledged the summary. + +Otherwise the skill isn't done — finish or tell the user they're exiting incomplete. + +## When this skill can't help + +- **Central config** (`{project-root}/_bmad/custom/config.toml`) — see the [How to Customize BMad guide](https://docs.bmad-method.org/how-to/customize-bmad/). +- **Step logic, ordering, behavior not in `customize.toml`** — open a feature request, or use `bmad-builder` to create a custom skill. Offer to help with either. +- **Skills without a `customize.toml`** — not customizable. diff --git a/src/core-skills/bmad-customize/scripts/list_customizable_skills.py b/src/core-skills/bmad-customize/scripts/list_customizable_skills.py new file mode 100644 index 000000000..86fd82a54 --- /dev/null +++ b/src/core-skills/bmad-customize/scripts/list_customizable_skills.py @@ -0,0 +1,231 @@ +#!/usr/bin/env python3 +# /// script +# requires-python = ">=3.11" +# /// +"""Enumerate customizable BMad skills installed alongside this one. + +Scans a skills directory (by default: the directory this script's own skill +lives in, derived from __file__), finds every sibling directory containing a +`customize.toml`, classifies each as agent and/or workflow based on its +top-level blocks, reads the skill's SKILL.md frontmatter description for a +one-liner, and checks whether override files already exist in +`{project-root}/_bmad/custom/`. + +Skills in BMad are loaded either from a project-local location (e.g. the +project's `.claude/skills/` or `.cursor/skills/`) or from a user-global +location (e.g. `~/.claude/skills/`). We do not hardcode those paths — the +running skill's own location is the source of truth for sibling discovery. +`--extra-root` is available for the rare case where skills live in multiple +locations on the same machine. + +Output: JSON to stdout. Non-empty `errors[]` in the payload is non-fatal +by contract — the scanner surfaces malformed TOML, missing roots, and +skills with no customization block as data for the caller to display, +and still exits 0. Exit 2 is reserved for invocation errors (e.g. +missing or unreadable `--project-root`) where no useful payload can be +produced. +""" + +from __future__ import annotations + +import argparse +import json +import re +import sys +import tomllib +from pathlib import Path + +# Top-level TOML blocks that indicate a customization surface. +SURFACE_KEYS = ("agent", "workflow") + +FRONTMATTER_RE = re.compile(r"^---\s*\n(.*?)\n---\s*\n", re.DOTALL) + + +def default_skills_root() -> Path: + """Derive the skills root from this script's location. + + Layout assumption: {skills_root}/bmad-customize/scripts/list_customizable_skills.py. + So the skills root is three parents up from this file. + """ + return Path(__file__).resolve().parent.parent.parent + + +def read_frontmatter_description(skill_md: Path) -> str: + """Extract the `description:` value from a SKILL.md YAML frontmatter block. + + Returns an empty string if the file is missing, unreadable, or has no + description field. Intentionally permissive — this is metadata for a + human-facing list, not a validation target. + """ + if not skill_md.is_file(): + return "" + try: + text = skill_md.read_text(encoding="utf-8") + except (OSError, UnicodeDecodeError): + return "" + m = FRONTMATTER_RE.match(text) + if not m: + return "" + for line in m.group(1).splitlines(): + stripped = line.strip() + if stripped.startswith("description:"): + value = stripped[len("description:") :].strip() + # Strip surrounding quotes if present. + if (value.startswith("'") and value.endswith("'")) or ( + value.startswith('"') and value.endswith('"') + ): + value = value[1:-1] + return value + return "" + + +def load_customize(toml_path: Path) -> dict | None: + """Return the parsed TOML, or None if unreadable.""" + try: + with toml_path.open("rb") as f: + return tomllib.load(f) + except (OSError, tomllib.TOMLDecodeError): + return None + + +def scan_skills( + skills_roots: list[Path], + project_root: Path, +) -> dict: + """Scan each skills root for directories that contain a customize.toml.""" + agents: list[dict] = [] + workflows: list[dict] = [] + errors: list[str] = [] + scanned_roots: list[str] = [] + seen_names: set[str] = set() + custom_dir = project_root / "_bmad" / "custom" + + for root in skills_roots: + if not root.is_dir(): + errors.append(f"skills root does not exist: {root}") + continue + scanned_roots.append(str(root)) + + for skill_dir in sorted(p for p in root.iterdir() if p.is_dir()): + customize_toml = skill_dir / "customize.toml" + if not customize_toml.is_file(): + continue + + data = load_customize(customize_toml) + if data is None: + errors.append(f"failed to parse {customize_toml}") + continue + + skill_name = skill_dir.name + # If a skill with this name was already found in an earlier + # root, skip it — roots are scanned in the order provided, so + # the first occurrence wins. + if skill_name in seen_names: + continue + seen_names.add(skill_name) + + description = read_frontmatter_description(skill_dir / "SKILL.md") + team_override = custom_dir / f"{skill_name}.toml" + user_override = custom_dir / f"{skill_name}.user.toml" + + entry_base = { + "name": skill_name, + "install_path": str(skill_dir), + "skills_root": str(root), + "description": description, + "has_team_override": team_override.is_file(), + "has_user_override": user_override.is_file(), + "team_override_path": str(team_override), + "user_override_path": str(user_override), + } + + # A skill may expose an agent surface, a workflow surface, or + # both. Emit one entry per surface so the caller can group cleanly. + surfaces_found = [k for k in SURFACE_KEYS if k in data] + if not surfaces_found: + errors.append( + f"no [agent] or [workflow] block in {customize_toml}" + ) + continue + for surface in surfaces_found: + entry = dict(entry_base) + entry["surface"] = surface + if surface == "agent": + agents.append(entry) + else: + workflows.append(entry) + + return { + "project_root": str(project_root), + "scanned_roots": scanned_roots, + "custom_dir": str(custom_dir), + "agents": agents, + "workflows": workflows, + "errors": errors, + } + + +def parse_args(argv: list[str]) -> argparse.Namespace: + parser = argparse.ArgumentParser( + description=( + "List customizable BMad skills installed alongside this one, " + "grouped by surface (agent vs workflow), with override status " + "looked up against {project-root}/_bmad/custom/." + ) + ) + parser.add_argument( + "--project-root", + required=True, + help="Absolute path to the project root (the folder containing _bmad/).", + ) + parser.add_argument( + "--skills-root", + default=None, + help=( + "Override the primary skills directory to scan. Defaults to the " + "directory this script's own skill lives in." + ), + ) + parser.add_argument( + "--extra-root", + action="append", + default=[], + metavar="PATH", + help=( + "Additional skills directory to include (repeatable). Useful " + "when skills live in multiple locations on the same machine " + "(e.g. project-local plus a user-global install)." + ), + ) + return parser.parse_args(argv) + + +def main(argv: list[str]) -> int: + args = parse_args(argv) + project_root = Path(args.project_root).expanduser().resolve() + if not project_root.is_dir(): + print( + f"error: project-root does not exist or is not a directory: {project_root}", + file=sys.stderr, + ) + return 2 + + primary = ( + Path(args.skills_root).expanduser().resolve() + if args.skills_root + else default_skills_root() + ) + extras = [Path(p).expanduser().resolve() for p in args.extra_root] + # Deduplicate in order of appearance. + roots: list[Path] = [] + for root in [primary, *extras]: + if root not in roots: + roots.append(root) + + result = scan_skills(roots, project_root) + print(json.dumps(result, indent=2, sort_keys=True)) + return 0 + + +if __name__ == "__main__": + sys.exit(main(sys.argv[1:])) diff --git a/src/core-skills/bmad-customize/scripts/tests/test_list_customizable_skills.py b/src/core-skills/bmad-customize/scripts/tests/test_list_customizable_skills.py new file mode 100644 index 000000000..a7be22ece --- /dev/null +++ b/src/core-skills/bmad-customize/scripts/tests/test_list_customizable_skills.py @@ -0,0 +1,249 @@ +#!/usr/bin/env python3 +# /// script +# requires-python = ">=3.11" +# /// +"""Unit tests for list_customizable_skills.py. + +Exercises the scanner against a synthesized install tree: +- an agent-only customize.toml +- a workflow-only customize.toml +- a customize.toml that exposes both surfaces +- a skill directory with no customize.toml (ignored) +- a pre-existing team override in _bmad/custom/ +- malformed TOML (surfaces as an error without aborting) +- multiple skills roots (e.g. project-local + user-global mix) + +Run: python3 scripts/tests/test_list_customizable_skills.py +""" + +from __future__ import annotations + +import importlib.util +import json +import subprocess +import sys +import tempfile +import unittest +from pathlib import Path + +SCRIPT = Path(__file__).resolve().parent.parent / "list_customizable_skills.py" + + +def _load_module(): + spec = importlib.util.spec_from_file_location("list_customizable_skills", SCRIPT) + module = importlib.util.module_from_spec(spec) + spec.loader.exec_module(module) # type: ignore[union-attr] + return module + + +MODULE = _load_module() + + +def _make_skill(parent: Path, name: str, body: str, skill_md: str | None = None) -> Path: + skill_dir = parent / name + skill_dir.mkdir(parents=True, exist_ok=True) + (skill_dir / "customize.toml").write_text(body, encoding="utf-8") + if skill_md is not None: + (skill_dir / "SKILL.md").write_text(skill_md, encoding="utf-8") + return skill_dir + + +class ScannerTest(unittest.TestCase): + def setUp(self): + self.tmp = tempfile.TemporaryDirectory() + self.root = Path(self.tmp.name) + self.skills = self.root / "skills" + self.skills.mkdir(parents=True) + self.custom = self.root / "_bmad" / "custom" + self.custom.mkdir(parents=True) + + def tearDown(self): + self.tmp.cleanup() + + def test_agent_only_skill_detected(self): + _make_skill( + self.skills, + "bmad-agent-pm", + "[agent]\nicon = \"🧠\"\n", + "---\nname: bmad-agent-pm\ndescription: Product manager.\n---\n", + ) + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(len(result["agents"]), 1) + self.assertEqual(len(result["workflows"]), 0) + entry = result["agents"][0] + self.assertEqual(entry["name"], "bmad-agent-pm") + self.assertEqual(entry["surface"], "agent") + self.assertEqual(entry["description"], "Product manager.") + self.assertFalse(entry["has_team_override"]) + self.assertFalse(entry["has_user_override"]) + + def test_workflow_only_skill_detected(self): + _make_skill( + self.skills, + "bmad-create-prd", + "[workflow]\npersistent_facts = []\n", + "---\nname: bmad-create-prd\ndescription: 'Create a PRD.'\n---\n", + ) + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(len(result["agents"]), 0) + self.assertEqual(len(result["workflows"]), 1) + entry = result["workflows"][0] + self.assertEqual(entry["description"], "Create a PRD.") + + def test_dual_surface_skill_emits_two_entries(self): + _make_skill( + self.skills, + "bmad-dual", + "[agent]\nicon = \"x\"\n\n[workflow]\npersistent_facts = []\n", + "---\nname: bmad-dual\ndescription: Dual.\n---\n", + ) + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(len(result["agents"]), 1) + self.assertEqual(len(result["workflows"]), 1) + self.assertEqual(result["agents"][0]["name"], "bmad-dual") + self.assertEqual(result["workflows"][0]["name"], "bmad-dual") + + def test_skill_without_customize_toml_ignored(self): + (self.skills / "bmad-plain").mkdir() + (self.skills / "bmad-plain" / "SKILL.md").write_text("# plain\n") + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(len(result["agents"]) + len(result["workflows"]), 0) + self.assertEqual(result["errors"], []) + + def test_existing_team_override_flagged(self): + _make_skill( + self.skills, + "bmad-agent-pm", + "[agent]\nicon = \"x\"\n", + "---\nname: bmad-agent-pm\ndescription: PM.\n---\n", + ) + (self.custom / "bmad-agent-pm.toml").write_text("[agent]\n") + result = MODULE.scan_skills([self.skills], self.root) + entry = result["agents"][0] + self.assertTrue(entry["has_team_override"]) + self.assertFalse(entry["has_user_override"]) + + def test_missing_surface_block_reports_error(self): + _make_skill(self.skills, "bmad-broken", "[not_a_surface]\nfoo = 1\n") + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(len(result["agents"]) + len(result["workflows"]), 0) + self.assertEqual(len(result["errors"]), 1) + self.assertIn("no [agent] or [workflow] block", result["errors"][0]) + + def test_malformed_toml_reports_error_without_aborting(self): + skill_dir = self.skills / "bmad-bad" + skill_dir.mkdir() + (skill_dir / "customize.toml").write_text("this is not [valid toml\n") + # Plus a good sibling to confirm scanning continues. + _make_skill( + self.skills, + "bmad-good", + "[agent]\nicon = \"x\"\n", + "---\nname: bmad-good\ndescription: Good.\n---\n", + ) + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(len(result["agents"]), 1) + self.assertEqual(result["agents"][0]["name"], "bmad-good") + self.assertTrue(any("failed to parse" in e for e in result["errors"])) + + def test_description_with_double_quotes_stripped(self): + _make_skill( + self.skills, + "bmad-q", + "[agent]\nicon = \"x\"\n", + '---\nname: bmad-q\ndescription: "Double-quoted desc."\n---\n', + ) + result = MODULE.scan_skills([self.skills], self.root) + self.assertEqual(result["agents"][0]["description"], "Double-quoted desc.") + + def test_multiple_skills_roots_are_merged(self): + extra_root = self.root / "extra-skills" + extra_root.mkdir() + _make_skill( + self.skills, + "bmad-agent-pm", + "[agent]\nicon = \"x\"\n", + "---\nname: bmad-agent-pm\ndescription: PM.\n---\n", + ) + _make_skill( + extra_root, + "bmad-agent-dev", + "[agent]\nicon = \"y\"\n", + "---\nname: bmad-agent-dev\ndescription: Dev.\n---\n", + ) + result = MODULE.scan_skills([self.skills, extra_root], self.root) + names = {a["name"] for a in result["agents"]} + self.assertEqual(names, {"bmad-agent-pm", "bmad-agent-dev"}) + self.assertEqual(len(result["scanned_roots"]), 2) + + def test_duplicate_skill_name_across_roots_first_wins(self): + extra_root = self.root / "extra-skills" + extra_root.mkdir() + _make_skill( + self.skills, + "bmad-agent-pm", + "[agent]\nicon = \"primary\"\n", + "---\nname: bmad-agent-pm\ndescription: Primary.\n---\n", + ) + _make_skill( + extra_root, + "bmad-agent-pm", + "[agent]\nicon = \"duplicate\"\n", + "---\nname: bmad-agent-pm\ndescription: Duplicate.\n---\n", + ) + result = MODULE.scan_skills([self.skills, extra_root], self.root) + self.assertEqual(len(result["agents"]), 1) + self.assertEqual(result["agents"][0]["description"], "Primary.") + self.assertEqual(result["agents"][0]["skills_root"], str(self.skills)) + + def test_missing_skills_root_reports_error(self): + result = MODULE.scan_skills( + [self.root / "does-not-exist", self.skills], + self.root, + ) + self.assertTrue(any("skills root does not exist" in e for e in result["errors"])) + + def test_cli_emits_valid_json_and_exits_zero(self): + _make_skill( + self.skills, + "bmad-agent-pm", + "[agent]\nicon = \"x\"\n", + "---\nname: bmad-agent-pm\ndescription: PM.\n---\n", + ) + proc = subprocess.run( + [ + sys.executable, + str(SCRIPT), + "--project-root", + str(self.root), + "--skills-root", + str(self.skills), + ], + capture_output=True, + text=True, + check=False, + ) + self.assertEqual(proc.returncode, 0, proc.stderr) + payload = json.loads(proc.stdout) + self.assertEqual(len(payload["agents"]), 1) + + def test_cli_exits_two_on_missing_project_root(self): + proc = subprocess.run( + [ + sys.executable, + str(SCRIPT), + "--project-root", + str(self.root / "does-not-exist"), + "--skills-root", + str(self.skills), + ], + capture_output=True, + text=True, + check=False, + ) + self.assertEqual(proc.returncode, 2) + self.assertIn("does not exist", proc.stderr) + + +if __name__ == "__main__": + unittest.main() diff --git a/src/core-skills/bmad-distillator/resources/distillate-format-reference.md b/src/core-skills/bmad-distillator/resources/distillate-format-reference.md index d01cd49f1..efdac4cfc 100644 --- a/src/core-skills/bmad-distillator/resources/distillate-format-reference.md +++ b/src/core-skills/bmad-distillator/resources/distillate-format-reference.md @@ -174,7 +174,7 @@ parts: 1 ## Current Installer (migration context) - Entry: `tools/installer/bmad-cli.js` (Commander.js) → `tools/installer/core/installer.js` - Platforms: `platform-codes.yaml` (~20 platforms with target dirs, legacy dirs, template types, special flags) -- Manifests: CSV files (skill/workflow/agent-manifest.csv) are current source of truth, not JSON +- Manifests: skill-manifest.csv is the current source of truth; agent essence lives in `_bmad/config.toml` (generated from each module.yaml's `agents:` block) - External modules: `external-official-modules.yaml` (CIS, GDS, TEA, WDS) from npm with semver - Dependencies: 4-pass resolver (collect → parse → resolve → transitive); YAML-declared only - Config: prompts for name, communication language, document output language, output folder diff --git a/src/core-skills/bmad-help/SKILL.md b/src/core-skills/bmad-help/SKILL.md index cecb50fae..e829543cf 100644 --- a/src/core-skills/bmad-help/SKILL.md +++ b/src/core-skills/bmad-help/SKILL.md @@ -7,7 +7,7 @@ description: 'Analyzes current state and user query to answer BMad questions or ## Purpose -Help the user understand where they are in their BMad workflow and what to do next. Answer BMad questions when asked. +Help the user understand where they are in their BMad workflow and what to do next, and also answer broader questions when asked that could be augmented with remote sources such as module documentation sources. ## Desired Outcomes @@ -18,6 +18,7 @@ When this skill completes, the user should: 3. **Know how to invoke it** — skill name, menu code, action context, and any args that shortcut the conversation 4. **Get offered a quick start** — when a single skill is the clear next step, offer to run it for the user right now rather than just listing it 5. **Feel oriented, not overwhelmed** — surface only what's relevant to their current position; don't dump the entire catalog +6. **Get answers to general questions** — when the question doesn't map to a specific skill, use the module's registered documentation to give a grounded answer ## Data Sources @@ -25,6 +26,7 @@ When this skill completes, the user should: - **Config**: `config.yaml` and `user-config.yaml` files in `{project-root}/_bmad/` and its subfolders — resolve `output-location` variables, provide `communication_language` and `project_knowledge` - **Artifacts**: Files matching `outputs` patterns at resolved `output-location` paths reveal which steps are possibly completed; their content may also provide grounding context for recommendations - **Project knowledge**: If `project_knowledge` resolves to an existing path, read it for grounding context. Never fabricate project-specific details. +- **Module docs**: Rows with `_meta` in the `skill` column carry a URL or path in `output-location` pointing to the module's documentation (e.g., llms.txt). Fetch and use these to answer general questions about that module. ## CSV Interpretation @@ -70,4 +72,4 @@ For each recommended item, present: - Present all output in `{communication_language}` - Recommend running each skill in a **fresh context window** - Match the user's tone — conversational when they're casual, structured when they want specifics -- If the active module is ambiguous, ask rather than guess +- If the active module is ambiguous, retrieve all meta rows remote sources to find relevant info also to help answer their question diff --git a/src/core-skills/bmad-party-mode/SKILL.md b/src/core-skills/bmad-party-mode/SKILL.md index 9f451d821..6f4ee3e63 100644 --- a/src/core-skills/bmad-party-mode/SKILL.md +++ b/src/core-skills/bmad-party-mode/SKILL.md @@ -26,7 +26,13 @@ Party mode accepts optional arguments when invoked: - Use `{user_name}` for greeting - Use `{communication_language}` for all communications -3. **Read the agent manifest** at `{project-root}/_bmad/_config/agent-manifest.csv`. Build an internal roster of available agents with their displayName, title, icon, role, identity, communicationStyle, and principles. +3. **Resolve the agent roster** by running: + + ```bash + python3 {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key agents + ``` + + The resolver merges four layers in order: `_bmad/config.toml` (installer base, team-scoped), `_bmad/config.user.toml` (installer base, user-scoped), `_bmad/custom/config.toml` (team overrides), and `_bmad/custom/config.user.toml` (personal overrides). Each entry under `agents` is keyed by the agent's `code` and carries `name`, `title`, `icon`, `description`, `module`, and `team`. Build an internal roster of available agents from those fields. 4. **Load project context** — search for `**/project-context.md`. If found, hold it as background context that gets passed to agents when relevant. @@ -50,15 +56,12 @@ Choose 2-4 agents whose expertise is most relevant to what the user is asking. U For each selected agent, spawn a subagent using the Agent tool. Each subagent gets: -**The agent prompt** (built from the manifest data): +**The agent prompt** (built from the resolved roster entry): ``` -You are {displayName} ({title}), a BMAD agent in a collaborative roundtable discussion. +You are {name} ({title}), a BMAD agent in a collaborative roundtable discussion. ## Your Persona -- Icon: {icon} -- Communication Style: {communicationStyle} -- Principles: {principles} -- Identity: {identity} +{icon} {name} — {description} ## Discussion Context {summary of the conversation so far — keep under 400 words} @@ -72,11 +75,11 @@ You are {displayName} ({title}), a BMAD agent in a collaborative roundtable disc {the user's actual message} ## Guidelines -- Respond authentically as {displayName}. Your perspective should reflect your genuine expertise. -- Start your response with: {icon} **{displayName}:** +- Respond authentically as {name}. Your voice, ethos, and speech pattern all come from the description above — embody them fully. +- Start your response with: {icon} **{name}:** - Speak in {communication_language}. - Scale your response to the substance — don't pad. If you have a brief point, make it briefly. -- Disagree with other agents when your expertise tells you to. Don't hedge or be polite about it. +- Disagree with other agents when your perspective tells you to. Don't hedge or be polite about it. - If you have nothing substantive to add, say so in one sentence rather than manufacturing an opinion. - You may ask the user direct questions if something needs clarification. - Do NOT use tools. Just respond with your perspective. diff --git a/src/core-skills/module-help.csv b/src/core-skills/module-help.csv index 4a70c1bad..f3521c743 100644 --- a/src/core-skills/module-help.csv +++ b/src/core-skills/module-help.csv @@ -1,4 +1,5 @@ module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs +Core,_meta,,,,,,,,,false,https://docs.bmad-method.org/llms.txt, Core,bmad-brainstorming,Brainstorming,BSP,Use early in ideation or when stuck generating ideas.,,anytime,,,false,{output_folder}/brainstorming,brainstorming session Core,bmad-party-mode,Party Mode,PM,Orchestrate multi-agent discussions when you need multiple perspectives or want agents to collaborate.,,anytime,,,false,, Core,bmad-help,BMad Help,BH,,,anytime,,,false,, @@ -9,3 +10,4 @@ Core,bmad-editorial-review-structure,Editorial Review - Structure,ES,Use when do Core,bmad-review-adversarial-general,Adversarial Review,AR,"Use for quality assurance or before finalizing deliverables. Code Review in other modules runs this automatically, but also useful for document reviews.",[path],anytime,,,false,, Core,bmad-review-edge-case-hunter,Edge Case Hunter Review,ECH,Use alongside adversarial review for orthogonal coverage — method-driven not attitude-driven.,[path],anytime,,,false,, Core,bmad-distillator,Distillator,DG,Use when you need token-efficient distillates that preserve all information for downstream LLM consumption.,[path],anytime,,,false,adjacent to source document or specified output_path,distillate markdown file(s) +Core,bmad-customize,BMad Customize,BC,"Use when you want to change how an agent or workflow behaves — add persistent facts, swap templates, insert activation hooks, or customize menus. Scans what's customizable, picks the right scope (agent vs workflow), writes the override to _bmad/custom/, and verifies the merge. No TOML hand-authoring required.",,anytime,,,false,{project-root}/_bmad/custom,TOML override files diff --git a/src/core-skills/module.yaml b/src/core-skills/module.yaml index 48e7a58f7..0ccc68a78 100644 --- a/src/core-skills/module.yaml +++ b/src/core-skills/module.yaml @@ -1,16 +1,19 @@ code: core name: "BMad Core Module" +description: "Core configuration and shared resources" header: "BMad Core Configuration" subheader: "Configure the core settings for your BMad installation.\nThese settings will be used across all installed bmad skills, workflows, and agents." user_name: prompt: "What should agents call you? (Use your name or a team name)" + scope: user default: "BMad" result: "{value}" communication_language: prompt: "What language should agents use when chatting with you?" + scope: user default: "English" result: "{value}" diff --git a/src/scripts/resolve_config.py b/src/scripts/resolve_config.py new file mode 100644 index 000000000..eb9e20288 --- /dev/null +++ b/src/scripts/resolve_config.py @@ -0,0 +1,176 @@ +#!/usr/bin/env python3 +""" +Resolve BMad's central config using four-layer TOML merge. + +Reads from four layers (highest priority last): + 1. {project-root}/_bmad/config.toml (installer-owned team) + 2. {project-root}/_bmad/config.user.toml (installer-owned user) + 3. {project-root}/_bmad/custom/config.toml (human-authored team, committed) + 4. {project-root}/_bmad/custom/config.user.toml (human-authored user, gitignored) + +Outputs merged JSON to stdout. Errors go to stderr. + +Requires Python 3.11+ (uses stdlib `tomllib`). No `uv`, no `pip install`, +no virtualenv — plain `python3` is sufficient. + + python3 resolve_config.py --project-root /abs/path/to/project + python3 resolve_config.py --project-root ... --key core + python3 resolve_config.py --project-root ... --key agents + +Merge rules (same as resolve_customization.py): + - Scalars: override wins + - Tables: deep merge + - Arrays of tables where every item shares `code` or `id`: merge by that key + - All other arrays: append +""" + +import argparse +import json +import sys +from pathlib import Path + +try: + import tomllib +except ImportError: + sys.stderr.write( + "error: Python 3.11+ is required (stdlib `tomllib` not found).\n" + ) + sys.exit(3) + + +_MISSING = object() +_KEYED_MERGE_FIELDS = ("code", "id") + + +def load_toml(file_path: Path, required: bool = False) -> dict: + if not file_path.exists(): + if required: + sys.stderr.write(f"error: required config file not found: {file_path}\n") + sys.exit(1) + return {} + try: + with file_path.open("rb") as f: + parsed = tomllib.load(f) + if not isinstance(parsed, dict): + return {} + return parsed + except tomllib.TOMLDecodeError as error: + level = "error" if required else "warning" + sys.stderr.write(f"{level}: failed to parse {file_path}: {error}\n") + if required: + sys.exit(1) + return {} + except OSError as error: + level = "error" if required else "warning" + sys.stderr.write(f"{level}: failed to read {file_path}: {error}\n") + if required: + sys.exit(1) + return {} + + +def _detect_keyed_merge_field(items): + if not items or not all(isinstance(item, dict) for item in items): + return None + for candidate in _KEYED_MERGE_FIELDS: + if all(item.get(candidate) is not None for item in items): + return candidate + return None + + +def _merge_by_key(base, override, key_name): + result = [] + index_by_key = {} + for item in base: + if not isinstance(item, dict): + continue + if item.get(key_name) is not None: + index_by_key[item[key_name]] = len(result) + result.append(dict(item)) + for item in override: + if not isinstance(item, dict): + result.append(item) + continue + key = item.get(key_name) + if key is not None and key in index_by_key: + result[index_by_key[key]] = dict(item) + else: + if key is not None: + index_by_key[key] = len(result) + result.append(dict(item)) + return result + + +def _merge_arrays(base, override): + base_arr = base if isinstance(base, list) else [] + override_arr = override if isinstance(override, list) else [] + keyed_field = _detect_keyed_merge_field(base_arr + override_arr) + if keyed_field: + return _merge_by_key(base_arr, override_arr, keyed_field) + return base_arr + override_arr + + +def deep_merge(base, override): + if isinstance(base, dict) and isinstance(override, dict): + result = dict(base) + for key, over_val in override.items(): + if key in result: + result[key] = deep_merge(result[key], over_val) + else: + result[key] = over_val + return result + if isinstance(base, list) and isinstance(override, list): + return _merge_arrays(base, override) + return override + + +def extract_key(data, dotted_key: str): + parts = dotted_key.split(".") + current = data + for part in parts: + if isinstance(current, dict) and part in current: + current = current[part] + else: + return _MISSING + return current + + +def main(): + parser = argparse.ArgumentParser( + description="Resolve BMad central config using four-layer TOML merge.", + ) + parser.add_argument( + "--project-root", "-p", required=True, + help="Absolute path to the project root (contains _bmad/)", + ) + parser.add_argument( + "--key", "-k", action="append", default=[], + help="Dotted field path to resolve (repeatable). Omit for full dump.", + ) + args = parser.parse_args() + + project_root = Path(args.project_root).resolve() + bmad_dir = project_root / "_bmad" + + base_team = load_toml(bmad_dir / "config.toml", required=True) + base_user = load_toml(bmad_dir / "config.user.toml") + custom_team = load_toml(bmad_dir / "custom" / "config.toml") + custom_user = load_toml(bmad_dir / "custom" / "config.user.toml") + + merged = deep_merge(base_team, base_user) + merged = deep_merge(merged, custom_team) + merged = deep_merge(merged, custom_user) + + if args.key: + output = {} + for key in args.key: + value = extract_key(merged, key) + if value is not _MISSING: + output[key] = value + else: + output = merged + + sys.stdout.write(json.dumps(output, indent=2, ensure_ascii=False) + "\n") + + +if __name__ == "__main__": + main() diff --git a/src/scripts/resolve_customization.py b/src/scripts/resolve_customization.py new file mode 100755 index 000000000..28901ed0f --- /dev/null +++ b/src/scripts/resolve_customization.py @@ -0,0 +1,230 @@ +#!/usr/bin/env python3 +""" +Resolve customization for a BMad skill using three-layer TOML merge. + +Reads customization from three layers (highest priority first): + 1. {project-root}/_bmad/custom/{name}.user.toml (personal, gitignored) + 2. {project-root}/_bmad/custom/{name}.toml (team/org, committed) + 3. {skill-root}/customize.toml (skill defaults) + +Skill name is derived from the basename of the skill directory. + +Outputs merged JSON to stdout. Errors go to stderr. + +Requires Python 3.11+ (uses stdlib `tomllib`). No `uv`, no `pip install`, +no virtualenv — plain `python3` is sufficient. + + python3 resolve_customization.py --skill /abs/path/to/skill-dir + python3 resolve_customization.py --skill ... --key agent + python3 resolve_customization.py --skill ... --key agent.menu + +Merge rules (purely structural — no field-name special-casing): + - Scalars (string, int, bool, float): override wins + - Tables: deep merge (recursively apply these rules) + - Arrays of tables where every item shares the *same* identifier + field (every item has `code`, or every item has `id`): + merge by that key (matching keys replace, new keys append) + - All other arrays — including arrays where only some items have + `code` or `id`, or where items mix the two keys: + append (base items followed by override items) + +No removal mechanism — overrides cannot delete base items. To suppress +a default, fork the skill or override the item by code with a no-op +description/prompt. +""" + +import argparse +import json +import sys +from pathlib import Path + +try: + import tomllib +except ImportError: + sys.stderr.write( + "error: Python 3.11+ is required (stdlib `tomllib` not found).\n" + "Install a newer Python or run the resolution manually per the\n" + "fallback instructions in the skill's SKILL.md.\n" + ) + sys.exit(3) + + +_MISSING = object() +_KEYED_MERGE_FIELDS = ("code", "id") + + +def find_project_root(start: Path): + current = start.resolve() + while True: + if (current / "_bmad").exists() or (current / ".git").exists(): + return current + parent = current.parent + if parent == current: + return None + current = parent + + +def load_toml(file_path: Path, required: bool = False) -> dict: + if not file_path.exists(): + if required: + sys.stderr.write(f"error: required customization file not found: {file_path}\n") + sys.exit(1) + return {} + try: + with file_path.open("rb") as f: + parsed = tomllib.load(f) + if not isinstance(parsed, dict): + if required: + sys.stderr.write(f"error: {file_path} did not parse to a table\n") + sys.exit(1) + return {} + return parsed + except tomllib.TOMLDecodeError as error: + level = "error" if required else "warning" + sys.stderr.write(f"{level}: failed to parse {file_path}: {error}\n") + if required: + sys.exit(1) + return {} + except OSError as error: + level = "error" if required else "warning" + sys.stderr.write(f"{level}: failed to read {file_path}: {error}\n") + if required: + sys.exit(1) + return {} + + +def _detect_keyed_merge_field(items): + """Return 'code' or 'id' if every table item carries that *same* field. + + All items must share the same identifier (all `code`, or all `id`). + Mixed arrays — where some items use `code` and others use `id` — + return None and fall through to append semantics. This is intentional: + mixing identifier keys within one array is a schema smell, and + append-fallback is safer than guessing which key should merge. + """ + if not items or not all(isinstance(item, dict) for item in items): + return None + for candidate in _KEYED_MERGE_FIELDS: + if all(item.get(candidate) is not None for item in items): + return candidate + return None + + +def _merge_by_key(base, override, key_name): + result = [] + index_by_key = {} + + for item in base: + if not isinstance(item, dict): + continue + if item.get(key_name) is not None: + index_by_key[item[key_name]] = len(result) + result.append(dict(item)) + + for item in override: + if not isinstance(item, dict): + result.append(item) + continue + key = item.get(key_name) + if key is not None and key in index_by_key: + result[index_by_key[key]] = dict(item) + else: + if key is not None: + index_by_key[key] = len(result) + result.append(dict(item)) + + return result + + +def _merge_arrays(base, override): + """Shape-aware array merge. Base + override combined tables may opt into + keyed merge if every item has `code` or `id`. Otherwise: append.""" + base_arr = base if isinstance(base, list) else [] + override_arr = override if isinstance(override, list) else [] + keyed_field = _detect_keyed_merge_field(base_arr + override_arr) + if keyed_field: + return _merge_by_key(base_arr, override_arr, keyed_field) + return base_arr + override_arr + + +def deep_merge(base, override): + """Recursively merge override into base using structural rules. + - Table + table: deep merge + - Array + array: shape-aware (keyed merge if all items have code/id, else append) + - Anything else: override wins + """ + if isinstance(base, dict) and isinstance(override, dict): + result = dict(base) + for key, over_val in override.items(): + if key in result: + result[key] = deep_merge(result[key], over_val) + else: + result[key] = over_val + return result + if isinstance(base, list) and isinstance(override, list): + return _merge_arrays(base, override) + return override + + +def extract_key(data, dotted_key: str): + parts = dotted_key.split(".") + current = data + for part in parts: + if isinstance(current, dict) and part in current: + current = current[part] + else: + return _MISSING + return current + + +def main(): + parser = argparse.ArgumentParser( + description="Resolve customization for a BMad skill using three-layer TOML merge.", + add_help=True, + ) + parser.add_argument( + "--skill", "-s", required=True, + help="Absolute path to the skill directory (must contain customize.toml)", + ) + parser.add_argument( + "--key", "-k", action="append", default=[], + help="Dotted field path to resolve (repeatable). Omit for full dump.", + ) + args = parser.parse_args() + + skill_dir = Path(args.skill).resolve() + skill_name = skill_dir.name + defaults_path = skill_dir / "customize.toml" + + defaults = load_toml(defaults_path, required=True) + + # Prefer the project that contains this skill. Only fall back to cwd if + # the skill isn't inside a recognizable project tree (unusual but possible + # for standalone skills invoked directly). Using cwd first is unsafe when + # an ancestor of cwd happens to have a stray _bmad/ from another project. + project_root = find_project_root(skill_dir) or find_project_root(Path.cwd()) + + team = {} + user = {} + if project_root: + custom_dir = project_root / "_bmad" / "custom" + team = load_toml(custom_dir / f"{skill_name}.toml") + user = load_toml(custom_dir / f"{skill_name}.user.toml") + + merged = deep_merge(defaults, team) + merged = deep_merge(merged, user) + + if args.key: + output = {} + for key in args.key: + value = extract_key(merged, key) + if value is not _MISSING: + output[key] = value + else: + output = merged + + sys.stdout.write(json.dumps(output, indent=2, ensure_ascii=False) + "\n") + + +if __name__ == "__main__": + main() diff --git a/test/test-install-to-bmad.js b/test/test-install-to-bmad.js deleted file mode 100644 index d33218eb8..000000000 --- a/test/test-install-to-bmad.js +++ /dev/null @@ -1,154 +0,0 @@ -/** - * install_to_bmad Flag — Design Contract Tests - * - * Unit tests against the functions that implement the install_to_bmad flag. - * These nail down the 4 core design decisions: - * - * 1. true/omitted → skill stays in _bmad/ (default behavior) - * 2. false → skill removed from _bmad/ after IDE install - * 3. No platform → no cleanup runs (cleanup lives in installVerbatimSkills) - * 4. Mixed flags → each skill evaluated independently - * - * Usage: node test/test-install-to-bmad.js - */ - -const path = require('node:path'); -const os = require('node:os'); -const fs = require('fs-extra'); -const { loadSkillManifest, getInstallToBmad } = require('../tools/installer/ide/shared/skill-manifest'); - -// ANSI colors -const colors = { - reset: '\u001B[0m', - green: '\u001B[32m', - red: '\u001B[31m', - yellow: '\u001B[33m', - cyan: '\u001B[36m', - dim: '\u001B[2m', -}; - -let passed = 0; -let failed = 0; - -function assert(condition, testName, errorMessage = '') { - if (condition) { - console.log(`${colors.green}✓${colors.reset} ${testName}`); - passed++; - } else { - console.log(`${colors.red}✗${colors.reset} ${testName}`); - if (errorMessage) { - console.log(` ${colors.dim}${errorMessage}${colors.reset}`); - } - failed++; - } -} - -async function runTests() { - console.log(`${colors.cyan}========================================`); - console.log('install_to_bmad — Design Contract Tests'); - console.log(`========================================${colors.reset}\n`); - - // ============================================================ - // 1. true/omitted → getInstallToBmad returns true (keep in _bmad/) - // ============================================================ - console.log(`${colors.yellow}Design decision 1: true or omitted → skill stays in _bmad/${colors.reset}\n`); - - // Null manifest (no bmad-skill-manifest.yaml) → true - assert(getInstallToBmad(null, 'workflow.md') === true, 'null manifest defaults to true'); - - // Single-entry, flag omitted → true - assert( - getInstallToBmad({ __single: { type: 'skill' } }, 'workflow.md') === true, - 'single-entry manifest with flag omitted defaults to true', - ); - - // Single-entry, explicit true → true - assert( - getInstallToBmad({ __single: { type: 'skill', install_to_bmad: true } }, 'workflow.md') === true, - 'single-entry manifest with explicit true returns true', - ); - - console.log(''); - - // ============================================================ - // 2. false → getInstallToBmad returns false (remove from _bmad/) - // ============================================================ - console.log(`${colors.yellow}Design decision 2: false → skill removed from _bmad/${colors.reset}\n`); - - // Single-entry, explicit false → false - assert( - getInstallToBmad({ __single: { type: 'skill', install_to_bmad: false } }, 'workflow.md') === false, - 'single-entry manifest with explicit false returns false', - ); - - // loadSkillManifest round-trip: YAML with false is preserved through load - { - const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-itb-')); - await fs.writeFile(path.join(tmpDir, 'bmad-skill-manifest.yaml'), 'type: skill\ninstall_to_bmad: false\n'); - const loaded = await loadSkillManifest(tmpDir); - assert(getInstallToBmad(loaded, 'workflow.md') === false, 'loadSkillManifest preserves install_to_bmad: false through round-trip'); - await fs.remove(tmpDir); - } - - console.log(''); - - // ============================================================ - // 3. No platform → cleanup only runs inside installVerbatimSkills - // (This is a design invariant: getInstallToBmad is only consulted - // during IDE install. Without a platform, the flag has no effect.) - // ============================================================ - console.log(`${colors.yellow}Design decision 3: flag is a per-skill property, not a pipeline gate${colors.reset}\n`); - - // The flag value is stored but doesn't trigger any side effects by itself. - // Cleanup is driven by reading the CSV column inside installVerbatimSkills. - // We verify the flag is just data — getInstallToBmad doesn't touch the filesystem. - { - const manifest = { __single: { type: 'skill', install_to_bmad: false } }; - const result = getInstallToBmad(manifest, 'workflow.md'); - assert(typeof result === 'boolean', 'getInstallToBmad returns a boolean (pure data, no side effects)'); - assert(result === false, 'false value is faithfully returned for consumer to act on'); - } - - console.log(''); - - // ============================================================ - // 4. Mixed flags → each skill evaluated independently - // ============================================================ - console.log(`${colors.yellow}Design decision 4: mixed flags — each skill independent${colors.reset}\n`); - - // Multi-entry manifest: different files can have different flags - { - const manifest = { - 'workflow.md': { type: 'skill', install_to_bmad: false }, - 'other.md': { type: 'skill', install_to_bmad: true }, - }; - assert(getInstallToBmad(manifest, 'workflow.md') === false, 'multi-entry: workflow.md with false returns false'); - assert(getInstallToBmad(manifest, 'other.md') === true, 'multi-entry: other.md with true returns true'); - assert(getInstallToBmad(manifest, 'unknown.md') === true, 'multi-entry: unknown file defaults to true'); - } - - console.log(''); - - // ============================================================ - // Summary - // ============================================================ - console.log(`${colors.cyan}========================================`); - console.log('Results:'); - console.log(` Passed: ${colors.green}${passed}${colors.reset}`); - console.log(` Failed: ${colors.red}${failed}${colors.reset}`); - console.log(`========================================${colors.reset}\n`); - - if (failed === 0) { - console.log(`${colors.green}All install_to_bmad contract tests passed!${colors.reset}\n`); - process.exit(0); - } else { - console.log(`${colors.red}Some install_to_bmad contract tests failed${colors.reset}\n`); - process.exit(1); - } -} - -runTests().catch((error) => { - console.error(`${colors.red}Test runner failed:${colors.reset}`, error.message); - console.error(error.stack); - process.exit(1); -}); diff --git a/test/test-installation-components.js b/test/test-installation-components.js index b548cbabe..4827afcbf 100644 --- a/test/test-installation-components.js +++ b/test/test-installation-components.js @@ -13,7 +13,7 @@ const path = require('node:path'); const os = require('node:os'); -const fs = require('fs-extra'); +const fs = require('../tools/installer/fs-native'); const { Installer } = require('../tools/installer/core/installer'); const { ManifestGenerator } = require('../tools/installer/core/manifest-generator'); const { OfficialModules } = require('../tools/installer/modules/official-modules'); @@ -59,8 +59,8 @@ async function createTestBmadFixture() { await fs.writeFile( path.join(fixtureDir, '_config', 'skill-manifest.csv'), [ - 'canonicalId,name,description,module,path,install_to_bmad', - '"bmad-master","bmad-master","Minimal test agent fixture","core","_bmad/core/bmad-master/SKILL.md","true"', + 'canonicalId,name,description,module,path', + '"bmad-master","bmad-master","Minimal test agent fixture","core","_bmad/core/bmad-master/SKILL.md"', '', ].join('\n'), ); @@ -91,20 +91,11 @@ async function createSkillCollisionFixture() { const configDir = path.join(fixtureDir, '_config'); await fs.ensureDir(configDir); - await fs.writeFile( - path.join(configDir, 'agent-manifest.csv'), - [ - 'name,displayName,title,icon,capabilities,role,identity,communicationStyle,principles,module,path,canonicalId', - '"bmad-master","BMAD Master","","","","","","","","core","_bmad/core/agents/bmad-master.md","bmad-master"', - '', - ].join('\n'), - ); - await fs.writeFile( path.join(configDir, 'skill-manifest.csv'), [ - 'canonicalId,name,description,module,path,install_to_bmad', - '"bmad-help","bmad-help","Native help skill","core","_bmad/core/tasks/bmad-help/SKILL.md","true"', + 'canonicalId,name,description,module,path', + '"bmad-help","bmad-help","Native help skill","core","_bmad/core/tasks/bmad-help/SKILL.md"', '', ].join('\n'), ); @@ -128,56 +119,6 @@ async function createSkillCollisionFixture() { return { root: fixtureRoot, bmadDir: fixtureDir }; } -async function createCustomModuleManifestFixture() { - const fixtureRoot = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-custom-manifest-')); - const bmadDir = path.join(fixtureRoot, '_bmad'); - const configDir = path.join(bmadDir, '_config'); - const moduleSourceDir = path.join(fixtureRoot, 'test-module-source'); - await fs.ensureDir(configDir); - await fs.ensureDir(moduleSourceDir); - - const minimalAgent = 'p'; - await fs.ensureDir(path.join(bmadDir, 'core', 'agents')); - await fs.writeFile(path.join(bmadDir, 'core', 'agents', 'test.md'), minimalAgent); - await fs.ensureDir(path.join(bmadDir, 'test-module', 'agents')); - await fs.writeFile(path.join(bmadDir, 'test-module', 'agents', 'test.md'), minimalAgent); - await fs.writeFile(path.join(moduleSourceDir, 'module.yaml'), ['code: test-module', 'name: Test Module', ''].join('\n')); - - await fs.writeFile( - path.join(configDir, 'manifest.yaml'), - [ - 'installation:', - ' version: 6.2.2', - ' installDate: 2026-03-30T00:00:00.000Z', - ' lastUpdated: 2026-03-30T00:00:00.000Z', - 'modules:', - ' - name: core', - ' version: 6.2.2', - ' installDate: 2026-03-30T00:00:00.000Z', - ' lastUpdated: 2026-03-30T00:00:00.000Z', - ' source: built-in', - ' npmPackage: null', - ' repoUrl: null', - ' - name: test-module', - ' version: null', - ' installDate: 2026-03-30T00:00:00.000Z', - ' lastUpdated: 2026-03-30T00:00:00.000Z', - ' source: custom', - ' npmPackage: null', - ' repoUrl: null', - 'customModules:', - ' - id: test-module', - ' name: "Test Module"', - ` sourcePath: ${JSON.stringify(moduleSourceDir)}`, - 'ides:', - ' - codex', - '', - ].join('\n'), - ); - - return { root: fixtureRoot, bmadDir, manifestPath: path.join(configDir, 'manifest.yaml'), moduleSourceDir }; -} - /** * Test Suite */ @@ -198,19 +139,10 @@ async function runTests() { const platformCodes = await loadPlatformCodes(); const windsurfInstaller = platformCodes.platforms.windsurf?.installer; - assert(windsurfInstaller?.target_dir === '.windsurf/skills', 'Windsurf target_dir uses native skills path'); - - assert( - Array.isArray(windsurfInstaller?.legacy_targets) && windsurfInstaller.legacy_targets.includes('.windsurf/workflows'), - 'Windsurf installer cleans legacy workflow output', - ); + assert(windsurfInstaller?.target_dir === '.agents/skills', 'Windsurf target_dir uses native skills path'); const tempProjectDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-windsurf-test-')); const installedBmadDir = await createTestBmadFixture(); - const legacyDir = path.join(tempProjectDir, '.windsurf', 'workflows', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir); - await fs.writeFile(path.join(tempProjectDir, '.windsurf', 'workflows', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir, 'SKILL.md'), 'legacy\n'); const ideManager = new IdeManager(); await ideManager.ensureInitialized(); @@ -221,11 +153,9 @@ async function runTests() { assert(result.success === true, 'Windsurf setup succeeds against temp project'); - const skillFile = path.join(tempProjectDir, '.windsurf', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile = path.join(tempProjectDir, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile), 'Windsurf install writes SKILL.md directory output'); - assert(!(await fs.pathExists(path.join(tempProjectDir, '.windsurf', 'workflows'))), 'Windsurf setup removes legacy workflows dir'); - await fs.remove(tempProjectDir); await fs.remove(path.dirname(installedBmadDir)); } catch (error) { @@ -246,17 +176,8 @@ async function runTests() { assert(kiroInstaller?.target_dir === '.kiro/skills', 'Kiro target_dir uses native skills path'); - assert( - Array.isArray(kiroInstaller?.legacy_targets) && kiroInstaller.legacy_targets.includes('.kiro/steering'), - 'Kiro installer cleans legacy steering output', - ); - const tempProjectDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-kiro-test-')); const installedBmadDir = await createTestBmadFixture(); - const legacyDir = path.join(tempProjectDir, '.kiro', 'steering', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir); - await fs.writeFile(path.join(tempProjectDir, '.kiro', 'steering', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir, 'SKILL.md'), 'legacy\n'); const ideManager = new IdeManager(); await ideManager.ensureInitialized(); @@ -270,8 +191,6 @@ async function runTests() { const skillFile = path.join(tempProjectDir, '.kiro', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile), 'Kiro install writes SKILL.md directory output'); - assert(!(await fs.pathExists(path.join(tempProjectDir, '.kiro', 'steering'))), 'Kiro setup removes legacy steering dir'); - await fs.remove(tempProjectDir); await fs.remove(path.dirname(installedBmadDir)); } catch (error) { @@ -292,17 +211,8 @@ async function runTests() { assert(antigravityInstaller?.target_dir === '.agent/skills', 'Antigravity target_dir uses native skills path'); - assert( - Array.isArray(antigravityInstaller?.legacy_targets) && antigravityInstaller.legacy_targets.includes('.agent/workflows'), - 'Antigravity installer cleans legacy workflow output', - ); - const tempProjectDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-antigravity-test-')); const installedBmadDir = await createTestBmadFixture(); - const legacyDir = path.join(tempProjectDir, '.agent', 'workflows', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir); - await fs.writeFile(path.join(tempProjectDir, '.agent', 'workflows', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir, 'SKILL.md'), 'legacy\n'); const ideManager = new IdeManager(); await ideManager.ensureInitialized(); @@ -316,8 +226,6 @@ async function runTests() { const skillFile = path.join(tempProjectDir, '.agent', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile), 'Antigravity install writes SKILL.md directory output'); - assert(!(await fs.pathExists(path.join(tempProjectDir, '.agent', 'workflows'))), 'Antigravity setup removes legacy workflows dir'); - await fs.remove(tempProjectDir); await fs.remove(path.dirname(installedBmadDir)); } catch (error) { @@ -336,12 +244,7 @@ async function runTests() { const platformCodes = await loadPlatformCodes(); const auggieInstaller = platformCodes.platforms.auggie?.installer; - assert(auggieInstaller?.target_dir === '.augment/skills', 'Auggie target_dir uses native skills path'); - - assert( - Array.isArray(auggieInstaller?.legacy_targets) && auggieInstaller.legacy_targets.includes('.augment/commands'), - 'Auggie installer cleans legacy command output', - ); + assert(auggieInstaller?.target_dir === '.agents/skills', 'Auggie target_dir uses native skills path'); assert( auggieInstaller?.ancestor_conflict_check !== true, @@ -350,10 +253,6 @@ async function runTests() { const tempProjectDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-auggie-test-')); const installedBmadDir = await createTestBmadFixture(); - const legacyDir = path.join(tempProjectDir, '.augment', 'commands', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir); - await fs.writeFile(path.join(tempProjectDir, '.augment', 'commands', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir, 'SKILL.md'), 'legacy\n'); const ideManager = new IdeManager(); await ideManager.ensureInitialized(); @@ -364,11 +263,9 @@ async function runTests() { assert(result.success === true, 'Auggie setup succeeds against temp project'); - const skillFile = path.join(tempProjectDir, '.augment', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile = path.join(tempProjectDir, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile), 'Auggie install writes SKILL.md directory output'); - assert(!(await fs.pathExists(path.join(tempProjectDir, '.augment', 'commands'))), 'Auggie setup removes legacy commands dir'); - await fs.remove(tempProjectDir); await fs.remove(path.dirname(installedBmadDir)); } catch (error) { @@ -387,30 +284,10 @@ async function runTests() { const platformCodes = await loadPlatformCodes(); const opencodeInstaller = platformCodes.platforms.opencode?.installer; - assert(opencodeInstaller?.target_dir === '.opencode/skills', 'OpenCode target_dir uses native skills path'); - - assert( - Array.isArray(opencodeInstaller?.legacy_targets) && - ['.opencode/agents', '.opencode/commands', '.opencode/agent', '.opencode/command'].every((legacyTarget) => - opencodeInstaller.legacy_targets.includes(legacyTarget), - ), - 'OpenCode installer cleans split legacy agent and command output', - ); + assert(opencodeInstaller?.target_dir === '.agents/skills', 'OpenCode target_dir uses native skills path'); const tempProjectDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-opencode-test-')); const installedBmadDir = await createTestBmadFixture(); - const legacyDirs = [ - path.join(tempProjectDir, '.opencode', 'agents', 'bmad-legacy-agent'), - path.join(tempProjectDir, '.opencode', 'commands', 'bmad-legacy-command'), - path.join(tempProjectDir, '.opencode', 'agent', 'bmad-legacy-agent-singular'), - path.join(tempProjectDir, '.opencode', 'command', 'bmad-legacy-command-singular'), - ]; - - for (const legacyDir of legacyDirs) { - await fs.ensureDir(legacyDir); - await fs.writeFile(path.join(legacyDir, 'SKILL.md'), 'legacy\n'); - await fs.writeFile(path.join(path.dirname(legacyDir), `${path.basename(legacyDir)}.md`), 'legacy\n'); - } const ideManager = new IdeManager(); await ideManager.ensureInitialized(); @@ -421,16 +298,9 @@ async function runTests() { assert(result.success === true, 'OpenCode setup succeeds against temp project'); - const skillFile = path.join(tempProjectDir, '.opencode', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile = path.join(tempProjectDir, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile), 'OpenCode install writes SKILL.md directory output'); - for (const legacyDir of ['agents', 'commands', 'agent', 'command']) { - assert( - !(await fs.pathExists(path.join(tempProjectDir, '.opencode', legacyDir))), - `OpenCode setup removes legacy .opencode/${legacyDir} dir`, - ); - } - await fs.remove(tempProjectDir); await fs.remove(path.dirname(installedBmadDir)); } catch (error) { @@ -451,16 +321,8 @@ async function runTests() { assert(claudeInstaller?.target_dir === '.claude/skills', 'Claude Code target_dir uses native skills path'); - assert( - Array.isArray(claudeInstaller?.legacy_targets) && claudeInstaller.legacy_targets.includes('.claude/commands'), - 'Claude Code installer cleans legacy command output', - ); - const tempProjectDir9 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-claude-code-test-')); const installedBmadDir9 = await createTestBmadFixture(); - const legacyDir9 = path.join(tempProjectDir9, '.claude', 'commands'); - await fs.ensureDir(legacyDir9); - await fs.writeFile(path.join(legacyDir9, 'bmad-legacy.md'), 'legacy\n'); const ideManager9 = new IdeManager(); await ideManager9.ensureInitialized(); @@ -479,8 +341,6 @@ async function runTests() { const nameMatch9 = skillContent9.match(/^name:\s*(.+)$/m); assert(nameMatch9 && nameMatch9[1].trim() === 'bmad-master', 'Claude Code skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(legacyDir9)), 'Claude Code setup removes legacy commands dir'); - await fs.remove(tempProjectDir9); await fs.remove(path.dirname(installedBmadDir9)); } catch (error) { @@ -503,16 +363,8 @@ async function runTests() { assert(codexInstaller?.target_dir === '.agents/skills', 'Codex target_dir uses native skills path'); - assert( - Array.isArray(codexInstaller?.legacy_targets) && codexInstaller.legacy_targets.includes('.codex/prompts'), - 'Codex installer cleans legacy prompt output', - ); - const tempProjectDir11 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-codex-test-')); const installedBmadDir11 = await createTestBmadFixture(); - const legacyDir11 = path.join(tempProjectDir11, '.codex', 'prompts'); - await fs.ensureDir(legacyDir11); - await fs.writeFile(path.join(legacyDir11, 'bmad-legacy.md'), 'legacy\n'); const ideManager11 = new IdeManager(); await ideManager11.ensureInitialized(); @@ -531,8 +383,6 @@ async function runTests() { const nameMatch11 = skillContent11.match(/^name:\s*(.+)$/m); assert(nameMatch11 && nameMatch11[1].trim() === 'bmad-master', 'Codex skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(legacyDir11)), 'Codex setup removes legacy prompts dir'); - await fs.remove(tempProjectDir11); await fs.remove(path.dirname(installedBmadDir11)); } catch (error) { @@ -553,20 +403,12 @@ async function runTests() { const platformCodes13 = await loadPlatformCodes(); const cursorInstaller = platformCodes13.platforms.cursor?.installer; - assert(cursorInstaller?.target_dir === '.cursor/skills', 'Cursor target_dir uses native skills path'); - - assert( - Array.isArray(cursorInstaller?.legacy_targets) && cursorInstaller.legacy_targets.includes('.cursor/commands'), - 'Cursor installer cleans legacy command output', - ); + assert(cursorInstaller?.target_dir === '.agents/skills', 'Cursor target_dir uses native skills path'); assert(!cursorInstaller?.ancestor_conflict_check, 'Cursor installer does not enable ancestor conflict checks'); const tempProjectDir13c = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-cursor-test-')); const installedBmadDir13c = await createTestBmadFixture(); - const legacyDir13c = path.join(tempProjectDir13c, '.cursor', 'commands'); - await fs.ensureDir(legacyDir13c); - await fs.writeFile(path.join(legacyDir13c, 'bmad-legacy.md'), 'legacy\n'); const ideManager13c = new IdeManager(); await ideManager13c.ensureInitialized(); @@ -577,7 +419,7 @@ async function runTests() { assert(result13c.success === true, 'Cursor setup succeeds against temp project'); - const skillFile13c = path.join(tempProjectDir13c, '.cursor', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile13c = path.join(tempProjectDir13c, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile13c), 'Cursor install writes SKILL.md directory output'); // Verify name frontmatter matches directory name @@ -585,8 +427,6 @@ async function runTests() { const nameMatch13c = skillContent13c.match(/^name:\s*(.+)$/m); assert(nameMatch13c && nameMatch13c[1].trim() === 'bmad-master', 'Cursor skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(legacyDir13c)), 'Cursor setup removes legacy commands dir'); - await fs.remove(tempProjectDir13c); await fs.remove(path.dirname(installedBmadDir13c)); } catch (error) { @@ -605,19 +445,10 @@ async function runTests() { const platformCodes13 = await loadPlatformCodes(); const rooInstaller = platformCodes13.platforms.roo?.installer; - assert(rooInstaller?.target_dir === '.roo/skills', 'Roo target_dir uses native skills path'); - - assert( - Array.isArray(rooInstaller?.legacy_targets) && rooInstaller.legacy_targets.includes('.roo/commands'), - 'Roo installer cleans legacy command output', - ); + assert(rooInstaller?.target_dir === '.agents/skills', 'Roo target_dir uses native skills path'); const tempProjectDir13 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-roo-test-')); const installedBmadDir13 = await createTestBmadFixture(); - const legacyDir13 = path.join(tempProjectDir13, '.roo', 'commands', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir13); - await fs.writeFile(path.join(tempProjectDir13, '.roo', 'commands', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir13, 'SKILL.md'), 'legacy\n'); const ideManager13 = new IdeManager(); await ideManager13.ensureInitialized(); @@ -628,7 +459,7 @@ async function runTests() { assert(result13.success === true, 'Roo setup succeeds against temp project'); - const skillFile13 = path.join(tempProjectDir13, '.roo', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile13 = path.join(tempProjectDir13, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile13), 'Roo install writes SKILL.md directory output'); // Verify name frontmatter matches directory name (Roo constraint: lowercase alphanumeric + hyphens) @@ -639,8 +470,6 @@ async function runTests() { 'Roo skill name frontmatter matches directory name exactly (lowercase alphanumeric + hyphens)', ); - assert(!(await fs.pathExists(path.join(tempProjectDir13, '.roo', 'commands'))), 'Roo setup removes legacy commands dir'); - // Reinstall/upgrade: run setup again over existing skills output const result13b = await ideManager13.setup('roo', tempProjectDir13, installedBmadDir13, { silent: true, @@ -674,31 +503,13 @@ async function runTests() { const platformCodes17 = await loadPlatformCodes(); const copilotInstaller = platformCodes17.platforms['github-copilot']?.installer; - assert(copilotInstaller?.target_dir === '.github/skills', 'GitHub Copilot target_dir uses native skills path'); - - assert( - Array.isArray(copilotInstaller?.legacy_targets) && copilotInstaller.legacy_targets.includes('.github/agents'), - 'GitHub Copilot installer cleans legacy agents output', - ); - - assert( - Array.isArray(copilotInstaller?.legacy_targets) && copilotInstaller.legacy_targets.includes('.github/prompts'), - 'GitHub Copilot installer cleans legacy prompts output', - ); + assert(copilotInstaller?.target_dir === '.agents/skills', 'GitHub Copilot target_dir uses native skills path'); const tempProjectDir17 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-copilot-test-')); const installedBmadDir17 = await createTestBmadFixture(); - // Create legacy .github/agents/ and .github/prompts/ files - const legacyAgentsDir17 = path.join(tempProjectDir17, '.github', 'agents'); - const legacyPromptsDir17 = path.join(tempProjectDir17, '.github', 'prompts'); - await fs.ensureDir(legacyAgentsDir17); - await fs.ensureDir(legacyPromptsDir17); - await fs.writeFile(path.join(legacyAgentsDir17, 'bmad-legacy.agent.md'), 'legacy agent\n'); - await fs.writeFile(path.join(legacyPromptsDir17, 'bmad-legacy.prompt.md'), 'legacy prompt\n'); - - // Create legacy copilot-instructions.md with BMAD markers const copilotInstructionsPath17 = path.join(tempProjectDir17, '.github', 'copilot-instructions.md'); + await fs.ensureDir(path.dirname(copilotInstructionsPath17)); await fs.writeFile( copilotInstructionsPath17, 'User content before\n\nBMAD generated content\n\nUser content after\n', @@ -713,7 +524,7 @@ async function runTests() { assert(result17.success === true, 'GitHub Copilot setup succeeds against temp project'); - const skillFile17 = path.join(tempProjectDir17, '.github', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile17 = path.join(tempProjectDir17, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile17), 'GitHub Copilot install writes SKILL.md directory output'); // Verify name frontmatter matches directory name @@ -721,10 +532,6 @@ async function runTests() { const nameMatch17 = skillContent17.match(/^name:\s*(.+)$/m); assert(nameMatch17 && nameMatch17[1].trim() === 'bmad-master', 'GitHub Copilot skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(legacyAgentsDir17)), 'GitHub Copilot setup removes legacy agents dir'); - - assert(!(await fs.pathExists(legacyPromptsDir17)), 'GitHub Copilot setup removes legacy prompts dir'); - // Verify copilot-instructions.md BMAD markers were stripped but user content preserved const cleanedInstructions17 = await fs.readFile(copilotInstructionsPath17, 'utf8'); assert( @@ -756,17 +563,8 @@ async function runTests() { assert(clineInstaller?.target_dir === '.cline/skills', 'Cline target_dir uses native skills path'); - assert( - Array.isArray(clineInstaller?.legacy_targets) && clineInstaller.legacy_targets.includes('.clinerules/workflows'), - 'Cline installer cleans legacy workflow output', - ); - const tempProjectDir18 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-cline-test-')); const installedBmadDir18 = await createTestBmadFixture(); - const legacyDir18 = path.join(tempProjectDir18, '.clinerules', 'workflows', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir18); - await fs.writeFile(path.join(tempProjectDir18, '.clinerules', 'workflows', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir18, 'SKILL.md'), 'legacy\n'); const ideManager18 = new IdeManager(); await ideManager18.ensureInitialized(); @@ -785,8 +583,6 @@ async function runTests() { const nameMatch18 = skillContent18.match(/^name:\s*(.+)$/m); assert(nameMatch18 && nameMatch18[1].trim() === 'bmad-master', 'Cline skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir18, '.clinerules', 'workflows'))), 'Cline setup removes legacy workflows dir'); - // Reinstall/upgrade: run setup again over existing skills output const result18b = await ideManager18.setup('cline', tempProjectDir18, installedBmadDir18, { silent: true, @@ -816,17 +612,8 @@ async function runTests() { assert(codebuddyInstaller?.target_dir === '.codebuddy/skills', 'CodeBuddy target_dir uses native skills path'); - assert( - Array.isArray(codebuddyInstaller?.legacy_targets) && codebuddyInstaller.legacy_targets.includes('.codebuddy/commands'), - 'CodeBuddy installer cleans legacy command output', - ); - const tempProjectDir19 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-codebuddy-test-')); const installedBmadDir19 = await createTestBmadFixture(); - const legacyDir19 = path.join(tempProjectDir19, '.codebuddy', 'commands', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir19); - await fs.writeFile(path.join(tempProjectDir19, '.codebuddy', 'commands', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir19, 'SKILL.md'), 'legacy\n'); const ideManager19 = new IdeManager(); await ideManager19.ensureInitialized(); @@ -844,8 +631,6 @@ async function runTests() { const nameMatch19 = skillContent19.match(/^name:\s*(.+)$/m); assert(nameMatch19 && nameMatch19[1].trim() === 'bmad-master', 'CodeBuddy skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir19, '.codebuddy', 'commands'))), 'CodeBuddy setup removes legacy commands dir'); - const result19b = await ideManager19.setup('codebuddy', tempProjectDir19, installedBmadDir19, { silent: true, selectedModules: ['bmm'], @@ -872,19 +657,10 @@ async function runTests() { const platformCodes20 = await loadPlatformCodes(); const crushInstaller = platformCodes20.platforms.crush?.installer; - assert(crushInstaller?.target_dir === '.crush/skills', 'Crush target_dir uses native skills path'); - - assert( - Array.isArray(crushInstaller?.legacy_targets) && crushInstaller.legacy_targets.includes('.crush/commands'), - 'Crush installer cleans legacy command output', - ); + assert(crushInstaller?.target_dir === '.agents/skills', 'Crush target_dir uses native skills path'); const tempProjectDir20 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-crush-test-')); const installedBmadDir20 = await createTestBmadFixture(); - const legacyDir20 = path.join(tempProjectDir20, '.crush', 'commands', 'bmad-legacy-dir'); - await fs.ensureDir(legacyDir20); - await fs.writeFile(path.join(tempProjectDir20, '.crush', 'commands', 'bmad-legacy.md'), 'legacy\n'); - await fs.writeFile(path.join(legacyDir20, 'SKILL.md'), 'legacy\n'); const ideManager20 = new IdeManager(); await ideManager20.ensureInitialized(); @@ -895,15 +671,13 @@ async function runTests() { assert(result20.success === true, 'Crush setup succeeds against temp project'); - const skillFile20 = path.join(tempProjectDir20, '.crush', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile20 = path.join(tempProjectDir20, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile20), 'Crush install writes SKILL.md directory output'); const skillContent20 = await fs.readFile(skillFile20, 'utf8'); const nameMatch20 = skillContent20.match(/^name:\s*(.+)$/m); assert(nameMatch20 && nameMatch20[1].trim() === 'bmad-master', 'Crush skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir20, '.crush', 'commands'))), 'Crush setup removes legacy commands dir'); - const result20b = await ideManager20.setup('crush', tempProjectDir20, installedBmadDir20, { silent: true, selectedModules: ['bmm'], @@ -932,16 +706,8 @@ async function runTests() { assert(traeInstaller?.target_dir === '.trae/skills', 'Trae target_dir uses native skills path'); - assert( - Array.isArray(traeInstaller?.legacy_targets) && traeInstaller.legacy_targets.includes('.trae/rules'), - 'Trae installer cleans legacy rules output', - ); - const tempProjectDir21 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-trae-test-')); const installedBmadDir21 = await createTestBmadFixture(); - const legacyDir21 = path.join(tempProjectDir21, '.trae', 'rules'); - await fs.ensureDir(legacyDir21); - await fs.writeFile(path.join(legacyDir21, 'bmad-legacy.md'), 'legacy\n'); const ideManager21 = new IdeManager(); await ideManager21.ensureInitialized(); @@ -959,8 +725,6 @@ async function runTests() { const nameMatch21 = skillContent21.match(/^name:\s*(.+)$/m); assert(nameMatch21 && nameMatch21[1].trim() === 'bmad-master', 'Trae skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir21, '.trae', 'rules'))), 'Trae setup removes legacy rules dir'); - const result21b = await ideManager21.setup('trae', tempProjectDir21, installedBmadDir21, { silent: true, selectedModules: ['bmm'], @@ -989,12 +753,7 @@ async function runTests() { assert(!kiloConfig22?.suspended, 'KiloCoder is not suspended'); - assert(kiloConfig22?.installer?.target_dir === '.kilocode/skills', 'KiloCoder target_dir uses native skills path'); - - assert( - Array.isArray(kiloConfig22?.installer?.legacy_targets) && kiloConfig22.installer.legacy_targets.includes('.kilocode/workflows'), - 'KiloCoder installer cleans legacy workflows output', - ); + assert(kiloConfig22?.installer?.target_dir === '.agents/skills', 'KiloCoder target_dir uses native skills path'); const ideManager22 = new IdeManager(); await ideManager22.ensureInitialized(); @@ -1009,11 +768,6 @@ async function runTests() { const tempProjectDir22 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-kilo-test-')); const installedBmadDir22 = await createTestBmadFixture(); - // Pre-populate legacy Kilo artifacts that should be cleaned up - const legacyDir22 = path.join(tempProjectDir22, '.kilocode', 'workflows'); - await fs.ensureDir(legacyDir22); - await fs.writeFile(path.join(legacyDir22, 'bmad-legacy.md'), 'legacy\n'); - const result22 = await ideManager22.setup('kilo', tempProjectDir22, installedBmadDir22, { silent: true, selectedModules: ['bmm'], @@ -1021,15 +775,13 @@ async function runTests() { assert(result22.success === true, 'KiloCoder setup succeeds against temp project'); - const skillFile22 = path.join(tempProjectDir22, '.kilocode', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile22 = path.join(tempProjectDir22, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile22), 'KiloCoder install writes SKILL.md directory output'); const skillContent22 = await fs.readFile(skillFile22, 'utf8'); const nameMatch22 = skillContent22.match(/^name:\s*(.+)$/m); assert(nameMatch22 && nameMatch22[1].trim() === 'bmad-master', 'KiloCoder skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir22, '.kilocode', 'workflows'))), 'KiloCoder setup removes legacy workflows dir'); - const result22b = await ideManager22.setup('kilo', tempProjectDir22, installedBmadDir22, { silent: true, selectedModules: ['bmm'], @@ -1056,18 +808,10 @@ async function runTests() { const platformCodes23 = await loadPlatformCodes(); const geminiInstaller = platformCodes23.platforms.gemini?.installer; - assert(geminiInstaller?.target_dir === '.gemini/skills', 'Gemini target_dir uses native skills path'); - - assert( - Array.isArray(geminiInstaller?.legacy_targets) && geminiInstaller.legacy_targets.includes('.gemini/commands'), - 'Gemini installer cleans legacy commands output', - ); + assert(geminiInstaller?.target_dir === '.agents/skills', 'Gemini target_dir uses native skills path'); const tempProjectDir23 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-gemini-test-')); const installedBmadDir23 = await createTestBmadFixture(); - const legacyDir23 = path.join(tempProjectDir23, '.gemini', 'commands'); - await fs.ensureDir(legacyDir23); - await fs.writeFile(path.join(legacyDir23, 'bmad-legacy.toml'), 'legacy\n'); const ideManager23 = new IdeManager(); await ideManager23.ensureInitialized(); @@ -1078,15 +822,13 @@ async function runTests() { assert(result23.success === true, 'Gemini setup succeeds against temp project'); - const skillFile23 = path.join(tempProjectDir23, '.gemini', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile23 = path.join(tempProjectDir23, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile23), 'Gemini install writes SKILL.md directory output'); const skillContent23 = await fs.readFile(skillFile23, 'utf8'); const nameMatch23 = skillContent23.match(/^name:\s*(.+)$/m); assert(nameMatch23 && nameMatch23[1].trim() === 'bmad-master', 'Gemini skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir23, '.gemini', 'commands'))), 'Gemini setup removes legacy commands dir'); - const result23b = await ideManager23.setup('gemini', tempProjectDir23, installedBmadDir23, { silent: true, selectedModules: ['bmm'], @@ -1114,16 +856,9 @@ async function runTests() { const iflowInstaller = platformCodes24.platforms.iflow?.installer; assert(iflowInstaller?.target_dir === '.iflow/skills', 'iFlow target_dir uses native skills path'); - assert( - Array.isArray(iflowInstaller?.legacy_targets) && iflowInstaller.legacy_targets.includes('.iflow/commands'), - 'iFlow installer cleans legacy commands output', - ); const tempProjectDir24 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-iflow-test-')); const installedBmadDir24 = await createTestBmadFixture(); - const legacyDir24 = path.join(tempProjectDir24, '.iflow', 'commands'); - await fs.ensureDir(legacyDir24); - await fs.writeFile(path.join(legacyDir24, 'bmad-legacy.md'), 'legacy\n'); const ideManager24 = new IdeManager(); await ideManager24.ensureInitialized(); @@ -1142,8 +877,6 @@ async function runTests() { const nameMatch24 = skillContent24.match(/^name:\s*(.+)$/m); assert(nameMatch24 && nameMatch24[1].trim() === 'bmad-master', 'iFlow skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir24, '.iflow', 'commands'))), 'iFlow setup removes legacy commands dir'); - await fs.remove(tempProjectDir24); await fs.remove(path.dirname(installedBmadDir24)); } catch (error) { @@ -1163,16 +896,9 @@ async function runTests() { const qwenInstaller = platformCodes25.platforms.qwen?.installer; assert(qwenInstaller?.target_dir === '.qwen/skills', 'QwenCoder target_dir uses native skills path'); - assert( - Array.isArray(qwenInstaller?.legacy_targets) && qwenInstaller.legacy_targets.includes('.qwen/commands'), - 'QwenCoder installer cleans legacy commands output', - ); const tempProjectDir25 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-qwen-test-')); const installedBmadDir25 = await createTestBmadFixture(); - const legacyDir25 = path.join(tempProjectDir25, '.qwen', 'commands'); - await fs.ensureDir(legacyDir25); - await fs.writeFile(path.join(legacyDir25, 'bmad-legacy.md'), 'legacy\n'); const ideManager25 = new IdeManager(); await ideManager25.ensureInitialized(); @@ -1191,8 +917,6 @@ async function runTests() { const nameMatch25 = skillContent25.match(/^name:\s*(.+)$/m); assert(nameMatch25 && nameMatch25[1].trim() === 'bmad-master', 'QwenCoder skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir25, '.qwen', 'commands'))), 'QwenCoder setup removes legacy commands dir'); - await fs.remove(tempProjectDir25); await fs.remove(path.dirname(installedBmadDir25)); } catch (error) { @@ -1211,17 +935,10 @@ async function runTests() { const platformCodes26 = await loadPlatformCodes(); const rovoInstaller = platformCodes26.platforms['rovo-dev']?.installer; - assert(rovoInstaller?.target_dir === '.rovodev/skills', 'Rovo Dev target_dir uses native skills path'); - assert( - Array.isArray(rovoInstaller?.legacy_targets) && rovoInstaller.legacy_targets.includes('.rovodev/workflows'), - 'Rovo Dev installer cleans legacy workflows output', - ); + assert(rovoInstaller?.target_dir === '.agents/skills', 'Rovo Dev target_dir uses native skills path'); const tempProjectDir26 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-rovodev-test-')); const installedBmadDir26 = await createTestBmadFixture(); - const legacyDir26 = path.join(tempProjectDir26, '.rovodev', 'workflows'); - await fs.ensureDir(legacyDir26); - await fs.writeFile(path.join(legacyDir26, 'bmad-legacy.md'), 'legacy\n'); // Create a prompts.yml with BMAD entries and a user entry const yaml26 = require('yaml'); @@ -1232,6 +949,7 @@ async function runTests() { { name: 'my-custom-prompt', description: 'User prompt', content_file: 'custom.md' }, ], }); + await fs.ensureDir(path.dirname(promptsPath26)); await fs.writeFile(promptsPath26, promptsContent26); const ideManager26 = new IdeManager(); @@ -1243,7 +961,7 @@ async function runTests() { assert(result26.success === true, 'Rovo Dev setup succeeds against temp project'); - const skillFile26 = path.join(tempProjectDir26, '.rovodev', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile26 = path.join(tempProjectDir26, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile26), 'Rovo Dev install writes SKILL.md directory output'); // Verify name frontmatter matches directory name @@ -1251,8 +969,6 @@ async function runTests() { const nameMatch26 = skillContent26.match(/^name:\s*(.+)$/m); assert(nameMatch26 && nameMatch26[1].trim() === 'bmad-master', 'Rovo Dev skill name frontmatter matches directory name exactly'); - assert(!(await fs.pathExists(path.join(tempProjectDir26, '.rovodev', 'workflows'))), 'Rovo Dev setup removes legacy workflows dir'); - // Verify prompts.yml cleanup: BMAD entries removed, user entry preserved const cleanedPrompts26 = yaml26.parse(await fs.readFile(promptsPath26, 'utf8')); assert( @@ -1301,6 +1017,14 @@ async function runTests() { '---\nname: bmad-architect\ndescription: Architect\n---\nOld skill content\n', ); + // Add bmad-architect to the existing skill-manifest.csv so cleanup knows it was previously installed + const configDir27 = path.join(installedBmadDir27, '_config'); + const existingCsv27 = await fs.readFile(path.join(configDir27, 'skill-manifest.csv'), 'utf8'); + await fs.writeFile( + path.join(configDir27, 'skill-manifest.csv'), + existingCsv27.trimEnd() + '\n"bmad-architect","bmad-architect","Architect","bmm","_bmad/bmm/agents/bmad-architect/SKILL.md"\n', + ); + // Run Claude Code setup (which triggers cleanup then install) const ideManager27 = new IdeManager(); await ideManager27.ensureInitialized(); @@ -1346,7 +1070,7 @@ async function runTests() { const platformCodes28 = await loadPlatformCodes(); const piInstaller = platformCodes28.platforms.pi?.installer; - assert(piInstaller?.target_dir === '.pi/skills', 'Pi target_dir uses native skills path'); + assert(piInstaller?.target_dir === '.agents/skills', 'Pi target_dir uses native skills path'); tempProjectDir28 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-pi-test-')); installedBmadDir28 = await createTestBmadFixture(); @@ -1376,7 +1100,7 @@ async function runTests() { const detectedAfter28 = await ideManager28.detectInstalledIdes(tempProjectDir28); assert(detectedAfter28.includes('pi'), 'Pi is detected after install'); - const skillFile28 = path.join(tempProjectDir28, '.pi', 'skills', 'bmad-master', 'SKILL.md'); + const skillFile28 = path.join(tempProjectDir28, '.agents', 'skills', 'bmad-master', 'SKILL.md'); assert(await fs.pathExists(skillFile28), 'Pi install writes SKILL.md directory output'); // Parse YAML frontmatter between --- markers @@ -1500,16 +1224,16 @@ async function runTests() { const taskSkillEntry29 = generator29.skills.find((s) => s.canonicalId === 'task-skill'); assert(taskSkillEntry29 !== undefined, 'Skill in tasks/ dir appears in skills[]'); - // Native agent entrypoint should be installed as a verbatim skill and also - // remain visible to the agent manifest pipeline. + // Native agent entrypoint should be installed as a verbatim skill. + // (Agent roster is now sourced from module.yaml's `agents:` block, not + // from per-skill bmad-skill-manifest.yaml sidecars, so this test no longer + // verifies agents[] membership — see collectAgentsFromModuleYaml tests.) const nativeAgentEntry29 = generator29.skills.find((s) => s.canonicalId === 'bmad-tea'); assert(nativeAgentEntry29 !== undefined, 'Native type:agent SKILL.md dir appears in skills[]'); assert( nativeAgentEntry29 && nativeAgentEntry29.path.includes('agents/bmad-tea/SKILL.md'), 'Native type:agent SKILL.md path points to the agent directory entrypoint', ); - const nativeAgentManifest29 = generator29.agents.find((a) => a.name === 'bmad-tea'); - assert(nativeAgentManifest29 !== undefined, 'Native type:agent SKILL.md dir appears in agents[] for agent metadata'); // Regular type:workflow should NOT appear in skills[] const regularInSkills29 = generator29.skills.find((s) => s.canonicalId === 'regular-wf'); @@ -1658,7 +1382,7 @@ async function runTests() { }); assert(result.success === true, 'Antigravity setup succeeds with overlapping skill names'); - assert(result.detail === '1 skills', 'Installer detail reports skill count'); + assert(result.detail === '1 skills → .agent/skills', 'Installer detail reports skill count and target dir'); assert(result.handlerResult.results.skillDirectories === 1, 'Result exposes unique skill directory count'); assert(result.handlerResult.results.skills === 1, 'Result retains verbatim skill count'); assert( @@ -1766,102 +1490,1285 @@ async function runTests() { console.log(''); // ============================================================ - // Suite 33: Main manifest preserves active customModules only + // Test Suite 33: Community & Custom Module Managers // ============================================================ - console.log(`${colors.yellow}Test Suite 33: Preserve active customModules in main manifest${colors.reset}\n`); + console.log(`${colors.yellow}Test Suite 33: Community & Custom Module Managers${colors.reset}\n`); - let customManifestFixture = null; - try { - customManifestFixture = await createCustomModuleManifestFixture(); - const yaml = require('yaml'); - const originalManifest = yaml.parse(await fs.readFile(customManifestFixture.manifestPath, 'utf8')); - originalManifest.customModules.push({ - id: 'removed-module', - name: 'Removed Module', - sourcePath: path.join(customManifestFixture.root, 'removed-module-source'), + // --- CustomModuleManager._normalizeCustomModule --- + { + const { CustomModuleManager } = require('../tools/installer/modules/custom-module-manager'); + const mgr = new CustomModuleManager(); + + const plugin = { name: 'test-plugin', description: 'A test', version: '1.0.0', author: 'tester', source: './src' }; + const data = { owner: 'Fallback Owner' }; + const result = mgr._normalizeCustomModule(plugin, 'https://github.com/o/r', data); + + assert(result.code === 'test-plugin', 'normalizeCustomModule sets code from plugin name'); + assert(result.type === 'custom', 'normalizeCustomModule sets type to custom'); + assert(result.trustTier === 'unverified', 'normalizeCustomModule sets trustTier to unverified'); + assert(result.version === '1.0.0', 'normalizeCustomModule preserves version'); + assert(result.author === 'tester', 'normalizeCustomModule uses plugin author over data.owner'); + + const pluginNoAuthor = { name: 'x', description: '', version: null }; + const result2 = mgr._normalizeCustomModule(pluginNoAuthor, 'https://github.com/o/r', data); + assert(result2.author === 'Fallback Owner', 'normalizeCustomModule falls back to data.owner'); + } + + // --- CommunityModuleManager._normalizeCommunityModule --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); + + const mod = { + name: 'test-mod', + display_name: 'Test Module', + code: 'tm', + description: 'desc', + repository: 'https://github.com/o/r', + module_definition: 'src/module.yaml', + category: 'software-development', + subcategory: 'dev-tools', + trust_tier: 'bmad-certified', + version: '2.0.0', + approved_sha: 'abc123', + promoted: true, + promoted_rank: 1, + keywords: ['test', 'module'], + }; + const result = mgr._normalizeCommunityModule(mod); + + assert(result.code === 'tm', 'normalizeCommunityModule sets code'); + assert(result.displayName === 'Test Module', 'normalizeCommunityModule sets displayName from display_name'); + assert(result.type === 'community', 'normalizeCommunityModule sets type to community'); + assert(result.category === 'software-development', 'normalizeCommunityModule preserves category'); + assert(result.trustTier === 'bmad-certified', 'normalizeCommunityModule maps trust_tier'); + assert(result.approvedSha === 'abc123', 'normalizeCommunityModule maps approved_sha'); + assert(result.promoted === true, 'normalizeCommunityModule maps promoted'); + assert(result.promotedRank === 1, 'normalizeCommunityModule maps promoted_rank'); + assert(result.builtIn === false, 'normalizeCommunityModule sets builtIn false'); + } + + // --- CommunityModuleManager.searchByKeyword (with injected cache) --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); + + // Inject cached index to avoid network call + mgr._cachedIndex = { + modules: [ + { name: 'mod-a', display_name: 'Alpha', code: 'a', description: 'testing tools', category: 'dev', keywords: ['test'] }, + { name: 'mod-b', display_name: 'Beta', code: 'b', description: 'design suite', category: 'design', keywords: ['ux'] }, + { name: 'mod-c', display_name: 'Gamma', code: 'c', description: 'game engine', category: 'game', keywords: ['unity'] }, + ], + }; + + const r1 = await mgr.searchByKeyword('test'); + assert(r1.length === 1 && r1[0].code === 'a', 'searchByKeyword matches keyword'); + + const r2 = await mgr.searchByKeyword('design'); + assert(r2.length === 1 && r2[0].code === 'b', 'searchByKeyword matches description'); + + const r3 = await mgr.searchByKeyword('alpha'); + assert(r3.length === 1 && r3[0].code === 'a', 'searchByKeyword matches display name'); + + const r4 = await mgr.searchByKeyword('xyz'); + assert(r4.length === 0, 'searchByKeyword returns empty for no match'); + + const r5 = await mgr.searchByKeyword('UNITY'); + assert(r5.length === 1 && r5[0].code === 'c', 'searchByKeyword is case-insensitive'); + } + + // --- CommunityModuleManager.listFeatured (with injected cache) --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); + + mgr._cachedIndex = { + modules: [ + { name: 'a', code: 'a', promoted: true, promoted_rank: 3 }, + { name: 'b', code: 'b', promoted: false }, + { name: 'c', code: 'c', promoted: true, promoted_rank: 1 }, + ], + }; + + const featured = await mgr.listFeatured(); + assert(featured.length === 2, 'listFeatured returns only promoted modules'); + assert(featured[0].code === 'c' && featured[1].code === 'a', 'listFeatured sorts by promoted_rank ascending'); + } + + // --- CommunityModuleManager.getCategoryList (with injected cache) --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); + + mgr._cachedIndex = { + modules: [ + { name: 'a', code: 'a', category: 'software-development' }, + { name: 'b', code: 'b', category: 'design-and-creative' }, + { name: 'c', code: 'c', category: 'software-development' }, + ], + }; + mgr._cachedCategories = { + categories: { + 'software-development': { name: 'Software Development' }, + 'design-and-creative': { name: 'Design & Creative' }, + }, + }; + + const cats = await mgr.getCategoryList(); + assert(cats.length === 2, 'getCategoryList returns categories with modules'); + const swDev = cats.find((c) => c.slug === 'software-development'); + assert(swDev && swDev.moduleCount === 2, 'getCategoryList counts modules per category'); + assert(cats[0].name === 'Design & Creative', 'getCategoryList sorts alphabetically'); + } + + // --- CommunityModuleManager SHA pinning normalization --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); + + // Module with SHA set + const withSha = mgr._normalizeCommunityModule({ + name: 'pinned-mod', + code: 'pm', + approved_sha: 'abc123def456', + approved_tag: 'v1.0.0', }); - await fs.writeFile(customManifestFixture.manifestPath, yaml.stringify(originalManifest), 'utf8'); + assert(withSha.approvedSha === 'abc123def456', 'SHA is preserved when set'); + assert(withSha.approvedTag === 'v1.0.0', 'Tag is preserved as metadata'); - const generator33 = new ManifestGenerator(); - await generator33.generateManifests(customManifestFixture.bmadDir, ['core', 'test-module'], [], { ides: ['codex'] }); + // Module with null SHA (trusted contributor) + const noSha = mgr._normalizeCommunityModule({ + name: 'trusted-mod', + code: 'tm', + approved_sha: null, + }); + assert(noSha.approvedSha === null, 'Null SHA means no pinning (trusted contributor)'); + } - const updatedManifest = yaml.parse(await fs.readFile(customManifestFixture.manifestPath, 'utf8')); - const customModule = updatedManifest.customModules?.find((entry) => entry.id === 'test-module'); + // --- CommunityModuleManager.listByCategory (with injected cache) --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); - assert(Array.isArray(updatedManifest.customModules), 'Main manifest keeps customModules array'); - assert(customModule !== undefined, 'Main manifest preserves existing custom module entry'); + mgr._cachedIndex = { + modules: [ + { name: 'a', code: 'a', category: 'design-and-creative' }, + { name: 'b', code: 'b', category: 'software-development' }, + { name: 'c', code: 'c', category: 'design-and-creative' }, + { name: 'd', code: 'd', category: 'game-development' }, + ], + }; + + const design = await mgr.listByCategory('design-and-creative'); + assert(design.length === 2, 'listByCategory filters to matching category'); assert( - customModule && customModule.sourcePath === customManifestFixture.moduleSourceDir, - 'Main manifest preserves custom module sourcePath', + design.every((m) => m.category === 'design-and-creative'), + 'listByCategory returns only matching modules', ); - assert( - !updatedManifest.customModules?.some((entry) => entry.id === 'removed-module'), - 'Main manifest drops stale custom module entries', - ); - } catch (error) { - assert(false, 'Main manifest preserves customModules test succeeds', error.message); - } finally { - if (customManifestFixture?.root) await fs.remove(customManifestFixture.root).catch(() => {}); + + const empty = await mgr.listByCategory('nonexistent'); + assert(empty.length === 0, 'listByCategory returns empty for unknown category'); + } + + // --- CommunityModuleManager.getModuleByCode (with injected cache) --- + { + const { CommunityModuleManager } = require('../tools/installer/modules/community-manager'); + const mgr = new CommunityModuleManager(); + + mgr._cachedIndex = { + modules: [ + { name: 'test-mod', code: 'tm', display_name: 'Test Module' }, + { name: 'other-mod', code: 'om', display_name: 'Other Module' }, + ], + }; + + const found = await mgr.getModuleByCode('tm'); + assert(found !== null && found.code === 'tm', 'getModuleByCode finds existing module'); + + const notFound = await mgr.getModuleByCode('xyz'); + assert(notFound === null, 'getModuleByCode returns null for unknown code'); } console.log(''); // ============================================================ - // Suite 34: Quick update uses manifest-backed custom sources + // Test Suite 34: RegistryClient GitHub API Cascade // ============================================================ - console.log(`${colors.yellow}Test Suite 34: Quick update uses manifest-backed custom module sources${colors.reset}\n`); + console.log(`${colors.yellow}Test Suite 34: RegistryClient GitHub API Cascade${colors.reset}\n`); - let quickUpdateFixture = null; - const originalListAvailable34 = OfficialModules.prototype.listAvailable; - const originalLoadExistingConfig34 = OfficialModules.prototype.loadExistingConfig; - const originalCollectModuleConfigQuick34 = OfficialModules.prototype.collectModuleConfigQuick; - try { - quickUpdateFixture = await createCustomModuleManifestFixture(); - const installer34 = new Installer(); - installer34.externalModuleManager.hasModule = async () => false; - installer34.externalModuleManager.listAvailable = async () => []; + { + const { RegistryClient } = require('../tools/installer/modules/registry-client'); - let capturedInstallConfig34 = null; - installer34.install = async (config) => { - capturedInstallConfig34 = config; - return { success: true }; + // Build a RegistryClient with stubbed fetch paths so we can assert on cascade behavior + // without making real network calls. + function createStubbedClient({ apiResult, rawResult }) { + const client = new RegistryClient(); + const calls = []; + + // Stub _fetchWithHeaders (GitHub API path) + client._fetchWithHeaders = async (url) => { + calls.push(`api:${url}`); + if (apiResult instanceof Error) throw apiResult; + return apiResult; + }; + + // Stub fetch (raw CDN path) — only intercept raw.githubusercontent.com calls + const originalFetch = client.fetch.bind(client); + client.fetch = async (url, timeout) => { + if (url.includes('raw.githubusercontent.com')) { + calls.push(`raw:${url}`); + if (rawResult instanceof Error) throw rawResult; + return rawResult; + } + return originalFetch(url, timeout); + }; + + return { client, calls }; + } + + // --- API success skips raw CDN --- + { + const { client, calls } = createStubbedClient({ apiResult: 'api-content', rawResult: 'raw-content' }); + const result = await client.fetchGitHubFile('owner', 'repo', 'path/file.txt', 'main'); + + assert(result === 'api-content', 'RegistryClient API success returns API content'); + assert(calls.length === 1, 'RegistryClient API success makes exactly one call'); + assert(calls[0].startsWith('api:'), 'RegistryClient API success calls API endpoint'); + } + + // --- API failure falls back to raw CDN --- + { + const { client, calls } = createStubbedClient({ apiResult: new Error('HTTP 403'), rawResult: 'raw-content' }); + const result = await client.fetchGitHubFile('owner', 'repo', 'path/file.txt', 'main'); + + assert(result === 'raw-content', 'RegistryClient API failure returns raw CDN content'); + assert(calls.length === 2, 'RegistryClient API failure makes two calls'); + assert(calls[0].startsWith('api:'), 'RegistryClient first call is to API'); + assert(calls[1].startsWith('raw:'), 'RegistryClient second call is to raw CDN'); + } + + // --- Both endpoints failing throws --- + { + const { client } = createStubbedClient({ apiResult: new Error('HTTP 403'), rawResult: new Error('HTTP 404') }); + let threw = false; + try { + await client.fetchGitHubFile('owner', 'repo', 'path/file.txt', 'main'); + } catch { + threw = true; + } + assert(threw, 'RegistryClient both endpoints failing throws an error'); + } + + // --- API URL construction --- + { + const { client, calls } = createStubbedClient({ apiResult: 'content', rawResult: 'content' }); + await client.fetchGitHubFile('bmad-code-org', 'bmad-plugins-marketplace', 'registry/official.yaml', 'main'); + + const apiCall = calls[0]; + assert( + apiCall.includes('api.github.com/repos/bmad-code-org/bmad-plugins-marketplace/contents/registry/official.yaml'), + 'RegistryClient API URL contains correct path', + ); + assert(apiCall.includes('ref=main'), 'RegistryClient API URL contains ref parameter'); + } + + // --- Raw CDN URL construction --- + { + const { client, calls } = createStubbedClient({ apiResult: new Error('fail'), rawResult: 'content' }); + await client.fetchGitHubFile('bmad-code-org', 'bmad-plugins-marketplace', 'registry/official.yaml', 'main'); + + const rawCall = calls[1]; + assert( + rawCall.includes('raw.githubusercontent.com/bmad-code-org/bmad-plugins-marketplace/main/registry/official.yaml'), + 'RegistryClient raw CDN URL contains correct path', + ); + } + + // --- fetchGitHubYaml parses YAML --- + { + const yamlContent = 'modules:\n - name: test\n description: A test module\n'; + const { client } = createStubbedClient({ apiResult: yamlContent, rawResult: yamlContent }); + const result = await client.fetchGitHubYaml('owner', 'repo', 'file.yaml', 'main'); + + assert(Array.isArray(result.modules), 'fetchGitHubYaml parses YAML correctly'); + assert(result.modules[0].name === 'test', 'fetchGitHubYaml preserves YAML values'); + } + } + + console.log(''); + + // ============================================================ + // Test Suite 35: Central Config Emission + // ============================================================ + console.log(`${colors.yellow}Test Suite 35: Central Config Emission${colors.reset}\n`); + + { + // Use the real src/ tree (core-skills + bmm-skills module.yaml are read via + // getModulePath). Only the destination bmadDir is a temp dir, which the + // installer writes config.toml / config.user.toml / custom/ into. + const tempBmadDir35 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-central-config-')); + + try { + const moduleConfigs = { + core: { + user_name: 'TestUser', + communication_language: 'Spanish', + document_output_language: 'English', + output_folder: '_bmad-output', + }, + bmm: { + project_name: 'demo-project', + user_skill_level: 'expert', + planning_artifacts: '{project-root}/_bmad-output/planning-artifacts', + implementation_artifacts: '{project-root}/_bmad-output/implementation-artifacts', + project_knowledge: '{project-root}/docs', + // Spread-from-core pollution: legacy per-module config.yaml merges + // core values into every module; writeCentralConfig must strip these + // from [modules.bmm] so core values only live in [core]. + user_name: 'TestUser', + communication_language: 'Spanish', + document_output_language: 'English', + output_folder: '_bmad-output', + }, + 'external-mod': { + // No src/modules/external-mod/module.yaml exists; installer treats + // this as unknown-schema and falls through. Core-key stripping still + // applies, so user_name/language must NOT appear under this module. + custom_setting: 'external-value', + another_setting: 'another-value', + user_name: 'TestUser', + communication_language: 'Spanish', + }, + }; + + const generator35 = new ManifestGenerator(); + generator35.bmadDir = tempBmadDir35; + generator35.bmadFolderName = path.basename(tempBmadDir35); + generator35.updatedModules = ['core', 'bmm', 'external-mod']; + + // collectAgentsFromModuleYaml reads from src/bmm-skills/module.yaml + await generator35.collectAgentsFromModuleYaml(); + assert(generator35.agents.length >= 6, 'collectAgentsFromModuleYaml discovers bmm agents from module.yaml (>= 6 agents)'); + + const maryEntry = generator35.agents.find((a) => a.code === 'bmad-agent-analyst'); + assert(maryEntry !== undefined, 'collectAgentsFromModuleYaml includes bmad-agent-analyst'); + assert(maryEntry && maryEntry.name === 'Mary', 'Agent entry carries name field'); + assert(maryEntry && maryEntry.title === 'Business Analyst', 'Agent entry carries title field'); + assert(maryEntry && maryEntry.icon === '📊', 'Agent entry carries icon field'); + assert(maryEntry && maryEntry.description.length > 0, 'Agent entry carries description field'); + assert(maryEntry && maryEntry.module === 'bmm', 'Agent entry module derives from owning module'); + assert(maryEntry && maryEntry.team === 'software-development', 'Agent entry carries explicit team from module.yaml'); + + // writeCentralConfig produces the two root files + const [teamPath, userPath] = await generator35.writeCentralConfig(tempBmadDir35, moduleConfigs); + assert(teamPath === path.join(tempBmadDir35, 'config.toml'), 'writeCentralConfig returns team config path'); + assert(userPath === path.join(tempBmadDir35, 'config.user.toml'), 'writeCentralConfig returns user config path'); + assert(await fs.pathExists(teamPath), 'config.toml is written to disk'); + assert(await fs.pathExists(userPath), 'config.user.toml is written to disk'); + + const teamContent = await fs.readFile(teamPath, 'utf8'); + const userContent = await fs.readFile(userPath, 'utf8'); + + // [core] — team-scoped keys land in config.toml + assert(teamContent.includes('[core]'), 'config.toml has [core] section'); + assert(teamContent.includes('document_output_language = "English"'), 'Team-scope core key lands in config.toml'); + assert(teamContent.includes('output_folder = "_bmad-output"'), 'Team-scope output_folder lands in config.toml'); + assert(!teamContent.includes('user_name'), 'user_name (scope: user) is absent from config.toml'); + assert(!teamContent.includes('communication_language'), 'communication_language (scope: user) is absent from config.toml'); + + // [core] — user-scoped keys land in config.user.toml + assert(userContent.includes('[core]'), 'config.user.toml has [core] section'); + assert(userContent.includes('user_name = "TestUser"'), 'user_name lands in config.user.toml'); + assert(userContent.includes('communication_language = "Spanish"'), 'communication_language lands in config.user.toml'); + assert(!userContent.includes('document_output_language'), 'Team-scope key is absent from config.user.toml'); + + // [modules.bmm] — core-key pollution stripped; own user-scope key routed to user file + const bmmTeamMatch = teamContent.match(/\[modules\.bmm\][\s\S]*?(?=\n\[|$)/); + assert(bmmTeamMatch !== null, 'config.toml has [modules.bmm] section'); + if (bmmTeamMatch) { + const bmmTeamBlock = bmmTeamMatch[0]; + assert(bmmTeamBlock.includes('project_name = "demo-project"'), 'bmm team-scope key lands under [modules.bmm]'); + assert(!bmmTeamBlock.includes('user_name'), 'user_name stripped from [modules.bmm] (core-key pollution)'); + assert(!bmmTeamBlock.includes('communication_language'), 'communication_language stripped from [modules.bmm]'); + assert(!bmmTeamBlock.includes('user_skill_level'), 'user_skill_level (scope: user) absent from [modules.bmm] in config.toml'); + } + + const bmmUserMatch = userContent.match(/\[modules\.bmm\][\s\S]*?(?=\n\[|$)/); + assert(bmmUserMatch !== null, 'config.user.toml has [modules.bmm] section'); + if (bmmUserMatch) { + assert(bmmUserMatch[0].includes('user_skill_level = "expert"'), 'user_skill_level lands in config.user.toml [modules.bmm]'); + } + + // [modules.external-mod] — unknown schema, falls through as team; core keys still stripped + const extMatch = teamContent.match(/\[modules\.external-mod\][\s\S]*?(?=\n\[|$)/); + assert(extMatch !== null, 'Unknown-schema module survives with its own [modules.*] section'); + if (extMatch) { + const extBlock = extMatch[0]; + assert(extBlock.includes('custom_setting = "external-value"'), 'Unknown-schema module retains its own keys'); + assert(!extBlock.includes('user_name'), 'Core-key pollution stripped from unknown-schema module too'); + assert(!extBlock.includes('communication_language'), 'All core-key pollution stripped from unknown-schema module'); + } + + // [agents.*] — agent roster from bmm module.yaml baked into config.toml (team-only) + assert(teamContent.includes('[agents.bmad-agent-analyst]'), 'config.toml has [agents.bmad-agent-analyst] table'); + assert(teamContent.includes('[agents.bmad-agent-dev]'), 'config.toml has [agents.bmad-agent-dev] table'); + assert(teamContent.includes('module = "bmm"'), 'Agent entry serializes module field'); + assert(teamContent.includes('team = "software-development"'), 'Agent entry serializes team field'); + assert(teamContent.includes('name = "Mary"'), 'Agent entry serializes name'); + assert(teamContent.includes('icon = "📊"'), 'Agent entry serializes icon'); + assert(!userContent.includes('[agents.'), '[agents.*] tables are never written to config.user.toml'); + + // Header comments present on both files + assert(teamContent.includes('Installer-managed. Regenerated on every install'), 'config.toml has installer-managed header'); + assert(userContent.includes('Holds install answers scoped to YOU personally.'), 'config.user.toml header clarifies user scope'); + } finally { + await fs.remove(tempBmadDir35).catch(() => {}); + } + } + + console.log(''); + + // ============================================================ + // Test Suite 36: Custom Config Stubs + // ============================================================ + console.log(`${colors.yellow}Test Suite 36: Custom Config Stubs${colors.reset}\n`); + + { + const tempBmadDir36 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-custom-stubs-')); + + try { + const generator36 = new ManifestGenerator(); + + // First install: both stubs are created + await generator36.ensureCustomConfigStubs(tempBmadDir36); + + const teamStub = path.join(tempBmadDir36, 'custom', 'config.toml'); + const userStub = path.join(tempBmadDir36, 'custom', 'config.user.toml'); + + assert(await fs.pathExists(teamStub), 'ensureCustomConfigStubs creates custom/config.toml'); + assert(await fs.pathExists(userStub), 'ensureCustomConfigStubs creates custom/config.user.toml'); + + // User writes content into the stub + const userEdit = '# User edit\n[agents.kirk]\ndescription = "Enterprise captain"\n'; + await fs.writeFile(userStub, userEdit); + + // Second install: stubs are NOT overwritten + await generator36.ensureCustomConfigStubs(tempBmadDir36); + + const preservedContent = await fs.readFile(userStub, 'utf8'); + assert(preservedContent === userEdit, 'ensureCustomConfigStubs does not overwrite user-edited custom/config.user.toml'); + } finally { + await fs.remove(tempBmadDir36).catch(() => {}); + } + } + + console.log(''); + + // ============================================================ + // Test Suite 37: Agent Preservation for Non-Contributing Modules + // ============================================================ + console.log(`${colors.yellow}Test Suite 37: Agent Preservation for Non-Contributing Modules${colors.reset}\n`); + + { + // Scenario: quickUpdate preserves a module whose source isn't available + // (e.g. external/marketplace). Its module.yaml isn't read, so its agents + // aren't in this.agents. writeCentralConfig must read the prior config.toml + // and keep those [agents.*] blocks so the roster doesn't silently shrink. + const tempBmadDir37 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-agent-preserve-')); + + try { + // Seed a prior config.toml with an agent from an external module + const priorToml = [ + '# prior', + '', + '[agents.bmad-agent-analyst]', + 'module = "bmm"', + 'team = "bmm"', + 'name = "Stale Mary"', + '', + '[agents.external-hero]', + 'module = "external-mod"', + 'team = "external-mod"', + 'name = "Hero"', + 'title = "External Agent"', + 'icon = "🦸"', + 'description = "Ships with the marketplace module."', + '', + ].join('\n'); + await fs.writeFile(path.join(tempBmadDir37, 'config.toml'), priorToml); + + const generator37 = new ManifestGenerator(); + generator37.bmadDir = tempBmadDir37; + generator37.bmadFolderName = path.basename(tempBmadDir37); + generator37.updatedModules = ['core', 'bmm', 'external-mod']; + + // bmm source is available; external-mod is not — it's a preserved module + await generator37.collectAgentsFromModuleYaml(); + const freshModules = new Set(generator37.agents.map((a) => a.module)); + assert(freshModules.has('bmm'), 'bmm contributes fresh agents from src module.yaml'); + assert(!freshModules.has('external-mod'), 'external-mod source is unavailable (preserved-module scenario)'); + + await generator37.writeCentralConfig(tempBmadDir37, { core: {}, bmm: {}, 'external-mod': {} }); + + const teamContent = await fs.readFile(path.join(tempBmadDir37, 'config.toml'), 'utf8'); + + assert( + teamContent.includes('[agents.external-hero]'), + 'Preserved [agents.external-hero] block survives rewrite even though external-mod source was unavailable', + ); + assert(teamContent.includes('Ships with the marketplace module.'), 'Preserved block keeps its original description'); + assert(teamContent.includes('module = "external-mod"'), 'Preserved block keeps its module field'); + + // Freshly collected agents win over stale entries with the same code + const maryMatches = teamContent.match(/\[agents\.bmad-agent-analyst\]/g) || []; + assert(maryMatches.length === 1, 'bmad-agent-analyst emitted exactly once (fresh wins; stale not duplicated)'); + assert(!teamContent.includes('Stale Mary'), 'Stale name from prior config.toml is discarded when fresh module.yaml is read'); + } finally { + await fs.remove(tempBmadDir37).catch(() => {}); + } + } + + console.log(''); + + // ============================================================ + // Test Suite 38: External-Module Agent Resolution + // ============================================================ + console.log(`${colors.yellow}Test Suite 38: External-Module Agent Resolution${colors.reset}\n`); + + { + // Scenario: external official modules (bmb, cis, gds, ...) are cloned into + // ~/.bmad/cache/external-modules// — NOT copied into src/modules/. + // collectAgentsFromModuleYaml must resolve them from the cache or their + // agent roster silently vanishes from config.toml. + const tempCacheDir38 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-ext-cache-')); + const tempBmadDir38 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-ext-install-')); + const priorCacheEnv = process.env.BMAD_EXTERNAL_MODULES_CACHE; + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir38; + + try { + // Seed a fake external module with agents at cache//src/module.yaml — + // matches the real CIS layout. + const extSrcDir = path.join(tempCacheDir38, 'fake-ext', 'src'); + await fs.ensureDir(extSrcDir); + await fs.writeFile( + path.join(extSrcDir, 'module.yaml'), + [ + 'code: fake-ext', + 'name: "Fake External Module"', + 'agents:', + ' - code: bmad-fake-ext-agent-one', + ' name: Ext-One', + ' title: External Agent One', + ' icon: "🧪"', + ' team: fake', + ' description: "First fake external agent."', + ' - code: bmad-fake-ext-agent-two', + ' name: Ext-Two', + ' title: External Agent Two', + ' icon: "🧬"', + ' team: fake', + ' description: "Second fake external agent."', + '', + ].join('\n'), + ); + + // Second fake module at cache//skills/module.yaml — matches bmb layout. + const extSkillsDir = path.join(tempCacheDir38, 'fake-skills', 'skills'); + await fs.ensureDir(extSkillsDir); + await fs.writeFile( + path.join(extSkillsDir, 'module.yaml'), + [ + 'code: fake-skills', + 'name: "Fake Skills-Layout Module"', + 'agents:', + ' - code: bmad-fake-skills-agent', + ' name: SkillsHero', + ' title: Skills Layout Agent', + ' icon: "🛠️"', + ' team: fake-skills', + ' description: "Lives under skills/ not src/."', + '', + ].join('\n'), + ); + + const generator38 = new ManifestGenerator(); + generator38.bmadDir = tempBmadDir38; + generator38.bmadFolderName = path.basename(tempBmadDir38); + generator38.updatedModules = ['core', 'bmm', 'fake-ext', 'fake-skills']; + + await generator38.collectAgentsFromModuleYaml(); + + const byCode = new Map(generator38.agents.map((a) => [a.code, a])); + assert(byCode.has('bmad-fake-ext-agent-one'), 'external module at cache//src resolves and contributes agent one'); + assert(byCode.has('bmad-fake-ext-agent-two'), 'external module at cache//src resolves and contributes agent two'); + assert(byCode.has('bmad-fake-skills-agent'), 'external module at cache//skills layout also resolves'); + assert(byCode.get('bmad-fake-ext-agent-one').module === 'fake-ext', 'agent.module matches the owning external module name'); + assert(byCode.get('bmad-fake-ext-agent-one').team === 'fake', 'explicit team from module.yaml is preserved'); + + await generator38.writeCentralConfig(tempBmadDir38, { + core: {}, + bmm: {}, + 'fake-ext': {}, + 'fake-skills': {}, + }); + + const teamContent = await fs.readFile(path.join(tempBmadDir38, 'config.toml'), 'utf8'); + assert(teamContent.includes('[agents.bmad-fake-ext-agent-one]'), 'external-module agents land in config.toml [agents.*] section'); + assert(teamContent.includes('[agents.bmad-fake-skills-agent]'), 'skills-layout external module agents also land in config.toml'); + assert(teamContent.includes('First fake external agent.'), 'agent description from external module.yaml is written'); + } finally { + if (priorCacheEnv === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv; + } + await fs.remove(tempCacheDir38).catch(() => {}); + await fs.remove(tempBmadDir38).catch(() => {}); + } + } + + console.log(''); + + // ============================================================ + // Test Suite 39: Module Version Resolution + // ============================================================ + console.log(`${colors.yellow}Test Suite 39: Module Version Resolution${colors.reset}\n`); + + // --- package.json beats module.yaml and marketplace.json for cached external modules --- + { + const { resolveModuleVersion } = require('../tools/installer/modules/version-resolver'); + const tempCacheDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-cache-')); + const priorCacheEnv39 = process.env.BMAD_EXTERNAL_MODULES_CACHE; + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir39; + + try { + const moduleRoot = path.join(tempCacheDir39, 'tea'); + const moduleSrc = path.join(moduleRoot, 'src'); + await fs.ensureDir(path.join(moduleRoot, '.claude-plugin')); + await fs.ensureDir(moduleSrc); + + await fs.writeFile( + path.join(moduleRoot, 'package.json'), + JSON.stringify({ name: 'bmad-method-test-architecture-enterprise', version: '1.12.3' }, null, 2) + '\n', + ); + await fs.writeFile( + path.join(moduleSrc, 'module.yaml'), + ['code: tea', 'name: Test Architect', 'module_version: 1.11.0', ''].join('\n'), + ); + await fs.writeFile( + path.join(moduleRoot, '.claude-plugin', 'marketplace.json'), + JSON.stringify({ plugins: [{ name: 'tea', version: '1.7.2' }] }, null, 2) + '\n', + ); + + const versionInfo = await resolveModuleVersion('tea'); + assert(versionInfo.version === '1.12.3', 'resolver prefers cached package.json over stale marketplace metadata for external modules'); + assert(versionInfo.source === 'package.json', 'resolver reports package.json as the winning metadata source'); + } finally { + if (priorCacheEnv39 === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv39; + } + await fs.remove(tempCacheDir39).catch(() => {}); + } + } + + // --- module.yaml is used when package.json is absent --- + { + const { resolveModuleVersion } = require('../tools/installer/modules/version-resolver'); + const tempRepo39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-module-yaml-')); + const tempCacheDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-module-yaml-cache-')); + const priorCacheEnv39 = process.env.BMAD_EXTERNAL_MODULES_CACHE; + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir39; + + try { + const moduleDir = path.join(tempRepo39, 'src'); + await fs.ensureDir(path.join(tempRepo39, '.claude-plugin')); + await fs.ensureDir(moduleDir); + + await fs.writeFile(path.join(moduleDir, 'module.yaml'), ['code: sample-mod', 'module_version: 2.4.0', ''].join('\n')); + await fs.writeFile( + path.join(tempRepo39, '.claude-plugin', 'marketplace.json'), + JSON.stringify({ plugins: [{ name: 'sample-mod', version: '1.7.2' }] }, null, 2) + '\n', + ); + + const versionInfo = await resolveModuleVersion('sample-mod', { moduleSourcePath: moduleDir }); + assert(versionInfo.version === '2.4.0', 'resolver falls back to module.yaml when package.json is missing'); + assert(versionInfo.source === 'module.yaml', 'resolver reports module.yaml when it provides the selected version'); + } finally { + if (priorCacheEnv39 === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv39; + } + await fs.remove(tempRepo39).catch(() => {}); + await fs.remove(tempCacheDir39).catch(() => {}); + } + } + + // --- marketplace fallback uses semver-aware comparison --- + { + const { resolveModuleVersion } = require('../tools/installer/modules/version-resolver'); + const tempRepo39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-marketplace-')); + const tempCacheDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-marketplace-cache-')); + const priorCacheEnv39 = process.env.BMAD_EXTERNAL_MODULES_CACHE; + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir39; + + try { + const moduleDir = path.join(tempRepo39, 'src'); + await fs.ensureDir(path.join(tempRepo39, '.claude-plugin')); + await fs.ensureDir(moduleDir); + + await fs.writeFile( + path.join(tempRepo39, '.claude-plugin', 'marketplace.json'), + JSON.stringify( + { + plugins: [ + { name: 'older-plugin', version: '1.7.2' }, + { name: 'newer-plugin', version: '1.12.3' }, + ], + }, + null, + 2, + ) + '\n', + ); + + const versionInfo = await resolveModuleVersion('missing-plugin', { moduleSourcePath: moduleDir }); + assert( + versionInfo.version === '1.12.3', + 'resolver picks the highest marketplace fallback version using semver instead of string comparison', + ); + assert(versionInfo.source === 'marketplace.json', 'resolver reports marketplace.json when it is the only usable metadata source'); + } finally { + if (priorCacheEnv39 === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv39; + } + await fs.remove(tempRepo39).catch(() => {}); + await fs.remove(tempCacheDir39).catch(() => {}); + } + } + + // --- package.json lookup must not escape the module repo boundary --- + { + const { resolveModuleVersion } = require('../tools/installer/modules/version-resolver'); + const tempHost39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-boundary-host-')); + const tempCacheDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-version-boundary-cache-')); + const priorCacheEnv39 = process.env.BMAD_EXTERNAL_MODULES_CACHE; + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir39; + + try { + const moduleRoot = path.join(tempHost39, 'nested-module'); + const moduleDir = path.join(moduleRoot, 'src'); + await fs.ensureDir(path.join(moduleRoot, '.claude-plugin')); + await fs.ensureDir(moduleDir); + + await fs.writeFile(path.join(tempHost39, 'package.json'), JSON.stringify({ name: 'host-project', version: '9.9.9' }, null, 2) + '\n'); + await fs.writeFile(path.join(moduleDir, 'module.yaml'), ['code: sample-mod', 'module_version: 2.4.0', ''].join('\n')); + await fs.writeFile( + path.join(moduleRoot, '.claude-plugin', 'marketplace.json'), + JSON.stringify({ plugins: [{ name: 'sample-mod', version: '1.7.2' }] }, null, 2) + '\n', + ); + + const versionInfo = await resolveModuleVersion('sample-mod', { moduleSourcePath: moduleDir }); + assert(versionInfo.version === '2.4.0', 'resolver does not read a host project package.json outside the module repo boundary'); + assert(versionInfo.source === 'module.yaml', 'resolver stops at the module repo boundary before climbing into host project metadata'); + } finally { + if (priorCacheEnv39 === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv39; + } + await fs.remove(tempHost39).catch(() => {}); + await fs.remove(tempCacheDir39).catch(() => {}); + } + } + + // --- Manifest uses the shared resolver for external modules --- + { + const { Manifest } = require('../tools/installer/core/manifest'); + const { ExternalModuleManager } = require('../tools/installer/modules/external-manager'); + const tempCacheDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-manifest-version-cache-')); + const tempBmadDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-manifest-version-install-')); + const priorCacheEnv39 = process.env.BMAD_EXTERNAL_MODULES_CACHE; + const originalLoadConfig39 = ExternalModuleManager.prototype.loadExternalModulesConfig; + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir39; + + ExternalModuleManager.prototype.loadExternalModulesConfig = async function () { + return { + modules: [ + { + code: 'tea', + name: 'Test Architect', + repository: 'https://example.com/tea.git', + module_definition: 'src/module.yaml', + npm_package: 'bmad-method-test-architecture-enterprise', + }, + ], + }; }; + try { + const moduleRoot = path.join(tempCacheDir39, 'tea'); + const moduleSrc = path.join(moduleRoot, 'src'); + await fs.ensureDir(path.join(moduleRoot, '.claude-plugin')); + await fs.ensureDir(moduleSrc); + + await fs.writeFile( + path.join(moduleRoot, 'package.json'), + JSON.stringify({ name: 'bmad-method-test-architecture-enterprise', version: '1.12.3' }, null, 2) + '\n', + ); + await fs.writeFile(path.join(moduleSrc, 'module.yaml'), ['code: tea', 'module_version: 1.11.0', ''].join('\n')); + await fs.writeFile( + path.join(moduleRoot, '.claude-plugin', 'marketplace.json'), + JSON.stringify({ plugins: [{ name: 'tea', version: '1.7.2' }] }, null, 2) + '\n', + ); + + const manifest39 = new Manifest(); + const versionInfo = await manifest39.getModuleVersionInfo('tea', tempBmadDir39, moduleSrc); + + assert(versionInfo.version === '1.12.3', 'manifest version info prefers external package.json over stale marketplace metadata'); + assert(versionInfo.source === 'external', 'manifest preserves external source classification while using the shared resolver'); + assert( + versionInfo.npmPackage === 'bmad-method-test-architecture-enterprise', + 'manifest preserves npm package metadata for external modules', + ); + } finally { + ExternalModuleManager.prototype.loadExternalModulesConfig = originalLoadConfig39; + if (priorCacheEnv39 === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv39; + } + await fs.remove(tempCacheDir39).catch(() => {}); + await fs.remove(tempBmadDir39).catch(() => {}); + } + } + + // --- Update checks should not advertise npm downgrades when source installs are newer --- + { + const { Manifest } = require('../tools/installer/core/manifest'); + const manifest39 = new Manifest(); + const originalGetAllModuleVersions39 = manifest39.getAllModuleVersions.bind(manifest39); + const originalFetchNpmVersion39 = manifest39.fetchNpmVersion.bind(manifest39); + + manifest39.getAllModuleVersions = async () => [ + { + name: 'tea', + version: '1.12.3', + npmPackage: 'bmad-method-test-architecture-enterprise', + }, + ]; + manifest39.fetchNpmVersion = async () => '1.7.2'; + + try { + const updates = await manifest39.checkForUpdates('/unused'); + assert(updates.length === 0, 'update check ignores older npm versions when installed source metadata is newer'); + } finally { + manifest39.getAllModuleVersions = originalGetAllModuleVersions39; + manifest39.fetchNpmVersion = originalFetchNpmVersion39; + } + } + + // --- Update checks ignore non-semver version strings instead of flagging false positives --- + { + const { Manifest } = require('../tools/installer/core/manifest'); + const manifest39 = new Manifest(); + const originalGetAllModuleVersions39 = manifest39.getAllModuleVersions.bind(manifest39); + const originalFetchNpmVersion39 = manifest39.fetchNpmVersion.bind(manifest39); + + manifest39.getAllModuleVersions = async () => [ + { + name: 'tea', + version: 'workspace-build', + npmPackage: 'bmad-method-test-architecture-enterprise', + }, + ]; + manifest39.fetchNpmVersion = async () => 'latest-build'; + + try { + const updates = await manifest39.checkForUpdates('/unused'); + assert(updates.length === 0, 'update check ignores non-semver version strings instead of reporting misleading updates'); + } finally { + manifest39.getAllModuleVersions = originalGetAllModuleVersions39; + manifest39.fetchNpmVersion = originalFetchNpmVersion39; + } + } + + // --- Official module picker uses git tags for external module labels --- + { + const { UI } = require('../tools/installer/ui'); + const prompts = require('../tools/installer/prompts'); + const channelResolver = require('../tools/installer/modules/channel-resolver'); + const { ExternalModuleManager } = require('../tools/installer/modules/external-manager'); + + const ui = new UI(); + const originalOfficialListAvailable39 = OfficialModules.prototype.listAvailable; + const originalExternalListAvailable39 = ExternalModuleManager.prototype.listAvailable; + const originalAutocomplete39 = prompts.autocompleteMultiselect; + const originalSpinner39 = prompts.spinner; + const originalWarn39 = prompts.log.warn; + const originalMessage39 = prompts.log.message; + const originalResolveChannel39 = channelResolver.resolveChannel; + + const seenLabels39 = []; + const spinnerStarts39 = []; + const spinnerStops39 = []; + const warnings39 = []; + OfficialModules.prototype.listAvailable = async function () { - return { modules: [], customModules: [] }; - }; - OfficialModules.prototype.loadExistingConfig = async function () { - this.collectedConfig = this.collectedConfig || {}; - }; - OfficialModules.prototype.collectModuleConfigQuick = async function (moduleName) { - this.collectedConfig = this.collectedConfig || {}; - if (!this.collectedConfig[moduleName]) { - this.collectedConfig[moduleName] = {}; - } - return false; + return { + modules: [ + { + id: 'core', + name: 'BMad Core Module', + description: 'always installed', + defaultSelected: true, + }, + ], + }; }; - await installer34.quickUpdate({ - directory: quickUpdateFixture.root, - skipPrompts: true, + ExternalModuleManager.prototype.listAvailable = async function () { + return [ + { + code: 'bmb', + name: 'BMad Builder', + description: 'Builder module', + defaultSelected: false, + builtIn: false, + url: 'https://github.com/bmad-code-org/bmad-builder', + defaultChannel: 'stable', + }, + { + code: 'tea', + name: 'Test Architect', + description: 'Test architecture module', + defaultSelected: false, + builtIn: false, + url: 'https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise', + defaultChannel: 'stable', + }, + ]; + }; + + channelResolver.resolveChannel = async function ({ repoUrl, channel }) { + if (channel !== 'stable') { + return { channel, version: channel === 'next' ? 'main' : 'unknown' }; + } + if (repoUrl.includes('bmad-builder')) { + return { channel: 'stable', version: 'v1.7.0', ref: 'v1.7.0', resolvedFallback: false }; + } + if (repoUrl.includes('bmad-method-test-architecture-enterprise')) { + return { channel: 'stable', version: 'v1.15.0', ref: 'v1.15.0', resolvedFallback: false }; + } + throw new Error(`unexpected repo ${repoUrl}`); + }; + + prompts.autocompleteMultiselect = async (options) => { + seenLabels39.push(...options.options.map((opt) => opt.label)); + return ['core']; + }; + prompts.spinner = async () => ({ + start(message) { + spinnerStarts39.push(message); + }, + stop(message) { + spinnerStops39.push(message); + }, + error(message) { + spinnerStops39.push(`error:${message}`); + }, + }); + prompts.log.warn = async (message) => { + warnings39.push(message); + }; + prompts.log.message = async () => {}; + + try { + await ui._selectOfficialModules( + new Set(['bmb']), + new Map([ + ['bmb', '1.1.0'], + ['core', '6.2.0'], + ]), + { global: null, nextSet: new Set(), pins: new Map(), warnings: [] }, + ); + + assert( + seenLabels39.includes('BMad Builder (v1.1.0 → v1.7.0)'), + 'official module picker shows installed-to-latest arrow from git tags', + ); + assert(seenLabels39.includes('Test Architect (v1.15.0)'), 'official module picker shows latest git-tag version for fresh installs'); + assert( + spinnerStarts39.includes('Checking latest module versions...'), + 'official module picker wraps external lookups in a single spinner', + ); + assert(spinnerStops39.includes('Checked latest module versions.'), 'official module picker stops the version-check spinner'); + assert(warnings39.length === 0, 'official module picker does not warn when tag lookups succeed'); + } finally { + OfficialModules.prototype.listAvailable = originalOfficialListAvailable39; + ExternalModuleManager.prototype.listAvailable = originalExternalListAvailable39; + prompts.autocompleteMultiselect = originalAutocomplete39; + prompts.spinner = originalSpinner39; + prompts.log.warn = originalWarn39; + prompts.log.message = originalMessage39; + channelResolver.resolveChannel = originalResolveChannel39; + } + } + + // --- Official module picker warns and falls back to cached versions when tag lookups fail --- + { + const { UI } = require('../tools/installer/ui'); + const prompts = require('../tools/installer/prompts'); + const channelResolver = require('../tools/installer/modules/channel-resolver'); + const { ExternalModuleManager } = require('../tools/installer/modules/external-manager'); + + const ui = new UI(); + const tempCacheDir39 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-picker-cache-')); + const priorCacheEnv39 = process.env.BMAD_EXTERNAL_MODULES_CACHE; + const originalOfficialListAvailable39 = OfficialModules.prototype.listAvailable; + const originalExternalListAvailable39 = ExternalModuleManager.prototype.listAvailable; + const originalAutocomplete39 = prompts.autocompleteMultiselect; + const originalSpinner39 = prompts.spinner; + const originalWarn39 = prompts.log.warn; + const originalMessage39 = prompts.log.message; + const originalResolveChannel39 = channelResolver.resolveChannel; + + const seenLabels39 = []; + const warnings39 = []; + + process.env.BMAD_EXTERNAL_MODULES_CACHE = tempCacheDir39; + await fs.ensureDir(path.join(tempCacheDir39, 'bmb')); + await fs.writeFile( + path.join(tempCacheDir39, 'bmb', 'package.json'), + JSON.stringify({ name: 'bmad-builder', version: '1.7.0' }, null, 2) + '\n', + ); + + OfficialModules.prototype.listAvailable = async function () { + return { + modules: [ + { + id: 'core', + name: 'BMad Core Module', + description: 'always installed', + defaultSelected: true, + }, + ], + }; + }; + + ExternalModuleManager.prototype.listAvailable = async function () { + return [ + { + code: 'bmb', + name: 'BMad Builder', + description: 'Builder module', + defaultSelected: false, + builtIn: false, + url: 'https://github.com/bmad-code-org/bmad-builder', + defaultChannel: 'stable', + }, + ]; + }; + + channelResolver.resolveChannel = async function () { + throw new Error('tag lookup unavailable'); + }; + + prompts.autocompleteMultiselect = async (options) => { + seenLabels39.push(...options.options.map((opt) => opt.label)); + return ['core']; + }; + prompts.spinner = async () => ({ + start() {}, + stop() {}, + error() {}, + }); + prompts.log.warn = async (message) => { + warnings39.push(message); + }; + prompts.log.message = async () => {}; + + try { + await ui._selectOfficialModules(new Set(), new Map(), { global: null, nextSet: new Set(), pins: new Map(), warnings: [] }); + + assert( + seenLabels39.includes('BMad Builder (v1.7.0)'), + 'official module picker falls back to cached/local versions when tag lookup fails', + ); + assert( + warnings39.includes('Could not check latest module versions; showing cached/local versions.'), + 'official module picker warns once when all latest-version lookups fail', + ); + } finally { + OfficialModules.prototype.listAvailable = originalOfficialListAvailable39; + ExternalModuleManager.prototype.listAvailable = originalExternalListAvailable39; + prompts.autocompleteMultiselect = originalAutocomplete39; + prompts.spinner = originalSpinner39; + prompts.log.warn = originalWarn39; + prompts.log.message = originalMessage39; + channelResolver.resolveChannel = originalResolveChannel39; + if (priorCacheEnv39 === undefined) { + delete process.env.BMAD_EXTERNAL_MODULES_CACHE; + } else { + process.env.BMAD_EXTERNAL_MODULES_CACHE = priorCacheEnv39; + } + await fs.remove(tempCacheDir39).catch(() => {}); + } + } + + console.log(''); + + // ============================================================ + // Test Suite 40: Shared target_dir coordination + // ============================================================ + console.log(`${colors.yellow}Test Suite 40: Shared target_dir coordination${colors.reset}\n`); + + try { + // Cursor and Gemini both use .agents/skills — verify they coordinate. + clearCache(); + const platformCodes40 = await loadPlatformCodes(); + const cursorTarget = platformCodes40.platforms.cursor?.installer?.target_dir; + const geminiTarget = platformCodes40.platforms.gemini?.installer?.target_dir; + assert(cursorTarget === '.agents/skills' && geminiTarget === '.agents/skills', 'Cursor and Gemini share .agents/skills target_dir'); + + const tempProjectDir40 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-shared-target-')); + const installedBmadDir40 = await createTestBmadFixture(); + + const ideManager40 = new IdeManager(); + await ideManager40.ensureInitialized(); + + // Run setupBatch with both platforms — second should skip skill write. + const batchResults = await ideManager40.setupBatch(['cursor', 'gemini'], tempProjectDir40, installedBmadDir40, { + silent: true, + selectedModules: ['core'], }); - const customModule34 = capturedInstallConfig34?._customModuleSources?.get('test-module'); - - assert(capturedInstallConfig34 !== null, 'Quick update forwards config to install'); - assert(customModule34 !== undefined, 'Quick update keeps manifest-backed custom module updateable'); - assert(customModule34 && customModule34.cached === false, 'Quick update uses manifest-backed source before cache'); + assert(batchResults.length === 2, 'setupBatch returns one result per IDE'); + assert(batchResults[0].success === true, 'First platform (cursor) succeeds'); + assert(batchResults[1].success === true, 'Second platform (gemini) succeeds'); assert( - customModule34 && customModule34.sourcePath === quickUpdateFixture.moduleSourceDir, - 'Quick update uses preserved manifest sourcePath for custom modules', + batchResults[1].handlerResult?.results?.sharedTargetHandledByPeer === true, + 'Second platform marked sharedTargetHandledByPeer (skipped redundant write)', ); + + // Skill should be present in the shared dir after batch. + const sharedDir = path.join(tempProjectDir40, '.agents', 'skills'); + const sharedDirEntries = await fs.readdir(sharedDir); + assert(sharedDirEntries.includes('bmad-master'), 'Shared .agents/skills/ contains bmad-master after batched install'); + + // Now uninstall just cursor while gemini remains. Skills must survive. + const cleanupResults = await ideManager40.cleanupByList(tempProjectDir40, ['cursor'], { + silent: true, + remainingIdes: ['gemini'], + }); + assert(cleanupResults[0].skippedTarget === true, 'Cursor cleanup skips target_dir wipe when Gemini remains'); + const stillThere = await fs.readdir(sharedDir); + assert(stillThere.includes('bmad-master'), 'bmad-master still present after partial uninstall (gemini still installed)'); + + // (Cleanup of the last sharing platform requires bmadDir to be inside + // projectDir to compute removalSet; that's the production layout. The + // fixture above keeps bmad in a separate temp dir, so test 41 below + // exercises the in-project layout instead.) + + await fs.remove(tempProjectDir40).catch(() => {}); + await fs.remove(path.dirname(installedBmadDir40)).catch(() => {}); } catch (error) { - assert(false, 'Quick update manifest-backed custom source test succeeds', error.message); - } finally { - OfficialModules.prototype.listAvailable = originalListAvailable34; - OfficialModules.prototype.loadExistingConfig = originalLoadExistingConfig34; - OfficialModules.prototype.collectModuleConfigQuick = originalCollectModuleConfigQuick34; - if (quickUpdateFixture?.root) await fs.remove(quickUpdateFixture.root).catch(() => {}); + console.log(`${colors.red}Test Suite 40 setup failed: ${error.message}${colors.reset}`); + failed++; + } + + console.log(''); + + // ============================================================ + // Test Suite 40b: setupBatch — failed first writer does not poison peers + // ============================================================ + console.log(`${colors.yellow}Test Suite 40b: setupBatch resilience to first-writer failure${colors.reset}\n`); + + try { + const tempProjectDir40b = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-batch-fail-')); + const installedBmadDir40b = await createTestBmadFixture(); + + const ideManager40b = new IdeManager(); + await ideManager40b.ensureInitialized(); + + // Force cursor's setup() to fail. With the bug, gemini would see the + // claimed target and skip — leaving .agents/skills/ empty. + const cursorHandler40b = ideManager40b.handlers.get('cursor'); + const originalSetup = cursorHandler40b.setup.bind(cursorHandler40b); + cursorHandler40b.setup = async () => { + throw new Error('Simulated cursor failure'); + }; + + const batchResults40b = await ideManager40b.setupBatch(['cursor', 'gemini'], tempProjectDir40b, installedBmadDir40b, { + silent: true, + selectedModules: ['core'], + }); + + // Restore so other tests aren't affected. + cursorHandler40b.setup = originalSetup; + + assert(batchResults40b[0].success === false, 'Cursor reports failure'); + assert(batchResults40b[1].success === true, 'Gemini still succeeds despite cursor failure'); + assert( + batchResults40b[1].handlerResult?.results?.sharedTargetHandledByPeer !== true, + 'Gemini does NOT skip its own write — it becomes the new first writer', + ); + + const sharedDir40b = path.join(tempProjectDir40b, '.agents', 'skills'); + const entries40b = await fs.readdir(sharedDir40b); + assert(entries40b.includes('bmad-master'), 'Shared dir is populated by gemini after cursor failure'); + + await fs.remove(tempProjectDir40b).catch(() => {}); + await fs.remove(path.dirname(installedBmadDir40b)).catch(() => {}); + } catch (error) { + console.log(`${colors.red}Test Suite 40b setup failed: ${error.message}${colors.reset}`); + failed++; + } + + console.log(''); + + // ============================================================ + // Test Suite 41: Custom-module skill ownership (non-bmad prefix) + // ============================================================ + console.log(`${colors.yellow}Test Suite 41: Custom-module skill ownership${colors.reset}\n`); + + try { + // A custom module can ship a skill with any canonicalId (e.g. "fred-cool-skill"). + // detect() must recognize it as BMAD-owned via the manifest, not the bmad- prefix. + const fixtureRoot41 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-custom-prefix-')); + const bmadDir41 = path.join(fixtureRoot41, '_bmad'); + await fs.ensureDir(path.join(bmadDir41, '_config')); + await fs.writeFile( + path.join(bmadDir41, '_config', 'skill-manifest.csv'), + [ + 'canonicalId,name,description,module,path', + '"fred-cool-skill","fred-cool-skill","Custom module skill","fred","_bmad/fred/skills/fred-cool-skill/SKILL.md"', + '', + ].join('\n'), + ); + const fredSkill = path.join(bmadDir41, 'fred', 'skills', 'fred-cool-skill'); + await fs.ensureDir(fredSkill); + await fs.writeFile( + path.join(fredSkill, 'SKILL.md'), + ['---', 'name: fred-cool-skill', 'description: Custom module skill', '---', '', 'A custom module skill.'].join('\n'), + ); + + const ideManager41 = new IdeManager(); + await ideManager41.ensureInitialized(); + await ideManager41.setup('cursor', fixtureRoot41, bmadDir41, { silent: true, selectedModules: ['fred'] }); + + const cursorHandler = ideManager41.handlers.get('cursor'); + const detected = await cursorHandler.detect(fixtureRoot41); + assert(detected === true, 'detect() recognizes non-bmad-prefixed skill as BMAD-owned via skill-manifest.csv'); + + await fs.remove(fixtureRoot41).catch(() => {}); + } catch (error) { + console.log(`${colors.red}Test Suite 41 setup failed: ${error.message}${colors.reset}`); + failed++; } console.log(''); diff --git a/test/test-installer-channels.js b/test/test-installer-channels.js new file mode 100644 index 000000000..48fedf70e --- /dev/null +++ b/test/test-installer-channels.js @@ -0,0 +1,348 @@ +/** + * Installer Channel Resolution Tests + * + * Unit tests for the pure planning/resolution modules: + * - tools/installer/modules/channel-plan.js + * - tools/installer/modules/channel-resolver.js + * + * Neither module does I/O outside of GitHub tag lookups (which we don't + * exercise here) and semver math. All tests are deterministic. + * + * Usage: node test/test-installer-channels.js + */ + +const { + parseChannelOptions, + decideChannelForModule, + buildPlan, + orphanPinWarnings, + bundledTargetWarnings, + parsePinSpec, +} = require('../tools/installer/modules/channel-plan'); + +const { parseGitHubRepo, normalizeStableTag, classifyUpgrade, releaseNotesUrl } = require('../tools/installer/modules/channel-resolver'); + +const colors = { + reset: '', + green: '', + red: '', + yellow: '', + cyan: '', + dim: '', +}; + +let passed = 0; +let failed = 0; + +function assert(condition, testName, errorMessage = '') { + if (condition) { + console.log(`${colors.green}✓${colors.reset} ${testName}`); + passed++; + } else { + console.log(`${colors.red}✗${colors.reset} ${testName}`); + if (errorMessage) { + console.log(` ${colors.dim}${errorMessage}${colors.reset}`); + } + failed++; + } +} + +function assertEqual(actual, expected, testName) { + const ok = actual === expected; + assert(ok, testName, ok ? '' : `expected ${JSON.stringify(expected)}, got ${JSON.stringify(actual)}`); +} + +function section(title) { + console.log(`\n${colors.cyan}── ${title} ──${colors.reset}`); +} + +function runTests() { + // ───────────────────────────────────────────────────────────────────────── + // channel-plan.js :: parsePinSpec + // ───────────────────────────────────────────────────────────────────────── + section('channel-plan :: parsePinSpec'); + + { + const r = parsePinSpec('bmb=v1.2.3'); + assert(r && r.code === 'bmb' && r.tag === 'v1.2.3', 'valid CODE=TAG'); + } + { + const r = parsePinSpec(' cis = v0.1.0 '); + assert(r && r.code === 'cis' && r.tag === 'v0.1.0', 'trims whitespace around code and tag'); + } + assert(parsePinSpec('') === null, 'empty string returns null'); + assert(parsePinSpec('bmb') === null, 'missing = returns null'); + assert(parsePinSpec('=v1.0.0') === null, 'leading = returns null'); + assert(parsePinSpec('bmb=') === null, 'trailing = returns null'); + assert(parsePinSpec(null) === null, 'null input returns null'); + let undef; + assert(parsePinSpec(undef) === null, 'undefined input returns null'); + assert(parsePinSpec(42) === null, 'non-string input returns null'); + + // ───────────────────────────────────────────────────────────────────────── + // channel-plan.js :: parseChannelOptions + // ───────────────────────────────────────────────────────────────────────── + section('channel-plan :: parseChannelOptions'); + + { + const r = parseChannelOptions({}); + assert(r.global === null, 'empty: global is null'); + assert(r.nextSet instanceof Set && r.nextSet.size === 0, 'empty: nextSet is empty Set'); + assert(r.pins instanceof Map && r.pins.size === 0, 'empty: pins is empty Map'); + assert(Array.isArray(r.warnings) && r.warnings.length === 0, 'empty: no warnings'); + assert(r.acceptBypass === false, 'empty: acceptBypass false by default'); + } + { + const r = parseChannelOptions({ channel: 'stable' }); + assertEqual(r.global, 'stable', '--channel=stable sets global'); + } + { + const r = parseChannelOptions({ channel: 'NEXT' }); + assertEqual(r.global, 'next', '--channel is case-insensitive'); + } + { + const r = parseChannelOptions({ allStable: true }); + assertEqual(r.global, 'stable', '--all-stable sets global stable'); + } + { + const r = parseChannelOptions({ allNext: true }); + assertEqual(r.global, 'next', '--all-next sets global next'); + } + { + const r = parseChannelOptions({ channel: 'bogus' }); + assert(r.global === null, 'invalid --channel value is rejected (global stays null)'); + assert( + r.warnings.some((w) => w.includes("Ignoring invalid --channel value 'bogus'")), + 'invalid --channel produces a warning', + ); + } + { + // --all-stable and --all-next conflict → warning, first-wins + const r = parseChannelOptions({ allStable: true, allNext: true }); + assertEqual(r.global, 'stable', 'conflict: first flag (--all-stable) wins'); + assert( + r.warnings.some((w) => w.includes('Conflicting channel flags')), + 'conflict produces warning', + ); + } + { + const r = parseChannelOptions({ next: ['bmb', 'cis', ' '] }); + assert(r.nextSet.has('bmb') && r.nextSet.has('cis'), '--next=CODE adds to nextSet'); + assert(!r.nextSet.has(''), 'blank --next entries are skipped'); + } + { + const r = parseChannelOptions({ pin: ['bmb=v1.0.0', 'cis=v2.0.0'] }); + assertEqual(r.pins.get('bmb'), 'v1.0.0', '--pin bmb=v1.0.0 recorded'); + assertEqual(r.pins.get('cis'), 'v2.0.0', '--pin cis=v2.0.0 recorded'); + } + { + const r = parseChannelOptions({ pin: ['bmb=v1.0.0', 'bmb=v1.1.0'] }); + assertEqual(r.pins.get('bmb'), 'v1.1.0', 'duplicate --pin: last wins'); + assert( + r.warnings.some((w) => w.includes('--pin specified multiple times')), + 'duplicate --pin produces warning', + ); + } + { + const r = parseChannelOptions({ pin: ['malformed-no-equals'] }); + assert(r.pins.size === 0, 'malformed --pin is ignored'); + assert( + r.warnings.some((w) => w.includes('malformed --pin')), + 'malformed --pin warns', + ); + } + { + const r = parseChannelOptions({ yes: true }); + assertEqual(r.acceptBypass, true, '--yes sets acceptBypass so curator-bypass prompt is auto-confirmed'); + } + { + const r = parseChannelOptions({ acceptBypass: true }); + assertEqual(r.acceptBypass, true, 'explicit acceptBypass: true honored'); + } + + // ───────────────────────────────────────────────────────────────────────── + // channel-plan.js :: decideChannelForModule (precedence) + // ───────────────────────────────────────────────────────────────────────── + section('channel-plan :: decideChannelForModule (precedence)'); + + const emptyOpts = parseChannelOptions({}); + + { + const r = decideChannelForModule({ code: 'bmb', channelOptions: emptyOpts }); + assertEqual(r.channel, 'stable', 'no signal → stable default'); + assertEqual(r.source, 'default', 'source: default'); + } + { + const r = decideChannelForModule({ code: 'bmb', channelOptions: emptyOpts, registryDefault: 'next' }); + assertEqual(r.channel, 'next', 'registry default applied when no flags'); + assertEqual(r.source, 'registry', 'source: registry'); + } + { + const r = decideChannelForModule({ code: 'bmb', channelOptions: emptyOpts, registryDefault: 'bogus' }); + assertEqual(r.channel, 'stable', 'invalid registry default ignored, falls to stable'); + } + { + const opts = parseChannelOptions({ channel: 'next' }); + const r = decideChannelForModule({ code: 'bmb', channelOptions: opts, registryDefault: 'stable' }); + assertEqual(r.channel, 'next', 'global --channel beats registry default'); + assertEqual(r.source, 'flag:--channel', 'source reflects --channel origin'); + } + { + const opts = parseChannelOptions({ channel: 'stable', next: ['bmb'] }); + const r = decideChannelForModule({ code: 'bmb', channelOptions: opts }); + assertEqual(r.channel, 'next', '--next=bmb beats --channel=stable for bmb'); + assertEqual(r.source, 'flag:--next', 'source: flag:--next'); + } + { + const opts = parseChannelOptions({ channel: 'next', pin: ['bmb=v1.0.0'] }); + const r = decideChannelForModule({ code: 'bmb', channelOptions: opts }); + assertEqual(r.channel, 'pinned', '--pin beats --channel'); + assertEqual(r.pin, 'v1.0.0', 'pin value carried through'); + assertEqual(r.source, 'flag:--pin', 'source: flag:--pin'); + } + { + const opts = parseChannelOptions({ next: ['bmb'], pin: ['bmb=v1.0.0'] }); + const r = decideChannelForModule({ code: 'bmb', channelOptions: opts }); + assertEqual(r.channel, 'pinned', '--pin beats --next for same code'); + } + + // ───────────────────────────────────────────────────────────────────────── + // channel-plan.js :: buildPlan, orphanPinWarnings, bundledTargetWarnings + // ───────────────────────────────────────────────────────────────────────── + section('channel-plan :: buildPlan / warnings'); + + { + const opts = parseChannelOptions({ allStable: true, pin: ['bmb=v1.0.0'] }); + const plan = buildPlan({ + modules: [ + { code: 'bmb', defaultChannel: 'stable' }, + { code: 'cis', defaultChannel: 'stable' }, + ], + channelOptions: opts, + }); + assertEqual(plan.get('bmb').channel, 'pinned', 'buildPlan: bmb pinned'); + assertEqual(plan.get('cis').channel, 'stable', 'buildPlan: cis stable via global'); + } + { + const opts = parseChannelOptions({ pin: ['ghost=v1.0.0', 'bmb=v1.0.0'], next: ['gds'] }); + const warnings = orphanPinWarnings(opts, ['bmb']); + assert( + warnings.some((w) => w.includes("--pin for 'ghost'")), + 'orphanPinWarnings: flags pin for unselected module', + ); + assert( + warnings.some((w) => w.includes("--next for 'gds'")), + 'orphanPinWarnings: flags --next for unselected module', + ); + assert(!warnings.some((w) => w.includes("'bmb'")), 'orphanPinWarnings: no warning for selected module'); + } + { + const opts = parseChannelOptions({ pin: ['bmm=v1.0.0'], next: ['core'] }); + const warnings = bundledTargetWarnings(opts, ['core', 'bmm']); + assert( + warnings.some((w) => w.includes('bundled module')), + 'bundledTargetWarnings: warns bundled pin', + ); + assert(warnings.length === 2, 'bundledTargetWarnings: both pin and next warned'); + } + + // ───────────────────────────────────────────────────────────────────────── + // channel-resolver.js :: parseGitHubRepo + // ───────────────────────────────────────────────────────────────────────── + section('channel-resolver :: parseGitHubRepo'); + + { + const r = parseGitHubRepo('https://github.com/bmad-code-org/BMAD-METHOD'); + assert(r && r.owner === 'bmad-code-org' && r.repo === 'BMAD-METHOD', 'https URL basic'); + } + { + const r = parseGitHubRepo('https://github.com/bmad-code-org/BMAD-METHOD.git'); + assert(r && r.repo === 'BMAD-METHOD', '.git suffix stripped'); + } + { + const r = parseGitHubRepo('https://github.com/bmad-code-org/BMAD-METHOD/'); + assert(r && r.repo === 'BMAD-METHOD', 'trailing slash stripped'); + } + { + const r = parseGitHubRepo('https://github.com/org/repo/tree/main/subdir'); + assert(r && r.owner === 'org' && r.repo === 'repo', 'deep path yields owner/repo'); + } + { + const r = parseGitHubRepo('git@github.com:org/repo.git'); + assert(r && r.owner === 'org' && r.repo === 'repo', 'SSH URL parsed'); + } + assert(parseGitHubRepo('https://gitlab.com/foo/bar') === null, 'non-github URL returns null'); + assert(parseGitHubRepo('') === null, 'empty string returns null'); + assert(parseGitHubRepo(null) === null, 'null input returns null'); + assert(parseGitHubRepo(123) === null, 'non-string input returns null'); + + // ───────────────────────────────────────────────────────────────────────── + // channel-resolver.js :: normalizeStableTag + // ───────────────────────────────────────────────────────────────────────── + section('channel-resolver :: normalizeStableTag'); + + assertEqual(normalizeStableTag('v1.2.3'), '1.2.3', 'strips leading v'); + assertEqual(normalizeStableTag('1.2.3'), '1.2.3', 'bare semver accepted'); + assertEqual(normalizeStableTag('v1.2.3-alpha.1'), null, 'prerelease -alpha excluded'); + assertEqual(normalizeStableTag('v1.2.3-beta'), null, 'prerelease -beta excluded'); + assertEqual(normalizeStableTag('v1.2.3-rc.1'), null, 'prerelease -rc excluded'); + assertEqual(normalizeStableTag('not-a-version'), null, 'invalid string returns null'); + assertEqual(normalizeStableTag('v1.2'), null, 'incomplete semver returns null'); + assertEqual(normalizeStableTag(null), null, 'null returns null'); + assertEqual(normalizeStableTag(123), null, 'non-string returns null'); + + // ───────────────────────────────────────────────────────────────────────── + // channel-resolver.js :: classifyUpgrade + // ───────────────────────────────────────────────────────────────────────── + section('channel-resolver :: classifyUpgrade'); + + assertEqual(classifyUpgrade('v1.2.3', 'v1.2.3'), 'none', 'equal versions → none'); + assertEqual(classifyUpgrade('v1.2.3', 'v1.2.2'), 'none', 'downgrade → none'); + assertEqual(classifyUpgrade('v1.2.3', 'v1.2.4'), 'patch', 'patch bump'); + assertEqual(classifyUpgrade('v1.2.3', 'v1.3.0'), 'minor', 'minor bump'); + assertEqual(classifyUpgrade('v1.2.3', 'v2.0.0'), 'major', 'major bump'); + assertEqual(classifyUpgrade('1.2.3', '1.2.4'), 'patch', 'unprefixed versions work'); + assertEqual(classifyUpgrade('main', 'v1.2.3'), 'unknown', 'non-semver current → unknown'); + assertEqual(classifyUpgrade('v1.2.3', 'main'), 'unknown', 'non-semver next → unknown'); + assertEqual(classifyUpgrade('', ''), 'unknown', 'both empty → unknown'); + + // ───────────────────────────────────────────────────────────────────────── + // channel-resolver.js :: releaseNotesUrl + // ───────────────────────────────────────────────────────────────────────── + section('channel-resolver :: releaseNotesUrl'); + + assertEqual( + releaseNotesUrl('https://github.com/bmad-code-org/BMAD-METHOD', 'v1.2.3'), + 'https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v1.2.3', + 'builds standard release URL', + ); + assertEqual(releaseNotesUrl('https://gitlab.com/foo/bar', 'v1.0.0'), null, 'non-github repo → null'); + assertEqual(releaseNotesUrl('https://github.com/foo/bar', null), null, 'null tag → null'); + assertEqual(releaseNotesUrl('', 'v1.0.0'), null, 'empty URL → null'); + + // ───────────────────────────────────────────────────────────────────────── + // Summary + // ───────────────────────────────────────────────────────────────────────── + console.log(''); + console.log(`${colors.cyan}========================================`); + console.log('Test Results:'); + console.log(` Passed: ${colors.green}${passed}${colors.reset}`); + console.log(` Failed: ${colors.red}${failed}${colors.reset}`); + console.log(`========================================${colors.reset}\n`); + + if (failed === 0) { + console.log(`${colors.green}✨ All channel resolution tests passed!${colors.reset}\n`); + process.exit(0); + } else { + console.log(`${colors.red}❌ Some channel resolution tests failed${colors.reset}\n`); + process.exit(1); + } +} + +try { + runTests(); +} catch (error) { + console.error(`${colors.red}Test runner failed:${colors.reset}`, error.message); + console.error(error.stack); + process.exit(1); +} diff --git a/tools/docs/native-skills-migration-checklist.md b/tools/docs/native-skills-migration-checklist.md index 80c6a9296..e8fa4ad34 100644 --- a/tools/docs/native-skills-migration-checklist.md +++ b/tools/docs/native-skills-migration-checklist.md @@ -222,7 +222,6 @@ Support assumption: full Agent Skills support. Gemini CLI docs confirm workspace - [x] Confirm Gemini CLI native skills path is `.gemini/skills/{skill-name}/SKILL.md` (per [geminicli.com/docs/cli/skills](https://geminicli.com/docs/cli/skills/)) - [x] Implement native skills output — target_dir `.gemini/skills`, skill_format true, template_type default (replaces TOML templates) -- [x] Add legacy cleanup for `.gemini/commands` (via `legacy_targets`) - [x] Test fresh install — skills written to `.gemini/skills/bmad-master/SKILL.md` with correct frontmatter - [x] Test reinstall/upgrade from legacy TOML command output — legacy dir removed, skills installed - [x] Confirm no ancestor conflict protection is needed — Gemini CLI uses workspace > user > extension precedence, no ancestor directory inheritance @@ -236,7 +235,6 @@ Support assumption: full Agent Skills support. iFlow docs confirm workspace skil - [x] Confirm iFlow native skills path is `.iflow/skills/{skill-name}/SKILL.md` - [x] Implement native skills output — target_dir `.iflow/skills`, skill_format true, template_type default -- [x] Add legacy cleanup for `.iflow/commands` (via `legacy_targets`) - [x] Test fresh install — skills written to `.iflow/skills/bmad-master/SKILL.md` - [x] Test legacy cleanup — legacy commands dir removed - [x] Implement/extend automated tests — 6 assertions in test suite 24 @@ -249,7 +247,6 @@ Support assumption: full Agent Skills support. Qwen Code supports workspace skil - [x] Confirm QwenCoder native skills path is `.qwen/skills/{skill-name}/SKILL.md` - [x] Implement native skills output — target_dir `.qwen/skills`, skill_format true, template_type default -- [x] Add legacy cleanup for `.qwen/commands` (via `legacy_targets`) - [x] Test fresh install — skills written to `.qwen/skills/bmad-master/SKILL.md` - [x] Test legacy cleanup — legacy commands dir removed - [x] Implement/extend automated tests — 6 assertions in test suite 25 @@ -262,7 +259,6 @@ Support assumption: full Agent Skills support. Rovo Dev now supports workspace s - [x] Confirm Rovo Dev native skills path is `.rovodev/skills/{skill-name}/SKILL.md` (per Atlassian blog) - [x] Replace 257-line custom `rovodev.js` with config-driven entry in `platform-codes.yaml` -- [x] Add legacy cleanup for `.rovodev/workflows` (via `legacy_targets`) and BMAD entries in `prompts.yml` (via `cleanupRovoDevPrompts()` in `_config-driven.js`) - [x] Test fresh install — skills written to `.rovodev/skills/bmad-master/SKILL.md` - [x] Test legacy cleanup — legacy workflows dir removed, `prompts.yml` BMAD entries stripped while preserving user entries - [x] Implement/extend automated tests — 8 assertions in test suite 26 diff --git a/tools/installer/bmad-cli.js b/tools/installer/bmad-cli.js index 042714e45..a108b3a44 100755 --- a/tools/installer/bmad-cli.js +++ b/tools/installer/bmad-cli.js @@ -23,13 +23,10 @@ checkForUpdate().catch(() => { async function checkForUpdate() { try { - // For beta versions, check the beta tag; otherwise check latest - const isBeta = - packageJson.version.includes('Beta') || - packageJson.version.includes('beta') || - packageJson.version.includes('alpha') || - packageJson.version.includes('rc'); - const tag = isBeta ? 'beta' : 'latest'; + // Prereleases (e.g. 6.5.1-next.0) live on the `next` dist-tag; stable + // releases live on `latest`. semver.prerelease() returns null for stable, + // so this correctly routes pre-1.0-next/rc/etc. without string matching. + const tag = semver.prerelease(packageJson.version) ? 'next' : 'latest'; const result = execSync(`npm view ${packageName}@${tag} version`, { encoding: 'utf8', diff --git a/tools/installer/cli-utils.js b/tools/installer/cli-utils.js index 6ca615534..b2b7b0979 100644 --- a/tools/installer/cli-utils.js +++ b/tools/installer/cli-utils.js @@ -1,79 +1,43 @@ -const path = require('node:path'); -const os = require('node:os'); const prompts = require('./prompts'); const CLIUtils = { - /** - * Get version from package.json - */ - getVersion() { - try { - const packageJson = require(path.join(__dirname, '..', '..', 'package.json')); - return packageJson.version || 'Unknown'; - } catch { - return 'Unknown'; - } - }, - /** * Display BMAD logo and version using @clack intro + box */ async displayLogo() { - const version = this.getVersion(); const color = await prompts.getColor(); + const termWidth = process.stdout.columns || 80; - // ASCII art logo - const logo = [ + // Full "BMad Method" logo for wide terminals, "BMad" only for narrow + const logoWide = [ + ' ██████╗ ███╗ ███╗ █████╗ ██████╗ ███╗ ███╗███████╗████████╗██╗ ██╗ ██████╗ ██████╗ ™', + '██╔══██╗████╗ ████║██╔══██╗██╔══██╗ ████╗ ████║██╔════╝╚══██╔══╝██║ ██║██╔═══██╗██╔══██╗', + '██████╔╝██╔████╔██║███████║██║ ██║ ██╔████╔██║█████╗ ██║ ███████║██║ ██║██║ ██║', + '██╔══██╗██║╚██╔╝██║██╔══██║██║ ██║ ██║╚██╔╝██║██╔══╝ ██║ ██╔══██║██║ ██║██║ ██║', + '██████╔╝██║ ╚═╝ ██║██║ ██║██████╔╝ ██║ ╚═╝ ██║███████╗ ██║ ██║ ██║╚██████╔╝██████╔╝', + '╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═════╝ ', + ]; + + const logoNarrow = [ ' ██████╗ ███╗ ███╗ █████╗ ██████╗ ™', ' ██╔══██╗████╗ ████║██╔══██╗██╔══██╗', ' ██████╔╝██╔████╔██║███████║██║ ██║', ' ██╔══██╗██║╚██╔╝██║██╔══██║██║ ██║', ' ██████╔╝██║ ╚═╝ ██║██║ ██║██████╔╝', ' ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═════╝', - ] - .map((line) => color.yellow(line)) - .join('\n'); + ]; - const tagline = ' Build More, Architect Dreams'; + const logoLines = termWidth >= 95 ? logoWide : logoNarrow; + const logo = logoLines.map((line) => color.blue(line)).join('\n'); + const tagline = color.white(' Build More, Architect Dreams\n © BMad Code'); - await prompts.box(`${logo}\n${tagline}`, `v${version}`, { + await prompts.box(`${logo}\n${tagline}`, '', { contentAlign: 'center', rounded: true, formatBorder: color.blue, }); }, - /** - * Display section header - * @param {string} title - Section title - * @param {string} subtitle - Optional subtitle - */ - async displaySection(title, subtitle = null) { - await prompts.note(subtitle || '', title); - }, - - /** - * Display info box - * @param {string|Array} content - Content to display - * @param {Object} options - Box options - */ - async displayBox(content, options = {}) { - let text = content; - if (Array.isArray(content)) { - text = content.join('\n\n'); - } - - const color = await prompts.getColor(); - const borderColor = options.borderColor || 'cyan'; - const colorMap = { green: color.green, red: color.red, yellow: color.yellow, cyan: color.cyan, blue: color.blue }; - const formatBorder = colorMap[borderColor] || color.cyan; - - await prompts.box(text, options.title, { - rounded: options.borderStyle === 'round' || options.borderStyle === undefined, - formatBorder, - }); - }, - /** * Display module configuration header * @param {string} moduleName - Module name (fallback if no custom header) @@ -84,98 +48,6 @@ const CLIUtils = { const title = header || `Configuring ${moduleName.toUpperCase()} Module`; await prompts.note(subheader || '', title); }, - - /** - * Display module with no custom configuration - * @param {string} moduleName - Module name (fallback if no custom header) - * @param {string} header - Custom header from module.yaml - * @param {string} subheader - Custom subheader from module.yaml - */ - async displayModuleNoConfig(moduleName, header = null, subheader = null) { - const title = header || `${moduleName.toUpperCase()} Module - No Custom Configuration`; - await prompts.note(subheader || '', title); - }, - - /** - * Display step indicator - * @param {number} current - Current step - * @param {number} total - Total steps - * @param {string} description - Step description - */ - async displayStep(current, total, description) { - const progress = `[${current}/${total}]`; - await prompts.log.step(`${progress} ${description}`); - }, - - /** - * Display completion message - * @param {string} message - Completion message - */ - async displayComplete(message) { - const color = await prompts.getColor(); - await prompts.box(`\u2728 ${message}`, 'Complete', { - rounded: true, - formatBorder: color.green, - }); - }, - - /** - * Display error message - * @param {string} message - Error message - */ - async displayError(message) { - const color = await prompts.getColor(); - await prompts.box(`\u2717 ${message}`, 'Error', { - rounded: true, - formatBorder: color.red, - }); - }, - - /** - * Format list for display - * @param {Array} items - Items to display - * @param {string} prefix - Item prefix - */ - formatList(items, prefix = '\u2022') { - return items.map((item) => ` ${prefix} ${item}`).join('\n'); - }, - - /** - * Clear previous lines - * @param {number} lines - Number of lines to clear - */ - clearLines(lines) { - for (let i = 0; i < lines; i++) { - process.stdout.moveCursor(0, -1); - process.stdout.clearLine(1); - } - }, - - /** - * Display module completion message - * @param {string} moduleName - Name of the completed module - * @param {boolean} clearScreen - Whether to clear the screen first (deprecated, always false now) - */ - displayModuleComplete(moduleName, clearScreen = false) { - // No longer clear screen or show boxes - just a simple completion message - // This is deprecated but kept for backwards compatibility - }, - - /** - * Expand path with ~ expansion - * @param {string} inputPath - Path to expand - * @returns {string} Expanded path - */ - expandPath(inputPath) { - if (!inputPath) return inputPath; - - // Expand ~ to home directory - if (inputPath.startsWith('~')) { - return path.join(os.homedir(), inputPath.slice(1)); - } - - return inputPath; - }, }; module.exports = { CLIUtils }; diff --git a/tools/installer/commands/install.js b/tools/installer/commands/install.js index 96f536ef4..e10a0c96a 100644 --- a/tools/installer/commands/install.js +++ b/tools/installer/commands/install.js @@ -17,13 +17,26 @@ module.exports = { '--tools ', 'Comma-separated list of tool/IDE IDs to configure (e.g., "claude-code,cursor"). Use "none" to skip tool configuration.', ], - ['--custom-content ', 'Comma-separated list of paths to custom modules/agents/workflows'], ['--action ', 'Action type for existing installations: install, update, or quick-update'], ['--user-name ', 'Name for agents to use (default: system username)'], ['--communication-language ', 'Language for agent communication (default: English)'], ['--document-output-language ', 'Language for document output (default: English)'], ['--output-folder ', 'Output folder path relative to project root (default: _bmad-output)'], + ['--custom-source ', 'Comma-separated Git URLs or local paths to install custom modules from'], ['-y, --yes', 'Accept all defaults and skip prompts where possible'], + [ + '--channel ', + 'Apply channel (stable|next) to all external modules being installed. --all-stable and --all-next are aliases.', + ], + ['--all-stable', 'Alias for --channel=stable. Resolves externals to the highest stable release tag.'], + ['--all-next', 'Alias for --channel=next. Resolves externals to main HEAD.'], + ['--next ', 'Install module from main HEAD (next channel). Repeatable.', (value, prev) => [...(prev || []), value], []], + [ + '--pin ', + 'Pin module to a specific tag: --pin CODE=TAG (e.g. --pin bmb=v1.7.0). Repeatable.', + (value, prev) => [...(prev || []), value], + [], + ], ], action: async (options) => { try { diff --git a/tools/installer/commands/status.js b/tools/installer/commands/status.js index 49c0afd73..c7f4a816c 100644 --- a/tools/installer/commands/status.js +++ b/tools/installer/commands/status.js @@ -19,7 +19,7 @@ module.exports = { const { bmadDir } = await installer.findBmadDir(projectDir); // Check if bmad directory exists - const fs = require('fs-extra'); + const fs = require('../fs-native'); if (!(await fs.pathExists(bmadDir))) { await prompts.log.warn('No BMAD installation found in the current directory.'); await prompts.log.message(`Expected location: ${bmadDir}`); diff --git a/tools/installer/commands/uninstall.js b/tools/installer/commands/uninstall.js index d0e168a15..727b7b0ef 100644 --- a/tools/installer/commands/uninstall.js +++ b/tools/installer/commands/uninstall.js @@ -1,5 +1,5 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const prompts = require('../prompts'); const { Installer } = require('../core/installer'); diff --git a/tools/installer/core/config.js b/tools/installer/core/config.js index c844e2d00..bc359fed9 100644 --- a/tools/installer/core/config.js +++ b/tools/installer/core/config.js @@ -3,7 +3,7 @@ * User input comes from either UI answers or headless CLI flags. */ class Config { - constructor({ directory, modules, ides, skipPrompts, verbose, actionType, coreConfig, moduleConfigs, quickUpdate }) { + constructor({ directory, modules, ides, skipPrompts, verbose, actionType, coreConfig, moduleConfigs, quickUpdate, channelOptions }) { this.directory = directory; this.modules = Object.freeze([...modules]); this.ides = Object.freeze([...ides]); @@ -13,6 +13,8 @@ class Config { this.coreConfig = coreConfig; this.moduleConfigs = moduleConfigs; this._quickUpdate = quickUpdate; + // channelOptions carry a Map + Set; don't deep-freeze. + this.channelOptions = channelOptions || null; Object.freeze(this); } @@ -37,6 +39,7 @@ class Config { coreConfig: userInput.coreConfig || {}, moduleConfigs: userInput.moduleConfigs || null, quickUpdate: userInput._quickUpdate || false, + channelOptions: userInput.channelOptions || null, }); } diff --git a/tools/installer/core/custom-module-cache.js b/tools/installer/core/custom-module-cache.js deleted file mode 100644 index 4afe77884..000000000 --- a/tools/installer/core/custom-module-cache.js +++ /dev/null @@ -1,260 +0,0 @@ -/** - * Custom Module Source Cache - * Caches custom module sources under _config/custom/ to ensure they're never lost - * and can be checked into source control - */ - -const fs = require('fs-extra'); -const path = require('node:path'); -const crypto = require('node:crypto'); -const prompts = require('../prompts'); - -class CustomModuleCache { - constructor(bmadDir) { - this.bmadDir = bmadDir; - this.customCacheDir = path.join(bmadDir, '_config', 'custom'); - this.manifestPath = path.join(this.customCacheDir, 'cache-manifest.yaml'); - } - - /** - * Ensure the custom cache directory exists - */ - async ensureCacheDir() { - await fs.ensureDir(this.customCacheDir); - } - - /** - * Get cache manifest - */ - async getCacheManifest() { - if (!(await fs.pathExists(this.manifestPath))) { - return {}; - } - - const content = await fs.readFile(this.manifestPath, 'utf8'); - const yaml = require('yaml'); - return yaml.parse(content) || {}; - } - - /** - * Update cache manifest - */ - async updateCacheManifest(manifest) { - const yaml = require('yaml'); - // Clean the manifest to remove any non-serializable values - const cleanManifest = structuredClone(manifest); - - const content = yaml.stringify(cleanManifest, { - indent: 2, - lineWidth: 0, - sortKeys: false, - }); - - await fs.writeFile(this.manifestPath, content); - } - - /** - * Stream a file into the hash to avoid loading entire file into memory - */ - async hashFileStream(filePath, hash) { - return new Promise((resolve, reject) => { - const stream = require('node:fs').createReadStream(filePath); - stream.on('data', (chunk) => hash.update(chunk)); - stream.on('end', resolve); - stream.on('error', reject); - }); - } - - /** - * Calculate hash of a file or directory using streaming to minimize memory usage - */ - async calculateHash(sourcePath) { - const hash = crypto.createHash('sha256'); - - const isDir = (await fs.stat(sourcePath)).isDirectory(); - - if (isDir) { - // For directories, hash all files - const files = []; - async function collectFiles(dir) { - const entries = await fs.readdir(dir, { withFileTypes: true }); - for (const entry of entries) { - if (entry.isFile()) { - files.push(path.join(dir, entry.name)); - } else if (entry.isDirectory() && !entry.name.startsWith('.')) { - await collectFiles(path.join(dir, entry.name)); - } - } - } - - await collectFiles(sourcePath); - files.sort(); // Ensure consistent order - - for (const file of files) { - const relativePath = path.relative(sourcePath, file); - // Hash the path first, then stream file contents - hash.update(relativePath + '|'); - await this.hashFileStream(file, hash); - } - } else { - // For single files, stream directly into hash - await this.hashFileStream(sourcePath, hash); - } - - return hash.digest('hex'); - } - - /** - * Cache a custom module source - * @param {string} moduleId - Module ID - * @param {string} sourcePath - Original source path - * @param {Object} metadata - Additional metadata to store - * @returns {Object} Cached module info - */ - async cacheModule(moduleId, sourcePath, metadata = {}) { - await this.ensureCacheDir(); - - const cacheDir = path.join(this.customCacheDir, moduleId); - const cacheManifest = await this.getCacheManifest(); - - // Check if already cached and unchanged - if (cacheManifest[moduleId]) { - const cached = cacheManifest[moduleId]; - if (cached.originalHash && cached.originalHash === (await this.calculateHash(sourcePath))) { - // Source unchanged, return existing cache info - return { - moduleId, - cachePath: cacheDir, - ...cached, - }; - } - } - - // Remove existing cache if it exists - if (await fs.pathExists(cacheDir)) { - await fs.remove(cacheDir); - } - - // Copy module to cache - await fs.copy(sourcePath, cacheDir, { - filter: (src) => { - const relative = path.relative(sourcePath, src); - // Skip node_modules, .git, and other common ignore patterns - return !relative.includes('node_modules') && !relative.startsWith('.git') && !relative.startsWith('.DS_Store'); - }, - }); - - // Calculate hash of the source - const sourceHash = await this.calculateHash(sourcePath); - const cacheHash = await this.calculateHash(cacheDir); - - // Update manifest - don't store absolute paths for portability - // Clean metadata to remove absolute paths - const cleanMetadata = { ...metadata }; - if (cleanMetadata.sourcePath) { - delete cleanMetadata.sourcePath; - } - - cacheManifest[moduleId] = { - originalHash: sourceHash, - cacheHash: cacheHash, - cachedAt: new Date().toISOString(), - ...cleanMetadata, - }; - - await this.updateCacheManifest(cacheManifest); - - return { - moduleId, - cachePath: cacheDir, - ...cacheManifest[moduleId], - }; - } - - /** - * Get cached module info - * @param {string} moduleId - Module ID - * @returns {Object|null} Cached module info or null - */ - async getCachedModule(moduleId) { - const cacheManifest = await this.getCacheManifest(); - const cached = cacheManifest[moduleId]; - - if (!cached) { - return null; - } - - const cacheDir = path.join(this.customCacheDir, moduleId); - - if (!(await fs.pathExists(cacheDir))) { - // Cache dir missing, remove from manifest - delete cacheManifest[moduleId]; - await this.updateCacheManifest(cacheManifest); - return null; - } - - // Verify cache integrity - const currentCacheHash = await this.calculateHash(cacheDir); - if (currentCacheHash !== cached.cacheHash) { - await prompts.log.warn(`Cache integrity check failed for ${moduleId}`); - } - - return { - moduleId, - cachePath: cacheDir, - ...cached, - }; - } - - /** - * Get all cached modules - * @returns {Array} Array of cached module info - */ - async getAllCachedModules() { - const cacheManifest = await this.getCacheManifest(); - const cached = []; - - for (const [moduleId, info] of Object.entries(cacheManifest)) { - const cachedModule = await this.getCachedModule(moduleId); - if (cachedModule) { - cached.push(cachedModule); - } - } - - return cached; - } - - /** - * Remove a cached module - * @param {string} moduleId - Module ID to remove - */ - async removeCachedModule(moduleId) { - const cacheManifest = await this.getCacheManifest(); - const cacheDir = path.join(this.customCacheDir, moduleId); - - // Remove cache directory - if (await fs.pathExists(cacheDir)) { - await fs.remove(cacheDir); - } - - // Remove from manifest - delete cacheManifest[moduleId]; - await this.updateCacheManifest(cacheManifest); - } - - /** - * Sync cached modules with a list of module IDs - * @param {Array} moduleIds - Module IDs to keep - */ - async syncCache(moduleIds) { - const cached = await this.getAllCachedModules(); - - for (const cachedModule of cached) { - if (!moduleIds.includes(cachedModule.moduleId)) { - await this.removeCachedModule(cachedModule.moduleId); - } - } - } -} - -module.exports = { CustomModuleCache }; diff --git a/tools/installer/core/existing-install.js b/tools/installer/core/existing-install.js index 8e86f4b03..6bbf191d1 100644 --- a/tools/installer/core/existing-install.js +++ b/tools/installer/core/existing-install.js @@ -1,5 +1,5 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const yaml = require('yaml'); const { Manifest } = require('./manifest'); @@ -10,14 +10,13 @@ const { Manifest } = require('./manifest'); class ExistingInstall { #version; - constructor({ installed, version, hasCore, modules, ides, customModules }) { + constructor({ installed, version, hasCore, modules, ides }) { this.installed = installed; this.#version = version; this.hasCore = hasCore; this.modules = Object.freeze(modules.map((m) => Object.freeze({ ...m }))); this.moduleIds = Object.freeze(this.modules.map((m) => m.id)); this.ides = Object.freeze([...ides]); - this.customModules = Object.freeze([...customModules]); Object.freeze(this); } @@ -35,7 +34,6 @@ class ExistingInstall { hasCore: false, modules: [], ides: [], - customModules: [], }); } @@ -53,15 +51,11 @@ class ExistingInstall { let hasCore = false; const modules = []; let ides = []; - let customModules = []; const manifest = new Manifest(); const manifestData = await manifest.read(bmadDir); if (manifestData) { version = manifestData.version; - if (manifestData.customModules) { - customModules = manifestData.customModules; - } if (manifestData.ides) { ides = manifestData.ides.filter((ide) => ide && typeof ide === 'string'); } @@ -120,7 +114,7 @@ class ExistingInstall { return ExistingInstall.empty(); } - return new ExistingInstall({ installed, version, hasCore, modules, ides, customModules }); + return new ExistingInstall({ installed, version, hasCore, modules, ides }); } } diff --git a/tools/installer/core/install-paths.js b/tools/installer/core/install-paths.js index 7383f9bfd..21b8d4be7 100644 --- a/tools/installer/core/install-paths.js +++ b/tools/installer/core/install-paths.js @@ -1,5 +1,5 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const { getProjectRoot } = require('../project-root'); const { BMAD_FOLDER_NAME } = require('../ide/shared/path-utils'); @@ -19,16 +19,16 @@ class InstallPaths { const isUpdate = await fs.pathExists(bmadDir); const configDir = path.join(bmadDir, '_config'); - const agentsDir = path.join(configDir, 'agents'); - const customCacheDir = path.join(configDir, 'custom'); const coreDir = path.join(bmadDir, 'core'); + const scriptsDir = path.join(bmadDir, 'scripts'); + const customDir = path.join(bmadDir, 'custom'); for (const [dir, label] of [ [bmadDir, 'bmad directory'], [configDir, 'config directory'], - [agentsDir, 'agents config directory'], - [customCacheDir, 'custom modules cache'], [coreDir, 'core module directory'], + [scriptsDir, 'shared scripts directory'], + [customDir, 'customizations directory'], ]) { await ensureWritableDir(dir, label); } @@ -39,9 +39,9 @@ class InstallPaths { projectRoot, bmadDir, configDir, - agentsDir, - customCacheDir, coreDir, + scriptsDir, + customDir, isUpdate, }); } @@ -54,8 +54,11 @@ class InstallPaths { manifestFile() { return path.join(this.configDir, 'manifest.yaml'); } - agentManifest() { - return path.join(this.configDir, 'agent-manifest.csv'); + centralConfig() { + return path.join(this.bmadDir, 'config.toml'); + } + centralUserConfig() { + return path.join(this.bmadDir, 'config.user.toml'); } filesManifest() { return path.join(this.configDir, 'files-manifest.csv'); diff --git a/tools/installer/core/installer.js b/tools/installer/core/installer.js index a0ea9a66e..a68193bc6 100644 --- a/tools/installer/core/installer.js +++ b/tools/installer/core/installer.js @@ -1,8 +1,7 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const { Manifest } = require('./manifest'); const { OfficialModules } = require('../modules/official-modules'); -const { CustomModules } = require('../modules/custom-modules'); const { IdeManager } = require('../ide/manager'); const { FileOps } = require('../file-ops'); const { Config } = require('./config'); @@ -12,14 +11,15 @@ const prompts = require('../prompts'); const { BMAD_FOLDER_NAME } = require('../ide/shared/path-utils'); const { InstallPaths } = require('./install-paths'); const { ExternalModuleManager } = require('../modules/external-manager'); +const { resolveModuleVersion } = require('../modules/version-resolver'); const { ExistingInstall } = require('./existing-install'); +const { warnPreNativeSkillsLegacy } = require('./legacy-warnings'); class Installer { constructor() { this.externalModuleManager = new ExternalModuleManager(); this.manifest = new Manifest(); - this.customModules = new CustomModules(); this.ideManager = new IdeManager(); this.fileOps = new FileOps(); this.installedFiles = new Set(); // Track all installed files @@ -42,7 +42,15 @@ class Installer { const officialModules = await OfficialModules.build(config, paths); const existingInstall = await ExistingInstall.detect(paths.bmadDir); - await this.customModules.discoverPaths(originalConfig, paths); + try { + await warnPreNativeSkillsLegacy({ + projectRoot: paths.projectRoot, + existingVersion: existingInstall.installed ? existingInstall.version : null, + }); + } catch (error) { + // Legacy-dir scan is informational; never let it abort install. + await prompts.log.warn(`Warning: Could not check for legacy BMAD entries: ${error.message}`); + } if (existingInstall.installed) { await this._removeDeselectedModules(existingInstall, config, paths); @@ -52,20 +60,46 @@ class Installer { await this._validateIdeSelection(config); + // Capture pre-install module versions for from→to display + const preInstallVersions = new Map(); + if (existingInstall.installed) { + const existingModules = await this.manifest.getAllModuleVersions(paths.bmadDir); + for (const mod of existingModules) { + if (mod.name && mod.version) { + preInstallVersions.set(mod.name, mod.version); + } + } + } + // Results collector for consolidated summary const results = []; - const addResult = (step, status, detail = '') => results.push({ step, status, detail }); + const addResult = (step, status, detail = '', meta = {}) => results.push({ step, status, detail, ...meta }); - await this._cacheCustomModules(paths, addResult); + // Capture previously installed skill IDs before they get overwritten + const previousSkillIds = new Set(); + const prevCsvPath = path.join(paths.bmadDir, '_config', 'skill-manifest.csv'); + if (await fs.pathExists(prevCsvPath)) { + try { + const csvParse = require('csv-parse/sync'); + const content = await fs.readFile(prevCsvPath, 'utf8'); + const records = csvParse.parse(content, { columns: true, skip_empty_lines: true }); + for (const r of records) { + if (r.canonicalId) previousSkillIds.add(r.canonicalId); + } + } catch (error) { + await prompts.log.warn(`Failed to parse skill-manifest.csv: ${error.message}`); + } + } - // Compute module lists: official = selected minus custom, all = both - const customModuleIds = new Set(this.customModules.paths.keys()); - const officialModuleIds = (config.modules || []).filter((m) => !customModuleIds.has(m)); - const allModules = [...officialModuleIds, ...[...customModuleIds].filter((id) => !officialModuleIds.includes(id))]; + const allModules = config.modules || []; - await this._installAndConfigure(config, originalConfig, paths, officialModuleIds, allModules, addResult, officialModules); + await this._installAndConfigure(config, originalConfig, paths, allModules, allModules, addResult, officialModules); - await this._setupIdes(config, allModules, paths, addResult); + await this._setupIdes(config, allModules, paths, addResult, previousSkillIds); + + // Skills are now in IDE directories — remove redundant copies from _bmad/. + // Also cleans up skill dirs left by older installer versions. + await this._cleanupSkillDirs(paths.bmadDir); const restoreResult = await this._restoreUserFiles(paths, updateState); @@ -76,6 +110,7 @@ class Installer { ides: config.ides, customFiles: restoreResult.customFiles.length > 0 ? restoreResult.customFiles : undefined, modifiedFiles: restoreResult.modifiedFiles.length > 0 ? restoreResult.modifiedFiles : undefined, + preInstallVersions, }); return { @@ -159,39 +194,20 @@ class Installer { if (toRemove.length === 0) return; - await this.ideManager.ensureInitialized(); - for (const ide of toRemove) { - try { - const handler = this.ideManager.handlers.get(ide); - if (handler) { - await handler.cleanup(paths.projectRoot); - } - } catch (error) { - await prompts.log.warn(`Warning: Failed to remove ${ide}: ${error.message}`); + // Pass the newly-selected list as remainingIdes so cleanupByList skips + // target_dir wipes for IDEs whose directory is still owned by a peer + // (e.g. removing 'cursor' while 'gemini' remains — both share .agents/skills). + const results = await this.ideManager.cleanupByList(paths.projectRoot, toRemove, { + remainingIdes: [...newlySelected], + }); + + for (const result of results || []) { + if (result && result.success === false) { + await prompts.log.warn(`Warning: Failed to remove ${result.ide}: ${result.error || 'unknown error'}`); } } } - /** - * Cache custom modules into the local cache directory. - * Updates this.customModules.paths in place with cached locations. - */ - async _cacheCustomModules(paths, addResult) { - if (!this.customModules.paths || this.customModules.paths.size === 0) return; - - const { CustomModuleCache } = require('./custom-module-cache'); - const customCache = new CustomModuleCache(paths.bmadDir); - - for (const [moduleId, sourcePath] of this.customModules.paths) { - const cachedInfo = await customCache.cacheModule(moduleId, sourcePath, { - sourcePath: sourcePath, - }); - this.customModules.paths.set(moduleId, cachedInfo.cachePath); - } - - addResult('Custom modules cached', 'ok'); - } - /** * Install modules, create directories, generate configs and manifests. */ @@ -203,6 +219,15 @@ class Installer { const installTasks = []; + installTasks.push({ + title: 'Installing shared scripts', + task: async () => { + await this._installSharedScripts(paths); + addResult('Shared scripts', 'ok'); + return 'Shared scripts installed'; + }, + }); + if (allModules.length > 0) { installTasks.push({ title: isQuickUpdate ? `Updating ${allModules.length} module(s)` : `Installing ${allModules.length} module(s)`, @@ -214,11 +239,6 @@ class Installer { installedModuleNames, }); - await this._installCustomModules(config, paths, addResult, officialModules, { - message, - installedModuleNames, - }); - return `${allModules.length} module(s) ${isQuickUpdate ? 'updated' : 'installed'}`; }, }); @@ -265,7 +285,8 @@ class Installer { addResult('Configurations', 'ok', 'generated'); this.installedFiles.add(paths.manifestFile()); - this.installedFiles.add(paths.agentManifest()); + this.installedFiles.add(paths.centralConfig()); + this.installedFiles.add(paths.centralUserConfig()); message('Generating manifests...'); const manifestGen = new ManifestGenerator(); @@ -286,10 +307,11 @@ class Installer { await manifestGen.generateManifests(paths.bmadDir, allModulesForManifest, [...this.installedFiles], { ides: config.ides || [], preservedModules: modulesForCsvPreserve, + moduleConfigs, }); message('Generating help catalog...'); - await this.mergeModuleHelpCatalogs(paths.bmadDir); + await this.mergeModuleHelpCatalogs(paths.bmadDir, manifestGen.agents); addResult('Help catalog', 'ok'); return 'Configurations generated'; @@ -321,7 +343,7 @@ class Installer { /** * Set up IDE integrations for each selected IDE. */ - async _setupIdes(config, allModules, paths, addResult) { + async _setupIdes(config, allModules, paths, addResult, previousSkillIds = new Set()) { if (config.skipIde || !config.ides || config.ides.length === 0) return; await this.ideManager.ensureInitialized(); @@ -332,12 +354,14 @@ class Installer { return; } - for (const ide of validIdes) { - const setupResult = await this.ideManager.setup(ide, paths.projectRoot, paths.bmadDir, { - selectedModules: allModules || [], - verbose: config.verbose, - }); + const setupResults = await this.ideManager.setupBatch(validIdes, paths.projectRoot, paths.bmadDir, { + selectedModules: allModules || [], + verbose: config.verbose, + previousSkillIds, + }); + for (const setupResult of setupResults) { + const ide = setupResult.ide; if (setupResult.success) { addResult(ide, 'ok', setupResult.detail || ''); } else { @@ -346,6 +370,33 @@ class Installer { } } + /** + * Remove skill directories from _bmad/ after IDE installation. + * Skills are self-contained in IDE directories, so _bmad/ only needs + * module-level files (config.yaml, _config/, etc.). + * Also cleans up skill dirs left by older installer versions. + * @param {string} bmadDir - BMAD installation directory + */ + async _cleanupSkillDirs(bmadDir) { + const csv = require('csv-parse/sync'); + const csvPath = path.join(bmadDir, '_config', 'skill-manifest.csv'); + if (!(await fs.pathExists(csvPath))) return; + + const csvContent = await fs.readFile(csvPath, 'utf8'); + const records = csv.parse(csvContent, { columns: true, skip_empty_lines: true }); + const bmadFolderName = path.basename(bmadDir); + const bmadPrefix = bmadFolderName + '/'; + + for (const record of records) { + if (!record.path) continue; + const relativePath = record.path.startsWith(bmadPrefix) ? record.path.slice(bmadPrefix.length) : record.path; + const sourceDir = path.dirname(path.join(bmadDir, relativePath)); + if (await fs.pathExists(sourceDir)) { + await fs.remove(sourceDir); + } + } + } + /** * Restore custom and modified files that were backed up before the update. * No-op for fresh installs (updateState is null). @@ -417,48 +468,7 @@ class Installer { } /** - * Scan the custom module cache directory and register any cached custom modules - * that aren't already known from the manifest or external module list. - * @param {Object} paths - InstallPaths instance - */ - async _scanCachedCustomModules(paths) { - const cacheDir = paths.customCacheDir; - if (!(await fs.pathExists(cacheDir))) { - return; - } - - const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true }); - - for (const cachedModule of cachedModules) { - const moduleId = cachedModule.name; - const cachedPath = path.join(cacheDir, moduleId); - - // Skip if path doesn't exist (broken symlink, deleted dir) - avoids lstat ENOENT - if (!(await fs.pathExists(cachedPath)) || !cachedModule.isDirectory()) { - continue; - } - - // Skip if we already have this module from manifest - if (this.customModules.paths.has(moduleId)) { - continue; - } - - // Check if this is an external official module - skip cache for those - const isExternal = await this.externalModuleManager.hasModule(moduleId); - if (isExternal) { - continue; - } - - // Check if this is actually a custom module (has module.yaml) - const moduleYamlPath = path.join(cachedPath, 'module.yaml'); - if (await fs.pathExists(moduleYamlPath)) { - this.customModules.paths.set(moduleId, cachedPath); - } - } - } - - /** - * Common update preparation: detect files, preserve core config, scan cache, back up. + * Common update preparation: detect files, preserve core config, back up. * @param {Object} paths - InstallPaths instance * @param {Object} config - Clean config (may have coreConfig updated) * @param {Object} existingInstall - Detection result @@ -486,8 +496,6 @@ class Installer { } } - await this._scanCachedCustomModules(paths); - const backupDirs = await this._backupUserFiles(paths, customFiles, modifiedFiles); return { @@ -537,6 +545,44 @@ class Installer { return { tempBackupDir, tempModifiedBackupDir }; } + /** + * Sync src/scripts/* → _bmad/scripts/ so shared Python scripts + * (e.g. resolve_customization.py) are available at install time. + * Wipes the destination first so files removed or renamed in source + * don't linger and get recorded as installed. Also seeds + * _bmad/custom/.gitignore on fresh installs so *.user.toml overrides + * stay out of version control. + */ + async _installSharedScripts(paths) { + const srcScriptsDir = path.join(paths.srcDir, 'src', 'scripts'); + if (!(await fs.pathExists(srcScriptsDir))) { + throw new Error(`Shared scripts source directory not found: ${srcScriptsDir}`); + } + + await fs.remove(paths.scriptsDir); + await fs.ensureDir(paths.scriptsDir); + await fs.copy(srcScriptsDir, paths.scriptsDir, { overwrite: true }); + await this._trackFilesRecursive(paths.scriptsDir); + + const customGitignore = path.join(paths.customDir, '.gitignore'); + if (!(await fs.pathExists(customGitignore))) { + await fs.writeFile(customGitignore, '*.user.toml\n', 'utf8'); + this.installedFiles.add(customGitignore); + } + } + + async _trackFilesRecursive(dir) { + const entries = await fs.readdir(dir, { withFileTypes: true }); + for (const entry of entries) { + const full = path.join(dir, entry.name); + if (entry.isDirectory()) { + await this._trackFilesRecursive(full); + } else if (entry.isFile()) { + this.installedFiles.add(full); + } + } + } + /** * Install official (non-custom) modules. * @param {Object} config - Installation configuration @@ -548,6 +594,7 @@ class Installer { */ async _installOfficialModules(config, paths, officialModuleIds, addResult, isQuickUpdate, officialModules, ctx) { const { message, installedModuleNames } = ctx; + const { CustomModuleManager } = require('../modules/custom-module-manager'); for (const moduleName of officialModuleIds) { if (installedModuleNames.has(moduleName)) continue; @@ -556,7 +603,7 @@ class Installer { message(`${isQuickUpdate ? 'Updating' : 'Installing'} ${moduleName}...`); const moduleConfig = officialModules.moduleConfigs[moduleName] || {}; - await officialModules.install( + const installResult = await officialModules.install( moduleName, paths.bmadDir, (filePath) => { @@ -567,38 +614,40 @@ class Installer { moduleConfig: moduleConfig, installer: this, silent: true, + channelOptions: config.channelOptions, }, ); - addResult(`Module: ${moduleName}`, 'ok', isQuickUpdate ? 'updated' : 'installed'); - } - } - - /** - * Install custom modules using CustomModules.install(). - * Source paths come from this.customModules.paths (populated by discoverPaths). - */ - async _installCustomModules(config, paths, addResult, officialModules, ctx) { - const { message, installedModuleNames } = ctx; - const isQuickUpdate = config.isQuickUpdate(); - - for (const [moduleName, sourcePath] of this.customModules.paths) { - if (installedModuleNames.has(moduleName)) continue; - installedModuleNames.add(moduleName); - - message(`${isQuickUpdate ? 'Updating' : 'Installing'} ${moduleName}...`); - - const collectedModuleConfig = officialModules.moduleConfigs[moduleName] || {}; - const result = await this.customModules.install(moduleName, paths.bmadDir, (filePath) => this.installedFiles.add(filePath), { - moduleConfig: collectedModuleConfig, + // Get display name from source module.yaml and resolve the freshest version metadata we can find locally. + const sourcePath = await officialModules.findModuleSource(moduleName, { + silent: true, + channelOptions: config.channelOptions, }); + const moduleInfo = sourcePath ? await officialModules.getModuleInfo(sourcePath, moduleName, '') : null; + const displayName = moduleInfo?.name || moduleName; - // Generate runtime config.yaml with merged values - await this.generateModuleConfigs(paths.bmadDir, { - [moduleName]: { ...config.coreConfig, ...result.moduleConfig, ...collectedModuleConfig }, + const externalResolution = officialModules.externalModuleManager.getResolution(moduleName); + let communityResolution = null; + if (!externalResolution) { + const { CommunityModuleManager } = require('../modules/community-manager'); + communityResolution = new CommunityModuleManager().getResolution(moduleName); + } + const resolution = externalResolution || communityResolution; + const cachedResolution = CustomModuleManager._resolutionCache.get(moduleName); + const versionInfo = await resolveModuleVersion(moduleName, { + moduleSourcePath: sourcePath, + fallbackVersion: resolution?.version || cachedResolution?.version, + marketplacePluginNames: cachedResolution?.pluginName ? [cachedResolution.pluginName] : [], + }); + // Prefer the git tag recorded by the resolution (e.g. "v1.7.0") over + // the on-disk package.json (which may be ahead of the released tag). + const version = resolution?.version || versionInfo.version || ''; + addResult(displayName, 'ok', '', { + moduleCode: moduleName, + newVersion: version, + newChannel: resolution?.channel || null, + newSha: resolution?.sha || null, }); - - addResult(`Module: ${moduleName}`, 'ok', isQuickUpdate ? 'updated' : 'installed'); } } @@ -668,8 +717,11 @@ class Installer { const customFiles = []; const modifiedFiles = []; - // Memory is always in _bmad/_memory - const bmadMemoryPath = '_memory'; + // Memory subtrees (v6.1: _bmad/_memory, current: _bmad/memory) hold + // per-user runtime data generated by agents with sidecars. These files + // aren't installer-managed and must never be reported as "custom" or + // "modified" — they're user state, not user overrides. + const bmadMemoryPaths = ['_memory', 'memory']; // Check if the manifest has hashes - if not, we can't detect modifications let manifestHasHashes = false; @@ -735,7 +787,7 @@ class Installer { continue; } - if (relativePath.startsWith(bmadMemoryPath + '/') && path.dirname(relativePath).includes('-sidecar')) { + if (bmadMemoryPaths.some((mp) => relativePath === mp || relativePath.startsWith(mp + '/'))) { continue; } @@ -786,9 +838,8 @@ class Installer { // Get all installed module directories const entries = await fs.readdir(bmadDir, { withFileTypes: true }); - const installedModules = entries - .filter((entry) => entry.isDirectory() && entry.name !== '_config' && entry.name !== 'docs') - .map((entry) => entry.name); + const nonModuleDirs = new Set(['_config', '_memory', 'memory', 'docs', 'scripts', 'custom']); + const installedModules = entries.filter((entry) => entry.isDirectory() && !nonModuleDirs.has(entry.name)).map((entry) => entry.name); // Generate config.yaml for each installed module for (const moduleName of installedModules) { @@ -870,53 +921,36 @@ class Installer { } /** - * Merge all module-help.csv files into a single bmad-help.csv - * Scans all installed modules for module-help.csv and merges them - * Enriches agent info from agent-manifest.csv - * Output is written to _bmad/_config/bmad-help.csv + * Merge all module-help.csv files into a single bmad-help.csv. + * Scans all installed modules for module-help.csv and merges them. + * Enriches agent info from the in-memory agent list produced by ManifestGenerator. + * Output is written to _bmad/_config/bmad-help.csv. * @param {string} bmadDir - BMAD installation directory + * @param {Array} agentEntries - Agents collected from module.yaml (code, name, title, icon, module, ...) */ - async mergeModuleHelpCatalogs(bmadDir) { + async mergeModuleHelpCatalogs(bmadDir, agentEntries = []) { const allRows = []; const headerRow = 'module,phase,name,code,sequence,workflow-file,command,required,agent-name,agent-command,agent-display-name,agent-title,options,description,output-location,outputs'; - // Load agent manifest for agent info lookup - const agentManifestPath = path.join(bmadDir, '_config', 'agent-manifest.csv'); - const agentInfo = new Map(); // agent-name -> {command, displayName, title+icon} - - if (await fs.pathExists(agentManifestPath)) { - const manifestContent = await fs.readFile(agentManifestPath, 'utf8'); - const lines = manifestContent.split('\n').filter((line) => line.trim()); - - for (const line of lines) { - if (line.startsWith('name,')) continue; // Skip header - - const cols = line.split(','); - if (cols.length >= 4) { - const agentName = cols[0].replaceAll('"', '').trim(); - const displayName = cols[1].replaceAll('"', '').trim(); - const title = cols[2].replaceAll('"', '').trim(); - const icon = cols[3].replaceAll('"', '').trim(); - const module = cols[10] ? cols[10].replaceAll('"', '').trim() : ''; - - // Build agent command: bmad:module:agent:name - const agentCommand = module ? `bmad:${module}:agent:${agentName}` : `bmad:agent:${agentName}`; - - agentInfo.set(agentName, { - command: agentCommand, - displayName: displayName || agentName, - title: icon && title ? `${icon} ${title}` : title || agentName, - }); - } - } + // Build agent lookup from the in-memory list (agent code → command + display fields). + const agentInfo = new Map(); + for (const agent of agentEntries) { + if (!agent || !agent.code) continue; + const agentCommand = agent.module ? `bmad:${agent.module}:agent:${agent.code}` : `bmad:agent:${agent.code}`; + const displayName = agent.name || agent.code; + const titleCombined = agent.icon && agent.title ? `${agent.icon} ${agent.title}` : agent.title || agent.code; + agentInfo.set(agent.code, { + command: agentCommand, + displayName, + title: titleCombined, + }); } // Get all installed module directories const entries = await fs.readdir(bmadDir, { withFileTypes: true }); - const installedModules = entries - .filter((entry) => entry.isDirectory() && entry.name !== '_config' && entry.name !== 'docs' && entry.name !== '_memory') - .map((entry) => entry.name); + const nonModuleDirs = new Set(['_config', '_memory', 'memory', 'docs', 'scripts', 'custom']); + const installedModules = entries.filter((entry) => entry.isDirectory() && !nonModuleDirs.has(entry.name)).map((entry) => entry.name); // Add core module to scan (it's installed at root level as _config, but we check src/core-skills) const coreModulePath = getSourcePath('core-skills'); @@ -971,6 +1005,14 @@ class Installer { outputs, ] = columns; + // Pass through _meta rows as-is (module metadata, not a skill) + if (phase === '_meta') { + const finalModule = (!module || module.trim() === '') && moduleName !== 'core' ? moduleName : module || ''; + const metaRow = [finalModule, '_meta', '', '', '', '', '', 'false', '', '', '', '', '', '', outputLocation || '', '']; + allRows.push(metaRow.map((c) => this.escapeCSVField(c)).join(',')); + continue; + } + // If module column is empty, set it to this module's name (except for core which stays empty for universal tools) const finalModule = (!module || module.trim() === '') && moduleName !== 'core' ? moduleName : module || ''; @@ -1062,23 +1104,10 @@ class Installer { const selectedIdes = new Set((context.ides || []).map((ide) => String(ide).toLowerCase())); // Build step lines with status indicators + const preVersions = context.preInstallVersions || new Map(); const lines = []; for (const r of results) { - let stepLabel = null; - - if (r.status !== 'ok') { - stepLabel = r.step; - } else if (r.step === 'Core') { - stepLabel = 'BMAD'; - } else if (r.step.startsWith('Module: ')) { - stepLabel = r.step; - } else if (selectedIdes.has(String(r.step).toLowerCase())) { - stepLabel = r.step; - } - - if (!stepLabel) { - continue; - } + const stepLabel = r.step; let icon; if (r.status === 'ok') { @@ -1088,18 +1117,50 @@ class Installer { } else { icon = color.red('\u2717'); } - const detail = r.detail ? color.dim(` (${r.detail})`) : ''; + + // Build version detail for module results + let detail = ''; + if (r.moduleCode && r.newVersion) { + const oldVersion = preVersions.get(r.moduleCode); + // Format a version label for display: + // "main" → "main @ " (next channel shows what SHA landed) + // "v1.7.0" or "1.7.0" → "v1.7.0" (prefix 'v' when missing) + // anything else (legacy strings) → as-is + const fmt = (v, sha) => { + if (typeof v !== 'string' || !v) return ''; + if (v === 'main' || v === 'HEAD') return sha ? `main @ ${sha.slice(0, 7)}` : 'main'; + if (/^v?\d+\.\d+\.\d+/.test(v)) return v.startsWith('v') ? v : `v${v}`; + return v; + }; + const newV = fmt(r.newVersion, r.newSha); + // 'main'/'HEAD' strings only identify the channel, not the commit, so + // we can't assert "no change" without comparing SHAs — and preVersions + // doesn't carry the old SHA. Render these as a refresh instead of a + // false-negative "no change". + const isMainLike = oldVersion === 'main' || oldVersion === 'HEAD'; + if (oldVersion && oldVersion === r.newVersion && !isMainLike) { + detail = ` (${newV}, no change)`; + } else if (oldVersion && isMainLike) { + detail = ` (${newV}, refreshed)`; + } else if (oldVersion) { + detail = ` (${fmt(oldVersion, r.newSha)} → ${newV})`; + } else { + detail = ` (${newV}, installed)`; + } + } else if (r.detail) { + detail = ` (${r.detail})`; + } lines.push(` ${icon} ${stepLabel}${detail}`); } if ((context.ides || []).length === 0) { - lines.push(` ${color.green('\u2713')} No IDE selected ${color.dim('(installed in _bmad only)')}`); + lines.push(` ${color.green('\u2713')} No IDE selected (installed in _bmad only)`); } // Context and warnings lines.push(''); if (context.bmadDir) { - lines.push(` Installed to: ${color.dim(context.bmadDir)}`); + lines.push(` Installed to: ${context.bmadDir}`); } if (context.customFiles && context.customFiles.length > 0) { lines.push(` ${color.cyan(`Custom files preserved: ${context.customFiles.length}`)}`); @@ -1111,17 +1172,18 @@ class Installer { // Next steps lines.push( '', - ' Next steps:', - ` Read our new Docs Site: ${color.dim('https://docs.bmad-method.org/')}`, - ` Join our Discord: ${color.dim('https://discord.gg/gk8jAdXWmj')}`, - ` Star us on GitHub: ${color.dim('https://github.com/bmad-code-org/BMAD-METHOD/')}`, - ` Subscribe on YouTube: ${color.dim('https://www.youtube.com/@BMadCode')}`, + ' Get started:', + ` 1. Launch your AI agent from your project folder`, + ` 2. Not sure what to do? Invoke the ${color.cyan('bmad-help')} skill and ask it what to do!`, + '', + ` Blog, Docs and Guides: ${color.blue('https://bmadcode.com/')}`, + ` Community: ${color.blue('https://discord.gg/gk8jAdXWmj')}`, ); - if (context.ides && context.ides.length > 0) { - lines.push(` Invoke the ${color.cyan('bmad-help')} skill in your IDE Agent to get started`); - } - await prompts.note(lines.join('\n'), 'BMAD is ready to use!'); + await prompts.box(lines.join('\n'), 'BMAD is ready to use!', { + rounded: true, + formatBorder: color.green, + }); } /** @@ -1144,16 +1206,9 @@ class Installer { const configuredIdes = existingInstall.ides; const projectRoot = path.dirname(bmadDir); - const customModuleSources = await this.customModules.assembleQuickUpdateSources( - config, - existingInstall, - bmadDir, - this.externalModuleManager, - ); - // Get available modules (what we have source for) const availableModulesData = await new OfficialModules().listAvailable(); - const availableModules = [...availableModulesData.modules, ...availableModulesData.customModules]; + const availableModules = [...availableModulesData.modules]; // Add external official modules to available modules const externalModules = await this.externalModuleManager.listAvailable(); @@ -1168,59 +1223,101 @@ class Installer { } } - // Add custom modules from manifest if their sources exist - for (const [moduleId, customModule] of customModuleSources) { - const sourcePath = customModule.sourcePath; - if (sourcePath && (await fs.pathExists(sourcePath)) && !availableModules.some((m) => m.id === moduleId)) { + // Add installed community modules to available modules + const { CommunityModuleManager } = require('../modules/community-manager'); + const communityMgr = new CommunityModuleManager(); + const communityModules = await communityMgr.listAll(); + for (const communityModule of communityModules) { + if (installedModules.includes(communityModule.code) && !availableModules.some((m) => m.id === communityModule.code)) { availableModules.push({ - id: moduleId, - name: customModule.name || moduleId, - path: sourcePath, - isCustom: true, - fromManifest: true, + id: communityModule.code, + name: communityModule.displayName, + isExternal: true, + fromCommunity: true, }); } } - // Handle missing custom module sources - const customModuleResult = await this.handleMissingCustomSources( - customModuleSources, - bmadDir, - projectRoot, - 'update', - installedModules, - config.skipPrompts || false, - ); + // Add installed custom modules to available modules + const { CustomModuleManager } = require('../modules/custom-module-manager'); + const customMgr = new CustomModuleManager(); + for (const moduleId of installedModules) { + if (!availableModules.some((m) => m.id === moduleId)) { + const customSource = await customMgr.findModuleSourceByCode(moduleId, { bmadDir }); + if (customSource) { + availableModules.push({ + id: moduleId, + name: moduleId, + isExternal: true, + fromCustom: true, + }); + } + } + } - const { validCustomModules, keptModulesWithoutSources } = customModuleResult; - - const customModulesFromManifest = validCustomModules.map((m) => ({ - ...m, - isCustom: true, - hasUpdate: true, - })); - - const allAvailableModules = [...availableModules, ...customModulesFromManifest]; - const availableModuleIds = new Set(allAvailableModules.map((m) => m.id)); + const availableModuleIds = new Set(availableModules.map((m) => m.id)); // Only update modules that are BOTH installed AND available (we have source for) const modulesToUpdate = installedModules.filter((id) => availableModuleIds.has(id)); const skippedModules = installedModules.filter((id) => !availableModuleIds.has(id)); - // Add custom modules that were kept without sources to the skipped modules - for (const keptModule of keptModulesWithoutSources) { - if (!skippedModules.includes(keptModule)) { - skippedModules.push(keptModule); - } - } - if (skippedModules.length > 0) { await prompts.log.warn(`Skipping ${skippedModules.length} module(s) - no source available: ${skippedModules.join(', ')}`); } + // Build channel options from the existing manifest FIRST so the config + // collector below (which triggers external-module clones via + // findModuleSource) knows each module's recorded channel and doesn't + // silently redecide it. Without this, modules previously on 'next' or + // 'pinned' would trigger a stable-channel tag lookup at config-collection + // time, burning GitHub API quota and potentially failing. + const manifestData = await this.manifest.read(bmadDir); + const channelOptions = { global: null, nextSet: new Set(), pins: new Map(), warnings: [] }; + if (manifestData?.modulesDetailed) { + const { fetchStableTags, classifyUpgrade, parseGitHubRepo } = require('../modules/channel-resolver'); + for (const entry of manifestData.modulesDetailed) { + if (!entry?.name || !entry?.channel) continue; + if (entry.channel === 'pinned' && entry.version) { + channelOptions.pins.set(entry.name, entry.version); + continue; + } + if (entry.channel === 'next') { + channelOptions.nextSet.add(entry.name); + continue; + } + // Stable: classify the available upgrade. Patches and minors fall + // through (stable default picks up the top tag). A major upgrade + // requires opt-in, so under quick-update's non-interactive semantics + // we pin to the current version to prevent a silent breaking jump. + if (entry.channel === 'stable' && entry.version && entry.repoUrl) { + const parsed = parseGitHubRepo(entry.repoUrl); + if (!parsed) continue; + try { + const tags = await fetchStableTags(parsed.owner, parsed.repo); + if (tags.length === 0) continue; + const topTag = tags[0].tag; + const cls = classifyUpgrade(entry.version, topTag); + if (cls === 'major') { + channelOptions.pins.set(entry.name, entry.version); + await prompts.log.warn( + `${entry.name} ${entry.version} → ${topTag} is a new major release; staying on ${entry.version}. ` + + `Run \`bmad install\` (Modify) with \`--pin ${entry.name}=${topTag}\` to accept.`, + ); + } + } catch (error) { + // Tag lookup failed (offline, rate-limited). Stay on the current + // version rather than guessing — the existing cache is already + // at that ref, so re-using it keeps the install stable. + channelOptions.pins.set(entry.name, entry.version); + await prompts.log.warn(`Could not check ${entry.name} for updates (${error.message}); staying on ${entry.version}.`); + } + } + } + } + // Load existing configs and collect new fields (if any) await prompts.log.info('Checking for new configuration options...'); - const quickModules = new OfficialModules(); + const quickModules = new OfficialModules({ channelOptions }); await quickModules.loadExistingConfig(projectDir); let promptedForNewFields = false; @@ -1231,6 +1328,7 @@ class Installer { } for (const moduleName of modulesToUpdate) { + if (moduleName === 'core') continue; // Already collected above const modulePrompted = await quickModules.collectModuleConfigQuick(moduleName, projectDir, true); if (modulePrompted) { promptedForNewFields = true; @@ -1257,9 +1355,8 @@ class Installer { actionType: 'install', _quickUpdate: true, _preserveModules: skippedModules, - _customModuleSources: customModuleSources, _existingModules: installedModules, - customContent: config.customContent, + channelOptions, }; await this.install(installConfig); @@ -1394,239 +1491,6 @@ class Installer { return this._readOutputFolder(bmadDir); } - /** - * Handle missing custom module sources interactively - * @param {Map} customModuleSources - Map of custom module ID to info - * @param {string} bmadDir - BMAD directory - * @param {string} projectRoot - Project root directory - * @param {string} operation - Current operation ('update', 'compile', etc.) - * @param {Array} installedModules - Array of installed module IDs (will be modified) - * @param {boolean} [skipPrompts=false] - Skip interactive prompts and keep all modules with missing sources - * @returns {Object} Object with validCustomModules array and keptModulesWithoutSources array - */ - async handleMissingCustomSources(customModuleSources, bmadDir, projectRoot, operation, installedModules, skipPrompts = false) { - const validCustomModules = []; - const keptModulesWithoutSources = []; // Track modules kept without sources - const customModulesWithMissingSources = []; - - // Check which sources exist - for (const [moduleId, customInfo] of customModuleSources) { - if (await fs.pathExists(customInfo.sourcePath)) { - validCustomModules.push({ - id: moduleId, - name: customInfo.name, - path: customInfo.sourcePath, - info: customInfo, - }); - } else { - // For cached modules that are missing, we just skip them without prompting - if (customInfo.cached) { - // Skip cached modules without prompting - keptModulesWithoutSources.push({ - id: moduleId, - name: customInfo.name, - cached: true, - }); - } else { - customModulesWithMissingSources.push({ - id: moduleId, - name: customInfo.name, - sourcePath: customInfo.sourcePath, - relativePath: customInfo.relativePath, - info: customInfo, - }); - } - } - } - - // If no missing sources, return immediately - if (customModulesWithMissingSources.length === 0) { - return { - validCustomModules, - keptModulesWithoutSources: [], - }; - } - - // Non-interactive mode: keep all modules with missing sources - if (skipPrompts) { - for (const missing of customModulesWithMissingSources) { - keptModulesWithoutSources.push(missing.id); - } - return { validCustomModules, keptModulesWithoutSources }; - } - - await prompts.log.warn(`Found ${customModulesWithMissingSources.length} custom module(s) with missing sources:`); - - let keptCount = 0; - let updatedCount = 0; - let removedCount = 0; - - for (const missing of customModulesWithMissingSources) { - await prompts.log.message( - `${missing.name} (${missing.id})\n Original source: ${missing.relativePath}\n Full path: ${missing.sourcePath}`, - ); - - const choices = [ - { - name: 'Keep installed (will not be processed)', - value: 'keep', - hint: 'Keep', - }, - { - name: 'Specify new source location', - value: 'update', - hint: 'Update', - }, - ]; - - // Only add remove option if not just compiling agents - if (operation !== 'compile-agents') { - choices.push({ - name: '⚠️ REMOVE module completely (destructive!)', - value: 'remove', - hint: 'Remove', - }); - } - - const action = await prompts.select({ - message: `How would you like to handle "${missing.name}"?`, - choices, - }); - - switch (action) { - case 'update': { - // Use sync validation because @clack/prompts doesn't support async validate - const newSourcePath = await prompts.text({ - message: 'Enter the new path to the custom module:', - default: missing.sourcePath, - validate: (input) => { - if (!input || input.trim() === '') { - return 'Please enter a path'; - } - const expandedPath = path.resolve(input.trim()); - if (!fs.pathExistsSync(expandedPath)) { - return 'Path does not exist'; - } - // Check if it looks like a valid module - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - const agentsPath = path.join(expandedPath, 'agents'); - const workflowsPath = path.join(expandedPath, 'workflows'); - - if (!fs.pathExistsSync(moduleYamlPath) && !fs.pathExistsSync(agentsPath) && !fs.pathExistsSync(workflowsPath)) { - return 'Path does not appear to contain a valid custom module'; - } - return; // clack expects undefined for valid input - }, - }); - - // Defensive: handleCancel should have exited, but guard against symbol propagation - if (typeof newSourcePath !== 'string') { - keptCount++; - keptModulesWithoutSources.push(missing.id); - continue; - } - - // Update the source in manifest - const resolvedPath = path.resolve(newSourcePath.trim()); - missing.info.sourcePath = resolvedPath; - // Remove relativePath - we only store absolute sourcePath now - delete missing.info.relativePath; - await this.manifest.addCustomModule(bmadDir, missing.info); - - validCustomModules.push({ - id: missing.id, - name: missing.name, - path: resolvedPath, - info: missing.info, - }); - - updatedCount++; - await prompts.log.success('Updated source location'); - - break; - } - case 'remove': { - // Extra confirmation for destructive remove - await prompts.log.error( - `WARNING: This will PERMANENTLY DELETE "${missing.name}" and all its files!\n Module location: ${path.join(bmadDir, missing.id)}`, - ); - - const confirmDelete = await prompts.confirm({ - message: 'Are you absolutely sure you want to delete this module?', - default: false, - }); - - if (confirmDelete) { - const typedConfirm = await prompts.text({ - message: 'Type "DELETE" to confirm permanent deletion:', - validate: (input) => { - if (input !== 'DELETE') { - return 'You must type "DELETE" exactly to proceed'; - } - return; // clack expects undefined for valid input - }, - }); - - if (typedConfirm === 'DELETE') { - // Remove the module from filesystem and manifest - const modulePath = path.join(bmadDir, missing.id); - if (await fs.pathExists(modulePath)) { - const fsExtra = require('fs-extra'); - await fsExtra.remove(modulePath); - await prompts.log.warn(`Deleted module directory: ${path.relative(projectRoot, modulePath)}`); - } - - await this.manifest.removeModule(bmadDir, missing.id); - await this.manifest.removeCustomModule(bmadDir, missing.id); - await prompts.log.warn('Removed from manifest'); - - // Also remove from installedModules list - if (installedModules && installedModules.includes(missing.id)) { - const index = installedModules.indexOf(missing.id); - if (index !== -1) { - installedModules.splice(index, 1); - } - } - - removedCount++; - await prompts.log.error(`"${missing.name}" has been permanently removed`); - } else { - await prompts.log.message('Removal cancelled - module will be kept'); - keptCount++; - } - } else { - await prompts.log.message('Removal cancelled - module will be kept'); - keptCount++; - } - - break; - } - case 'keep': { - keptCount++; - keptModulesWithoutSources.push(missing.id); - await prompts.log.message('Module will be kept as-is'); - - break; - } - // No default - } - } - - // Show summary - if (keptCount > 0 || updatedCount > 0 || removedCount > 0) { - let summary = 'Summary for custom modules with missing sources:'; - if (keptCount > 0) summary += `\n • ${keptCount} module(s) kept as-is`; - if (updatedCount > 0) summary += `\n • ${updatedCount} module(s) updated with new sources`; - if (removedCount > 0) summary += `\n • ${removedCount} module(s) permanently deleted`; - await prompts.log.message(summary); - } - - return { - validCustomModules, - keptModulesWithoutSources, - }; - } - /** * Find the bmad installation directory in a project * Always uses the standard _bmad folder name diff --git a/tools/installer/core/legacy-warnings.js b/tools/installer/core/legacy-warnings.js new file mode 100644 index 000000000..e3098b82b --- /dev/null +++ b/tools/installer/core/legacy-warnings.js @@ -0,0 +1,151 @@ +const os = require('node:os'); +const path = require('node:path'); +const semver = require('semver'); +const fs = require('../fs-native'); +const prompts = require('../prompts'); +const { BMAD_FOLDER_NAME } = require('../ide/shared/path-utils'); +const { getInstalledCanonicalIds, isBmadOwnedEntry } = require('../ide/shared/installed-skills'); + +const MIN_NATIVE_SKILLS_VERSION = '6.1.0'; + +// Pre-v6.1.0 paths: BMAD used to install commands/workflows/etc in tool-specific dirs. +// In v6.1.0 BMAD switched to native SKILL.md format. +const LEGACY_COMMAND_PATHS = [ + '.agent/workflows', + '.augment/commands', + '.claude/commands', + '.clinerules/workflows', + '.codex/prompts', + '~/.codex/prompts', + '.codebuddy/commands', + '.crush/commands', + '.cursor/commands', + '.gemini/commands', + '.github/agents', + '.github/prompts', + '.iflow/commands', + '.kilocode/workflows', + '.kiro/steering', + '.opencode/agents', + '.opencode/commands', + '.opencode/agent', + '.opencode/command', + '.qwen/commands', + '.roo/commands', + '.rovodev/workflows', + '.trae/rules', + '.windsurf/workflows', +]; + +// Skill paths that moved to the cross-tool .agents/skills/ standard. +// Users upgrading from a prior install may have stale BMAD skills here that +// the AI tool will load alongside the new ones, causing duplicates. +const LEGACY_SKILL_PATHS = [ + '.augment/skills', + '~/.augment/skills', + '.codex/skills', + '.crush/skills', + '.cursor/skills', + '~/.cursor/skills', + '.gemini/skills', + '~/.gemini/skills', + '.github/skills', + '~/.github/skills', + '.kilocode/skills', + '.kimi/skills', + '~/.kimi/skills', + '.opencode/skills', + '~/.opencode/skills', + '.pi/skills', + '~/.pi/skills', + '.roo/skills', + '~/.roo/skills', + '.rovodev/skills', + '~/.rovodev/skills', + '.windsurf/skills', + '~/.windsurf/skills', + '~/.codeium/windsurf/skills', +]; + +const LEGACY_PATHS = [...LEGACY_COMMAND_PATHS, ...LEGACY_SKILL_PATHS]; + +function expandPath(p) { + if (p === '~') return os.homedir(); + if (p.startsWith('~/')) return path.join(os.homedir(), p.slice(2)); + return p; +} + +function resolveLegacyPath(projectRoot, p) { + if (path.isAbsolute(p) || p.startsWith('~')) return expandPath(p); + return path.join(projectRoot, p); +} + +async function findStaleLegacyDirs(projectRoot) { + const bmadDir = path.join(projectRoot, BMAD_FOLDER_NAME); + const canonicalIds = await getInstalledCanonicalIds(bmadDir); + + const findings = []; + for (const legacyPath of LEGACY_PATHS) { + const resolved = resolveLegacyPath(projectRoot, legacyPath); + if (!(await fs.pathExists(resolved))) continue; + try { + const entries = await fs.readdir(resolved); + const bmadEntries = entries.filter((e) => isBmadOwnedEntry(e, canonicalIds)); + if (bmadEntries.length > 0) { + findings.push({ path: resolved, displayPath: legacyPath, count: bmadEntries.length, entries: bmadEntries }); + } + } catch { + // Unreadable dir — skip + } + } + return findings; +} + +function isPreNativeSkillsVersion(version) { + if (!version) return false; + const coerced = semver.valid(version) || semver.valid(semver.coerce(version)); + if (!coerced) return false; + return semver.lt(coerced, MIN_NATIVE_SKILLS_VERSION); +} + +async function warnPreNativeSkillsLegacy({ projectRoot, existingVersion } = {}) { + const versionTriggered = isPreNativeSkillsVersion(existingVersion); + const staleDirs = await findStaleLegacyDirs(projectRoot); + + if (!versionTriggered && staleDirs.length === 0) return; + + if (versionTriggered) { + await prompts.log.warn( + `Detected previous BMAD install v${existingVersion} (pre-${MIN_NATIVE_SKILLS_VERSION}). ` + + `BMAD switched to native skills format in v${MIN_NATIVE_SKILLS_VERSION}; old command/workflow directories from your prior install may still be present.`, + ); + } + + if (staleDirs.length > 0) { + await prompts.log.warn( + `Found stale BMAD entries in ${staleDirs.length} legacy location(s) that the new installer no longer manages. ` + + `Your AI tool may load these alongside the new skills, causing duplicates. Remove them manually:`, + ); + for (const finding of staleDirs) { + // Print each entry by exact name. A `bmad*` glob would (a) miss + // custom-module skills the canonicalId scan now picks up, and + // (b) match bmad-os-* utility skills the user should keep. + const entries = finding.entries || []; + for (const entry of entries) { + await prompts.log.message(` rm -rf "${path.join(finding.path, entry)}"`); + } + } + } else if (versionTriggered) { + await prompts.log.message( + ' No stale legacy directories detected, but if your AI tool shows duplicate BMAD commands after install, check for old `bmad-*` entries in tool-specific dirs (e.g. .claude/commands, .cursor/commands).', + ); + } +} + +module.exports = { + warnPreNativeSkillsLegacy, + findStaleLegacyDirs, + isPreNativeSkillsVersion, + LEGACY_PATHS, + MIN_NATIVE_SKILLS_VERSION, +}; diff --git a/tools/installer/core/manifest-generator.js b/tools/installer/core/manifest-generator.js index bef6f2d23..f7b5d0084 100644 --- a/tools/installer/core/manifest-generator.js +++ b/tools/installer/core/manifest-generator.js @@ -1,16 +1,9 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const yaml = require('yaml'); const crypto = require('node:crypto'); -const csv = require('csv-parse/sync'); -const { getSourcePath, getModulePath } = require('../project-root'); +const { resolveInstalledModuleYaml } = require('../project-root'); const prompts = require('../prompts'); -const { - loadSkillManifest: loadSkillManifestShared, - getCanonicalId: getCanonicalIdShared, - getArtifactType: getArtifactTypeShared, - getInstallToBmad: getInstallToBmadShared, -} = require('../ide/shared/skill-manifest'); // Load package.json for version info const packageJson = require('../../../package.json'); @@ -27,26 +20,6 @@ class ManifestGenerator { this.selectedIdes = []; } - /** Delegate to shared skill-manifest module */ - async loadSkillManifest(dirPath) { - return loadSkillManifestShared(dirPath); - } - - /** Delegate to shared skill-manifest module */ - getCanonicalId(manifest, filename) { - return getCanonicalIdShared(manifest, filename); - } - - /** Delegate to shared skill-manifest module */ - getArtifactType(manifest, filename) { - return getArtifactTypeShared(manifest, filename); - } - - /** Delegate to shared skill-manifest module */ - getInstallToBmad(manifest, filename) { - return getInstallToBmadShared(manifest, filename); - } - /** * Clean text for CSV output by normalizing whitespace. * Note: Quote escaping is handled by escapeCsv() at write time. @@ -104,17 +77,21 @@ class ManifestGenerator { // Collect skills first (populates skillClaimedDirs before legacy collectors run) await this.collectSkills(); - // Collect agent data - use updatedModules which includes all installed modules - await this.collectAgents(this.updatedModules); + // Collect agent essence from each module's source module.yaml `agents:` array + await this.collectAgentsFromModuleYaml(); // Write manifest files and collect their paths + const [teamConfigPath, userConfigPath] = await this.writeCentralConfig(bmadDir, options.moduleConfigs || {}); const manifestFiles = [ await this.writeMainManifest(cfgDir), await this.writeSkillManifest(cfgDir), - await this.writeAgentManifest(cfgDir), + teamConfigPath, + userConfigPath, await this.writeFilesManifest(cfgDir), ]; + await this.ensureCustomConfigStubs(bmadDir); + return { skills: this.skills.length, agents: this.agents.length, @@ -127,7 +104,7 @@ class ManifestGenerator { * Recursively walk a module directory tree, collecting native SKILL.md entrypoints. * A directory is discovered as a skill when it contains a SKILL.md file with * valid name/description frontmatter (name must match directory name). - * Manifest YAML is loaded only when present — for install_to_bmad and agent metadata. + * Manifest YAML is loaded only when present — for agent metadata. * Populates this.skills[] and this.skillClaimedDirs (Set of absolute paths). */ async collectSkills() { @@ -156,24 +133,13 @@ class ManifestGenerator { const skillMeta = await this.parseSkillMd(skillMdPath, dir, dirName, debug); if (skillMeta) { - // Load manifest when present (for install_to_bmad and agent metadata) - const manifest = await this.loadSkillManifest(dir); - const artifactType = this.getArtifactType(manifest, skillFile); - // Build path relative from module root (points to SKILL.md — the permanent entrypoint) const relativePath = path.relative(modulePath, dir).split(path.sep).join('/'); const installPath = relativePath ? `${this.bmadFolderName}/${moduleName}/${relativePath}/${skillFile}` : `${this.bmadFolderName}/${moduleName}/${skillFile}`; - // Native SKILL.md entrypoints derive canonicalId from directory name. - // Agent entrypoints may keep canonicalId metadata for compatibility, so - // only warn for non-agent SKILL.md directories. - if (manifest && manifest.__single && manifest.__single.canonicalId && artifactType !== 'agent') { - console.warn( - `Warning: Native entrypoint manifest at ${dir}/bmad-skill-manifest.yaml contains canonicalId — this field is ignored for SKILL.md directories (directory name is the canonical ID)`, - ); - } + // Native SKILL.md entrypoints always derive canonicalId from directory name. const canonicalId = dirName; this.skills.push({ @@ -182,7 +148,6 @@ class ManifestGenerator { module: moduleName, path: installPath, canonicalId, - install_to_bmad: this.getInstallToBmad(manifest, skillFile), }); // Add to files list @@ -200,11 +165,13 @@ class ManifestGenerator { } } - // Recurse into subdirectories - for (const entry of entries) { - if (!entry.isDirectory()) continue; - if (entry.name.startsWith('.') || entry.name.startsWith('_')) continue; - await walk(path.join(dir, entry.name)); + // Recurse into subdirectories — but not inside a discovered skill + if (!skillMeta) { + for (const entry of entries) { + if (!entry.isDirectory()) continue; + if (entry.name.startsWith('.') || entry.name.startsWith('_')) continue; + await walk(path.join(dir, entry.name)); + } } }; @@ -268,106 +235,60 @@ class ManifestGenerator { } /** - * Collect all agents from selected modules by walking their directory trees. + * Collect agents from each installed module's source module.yaml `agents:` array. + * Essence fields (code, name, title, icon, description) are authored in module.yaml; + * `team` defaults to module code when not set; `module` is always the owning module. */ - async collectAgents(selectedModules) { + async collectAgentsFromModuleYaml() { this.agents = []; const debug = process.env.BMAD_DEBUG_MANIFEST === 'true'; - // Walk each module's full directory tree looking for type:agent manifests for (const moduleName of this.updatedModules) { - const modulePath = path.join(this.bmadDir, moduleName); - if (!(await fs.pathExists(modulePath))) continue; - - const moduleAgents = await this.getAgentsFromDirRecursive(modulePath, moduleName, '', debug); - this.agents.push(...moduleAgents); - } - - // Get standalone agents from bmad/agents/ directory - const standaloneAgentsDir = path.join(this.bmadDir, 'agents'); - if (await fs.pathExists(standaloneAgentsDir)) { - const standaloneAgents = await this.getAgentsFromDirRecursive(standaloneAgentsDir, 'standalone', '', debug); - this.agents.push(...standaloneAgents); - } - - if (debug) { - console.log(`[DEBUG] collectAgents: total agents found: ${this.agents.length}`); - } - } - - /** - * Recursively walk a directory tree collecting agents. - * Discovers agents via directory with bmad-skill-manifest.yaml containing type: agent - * - * @param {string} dirPath - Current directory being scanned - * @param {string} moduleName - Module this directory belongs to - * @param {string} relativePath - Path relative to the module root (for install path construction) - * @param {boolean} debug - Emit debug messages - */ - async getAgentsFromDirRecursive(dirPath, moduleName, relativePath = '', debug = false) { - const agents = []; - let entries; - try { - entries = await fs.readdir(dirPath, { withFileTypes: true }); - } catch { - return agents; - } - - for (const entry of entries) { - if (!entry.isDirectory()) continue; - if (entry.name.startsWith('.') || entry.name.startsWith('_')) continue; - - const fullPath = path.join(dirPath, entry.name); - - // Check for type:agent manifest BEFORE checking skillClaimedDirs — - // agent dirs may be claimed by collectSkills for IDE installation, - // but we still need them in agent-manifest.csv. - const dirManifest = await this.loadSkillManifest(fullPath); - if (dirManifest && dirManifest.__single && dirManifest.__single.type === 'agent') { - const m = dirManifest.__single; - const dirRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name; - const agentModule = m.module || moduleName; - const installPath = `${this.bmadFolderName}/${agentModule}/${dirRelativePath}`; - - agents.push({ - name: m.name || entry.name, - displayName: m.displayName || m.name || entry.name, - title: m.title || '', - icon: m.icon || '', - capabilities: m.capabilities ? this.cleanForCSV(m.capabilities) : '', - role: m.role ? this.cleanForCSV(m.role) : '', - identity: m.identity ? this.cleanForCSV(m.identity) : '', - communicationStyle: m.communicationStyle ? this.cleanForCSV(m.communicationStyle) : '', - principles: m.principles ? this.cleanForCSV(m.principles) : '', - module: agentModule, - path: installPath, - canonicalId: m.canonicalId || '', - }); - - this.files.push({ - type: 'agent', - name: m.name || entry.name, - module: agentModule, - path: installPath, - }); - - if (debug) { - console.log(`[DEBUG] collectAgents: found type:agent "${m.name || entry.name}" at ${fullPath}`); - } + const moduleYamlPath = await resolveInstalledModuleYaml(moduleName); + if (!moduleYamlPath) { + // External modules live in ~/.bmad/cache/external-modules, not src/modules. + // Warn rather than silently skip so missing agent rosters don't vanish + // from config.toml without notice. + console.warn( + `[warn] collectAgentsFromModuleYaml: could not locate module.yaml for '${moduleName}'. ` + + `Agents declared by this module will not be written to config.toml.`, + ); continue; } - // Skip directories claimed by collectSkills (non-agent type skills) — - // avoids recursing into skill trees that can't contain agents. - if (this.skillClaimedDirs && this.skillClaimedDirs.has(fullPath)) continue; + let moduleDef; + try { + moduleDef = yaml.parse(await fs.readFile(moduleYamlPath, 'utf8')); + } catch (error) { + if (debug) console.log(`[DEBUG] collectAgentsFromModuleYaml: failed to parse ${moduleYamlPath}: ${error.message}`); + continue; + } - // Recurse into subdirectories - const newRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name; - const subDirAgents = await this.getAgentsFromDirRecursive(fullPath, moduleName, newRelativePath, debug); - agents.push(...subDirAgents); + if (!moduleDef || !Array.isArray(moduleDef.agents)) continue; + + for (const entry of moduleDef.agents) { + if (!entry || typeof entry.code !== 'string') continue; + this.agents.push({ + code: entry.code, + name: entry.name || '', + title: entry.title || '', + icon: entry.icon || '', + description: entry.description || '', + module: moduleName, + team: entry.team || moduleName, + }); + } + + if (debug) { + console.log( + `[DEBUG] collectAgentsFromModuleYaml: ${moduleName} contributed ${moduleDef.agents.length} agents from ${moduleYamlPath}`, + ); + } } - return agents; + if (debug) { + console.log(`[DEBUG] collectAgentsFromModuleYaml: total agents found: ${this.agents.length}`); + } } /** @@ -382,8 +303,6 @@ class ManifestGenerator { // Read existing manifest to preserve install date let existingInstallDate = null; const existingModulesMap = new Map(); - let existingCustomModules = []; - if (await fs.pathExists(manifestPath)) { try { const existingContent = await fs.readFile(manifestPath, 'utf8'); @@ -404,12 +323,6 @@ class ManifestGenerator { } } } - - if (existingManifest.customModules && Array.isArray(existingManifest.customModules)) { - // We filter here so manifest regeneration preserves source metadata only for custom modules that - // are still installed. Without that, customModules can retain stale entries for modules that were removed. - existingCustomModules = existingManifest.customModules.filter((customModule) => installedModuleSet.has(customModule?.id)); - } } catch { // If we can't read existing manifest, continue with defaults } @@ -427,7 +340,7 @@ class ManifestGenerator { // Get existing install date if available const existing = existingModulesMap.get(moduleName); - updatedModules.push({ + const moduleEntry = { name: moduleName, version: versionInfo.version, installDate: existing?.installDate || new Date().toISOString(), @@ -435,7 +348,24 @@ class ManifestGenerator { source: versionInfo.source, npmPackage: versionInfo.npmPackage, repoUrl: versionInfo.repoUrl, - }); + }; + // Preserve channel/sha from the resolution (external/community/custom) + // or from the existing entry if this is a no-change rewrite. + const channel = versionInfo.channel ?? existing?.channel; + const sha = versionInfo.sha ?? existing?.sha; + if (channel) moduleEntry.channel = channel; + if (sha) moduleEntry.sha = sha; + if (versionInfo.localPath || existing?.localPath) { + moduleEntry.localPath = versionInfo.localPath || existing.localPath; + } + if (versionInfo.rawSource || existing?.rawSource) { + moduleEntry.rawSource = versionInfo.rawSource || existing.rawSource; + } + const regTag = versionInfo.registryApprovedTag ?? existing?.registryApprovedTag; + const regSha = versionInfo.registryApprovedSha ?? existing?.registryApprovedSha; + if (regTag) moduleEntry.registryApprovedTag = regTag; + if (regSha) moduleEntry.registryApprovedSha = regSha; + updatedModules.push(moduleEntry); } const manifest = { @@ -445,7 +375,6 @@ class ManifestGenerator { lastUpdated: new Date().toISOString(), }, modules: updatedModules, - customModules: existingCustomModules, ides: this.selectedIdes, }; @@ -472,7 +401,7 @@ class ManifestGenerator { const csvPath = path.join(cfgDir, 'skill-manifest.csv'); const escapeCsv = (value) => `"${String(value ?? '').replaceAll('"', '""')}"`; - let csvContent = 'canonicalId,name,description,module,path,install_to_bmad\n'; + let csvContent = 'canonicalId,name,description,module,path\n'; for (const skill of this.skills) { const row = [ @@ -481,7 +410,6 @@ class ManifestGenerator { escapeCsv(skill.description), escapeCsv(skill.module), escapeCsv(skill.path), - escapeCsv(skill.install_to_bmad), ].join(','); csvContent += row + '\n'; } @@ -491,77 +419,243 @@ class ManifestGenerator { } /** - * Write agent manifest CSV - * @returns {string} Path to the manifest file + * Write central _bmad/config.toml with [core], [modules.], [agents.] tables. + * Install-owned. Team-scope answers → config.toml; user-scope answers → config.user.toml. + * Both files are regenerated on every install. User overrides live in + * _bmad/custom/config.toml and _bmad/custom/config.user.toml (never touched by installer). + * @returns {string[]} Paths to the written config files */ - async writeAgentManifest(cfgDir) { - const csvPath = path.join(cfgDir, 'agent-manifest.csv'); - const escapeCsv = (value) => `"${String(value ?? '').replaceAll('"', '""')}"`; + async writeCentralConfig(bmadDir, moduleConfigs) { + const teamPath = path.join(bmadDir, 'config.toml'); + const userPath = path.join(bmadDir, 'config.user.toml'); - // Read existing manifest to preserve entries - const existingEntries = new Map(); - if (await fs.pathExists(csvPath)) { - const content = await fs.readFile(csvPath, 'utf8'); - const records = csv.parse(content, { - columns: true, - skip_empty_lines: true, - }); - for (const record of records) { - existingEntries.set(`${record.module}:${record.name}`, record); + // Load each module's source module.yaml to determine scope per prompt key. + // Default scope is 'team' when the prompt doesn't declare one. + // When a module.yaml is unreadable we warn — for known official modules + // this means user-scoped keys (e.g. user_name) could mis-file into the + // team config, so the operator should notice. + const scopeByModuleKey = {}; + // Maps installer moduleName (may be full display name) → module code field + // from module.yaml, so TOML sections use [modules.] not [modules.]. + const codeByModuleName = {}; + for (const moduleName of this.updatedModules) { + const moduleYamlPath = await resolveInstalledModuleYaml(moduleName); + if (!moduleYamlPath) { + console.warn( + `[warn] writeCentralConfig: could not locate module.yaml for '${moduleName}'. ` + + `Answers from this module will default to team scope — user-scoped keys may mis-file into config.toml.`, + ); + continue; + } + try { + const parsed = yaml.parse(await fs.readFile(moduleYamlPath, 'utf8')); + if (!parsed || typeof parsed !== 'object') continue; + if (parsed.code) codeByModuleName[moduleName] = parsed.code; + scopeByModuleKey[moduleName] = {}; + for (const [key, value] of Object.entries(parsed)) { + if (value && typeof value === 'object' && 'prompt' in value) { + scopeByModuleKey[moduleName][key] = value.scope === 'user' ? 'user' : 'team'; + } + } + } catch (error) { + console.warn( + `[warn] writeCentralConfig: could not parse module.yaml for '${moduleName}' (${error.message}). ` + + `Answers from this module will default to team scope — user-scoped keys may mis-file into config.toml.`, + ); } } - // Create CSV header with persona fields and canonicalId - let csvContent = 'name,displayName,title,icon,capabilities,role,identity,communicationStyle,principles,module,path,canonicalId\n'; + // Core keys are always known (core module.yaml is built-in). These are + // the only keys allowed in [core]; they must be stripped from every + // non-core module bucket because legacy _bmad/{mod}/config.yaml files + // spread core values into each module. Core belongs in [core] only — + // workflows that need user_name/language/etc. read [core] directly. + const coreKeys = new Set(Object.keys(scopeByModuleKey.core || {})); - // Combine existing and new agents, preferring new data for duplicates - const allAgents = new Map(); + // Partition a module's answered config into team vs user buckets. + // For non-core modules: strip core keys always; when we know the module's + // own schema, also drop keys it doesn't declare. Unknown-schema modules + // (external / marketplace) fall through with their remaining answers as + // team so they don't vanish from the config. + const partition = (moduleName, cfg, onlyDeclaredKeys = false) => { + const team = {}; + const user = {}; + const scopes = scopeByModuleKey[moduleName] || {}; + const isCore = moduleName === 'core'; + for (const [key, value] of Object.entries(cfg || {})) { + if (!isCore && coreKeys.has(key)) continue; + if (onlyDeclaredKeys && !(key in scopes)) continue; + if (scopes[key] === 'user') { + user[key] = value; + } else { + team[key] = value; + } + } + return { team, user }; + }; - // Add existing entries - for (const [key, value] of existingEntries) { - allAgents.set(key, value); + const teamHeader = [ + '# ─────────────────────────────────────────────────────────────────', + '# Installer-managed. Regenerated on every install — treat as read-only.', + '#', + '# Direct edits to this file will be overwritten on the next install.', + '# To change an install answer durably, re-run the installer (your prior', + '# answers are remembered as defaults). To pin a value regardless of', + '# install answers, or to add custom agents / override descriptors, use:', + '# _bmad/custom/config.toml (team, committed)', + '# _bmad/custom/config.user.toml (personal, gitignored)', + '# Those files are never touched by the installer.', + '# ─────────────────────────────────────────────────────────────────', + '', + ]; + + const userHeader = [ + '# ─────────────────────────────────────────────────────────────────', + '# Installer-managed. Regenerated on every install — treat as read-only.', + '# Holds install answers scoped to YOU personally.', + '#', + '# Direct edits to this file will be overwritten on the next install.', + '# To change an answer durably, re-run the installer (your prior answers', + '# are remembered as defaults). For pinned overrides or custom sections', + '# the installer does not know about, use _bmad/custom/config.user.toml', + '# — it is never touched by the installer.', + '# ─────────────────────────────────────────────────────────────────', + '', + ]; + + const teamLines = [...teamHeader]; + const userLines = [...userHeader]; + + // [core] — split into team and user + const coreConfig = moduleConfigs.core || {}; + const { team: coreTeam, user: coreUser } = partition('core', coreConfig); + if (Object.keys(coreTeam).length > 0) { + teamLines.push('[core]'); + for (const [key, value] of Object.entries(coreTeam)) { + teamLines.push(`${key} = ${formatTomlValue(value)}`); + } + teamLines.push(''); + } + if (Object.keys(coreUser).length > 0) { + userLines.push('[core]'); + for (const [key, value] of Object.entries(coreUser)) { + userLines.push(`${key} = ${formatTomlValue(value)}`); + } + userLines.push(''); + } + + // [modules.] — split per module + for (const moduleName of this.updatedModules) { + if (moduleName === 'core') continue; + const cfg = moduleConfigs[moduleName]; + if (!cfg || Object.keys(cfg).length === 0) continue; + // Use the module's code field from module.yaml as the TOML key so the + // section is [modules.mdo] not [modules.MDO: Maxio DevOps Operations]. + const sectionKey = codeByModuleName[moduleName] || moduleName; + // Only filter out spread-from-core pollution when we actually know + // this module's prompt schema. For external/marketplace modules whose + // module.yaml isn't in the src tree, fall through as all-team so we + // don't drop their real answers. + const haveSchema = Object.keys(scopeByModuleKey[moduleName] || {}).length > 0; + const { team: modTeam, user: modUser } = partition(moduleName, cfg, haveSchema); + if (Object.keys(modTeam).length > 0) { + teamLines.push(`[modules.${sectionKey}]`); + for (const [key, value] of Object.entries(modTeam)) { + teamLines.push(`${key} = ${formatTomlValue(value)}`); + } + teamLines.push(''); + } + if (Object.keys(modUser).length > 0) { + userLines.push(`[modules.${sectionKey}]`); + for (const [key, value] of Object.entries(modUser)) { + userLines.push(`${key} = ${formatTomlValue(value)}`); + } + userLines.push(''); + } + } + + // [agents.] — always team (agent roster is organizational). + // Freshly collected agents come from module.yaml this run. If a module + // was preserved (e.g. during quickUpdate when its source isn't available), + // its module.yaml wasn't read — so its agents aren't in `this.agents` and + // would silently disappear from the roster. Preserve those existing + // [agents.*] blocks verbatim from the prior config.toml. + const freshAgentCodes = new Set(this.agents.map((a) => a.code)); + const contributingModules = new Set(this.agents.map((a) => a.module)); + const preservedModules = this.updatedModules.filter((m) => !contributingModules.has(m)); + const preservedBlocks = []; + if (preservedModules.length > 0 && (await fs.pathExists(teamPath))) { + try { + const prev = await fs.readFile(teamPath, 'utf8'); + for (const block of extractAgentBlocks(prev)) { + if (freshAgentCodes.has(block.code)) continue; + if (block.module && preservedModules.includes(block.module)) { + preservedBlocks.push(block.body); + } + } + } catch (error) { + console.warn(`[warn] writeCentralConfig: could not read prior config.toml to preserve agents: ${error.message}`); + } } - // Add/update new agents for (const agent of this.agents) { - const key = `${agent.module}:${agent.name}`; - allAgents.set(key, { - name: agent.name, - displayName: agent.displayName, - title: agent.title, - icon: agent.icon, - capabilities: agent.capabilities, - role: agent.role, - identity: agent.identity, - communicationStyle: agent.communicationStyle, - principles: agent.principles, - module: agent.module, - path: agent.path, - canonicalId: agent.canonicalId || '', - }); + const agentLines = [`[agents.${agent.code}]`, `module = ${formatTomlValue(agent.module)}`, `team = ${formatTomlValue(agent.team)}`]; + if (agent.name) agentLines.push(`name = ${formatTomlValue(agent.name)}`); + if (agent.title) agentLines.push(`title = ${formatTomlValue(agent.title)}`); + if (agent.icon) agentLines.push(`icon = ${formatTomlValue(agent.icon)}`); + if (agent.description) agentLines.push(`description = ${formatTomlValue(agent.description)}`); + agentLines.push(''); + teamLines.push(...agentLines); } - // Write all agents - for (const [, record] of allAgents) { - const row = [ - escapeCsv(record.name), - escapeCsv(record.displayName), - escapeCsv(record.title), - escapeCsv(record.icon), - escapeCsv(record.capabilities), - escapeCsv(record.role), - escapeCsv(record.identity), - escapeCsv(record.communicationStyle), - escapeCsv(record.principles), - escapeCsv(record.module), - escapeCsv(record.path), - escapeCsv(record.canonicalId), - ].join(','); - csvContent += row + '\n'; + for (const body of preservedBlocks) { + teamLines.push(body, ''); } - await fs.writeFile(csvPath, csvContent); - return csvPath; + const teamContent = teamLines.join('\n').replace(/\n+$/, '\n'); + const userContent = userLines.join('\n').replace(/\n+$/, '\n'); + await fs.writeFile(teamPath, teamContent); + await fs.writeFile(userPath, userContent); + return [teamPath, userPath]; + } + + /** + * Create empty _bmad/custom/config.toml and _bmad/custom/config.user.toml stubs + * on first install only. Installer never touches these files again after creation. + */ + async ensureCustomConfigStubs(bmadDir) { + const customDir = path.join(bmadDir, 'custom'); + await fs.ensureDir(customDir); + + const stubs = [ + { + file: path.join(customDir, 'config.toml'), + header: [ + '# Team / enterprise overrides for _bmad/config.toml.', + '# Committed to the repo — applies to every developer on the project.', + '# Tables deep-merge over base config; keyed entries merge by key.', + '# Example: override an agent descriptor, or add a new agent.', + '#', + '# [agents.bmad-agent-pm]', + '# description = "Prefers short, bulleted PRDs over narrative drafts."', + '', + ], + }, + { + file: path.join(customDir, 'config.user.toml'), + header: [ + '# Personal overrides for _bmad/config.toml.', + '# NOT committed (gitignored) — applies only to your local install.', + '# Wins over both base config and team overrides.', + '', + ], + }, + ]; + + for (const { file, header } of stubs) { + if (await fs.pathExists(file)) continue; + await fs.writeFile(file, header.join('\n')); + } } /** @@ -707,4 +801,59 @@ class ManifestGenerator { } } +/** + * Format a JS scalar as a TOML value literal. + * Handles strings (quoted + escaped), booleans, numbers, and arrays of scalars. + * Objects are not expected at this emit path. + */ +function formatTomlValue(value) { + if (value === null || value === undefined) return '""'; + if (typeof value === 'boolean') return value ? 'true' : 'false'; + if (typeof value === 'number' && Number.isFinite(value)) return String(value); + if (Array.isArray(value)) return `[${value.map((v) => formatTomlValue(v)).join(', ')}]`; + const str = String(value); + const escaped = str + .replaceAll('\\', '\\\\') + .replaceAll('"', String.raw`\"`) + .replaceAll('\n', String.raw`\n`) + .replaceAll('\r', String.raw`\r`) + .replaceAll('\t', String.raw`\t`); + return `"${escaped}"`; +} + +/** + * Extract [agents.] blocks from a previously-emitted config.toml. + * We only need this for roster preservation — the file is our own controlled + * output, so a simple line scanner is safer than adding a TOML parser + * dependency. Each block runs from its `[agents.]` header until the + * next `[` heading or EOF; the `module = "..."` line inside drives which + * entries we keep on the next write. + * @returns {Array<{code: string, module: string | null, body: string}>} + */ +function extractAgentBlocks(tomlContent) { + const blocks = []; + const lines = tomlContent.split('\n'); + let i = 0; + while (i < lines.length) { + const header = lines[i].match(/^\[agents\.([^\]]+)]\s*$/); + if (!header) { + i++; + continue; + } + const code = header[1]; + const blockLines = [lines[i]]; + let moduleName = null; + i++; + while (i < lines.length && !lines[i].startsWith('[')) { + blockLines.push(lines[i]); + const m = lines[i].match(/^module\s*=\s*"((?:[^"\\]|\\.)*)"\s*$/); + if (m) moduleName = m[1]; + i++; + } + while (blockLines.length > 1 && blockLines.at(-1) === '') blockLines.pop(); + blocks.push({ code, module: moduleName, body: blockLines.join('\n') }); + } + return blocks; +} + module.exports = { ManifestGenerator }; diff --git a/tools/installer/core/manifest.js b/tools/installer/core/manifest.js index d6eade648..d604bf2fe 100644 --- a/tools/installer/core/manifest.js +++ b/tools/installer/core/manifest.js @@ -1,9 +1,20 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const https = require('node:https'); +const { execFile } = require('node:child_process'); +const { promisify } = require('node:util'); +const fs = require('../fs-native'); const crypto = require('node:crypto'); -const { getProjectRoot } = require('../project-root'); +const { resolveModuleVersion } = require('../modules/version-resolver'); const prompts = require('../prompts'); +const execFileAsync = promisify(execFile); +const NPM_LOOKUP_TIMEOUT_MS = 10_000; +const NPM_PACKAGE_NAME_PATTERN = /^(?:@[a-z0-9][a-z0-9._~-]*\/)?[a-z0-9][a-z0-9._~-]*$/; + +function isValidNpmPackageName(packageName) { + return typeof packageName === 'string' && NPM_PACKAGE_NAME_PATTERN.test(packageName); +} + class Manifest { /** * Create a new manifest @@ -97,7 +108,6 @@ class Manifest { lastUpdated: manifestData.installation?.lastUpdated, modules: moduleNames, // Simple array of module names for backward compatibility modulesDetailed: hasDetailedModules ? modules : null, // New detailed format - customModules: manifestData.customModules || [], // Keep for backward compatibility ides: manifestData.ides || [], }; } catch (error) { @@ -108,115 +118,6 @@ class Manifest { return null; } - /** - * Update existing manifest - * @param {string} bmadDir - Path to bmad directory - * @param {Object} updates - Fields to update - * @param {Array} installedFiles - Updated list of installed files - */ - async update(bmadDir, updates, installedFiles = null) { - const yaml = require('yaml'); - const manifest = (await this._readRaw(bmadDir)) || { - installation: {}, - modules: [], - ides: [], - }; - - // Handle module updates - if (updates.modules) { - // If modules is being updated, we need to preserve detailed module info - const existingDetailed = manifest.modules || []; - const incomingNames = updates.modules; - - // Build updated modules array - const updatedModules = []; - for (const name of incomingNames) { - const existing = existingDetailed.find((m) => m.name === name); - if (existing) { - // Preserve existing details, update lastUpdated if this module is being updated - updatedModules.push({ - ...existing, - lastUpdated: new Date().toISOString(), - }); - } else { - // New module - add with minimal details - updatedModules.push({ - name, - version: null, - installDate: new Date().toISOString(), - lastUpdated: new Date().toISOString(), - source: 'unknown', - }); - } - } - - manifest.modules = updatedModules; - } - - // Merge other updates - if (updates.version) { - manifest.installation.version = updates.version; - } - if (updates.installDate) { - manifest.installation.installDate = updates.installDate; - } - manifest.installation.lastUpdated = new Date().toISOString(); - - if (updates.ides) { - manifest.ides = updates.ides; - } - - // Handle per-module version updates - if (updates.moduleVersions) { - for (const [moduleName, versionInfo] of Object.entries(updates.moduleVersions)) { - const moduleIndex = manifest.modules.findIndex((m) => m.name === moduleName); - if (moduleIndex !== -1) { - manifest.modules[moduleIndex] = { - ...manifest.modules[moduleIndex], - ...versionInfo, - lastUpdated: new Date().toISOString(), - }; - } - } - } - - // Handle adding a new module with version info - if (updates.addModule) { - const { name, version, source, npmPackage, repoUrl } = updates.addModule; - const existing = manifest.modules.find((m) => m.name === name); - if (!existing) { - manifest.modules.push({ - name, - version: version || null, - installDate: new Date().toISOString(), - lastUpdated: new Date().toISOString(), - source: source || 'external', - npmPackage: npmPackage || null, - repoUrl: repoUrl || null, - }); - } - } - - const manifestPath = path.join(bmadDir, '_config', 'manifest.yaml'); - await fs.ensureDir(path.dirname(manifestPath)); - - // Clean the manifest data to remove any non-serializable values - const cleanManifestData = structuredClone(manifest); - - const yamlContent = yaml.stringify(cleanManifestData, { - indent: 2, - lineWidth: 0, - sortKeys: false, - }); - - // Ensure POSIX-compliant final newline - const content = yamlContent.endsWith('\n') ? yamlContent : yamlContent + '\n'; - await fs.writeFile(manifestPath, content, 'utf8'); - - // Return the flattened format for compatibility - return this._flattenManifest(manifest); - } - /** * Read raw manifest data without flattening * @param {string} bmadDir - Path to bmad directory @@ -254,7 +155,6 @@ class Manifest { lastUpdated: manifest.installation?.lastUpdated, modules: moduleNames, modulesDetailed: hasDetailedModules ? modules : null, - customModules: manifest.customModules || [], ides: manifest.ides || [], }; } @@ -282,7 +182,7 @@ class Manifest { if (existingIndex === -1) { // Module doesn't exist, add it - manifest.modules.push({ + const entry = { name: moduleName, version: options.version || null, installDate: new Date().toISOString(), @@ -290,7 +190,14 @@ class Manifest { source: options.source || 'unknown', npmPackage: options.npmPackage || null, repoUrl: options.repoUrl || null, - }); + }; + if (options.channel) entry.channel = options.channel; + if (options.sha) entry.sha = options.sha; + if (options.localPath) entry.localPath = options.localPath; + if (options.rawSource) entry.rawSource = options.rawSource; + if (options.registryApprovedTag) entry.registryApprovedTag = options.registryApprovedTag; + if (options.registryApprovedSha) entry.registryApprovedSha = options.registryApprovedSha; + manifest.modules.push(entry); } else { // Module exists, update its version info const existing = manifest.modules[existingIndex]; @@ -300,6 +207,12 @@ class Manifest { source: options.source || existing.source, npmPackage: options.npmPackage === undefined ? existing.npmPackage : options.npmPackage, repoUrl: options.repoUrl === undefined ? existing.repoUrl : options.repoUrl, + localPath: options.localPath === undefined ? existing.localPath : options.localPath, + channel: options.channel === undefined ? existing.channel : options.channel, + sha: options.sha === undefined ? existing.sha : options.sha, + rawSource: options.rawSource === undefined ? existing.rawSource : options.rawSource, + registryApprovedTag: options.registryApprovedTag === undefined ? existing.registryApprovedTag : options.registryApprovedTag, + registryApprovedSha: options.registryApprovedSha === undefined ? existing.registryApprovedSha : options.registryApprovedSha, lastUpdated: new Date().toISOString(), }; } @@ -307,62 +220,6 @@ class Manifest { await this._writeRaw(bmadDir, manifest); } - /** - * Remove a module from the manifest - * @param {string} bmadDir - Path to bmad directory - * @param {string} moduleName - Module name to remove - */ - async removeModule(bmadDir, moduleName) { - const manifest = await this._readRaw(bmadDir); - if (!manifest || !manifest.modules) { - return; - } - - const index = manifest.modules.findIndex((m) => m.name === moduleName); - if (index !== -1) { - manifest.modules.splice(index, 1); - await this._writeRaw(bmadDir, manifest); - } - } - - /** - * Update a single module's version info - * @param {string} bmadDir - Path to bmad directory - * @param {string} moduleName - Module name - * @param {Object} versionInfo - Version info to update - */ - async updateModuleVersion(bmadDir, moduleName, versionInfo) { - const manifest = await this._readRaw(bmadDir); - if (!manifest || !manifest.modules) { - return; - } - - const index = manifest.modules.findIndex((m) => m.name === moduleName); - if (index !== -1) { - manifest.modules[index] = { - ...manifest.modules[index], - ...versionInfo, - lastUpdated: new Date().toISOString(), - }; - await this._writeRaw(bmadDir, manifest); - } - } - - /** - * Get version info for a specific module - * @param {string} bmadDir - Path to bmad directory - * @param {string} moduleName - Module name - * @returns {Object|null} Module version info or null - */ - async getModuleVersion(bmadDir, moduleName) { - const manifest = await this._readRaw(bmadDir); - if (!manifest || !manifest.modules) { - return null; - } - - return manifest.modules.find((m) => m.name === moduleName) || null; - } - /** * Get all modules with their version info * @param {string} bmadDir - Path to bmad directory @@ -400,27 +257,6 @@ class Manifest { await fs.writeFile(manifestPath, content, 'utf8'); } - /** - * Add an IDE configuration to the manifest - * @param {string} bmadDir - Path to bmad directory - * @param {string} ideName - IDE name to add - */ - async addIde(bmadDir, ideName) { - const manifest = await this.read(bmadDir); - if (!manifest) { - throw new Error('No manifest found'); - } - - if (!manifest.ides) { - manifest.ides = []; - } - - if (!manifest.ides.includes(ideName)) { - manifest.ides.push(ideName); - await this.update(bmadDir, { ides: manifest.ides }); - } - } - /** * Calculate SHA256 hash of a file * @param {string} filePath - Path to file @@ -435,400 +271,6 @@ class Manifest { } } - /** - * Parse installed files to extract metadata - * @param {Array} installedFiles - List of installed file paths - * @param {string} bmadDir - Path to bmad directory for relative paths - * @returns {Array} Array of file metadata objects - */ - async parseInstalledFiles(installedFiles, bmadDir) { - const fileMetadata = []; - - for (const filePath of installedFiles) { - const fileExt = path.extname(filePath).toLowerCase(); - // Make path relative to parent of bmad directory, starting with 'bmad/' - const relativePath = 'bmad' + filePath.replace(bmadDir, '').replaceAll('\\', '/'); - - // Calculate file hash - const hash = await this.calculateFileHash(filePath); - - // Handle markdown files - extract XML metadata if present - if (fileExt === '.md') { - try { - if (await fs.pathExists(filePath)) { - const content = await fs.readFile(filePath, 'utf8'); - const metadata = this.extractXmlNodeAttributes(content, filePath, relativePath); - - if (metadata) { - // Has XML metadata - metadata.hash = hash; - fileMetadata.push(metadata); - } else { - // No XML metadata - still track the file - fileMetadata.push({ - file: relativePath, - type: 'md', - name: path.basename(filePath, fileExt), - title: null, - hash: hash, - }); - } - } - } catch (error) { - await prompts.log.warn(`Could not parse ${filePath}: ${error.message}`); - } - } - // Handle other file types (CSV, JSON, YAML, etc.) - else { - fileMetadata.push({ - file: relativePath, - type: fileExt.slice(1), // Remove the dot - name: path.basename(filePath, fileExt), - title: null, - hash: hash, - }); - } - } - - return fileMetadata; - } - - /** - * Extract XML node attributes from MD file content - * @param {string} content - File content - * @param {string} filePath - File path for context - * @param {string} relativePath - Relative path starting with 'bmad/' - * @returns {Object|null} Extracted metadata or null - */ - extractXmlNodeAttributes(content, filePath, relativePath) { - // Look for XML blocks in code fences - const xmlBlockMatch = content.match(/```xml\s*([\s\S]*?)```/); - if (!xmlBlockMatch) { - return null; - } - - const xmlContent = xmlBlockMatch[1]; - - // Extract root XML node (agent, task, template, etc.) - const rootNodeMatch = xmlContent.match(/<(\w+)([^>]*)>/); - if (!rootNodeMatch) { - return null; - } - - const nodeType = rootNodeMatch[1]; - const attributes = rootNodeMatch[2]; - - // Extract name and title attributes (id not needed since we have path) - const nameMatch = attributes.match(/name="([^"]*)"/); - const titleMatch = attributes.match(/title="([^"]*)"/); - - return { - file: relativePath, - type: nodeType, - name: nameMatch ? nameMatch[1] : null, - title: titleMatch ? titleMatch[1] : null, - }; - } - - /** - * Generate CSV manifest content - * @param {Object} data - Manifest data - * @param {Array} fileMetadata - File metadata array - * @param {Object} moduleConfigs - Module configuration data - * @returns {string} CSV content - */ - generateManifestCsv(data, fileMetadata, moduleConfigs = {}) { - const timestamp = new Date().toISOString(); - let csv = []; - - // Header section - csv.push( - '# BMAD Manifest', - `# Generated: ${timestamp}`, - '', - '## Installation Info', - 'Property,Value', - `Version,${data.version}`, - `InstallDate,${data.installDate || timestamp}`, - `LastUpdated,${data.lastUpdated || timestamp}`, - ); - if (data.language) { - csv.push(`Language,${data.language}`); - } - csv.push(''); - - // Modules section - if (data.modules && data.modules.length > 0) { - csv.push('## Modules', 'Name,Version,ShortTitle'); - for (const moduleName of data.modules) { - const config = moduleConfigs[moduleName] || {}; - csv.push([moduleName, config.version || '', config['short-title'] || ''].map((v) => this.escapeCsv(v)).join(',')); - } - csv.push(''); - } - - // IDEs section - if (data.ides && data.ides.length > 0) { - csv.push('## IDEs', 'IDE'); - for (const ide of data.ides) { - csv.push(this.escapeCsv(ide)); - } - csv.push(''); - } - - // Files section - NO LONGER USED - // Files are now tracked in files-manifest.csv by ManifestGenerator - - return csv.join('\n'); - } - - /** - * Parse CSV manifest content back to object - * @param {string} csvContent - CSV content to parse - * @returns {Object} Parsed manifest data - */ - parseManifestCsv(csvContent) { - const result = { - modules: [], - ides: [], - files: [], - }; - - const lines = csvContent.split('\n'); - let section = ''; - - for (const line_ of lines) { - const line = line_.trim(); - - // Skip empty lines and comments - if (!line || line.startsWith('#')) { - // Check for section headers - if (line.startsWith('## ')) { - section = line.slice(3).toLowerCase(); - } - continue; - } - - // Parse based on current section - switch (section) { - case 'installation info': { - // Skip header row - if (line === 'Property,Value') continue; - - const [property, ...valueParts] = line.split(','); - const value = this.unescapeCsv(valueParts.join(',')); - - switch (property) { - // Path no longer stored in manifest - case 'Version': { - result.version = value; - break; - } - case 'InstallDate': { - result.installDate = value; - break; - } - case 'LastUpdated': { - result.lastUpdated = value; - break; - } - case 'Language': { - result.language = value; - break; - } - } - - break; - } - case 'modules': { - // Skip header row - if (line === 'Name,Version,ShortTitle') continue; - - const parts = this.parseCsvLine(line); - if (parts[0]) { - result.modules.push(parts[0]); - } - - break; - } - case 'ides': { - // Skip header row - if (line === 'IDE') continue; - - result.ides.push(this.unescapeCsv(line)); - - break; - } - case 'files': { - // Skip header rows (support both old and new format) - if (line === 'Type,Path,Name,Title' || line === 'Type,Path,Name,Title,Hash') continue; - - const parts = this.parseCsvLine(line); - if (parts.length >= 2) { - result.files.push({ - type: parts[0] || '', - file: parts[1] || '', - name: parts[2] || null, - title: parts[3] || null, - hash: parts[4] || null, // Hash column (may not exist in old manifests) - }); - } - - break; - } - // No default - } - } - - return result; - } - - /** - * Parse a CSV line handling quotes and commas - * @param {string} line - CSV line to parse - * @returns {Array} Array of values - */ - parseCsvLine(line) { - const result = []; - let current = ''; - let inQuotes = false; - - for (let i = 0; i < line.length; i++) { - const char = line[i]; - - if (char === '"') { - if (inQuotes && line[i + 1] === '"') { - // Escaped quote - current += '"'; - i++; - } else { - // Toggle quote state - inQuotes = !inQuotes; - } - } else if (char === ',' && !inQuotes) { - // Field separator - result.push(this.unescapeCsv(current)); - current = ''; - } else { - current += char; - } - } - - // Add the last field - result.push(this.unescapeCsv(current)); - - return result; - } - - /** - * Escape CSV special characters - * @param {string} text - Text to escape - * @returns {string} Escaped text - */ - escapeCsv(text) { - if (!text) return ''; - const str = String(text); - - // If contains comma, newline, or quote, wrap in quotes and escape quotes - if (str.includes(',') || str.includes('\n') || str.includes('"')) { - return '"' + str.replaceAll('"', '""') + '"'; - } - - return str; - } - - /** - * Unescape CSV field - * @param {string} text - Text to unescape - * @returns {string} Unescaped text - */ - unescapeCsv(text) { - if (!text) return ''; - - // Remove surrounding quotes if present - if (text.startsWith('"') && text.endsWith('"')) { - text = text.slice(1, -1); - // Unescape doubled quotes - text = text.replaceAll('""', '"'); - } - - return text; - } - - /** - * Load module configuration files - * @param {Array} modules - List of module names - * @returns {Object} Module configurations indexed by name - */ - async loadModuleConfigs(modules) { - const configs = {}; - - for (const moduleName of modules) { - // Handle core module differently - it's in src/core-skills not src/modules/core - const configPath = - moduleName === 'core' - ? path.join(process.cwd(), 'src', 'core-skills', 'config.yaml') - : path.join(process.cwd(), 'src', 'modules', moduleName, 'config.yaml'); - - try { - if (await fs.pathExists(configPath)) { - const yaml = require('yaml'); - const content = await fs.readFile(configPath, 'utf8'); - configs[moduleName] = yaml.parse(content); - } - } catch (error) { - await prompts.log.warn(`Could not load config for module ${moduleName}: ${error.message}`); - } - } - - return configs; - } - /** - * Add a custom module to the manifest with its source path - * @param {string} bmadDir - Path to bmad directory - * @param {Object} customModule - Custom module info - */ - async addCustomModule(bmadDir, customModule) { - const manifest = await this.read(bmadDir); - if (!manifest) { - throw new Error('No manifest found'); - } - - if (!manifest.customModules) { - manifest.customModules = []; - } - - // Check if custom module already exists - const existingIndex = manifest.customModules.findIndex((m) => m.id === customModule.id); - if (existingIndex === -1) { - // Add new entry - manifest.customModules.push(customModule); - } else { - // Update existing entry - manifest.customModules[existingIndex] = customModule; - } - - await this.update(bmadDir, { customModules: manifest.customModules }); - } - - /** - * Remove a custom module from the manifest - * @param {string} bmadDir - Path to bmad directory - * @param {string} moduleId - Module ID to remove - */ - async removeCustomModule(bmadDir, moduleId) { - const manifest = await this.read(bmadDir); - if (!manifest || !manifest.customModules) { - return; - } - - const index = manifest.customModules.findIndex((m) => m.id === moduleId); - if (index !== -1) { - manifest.customModules.splice(index, 1); - await this.update(bmadDir, { customModules: manifest.customModules }); - } - } - /** * Get module version info from source * @param {string} moduleName - Module name/code @@ -837,14 +279,11 @@ class Manifest { * @returns {Object} Version info object with version, source, npmPackage, repoUrl */ async getModuleVersionInfo(moduleName, bmadDir, moduleSourcePath = null) { - const os = require('node:os'); - const yaml = require('yaml'); - - // Built-in modules use BMad version (only core and bmm are in BMAD-METHOD repo) + // Resolve source type first, then read version with the correct path context if (['core', 'bmm'].includes(moduleName)) { - const bmadVersion = require(path.join(getProjectRoot(), 'package.json')).version; + const versionInfo = await resolveModuleVersion(moduleName, { moduleSourcePath }); return { - version: bmadVersion, + version: versionInfo.version, source: 'built-in', npmPackage: null, repoUrl: null, @@ -857,63 +296,71 @@ class Manifest { const moduleInfo = await extMgr.getModuleByCode(moduleName); if (moduleInfo) { - // External module - try to get version from npm registry first, then fall back to cache - let version = null; - - if (moduleInfo.npmPackage) { - // Fetch version from npm registry - try { - version = await this.fetchNpmVersion(moduleInfo.npmPackage); - } catch { - // npm fetch failed, try cache as fallback - } - } - - // If npm didn't work, try reading from cached repo's package.json - if (!version) { - const cacheDir = path.join(os.homedir(), '.bmad', 'cache', 'external-modules', moduleName); - const packageJsonPath = path.join(cacheDir, 'package.json'); - - if (await fs.pathExists(packageJsonPath)) { - try { - const pkg = require(packageJsonPath); - version = pkg.version; - } catch (error) { - await prompts.log.warn(`Failed to read package.json for ${moduleName}: ${error.message}`); - } - } - } - + const externalResolution = extMgr.getResolution(moduleName); + const versionInfo = await resolveModuleVersion(moduleName, { moduleSourcePath }); return { - version: version, + // Git tag recorded during install trumps the on-disk package.json + // version, so the manifest carries "v1.7.0" instead of "1.7.0". + version: externalResolution?.version || versionInfo.version, source: 'external', npmPackage: moduleInfo.npmPackage || null, repoUrl: moduleInfo.url || null, + channel: externalResolution?.channel || null, + sha: externalResolution?.sha || null, }; } - // Custom module - check cache directory - const cacheDir = path.join(bmadDir, '_config', 'custom', moduleName); - const moduleYamlPath = path.join(cacheDir, 'module.yaml'); + // Check if this is a community module + const { CommunityModuleManager } = require('../modules/community-manager'); + const communityMgr = new CommunityModuleManager(); + const communityInfo = await communityMgr.getModuleByCode(moduleName); + if (communityInfo) { + const communityResolution = communityMgr.getResolution(moduleName); + const versionInfo = await resolveModuleVersion(moduleName, { + moduleSourcePath, + fallbackVersion: communityInfo.version, + }); + return { + version: communityResolution?.version || versionInfo.version || communityInfo.version, + source: 'community', + npmPackage: communityInfo.npmPackage || null, + repoUrl: communityInfo.url || null, + channel: communityResolution?.channel || null, + sha: communityResolution?.sha || null, + registryApprovedTag: communityResolution?.registryApprovedTag || null, + registryApprovedSha: communityResolution?.registryApprovedSha || null, + }; + } - if (await fs.pathExists(moduleYamlPath)) { - try { - const yamlContent = await fs.readFile(moduleYamlPath, 'utf8'); - const moduleConfig = yaml.parse(yamlContent); - return { - version: moduleConfig.version || null, - source: 'custom', - npmPackage: moduleConfig.npmPackage || null, - repoUrl: moduleConfig.repoUrl || null, - }; - } catch (error) { - await prompts.log.warn(`Failed to read module.yaml for ${moduleName}: ${error.message}`); - } + // Check if this is a custom module (from user-provided URL or local path) + const { CustomModuleManager } = require('../modules/custom-module-manager'); + const customMgr = new CustomModuleManager(); + const resolved = customMgr.getResolution(moduleName); + const customSource = await customMgr.findModuleSourceByCode(moduleName, { bmadDir }); + if (customSource || resolved) { + const versionInfo = await resolveModuleVersion(moduleName, { + moduleSourcePath: moduleSourcePath || customSource, + fallbackVersion: resolved?.version, + marketplacePluginNames: resolved?.pluginName ? [resolved.pluginName] : [], + }); + const hasGitClone = !!resolved?.repoUrl; + return { + // Prefer the git ref we actually cloned over the package.json version. + version: resolved?.cloneRef || (hasGitClone ? 'main' : versionInfo.version), + source: 'custom', + npmPackage: null, + repoUrl: resolved?.repoUrl || null, + localPath: resolved?.localPath || null, + channel: hasGitClone ? (resolved?.cloneRef ? 'pinned' : 'next') : null, + sha: resolved?.cloneSha || null, + rawSource: resolved?.rawInput || null, + }; } // Unknown module + const versionInfo = await resolveModuleVersion(moduleName, { moduleSourcePath }); return { - version: null, + version: versionInfo.version, source: 'unknown', npmPackage: null, repoUrl: null, @@ -926,35 +373,40 @@ class Manifest { * @returns {string|null} Latest version or null */ async fetchNpmVersion(packageName) { - try { - const https = require('node:https'); - const { execSync } = require('node:child_process'); + if (!isValidNpmPackageName(packageName)) { + return null; + } + try { // Try using npm view first (more reliable) try { - const result = execSync(`npm view ${packageName} version`, { + const { stdout } = await execFileAsync('npm', ['view', packageName, 'version'], { encoding: 'utf8', - stdio: 'pipe', - timeout: 10_000, + timeout: NPM_LOOKUP_TIMEOUT_MS, }); - return result.trim(); + return stdout.trim(); } catch { // Fallback to npm registry API - return new Promise((resolve, reject) => { - https - .get(`https://registry.npmjs.org/${packageName}`, (res) => { - let data = ''; - res.on('data', (chunk) => (data += chunk)); - res.on('end', () => { - try { - const pkg = JSON.parse(data); - resolve(pkg['dist-tags']?.latest || pkg.version || null); - } catch { - resolve(null); - } - }); - }) - .on('error', () => resolve(null)); + return new Promise((resolve) => { + const request = https.get(`https://registry.npmjs.org/${encodeURIComponent(packageName)}`, (res) => { + let data = ''; + res.on('data', (chunk) => (data += chunk)); + res.on('end', () => { + try { + const pkg = JSON.parse(data); + resolve(pkg['dist-tags']?.latest || pkg.version || null); + } catch { + resolve(null); + } + }); + }); + + request.setTimeout(NPM_LOOKUP_TIMEOUT_MS, () => { + request.destroy(); + resolve(null); + }); + + request.on('error', () => resolve(null)); }); } } catch { @@ -968,6 +420,7 @@ class Manifest { * @returns {Array} Array of update info objects */ async checkForUpdates(bmadDir) { + const semver = require('semver'); const modules = await this.getAllModuleVersions(bmadDir); const updates = []; @@ -981,7 +434,10 @@ class Manifest { continue; } - if (module.version !== latestVersion) { + const installedVersion = semver.valid(module.version) || semver.valid(semver.coerce(module.version || '')); + const availableVersion = semver.valid(latestVersion) || semver.valid(semver.coerce(latestVersion)); + + if (installedVersion && availableVersion && semver.gt(availableVersion, installedVersion)) { updates.push({ name: module.name, installedVersion: module.version, @@ -994,47 +450,6 @@ class Manifest { return updates; } - - /** - * Compare two semantic versions - * @param {string} v1 - First version - * @param {string} v2 - Second version - * @returns {number} -1 if v1 < v2, 0 if v1 == v2, 1 if v1 > v2 - */ - compareVersions(v1, v2) { - if (!v1 || !v2) return 0; - - const normalize = (v) => { - // Remove leading 'v' if present - v = v.replace(/^v/, ''); - // Handle prerelease tags - const parts = v.split('-'); - const main = parts[0].split('.'); - const prerelease = parts[1]; - return { main, prerelease }; - }; - - const n1 = normalize(v1); - const n2 = normalize(v2); - - // Compare main version parts - for (let i = 0; i < 3; i++) { - const num1 = parseInt(n1.main[i] || '0', 10); - const num2 = parseInt(n2.main[i] || '0', 10); - if (num1 !== num2) { - return num1 < num2 ? -1 : 1; - } - } - - // If main versions are equal, compare prerelease - if (n1.prerelease && n2.prerelease) { - return n1.prerelease < n2.prerelease ? -1 : n1.prerelease > n2.prerelease ? 1 : 0; - } - if (n1.prerelease) return -1; // Prerelease is older than stable - if (n2.prerelease) return 1; // Stable is newer than prerelease - - return 0; - } } module.exports = { Manifest }; diff --git a/tools/installer/custom-handler.js b/tools/installer/custom-handler.js deleted file mode 100644 index a1966b7e7..000000000 --- a/tools/installer/custom-handler.js +++ /dev/null @@ -1,112 +0,0 @@ -const path = require('node:path'); -const fs = require('fs-extra'); -const yaml = require('yaml'); -const prompts = require('./prompts'); -/** - * Handler for custom content (custom.yaml) - * Discovers custom agents and workflows in the project - */ -class CustomHandler { - /** - * Find all custom.yaml files in the project - * @param {string} projectRoot - Project root directory - * @returns {Array} List of custom content paths - */ - async findCustomContent(projectRoot) { - const customPaths = []; - - // Helper function to recursively scan directories - async function scanDirectory(dir, excludePaths = []) { - try { - const entries = await fs.readdir(dir, { withFileTypes: true }); - - for (const entry of entries) { - const fullPath = path.join(dir, entry.name); - - // Skip hidden directories and common exclusions - if ( - entry.name.startsWith('.') || - entry.name === 'node_modules' || - entry.name === 'dist' || - entry.name === 'build' || - entry.name === '.git' || - entry.name === 'bmad' - ) { - continue; - } - - // Skip excluded paths - if (excludePaths.some((exclude) => fullPath.startsWith(exclude))) { - continue; - } - - if (entry.isDirectory()) { - // Recursively scan subdirectories - await scanDirectory(fullPath, excludePaths); - } else if (entry.name === 'custom.yaml') { - // Found a custom.yaml file - customPaths.push(fullPath); - } else if ( - entry.name === 'module.yaml' && // Check if this is a custom module (in root directory) - // Skip if it's in src/modules (those are standard modules) - !fullPath.includes(path.join('src', 'modules')) - ) { - customPaths.push(fullPath); - } - } - } catch { - // Ignore errors (e.g., permission denied) - } - } - - // Scan the entire project, but exclude source directories - await scanDirectory(projectRoot, [path.join(projectRoot, 'src'), path.join(projectRoot, 'tools'), path.join(projectRoot, 'test')]); - - return customPaths; - } - - /** - * Get custom content info from a custom.yaml or module.yaml file - * @param {string} configPath - Path to config file - * @param {string} projectRoot - Project root directory for calculating relative paths - * @returns {Object|null} Custom content info - */ - async getCustomInfo(configPath, projectRoot = null) { - try { - const configContent = await fs.readFile(configPath, 'utf8'); - - // Try to parse YAML with error handling - let config; - try { - config = yaml.parse(configContent); - } catch (parseError) { - await prompts.log.warn('YAML parse error in ' + configPath + ': ' + parseError.message); - return null; - } - - // Check if this is an module.yaml (module) or custom.yaml (custom content) - const isInstallConfig = configPath.endsWith('module.yaml'); - const configDir = path.dirname(configPath); - - // Use provided projectRoot or fall back to process.cwd() - const basePath = projectRoot || process.cwd(); - const relativePath = path.relative(basePath, configDir); - - return { - id: config.code || 'unknown-code', - name: config.name, - description: config.description || '', - path: configDir, - relativePath: relativePath, - defaultSelected: config.default_selected === true, - config: config, - isInstallConfig: isInstallConfig, // Track which type this is - }; - } catch (error) { - await prompts.log.warn('Failed to read ' + configPath + ': ' + error.message); - return null; - } - } -} - -module.exports = { CustomHandler }; diff --git a/tools/installer/file-ops.js b/tools/installer/file-ops.js index 5cd7970d8..2a2869930 100644 --- a/tools/installer/file-ops.js +++ b/tools/installer/file-ops.js @@ -1,4 +1,4 @@ -const fs = require('fs-extra'); +const fs = require('./fs-native'); const path = require('node:path'); const crypto = require('node:crypto'); diff --git a/tools/installer/fs-native.js b/tools/installer/fs-native.js new file mode 100644 index 000000000..1d84af98a --- /dev/null +++ b/tools/installer/fs-native.js @@ -0,0 +1,116 @@ +// Drop-in replacement for fs-extra using native node:fs APIs. +// Eliminates graceful-fs monkey-patching that causes non-deterministic +// file loss during multi-module installs on macOS (issue #1779). +const fsp = require('node:fs/promises'); +const fs = require('node:fs'); +const path = require('node:path'); + +async function pathExists(p) { + try { + await fsp.access(p); + return true; + } catch { + return false; + } +} + +async function ensureDir(dir) { + await fsp.mkdir(dir, { recursive: true }); +} + +async function remove(p) { + await fsp.rm(p, { recursive: true, force: true }); +} + +async function copy(src, dest, options = {}) { + const filterFn = options.filter; + const overwrite = options.overwrite !== false; + const srcStat = await fsp.stat(src); + + if (srcStat.isFile()) { + if (filterFn && !(await filterFn(src, dest))) return; + await fsp.mkdir(path.dirname(dest), { recursive: true }); + if (!overwrite) { + try { + await fsp.access(dest); + if (options.errorOnExist) throw new Error(`${dest} already exists`); + return; + } catch (error) { + if (error.message.includes('already exists')) throw error; + } + } + await fsp.copyFile(src, dest); + return; + } + + if (srcStat.isDirectory()) { + if (filterFn && !(await filterFn(src, dest))) return; + await fsp.mkdir(dest, { recursive: true }); + const entries = await fsp.readdir(src, { withFileTypes: true }); + for (const entry of entries) { + await copy(path.join(src, entry.name), path.join(dest, entry.name), options); + } + } +} + +async function move(src, dest) { + try { + await fsp.rename(src, dest); + } catch (error) { + if (error.code === 'EXDEV') { + await copy(src, dest); + await fsp.rm(src, { recursive: true, force: true }); + } else { + throw error; + } + } +} + +function readJsonSync(p) { + return JSON.parse(fs.readFileSync(p, 'utf8')); +} + +async function writeJson(p, data, options = {}) { + const spaces = options.spaces ?? 2; + await fsp.writeFile(p, JSON.stringify(data, null, spaces) + '\n', 'utf8'); +} + +module.exports = { + // Native async (node:fs/promises) + readFile: fsp.readFile, + writeFile: fsp.writeFile, + stat: fsp.stat, + readdir: fsp.readdir, + access: fsp.access, + realpath: fsp.realpath, + rename: fsp.rename, + rmdir: fsp.rmdir, + unlink: fsp.unlink, + chmod: fsp.chmod, + mkdir: fsp.mkdir, + mkdtemp: fsp.mkdtemp, + copyFile: fsp.copyFile, + rm: fsp.rm, + + // fs-extra compatible helpers (native implementations) + pathExists, + ensureDir, + remove, + copy, + move, + readJsonSync, + writeJson, + + // Sync methods from core node:fs + existsSync: fs.existsSync.bind(fs), + readFileSync: fs.readFileSync.bind(fs), + writeFileSync: fs.writeFileSync.bind(fs), + statSync: fs.statSync.bind(fs), + accessSync: fs.accessSync.bind(fs), + readdirSync: fs.readdirSync.bind(fs), + createReadStream: fs.createReadStream.bind(fs), + pathExistsSync: fs.existsSync.bind(fs), + + // Constants + constants: fs.constants, +}; diff --git a/tools/installer/ide/_config-driven.js b/tools/installer/ide/_config-driven.js index 603ffc7a4..737e10862 100644 --- a/tools/installer/ide/_config-driven.js +++ b/tools/installer/ide/_config-driven.js @@ -1,10 +1,10 @@ -const os = require('node:os'); const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const yaml = require('yaml'); const prompts = require('../prompts'); const csv = require('csv-parse/sync'); const { BMAD_FOLDER_NAME } = require('./shared/path-utils'); +const { getInstalledCanonicalIds, isBmadOwnedEntry } = require('./shared/installed-skills'); /** * Config-driven IDE setup handler @@ -16,7 +16,7 @@ const { BMAD_FOLDER_NAME } = require('./shared/path-utils'); * Features: * - Config-driven from platform-codes.yaml * - Verbatim skill installation from skill-manifest.csv - * - Legacy directory cleanup and IDE-specific marker removal + * - IDE-specific marker removal (copilot-instructions, kilo modes, rovodev prompts) */ class ConfigDrivenIdeSetup { constructor(platformCode, platformConfig) { @@ -44,16 +44,20 @@ class ConfigDrivenIdeSetup { async detect(projectDir) { if (!this.configDir) return false; - const dir = path.join(projectDir || process.cwd(), this.configDir); - if (await fs.pathExists(dir)) { - try { - const entries = await fs.readdir(dir); - return entries.some((e) => typeof e === 'string' && e.startsWith('bmad')); - } catch { - return false; - } + const root = projectDir || process.cwd(); + const dir = path.join(root, this.configDir); + if (!(await fs.pathExists(dir))) return false; + + let entries; + try { + entries = await fs.readdir(dir); + } catch { + return false; } - return false; + + const bmadDir = await this._findBmadDir(root); + const canonicalIds = await getInstalledCanonicalIds(bmadDir); + return entries.some((e) => isBmadOwnedEntry(e, canonicalIds)); } /** @@ -86,12 +90,18 @@ class ConfigDrivenIdeSetup { if (!options.silent) await prompts.log.info(`Setting up ${this.name}...`); // Clean up any old BMAD installation first - await this.cleanup(projectDir, options); + await this.cleanup(projectDir, options, bmadDir); if (!this.installerConfig) { return { success: false, reason: 'no-config' }; } + // When a peer platform in the same install batch owns this target_dir, + // skip the skill write — the peer has already populated it. + if (options.skipTarget) { + return { success: true, results: { skills: 0, sharedTargetHandledByPeer: true } }; + } + if (this.installerConfig.target_dir) { return this.installToTarget(projectDir, bmadDir, this.installerConfig, options); } @@ -183,18 +193,6 @@ class ConfigDrivenIdeSetup { count++; } - // Post-install cleanup: remove _bmad/ directories for skills with install_to_bmad === "false" - for (const record of records) { - if (record.install_to_bmad === 'false') { - const relativePath = record.path.startsWith(bmadPrefix) ? record.path.slice(bmadPrefix.length) : record.path; - const sourceFile = path.join(bmadDir, relativePath); - const sourceDir = path.dirname(sourceFile); - if (await fs.pathExists(sourceDir)) { - await fs.remove(sourceDir); - } - } - } - return count; } @@ -215,18 +213,23 @@ class ConfigDrivenIdeSetup { * Cleanup IDE configuration * @param {string} projectDir - Project directory */ - async cleanup(projectDir, options = {}) { - // Migrate legacy target directories (e.g. .opencode/agent → .opencode/agents) - if (this.installerConfig?.legacy_targets) { - if (!options.silent) await prompts.log.message(' Migrating legacy directories...'); - for (const legacyDir of this.installerConfig.legacy_targets) { - if (this.isGlobalPath(legacyDir)) { - await this.warnGlobalLegacy(legacyDir, options); - } else { - await this.cleanupTarget(projectDir, legacyDir, options); - await this.removeEmptyParents(projectDir, legacyDir); - } + async cleanup(projectDir, options = {}, bmadDir = null) { + const resolvedBmadDir = bmadDir || (await this._findBmadDir(projectDir)); + + // Build removal set: previously installed skills + removals.txt entries + let removalSet; + if (options.previousSkillIds && options.previousSkillIds.size > 0) { + // Install/update flow: use pre-captured skill IDs (before manifest was overwritten) + removalSet = new Set(options.previousSkillIds); + if (resolvedBmadDir) { + const removals = await this.loadRemovalLists(resolvedBmadDir); + for (const entry of removals) removalSet.add(entry); } + } else if (resolvedBmadDir) { + // Uninstall flow: read from current skill-manifest.csv + removals.txt + removalSet = await this._buildUninstallSet(resolvedBmadDir); + } else { + removalSet = new Set(); } // Strip BMAD markers from copilot-instructions.md if present @@ -244,65 +247,129 @@ class ConfigDrivenIdeSetup { await this.cleanupRovoDevPrompts(projectDir, options); } - // Clean target directory + // Skip target_dir cleanup when a peer platform owns this directory + // (set during dedup'd install or when uninstalling one of several + // platforms that share the same target_dir). + if (options.skipTarget) return; + + // Clean current target directory if (this.installerConfig?.target_dir) { - await this.cleanupTarget(projectDir, this.installerConfig.target_dir, options); + await this.cleanupTarget(projectDir, this.installerConfig.target_dir, options, removalSet); } } /** - * Check if a path is global (starts with ~ or is absolute) - * @param {string} p - Path to check - * @returns {boolean} + * Find the _bmad directory in a project + * @param {string} projectDir - Project directory + * @returns {string|null} Path to bmad dir or null */ - isGlobalPath(p) { - return p.startsWith('~') || path.isAbsolute(p); + async _findBmadDir(projectDir) { + const bmadDir = path.join(projectDir, BMAD_FOLDER_NAME); + return (await fs.pathExists(bmadDir)) ? bmadDir : null; } /** - * Warn about stale BMAD files in a global legacy directory (never auto-deletes) - * @param {string} legacyDir - Legacy directory path (may start with ~) - * @param {Object} options - Options (silent, etc.) + * Build the full set of entries to remove for uninstall. + * Reads skill-manifest.csv to know exactly what was installed, plus removal lists. + * @param {string} bmadDir - BMAD installation directory + * @returns {Set} Set of entries to remove */ - async warnGlobalLegacy(legacyDir, options = {}) { + async _buildUninstallSet(bmadDir) { + const removals = await this.loadRemovalLists(bmadDir); + + // Also add all currently installed skills from skill-manifest.csv + const csvPath = path.join(bmadDir, '_config', 'skill-manifest.csv'); try { - const expanded = legacyDir.startsWith('~/') - ? path.join(os.homedir(), legacyDir.slice(2)) - : legacyDir === '~' - ? os.homedir() - : legacyDir; - - if (!(await fs.pathExists(expanded))) return; - - const entries = await fs.readdir(expanded); - const bmadFiles = entries.filter((e) => typeof e === 'string' && e.startsWith('bmad')); - - if (bmadFiles.length > 0 && !options.silent) { - await prompts.log.warn(`Found ${bmadFiles.length} stale BMAD file(s) in ${expanded}. Remove manually: rm ${expanded}/bmad-*`); + if (await fs.pathExists(csvPath)) { + const content = await fs.readFile(csvPath, 'utf8'); + const records = csv.parse(content, { columns: true, skip_empty_lines: true }); + for (const record of records) { + if (record.canonicalId) { + removals.add(record.canonicalId); + } + } } } catch { - // Errors reading global paths are silently ignored + // If we can't read the manifest, we still have the removal lists + } + + return removals; + } + + /** + * Load removal lists from all module sources in the bmad directory. + * Each module can have an optional removals.txt listing entries to remove. + * @param {string} bmadDir - BMAD installation directory + * @returns {Set} Set of entries to remove + */ + async loadRemovalLists(bmadDir) { + const removals = new Set(); + const { getProjectRoot } = require('../project-root'); + + // Read project-level removals.txt (covers core and bmm) + const projectRemovalsPath = path.join(getProjectRoot(), 'removals.txt'); + await this._readRemovalFile(projectRemovalsPath, removals); + + // Read per-module removals.txt from installed module directories + try { + const entries = await fs.readdir(bmadDir); + for (const entry of entries) { + if (entry.startsWith('_')) continue; + const removalPath = path.join(bmadDir, entry, 'removals.txt'); + await this._readRemovalFile(removalPath, removals); + } + } catch { + // bmadDir may not exist yet on fresh install + } + + return removals; + } + + /** + * Read a removals.txt file and add entries to the set + * @param {string} filePath - Path to removals.txt + * @param {Set} removals - Set to add entries to + */ + async _readRemovalFile(filePath, removals) { + try { + if (await fs.pathExists(filePath)) { + const content = await fs.readFile(filePath, 'utf8'); + for (const line of content.split('\n')) { + const trimmed = line.trim(); + if (trimmed && !trimmed.startsWith('#')) { + removals.add(trimmed); + } + } + } + } catch { + // Optional file — ignore errors } } /** - * Cleanup a specific target directory + * Cleanup a specific target directory. + * When removalSet is provided, only removes entries in that set. + * When removalSet is null (legacy dirs), removes all bmad-prefixed entries. * @param {string} projectDir - Project directory * @param {string} targetDir - Target directory to clean + * @param {Object} options - Cleanup options + * @param {Set|null} removalSet - Entries to remove, or null for legacy prefix matching */ - async cleanupTarget(projectDir, targetDir, options = {}) { + async cleanupTarget(projectDir, targetDir, options = {}, removalSet = new Set()) { const targetPath = path.join(projectDir, targetDir); if (!(await fs.pathExists(targetPath))) { return; } - // Remove all bmad* files + if (removalSet && removalSet.size === 0) { + return; + } + let entries; try { entries = await fs.readdir(targetPath); } catch { - // Directory exists but can't be read - skip cleanup return; } @@ -313,23 +380,26 @@ class ConfigDrivenIdeSetup { let removedCount = 0; for (const entry of entries) { - if (!entry || typeof entry !== 'string') { - continue; - } - if (entry.startsWith('bmad') && !entry.startsWith('bmad-os-')) { - const entryPath = path.join(targetPath, entry); + if (!entry || typeof entry !== 'string') continue; + + // Always preserve bmad-os-* utility skills regardless of cleanup mode + if (entry.startsWith('bmad-os-')) continue; + + // Surgical removal from set, or fallback to manifest+prefix detection when null + const shouldRemove = removalSet ? removalSet.has(entry) : isBmadOwnedEntry(entry, null); + + if (shouldRemove) { try { - await fs.remove(entryPath); + await fs.remove(path.join(targetPath, entry)); removedCount++; } catch { - // Skip entries that can't be removed (broken symlinks, permission errors) + // Skip entries that can't be removed } } } - if (removedCount > 0 && !options.silent) { - await prompts.log.message(` Cleaned ${removedCount} BMAD files from ${targetDir}`); - } + // Only log cleanup when it's not a routine reinstall (legacy dir cleanup or actual removals) + // Suppress for current target_dir since it's always cleaned before a fresh write // Remove empty directory after cleanup if (removedCount > 0) { @@ -339,7 +409,7 @@ class ConfigDrivenIdeSetup { await fs.remove(targetPath); } } catch { - // Directory may already be gone or in use — skip + // Directory may already be gone or in use } } } @@ -479,10 +549,9 @@ class ConfigDrivenIdeSetup { try { if (await fs.pathExists(candidatePath)) { const entries = await fs.readdir(candidatePath); - const hasBmad = entries.some( - (e) => typeof e === 'string' && e.toLowerCase().startsWith('bmad') && !e.toLowerCase().startsWith('bmad-os-'), - ); - if (hasBmad) { + const ancestorBmadDir = await this._findBmadDir(current); + const canonicalIds = await getInstalledCanonicalIds(ancestorBmadDir); + if (entries.some((e) => isBmadOwnedEntry(e, canonicalIds))) { return candidatePath; } } @@ -494,43 +563,6 @@ class ConfigDrivenIdeSetup { return null; } - - /** - * Walk up ancestor directories from relativeDir toward projectDir, removing each if empty - * Stops at projectDir boundary — never removes projectDir itself - * @param {string} projectDir - Project root (boundary) - * @param {string} relativeDir - Relative directory to start from - */ - async removeEmptyParents(projectDir, relativeDir) { - const resolvedProject = path.resolve(projectDir); - let current = relativeDir; - let last = null; - while (current && current !== '.' && current !== last) { - last = current; - const fullPath = path.resolve(projectDir, current); - // Boundary guard: never traverse outside projectDir - if (!fullPath.startsWith(resolvedProject + path.sep) && fullPath !== resolvedProject) break; - try { - if (!(await fs.pathExists(fullPath))) { - // Dir already gone — advance current; last is reset at top of next iteration - current = path.dirname(current); - continue; - } - const remaining = await fs.readdir(fullPath); - if (remaining.length > 0) break; - await fs.rmdir(fullPath); - } catch (error) { - // ENOTEMPTY: TOCTOU race (file added between readdir and rmdir) — skip level, continue upward - // ENOENT: dir removed by another process between pathExists and rmdir — skip level, continue upward - if (error.code === 'ENOTEMPTY' || error.code === 'ENOENT') { - current = path.dirname(current); - continue; - } - break; // fatal error (e.g. EACCES) — stop upward walk - } - current = path.dirname(current); - } - } } module.exports = { ConfigDrivenIdeSetup }; diff --git a/tools/installer/ide/manager.js b/tools/installer/ide/manager.js index ac49a8773..6370e4f41 100644 --- a/tools/installer/ide/manager.js +++ b/tools/installer/ide/manager.js @@ -160,8 +160,18 @@ class IdeManager { let detail = ''; if (handlerResult && handlerResult.results) { const r = handlerResult.results; - const count = r.skillDirectories || r.skills || 0; - if (count > 0) detail = `${count} skills`; + let count = r.skillDirectories || r.skills || 0; + // Dedup'd platform: report the count its peer wrote so the user sees + // a consistent picture across all platforms sharing the dir. + if (count === 0 && r.sharedTargetHandledByPeer && options.sharedSkillCount) { + count = options.sharedSkillCount; + } + const targetDir = handler.installerConfig?.target_dir || null; + if (count > 0 && targetDir) { + detail = `${count} skills → ${targetDir}`; + } else if (count > 0) { + detail = `${count} skills`; + } } // Propagate handler's success status (default true for backward compat) const success = handlerResult?.success !== false; @@ -172,6 +182,57 @@ class IdeManager { } } + /** + * Run setup for multiple IDEs as a single batch. + * Dedupes work when several selected platforms share the same target_dir: + * the first platform owns the directory write, peers skip it. + * @param {Array} ideList - IDE names to set up + * @param {string} projectDir + * @param {string} bmadDir + * @param {Object} [options] - Forwarded to each handler.setup + * @returns {Promise} Per-IDE results + */ + async setupBatch(ideList, projectDir, bmadDir, options = {}) { + await this.ensureInitialized(); + const results = []; + // target_dir → { firstIde, skillCount } from the platform that actually wrote it + const claimedTargets = new Map(); + + for (const ideName of ideList) { + const handler = this.handlers.get(ideName.toLowerCase()); + if (!handler) { + results.push(await this.setup(ideName, projectDir, bmadDir, options)); + continue; + } + + const target = handler.installerConfig?.target_dir || null; + const claim = target ? claimedTargets.get(target) : null; + const skipTarget = !!claim; + + const result = await this.setup(ideName, projectDir, bmadDir, { + ...options, + skipTarget, + sharedWith: claim?.firstIde || null, + sharedTarget: target, + sharedSkillCount: claim?.skillCount || 0, + }); + + if (target && !claim) { + const writtenCount = result.handlerResult?.results?.skillDirectories || result.handlerResult?.results?.skills || 0; + // Only claim the target when the install actually succeeded and wrote skills. + // If the first platform fails (ancestor conflict, exception, etc.), leave the + // dir unclaimed so the next peer becomes the new first writer instead of + // silently skipping into a broken/empty target_dir. + if (result.success && writtenCount > 0) { + claimedTargets.set(target, { firstIde: ideName, skillCount: writtenCount }); + } + } + results.push(result); + } + + return results; + } + /** * Cleanup IDE configurations * @param {string} projectDir - Project directory @@ -198,6 +259,8 @@ class IdeManager { * @param {string} projectDir - Project directory * @param {Array} ideList - List of IDE names to clean up * @param {Object} [options] - Cleanup options passed through to handlers + * options.remainingIdes - IDE names still installed after this cleanup; used + * to skip target_dir wipe when a co-installed platform shares the dir. * @returns {Array} Results array */ async cleanupByList(projectDir, ideList, options = {}) { @@ -211,13 +274,27 @@ class IdeManager { // Build lowercase lookup for case-insensitive matching const lowercaseHandlers = new Map([...this.handlers.entries()].map(([k, v]) => [k.toLowerCase(), v])); + // Resolve target_dirs for IDEs that will remain installed after this cleanup + const remainingTargets = new Set(); + if (Array.isArray(options.remainingIdes)) { + for (const remaining of options.remainingIdes) { + const h = lowercaseHandlers.get(String(remaining).toLowerCase()); + const t = h?.installerConfig?.target_dir; + if (t) remainingTargets.add(t); + } + } + for (const ideName of ideList) { const handler = lowercaseHandlers.get(ideName.toLowerCase()); if (!handler) continue; + const target = handler.installerConfig?.target_dir || null; + const skipTarget = target && remainingTargets.has(target); + const cleanupOptions = skipTarget ? { ...options, skipTarget: true } : options; + try { - await handler.cleanup(projectDir, options); - results.push({ ide: ideName, success: true }); + await handler.cleanup(projectDir, cleanupOptions); + results.push({ ide: ideName, success: true, skippedTarget: !!skipTarget }); } catch (error) { results.push({ ide: ideName, success: false, error: error.message }); } diff --git a/tools/installer/ide/platform-codes.js b/tools/installer/ide/platform-codes.js index 32d82e9cc..f29be8fcb 100644 --- a/tools/installer/ide/platform-codes.js +++ b/tools/installer/ide/platform-codes.js @@ -1,4 +1,4 @@ -const fs = require('fs-extra'); +const fs = require('../fs-native'); const path = require('node:path'); const yaml = require('yaml'); diff --git a/tools/installer/ide/platform-codes.yaml b/tools/installer/ide/platform-codes.yaml index 4b08046f1..0f49a7fbe 100644 --- a/tools/installer/ide/platform-codes.yaml +++ b/tools/installer/ide/platform-codes.yaml @@ -5,122 +5,203 @@ # preferred: Whether shown as a recommended option on install # suspended: (optional) Message explaining why install is blocked # installer: -# target_dir: Directory where skill directories are installed -# legacy_targets: (optional) Old target dirs to clean up on reinstall +# target_dir: Directory where skill directories are installed (project/workspace) +# global_target_dir: (optional) User-home directory for global install # ancestor_conflict_check: (optional) Refuse install when ancestor dir has BMAD files +# +# Multiple platforms may share the same target_dir or global_target_dir — many tools +# read from the shared `.agents/skills/` and `~/.agents/skills/` cross-tool standard. +# Paths verified against each tool's primary docs as of 2026-04-25. platforms: + adal: + name: "AdaL" + preferred: false + installer: + target_dir: .adal/skills + global_target_dir: ~/.adal/skills + + amp: + name: "Sourcegraph Amp" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.config/agents/skills + antigravity: name: "Google Antigravity" preferred: false installer: - legacy_targets: - - .agent/workflows target_dir: .agent/skills + global_target_dir: ~/.gemini/antigravity/skills auggie: name: "Auggie" preferred: false installer: - legacy_targets: - - .augment/commands - target_dir: .augment/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + bob: + name: "IBM Bob" + preferred: false + installer: + target_dir: .bob/skills + global_target_dir: ~/.bob/skills claude-code: name: "Claude Code" preferred: true installer: - legacy_targets: - - .claude/commands target_dir: .claude/skills + global_target_dir: ~/.claude/skills cline: name: "Cline" preferred: false installer: - legacy_targets: - - .clinerules/workflows target_dir: .cline/skills + global_target_dir: ~/.cline/skills codex: name: "Codex" - preferred: false + preferred: true installer: - legacy_targets: - - .codex/prompts - - ~/.codex/prompts target_dir: .agents/skills + global_target_dir: ~/.codex/skills codebuddy: name: "CodeBuddy" preferred: false installer: - legacy_targets: - - .codebuddy/commands target_dir: .codebuddy/skills + global_target_dir: ~/.codebuddy/skills + + command-code: + name: "Command Code" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + cortex: + name: "Snowflake Cortex Code" + preferred: false + installer: + target_dir: .cortex/skills + global_target_dir: ~/.snowflake/cortex/skills crush: name: "Crush" preferred: false installer: - legacy_targets: - - .crush/commands - target_dir: .crush/skills + target_dir: .agents/skills + global_target_dir: ~/.config/agents/skills cursor: name: "Cursor" preferred: true installer: - legacy_targets: - - .cursor/commands - target_dir: .cursor/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + droid: + name: "Factory Droid" + preferred: false + installer: + target_dir: .factory/skills + global_target_dir: ~/.factory/skills + + firebender: + name: "Firebender" + preferred: false + installer: + target_dir: .firebender/skills + global_target_dir: ~/.agents/skills gemini: name: "Gemini CLI" preferred: false installer: - legacy_targets: - - .gemini/commands - target_dir: .gemini/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills github-copilot: name: "GitHub Copilot" + preferred: true + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + goose: + name: "Block Goose" preferred: false installer: - legacy_targets: - - .github/agents - - .github/prompts - target_dir: .github/skills + target_dir: .agents/skills + global_target_dir: ~/.config/agents/skills iflow: name: "iFlow" preferred: false installer: - legacy_targets: - - .iflow/commands target_dir: .iflow/skills + global_target_dir: ~/.iflow/skills junie: name: "Junie" preferred: false installer: - target_dir: .agents/skills + target_dir: .junie/skills + global_target_dir: ~/.junie/skills kilo: name: "KiloCoder" preferred: false installer: - legacy_targets: - - .kilocode/workflows - target_dir: .kilocode/skills + target_dir: .agents/skills + global_target_dir: ~/.kilocode/skills + + kimi-code: + name: "Kimi Code" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills kiro: name: "Kiro" preferred: false installer: - legacy_targets: - - .kiro/steering target_dir: .kiro/skills + global_target_dir: ~/.kiro/skills + + kode: + name: "Kode" + preferred: false + installer: + target_dir: .kode/skills + global_target_dir: ~/.kode/skills + + mistral-vibe: + name: "Mistral Vibe" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.vibe/skills + + mux: + name: "Mux" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + neovate: + name: "Neovate" + preferred: false + installer: + target_dir: .neovate/skills + global_target_dir: ~/.neovate/skills ona: name: "Ona" @@ -128,65 +209,98 @@ platforms: installer: target_dir: .ona/skills + openclaw: + name: "OpenClaw" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + opencode: name: "OpenCode" preferred: false installer: - legacy_targets: - - .opencode/agents - - .opencode/commands - - .opencode/agent - - .opencode/command - target_dir: .opencode/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + openhands: + name: "OpenHands" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills pi: name: "Pi" preferred: false installer: - target_dir: .pi/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + pochi: + name: "Pochi" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills qoder: name: "Qoder" preferred: false installer: target_dir: .qoder/skills + global_target_dir: ~/.qoder/skills qwen: name: "QwenCoder" preferred: false installer: - legacy_targets: - - .qwen/commands target_dir: .qwen/skills + global_target_dir: ~/.qwen/skills + + replit: + name: "Replit Agent" + preferred: false + installer: + target_dir: .agents/skills roo: name: "Roo Code" preferred: false installer: - legacy_targets: - - .roo/commands - target_dir: .roo/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills rovo-dev: name: "Rovo Dev" preferred: false installer: - legacy_targets: - - .rovodev/workflows - target_dir: .rovodev/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills trae: name: "Trae" preferred: false installer: - legacy_targets: - - .trae/rules target_dir: .trae/skills + warp: + name: "Warp" + preferred: false + installer: + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + windsurf: name: "Windsurf" preferred: false installer: - legacy_targets: - - .windsurf/workflows - target_dir: .windsurf/skills + target_dir: .agents/skills + global_target_dir: ~/.agents/skills + + zencoder: + name: "Zencoder" + preferred: false + installer: + target_dir: .zencoder/skills + global_target_dir: ~/.zencoder/skills diff --git a/tools/installer/ide/shared/agent-command-generator.js b/tools/installer/ide/shared/agent-command-generator.js deleted file mode 100644 index 0fc1b04dc..000000000 --- a/tools/installer/ide/shared/agent-command-generator.js +++ /dev/null @@ -1,180 +0,0 @@ -const path = require('node:path'); -const fs = require('fs-extra'); -const { toColonPath, toDashPath, customAgentColonName, customAgentDashName, BMAD_FOLDER_NAME } = require('./path-utils'); - -/** - * Generates launcher command files for each agent - */ -class AgentCommandGenerator { - constructor(bmadFolderName = BMAD_FOLDER_NAME) { - this.templatePath = path.join(__dirname, '../templates/agent-command-template.md'); - this.bmadFolderName = bmadFolderName; - } - - /** - * Collect agent artifacts for IDE installation - * @param {string} bmadDir - BMAD installation directory - * @param {Array} selectedModules - Modules to include - * @returns {Object} Artifacts array with metadata - */ - async collectAgentArtifacts(bmadDir, selectedModules = []) { - const { getAgentsFromBmad } = require('./bmad-artifacts'); - - // Get agents from INSTALLED bmad/ directory - const agents = await getAgentsFromBmad(bmadDir, selectedModules); - - const artifacts = []; - - for (const agent of agents) { - const launcherContent = await this.generateLauncherContent(agent); - // Use relativePath if available (for nested agents), otherwise just name with .md - const agentPathInModule = agent.relativePath || `${agent.name}.md`; - // Calculate the relative agent path (e.g., bmm/agents/pm.md) - let agentRelPath = agent.path || ''; - // Normalize path separators for cross-platform compatibility - agentRelPath = agentRelPath.replaceAll('\\', '/'); - // Remove _bmad/ prefix if present to get relative path from project root - // Handle both absolute paths (/path/to/_bmad/...) and relative paths (_bmad/...) - if (agentRelPath.includes('_bmad/')) { - const parts = agentRelPath.split(/_bmad\//); - if (parts.length > 1) { - agentRelPath = parts.slice(1).join('/'); - } - } - artifacts.push({ - type: 'agent-launcher', - name: agent.name, - description: agent.description || `${agent.name} agent`, - module: agent.module, - canonicalId: agent.canonicalId || '', - relativePath: path.join(agent.module, 'agents', agentPathInModule), // For command filename - agentPath: agentRelPath, // Relative path to actual agent file - content: launcherContent, - sourcePath: agent.path, - }); - } - - return { - artifacts, - counts: { - agents: agents.length, - }, - }; - } - - /** - * Generate launcher content for an agent - * @param {Object} agent - Agent metadata - * @returns {string} Launcher file content - */ - async generateLauncherContent(agent) { - // Load the template - const template = await fs.readFile(this.templatePath, 'utf8'); - - // Replace template variables - // Use relativePath if available (for nested agents), otherwise just name with .md - const agentPathInModule = agent.relativePath || `${agent.name}.md`; - return template - .replaceAll('{{name}}', agent.name) - .replaceAll('{{module}}', agent.module) - .replaceAll('{{path}}', agentPathInModule) - .replaceAll('{{description}}', agent.description || `${agent.name} agent`) - .replaceAll('_bmad', this.bmadFolderName) - .replaceAll('_bmad', '_bmad'); - } - - /** - * Write agent launcher artifacts to IDE commands directory - * @param {string} baseCommandsDir - Base commands directory for the IDE - * @param {Array} artifacts - Agent launcher artifacts - * @returns {number} Count of launchers written - */ - async writeAgentLaunchers(baseCommandsDir, artifacts) { - let writtenCount = 0; - - for (const artifact of artifacts) { - if (artifact.type === 'agent-launcher') { - const moduleAgentsDir = path.join(baseCommandsDir, artifact.module, 'agents'); - await fs.ensureDir(moduleAgentsDir); - - const launcherPath = path.join(moduleAgentsDir, `${artifact.name}.md`); - await fs.writeFile(launcherPath, artifact.content); - writtenCount++; - } - } - - return writtenCount; - } - - /** - * Write agent launcher artifacts using underscore format (Windows-compatible) - * Creates flat files like: bmad_bmm_pm.md - * - * @param {string} baseCommandsDir - Base commands directory for the IDE - * @param {Array} artifacts - Agent launcher artifacts - * @returns {number} Count of launchers written - */ - async writeColonArtifacts(baseCommandsDir, artifacts) { - let writtenCount = 0; - - for (const artifact of artifacts) { - if (artifact.type === 'agent-launcher') { - // Convert relativePath to underscore format: bmm/agents/pm.md → bmad_bmm_pm.md - const flatName = toColonPath(artifact.relativePath); - const launcherPath = path.join(baseCommandsDir, flatName); - await fs.ensureDir(path.dirname(launcherPath)); - await fs.writeFile(launcherPath, artifact.content); - writtenCount++; - } - } - - return writtenCount; - } - - /** - * Write agent launcher artifacts using dash format (NEW STANDARD) - * Creates flat files like: bmad-agent-bmm-pm.md - * - * The bmad-agent- prefix distinguishes agents from workflows/tasks/tools. - * - * @param {string} baseCommandsDir - Base commands directory for the IDE - * @param {Array} artifacts - Agent launcher artifacts - * @returns {number} Count of launchers written - */ - async writeDashArtifacts(baseCommandsDir, artifacts) { - let writtenCount = 0; - - for (const artifact of artifacts) { - if (artifact.type === 'agent-launcher') { - // Convert relativePath to dash format: bmm/agents/pm.md → bmad-agent-bmm-pm.md - const flatName = toDashPath(artifact.relativePath); - const launcherPath = path.join(baseCommandsDir, flatName); - await fs.ensureDir(path.dirname(launcherPath)); - await fs.writeFile(launcherPath, artifact.content); - writtenCount++; - } - } - - return writtenCount; - } - - /** - * Get the custom agent name in underscore format (Windows-compatible) - * @param {string} agentName - Custom agent name - * @returns {string} Underscore-formatted filename - */ - getCustomAgentColonName(agentName) { - return customAgentColonName(agentName); - } - - /** - * Get the custom agent name in underscore format (Windows-compatible) - * @param {string} agentName - Custom agent name - * @returns {string} Underscore-formatted filename - */ - getCustomAgentDashName(agentName) { - return customAgentDashName(agentName); - } -} - -module.exports = { AgentCommandGenerator }; diff --git a/tools/installer/ide/shared/bmad-artifacts.js b/tools/installer/ide/shared/bmad-artifacts.js deleted file mode 100644 index ac0dbd190..000000000 --- a/tools/installer/ide/shared/bmad-artifacts.js +++ /dev/null @@ -1,208 +0,0 @@ -const path = require('node:path'); -const fs = require('fs-extra'); -const { loadSkillManifest, getCanonicalId } = require('./skill-manifest'); - -/** - * Helpers for gathering BMAD agents/tasks from the installed tree. - * Shared by installers that need Claude-style exports. - * - * TODO: Dead code cleanup — compiled XML agents are retired. - * - * All agents now use the SKILL.md directory format with bmad-skill-manifest.yaml - * (type: agent). The legacy pipeline below only discovers compiled .md files - * containing XML tags, which no longer exist. The following are dead: - * - * - getAgentsFromBmad() — scans {module}/agents/ for .md files with tags - * - getAgentsFromDir() — recursive helper for the above - * - AgentCommandGenerator — (agent-command-generator.js) generates launcher .md files - * that tell the LLM to load a compiled agent .md file - * - agent-command-template.md — (templates/) the launcher template with hardcoded - * {module}/agents/{{path}} reference - * - * Agent metadata for agent-manifest.csv is now handled entirely by - * ManifestGenerator.getAgentsFromDirRecursive() in manifest-generator.js, - * which walks the full module tree and finds type:agent directories. - * - * IDE installation of agents is handled by the native skill pipeline — - * each agent's SKILL.md directory is installed directly to the IDE's - * skills path, so no launcher intermediary is needed. - * - * Cleanup: remove getAgentsFromBmad, getAgentsFromDir, their exports, - * AgentCommandGenerator, agent-command-template.md, and all call sites - * in IDE installers that invoke collectAgentArtifacts / writeAgentLaunchers / - * writeColonArtifacts / writeDashArtifacts. - * getTasksFromBmad and getTasksFromDir may still be live — verify before removing. - */ -async function getAgentsFromBmad(bmadDir, selectedModules = []) { - const agents = []; - - // Get core agents - if (await fs.pathExists(path.join(bmadDir, 'core', 'agents'))) { - const coreAgents = await getAgentsFromDir(path.join(bmadDir, 'core', 'agents'), 'core'); - agents.push(...coreAgents); - } - - // Get module agents - for (const moduleName of selectedModules) { - const agentsPath = path.join(bmadDir, moduleName, 'agents'); - - if (await fs.pathExists(agentsPath)) { - const moduleAgents = await getAgentsFromDir(agentsPath, moduleName); - agents.push(...moduleAgents); - } - } - - // Get standalone agents from bmad/agents/ directory - const standaloneAgentsDir = path.join(bmadDir, 'agents'); - if (await fs.pathExists(standaloneAgentsDir)) { - const agentDirs = await fs.readdir(standaloneAgentsDir, { withFileTypes: true }); - - for (const agentDir of agentDirs) { - if (!agentDir.isDirectory()) continue; - - const agentDirPath = path.join(standaloneAgentsDir, agentDir.name); - const agentFiles = await fs.readdir(agentDirPath); - const skillManifest = await loadSkillManifest(agentDirPath); - - for (const file of agentFiles) { - if (!file.endsWith('.md')) continue; - if (file.includes('.customize.')) continue; - - const filePath = path.join(agentDirPath, file); - const content = await fs.readFile(filePath, 'utf8'); - - if (content.includes('localskip="true"')) continue; - - agents.push({ - path: filePath, - name: file.replace('.md', ''), - module: 'standalone', // Mark as standalone agent - canonicalId: getCanonicalId(skillManifest, file), - }); - } - } - } - - return agents; -} - -async function getTasksFromBmad(bmadDir, selectedModules = []) { - const tasks = []; - - if (await fs.pathExists(path.join(bmadDir, 'core', 'tasks'))) { - const coreTasks = await getTasksFromDir(path.join(bmadDir, 'core', 'tasks'), 'core'); - tasks.push(...coreTasks); - } - - for (const moduleName of selectedModules) { - const tasksPath = path.join(bmadDir, moduleName, 'tasks'); - - if (await fs.pathExists(tasksPath)) { - const moduleTasks = await getTasksFromDir(tasksPath, moduleName); - tasks.push(...moduleTasks); - } - } - - return tasks; -} - -async function getAgentsFromDir(dirPath, moduleName, relativePath = '') { - const agents = []; - - if (!(await fs.pathExists(dirPath))) { - return agents; - } - - const entries = await fs.readdir(dirPath, { withFileTypes: true }); - const skillManifest = await loadSkillManifest(dirPath); - - for (const entry of entries) { - // Skip if entry.name is undefined or not a string - if (!entry.name || typeof entry.name !== 'string') { - continue; - } - - const fullPath = path.join(dirPath, entry.name); - const newRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name; - - if (entry.isDirectory()) { - // Recurse into subdirectories - const subDirAgents = await getAgentsFromDir(fullPath, moduleName, newRelativePath); - agents.push(...subDirAgents); - } else if (entry.name.endsWith('.md')) { - // Skip README files and other non-agent files - if (entry.name.toLowerCase() === 'readme.md' || entry.name.toLowerCase().startsWith('readme-')) { - continue; - } - - if (entry.name.includes('.customize.')) { - continue; - } - - const content = await fs.readFile(fullPath, 'utf8'); - - if (content.includes('localskip="true"')) { - continue; - } - - // Only include files that have agent-specific content (compiled agents have tag) - if (!content.includes('>} Set of canonicalIds, or empty set if manifest missing + */ +async function getInstalledCanonicalIds(bmadDir) { + const ids = new Set(); + if (!bmadDir) return ids; + + const csvPath = path.join(bmadDir, '_config', 'skill-manifest.csv'); + if (!(await fs.pathExists(csvPath))) return ids; + + try { + const content = await fs.readFile(csvPath, 'utf8'); + const records = csv.parse(content, { columns: true, skip_empty_lines: true }); + for (const record of records) { + if (record.canonicalId) ids.add(record.canonicalId); + } + } catch { + // Unreadable/invalid manifest — treat as no info + } + + return ids; +} + +/** + * Test whether a directory entry is BMAD-owned. + * Prefers the manifest's canonicalIds; falls back to the legacy "bmad" prefix + * when no manifest is available (early install, ancestor lookup with no bmad dir). + * + * @param {string} entry - Directory entry name + * @param {Set|null} canonicalIds - From getInstalledCanonicalIds, or null + * @returns {boolean} + */ +function isBmadOwnedEntry(entry, canonicalIds) { + if (!entry || typeof entry !== 'string') return false; + if (entry.toLowerCase().startsWith('bmad-os-')) return false; + if (canonicalIds && canonicalIds.size > 0) return canonicalIds.has(entry); + return entry.toLowerCase().startsWith('bmad'); +} + +module.exports = { getInstalledCanonicalIds, isBmadOwnedEntry }; diff --git a/tools/installer/ide/shared/module-injections.js b/tools/installer/ide/shared/module-injections.js deleted file mode 100644 index 3090c5da4..000000000 --- a/tools/installer/ide/shared/module-injections.js +++ /dev/null @@ -1,136 +0,0 @@ -const path = require('node:path'); -const fs = require('fs-extra'); -const yaml = require('yaml'); -const { glob } = require('glob'); -const { getSourcePath } = require('../../project-root'); - -async function loadModuleInjectionConfig(handler, moduleName) { - const sourceModulesPath = getSourcePath('modules'); - const handlerBaseDir = path.join(sourceModulesPath, moduleName, 'sub-modules', handler); - const configPath = path.join(handlerBaseDir, 'injections.yaml'); - - if (!(await fs.pathExists(configPath))) { - return null; - } - - const configContent = await fs.readFile(configPath, 'utf8'); - const config = yaml.parse(configContent) || {}; - - return { - config, - handlerBaseDir, - configPath, - }; -} - -function shouldApplyInjection(injection, subagentChoices) { - if (!subagentChoices || subagentChoices.install === 'none') { - return false; - } - - if (subagentChoices.install === 'all') { - return true; - } - - if (subagentChoices.install === 'selective') { - const selected = subagentChoices.selected || []; - - if (injection.requires === 'any' && selected.length > 0) { - return true; - } - - if (injection.requires) { - const required = `${injection.requires}.md`; - return selected.includes(required); - } - - if (injection.point) { - const selectedNames = selected.map((file) => file.replace('.md', '')); - return selectedNames.some((name) => injection.point.includes(name)); - } - } - - return false; -} - -function filterAgentInstructions(content, selectedFiles) { - if (!selectedFiles || selectedFiles.length === 0) { - return ''; - } - - const selectedAgents = selectedFiles.map((file) => file.replace('.md', '')); - const lines = content.split('\n'); - const filteredLines = []; - - for (const line of lines) { - if (line.includes('')) { - filteredLines.push(line); - } else if (line.includes('subagent')) { - let shouldInclude = false; - for (const agent of selectedAgents) { - if (line.includes(agent)) { - shouldInclude = true; - break; - } - } - - if (shouldInclude) { - filteredLines.push(line); - } - } else if (line.includes('When creating PRDs') || line.includes('ACTIVELY delegate')) { - filteredLines.push(line); - } - } - - if (filteredLines.length > 2) { - return filteredLines.join('\n'); - } - - return ''; -} - -async function resolveSubagentFiles(handlerBaseDir, subagentConfig, subagentChoices) { - if (!subagentConfig || !subagentConfig.files) { - return []; - } - - if (!subagentChoices || subagentChoices.install === 'none') { - return []; - } - - let filesToCopy = subagentConfig.files; - - if (subagentChoices.install === 'selective') { - filesToCopy = subagentChoices.selected || []; - } - - const sourceDir = path.join(handlerBaseDir, subagentConfig.source || ''); - const resolved = []; - - for (const file of filesToCopy) { - // Use forward slashes for glob pattern (works on both Windows and Unix) - // Convert backslashes to forward slashes for glob compatibility - const normalizedSourceDir = sourceDir.replaceAll('\\', '/'); - const pattern = `${normalizedSourceDir}/**/${file}`; - const matches = await glob(pattern); - - if (matches.length > 0) { - const absolutePath = matches[0]; - resolved.push({ - file, - absolutePath, - relativePath: path.relative(sourceDir, absolutePath), - sourceDir, - }); - } - } - - return resolved; -} - -module.exports = { - loadModuleInjectionConfig, - shouldApplyInjection, - filterAgentInstructions, - resolveSubagentFiles, -}; diff --git a/tools/installer/ide/shared/path-utils.js b/tools/installer/ide/shared/path-utils.js index 35fc263f4..6d7c2c9fa 100644 --- a/tools/installer/ide/shared/path-utils.js +++ b/tools/installer/ide/shared/path-utils.js @@ -15,8 +15,6 @@ * - standalone/agents/fred.md → bmad-agent-standalone-fred.md */ -// Type segments - agents are included in naming, others are filtered out -const TYPE_SEGMENTS = ['workflows', 'tasks', 'tools']; const AGENT_SEGMENT = 'agents'; // BMAD installation folder name - centralized constant for all installers @@ -194,125 +192,6 @@ function parseDashName(filename) { }; } -// ============================================================================ -// LEGACY FUNCTIONS (underscore format) - kept for backward compatibility -// ============================================================================ - -/** - * Convert hierarchical path to flat underscore-separated name (LEGACY) - * @deprecated Use toDashName instead - */ -function toUnderscoreName(module, type, name) { - const isAgent = type === AGENT_SEGMENT; - if (module === 'core') { - return isAgent ? `bmad_agent_${name}.md` : `bmad_${name}.md`; - } - if (module === 'standalone') { - return isAgent ? `bmad_agent_standalone_${name}.md` : `bmad_standalone_${name}.md`; - } - return isAgent ? `bmad_${module}_agent_${name}.md` : `bmad_${module}_${name}.md`; -} - -/** - * Convert relative path to flat underscore-separated name (LEGACY) - * @deprecated Use toDashPath instead - */ -function toUnderscorePath(relativePath) { - // Strip common file extensions (same as toDashPath for consistency) - const withoutExt = relativePath.replace(/\.(md|yaml|yml|json|xml|toml)$/i, ''); - const parts = withoutExt.split(/[/\\]/); - - const module = parts[0]; - const type = parts[1]; - const name = parts.slice(2).join('_'); - - return toUnderscoreName(module, type, name); -} - -/** - * Create custom agent underscore name (LEGACY) - * @deprecated Use customAgentDashName instead - */ -function customAgentUnderscoreName(agentName) { - return `bmad_custom_${agentName}.md`; -} - -/** - * Check if a filename uses underscore format (LEGACY) - * @deprecated Use isDashFormat instead - */ -function isUnderscoreFormat(filename) { - return filename.startsWith('bmad_') && filename.includes('_'); -} - -/** - * Extract parts from an underscore-formatted filename (LEGACY) - * @deprecated Use parseDashName instead - */ -function parseUnderscoreName(filename) { - const withoutExt = filename.replace('.md', ''); - const parts = withoutExt.split('_'); - - if (parts.length < 2 || parts[0] !== 'bmad') { - return null; - } - - const agentIndex = parts.indexOf('agent'); - - if (agentIndex !== -1) { - if (agentIndex === 1) { - // bmad_agent_... - check for standalone - if (parts.length >= 4 && parts[2] === 'standalone') { - return { - prefix: parts[0], - module: 'standalone', - type: 'agents', - name: parts.slice(3).join('_'), - }; - } - return { - prefix: parts[0], - module: 'core', - type: 'agents', - name: parts.slice(agentIndex + 1).join('_'), - }; - } else { - return { - prefix: parts[0], - module: parts[1], - type: 'agents', - name: parts.slice(agentIndex + 1).join('_'), - }; - } - } - - if (parts.length === 2) { - return { - prefix: parts[0], - module: 'core', - type: 'workflows', - name: parts[1], - }; - } - - // Check for standalone non-agent: bmad_standalone_name - if (parts[1] === 'standalone') { - return { - prefix: parts[0], - module: 'standalone', - type: 'workflows', - name: parts.slice(2).join('_'), - }; - } - - return { - prefix: parts[0], - module: parts[1], - type: 'workflows', - name: parts.slice(2).join('_'), - }; -} - /** * Resolve the skill name for an artifact. * Prefers canonicalId from a bmad-skill-manifest.yaml sidecar when available, @@ -328,37 +207,13 @@ function resolveSkillName(artifact) { return toDashPath(artifact.relativePath); } -// Backward compatibility aliases (colon format was same as underscore) -const toColonName = toUnderscoreName; -const toColonPath = toUnderscorePath; -const customAgentColonName = customAgentUnderscoreName; -const isColonFormat = isUnderscoreFormat; -const parseColonName = parseUnderscoreName; - module.exports = { - // New standard (dash-based) toDashName, toDashPath, resolveSkillName, customAgentDashName, isDashFormat, parseDashName, - - // Legacy (underscore-based) - kept for backward compatibility - toUnderscoreName, - toUnderscorePath, - customAgentUnderscoreName, - isUnderscoreFormat, - parseUnderscoreName, - - // Backward compatibility aliases - toColonName, - toColonPath, - customAgentColonName, - isColonFormat, - parseColonName, - - TYPE_SEGMENTS, AGENT_SEGMENT, BMAD_FOLDER_NAME, }; diff --git a/tools/installer/ide/shared/skill-manifest.js b/tools/installer/ide/shared/skill-manifest.js index c5ae4aed8..1dfc7eb35 100644 --- a/tools/installer/ide/shared/skill-manifest.js +++ b/tools/installer/ide/shared/skill-manifest.js @@ -1,5 +1,5 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../../fs-native'); const yaml = require('yaml'); /** @@ -54,19 +54,4 @@ function getArtifactType(manifest, filename) { return null; } -/** - * Get the install_to_bmad flag for a specific file from a loaded skill manifest. - * @param {Object|null} manifest - Loaded manifest (from loadSkillManifest) - * @param {string} filename - Source filename to look up - * @returns {boolean} install_to_bmad value (defaults to true) - */ -function getInstallToBmad(manifest, filename) { - if (!manifest) return true; - // Single-entry manifest applies to all files in the directory - if (manifest.__single) return manifest.__single.install_to_bmad !== false; - // Multi-entry: look up by filename directly - if (manifest[filename]) return manifest[filename].install_to_bmad !== false; - return true; -} - -module.exports = { loadSkillManifest, getCanonicalId, getArtifactType, getInstallToBmad }; +module.exports = { loadSkillManifest, getCanonicalId, getArtifactType }; diff --git a/tools/installer/ide/templates/agent-command-template.md b/tools/installer/ide/templates/agent-command-template.md deleted file mode 100644 index 0f0c2e20d..000000000 --- a/tools/installer/ide/templates/agent-command-template.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: '{{name}}' -description: '{{description}}' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from {project-root}/_bmad/{{module}}/agents/{{path}} -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/tools/installer/ide/templates/combined/antigravity.md b/tools/installer/ide/templates/combined/antigravity.md deleted file mode 100644 index 88e806e9d..000000000 --- a/tools/installer/ide/templates/combined/antigravity.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: '{{name}}' -description: '{{description}}' ---- - -Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}} - -Follow all instructions in the workflow file exactly as written. diff --git a/tools/installer/ide/templates/combined/claude-agent.md b/tools/installer/ide/templates/combined/claude-agent.md deleted file mode 120000 index 9f6c17b45..000000000 --- a/tools/installer/ide/templates/combined/claude-agent.md +++ /dev/null @@ -1 +0,0 @@ -default-agent.md \ No newline at end of file diff --git a/tools/installer/ide/templates/combined/claude-workflow.md b/tools/installer/ide/templates/combined/claude-workflow.md deleted file mode 120000 index 8d4ae5238..000000000 --- a/tools/installer/ide/templates/combined/claude-workflow.md +++ /dev/null @@ -1 +0,0 @@ -default-workflow.md \ No newline at end of file diff --git a/tools/installer/ide/templates/combined/default-agent.md b/tools/installer/ide/templates/combined/default-agent.md deleted file mode 100644 index f8ad93801..000000000 --- a/tools/installer/ide/templates/combined/default-agent.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: '{{name}}' -description: '{{description}}' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from {project-root}/_bmad/{{path}} -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. FOLLOW every step in the section precisely -4. DISPLAY the welcome/greeting as instructed -5. PRESENT the numbered menu -6. WAIT for user input before proceeding - diff --git a/tools/installer/ide/templates/combined/default-task.md b/tools/installer/ide/templates/combined/default-task.md deleted file mode 100644 index b865d6ffb..000000000 --- a/tools/installer/ide/templates/combined/default-task.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: '{{name}}' -description: '{{description}}' ---- - -# {{name}} - -Read the entire task file at: {project-root}/{{bmadFolderName}}/{{path}} - -Follow all instructions in the task file exactly as written. diff --git a/tools/installer/ide/templates/combined/default-tool.md b/tools/installer/ide/templates/combined/default-tool.md deleted file mode 100644 index 11c6aac8d..000000000 --- a/tools/installer/ide/templates/combined/default-tool.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: '{{name}}' -description: '{{description}}' ---- - -# {{name}} - -Read the entire tool file at: {project-root}/{{bmadFolderName}}/{{path}} - -Follow all instructions in the tool file exactly as written. diff --git a/tools/installer/ide/templates/combined/default-workflow.md b/tools/installer/ide/templates/combined/default-workflow.md deleted file mode 100644 index c8ad40459..000000000 --- a/tools/installer/ide/templates/combined/default-workflow.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -name: '{{name}}' -description: '{{description}}' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL {project-root}/{{bmadFolderName}}/{{path}}, READ its entire contents and follow its directions exactly! diff --git a/tools/installer/ide/templates/combined/gemini-agent.toml b/tools/installer/ide/templates/combined/gemini-agent.toml deleted file mode 100644 index ae5f791cf..000000000 --- a/tools/installer/ide/templates/combined/gemini-agent.toml +++ /dev/null @@ -1,14 +0,0 @@ -description = "Activates the {{name}} agent from the BMad Method." -prompt = """ -CRITICAL: You are now the BMad '{{name}}' agent. - -PRE-FLIGHT CHECKLIST: -1. [ ] IMMEDIATE ACTION: Load and parse {project-root}/{{bmadFolderName}}/{{module}}/config.yaml - store ALL config values in memory for use throughout the session. -2. [ ] IMMEDIATE ACTION: Read and internalize the full agent definition at {project-root}/{{bmadFolderName}}/{{path}}. -3. [ ] CONFIRM: The user's name from config is {user_name}. - -Only after all checks are complete, greet the user by name and display the menu. -Acknowledge this checklist is complete in your first response. - -AGENT DEFINITION: {project-root}/{{bmadFolderName}}/{{path}} -""" diff --git a/tools/installer/ide/templates/combined/gemini-task.toml b/tools/installer/ide/templates/combined/gemini-task.toml deleted file mode 100644 index 7d15e2164..000000000 --- a/tools/installer/ide/templates/combined/gemini-task.toml +++ /dev/null @@ -1,11 +0,0 @@ -description = "Executes the {{name}} task from the BMAD Method." -prompt = """ -Execute the BMAD '{{name}}' task. - -TASK INSTRUCTIONS: -1. LOAD the task file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents -3. FOLLOW every instruction precisely as specified - -TASK FILE: {project-root}/{{bmadFolderName}}/{{path}} -""" diff --git a/tools/installer/ide/templates/combined/gemini-tool.toml b/tools/installer/ide/templates/combined/gemini-tool.toml deleted file mode 100644 index fc78c6b72..000000000 --- a/tools/installer/ide/templates/combined/gemini-tool.toml +++ /dev/null @@ -1,11 +0,0 @@ -description = "Executes the {{name}} tool from the BMAD Method." -prompt = """ -Execute the BMAD '{{name}}' tool. - -TOOL INSTRUCTIONS: -1. LOAD the tool file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents -3. FOLLOW every instruction precisely as specified - -TOOL FILE: {project-root}/{{bmadFolderName}}/{{path}} -""" diff --git a/tools/installer/ide/templates/combined/gemini-workflow-yaml.toml b/tools/installer/ide/templates/combined/gemini-workflow-yaml.toml deleted file mode 100644 index bc6c8da39..000000000 --- a/tools/installer/ide/templates/combined/gemini-workflow-yaml.toml +++ /dev/null @@ -1,16 +0,0 @@ -description = '{{description}}' -prompt = """ -Execute the BMAD '{{name}}' workflow. - -CRITICAL: This is a structured YAML workflow. Follow these steps precisely: - -1. LOAD the workflow definition from {project-root}/{{bmadFolderName}}/{{workflow_path}} -2. PARSE the YAML structure to understand: - - Workflow phases and steps - - Required inputs and outputs - - Dependencies between steps -3. EXECUTE each step in order -4. VALIDATE outputs before proceeding to next step - -WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}} -""" diff --git a/tools/installer/ide/templates/combined/gemini-workflow.toml b/tools/installer/ide/templates/combined/gemini-workflow.toml deleted file mode 100644 index 3306cce04..000000000 --- a/tools/installer/ide/templates/combined/gemini-workflow.toml +++ /dev/null @@ -1,14 +0,0 @@ -description = '{{description}}' -prompt = """ -Execute the BMAD '{{name}}' workflow. - -CRITICAL: You must load and follow the workflow definition exactly. - -WORKFLOW INSTRUCTIONS: -1. LOAD the workflow file from {project-root}/{{bmadFolderName}}/{{workflow_path}} -2. READ its entire contents -3. FOLLOW every step precisely as specified -4. DO NOT skip or modify any steps - -WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}} -""" diff --git a/tools/installer/ide/templates/combined/kiro-agent.md b/tools/installer/ide/templates/combined/kiro-agent.md deleted file mode 100644 index e2c2a83fa..000000000 --- a/tools/installer/ide/templates/combined/kiro-agent.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -inclusion: manual ---- - -# {{name}} - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from #[[file:{{bmadFolderName}}/{{path}}]] -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. FOLLOW every step in the section precisely -4. DISPLAY the welcome/greeting as instructed -5. PRESENT the numbered menu -6. WAIT for user input before proceeding - diff --git a/tools/installer/ide/templates/combined/kiro-task.md b/tools/installer/ide/templates/combined/kiro-task.md deleted file mode 100644 index 8952e5ee2..000000000 --- a/tools/installer/ide/templates/combined/kiro-task.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -inclusion: manual ---- - -# {{name}} - -Read the entire task file at: #[[file:{{bmadFolderName}}/{{path}}]] - -Follow all instructions in the task file exactly as written. diff --git a/tools/installer/ide/templates/combined/kiro-tool.md b/tools/installer/ide/templates/combined/kiro-tool.md deleted file mode 100644 index cd903217a..000000000 --- a/tools/installer/ide/templates/combined/kiro-tool.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -inclusion: manual ---- - -# {{name}} - -Read the entire tool file at: #[[file:{{bmadFolderName}}/{{path}}]] - -Follow all instructions in the tool file exactly as written. diff --git a/tools/installer/ide/templates/combined/kiro-workflow.md b/tools/installer/ide/templates/combined/kiro-workflow.md deleted file mode 100644 index e1847f414..000000000 --- a/tools/installer/ide/templates/combined/kiro-workflow.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -inclusion: manual ---- - -# {{name}} - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL #[[file:{{bmadFolderName}}/{{path}}]], READ its entire contents and follow its directions exactly! diff --git a/tools/installer/ide/templates/combined/opencode-agent.md b/tools/installer/ide/templates/combined/opencode-agent.md deleted file mode 100644 index 828d673ac..000000000 --- a/tools/installer/ide/templates/combined/opencode-agent.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -mode: all -description: '{{description}}' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. FOLLOW every step in the section precisely -4. DISPLAY the welcome/greeting as instructed -5. PRESENT the numbered menu -6. WAIT for user input before proceeding - diff --git a/tools/installer/ide/templates/combined/opencode-task.md b/tools/installer/ide/templates/combined/opencode-task.md deleted file mode 100644 index 772f9c9eb..000000000 --- a/tools/installer/ide/templates/combined/opencode-task.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: '{{description}}' ---- - -Execute the BMAD '{{name}}' task. - -TASK INSTRUCTIONS: - -1. LOAD the task file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents -3. FOLLOW every instruction precisely as specified - -TASK FILE: {project-root}/{{bmadFolderName}}/{{path}} diff --git a/tools/installer/ide/templates/combined/opencode-tool.md b/tools/installer/ide/templates/combined/opencode-tool.md deleted file mode 100644 index 88c317e63..000000000 --- a/tools/installer/ide/templates/combined/opencode-tool.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: '{{description}}' ---- - -Execute the BMAD '{{name}}' tool. - -TOOL INSTRUCTIONS: - -1. LOAD the tool file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents -3. FOLLOW every instruction precisely as specified - -TOOL FILE: {project-root}/{{bmadFolderName}}/{{path}} diff --git a/tools/installer/ide/templates/combined/opencode-workflow-yaml.md b/tools/installer/ide/templates/combined/opencode-workflow-yaml.md deleted file mode 100644 index 88838cc1c..000000000 --- a/tools/installer/ide/templates/combined/opencode-workflow-yaml.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -description: '{{description}}' ---- - -Execute the BMAD '{{name}}' workflow. - -CRITICAL: You must load and follow the workflow definition exactly. - -WORKFLOW INSTRUCTIONS: - -1. LOAD the workflow file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents -3. FOLLOW every step precisely as specified -4. DO NOT skip or modify any steps - -WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}} diff --git a/tools/installer/ide/templates/combined/opencode-workflow.md b/tools/installer/ide/templates/combined/opencode-workflow.md deleted file mode 100644 index 88838cc1c..000000000 --- a/tools/installer/ide/templates/combined/opencode-workflow.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -description: '{{description}}' ---- - -Execute the BMAD '{{name}}' workflow. - -CRITICAL: You must load and follow the workflow definition exactly. - -WORKFLOW INSTRUCTIONS: - -1. LOAD the workflow file from {project-root}/{{bmadFolderName}}/{{path}} -2. READ its entire contents -3. FOLLOW every step precisely as specified -4. DO NOT skip or modify any steps - -WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}} diff --git a/tools/installer/ide/templates/combined/rovodev.md b/tools/installer/ide/templates/combined/rovodev.md deleted file mode 100644 index 066945ee5..000000000 --- a/tools/installer/ide/templates/combined/rovodev.md +++ /dev/null @@ -1,9 +0,0 @@ -# {{name}} - -{{description}} - ---- - -Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}} - -Follow all instructions in the workflow file exactly as written. diff --git a/tools/installer/ide/templates/combined/trae.md b/tools/installer/ide/templates/combined/trae.md deleted file mode 100644 index b4d43d7af..000000000 --- a/tools/installer/ide/templates/combined/trae.md +++ /dev/null @@ -1,9 +0,0 @@ -# {{name}} - -{{description}} - -## Instructions - -Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}} - -Follow all instructions in the workflow file exactly as written. diff --git a/tools/installer/ide/templates/combined/windsurf-workflow.md b/tools/installer/ide/templates/combined/windsurf-workflow.md deleted file mode 100644 index 6366425c7..000000000 --- a/tools/installer/ide/templates/combined/windsurf-workflow.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -description: '{{description}}' -auto_execution_mode: "iterate" ---- - -# {{name}} - -Read the entire workflow file at {project-root}/_bmad/{{workflow_path}} - -Follow all instructions in the workflow file exactly as written. diff --git a/tools/installer/ide/templates/split/.gitkeep b/tools/installer/ide/templates/split/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/tools/installer/install-messages.yaml b/tools/installer/install-messages.yaml index 0fc32cc82..4aff87a95 100644 --- a/tools/installer/install-messages.yaml +++ b/tools/installer/install-messages.yaml @@ -6,32 +6,25 @@ startMessage: | ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - 🎉 V6 IS HERE! Welcome to BMad Method V6 - Official Stable Release! + Agile AI-Driven Development. Powered by BMad Core and a growing module ecosystem. + Install official and community modules during setup to customize your experience. - The BMad Method is now a Platform powered by the BMad Method Core and Module Ecosystem! - - Select and install modules during setup - customize your experience - - New BMad Method for Agile AI-Driven Development (the evolution of V4) - - Exciting new modules available during installation, with community modules coming soon - - Documentation: https://docs.bmad-method.org + 🌟 100% free. 100% open source. Always. + No paywalls. No gated content. Knowledge shared, not sold. - 🌟 BMad is 100% free and open source. - - No gated Discord. No paywalls. No gated content. - - We believe in empowering everyone, not just those who can pay. - - Knowledge should be shared, not sold. + 🌐 CONNECT: + Website: https://bmadcode.com/ + Discord: https://discord.gg/gk8jAdXWmj + YouTube: https://www.youtube.com/@BMadCode + X: https://x.com/BMadCode + Facebook: https://facebook.com/@BMadCode - 🎤 SPEAKING & MEDIA: - - Available for conferences, podcasts, and media appearances - - Topics: AI-Native Transformation, Spec and Context Engineering, BMad Method - - For speaking inquiries or interviews, reach out to BMad on Discord! + ⭐ SUPPORT THE PROJECT: + Star us: https://github.com/bmad-code-org/BMAD-METHOD/ + Donate: https://buymeacoffee.com/bmad + Corporate sponsorship and speaking inquiries: contact@bmadcode.com - ⭐ HELP US GROW: - - Star us on GitHub: https://github.com/bmad-code-org/BMAD-METHOD/ - - Subscribe on YouTube: https://www.youtube.com/@BMadCode - - Free Community and Support: https://discord.gg/gk8jAdXWmj - - Donate: https://buymeacoffee.com/bmad - - Corporate Sponsorship available - - Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + Docs, blog, and latest updates: https://bmadcode.com/ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ diff --git a/tools/installer/message-loader.js b/tools/installer/message-loader.js index 03ba7eca1..97f02d6e4 100644 --- a/tools/installer/message-loader.js +++ b/tools/installer/message-loader.js @@ -1,4 +1,4 @@ -const fs = require('fs-extra'); +const fs = require('./fs-native'); const path = require('node:path'); const yaml = require('yaml'); const prompts = require('./prompts'); diff --git a/tools/installer/modules/channel-plan.js b/tools/installer/modules/channel-plan.js new file mode 100644 index 000000000..97581bd35 --- /dev/null +++ b/tools/installer/modules/channel-plan.js @@ -0,0 +1,203 @@ +/** + * Channel plan: the per-module resolution decision applied at install time. + * + * A "plan entry" for a module is: + * { channel: 'stable'|'next'|'pinned', pin?: string } + * + * We build the plan from: + * 1. CLI flags (--channel / --all-* / --next=CODE / --pin CODE=TAG) + * 2. Interactive answers (the "all stable?" gate + per-module picker) + * 3. Registry defaults (default_channel from registry-fallback.yaml / official.yaml) + * 4. Hardcoded fallback 'stable' + * + * Precedence: --pin > --next=CODE > --channel (global) > registry default > 'stable'. + * + * This module is pure. No prompts, no git, no filesystem. + */ + +const VALID_CHANNELS = new Set(['stable', 'next']); + +/** + * Parse raw commander options into a structured channel options object. + * + * @param {Object} options - raw command-line options + * @returns {{ + * global: 'stable'|'next'|null, + * nextSet: Set, + * pins: Map, + * warnings: string[] + * }} + */ +function parseChannelOptions(options = {}) { + const warnings = []; + + // Global channel from --channel / --all-stable / --all-next. + let global = null; + const aliases = []; + if (options.channel) aliases.push({ flag: '--channel', value: normalizeChannel(options.channel, warnings, '--channel') }); + if (options.allStable) aliases.push({ flag: '--all-stable', value: 'stable' }); + if (options.allNext) aliases.push({ flag: '--all-next', value: 'next' }); + + const distinct = new Set(aliases.map((a) => a.value).filter(Boolean)); + if (distinct.size > 1) { + warnings.push( + `Conflicting channel flags: ${aliases + .filter((a) => a.value) + .map((a) => a.flag + '=' + a.value) + .join(', ')}. Using first: ${aliases.find((a) => a.value).flag}.`, + ); + } + const firstValid = aliases.find((a) => a.value); + if (firstValid) global = firstValid.value; + + // --next=CODE (repeatable) + const nextSet = new Set(); + for (const code of options.next || []) { + const trimmed = String(code).trim(); + if (!trimmed) continue; + nextSet.add(trimmed); + } + + // --pin CODE=TAG (repeatable) + const pins = new Map(); + for (const spec of options.pin || []) { + const parsed = parsePinSpec(spec); + if (!parsed) { + warnings.push(`Ignoring malformed --pin value '${spec}'. Expected CODE=TAG.`); + continue; + } + if (pins.has(parsed.code)) { + warnings.push(`--pin specified multiple times for '${parsed.code}'. Using last: ${parsed.tag}.`); + } + pins.set(parsed.code, parsed.tag); + } + + // --yes auto-confirms the community-module curator-bypass prompt so + // headless installs with --next=/--pin for a community module don't hang. + const acceptBypass = options.yes === true || options.acceptBypass === true; + + return { global, nextSet, pins, warnings, acceptBypass }; +} + +function normalizeChannel(raw, warnings, flagName) { + if (typeof raw !== 'string') return null; + const lower = raw.trim().toLowerCase(); + if (VALID_CHANNELS.has(lower)) return lower; + warnings.push(`Ignoring invalid ${flagName} value '${raw}'. Expected one of: stable, next.`); + return null; +} + +function parsePinSpec(spec) { + if (typeof spec !== 'string') return null; + const idx = spec.indexOf('='); + if (idx <= 0 || idx === spec.length - 1) return null; + const code = spec.slice(0, idx).trim(); + const tag = spec.slice(idx + 1).trim(); + if (!code || !tag) return null; + return { code, tag }; +} + +/** + * Build a per-module plan entry, applying precedence. + * + * @param {Object} args + * @param {string} args.code + * @param {Object} args.channelOptions - from parseChannelOptions + * @param {string} [args.registryDefault] - module's default_channel, if any + * @returns {{channel: 'stable'|'next'|'pinned', pin?: string, source: string}} + * source describes where the decision came from, for logging / debugging. + */ +function decideChannelForModule({ code, channelOptions, registryDefault }) { + const { global, nextSet, pins } = channelOptions || { nextSet: new Set(), pins: new Map() }; + + if (pins && pins.has(code)) { + return { channel: 'pinned', pin: pins.get(code), source: 'flag:--pin' }; + } + if (nextSet && nextSet.has(code)) { + return { channel: 'next', source: 'flag:--next' }; + } + if (global) { + return { channel: global, source: 'flag:--channel' }; + } + if (registryDefault && VALID_CHANNELS.has(registryDefault)) { + return { channel: registryDefault, source: 'registry' }; + } + return { channel: 'stable', source: 'default' }; +} + +/** + * Build a full channel plan map for a set of modules. + * + * @param {Object} args + * @param {Array<{code: string, defaultChannel?: string, builtIn?: boolean}>} args.modules + * Only the modules that need a channel entry; callers should filter out + * bundled modules (core/bmm) before calling. + * @param {Object} args.channelOptions - from parseChannelOptions + * @returns {Map} + */ +function buildPlan({ modules, channelOptions }) { + const plan = new Map(); + for (const mod of modules || []) { + plan.set( + mod.code, + decideChannelForModule({ + code: mod.code, + channelOptions, + registryDefault: mod.defaultChannel, + }), + ); + } + return plan; +} + +/** + * Report any --pin CODE=TAG entries that don't correspond to a selected module. + * These get warned about but don't abort the install. + */ +function orphanPinWarnings(channelOptions, selectedCodes) { + const warnings = []; + const selected = new Set(selectedCodes || []); + for (const code of channelOptions?.pins?.keys() || []) { + if (!selected.has(code)) { + warnings.push(`--pin for '${code}' has no effect (module not selected).`); + } + } + for (const code of channelOptions?.nextSet || []) { + if (!selected.has(code)) { + warnings.push(`--next for '${code}' has no effect (module not selected).`); + } + } + return warnings; +} + +/** + * Warn when --pin / --next targets a bundled module (core, bmm). Those are + * shipped inside the installer binary — there's no git clone to override, so + * the flag has no effect. Users who actually want a prerelease core/bmm + * should use `npx bmad-method@next install`. + */ +function bundledTargetWarnings(channelOptions, bundledCodes) { + const warnings = []; + const bundled = new Set(bundledCodes || []); + const hint = '(bundled module; use `npx bmad-method@next install` for a prerelease)'; + for (const code of channelOptions?.pins?.keys() || []) { + if (bundled.has(code)) { + warnings.push(`--pin for '${code}' has no effect ${hint}.`); + } + } + for (const code of channelOptions?.nextSet || []) { + if (bundled.has(code)) { + warnings.push(`--next for '${code}' has no effect ${hint}.`); + } + } + return warnings; +} + +module.exports = { + parseChannelOptions, + decideChannelForModule, + buildPlan, + orphanPinWarnings, + bundledTargetWarnings, + parsePinSpec, +}; diff --git a/tools/installer/modules/channel-resolver.js b/tools/installer/modules/channel-resolver.js new file mode 100644 index 000000000..c6e347f13 --- /dev/null +++ b/tools/installer/modules/channel-resolver.js @@ -0,0 +1,241 @@ +const https = require('node:https'); +const semver = require('semver'); + +/** + * Channel resolver for external and community modules. + * + * A "channel" is the resolution strategy that decides which ref of a module + * to clone when no explicit version is supplied: + * - stable: highest pure-semver git tag (excludes -alpha/-beta/-rc) + * - next: main branch HEAD + * - pinned: an explicit user-supplied tag + * + * This module is pure (no prompts, no git, no filesystem). It only talks to + * the GitHub tags API and performs semver math. Clone logic lives in the + * module managers that call resolveChannel(). + */ + +const GITHUB_API_BASE = 'https://api.github.com'; +const DEFAULT_TIMEOUT_MS = 10_000; +const USER_AGENT = 'bmad-method-installer'; + +// Per-process cache: { 'owner/repo' => string[] sorted desc } of pure-semver tags. +const tagCache = new Map(); + +/** + * Parse a GitHub repo URL into { owner, repo }. Returns null if the URL is + * not a GitHub URL the resolver can handle. + */ +function parseGitHubRepo(url) { + if (!url || typeof url !== 'string') return null; + const trimmed = url + .trim() + .replace(/\.git$/, '') + .replace(/\/$/, ''); + + // https://github.com/owner/repo + const httpsMatch = trimmed.match(/^https?:\/\/github\.com\/([^/]+)\/([^/]+)(?:\/.*)?$/i); + if (httpsMatch) return { owner: httpsMatch[1], repo: httpsMatch[2] }; + + // git@github.com:owner/repo + const sshMatch = trimmed.match(/^git@github\.com:([^/]+)\/([^/]+)$/i); + if (sshMatch) return { owner: sshMatch[1], repo: sshMatch[2] }; + + return null; +} + +function fetchJson(url, { timeout = DEFAULT_TIMEOUT_MS } = {}) { + const headers = { + 'User-Agent': USER_AGENT, + Accept: 'application/vnd.github+json', + 'X-GitHub-Api-Version': '2022-11-28', + }; + if (process.env.GITHUB_TOKEN) { + headers.Authorization = `Bearer ${process.env.GITHUB_TOKEN}`; + } + + return new Promise((resolve, reject) => { + const req = https.get(url, { headers, timeout }, (res) => { + let body = ''; + res.on('data', (chunk) => (body += chunk)); + res.on('end', () => { + if (res.statusCode < 200 || res.statusCode >= 300) { + const err = new Error(`GitHub API ${res.statusCode} for ${url}: ${body.slice(0, 200)}`); + err.statusCode = res.statusCode; + return reject(err); + } + try { + resolve(JSON.parse(body)); + } catch (error) { + reject(new Error(`Failed to parse GitHub response: ${error.message}`)); + } + }); + }); + req.on('error', reject); + req.on('timeout', () => { + req.destroy(); + reject(new Error(`GitHub API request timed out: ${url}`)); + }); + }); +} + +/** + * Strip a leading 'v' and return a valid semver string, or null if the tag + * is not valid semver or is a prerelease (contains -alpha/-beta/-rc/etc.). + */ +function normalizeStableTag(tagName) { + if (typeof tagName !== 'string') return null; + const stripped = tagName.startsWith('v') ? tagName.slice(1) : tagName; + const valid = semver.valid(stripped); + if (!valid) return null; + // Exclude prereleases. semver.prerelease returns null for pure releases. + if (semver.prerelease(valid)) return null; + return valid; +} + +/** + * Fetch pure-semver tags (highest first) from a GitHub repo. + * Cached per-process per owner/repo. + * + * @returns {Promise>} + * tag is the original ref name (e.g. "v1.7.0"), version is the cleaned + * semver (e.g. "1.7.0"). + */ +async function fetchStableTags(owner, repo, { timeout } = {}) { + const cacheKey = `${owner}/${repo}`; + if (tagCache.has(cacheKey)) return tagCache.get(cacheKey); + + // GitHub returns up to 100 tags per page; one page is plenty for our modules. + const url = `${GITHUB_API_BASE}/repos/${owner}/${repo}/tags?per_page=100`; + const raw = await fetchJson(url, { timeout }); + if (!Array.isArray(raw)) { + throw new TypeError(`Unexpected response from ${url}`); + } + + const stable = []; + for (const entry of raw) { + const version = normalizeStableTag(entry?.name); + if (version) stable.push({ tag: entry.name, version }); + } + stable.sort((a, b) => semver.rcompare(a.version, b.version)); + + tagCache.set(cacheKey, stable); + return stable; +} + +/** + * Resolve a channel plan for a single module into a git-clonable ref. + * + * @param {Object} args + * @param {'stable'|'next'|'pinned'} args.channel + * @param {string} [args.pin] - Required when channel === 'pinned' + * @param {string} args.repoUrl - Module's git URL (for tag lookup) + * @returns {Promise<{channel, ref, version}>} where + * ref: the git ref to pass to `git clone --branch`, or null for HEAD (next) + * version: the resolved version string (tag name for stable/pinned, 'main' for next) + * + * Throws on: + * - pinned without a pin value + * - stable with no GitHub repo parseable from the URL (pass through to caller to fall back) + * + * Falls back to next-channel semantics and sets resolvedFallback=true when + * stable resolution turns up no tags. + */ +async function resolveChannel({ channel, pin, repoUrl, timeout }) { + if (channel === 'pinned') { + if (!pin) throw new Error('resolveChannel: pinned channel requires a pin value'); + return { channel: 'pinned', ref: pin, version: pin, resolvedFallback: false }; + } + + if (channel === 'next') { + return { channel: 'next', ref: null, version: 'main', resolvedFallback: false }; + } + + if (channel === 'stable') { + const parsed = parseGitHubRepo(repoUrl); + if (!parsed) { + // No GitHub URL — caller must handle by falling back to next. + return { channel: 'next', ref: null, version: 'main', resolvedFallback: true, reason: 'not-a-github-url' }; + } + + try { + const tags = await fetchStableTags(parsed.owner, parsed.repo, { timeout }); + if (tags.length === 0) { + return { channel: 'next', ref: null, version: 'main', resolvedFallback: true, reason: 'no-stable-tags' }; + } + const top = tags[0]; + return { channel: 'stable', ref: top.tag, version: top.tag, resolvedFallback: false }; + } catch (error) { + // Propagate the error; callers decide whether to fall back or abort. + error.message = `Failed to resolve stable channel for ${parsed.owner}/${parsed.repo}: ${error.message}`; + throw error; + } + } + + throw new Error(`resolveChannel: unknown channel '${channel}'`); +} + +/** + * Verify that a specific tag exists in a GitHub repo. Used to validate + * --pin values before the user sits through a long clone that then fails. + */ +async function tagExists(owner, repo, tagName, { timeout } = {}) { + const url = `${GITHUB_API_BASE}/repos/${owner}/${repo}/git/refs/tags/${encodeURIComponent(tagName)}`; + try { + await fetchJson(url, { timeout }); + return true; + } catch (error) { + if (error.statusCode === 404) return false; + throw error; + } +} + +/** + * Classify the semver delta between two versions. + * - 'none' → same version (or downgrade; treated same) + * - 'patch' → same major.minor, higher patch + * - 'minor' → same major, higher minor + * - 'major' → different major + * - 'unknown' → either version is not valid semver; caller should treat as major + */ +function classifyUpgrade(currentVersion, newVersion) { + const current = semver.valid(semver.coerce(currentVersion)); + const next = semver.valid(semver.coerce(newVersion)); + if (!current || !next) return 'unknown'; + if (semver.lte(next, current)) return 'none'; + const diff = semver.diff(current, next); + if (diff === 'patch') return 'patch'; + if (diff === 'minor' || diff === 'preminor') return 'minor'; + if (diff === 'major' || diff === 'premajor') return 'major'; + // prepatch, prerelease — treat conservatively as minor (prereleases shouldn't + // normally surface here since stable channel filters them out). + return 'minor'; +} + +/** + * Build the GitHub release notes URL for a resolved tag. + * Returns null if the repo URL isn't a GitHub URL. + */ +function releaseNotesUrl(repoUrl, tag) { + const parsed = parseGitHubRepo(repoUrl); + if (!parsed || !tag) return null; + return `https://github.com/${parsed.owner}/${parsed.repo}/releases/tag/${encodeURIComponent(tag)}`; +} + +/** + * Test-only: clear the per-process tag cache. + */ +function _clearTagCache() { + tagCache.clear(); +} + +module.exports = { + parseGitHubRepo, + fetchStableTags, + resolveChannel, + tagExists, + classifyUpgrade, + releaseNotesUrl, + normalizeStableTag, + _clearTagCache, +}; diff --git a/tools/installer/modules/community-manager.js b/tools/installer/modules/community-manager.js new file mode 100644 index 000000000..192e8f701 --- /dev/null +++ b/tools/installer/modules/community-manager.js @@ -0,0 +1,704 @@ +const fs = require('../fs-native'); +const os = require('node:os'); +const path = require('node:path'); +const { execSync } = require('node:child_process'); +const prompts = require('../prompts'); +const { RegistryClient } = require('./registry-client'); +const { decideChannelForModule } = require('./channel-plan'); +const { parseGitHubRepo, tagExists } = require('./channel-resolver'); + +const MARKETPLACE_OWNER = 'bmad-code-org'; +const MARKETPLACE_REPO = 'bmad-plugins-marketplace'; +const MARKETPLACE_REF = 'main'; + +/** + * Manages community modules from the BMad marketplace registry. + * Fetches community-index.yaml and categories.yaml from GitHub. + * Returns empty results when the registry is unreachable. + * Community modules are pinned to approved SHA when set; uses HEAD otherwise. + */ +function quoteShellRef(ref) { + if (typeof ref !== 'string' || !/^[\w.\-+/]+$/.test(ref)) { + throw new Error(`Unsafe ref name: ${JSON.stringify(ref)}`); + } + return `"${ref}"`; +} + +class CommunityModuleManager { + // moduleCode → { channel, version, sha, registryApprovedTag, registryApprovedSha, repoUrl, bypassedCurator } + // Shared across all instances; the manifest writer often uses a fresh instance. + static _resolutions = new Map(); + + // moduleCode → ResolvedModule (from PluginResolver) when the cloned repo ships + // a `.claude-plugin/marketplace.json`. Lets community installs reuse the same + // skill-level install pipeline as custom-source installs (installFromResolution). + static _pluginResolutions = new Map(); + + constructor() { + this._client = new RegistryClient(); + this._cachedIndex = null; + this._cachedCategories = null; + } + + /** Get the most recent channel resolution for a community module. */ + getResolution(moduleCode) { + return CommunityModuleManager._resolutions.get(moduleCode) || null; + } + + /** Get the marketplace.json-derived plugin resolution for a community module, if any. */ + getPluginResolution(moduleCode) { + return CommunityModuleManager._pluginResolutions.get(moduleCode) || null; + } + + // ─── Data Loading ────────────────────────────────────────────────────────── + + /** + * Load the community module index from the marketplace repo. + * Returns empty when the registry is unreachable. + * @returns {Object} Parsed YAML with modules array + */ + async loadCommunityIndex() { + if (this._cachedIndex) return this._cachedIndex; + + try { + const config = await this._client.fetchGitHubYaml( + MARKETPLACE_OWNER, + MARKETPLACE_REPO, + 'registry/community-index.yaml', + MARKETPLACE_REF, + ); + if (config?.modules?.length) { + this._cachedIndex = config; + return config; + } + } catch { + // Registry unreachable - no community modules available + } + + return { modules: [] }; + } + + /** + * Load categories from the marketplace repo. + * Returns empty when the registry is unreachable. + * @returns {Object} Parsed categories.yaml content + */ + async loadCategories() { + if (this._cachedCategories) return this._cachedCategories; + + try { + const config = await this._client.fetchGitHubYaml(MARKETPLACE_OWNER, MARKETPLACE_REPO, 'categories.yaml', MARKETPLACE_REF); + if (config?.categories) { + this._cachedCategories = config; + return config; + } + } catch { + // Registry unreachable - no categories available + } + + return { categories: {} }; + } + + // ─── Listing & Filtering ────────────────────────────────────────────────── + + /** + * Get all community modules, normalized. + * @returns {Array} Normalized community modules + */ + async listAll() { + const index = await this.loadCommunityIndex(); + return (index.modules || []).map((mod) => this._normalizeCommunityModule(mod)); + } + + /** + * Get community modules filtered to a category. + * @param {string} categorySlug - Category slug (e.g., 'design-and-creative') + * @returns {Array} Filtered modules + */ + async listByCategory(categorySlug) { + const all = await this.listAll(); + return all.filter((mod) => mod.category === categorySlug); + } + + /** + * Get promoted/featured community modules, sorted by rank. + * @returns {Array} Featured modules + */ + async listFeatured() { + const all = await this.listAll(); + return all.filter((mod) => mod.promoted === true).sort((a, b) => (a.promotedRank || 999) - (b.promotedRank || 999)); + } + + /** + * Search community modules by keyword. + * Matches against name, display name, description, and keywords array. + * @param {string} query - Search query + * @returns {Array} Matching modules + */ + async searchByKeyword(query) { + const all = await this.listAll(); + const q = query.toLowerCase(); + return all.filter((mod) => { + const searchable = [mod.name, mod.displayName, mod.description, ...(mod.keywords || [])].join(' ').toLowerCase(); + return searchable.includes(q); + }); + } + + /** + * Get categories with module counts for UI display. + * Only returns categories that have at least one community module. + * @returns {Array} Array of { slug, name, moduleCount } + */ + async getCategoryList() { + const all = await this.listAll(); + const categoriesData = await this.loadCategories(); + const categories = categoriesData.categories || {}; + + // Count modules per category + const counts = {}; + for (const mod of all) { + counts[mod.category] = (counts[mod.category] || 0) + 1; + } + + // Build list with display names from categories.yaml + const result = []; + for (const [slug, count] of Object.entries(counts)) { + const catInfo = categories[slug]; + result.push({ + slug, + name: catInfo?.name || slug, + moduleCount: count, + }); + } + + // Sort alphabetically by name + result.sort((a, b) => a.name.localeCompare(b.name)); + return result; + } + + // ─── Module Lookup ──────────────────────────────────────────────────────── + + /** + * Get a community module by its code. + * @param {string} code - Module code (e.g., 'wds') + * @returns {Object|null} Normalized module or null + */ + async getModuleByCode(code) { + const all = await this.listAll(); + return all.find((m) => m.code === code) || null; + } + + // ─── Clone with Tag Pinning ─────────────────────────────────────────────── + + /** + * Get the cache directory for community modules. + * @returns {string} Path to the community modules cache directory + */ + getCacheDir() { + return path.join(os.homedir(), '.bmad', 'cache', 'community-modules'); + } + + /** + * Clone a community module repository, pinned to its approved tag. + * @param {string} moduleCode - Module code + * @param {Object} [options] - Clone options + * @param {boolean} [options.silent] - Suppress spinner output + * @returns {string} Path to the cloned repository + */ + async cloneModule(moduleCode, options = {}) { + const moduleInfo = await this.getModuleByCode(moduleCode); + if (!moduleInfo) { + throw new Error(`Community module '${moduleCode}' not found in the registry`); + } + + const cacheDir = this.getCacheDir(); + const moduleCacheDir = path.join(cacheDir, moduleCode); + const silent = options.silent || false; + + await fs.ensureDir(cacheDir); + + const createSpinner = async () => { + if (silent) { + return { start() {}, stop() {}, error() {}, message() {} }; + } + return await prompts.spinner(); + }; + + // ─── Resolve channel plan ────────────────────────────────────────────── + // Default community behavior (stable channel) honors the curator's + // approved SHA. --next=CODE and --pin CODE=TAG override the curator; we + // warn the user before bypassing the approved version. + const planEntry = decideChannelForModule({ + code: moduleCode, + channelOptions: options.channelOptions, + registryDefault: 'stable', + }); + + const approvedSha = moduleInfo.approvedSha; + const approvedTag = moduleInfo.approvedTag; + + let bypassedCurator = false; + if (planEntry.channel !== 'stable') { + bypassedCurator = true; + if (!silent) { + const approvedLabel = approvedTag || approvedSha || 'curator-approved version'; + await prompts.log.warn( + `WARNING: Installing '${moduleCode}' from ${ + planEntry.channel === 'pinned' ? `tag ${planEntry.pin}` : 'main HEAD' + } bypasses the curator-approved ${approvedLabel}. Proceed only if you trust this source.`, + ); + if (!options.channelOptions?.acceptBypass) { + const proceed = await prompts.confirm({ + message: `Continue installing '${moduleCode}' with curator bypass?`, + default: false, + }); + if (!proceed) { + throw new Error(`Install of community module '${moduleCode}' cancelled by user.`); + } + } + } + } + + let needsDependencyInstall = false; + let wasNewClone = false; + + if (await fs.pathExists(moduleCacheDir)) { + // Already cloned — refresh to the correct ref for the resolved channel. + // A pinned install must not reset to origin/HEAD (it would silently drift + // to main on every re-install). Stable + approvedSha is handled below + // by the curator-SHA checkout logic. + const fetchSpinner = await createSpinner(); + fetchSpinner.start(`Checking ${moduleInfo.displayName}...`); + try { + const currentRef = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + execSync('git fetch origin --depth 1', { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + if (planEntry.channel === 'pinned') { + // Fetch the pin tag specifically and check it out. + execSync(`git fetch --depth 1 origin ${quoteShellRef(planEntry.pin)} --no-tags`, { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + execSync('git checkout --quiet FETCH_HEAD', { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + }); + } else { + // stable (approvedSha path re-checks out below) and next: track main. + execSync('git reset --hard origin/HEAD', { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + }); + } + const newRef = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + if (currentRef !== newRef) needsDependencyInstall = true; + fetchSpinner.stop(`Verified ${moduleInfo.displayName}`); + } catch { + fetchSpinner.error(`Fetch failed, re-downloading ${moduleInfo.displayName}`); + await fs.remove(moduleCacheDir); + wasNewClone = true; + } + } else { + wasNewClone = true; + } + + if (wasNewClone) { + const fetchSpinner = await createSpinner(); + fetchSpinner.start(`Fetching ${moduleInfo.displayName}...`); + try { + if (planEntry.channel === 'pinned') { + execSync(`git clone --depth 1 --branch ${quoteShellRef(planEntry.pin)} "${moduleInfo.url}" "${moduleCacheDir}"`, { + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } else { + execSync(`git clone --depth 1 "${moduleInfo.url}" "${moduleCacheDir}"`, { + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } + fetchSpinner.stop(`Fetched ${moduleInfo.displayName}`); + needsDependencyInstall = true; + } catch (error) { + fetchSpinner.error(`Failed to fetch ${moduleInfo.displayName}`); + throw new Error(`Failed to clone community module '${moduleCode}': ${error.message}`); + } + } + + // ─── Check out the resolved ref per channel ────────────────────────── + if (planEntry.channel === 'stable' && approvedSha) { + // Default path: pin to the curator-approved SHA. Refuse install if the SHA + // is unreachable (tag may have been deleted or rewritten) — security requirement. + const headSha = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + if (headSha !== approvedSha) { + try { + execSync(`git fetch --depth 1 origin ${quoteShellRef(approvedSha)}`, { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + execSync(`git checkout ${quoteShellRef(approvedSha)}`, { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + }); + needsDependencyInstall = true; + } catch { + await fs.remove(moduleCacheDir); + throw new Error( + `Community module '${moduleCode}' could not be pinned to its approved commit (${approvedSha}). ` + + `Installation refused for security. The module registry entry may need updating, ` + + `or use --next=${moduleCode} / --pin ${moduleCode}= to explicitly bypass.`, + ); + } + } + } else if (planEntry.channel === 'stable' && !approvedSha) { + // Registry data gap: tag or SHA missing. Warn but proceed at HEAD (pre-existing behavior). + if (!silent) { + await prompts.log.warn(`Community module '${moduleCode}' has no curator-approved SHA in the registry; installing from main HEAD.`); + } + } else if (planEntry.channel === 'pinned') { + // We cloned the tag directly above (via --branch), but ensure HEAD matches. + // No additional checkout needed. + } + // else: 'next' channel — already at origin/HEAD from the fetch/reset above. + + // Record the resolution so the manifest writer can pick up channel/version/sha. + const installedSha = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + const recordedVersion = + planEntry.channel === 'pinned' ? planEntry.pin : planEntry.channel === 'next' ? 'main' : approvedTag || installedSha.slice(0, 7); + CommunityModuleManager._resolutions.set(moduleCode, { + channel: planEntry.channel, + version: recordedVersion, + sha: installedSha, + registryApprovedTag: approvedTag || null, + registryApprovedSha: approvedSha || null, + repoUrl: moduleInfo.url, + bypassedCurator, + planSource: planEntry.source, + }); + + // If the repo ships a marketplace.json, route through PluginResolver so the + // skill-level install pipeline (installFromResolution) handles the copy. + // Repos without marketplace.json fall through to the legacy findModuleSource + // path unchanged. + await this._tryResolveMarketplacePlugin(moduleCacheDir, moduleInfo, { + channel: planEntry.channel, + version: recordedVersion, + sha: installedSha, + approvedTag, + approvedSha, + }); + + // Install dependencies if needed + const packageJsonPath = path.join(moduleCacheDir, 'package.json'); + if ((needsDependencyInstall || wasNewClone) && (await fs.pathExists(packageJsonPath))) { + const installSpinner = await createSpinner(); + installSpinner.start(`Installing dependencies for ${moduleInfo.displayName}...`); + try { + execSync('npm install --omit=dev --no-audit --no-fund --no-progress --legacy-peer-deps', { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + timeout: 120_000, + }); + installSpinner.stop(`Installed dependencies for ${moduleInfo.displayName}`); + } catch (error) { + installSpinner.error(`Failed to install dependencies for ${moduleInfo.displayName}`); + if (!silent) await prompts.log.warn(` ${error.message}`); + } + } + + return moduleCacheDir; + } + + // ─── Marketplace.json Resolution ────────────────────────────────────────── + + /** + * Detect `.claude-plugin/marketplace.json` in a cloned community repo and + * route through PluginResolver. When successful, caches the resolution so + * OfficialModulesManager.install() can route the copy through + * installFromResolution() — the same path used by custom-source installs. + * + * Silent no-op when marketplace.json is absent or the resolver returns no + * matches; the legacy findModuleSource path then handles the install. + * + * @param {string} repoPath - Absolute path to the cloned repo + * @param {Object} moduleInfo - Normalized community module info + * @param {Object} resolution - Resolution metadata from cloneModule + * @param {string} resolution.channel - Channel ('stable' | 'next' | 'pinned') + * @param {string} resolution.version - Recorded version string + * @param {string} resolution.sha - Resolved git SHA + * @param {string|null} resolution.approvedTag - Registry approved tag + * @param {string|null} resolution.approvedSha - Registry approved SHA + */ + async _tryResolveMarketplacePlugin(repoPath, moduleInfo, resolution) { + const marketplacePath = path.join(repoPath, '.claude-plugin', 'marketplace.json'); + if (!(await fs.pathExists(marketplacePath))) return; + + let marketplaceData; + try { + marketplaceData = JSON.parse(await fs.readFile(marketplacePath, 'utf8')); + } catch { + // Malformed marketplace.json — fall through to legacy path. + return; + } + + const plugins = Array.isArray(marketplaceData?.plugins) ? marketplaceData.plugins : []; + if (plugins.length === 0) return; + + const selection = this._selectPluginForModule(plugins, moduleInfo); + if (!selection) { + await this._safeWarn( + `Community module '${moduleInfo.code}' ships marketplace.json but no plugin entry matches the registry code. ` + + `Falling back to legacy install path.`, + ); + return; + } + + if (selection.source === 'single-fallback') { + // Single-entry marketplace.json whose plugin name doesn't match the registry + // code or the module_definition hint. Most likely correct, but worth surfacing + // in case marketplace.json is misconfigured and we'd install the wrong plugin. + await this._safeWarn( + `Community module '${moduleInfo.code}' picked the only plugin in marketplace.json ('${selection.plugin?.name}') ` + + `because no name or module_definition match was found. Verify marketplace.json if the install looks wrong.`, + ); + } + + const { PluginResolver } = require('./plugin-resolver'); + const resolver = new PluginResolver(); + let resolved; + try { + resolved = await resolver.resolve(repoPath, selection.plugin); + } catch (error) { + // PluginResolver threw (malformed plugin entry, missing files, etc.). + // Honor the silent-fallthrough contract — warn and let the legacy + // findModuleSource path handle the install. + await this._safeWarn( + `PluginResolver failed for community module '${moduleInfo.code}': ${error.message}. ` + `Falling back to legacy install path.`, + ); + return; + } + if (!resolved || resolved.length === 0) return; + + // The registry registers a single code per module. If the resolver returns + // multiple modules (Strategy 4: multiple standalone skills), accept only + // the entry whose code matches the registry. Other entries are ignored — + // they belong to plugins not registered in the community catalog. + const matched = resolved.find((mod) => mod.code === moduleInfo.code) || (resolved.length === 1 ? resolved[0] : null); + if (!matched) return; + + // Shallow-clone before stamping provenance — the resolver may cache or reuse + // its return objects, and we don't want install-specific fields leaking back. + const stamped = { + ...matched, + code: moduleInfo.code, + repoUrl: moduleInfo.url, + cloneRef: resolution.channel === 'pinned' ? resolution.version : resolution.approvedTag || null, + cloneSha: resolution.sha, + communitySource: true, + communityChannel: resolution.channel, + communityVersion: resolution.version, + registryApprovedTag: resolution.approvedTag, + registryApprovedSha: resolution.approvedSha, + }; + + CommunityModuleManager._pluginResolutions.set(moduleInfo.code, stamped); + } + + /** + * Lazy fallback: resolve marketplace.json straight from the on-disk cache + * when `_pluginResolutions` is empty (e.g. callers that reach `install()` + * without `cloneModule` having populated the cache earlier in this process). + * + * Reuses an existing channel resolution if present; otherwise synthesizes a + * minimal stable-channel stub from the registry entry + the cached repo's + * current HEAD. Returns the cached plugin resolution if one is produced, + * otherwise null (caller falls back to the legacy path). + * + * @param {string} moduleCode + * @returns {Promise} + */ + async resolveFromCache(moduleCode) { + const existing = this.getPluginResolution(moduleCode); + if (existing) return existing; + + const cacheRepoDir = path.join(this.getCacheDir(), moduleCode); + const marketplacePath = path.join(cacheRepoDir, '.claude-plugin', 'marketplace.json'); + if (!(await fs.pathExists(marketplacePath))) return null; + + let moduleInfo; + try { + moduleInfo = await this.getModuleByCode(moduleCode); + } catch { + return null; + } + if (!moduleInfo) return null; + + let channelResolution = this.getResolution(moduleCode); + if (!channelResolution) { + let sha = ''; + try { + sha = execSync('git rev-parse HEAD', { cwd: cacheRepoDir, stdio: 'pipe' }).toString().trim(); + } catch { + // Not a git repo or unreadable — give up and let the legacy path run. + return null; + } + channelResolution = { + channel: 'stable', + version: moduleInfo.approvedTag || sha.slice(0, 7), + sha, + registryApprovedTag: moduleInfo.approvedTag || null, + registryApprovedSha: moduleInfo.approvedSha || null, + }; + } + + await this._tryResolveMarketplacePlugin(cacheRepoDir, moduleInfo, { + channel: channelResolution.channel, + version: channelResolution.version, + sha: channelResolution.sha, + approvedTag: channelResolution.registryApprovedTag, + approvedSha: channelResolution.registryApprovedSha, + }); + + return this.getPluginResolution(moduleCode); + } + + /** + * Best-effort warning emitter. `prompts.log.warn` may be undefined in some + * harnesses and may return a rejected promise — swallow both cases so a + * fallthrough warning can never crash the install. + */ + async _safeWarn(message) { + try { + const result = prompts.log?.warn?.(message); + if (result && typeof result.then === 'function') await result; + } catch { + /* ignore */ + } + } + + /** + * Pick which plugin entry from marketplace.json represents this community module. + * Precedence: + * 1. Exact match on `plugin.name === moduleInfo.code` + * 2. Trailing directory of `module_definition` matches `plugin.name` + * 3. Single plugin in marketplace.json — accepted with a warning so a + * mismatched-but-uniquely-named plugin doesn't install silently. + * Otherwise null (caller falls back to legacy path). + * + * @returns {{plugin: Object, source: 'name'|'hint'|'single-fallback'}|null} + */ + _selectPluginForModule(plugins, moduleInfo) { + const byCode = plugins.find((p) => p && p.name === moduleInfo.code); + if (byCode) return { plugin: byCode, source: 'name' }; + + if (moduleInfo.moduleDefinition) { + // module_definition like "src/skills/suno-setup/assets/module.yaml" → + // hint segment "suno-setup". Match that against plugin names. + const segments = moduleInfo.moduleDefinition.split('/').filter(Boolean); + const setupIdx = segments.findIndex((s) => s.endsWith('-setup')); + if (setupIdx !== -1) { + const hint = segments[setupIdx]; + const byHint = plugins.find((p) => p && p.name === hint); + if (byHint) return { plugin: byHint, source: 'hint' }; + } + } + + if (plugins.length === 1) return { plugin: plugins[0], source: 'single-fallback' }; + return null; + } + + // ─── Source Finding ─────────────────────────────────────────────────────── + + /** + * Find the source path for a community module (clone + locate module.yaml). + * @param {string} moduleCode - Module code + * @param {Object} [options] - Options passed to cloneModule + * @returns {string|null} Path to the module source or null + */ + async findModuleSource(moduleCode, options = {}) { + const moduleInfo = await this.getModuleByCode(moduleCode); + if (!moduleInfo) return null; + + const cloneDir = await this.cloneModule(moduleCode, options); + + // Check configured module_definition path first + if (moduleInfo.moduleDefinition) { + const configuredPath = path.join(cloneDir, moduleInfo.moduleDefinition); + if (await fs.pathExists(configuredPath)) { + return path.dirname(configuredPath); + } + } + + // Fallback: search skills/ and src/ directories + for (const dir of ['skills', 'src']) { + const rootCandidate = path.join(cloneDir, dir, 'module.yaml'); + if (await fs.pathExists(rootCandidate)) { + return path.dirname(rootCandidate); + } + const dirPath = path.join(cloneDir, dir); + if (await fs.pathExists(dirPath)) { + const entries = await fs.readdir(dirPath, { withFileTypes: true }); + for (const entry of entries) { + if (entry.isDirectory()) { + const subCandidate = path.join(dirPath, entry.name, 'module.yaml'); + if (await fs.pathExists(subCandidate)) { + return path.dirname(subCandidate); + } + } + } + } + } + + // Check repo root + const rootCandidate = path.join(cloneDir, 'module.yaml'); + if (await fs.pathExists(rootCandidate)) { + return path.dirname(rootCandidate); + } + + return moduleInfo.moduleDefinition ? path.dirname(path.join(cloneDir, moduleInfo.moduleDefinition)) : null; + } + + // ─── Normalization ──────────────────────────────────────────────────────── + + /** + * Normalize a community module entry to a consistent shape. + * @param {Object} mod - Raw module from community-index.yaml + * @returns {Object} Normalized module info + */ + _normalizeCommunityModule(mod) { + return { + key: mod.name, + code: mod.code, + name: mod.display_name || mod.name, + displayName: mod.display_name || mod.name, + description: mod.description || '', + url: mod.repository || mod.url, + moduleDefinition: mod.module_definition || mod['module-definition'], + npmPackage: mod.npm_package || mod.npmPackage || null, + author: mod.author || '', + license: mod.license || '', + type: 'community', + category: mod.category || '', + subcategory: mod.subcategory || '', + keywords: mod.keywords || [], + version: mod.version || null, + approvedTag: mod.approved_tag || null, + approvedSha: mod.approved_sha || null, + approvedDate: mod.approved_date || null, + reviewer: mod.reviewer || null, + trustTier: mod.trust_tier || 'unverified', + promoted: mod.promoted === true, + promotedRank: mod.promoted_rank || null, + defaultSelected: false, + builtIn: false, + isExternal: true, + }; + } +} + +module.exports = { CommunityModuleManager }; diff --git a/tools/installer/modules/custom-module-manager.js b/tools/installer/modules/custom-module-manager.js new file mode 100644 index 000000000..ca3e52325 --- /dev/null +++ b/tools/installer/modules/custom-module-manager.js @@ -0,0 +1,759 @@ +const fs = require('../fs-native'); +const os = require('node:os'); +const path = require('node:path'); +const { execSync } = require('node:child_process'); +const prompts = require('../prompts'); + +function quoteCustomRef(ref) { + if (typeof ref !== 'string' || !/^[\w.\-+/]+$/.test(ref)) { + throw new Error(`Unsafe ref name: ${JSON.stringify(ref)}`); + } + return `"${ref}"`; +} + +/** + * Manages custom modules installed from user-provided sources. + * Supports any Git host (GitHub, GitLab, Bitbucket, self-hosted) and local file paths. + * Validates input, clones repos, reads .claude-plugin/marketplace.json, resolves plugins. + */ +class CustomModuleManager { + /** @type {Map} Shared across all instances: module code -> ResolvedModule */ + static _resolutionCache = new Map(); + + // ─── Source Parsing ─────────────────────────────────────────────────────── + + /** + * Parse a user-provided source input into a structured descriptor. + * Accepts local file paths, HTTPS Git URLs, HTTP Git URLs, and SSH Git URLs. + * For HTTPS/HTTP URLs with deep paths (e.g., /tree/main/subdir), extracts the subdir. + * The original protocol (http or https) is preserved in the returned cloneUrl. + * + * @param {string} input - URL or local file path + * @returns {Object} Parsed source descriptor: + * { type: 'url'|'local', cloneUrl, subdir, localPath, cacheKey, displayName, isValid, error } + */ + parseSource(input) { + if (!input || typeof input !== 'string') { + return { + type: null, + cloneUrl: null, + subdir: null, + localPath: null, + cacheKey: null, + displayName: null, + isValid: false, + error: 'Source is required', + }; + } + + const trimmedRaw = input.trim(); + if (!trimmedRaw) { + return { + type: null, + cloneUrl: null, + subdir: null, + localPath: null, + cacheKey: null, + displayName: null, + isValid: false, + error: 'Source is required', + }; + } + + // Extract optional @ suffix from the end of the input. + // Semver-valid characters: letters, digits, dot, hyphen, underscore, plus, slash. + // Raw commit SHAs are NOT supported here — `git clone --branch` can't take + // them; use --pin at the module level or check out the SHA manually. + // Only strip when the tail looks like a ref, so we don't disturb + // URLs without a version spec or the SSH protocol's `git@host:...` prefix. + let trimmed = trimmedRaw; + let versionSuffix = null; + const lastAt = trimmedRaw.lastIndexOf('@'); + // Skip if @ is part of git@github.com:... (first char cannot be stripped as version) + // and skip if @ appears before the path rather than after a ref-shaped tail. + if (lastAt > 0) { + const candidate = trimmedRaw.slice(lastAt + 1); + const before = trimmedRaw.slice(0, lastAt); + // candidate must be ref-shaped and must not itself look like a URL / SSH host + if (/^[\w.\-+/]+$/.test(candidate) && !candidate.includes(':')) { + // Avoid consuming the @ in `git@host:owner/repo` — `before` wouldn't end with a path separator + // in that case. Require that the @ comes after the host/path, not inside the auth segment. + // Rule: the @ is a version suffix only if `before` looks like a complete URL or local path. + const beforeLooksLikeRepo = + before.startsWith('/') || + before.startsWith('./') || + before.startsWith('../') || + before.startsWith('~') || + /^https?:\/\//i.test(before) || + /^git@[^:]+:.+/.test(before); + if (beforeLooksLikeRepo) { + versionSuffix = candidate; + trimmed = before; + } + } + } + + // Local path detection: starts with /, ./, ../, or ~ + if (trimmed.startsWith('/') || trimmed.startsWith('./') || trimmed.startsWith('../') || trimmed.startsWith('~')) { + if (versionSuffix) { + return { + type: 'local', + cloneUrl: null, + subdir: null, + localPath: null, + cacheKey: null, + displayName: null, + isValid: false, + error: 'Local paths do not support @version suffixes', + }; + } + return this._parseLocalPath(trimmed); + } + + // SSH URL: git@host:owner/repo.git + const sshMatch = trimmed.match(/^git@([^:]+):([^/]+)\/([^/.]+?)(?:\.git)?$/); + if (sshMatch) { + const [, host, owner, repo] = sshMatch; + return { + type: 'url', + cloneUrl: trimmed, + subdir: null, + localPath: null, + version: versionSuffix || null, + rawInput: trimmedRaw, + cacheKey: `${host}/${owner}/${repo}`, + displayName: `${owner}/${repo}`, + isValid: true, + error: null, + }; + } + + // HTTPS/HTTP URL: https://host/owner/repo[/tree/branch/subdir][.git] + const httpsMatch = trimmed.match(/^(https?):\/\/([^/]+)\/([^/]+)\/([^/.]+?)(?:\.git)?(\/.*)?$/); + if (httpsMatch) { + const [, protocol, host, owner, repo, remainder] = httpsMatch; + const cloneUrl = `${protocol}://${host}/${owner}/${repo}`; + let subdir = null; + let urlRef = null; // branch/tag extracted from /tree//subdir + + if (remainder) { + // Extract subdir from deep path patterns used by various Git hosts + const deepPathPatterns = [ + { regex: /^\/(?:-\/)?tree\/([^/]+)\/(.+)$/, refIdx: 1, pathIdx: 2 }, // GitHub, GitLab + { regex: /^\/(?:-\/)?blob\/([^/]+)\/(.+)$/, refIdx: 1, pathIdx: 2 }, + { regex: /^\/src\/([^/]+)\/(.+)$/, refIdx: 1, pathIdx: 2 }, // Gitea/Forgejo + ]; + // Also match `/tree/` with no subdir + const refOnlyPatterns = [/^\/(?:-\/)?tree\/([^/]+?)\/?$/, /^\/(?:-\/)?blob\/([^/]+?)\/?$/, /^\/src\/([^/]+?)\/?$/]; + + for (const p of deepPathPatterns) { + const match = remainder.match(p.regex); + if (match) { + urlRef = match[p.refIdx]; + subdir = match[p.pathIdx].replace(/\/$/, ''); + break; + } + } + if (!subdir) { + for (const r of refOnlyPatterns) { + const match = remainder.match(r); + if (match) { + urlRef = match[1]; + break; + } + } + } + } + + // Precedence: explicit @version suffix > URL /tree/ path segment. + const version = versionSuffix || urlRef || null; + + return { + type: 'url', + cloneUrl, + subdir, + localPath: null, + version, + rawInput: trimmedRaw, + cacheKey: `${host}/${owner}/${repo}`, + displayName: `${owner}/${repo}`, + isValid: true, + error: null, + }; + } + + return { + type: null, + cloneUrl: null, + subdir: null, + localPath: null, + cacheKey: null, + displayName: null, + isValid: false, + error: 'Not a valid Git URL or local path', + }; + } + + /** + * Parse a local filesystem path. + * @param {string} rawPath - Path string (may contain ~ for home) + * @returns {Object} Parsed source descriptor + */ + _parseLocalPath(rawPath) { + const expanded = rawPath.startsWith('~') ? path.join(os.homedir(), rawPath.slice(1)) : rawPath; + const resolved = path.resolve(expanded); + + if (!fs.pathExistsSync(resolved)) { + return { + type: 'local', + cloneUrl: null, + subdir: null, + localPath: resolved, + cacheKey: null, + displayName: path.basename(resolved), + isValid: false, + error: `Path does not exist: ${resolved}`, + }; + } + + return { + type: 'local', + cloneUrl: null, + subdir: null, + localPath: resolved, + cacheKey: null, + displayName: path.basename(resolved), + isValid: true, + error: null, + }; + } + + // ─── Marketplace JSON ───────────────────────────────────────────────────── + + /** + * Read .claude-plugin/marketplace.json from a local directory. + * @param {string} dirPath - Directory to read from + * @returns {Object|null} Parsed marketplace.json or null if not found + */ + async readMarketplaceJsonFromDisk(dirPath) { + const marketplacePath = path.join(dirPath, '.claude-plugin', 'marketplace.json'); + if (!(await fs.pathExists(marketplacePath))) return null; + try { + return JSON.parse(await fs.readFile(marketplacePath, 'utf8')); + } catch { + return null; + } + } + + // ─── Discovery ──────────────────────────────────────────────────────────── + + /** + * Discover modules from pre-read marketplace.json data. + * @param {Object} marketplaceData - Parsed marketplace.json content + * @param {string|null} sourceUrl - Source URL for tracking (null for local paths) + * @returns {Array} Normalized plugin list + */ + async discoverModules(marketplaceData, sourceUrl) { + const plugins = marketplaceData?.plugins; + + if (!Array.isArray(plugins) || plugins.length === 0) { + throw new Error('marketplace.json contains no plugins'); + } + + return plugins.map((plugin) => this._normalizeCustomModule(plugin, sourceUrl, marketplaceData)); + } + + // ─── Source Resolution ──────────────────────────────────────────────────── + + /** + * High-level coordinator: parse input, clone if URL, determine discovery vs direct mode. + * @param {string} input - URL or local path + * @param {Object} [options] - Options passed to cloneRepo + * @returns {Object} { parsed, rootDir, repoPath, sourceUrl, marketplace, mode: 'discovery'|'direct' } + */ + async resolveSource(input, options = {}) { + const parsed = this.parseSource(input); + if (!parsed.isValid) throw new Error(parsed.error); + + let rootDir; + let repoPath; + let sourceUrl; + + if (parsed.type === 'local') { + rootDir = parsed.localPath; + repoPath = null; + sourceUrl = null; + } else { + repoPath = await this.cloneRepo(input, options); + sourceUrl = parsed.cloneUrl; + rootDir = parsed.subdir ? path.join(repoPath, parsed.subdir) : repoPath; + + if (parsed.subdir && !(await fs.pathExists(rootDir))) { + throw new Error(`Subdirectory '${parsed.subdir}' not found in cloned repository`); + } + } + + const marketplace = await this.readMarketplaceJsonFromDisk(rootDir); + const mode = marketplace ? 'discovery' : 'direct'; + + return { parsed, rootDir, repoPath, sourceUrl, marketplace, mode }; + } + + // ─── Clone ──────────────────────────────────────────────────────────────── + + /** + * Get the cache directory for custom modules. + * @returns {string} Path to the custom modules cache directory + */ + getCacheDir() { + return path.join(os.homedir(), '.bmad', 'cache', 'custom-modules'); + } + + /** + * Clone a custom module repository to cache. + * Supports any Git host (GitHub, GitLab, Bitbucket, self-hosted, etc.). + * @param {string} sourceInput - Git URL (HTTPS, HTTP, or SSH) + * @param {Object} [options] - Clone options + * @param {boolean} [options.silent] - Suppress spinner output + * @param {boolean} [options.skipInstall] - Skip npm install (for browsing before user confirms) + * @returns {string} Path to the cloned repository + */ + async cloneRepo(sourceInput, options = {}) { + const parsed = this.parseSource(sourceInput); + if (!parsed.isValid) throw new Error(parsed.error); + if (parsed.type === 'local') throw new Error('cloneRepo does not accept local paths'); + + const cacheDir = this.getCacheDir(); + const repoCacheDir = path.join(cacheDir, ...parsed.cacheKey.split('/')); + const silent = options.silent || false; + const displayName = parsed.displayName; + + // Pin override: --pin CODE=TAG resolved at module-selection time overrides + // any @version suffix present in the URL. + const effectiveVersion = options.pinOverride || parsed.version || null; + + await fs.ensureDir(path.dirname(repoCacheDir)); + + const createSpinner = async () => { + if (silent) { + return { start() {}, stop() {}, error() {} }; + } + return await prompts.spinner(); + }; + + // If an existing cache exists but was cloned at a different version, re-clone. + // Tracked via .bmad-source.json's recorded version. + if (await fs.pathExists(repoCacheDir)) { + let cachedVersion = null; + try { + const existing = await fs.readJson(path.join(repoCacheDir, '.bmad-source.json')); + cachedVersion = existing?.version || null; + } catch { + // no metadata; treat as mismatched to be safe if a version was requested + } + if ((effectiveVersion || null) !== (cachedVersion || null)) { + await fs.remove(repoCacheDir); + } + } + + if (await fs.pathExists(repoCacheDir)) { + // Update existing clone (same version as before) + const fetchSpinner = await createSpinner(); + fetchSpinner.start(`Updating ${displayName}...`); + try { + execSync('git fetch origin --depth 1', { + cwd: repoCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + if (effectiveVersion) { + // Fetch the ref as either a tag or a branch — `origin ` works + // for both, whereas `origin tag ` fails for branch refs parsed + // out of /tree//... URLs. + execSync(`git fetch --depth 1 origin ${quoteCustomRef(effectiveVersion)} --no-tags`, { + cwd: repoCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + execSync(`git checkout --quiet FETCH_HEAD`, { + cwd: repoCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + }); + } else { + execSync('git reset --hard origin/HEAD', { + cwd: repoCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + }); + } + fetchSpinner.stop(`Updated ${displayName}`); + } catch { + fetchSpinner.error(`Update failed, re-downloading ${displayName}`); + await fs.remove(repoCacheDir); + } + } + + if (!(await fs.pathExists(repoCacheDir))) { + const fetchSpinner = await createSpinner(); + fetchSpinner.start(`Cloning ${displayName}${effectiveVersion ? ` @ ${effectiveVersion}` : ''}...`); + try { + if (effectiveVersion) { + execSync(`git clone --depth 1 --branch ${quoteCustomRef(effectiveVersion)} "${parsed.cloneUrl}" "${repoCacheDir}"`, { + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } else { + execSync(`git clone --depth 1 "${parsed.cloneUrl}" "${repoCacheDir}"`, { + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } + fetchSpinner.stop(`Cloned ${displayName}`); + } catch (error_) { + fetchSpinner.error(`Failed to clone ${displayName}`); + const refSuffix = effectiveVersion ? `@${effectiveVersion}` : ''; + throw new Error(`Failed to clone ${parsed.cloneUrl}${refSuffix}: ${error_.message}`); + } + } + + // Record the resolved SHA for the manifest writer. + let resolvedSha = null; + try { + resolvedSha = execSync('git rev-parse HEAD', { cwd: repoCacheDir, stdio: 'pipe' }).toString().trim(); + } catch { + // swallow — a non-git repo (local path) wouldn't reach here anyway + } + + // Write source metadata for later URL reconstruction + const metadataPath = path.join(repoCacheDir, '.bmad-source.json'); + await fs.writeJson(metadataPath, { + cloneUrl: parsed.cloneUrl, + cacheKey: parsed.cacheKey, + displayName: parsed.displayName, + version: effectiveVersion || null, + rawInput: parsed.rawInput || sourceInput, + sha: resolvedSha, + clonedAt: new Date().toISOString(), + }); + + // Install dependencies if package.json exists (skip during browsing/analysis) + const packageJsonPath = path.join(repoCacheDir, 'package.json'); + if (!options.skipInstall && (await fs.pathExists(packageJsonPath))) { + const installSpinner = await createSpinner(); + installSpinner.start(`Installing dependencies for ${displayName}...`); + try { + execSync('npm install --omit=dev --no-audit --no-fund --no-progress --legacy-peer-deps', { + cwd: repoCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + timeout: 120_000, + }); + installSpinner.stop(`Installed dependencies for ${displayName}`); + } catch (error_) { + installSpinner.error(`Failed to install dependencies for ${displayName}`); + if (!silent) await prompts.log.warn(` ${error_.message}`); + } + } + + return repoCacheDir; + } + + // ─── Plugin Resolution ──────────────────────────────────────────────────── + + /** + * Resolve a plugin to determine installation strategy and module registration files. + * Results are cached in _resolutionCache keyed by module code. + * @param {string} repoPath - Absolute path to the cloned repository or local directory + * @param {Object} plugin - Raw plugin object from marketplace.json + * @param {string} [sourceUrl] - Original URL for manifest tracking (null for local) + * @param {string} [localPath] - Local source path for manifest tracking (null for URLs) + * @returns {Promise>} Array of ResolvedModule objects + */ + async resolvePlugin(repoPath, plugin, sourceUrl, localPath) { + const { PluginResolver } = require('./plugin-resolver'); + const resolver = new PluginResolver(); + const resolved = await resolver.resolve(repoPath, plugin); + + // Read clone metadata (written by cloneRepo) so we can pick up the + // resolved git ref + SHA for manifest recording. + let cloneMetadata = null; + if (sourceUrl) { + try { + cloneMetadata = await fs.readJson(path.join(repoPath, '.bmad-source.json')); + } catch { + // no metadata — local-source or legacy cache + } + } + + // Stamp source info onto each resolved module for manifest tracking + for (const mod of resolved) { + if (sourceUrl) mod.repoUrl = sourceUrl; + if (localPath) mod.localPath = localPath; + if (cloneMetadata) { + mod.cloneRef = cloneMetadata.version || null; + mod.cloneSha = cloneMetadata.sha || null; + mod.rawInput = cloneMetadata.rawInput || null; + } + CustomModuleManager._resolutionCache.set(mod.code, mod); + } + + return resolved; + } + + /** + * Get a cached resolution result by module code. + * @param {string} moduleCode - Module code to look up + * @returns {Object|null} ResolvedModule or null if not cached + */ + getResolution(moduleCode) { + return CustomModuleManager._resolutionCache.get(moduleCode) || null; + } + + // ─── Source Finding ─────────────────────────────────────────────────────── + + /** + * Find the module source path within a cached or local source directory. + * @param {string} sourceInput - Git URL or local path (used to locate cached clone) + * @param {string} [pluginSource] - Plugin source path from marketplace.json + * @returns {string|null} Path to directory containing module.yaml + */ + async findModuleSource(sourceInput, pluginSource) { + const parsed = this.parseSource(sourceInput); + if (!parsed.isValid) return null; + + let baseDir; + if (parsed.type === 'local') { + baseDir = parsed.localPath; + } else { + baseDir = path.join(this.getCacheDir(), ...parsed.cacheKey.split('/')); + } + + if (!(await fs.pathExists(baseDir))) return null; + + // Try plugin source path first (e.g., "./src/pro-skills") + if (pluginSource) { + const sourcePath = path.join(baseDir, pluginSource); + const moduleYaml = path.join(sourcePath, 'module.yaml'); + if (await fs.pathExists(moduleYaml)) { + return sourcePath; + } + } + + // Fallback: search skills/ and src/ directories + for (const dir of ['skills', 'src']) { + const rootCandidate = path.join(baseDir, dir, 'module.yaml'); + if (await fs.pathExists(rootCandidate)) { + return path.dirname(rootCandidate); + } + const dirPath = path.join(baseDir, dir); + if (await fs.pathExists(dirPath)) { + const entries = await fs.readdir(dirPath, { withFileTypes: true }); + for (const entry of entries) { + if (entry.isDirectory()) { + const subCandidate = path.join(dirPath, entry.name, 'module.yaml'); + if (await fs.pathExists(subCandidate)) { + return path.dirname(subCandidate); + } + } + } + } + } + + // Check base directory root + const rootCandidate = path.join(baseDir, 'module.yaml'); + if (await fs.pathExists(rootCandidate)) { + return baseDir; + } + + return null; + } + + /** + * Find module source by module code, searching the custom cache. + * Handles both new 3-level cache structure (host/owner/repo) and + * legacy 2-level structure (owner/repo). + * @param {string} moduleCode - Module code to search for + * @param {Object} [options] - Options + * @returns {string|null} Path to the module source or null + */ + async findModuleSourceByCode(moduleCode, options = {}) { + // Check resolution cache first (populated by resolvePlugin) + const resolved = CustomModuleManager._resolutionCache.get(moduleCode); + if (resolved) { + // For strategies 1-2: the common parent or setup skill's parent has the module files + if (resolved.moduleYamlPath) { + return path.dirname(resolved.moduleYamlPath); + } + // For strategy 5 (synthesized): return the first skill's parent as a reference path + if (resolved.skillPaths && resolved.skillPaths.length > 0) { + return path.dirname(resolved.skillPaths[0]); + } + } + + const cacheDir = this.getCacheDir(); + if (!(await fs.pathExists(cacheDir))) return null; + + // Search through all cached repo roots + try { + const { PluginResolver } = require('./plugin-resolver'); + const resolver = new PluginResolver(); + const repoRoots = await this._findCacheRepoRoots(cacheDir); + + for (const { repoPath, metadata } of repoRoots) { + // Check marketplace.json for matching module code + const marketplacePath = path.join(repoPath, '.claude-plugin', 'marketplace.json'); + if (!(await fs.pathExists(marketplacePath))) continue; + + try { + const data = JSON.parse(await fs.readFile(marketplacePath, 'utf8')); + for (const plugin of data.plugins || []) { + // Direct name match (legacy behavior) + if (plugin.name === moduleCode) { + const sourcePath = plugin.source ? path.join(repoPath, plugin.source) : repoPath; + const moduleYaml = path.join(sourcePath, 'module.yaml'); + if (await fs.pathExists(moduleYaml)) { + return sourcePath; + } + } + + // Resolve plugin to check if any module.yaml code matches + if (plugin.skills && plugin.skills.length > 0) { + try { + const resolvedMods = await resolver.resolve(repoPath, plugin); + for (const mod of resolvedMods) { + if (mod.code === moduleCode) { + // Use metadata for URL reconstruction instead of deriving from path + mod.repoUrl = metadata?.cloneUrl || null; + CustomModuleManager._resolutionCache.set(mod.code, mod); + if (mod.moduleYamlPath) { + return path.dirname(mod.moduleYamlPath); + } + if (mod.skillPaths && mod.skillPaths.length > 0) { + return path.dirname(mod.skillPaths[0]); + } + } + } + } catch { + // Skip unresolvable plugins + } + } + } + } catch { + // Skip malformed marketplace.json + } + } + } catch { + // Cache doesn't exist or is inaccessible + } + + // Fallback: check manifest for localPath (local-source modules not in cache) + return this._findLocalSourceFromManifest(moduleCode, options); + } + + /** + * Check the installation manifest for a localPath entry for this module. + * Used as fallback when the module was installed from a local source (no cache entry). + * Returns the path only if it still exists on disk; never removes installed files. + * @param {string} moduleCode - Module code to search for + * @param {Object} [options] - Options (must include bmadDir or will search common locations) + * @returns {string|null} Path to the local module source or null + */ + async _findLocalSourceFromManifest(moduleCode, options = {}) { + try { + const { Manifest } = require('../core/manifest'); + const manifestObj = new Manifest(); + + // Try to find bmadDir from options or common locations + const bmadDir = options.bmadDir; + if (!bmadDir) return null; + + const manifestData = await manifestObj.read(bmadDir); + if (!manifestData?.modulesDetailed) return null; + + const moduleEntry = manifestData.modulesDetailed.find((m) => m.name === moduleCode); + if (!moduleEntry?.localPath) return null; + + // Only return the path if it still exists (source not removed) + if (await fs.pathExists(moduleEntry.localPath)) { + return moduleEntry.localPath; + } + + return null; + } catch { + return null; + } + } + + /** + * Recursively find repo root directories within the cache. + * A repo root is identified by containing .bmad-source.json (new) or .claude-plugin/ (legacy). + * Handles both 3-level (host/owner/repo) and legacy 2-level (owner/repo) cache layouts. + * @param {string} dir - Directory to search + * @param {number} [depth=0] - Current recursion depth + * @param {number} [maxDepth=4] - Maximum recursion depth + * @returns {Promise>} + */ + async _findCacheRepoRoots(dir, depth = 0, maxDepth = 4) { + const results = []; + + // Check if this directory is a repo root + const metadataPath = path.join(dir, '.bmad-source.json'); + const claudePluginDir = path.join(dir, '.claude-plugin'); + + if (await fs.pathExists(metadataPath)) { + try { + const metadata = JSON.parse(await fs.readFile(metadataPath, 'utf8')); + results.push({ repoPath: dir, metadata }); + } catch { + results.push({ repoPath: dir, metadata: null }); + } + return results; // Don't recurse into repo contents + } + if (await fs.pathExists(claudePluginDir)) { + results.push({ repoPath: dir, metadata: null }); + return results; + } + + // Recurse into subdirectories + if (depth >= maxDepth) return results; + try { + const entries = await fs.readdir(dir, { withFileTypes: true }); + for (const entry of entries) { + if (!entry.isDirectory() || entry.name.startsWith('.')) continue; + const subResults = await this._findCacheRepoRoots(path.join(dir, entry.name), depth + 1, maxDepth); + results.push(...subResults); + } + } catch { + // Directory not readable + } + return results; + } + + // ─── Normalization ──────────────────────────────────────────────────────── + + /** + * Normalize a plugin from marketplace.json to a consistent shape. + * @param {Object} plugin - Plugin object from marketplace.json + * @param {string|null} sourceUrl - Source URL (null for local paths) + * @param {Object} data - Full marketplace.json data + * @returns {Object} Normalized module info + */ + _normalizeCustomModule(plugin, sourceUrl, data) { + return { + code: plugin.name, + name: plugin.name, + displayName: plugin.name, + description: plugin.description || '', + version: plugin.version || null, + author: plugin.author || data.owner || '', + url: sourceUrl || null, + source: plugin.source || null, + skills: plugin.skills || [], + rawPlugin: plugin, + type: 'custom', + trustTier: 'unverified', + builtIn: false, + isExternal: true, + }; + } +} + +module.exports = { CustomModuleManager }; diff --git a/tools/installer/modules/custom-modules.js b/tools/installer/modules/custom-modules.js deleted file mode 100644 index 3f8b793be..000000000 --- a/tools/installer/modules/custom-modules.js +++ /dev/null @@ -1,302 +0,0 @@ -const path = require('node:path'); -const fs = require('fs-extra'); -const yaml = require('yaml'); -const { CustomHandler } = require('../custom-handler'); -const { Manifest } = require('../core/manifest'); -const prompts = require('../prompts'); - -class CustomModules { - constructor() { - this.paths = new Map(); - } - - has(moduleCode) { - return this.paths.has(moduleCode); - } - - get(moduleCode) { - return this.paths.get(moduleCode); - } - - set(moduleId, sourcePath) { - this.paths.set(moduleId, sourcePath); - } - - /** - * Install a custom module from its source path. - * @param {string} moduleName - Module identifier - * @param {string} bmadDir - Target bmad directory - * @param {Function} fileTrackingCallback - Optional callback to track installed files - * @param {Object} options - Install options - * @param {Object} options.moduleConfig - Pre-collected module configuration - * @returns {Object} Install result - */ - async install(moduleName, bmadDir, fileTrackingCallback = null, options = {}) { - const sourcePath = this.paths.get(moduleName); - if (!sourcePath) { - throw new Error(`No source path for custom module '${moduleName}'`); - } - - if (!(await fs.pathExists(sourcePath))) { - throw new Error(`Source for custom module '${moduleName}' not found at: ${sourcePath}`); - } - - const targetPath = path.join(bmadDir, moduleName); - - // Read custom.yaml and merge into module config - let moduleConfig = options.moduleConfig ? { ...options.moduleConfig } : {}; - const customConfigPath = path.join(sourcePath, 'custom.yaml'); - if (await fs.pathExists(customConfigPath)) { - try { - const content = await fs.readFile(customConfigPath, 'utf8'); - const customConfig = yaml.parse(content); - if (customConfig) { - moduleConfig = { ...moduleConfig, ...customConfig }; - } - } catch (error) { - await prompts.log.warn(`Failed to read custom.yaml for ${moduleName}: ${error.message}`); - } - } - - // Remove existing installation - if (await fs.pathExists(targetPath)) { - await fs.remove(targetPath); - } - - // Copy files with filtering - await this._copyWithFiltering(sourcePath, targetPath, fileTrackingCallback); - - // Add to manifest - const manifest = new Manifest(); - const versionInfo = await manifest.getModuleVersionInfo(moduleName, bmadDir, sourcePath); - await manifest.addModule(bmadDir, moduleName, { - version: versionInfo.version, - source: versionInfo.source, - npmPackage: versionInfo.npmPackage, - repoUrl: versionInfo.repoUrl, - }); - - return { success: true, module: moduleName, path: targetPath, moduleConfig }; - } - - /** - * Copy module files, filtering out install-time-only artifacts. - * @param {string} sourcePath - Source module directory - * @param {string} targetPath - Target module directory - * @param {Function} fileTrackingCallback - Optional callback to track installed files - */ - async _copyWithFiltering(sourcePath, targetPath, fileTrackingCallback = null) { - const files = await this._getFileList(sourcePath); - - for (const file of files) { - if (file.startsWith('sub-modules/')) continue; - - const isInSidecar = path - .dirname(file) - .split('/') - .some((dir) => dir.toLowerCase().endsWith('-sidecar')); - if (isInSidecar) continue; - - if (file === 'module.yaml') continue; - if (file === 'config.yaml') continue; - - const sourceFile = path.join(sourcePath, file); - const targetFile = path.join(targetPath, file); - - // Skip web-only agents - if (file.startsWith('agents/') && file.endsWith('.md')) { - const content = await fs.readFile(sourceFile, 'utf8'); - if (/]*\slocalskip="true"[^>]*>/.test(content)) { - continue; - } - } - - await fs.ensureDir(path.dirname(targetFile)); - await fs.copy(sourceFile, targetFile, { overwrite: true }); - - if (fileTrackingCallback) { - fileTrackingCallback(targetFile); - } - } - } - - /** - * Recursively list all files in a directory. - * @param {string} dir - Directory to scan - * @param {string} baseDir - Base directory for relative paths - * @returns {string[]} Relative file paths - */ - async _getFileList(dir, baseDir = dir) { - const files = []; - const entries = await fs.readdir(dir, { withFileTypes: true }); - - for (const entry of entries) { - const fullPath = path.join(dir, entry.name); - if (entry.isDirectory()) { - files.push(...(await this._getFileList(fullPath, baseDir))); - } else { - files.push(path.relative(baseDir, fullPath)); - } - } - - return files; - } - - /** - * Discover custom module source paths from all available sources. - * @param {Object} config - Installation configuration - * @param {Object} paths - InstallPaths instance - * @returns {Map} Map of module ID to source path - */ - async discoverPaths(config, paths) { - this.paths = new Map(); - - if (config._quickUpdate) { - if (config._customModuleSources) { - for (const [moduleId, customInfo] of config._customModuleSources) { - this.paths.set(moduleId, customInfo.sourcePath); - } - } - return this.paths; - } - - // From UI: selectedFiles - if (config.customContent && config.customContent.selected && config.customContent.selectedFiles) { - const customHandler = new CustomHandler(); - for (const customFile of config.customContent.selectedFiles) { - const customInfo = await customHandler.getCustomInfo(customFile, paths.projectRoot); - if (customInfo && customInfo.id) { - this.paths.set(customInfo.id, customInfo.path); - } - } - } - - // From UI: sources - if (config.customContent && config.customContent.sources) { - for (const source of config.customContent.sources) { - this.paths.set(source.id, source.path); - } - } - - // From UI: cachedModules - if (config.customContent && config.customContent.cachedModules) { - const selectedCachedIds = config.customContent.selectedCachedModules || []; - const shouldIncludeAll = selectedCachedIds.length === 0 && config.customContent.selected; - - for (const cachedModule of config.customContent.cachedModules) { - if (cachedModule.id && cachedModule.cachePath && (shouldIncludeAll || selectedCachedIds.includes(cachedModule.id))) { - this.paths.set(cachedModule.id, cachedModule.cachePath); - } - } - } - - return this.paths; - } - - /** - * Assemble quick-update source candidates before install() hands them to discoverPaths(). - * This exists because discoverPaths() consumes already-prepared quick-update sources, - * while quickUpdate() still has to build that source map from manifest, explicit inputs, - * and cache conventions. - * Precedence: manifest-backed paths, explicit sources override them, then cached modules. - * @param {Object} config - Quick update configuration - * @param {Object} existingInstall - Existing installation snapshot - * @param {string} bmadDir - BMAD directory - * @param {Object} externalModuleManager - External module manager - * @returns {Promise>} Map of custom module ID to source info - */ - async assembleQuickUpdateSources(config, existingInstall, bmadDir, externalModuleManager) { - const projectRoot = path.dirname(bmadDir); - const customModuleSources = new Map(); - - if (existingInstall.customModules) { - for (const customModule of existingInstall.customModules) { - // Skip if no ID - can't reliably track or re-cache without it - if (!customModule?.id) continue; - - let sourcePath = customModule.sourcePath; - if (sourcePath && sourcePath.startsWith('_config')) { - // Paths are relative to BMAD dir, but we want absolute paths for install - sourcePath = path.join(bmadDir, sourcePath); - } else if (!sourcePath && customModule.relativePath) { - // Fall back to relativePath - sourcePath = path.resolve(projectRoot, customModule.relativePath); - } else if (sourcePath && !path.isAbsolute(sourcePath)) { - // If we have a sourcePath but it's not absolute, resolve it relative to project root - sourcePath = path.resolve(projectRoot, sourcePath); - } - - // If we still don't have a valid source path, skip this module - if (!sourcePath || !(await fs.pathExists(sourcePath))) { - continue; - } - - customModuleSources.set(customModule.id, { - id: customModule.id, - name: customModule.name || customModule.id, - sourcePath, - relativePath: customModule.relativePath, - cached: false, - }); - } - } - - if (config.customContent?.sources?.length > 0) { - for (const source of config.customContent.sources) { - if (source.id && source.path) { - customModuleSources.set(source.id, { - id: source.id, - name: source.name || source.id, - sourcePath: source.path, - cached: false, // From CLI, will be re-cached - }); - } - } - } - - const cacheDir = path.join(bmadDir, '_config', 'custom'); - if (!(await fs.pathExists(cacheDir))) { - return customModuleSources; - } - - const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true }); - for (const cachedModule of cachedModules) { - const moduleId = cachedModule.name; - const cachedPath = path.join(cacheDir, moduleId); - - // Skip if path doesn't exist (broken symlink, deleted dir) - avoids lstat ENOENT - if (!(await fs.pathExists(cachedPath))) { - continue; - } - if (!cachedModule.isDirectory()) { - continue; - } - - // Skip if we already have this module from manifest - if (customModuleSources.has(moduleId)) { - continue; - } - - // Check if this is an external official module - skip cache for those - const isExternal = await externalModuleManager.hasModule(moduleId); - if (isExternal) { - continue; - } - - // Check if this is actually a custom module (has module.yaml) - const moduleYamlPath = path.join(cachedPath, 'module.yaml'); - if (await fs.pathExists(moduleYamlPath)) { - customModuleSources.set(moduleId, { - id: moduleId, - name: moduleId, - sourcePath: cachedPath, - cached: true, - }); - } - } - - return customModuleSources; - } -} - -module.exports = { CustomModules }; diff --git a/tools/installer/modules/external-manager.js b/tools/installer/modules/external-manager.js index fceb94e22..7d2add4fb 100644 --- a/tools/installer/modules/external-manager.js +++ b/tools/installer/modules/external-manager.js @@ -1,67 +1,158 @@ -const fs = require('fs-extra'); +const fs = require('../fs-native'); const os = require('node:os'); const path = require('node:path'); const { execSync } = require('node:child_process'); const yaml = require('yaml'); const prompts = require('../prompts'); +const { RegistryClient } = require('./registry-client'); +const { resolveChannel, tagExists, parseGitHubRepo } = require('./channel-resolver'); +const { decideChannelForModule } = require('./channel-plan'); + +const VALID_CHANNELS = new Set(['stable', 'next', 'pinned']); + +function normalizeChannelName(raw) { + if (typeof raw !== 'string') return null; + const lower = raw.trim().toLowerCase(); + return VALID_CHANNELS.has(lower) ? lower : null; +} /** - * Manages external official modules defined in external-official-modules.yaml - * These are modules hosted in external repositories that can be installed + * Conservative quoting for tag names passed to git commands. Tags are + * user-typed (--pin) or come from the GitHub API. Only allow the semver + * character class we use to tag BMad releases; anything else throws. + */ +function quoteShell(ref) { + if (typeof ref !== 'string' || !/^[\w.\-+/]+$/.test(ref)) { + throw new Error(`Unsafe ref name: ${JSON.stringify(ref)}`); + } + return `"${ref}"`; +} + +async function readChannelMarker(markerPath) { + try { + if (!(await fs.pathExists(markerPath))) return null; + const content = await fs.readFile(markerPath, 'utf8'); + return JSON.parse(content); + } catch { + return null; + } +} + +async function writeChannelMarker(markerPath, data) { + try { + await fs.writeFile(markerPath, JSON.stringify({ ...data, writtenAt: new Date().toISOString() }, null, 2)); + } catch { + // Best-effort: marker is an optimization, not a correctness requirement. + } +} + +const MARKETPLACE_OWNER = 'bmad-code-org'; +const MARKETPLACE_REPO = 'bmad-plugins-marketplace'; +const MARKETPLACE_REF = 'main'; +const FALLBACK_CONFIG_PATH = path.join(__dirname, 'registry-fallback.yaml'); + +/** + * Manages official modules from the remote BMad marketplace registry. + * Fetches registry/official.yaml from GitHub; falls back to the bundled + * external-official-modules.yaml when the network is unavailable. * * @class ExternalModuleManager */ class ExternalModuleManager { + // moduleCode → { channel, version, ref, sha, repoUrl, resolvedFallback } + // Populated when cloneExternalModule resolves a channel. Shared across all + // instances so the manifest writer (which often instantiates a fresh + // ExternalModuleManager) sees resolutions made during install. + static _resolutions = new Map(); + constructor() { - this.externalModulesConfigPath = path.join(__dirname, '../external-official-modules.yaml'); - this.cachedModules = null; + this._client = new RegistryClient(); } /** - * Load and parse the external-official-modules.yaml file - * @returns {Object} Parsed YAML content with modules object + * Get the most recent channel resolution for a module (if any). + * @param {string} moduleCode + * @returns {Object|null} + */ + getResolution(moduleCode) { + return ExternalModuleManager._resolutions.get(moduleCode) || null; + } + + /** + * Load the official modules registry from GitHub, falling back to the + * bundled YAML file if the fetch fails. + * @returns {Object} Parsed YAML content with modules array */ async loadExternalModulesConfig() { if (this.cachedModules) { return this.cachedModules; } + // Try remote registry first try { - const content = await fs.readFile(this.externalModulesConfigPath, 'utf8'); + const config = await this._client.fetchGitHubYaml(MARKETPLACE_OWNER, MARKETPLACE_REPO, 'registry/official.yaml', MARKETPLACE_REF); + if (config?.modules?.length) { + this.cachedModules = config; + return config; + } + } catch { + // Fall through to local fallback + } + + // Fallback to bundled file + try { + const content = await fs.readFile(FALLBACK_CONFIG_PATH, 'utf8'); const config = yaml.parse(content); this.cachedModules = config; + await prompts.log.warn('Could not reach BMad registry; using bundled module list.'); return config; } catch (error) { - await prompts.log.warn(`Failed to load external modules config: ${error.message}`); - return { modules: {} }; + await prompts.log.warn(`Failed to load modules config: ${error.message}`); + return { modules: [] }; } } /** - * Get list of available external modules + * Normalize a module entry from either the remote registry format + * (snake_case, array) or the legacy bundled format (kebab-case, object map). + * @param {Object} mod - Raw module config from YAML + * @param {string} [key] - Key name (only for legacy map format) + * @returns {Object} Normalized module info + */ + _normalizeModule(mod, key) { + return { + key: key || mod.name, + url: mod.repository || mod.url, + moduleDefinition: mod.module_definition || mod['module-definition'], + code: mod.code, + name: mod.display_name || mod.name, + description: mod.description || '', + defaultSelected: mod.default_selected === true || mod.defaultSelected === true, + type: mod.type || 'bmad-org', + npmPackage: mod.npm_package || mod.npmPackage || null, + defaultChannel: normalizeChannelName(mod.default_channel || mod.defaultChannel) || 'stable', + builtIn: mod.built_in === true, + isExternal: mod.built_in !== true, + }; + } + + /** + * Get list of available modules from the registry * @returns {Array} Array of module info objects */ async listAvailable() { const config = await this.loadExternalModulesConfig(); - const modules = []; - for (const [key, moduleConfig] of Object.entries(config.modules || {})) { - modules.push({ - key, - url: moduleConfig.url, - moduleDefinition: moduleConfig['module-definition'], - code: moduleConfig.code, - name: moduleConfig.name, - header: moduleConfig.header, - subheader: moduleConfig.subheader, - description: moduleConfig.description || '', - defaultSelected: moduleConfig.defaultSelected === true, - type: moduleConfig.type || 'community', // bmad-org or community - npmPackage: moduleConfig.npmPackage || null, // Include npm package name - isExternal: true, - }); + // Remote format: modules is an array + if (Array.isArray(config.modules)) { + return config.modules.map((mod) => this._normalizeModule(mod)); } + // Legacy bundled format: modules is an object map + const modules = []; + for (const [key, mod] of Object.entries(config.modules || {})) { + modules.push(this._normalizeModule(mod, key)); + } return modules; } @@ -75,65 +166,6 @@ class ExternalModuleManager { return modules.find((m) => m.code === code) || null; } - /** - * Get module info by key - * @param {string} key - The module key (e.g., 'bmad-creative-intelligence-suite') - * @returns {Object|null} Module info or null if not found - */ - async getModuleByKey(key) { - const config = await this.loadExternalModulesConfig(); - const moduleConfig = config.modules?.[key]; - - if (!moduleConfig) { - return null; - } - - return { - key, - url: moduleConfig.url, - moduleDefinition: moduleConfig['module-definition'], - code: moduleConfig.code, - name: moduleConfig.name, - header: moduleConfig.header, - subheader: moduleConfig.subheader, - description: moduleConfig.description || '', - defaultSelected: moduleConfig.defaultSelected === true, - type: moduleConfig.type || 'community', // bmad-org or community - npmPackage: moduleConfig.npmPackage || null, // Include npm package name - isExternal: true, - }; - } - - /** - * Check if a module code exists in external modules - * @param {string} code - The module code to check - * @returns {boolean} True if the module exists - */ - async hasModule(code) { - const module = await this.getModuleByCode(code); - return module !== null; - } - - /** - * Get the URL for a module by code - * @param {string} code - The module code - * @returns {string|null} The URL or null if not found - */ - async getModuleUrl(code) { - const module = await this.getModuleByCode(code); - return module ? module.url : null; - } - - /** - * Get the module definition path for a module by code - * @param {string} code - The module code - * @returns {string|null} The module definition path or null if not found - */ - async getModuleDefinition(code) { - const module = await this.getModuleByCode(code); - return module ? module.moduleDefinition : null; - } - /** * Get the cache directory for external modules * @returns {string} Path to the external modules cache directory @@ -144,17 +176,22 @@ class ExternalModuleManager { } /** - * Clone an external module repository to cache + * Clone an external module repository to cache, resolving the requested + * channel (stable / next / pinned) to a concrete git ref. + * * @param {string} moduleCode - Code of the external module * @param {Object} options - Clone options - * @param {boolean} options.silent - Suppress spinner output + * @param {boolean} [options.silent] - Suppress spinner output + * @param {Object} [options.channelOptions] - Parsed channel flags. See + * modules/channel-plan.js. When absent, the module installs on its + * registry-declared default channel (typically 'stable'). * @returns {string} Path to the cloned repository */ async cloneExternalModule(moduleCode, options = {}) { const moduleInfo = await this.getModuleByCode(moduleCode); if (!moduleInfo) { - throw new Error(`External module '${moduleCode}' not found in external-official-modules.yaml`); + throw new Error(`External module '${moduleCode}' not found in the BMad registry`); } const cacheDir = this.getExternalCacheDir(); @@ -185,38 +222,160 @@ class ExternalModuleManager { return await prompts.spinner(); }; - // Track if we need to install dependencies + // ─── Resolve channel plan ───────────────────────────────────────────── + // Post-install callers (config generation, directory setup, help catalog + // rebuild) invoke findModuleSource/cloneExternalModule without + // channelOptions just to locate the module's files. Those calls must not + // redecide the channel — the install step already chose one, cloned the + // right ref, and recorded a resolution. If we re-resolve without flags, + // we'd snap back to stable and overwrite a pinned install. + const hasExplicitChannelInput = + options.channelOptions && + (options.channelOptions.global || + (options.channelOptions.nextSet && options.channelOptions.nextSet.size > 0) || + (options.channelOptions.pins && options.channelOptions.pins.size > 0)); + const existingResolution = ExternalModuleManager._resolutions.get(moduleCode); + const haveUsableCache = await fs.pathExists(moduleCacheDir); + + if (!hasExplicitChannelInput && existingResolution && haveUsableCache) { + // This is a look-up only; the module is already installed at its chosen + // ref. Skip cloning and return the cached path unchanged. + return moduleCacheDir; + } + + const planEntry = decideChannelForModule({ + code: moduleCode, + channelOptions: options.channelOptions, + registryDefault: moduleInfo.defaultChannel, + }); + + // Same-plan short-circuit: a single install calls cloneExternalModule + // several times (config collection, directory setup, help-catalog rebuild) + // with the same channelOptions. The first call resolves + clones; later + // calls with an identical plan and a valid cache should return immediately + // instead of re-running resolveChannel() and `git fetch` (slow; can fail + // on flaky networks even though the tagCache dedupes the GitHub API hit). + if (existingResolution && haveUsableCache && existingResolution.channel === planEntry.channel) { + const samePin = planEntry.channel !== 'pinned' || existingResolution.version === planEntry.pin; + if (samePin) return moduleCacheDir; + } + + let resolved; + try { + resolved = await resolveChannel({ + channel: planEntry.channel, + pin: planEntry.pin, + repoUrl: moduleInfo.url, + }); + } catch (error) { + // Tag-API failure (rate limit, transient network). If we already have + // a usable cache at a recorded ref, treat this as "couldn't check for + // updates" and re-use the cached version silently — that's the right + // call for an update/quick-update, since the semantics don't change + // and the user isn't worse off than before they ran this command. + const cachedMarker = await readChannelMarker(path.join(moduleCacheDir, '.bmad-channel.json')); + if (cachedMarker?.channel && (await fs.pathExists(moduleCacheDir))) { + if (!silent) { + await prompts.log.warn( + `Could not check for updates to ${moduleInfo.name} (${error.message}); using cached ${cachedMarker.version || cachedMarker.channel}.`, + ); + } + ExternalModuleManager._resolutions.set(moduleCode, { + channel: cachedMarker.channel, + version: cachedMarker.version || 'main', + ref: cachedMarker.version && cachedMarker.version !== 'main' ? cachedMarker.version : null, + sha: cachedMarker.sha, + repoUrl: moduleInfo.url, + resolvedFallback: false, + planSource: 'cached', + }); + return moduleCacheDir; + } + // No cache to fall back on — this is effectively a fresh install with + // no offline safety net. Surface a clear error with actionable guidance. + const isRateLimited = /rate limit/i.test(error.message); + const hint = isRateLimited + ? process.env.GITHUB_TOKEN + ? 'Your GITHUB_TOKEN may have expired or been rate-limited on its own budget. Try a different token or wait for the reset.' + : 'Set a GITHUB_TOKEN env var (any personal access token with public-repo read) to raise the 60-req/hour anonymous limit.' + : `Check your network connection, or rerun with \`--next=${moduleCode}\` / \`--pin ${moduleCode}=\` to skip the tag lookup.`; + throw new Error(`Could not resolve stable tag for '${moduleCode}' (${error.message}). ${hint}`); + } + + if (resolved.resolvedFallback && !silent) { + if (resolved.reason === 'no-stable-tags') { + await prompts.log.warn(`No stable releases found for ${moduleInfo.name}; installing from main.`); + } else if (resolved.reason === 'not-a-github-url') { + await prompts.log.warn(`Cannot determine stable tags for ${moduleInfo.name} (non-GitHub URL); installing from main.`); + } + } + + // Validate pin before we burn time cloning. Best-effort: skip on non-GitHub URLs. + if (planEntry.channel === 'pinned') { + const parsed = parseGitHubRepo(moduleInfo.url); + if (parsed) { + try { + const exists = await tagExists(parsed.owner, parsed.repo, planEntry.pin); + if (!exists) { + throw new Error(`Tag '${planEntry.pin}' not found in ${parsed.owner}/${parsed.repo}.`); + } + } catch (error) { + if (error.message?.includes('not found')) throw error; + // Network hiccup on tag verification — let the clone attempt fail clearly. + } + } + } + + // ─── Clone or update cache by resolved channel ──────────────────────── + const markerPath = path.join(moduleCacheDir, '.bmad-channel.json'); + const currentMarker = await readChannelMarker(markerPath); + const needsChannelReset = currentMarker && currentMarker.channel !== resolved.channel; + let needsDependencyInstall = false; let wasNewClone = false; - // Check if already cloned + if (needsChannelReset && (await fs.pathExists(moduleCacheDir))) { + // Channel changed (e.g. user switched stable→next). Blow away and re-clone + // to avoid tangling shallow clones of different refs. + await fs.remove(moduleCacheDir); + } + if (await fs.pathExists(moduleCacheDir)) { - // Try to update if it's a git repo + // Cache exists on the right channel. Refresh the ref. const fetchSpinner = await createSpinner(); fetchSpinner.start(`Fetching ${moduleInfo.name}...`); try { - const currentRef = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); - // Fetch and reset to remote - works better with shallow clones than pull - execSync('git fetch origin --depth 1', { - cwd: moduleCacheDir, - stdio: ['ignore', 'pipe', 'pipe'], - env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, - }); - execSync('git reset --hard origin/HEAD', { - cwd: moduleCacheDir, - stdio: ['ignore', 'pipe', 'pipe'], - env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, - }); - const newRef = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + const currentSha = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); - fetchSpinner.stop(`Fetched ${moduleInfo.name}`); - // Force dependency install if we got new code - if (currentRef !== newRef) { - needsDependencyInstall = true; + if (resolved.channel === 'next') { + execSync('git fetch origin --depth 1', { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + execSync('git reset --hard origin/HEAD', { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } else { + // stable or pinned — fetch the specific tag and check it out. + execSync(`git fetch --depth 1 origin tag ${quoteShell(resolved.ref)} --no-tags`, { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + execSync(`git checkout --quiet FETCH_HEAD`, { + cwd: moduleCacheDir, + stdio: ['ignore', 'pipe', 'pipe'], + }); } + + const newSha = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + fetchSpinner.stop(`Fetched ${moduleInfo.name}`); + if (currentSha !== newSha) needsDependencyInstall = true; } catch { fetchSpinner.error(`Fetch failed, re-downloading ${moduleInfo.name}`); - // If update fails, remove and re-clone await fs.remove(moduleCacheDir); wasNewClone = true; } @@ -224,22 +383,41 @@ class ExternalModuleManager { wasNewClone = true; } - // Clone if not exists or was removed if (wasNewClone) { const fetchSpinner = await createSpinner(); fetchSpinner.start(`Fetching ${moduleInfo.name}...`); try { - execSync(`git clone --depth 1 "${moduleInfo.url}" "${moduleCacheDir}"`, { - stdio: ['ignore', 'pipe', 'pipe'], - env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, - }); + if (resolved.channel === 'next') { + execSync(`git clone --depth 1 "${moduleInfo.url}" "${moduleCacheDir}"`, { + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } else { + execSync(`git clone --depth 1 --branch ${quoteShell(resolved.ref)} "${moduleInfo.url}" "${moduleCacheDir}"`, { + stdio: ['ignore', 'pipe', 'pipe'], + env: { ...process.env, GIT_TERMINAL_PROMPT: '0' }, + }); + } fetchSpinner.stop(`Fetched ${moduleInfo.name}`); } catch (error) { fetchSpinner.error(`Failed to fetch ${moduleInfo.name}`); - throw new Error(`Failed to clone external module '${moduleCode}': ${error.message}`); + throw new Error(`Failed to clone external module '${moduleCode}' at ${resolved.version}: ${error.message}`); } } + // Record resolution (channel + tag + SHA) for the manifest writer to pick up. + const sha = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim(); + ExternalModuleManager._resolutions.set(moduleCode, { + channel: resolved.channel, + version: resolved.version, + ref: resolved.ref, + sha, + repoUrl: moduleInfo.url, + resolvedFallback: !!resolved.resolvedFallback, + planSource: planEntry.source, + }); + await writeChannelMarker(markerPath, { channel: resolved.channel, version: resolved.version, sha }); + // Install dependencies if package.json exists const packageJsonPath = path.join(moduleCacheDir, 'package.json'); const nodeModulesPath = path.join(moduleCacheDir, 'node_modules'); @@ -304,7 +482,7 @@ class ExternalModuleManager { async findExternalModuleSource(moduleCode, options = {}) { const moduleInfo = await this.getModuleByCode(moduleCode); - if (!moduleInfo) { + if (!moduleInfo || moduleInfo.builtIn) { return null; } @@ -349,6 +527,7 @@ class ExternalModuleManager { // Nothing found: return configured path (preserves old behavior for error messaging) return path.dirname(configuredPath); } + cachedModules = null; } module.exports = { ExternalModuleManager }; diff --git a/tools/installer/modules/official-modules.js b/tools/installer/modules/official-modules.js index 5b67fc4dd..4bd1e56b3 100644 --- a/tools/installer/modules/official-modules.js +++ b/tools/installer/modules/official-modules.js @@ -1,5 +1,5 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const fs = require('../fs-native'); const yaml = require('yaml'); const prompts = require('../prompts'); const { getProjectRoot, getSourcePath, getModulePath } = require('../project-root'); @@ -12,7 +12,14 @@ class OfficialModules { // Config collection state (merged from ConfigCollector) this.collectedConfig = {}; this._existingConfig = null; + // Tracked during interactive config collection so {directory_name} + // placeholder defaults can be resolved in buildQuestion(). this.currentProjectDir = null; + // Install-time channel flag state. Set by Config.build once, then used as + // the default for every findModuleSource/cloneExternalModule call so that + // pre-install config collection and the install step agree on which ref + // to clone. + this.channelOptions = options.channelOptions || null; } /** @@ -36,7 +43,7 @@ class OfficialModules { * @returns {OfficialModules} */ static async build(config, paths) { - const instance = new OfficialModules(); + const instance = new OfficialModules({ channelOptions: config.channelOptions }); // Pre-collected by UI or quickUpdate — store and load existing for path-change detection if (config.moduleConfigs) { @@ -98,11 +105,10 @@ class OfficialModules { /** * List all available built-in modules (core and bmm). * All other modules come from external-official-modules.yaml - * @returns {Object} Object with modules array and customModules array + * @returns {Object} Object with modules array */ async listAvailable() { const modules = []; - const customModules = []; // Add built-in core module (directly under src/core-skills) const corePath = getSourcePath('core-skills'); @@ -122,7 +128,7 @@ class OfficialModules { } } - return { modules, customModules }; + return { modules }; } /** @@ -133,25 +139,28 @@ class OfficialModules { * @returns {Object|null} Module info or null if not a valid module */ async getModuleInfo(modulePath, defaultName, sourceDescription) { - // Check for module structure (module.yaml OR custom.yaml) const moduleConfigPath = path.join(modulePath, 'module.yaml'); - const rootCustomConfigPath = path.join(modulePath, 'custom.yaml'); - let configPath = null; - if (await fs.pathExists(moduleConfigPath)) { - configPath = moduleConfigPath; - } else if (await fs.pathExists(rootCustomConfigPath)) { - configPath = rootCustomConfigPath; - } - - // Skip if this doesn't look like a module - if (!configPath) { + if (!(await fs.pathExists(moduleConfigPath))) { + // Check resolution cache for strategy 5 modules (no module.yaml on disk) + const { CustomModuleManager } = require('./custom-module-manager'); + const customMgr = new CustomModuleManager(); + const resolved = customMgr.getResolution(defaultName); + if (resolved && resolved.synthesizedModuleYaml) { + return { + id: resolved.code, + path: modulePath, + name: resolved.name, + description: resolved.description, + version: resolved.version || '1.0.0', + source: sourceDescription, + dependencies: [], + defaultSelected: false, + }; + } return null; } - // Mark as custom if it's using custom.yaml OR if it's outside src/bmm or src/core - const isCustomSource = - sourceDescription !== 'src/bmm-skills' && sourceDescription !== 'src/core-skills' && sourceDescription !== 'src/modules'; const moduleInfo = { id: defaultName, path: modulePath, @@ -162,12 +171,11 @@ class OfficialModules { description: 'BMAD Module', version: '5.0.0', source: sourceDescription, - isCustom: configPath === rootCustomConfigPath || isCustomSource, }; // Read module config for metadata try { - const configContent = await fs.readFile(configPath, 'utf8'); + const configContent = await fs.readFile(moduleConfigPath, 'utf8'); const config = yaml.parse(configContent); // Use the code property as the id if available @@ -193,6 +201,12 @@ class OfficialModules { * @returns {string|null} Path to the module source or null if not found */ async findModuleSource(moduleCode, options = {}) { + // Inherit channelOptions from the install-scoped instance when the caller + // didn't pass one explicitly. Keeps pre-install config collection and the + // actual install step looking at the same git ref. + if (options.channelOptions === undefined && this.channelOptions) { + options = { ...options, channelOptions: this.channelOptions }; + } const projectRoot = getProjectRoot(); // Check for core module (directly under src/core-skills) @@ -211,12 +225,28 @@ class OfficialModules { } } - // Check external official modules + // Check external official modules (pass channelOptions so channel plan applies) const externalSource = await this.externalModuleManager.findExternalModuleSource(moduleCode, options); if (externalSource) { return externalSource; } + // Check community modules (pass channelOptions for --next/--pin overrides) + const { CommunityModuleManager } = require('./community-manager'); + const communityMgr = new CommunityModuleManager(); + const communitySource = await communityMgr.findModuleSource(moduleCode, options); + if (communitySource) { + return communitySource; + } + + // Check custom modules (from user-provided URLs, already cloned to cache) + const { CustomModuleManager } = require('./custom-module-manager'); + const customMgr = new CustomModuleManager(); + const customSource = await customMgr.findModuleSourceByCode(moduleCode, options); + if (customSource) { + return customSource; + } + return null; } @@ -231,7 +261,33 @@ class OfficialModules { * @param {Object} options.logger - Logger instance for output */ async install(moduleName, bmadDir, fileTrackingCallback = null, options = {}) { - const sourcePath = await this.findModuleSource(moduleName, { silent: options.silent }); + // Check if this module has a plugin resolution (custom marketplace install) + const { CustomModuleManager } = require('./custom-module-manager'); + const customMgr = new CustomModuleManager(); + const resolved = customMgr.getResolution(moduleName); + if (resolved) { + return this.installFromResolution(resolved, bmadDir, fileTrackingCallback, options); + } + + // Community modules whose cloned repo ships marketplace.json get the same + // skill-level install treatment as custom-source installs. If the in-process + // cache wasn't populated (e.g. caller skipped the pre-clone phase), fall + // back to resolving directly from `~/.bmad/cache/community-modules//` + // so we don't silently regress to the legacy half-install path. + const { CommunityModuleManager } = require('./community-manager'); + const communityMgr = new CommunityModuleManager(); + let communityResolved = communityMgr.getPluginResolution(moduleName); + if (!communityResolved) { + communityResolved = await communityMgr.resolveFromCache(moduleName); + } + if (communityResolved) { + return this.installFromResolution(communityResolved, bmadDir, fileTrackingCallback, options); + } + + const sourcePath = await this.findModuleSource(moduleName, { + silent: options.silent, + channelOptions: options.channelOptions, + }); const targetPath = path.join(bmadDir, moduleName); if (!sourcePath) { @@ -254,16 +310,113 @@ class OfficialModules { const manifestObj = new Manifest(); const versionInfo = await manifestObj.getModuleVersionInfo(moduleName, bmadDir, sourcePath); + // Pick up channel resolution recorded by whichever manager did the clone. + const externalResolution = this.externalModuleManager.getResolution(moduleName); + let communityResolution = null; + if (!externalResolution) { + const { CommunityModuleManager } = require('./community-manager'); + communityResolution = new CommunityModuleManager().getResolution(moduleName); + } + const resolution = externalResolution || communityResolution; + await manifestObj.addModule(bmadDir, moduleName, { - version: versionInfo.version, + version: resolution?.version || versionInfo.version, source: versionInfo.source, npmPackage: versionInfo.npmPackage, repoUrl: versionInfo.repoUrl, + channel: resolution?.channel, + sha: resolution?.sha, + registryApprovedTag: communityResolution?.registryApprovedTag, + registryApprovedSha: communityResolution?.registryApprovedSha, }); return { success: true, module: moduleName, path: targetPath, versionInfo }; } + /** + * Install a module from a PluginResolver resolution result. + * Copies specific skill directories and places module-help.csv at the target root. + * @param {Object} resolved - ResolvedModule from PluginResolver + * @param {string} bmadDir - Target bmad directory + * @param {Function} fileTrackingCallback - Optional callback to track installed files + * @param {Object} options - Installation options + */ + async installFromResolution(resolved, bmadDir, fileTrackingCallback = null, options = {}) { + const targetPath = path.join(bmadDir, resolved.code); + + if (await fs.pathExists(targetPath)) { + await fs.remove(targetPath); + } + + await fs.ensureDir(targetPath); + + // Copy each skill directory, flattened by leaf name + for (const skillPath of resolved.skillPaths) { + const skillDirName = path.basename(skillPath); + const skillTarget = path.join(targetPath, skillDirName); + await this.copyModuleWithFiltering(skillPath, skillTarget, fileTrackingCallback, options.moduleConfig); + } + + // Place module-help.csv at the module root + if (resolved.moduleHelpCsvPath) { + // Strategies 1-4: copy the existing file + const helpTarget = path.join(targetPath, 'module-help.csv'); + await fs.copy(resolved.moduleHelpCsvPath, helpTarget, { overwrite: true }); + if (fileTrackingCallback) fileTrackingCallback(helpTarget); + } else if (resolved.synthesizedHelpCsv) { + // Strategy 5: write synthesized content + const helpTarget = path.join(targetPath, 'module-help.csv'); + await fs.writeFile(helpTarget, resolved.synthesizedHelpCsv, 'utf8'); + if (fileTrackingCallback) fileTrackingCallback(helpTarget); + } + + // Create directories declared in module.yaml (strategies 1-4 may have these) + if (!options.skipModuleInstaller) { + await this.createModuleDirectories(resolved.code, bmadDir, options); + } + + // Update manifest. For community installs we honor the channel resolved by + // CommunityModuleManager (stable/next/pinned) and propagate the registry's + // approved tag/sha. For custom-source installs we derive channel from the + // cloneRef (present → pinned, absent → next; local paths have no channel). + const { Manifest } = require('../core/manifest'); + const manifestObj = new Manifest(); + + const hasGitClone = !!resolved.repoUrl; + const isCommunity = resolved.communitySource === true; + const manifestEntry = { + version: resolved.communityVersion || resolved.cloneRef || (hasGitClone ? 'main' : resolved.version || null), + source: isCommunity ? 'community' : 'custom', + npmPackage: null, + repoUrl: resolved.repoUrl || null, + }; + if (isCommunity) { + if (resolved.communityChannel) manifestEntry.channel = resolved.communityChannel; + if (resolved.cloneSha) manifestEntry.sha = resolved.cloneSha; + if (resolved.registryApprovedTag) manifestEntry.registryApprovedTag = resolved.registryApprovedTag; + if (resolved.registryApprovedSha) manifestEntry.registryApprovedSha = resolved.registryApprovedSha; + } else if (hasGitClone) { + manifestEntry.channel = resolved.cloneRef ? 'pinned' : 'next'; + if (resolved.cloneSha) manifestEntry.sha = resolved.cloneSha; + if (resolved.rawInput) manifestEntry.rawSource = resolved.rawInput; + } + if (resolved.localPath) manifestEntry.localPath = resolved.localPath; + await manifestObj.addModule(bmadDir, resolved.code, manifestEntry); + + return { + success: true, + module: resolved.code, + path: targetPath, + // Mirror the manifestEntry.version precedence above so downstream summary + // lines show the same string we just wrote to disk (community installs + // use the registry-approved tag via `communityVersion`; custom git-backed + // installs show the cloned ref or 'main'). + versionInfo: { + version: resolved.communityVersion || resolved.cloneRef || (hasGitClone ? 'main' : resolved.version || ''), + }, + }; + } + /** * Update an existing module * @param {string} moduleName - Name of the module to update @@ -419,32 +572,6 @@ class OfficialModules { } } - /** - * Find all .md agent files recursively in a directory - * @param {string} dir - Directory to search - * @returns {Array} List of .md agent file paths - */ - async findAgentMdFiles(dir) { - const agentFiles = []; - - async function searchDirectory(searchDir) { - const entries = await fs.readdir(searchDir, { withFileTypes: true }); - - for (const entry of entries) { - const fullPath = path.join(searchDir, entry.name); - - if (entry.isFile() && entry.name.endsWith('.md')) { - agentFiles.push(fullPath); - } else if (entry.isDirectory()) { - await searchDirectory(fullPath); - } - } - } - - await searchDirectory(dir); - return agentFiles; - } - /** * Create directories declared in module.yaml's `directories` key * This replaces the security-risky module installer pattern with declarative config @@ -618,29 +745,6 @@ class OfficialModules { return { createdDirs, movedDirs, createdWdsFolders }; } - /** - * Private: Process module configuration - * @param {string} modulePath - Path to installed module - * @param {string} moduleName - Module name - */ - async processModuleConfig(modulePath, moduleName) { - const configPath = path.join(modulePath, 'config.yaml'); - - if (await fs.pathExists(configPath)) { - try { - let configContent = await fs.readFile(configPath, 'utf8'); - - // Replace path placeholders - configContent = configContent.replaceAll('{project-root}', `bmad/${moduleName}`); - configContent = configContent.replaceAll('{module}', moduleName); - - await fs.writeFile(configPath, configContent, 'utf8'); - } catch (error) { - await prompts.log.warn(`Failed to process module config: ${error.message}`); - } - } - } - /** * Private: Sync module files (preserving user modifications) * @param {string} sourcePath - Source module path @@ -786,10 +890,10 @@ class OfficialModules { let foundAny = false; const entries = await fs.readdir(bmadDir, { withFileTypes: true }); + const nonModuleDirs = new Set(['_config', '_memory', 'memory', 'docs', 'scripts', 'custom']); for (const entry of entries) { if (entry.isDirectory()) { - // Skip the _config directory - it's for system use - if (entry.name === '_config' || entry.name === '_memory') { + if (nonModuleDirs.has(entry.name)) { continue; } @@ -824,20 +928,15 @@ class OfficialModules { const results = []; for (const moduleName of modules) { - // Resolve module.yaml path - custom paths first, then standard location, then OfficialModules search + // Resolve module.yaml path - standard location first, then OfficialModules search let moduleConfigPath = null; - const customPath = this.customModulePaths?.get(moduleName); - if (customPath) { - moduleConfigPath = path.join(customPath, 'module.yaml'); + const standardPath = path.join(getModulePath(moduleName), 'module.yaml'); + if (await fs.pathExists(standardPath)) { + moduleConfigPath = standardPath; } else { - const standardPath = path.join(getModulePath(moduleName), 'module.yaml'); - if (await fs.pathExists(standardPath)) { - moduleConfigPath = standardPath; - } else { - const moduleSourcePath = await this.findModuleSource(moduleName, { silent: true }); - if (moduleSourcePath) { - moduleConfigPath = path.join(moduleSourcePath, 'module.yaml'); - } + const moduleSourcePath = await this.findModuleSource(moduleName, { silent: true }); + if (moduleSourcePath) { + moduleConfigPath = path.join(moduleSourcePath, 'module.yaml'); } } @@ -882,12 +981,9 @@ class OfficialModules { * @param {Array} modules - List of modules to configure (including 'core') * @param {string} projectDir - Target project directory * @param {Object} options - Additional options - * @param {Map} options.customModulePaths - Map of module ID to source path for custom modules * @param {boolean} options.skipPrompts - Skip prompts and use defaults (for --yes flag) */ async collectAllConfigurations(modules, projectDir, options = {}) { - // Store custom module paths for use in collectModuleConfig - this.customModulePaths = options.customModulePaths || new Map(); this.skipPrompts = options.skipPrompts || false; this.modulesToCustomize = undefined; await this.loadExistingConfig(projectDir); @@ -1018,7 +1114,6 @@ class OfficialModules { */ async collectModuleConfigQuick(moduleName, projectDir, silentMode = true) { this.currentProjectDir = projectDir; - // Load existing config if not already loaded if (!this._existingConfig) { await this.loadExistingConfig(projectDir); @@ -1042,25 +1137,7 @@ class OfficialModules { } } - let configPath = null; - let isCustomModule = false; - - if (await fs.pathExists(moduleConfigPath)) { - configPath = moduleConfigPath; - } else { - // Check if this is a custom module with custom.yaml - const moduleSourcePath = await this.findModuleSource(moduleName, { silent: true }); - - if (moduleSourcePath) { - const rootCustomConfigPath = path.join(moduleSourcePath, 'custom.yaml'); - - if (await fs.pathExists(rootCustomConfigPath)) { - isCustomModule = true; - // For custom modules, we don't have an install-config schema, so just use existing values - // The custom.yaml values will be loaded and merged during installation - } - } - + if (!(await fs.pathExists(moduleConfigPath))) { // No config schema for this module - use existing values if (this._existingConfig && this._existingConfig[moduleName]) { if (!this.collectedConfig[moduleName]) { @@ -1071,7 +1148,7 @@ class OfficialModules { return false; } - const configContent = await fs.readFile(configPath, 'utf8'); + const configContent = await fs.readFile(moduleConfigPath, 'utf8'); const moduleConfig = yaml.parse(configContent); if (!moduleConfig) { @@ -1172,7 +1249,13 @@ class OfficialModules { // Collect all answers (static + prompted) let allAnswers = { ...staticAnswers }; - if (questions.length > 0) { + if (questions.length > 0 && silentMode) { + // In silent mode (quick update), use defaults for new fields instead of prompting + for (const q of questions) { + allAnswers[q.name] = typeof q.default === 'function' ? q.default({}) : q.default; + } + await prompts.log.message(` \u2713 ${moduleName.toUpperCase()} module configured with defaults`); + } else if (questions.length > 0) { // Only show header if we actually have questions await CLIUtils.displayModuleConfigHeader(moduleName, moduleConfig.header, moduleConfig.subheader); await prompts.log.message(''); @@ -1332,16 +1415,7 @@ class OfficialModules { this.allAnswers = {}; } // Load module's config - // First, check if we have a custom module path for this module - let moduleConfigPath = null; - - if (this.customModulePaths && this.customModulePaths.has(moduleName)) { - const customPath = this.customModulePaths.get(moduleName); - moduleConfigPath = path.join(customPath, 'module.yaml'); - } else { - // Try the standard src/modules location - moduleConfigPath = path.join(getModulePath(moduleName), 'module.yaml'); - } + let moduleConfigPath = path.join(getModulePath(moduleName), 'module.yaml'); // If not found in src/modules or custom paths, search the project if (!(await fs.pathExists(moduleConfigPath))) { diff --git a/tools/installer/modules/plugin-resolver.js b/tools/installer/modules/plugin-resolver.js new file mode 100644 index 000000000..58e20ab88 --- /dev/null +++ b/tools/installer/modules/plugin-resolver.js @@ -0,0 +1,398 @@ +const fs = require('../fs-native'); +const path = require('node:path'); +const yaml = require('yaml'); + +/** + * Resolves how to install a plugin from marketplace.json by analyzing + * where module.yaml and module-help.csv live relative to the listed skills. + * + * Five strategies, tried in order: + * 1. Root module files at the common parent of all skills + * 2. A -setup skill with assets/module.yaml + assets/module-help.csv + * 3. Single standalone skill with both files in its assets/ + * 4. Multiple standalone skills, each with both files in assets/ + * 5. Fallback: synthesize from marketplace.json + SKILL.md frontmatter + */ +class PluginResolver { + /** + * Resolve a plugin to one or more installable module definitions. + * @param {string} repoPath - Absolute path to the cloned repository root + * @param {Object} plugin - Plugin object from marketplace.json + * @param {string} plugin.name - Plugin identifier + * @param {string} [plugin.source] - Relative path from repo root + * @param {string} [plugin.version] - Semantic version + * @param {string} [plugin.description] - Plugin description + * @param {string[]} [plugin.skills] - Relative paths to skill directories + * @returns {Promise} Array of resolved module definitions + */ + async resolve(repoPath, plugin) { + const skillRelPaths = plugin.skills || []; + + // No skills array: legacy behavior - caller should use existing findModuleSource + if (skillRelPaths.length === 0) { + return []; + } + + // Resolve skill paths to absolute, constrain to repo root, filter non-existent + const repoRoot = path.resolve(repoPath); + const skillPaths = []; + for (const rel of skillRelPaths) { + const normalized = rel.replace(/^\.\//, ''); + const abs = path.resolve(repoPath, normalized); + // Guard against path traversal (.. segments, absolute paths in marketplace.json) + if (!abs.startsWith(repoRoot + path.sep) && abs !== repoRoot) { + continue; + } + if (await fs.pathExists(abs)) { + skillPaths.push(abs); + } + } + + if (skillPaths.length === 0) { + return []; + } + + // Try each strategy in order + const result = + (await this._tryRootModuleFiles(repoPath, plugin, skillPaths)) || + (await this._trySetupSkill(repoPath, plugin, skillPaths)) || + (await this._trySingleStandalone(repoPath, plugin, skillPaths)) || + (await this._tryMultipleStandalone(repoPath, plugin, skillPaths)) || + (await this._synthesizeFallback(repoPath, plugin, skillPaths)); + + return result; + } + + // ─── Strategy 1: Root Module Files ────────────────────────────────────────── + + /** + * Check if module.yaml + module-help.csv exist at the common parent of all skills. + */ + async _tryRootModuleFiles(repoPath, plugin, skillPaths) { + const commonParent = this._computeCommonParent(skillPaths); + const moduleYamlPath = path.join(commonParent, 'module.yaml'); + const moduleHelpPath = path.join(commonParent, 'module-help.csv'); + + if (!(await fs.pathExists(moduleYamlPath)) || !(await fs.pathExists(moduleHelpPath))) { + return null; + } + + const moduleData = await this._readModuleYaml(moduleYamlPath); + if (!moduleData) return null; + + return [ + { + code: moduleData.code || plugin.name, + name: moduleData.name || plugin.name, + version: plugin.version || moduleData.module_version || null, + description: moduleData.description || plugin.description || '', + strategy: 1, + pluginName: plugin.name, + moduleYamlPath, + moduleHelpCsvPath: moduleHelpPath, + skillPaths, + synthesizedModuleYaml: null, + synthesizedHelpCsv: null, + }, + ]; + } + + // ─── Strategy 2: Setup Skill ──────────────────────────────────────────────── + + /** + * Search for a skill ending in -setup with assets/module.yaml + assets/module-help.csv. + */ + async _trySetupSkill(repoPath, plugin, skillPaths) { + for (const skillPath of skillPaths) { + const dirName = path.basename(skillPath); + if (!dirName.endsWith('-setup')) continue; + + const moduleYamlPath = path.join(skillPath, 'assets', 'module.yaml'); + const moduleHelpPath = path.join(skillPath, 'assets', 'module-help.csv'); + + if (!(await fs.pathExists(moduleYamlPath)) || !(await fs.pathExists(moduleHelpPath))) { + continue; + } + + const moduleData = await this._readModuleYaml(moduleYamlPath); + if (!moduleData) continue; + + return [ + { + code: moduleData.code || plugin.name, + name: moduleData.name || plugin.name, + version: plugin.version || moduleData.module_version || null, + description: moduleData.description || plugin.description || '', + strategy: 2, + pluginName: plugin.name, + moduleYamlPath, + moduleHelpCsvPath: moduleHelpPath, + skillPaths, + synthesizedModuleYaml: null, + synthesizedHelpCsv: null, + }, + ]; + } + + return null; + } + + // ─── Strategy 3: Single Standalone Skill ──────────────────────────────────── + + /** + * One skill listed, with assets/module.yaml + assets/module-help.csv. + */ + async _trySingleStandalone(repoPath, plugin, skillPaths) { + if (skillPaths.length !== 1) return null; + + const skillPath = skillPaths[0]; + const moduleYamlPath = path.join(skillPath, 'assets', 'module.yaml'); + const moduleHelpPath = path.join(skillPath, 'assets', 'module-help.csv'); + + if (!(await fs.pathExists(moduleYamlPath)) || !(await fs.pathExists(moduleHelpPath))) { + return null; + } + + const moduleData = await this._readModuleYaml(moduleYamlPath); + if (!moduleData) return null; + + return [ + { + code: moduleData.code || plugin.name, + name: moduleData.name || plugin.name, + version: plugin.version || moduleData.module_version || null, + description: moduleData.description || plugin.description || '', + strategy: 3, + pluginName: plugin.name, + moduleYamlPath, + moduleHelpCsvPath: moduleHelpPath, + skillPaths, + synthesizedModuleYaml: null, + synthesizedHelpCsv: null, + }, + ]; + } + + // ─── Strategy 4: Multiple Standalone Skills ───────────────────────────────── + + /** + * Multiple skills, each with assets/module.yaml + assets/module-help.csv. + * Each becomes its own installable module. + */ + async _tryMultipleStandalone(repoPath, plugin, skillPaths) { + if (skillPaths.length < 2) return null; + + const resolved = []; + + for (const skillPath of skillPaths) { + const moduleYamlPath = path.join(skillPath, 'assets', 'module.yaml'); + const moduleHelpPath = path.join(skillPath, 'assets', 'module-help.csv'); + + if (!(await fs.pathExists(moduleYamlPath)) || !(await fs.pathExists(moduleHelpPath))) { + continue; + } + + const moduleData = await this._readModuleYaml(moduleYamlPath); + if (!moduleData) continue; + + resolved.push({ + code: moduleData.code || path.basename(skillPath), + name: moduleData.name || path.basename(skillPath), + version: plugin.version || moduleData.module_version || null, + description: moduleData.description || '', + strategy: 4, + pluginName: plugin.name, + moduleYamlPath, + moduleHelpCsvPath: moduleHelpPath, + skillPaths: [skillPath], + synthesizedModuleYaml: null, + synthesizedHelpCsv: null, + }); + } + + // Only use strategy 4 if ALL skills have module files + if (resolved.length === skillPaths.length) { + return resolved; + } + + // Partial match: fall through to strategy 5 + return null; + } + + // ─── Strategy 5: Fallback (Synthesized) ───────────────────────────────────── + + /** + * No module files found anywhere. Synthesize from marketplace.json metadata + * and SKILL.md frontmatter. + */ + async _synthesizeFallback(repoPath, plugin, skillPaths) { + const skillInfos = []; + + for (const skillPath of skillPaths) { + const frontmatter = await this._parseSkillFrontmatter(skillPath); + skillInfos.push({ + dirName: path.basename(skillPath), + name: frontmatter.name || path.basename(skillPath), + description: frontmatter.description || '', + }); + } + + const moduleName = this._formatDisplayName(plugin.name); + const code = plugin.name; + + const synthesizedYaml = { + code, + name: moduleName, + description: plugin.description || '', + module_version: plugin.version || '1.0.0', + default_selected: false, + }; + + const synthesizedCsv = this._buildSynthesizedHelpCsv(moduleName, skillInfos); + + return [ + { + code, + name: moduleName, + version: plugin.version || null, + description: plugin.description || '', + strategy: 5, + pluginName: plugin.name, + moduleYamlPath: null, + moduleHelpCsvPath: null, + skillPaths, + synthesizedModuleYaml: synthesizedYaml, + synthesizedHelpCsv: synthesizedCsv, + }, + ]; + } + + // ─── Helpers ──────────────────────────────────────────────────────────────── + + /** + * Compute the deepest common ancestor directory of an array of absolute paths. + * @param {string[]} absPaths - Absolute directory paths + * @returns {string} Common parent directory + */ + _computeCommonParent(absPaths) { + if (absPaths.length === 0) return '/'; + if (absPaths.length === 1) return path.dirname(absPaths[0]); + + const segments = absPaths.map((p) => p.split(path.sep)); + const minLen = Math.min(...segments.map((s) => s.length)); + const common = []; + + for (let i = 0; i < minLen; i++) { + const segment = segments[0][i]; + if (segments.every((s) => s[i] === segment)) { + common.push(segment); + } else { + break; + } + } + + return common.join(path.sep) || '/'; + } + + /** + * Read and parse a module.yaml file. + * @param {string} yamlPath - Absolute path to module.yaml + * @returns {Object|null} Parsed content or null on failure + */ + async _readModuleYaml(yamlPath) { + try { + const content = await fs.readFile(yamlPath, 'utf8'); + return yaml.parse(content); + } catch { + return null; + } + } + + /** + * Extract name and description from a SKILL.md YAML frontmatter block. + * @param {string} skillDirPath - Absolute path to the skill directory + * @returns {Object} { name, description } or empty strings + */ + async _parseSkillFrontmatter(skillDirPath) { + const skillMdPath = path.join(skillDirPath, 'SKILL.md'); + try { + const content = await fs.readFile(skillMdPath, 'utf8'); + const match = content.match(/^---\s*\n([\s\S]*?)\n---/); + if (!match) return { name: '', description: '' }; + + const parsed = yaml.parse(match[1]); + return { + name: parsed.name || '', + description: parsed.description || '', + }; + } catch { + return { name: '', description: '' }; + } + } + + /** + * Build a synthesized module-help.csv from plugin metadata and skill frontmatter. + * Uses the standard 13-column format. + * @param {string} moduleName - Display name for the module column + * @param {Array<{dirName: string, name: string, description: string}>} skillInfos + * @returns {string} CSV content + */ + _buildSynthesizedHelpCsv(moduleName, skillInfos) { + const header = 'module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs'; + const rows = [header]; + + for (const info of skillInfos) { + const displayName = this._formatDisplayName(info.name || info.dirName); + const menuCode = this._generateMenuCode(info.name || info.dirName); + const description = this._escapeCSVField(info.description); + + rows.push(`${moduleName},${info.dirName},${displayName},${menuCode},${description},activate,,anytime,,,false,,`); + } + + return rows.join('\n') + '\n'; + } + + /** + * Format a kebab-case or snake_case name into a display name. + * Strips common prefixes like "bmad-" or "bmad-agent-". + * @param {string} name - Raw name + * @returns {string} Formatted display name + */ + _formatDisplayName(name) { + let cleaned = name.replace(/^bmad-agent-/, '').replace(/^bmad-/, ''); + return cleaned + .split(/[-_]/) + .map((word) => word.charAt(0).toUpperCase() + word.slice(1)) + .join(' '); + } + + /** + * Generate a short menu code from a skill name. + * Takes first letter of each significant word, uppercased, max 3 chars. + * @param {string} name - Skill name (kebab-case) + * @returns {string} Menu code (e.g., "CC" for "code-coach") + */ + _generateMenuCode(name) { + const cleaned = name.replace(/^bmad-agent-/, '').replace(/^bmad-/, ''); + const words = cleaned.split(/[-_]/).filter((w) => w.length > 0); + return words + .map((w) => w.charAt(0).toUpperCase()) + .join('') + .slice(0, 3); + } + + /** + * Escape a value for CSV output (wrap in quotes if it contains commas, quotes, or newlines). + * @param {string} value + * @returns {string} + */ + _escapeCSVField(value) { + if (!value) return ''; + if (value.includes(',') || value.includes('"') || value.includes('\n')) { + return `"${value.replaceAll('"', '""')}"`; + } + return value; + } +} + +module.exports = { PluginResolver }; diff --git a/tools/installer/modules/registry-client.js b/tools/installer/modules/registry-client.js new file mode 100644 index 000000000..31a38f8d3 --- /dev/null +++ b/tools/installer/modules/registry-client.js @@ -0,0 +1,187 @@ +const https = require('node:https'); +const yaml = require('yaml'); + +/** + * Build a rich Error from a non-2xx response. Includes the URL, the GitHub + * JSON error message (or a truncated body snippet), rate-limit reset time, + * and Retry-After — anything present that would help a user recover. + */ +function buildHttpError(url, res, body) { + const parts = [`HTTP ${res.statusCode} ${url}`]; + + if (body) { + try { + const parsed = JSON.parse(body); + if (parsed.message) parts.push(parsed.message); + if (parsed.documentation_url) parts.push(`(see ${parsed.documentation_url})`); + } catch { + const snippet = body.slice(0, 200).trim(); + if (snippet) parts.push(snippet); + } + } + + const remaining = res.headers['x-ratelimit-remaining']; + const reset = res.headers['x-ratelimit-reset']; + if (remaining === '0' && reset) { + parts.push(`rate limit exhausted; resets at ${new Date(Number(reset) * 1000).toISOString()}`); + } + + const retryAfter = res.headers['retry-after']; + if (retryAfter) parts.push(`retry after ${retryAfter}`); + + return new Error(parts.join(' — ')); +} + +/** + * Shared HTTP client for fetching registry data from GitHub. + * Used by ExternalModuleManager, CommunityModuleManager, and CustomModuleManager. + */ +class RegistryClient { + constructor(options = {}) { + this.timeout = options.timeout || 10_000; + } + + /** + * Fetch a URL and return the response body as a string. + * Follows up to 3 redirects (GitHub sometimes 301s). + * @param {string} url - URL to fetch + * @param {number} [timeout] - Timeout in ms (overrides default) + * @param {number} [maxRedirects=3] - Maximum redirects to follow + * @returns {Promise} Response body + */ + fetch(url, timeout, maxRedirects = 3) { + const timeoutMs = timeout || this.timeout; + return new Promise((resolve, reject) => { + const req = https + .get(url, { timeout: timeoutMs }, (res) => { + if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) { + if (maxRedirects <= 0) { + return reject(new Error('Too many redirects')); + } + return this.fetch(res.headers.location, timeoutMs, maxRedirects - 1).then(resolve, reject); + } + let data = ''; + res.on('data', (chunk) => (data += chunk)); + res.on('end', () => { + if (res.statusCode !== 200) { + return reject(buildHttpError(url, res, data)); + } + resolve(data); + }); + }) + .on('error', reject) + .on('timeout', () => { + req.destroy(); + reject(new Error('Request timed out')); + }); + }); + } + + /** + * Fetch a URL and parse the response as YAML. + * @param {string} url - URL to fetch + * @param {number} [timeout] - Timeout in ms + * @returns {Promise} Parsed YAML content + */ + async fetchYaml(url, timeout) { + const content = await this.fetch(url, timeout); + return yaml.parse(content); + } + + /** + * Fetch a file from a GitHub repo using the Contents API first, + * falling back to raw.githubusercontent.com if the API fails. + * + * The API endpoint (`api.github.com`) is tried first because corporate + * proxies commonly block `raw.githubusercontent.com` while allowing + * `api.github.com` under the "Software Development" category. + * + * @param {string} owner - Repository owner (e.g., 'bmad-code-org') + * @param {string} repo - Repository name (e.g., 'bmad-plugins-marketplace') + * @param {string} filePath - Path within the repo (e.g., 'registry/official.yaml') + * @param {string} ref - Git ref (branch, tag, or SHA; e.g., 'main') + * @param {number} [timeout] - Timeout in ms (overrides default) + * @returns {Promise} Raw file content + */ + async fetchGitHubFile(owner, repo, filePath, ref, timeout) { + const apiUrl = `https://api.github.com/repos/${owner}/${repo}/contents/${filePath}?ref=${ref}`; + const rawUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${ref}/${filePath}`; + + // Try GitHub Contents API first (with raw content accept header) + try { + return await this._fetchWithHeaders(apiUrl, { Accept: 'application/vnd.github.raw+json' }, timeout); + } catch (apiError) { + // API failed — fall back to raw CDN + try { + return await this.fetch(rawUrl, timeout); + } catch (cdnError) { + throw new AggregateError([apiError, cdnError], `Both GitHub API and raw CDN failed for ${filePath}`); + } + } + } + + /** + * Fetch a file from GitHub and parse as YAML. + * @param {string} owner - Repository owner + * @param {string} repo - Repository name + * @param {string} filePath - Path within the repo + * @param {string} ref - Git ref + * @param {number} [timeout] - Timeout in ms + * @returns {Promise} Parsed YAML content + */ + async fetchGitHubYaml(owner, repo, filePath, ref, timeout) { + const content = await this.fetchGitHubFile(owner, repo, filePath, ref, timeout); + return yaml.parse(content); + } + + /** + * Fetch a URL with custom headers. Used for GitHub API requests. + * Follows up to 3 redirects. + * @param {string} url - URL to fetch + * @param {Object} headers - Request headers + * @param {number} [timeout] - Timeout in ms + * @param {number} [maxRedirects=3] - Maximum redirects to follow + * @returns {Promise} Response body + * @private + */ + _fetchWithHeaders(url, headers, timeout, maxRedirects = 3) { + const timeoutMs = timeout || this.timeout; + const parsed = new URL(url); + const options = { + hostname: parsed.hostname, + path: parsed.pathname + parsed.search, + timeout: timeoutMs, + headers: { + 'User-Agent': 'bmad-installer', + ...headers, + }, + }; + + return new Promise((resolve, reject) => { + const req = https + .get(options, (res) => { + if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) { + if (maxRedirects <= 0) { + return reject(new Error('Too many redirects')); + } + return this._fetchWithHeaders(res.headers.location, headers, timeoutMs, maxRedirects - 1).then(resolve, reject); + } + let data = ''; + res.on('data', (chunk) => (data += chunk)); + res.on('end', () => { + if (res.statusCode !== 200) { + return reject(buildHttpError(url, res, data)); + } + resolve(data); + }); + }) + .on('error', reject) + .on('timeout', () => { + req.destroy(); + reject(new Error('Request timed out')); + }); + }); + } +} + +module.exports = { RegistryClient }; diff --git a/tools/installer/external-official-modules.yaml b/tools/installer/modules/registry-fallback.yaml similarity index 71% rename from tools/installer/external-official-modules.yaml rename to tools/installer/modules/registry-fallback.yaml index b62f3dc21..52bc4b4fc 100644 --- a/tools/installer/external-official-modules.yaml +++ b/tools/installer/modules/registry-fallback.yaml @@ -1,5 +1,10 @@ -# This file allows these modules under bmad-code-org to also be installed with the bmad method installer, while -# allowing us to keep the source of these projects in separate repos. +# Fallback module registry — used only when the BMad Marketplace repo +# (bmad-code-org/bmad-plugins-marketplace) is unreachable. +# The remote registry/official.yaml is the source of truth. +# +# default_channel (optional) — the install channel when the user does not +# override with --channel/--pin/--next. Valid values: stable | next. +# Omit to inherit the installer's hardcoded default (stable). modules: bmad-builder: @@ -11,6 +16,7 @@ modules: defaultSelected: false type: bmad-org npmPackage: bmad-builder + default_channel: stable bmad-creative-intelligence-suite: url: https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite @@ -21,6 +27,7 @@ modules: defaultSelected: false type: bmad-org npmPackage: bmad-creative-intelligence-suite + default_channel: stable bmad-game-dev-studio: url: https://github.com/bmad-code-org/bmad-module-game-dev-studio.git @@ -31,6 +38,7 @@ modules: defaultSelected: false type: bmad-org npmPackage: bmad-game-dev-studio + default_channel: stable bmad-method-test-architecture-enterprise: url: https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise @@ -41,13 +49,4 @@ modules: defaultSelected: false type: bmad-org npmPackage: bmad-method-test-architecture-enterprise - - whiteport-design-studio: - url: https://github.com/bmad-code-org/bmad-method-wds-expansion - module-definition: src/module.yaml - code: wds - name: "Whiteport Design Studio (For UX Professionals)" - description: "Whiteport Design Studio (For UX Professionals)" - defaultSelected: false - type: community - npmPackage: bmad-method-wds-expansion + default_channel: stable diff --git a/tools/installer/modules/version-resolver.js b/tools/installer/modules/version-resolver.js new file mode 100644 index 000000000..7ba42ee30 --- /dev/null +++ b/tools/installer/modules/version-resolver.js @@ -0,0 +1,336 @@ +const path = require('node:path'); +const semver = require('semver'); +const yaml = require('yaml'); +const fs = require('../fs-native'); +const { getExternalModuleCachePath, getModulePath, resolveInstalledModuleYaml } = require('../project-root'); + +const DEFAULT_PARENT_DEPTH = 8; + +/** + * Resolve a module version from authoritative on-disk metadata. + * Preference order: + * 1. package.json nearest the module source/cache root + * 2. module.yaml in the module source directory + * 3. .claude-plugin/marketplace.json + * 4. caller-provided fallback version + * + * @param {string} moduleName - Module code/name + * @param {Object} [options] + * @param {string} [options.moduleSourcePath] - Directory containing module.yaml + * @param {string} [options.fallbackVersion] - Final fallback when no metadata is found + * @param {string[]} [options.marketplacePluginNames] - Preferred marketplace plugin names + * @returns {Promise<{version: string|null, source: string|null, path: string|null}>} + */ +async function resolveModuleVersion(moduleName, options = {}) { + const moduleSourcePath = await normalizeDirectoryPath(options.moduleSourcePath); + const packageJsonPath = await findPackageJsonPath(moduleName, moduleSourcePath); + + if (packageJsonPath) { + const packageVersion = await readPackageJsonVersion(packageJsonPath); + if (packageVersion) { + return { + version: packageVersion, + source: 'package.json', + path: packageJsonPath, + }; + } + } + + const moduleYamlPath = await findModuleYamlPath(moduleName, moduleSourcePath); + if (moduleYamlPath) { + const moduleVersion = await readModuleYamlVersion(moduleYamlPath); + if (moduleVersion) { + return { + version: moduleVersion, + source: 'module.yaml', + path: moduleYamlPath, + }; + } + } + + const marketplaceVersion = await findMarketplaceVersion(moduleName, moduleSourcePath, options.marketplacePluginNames || []); + if (marketplaceVersion) { + return marketplaceVersion; + } + + const fallbackVersion = normalizeVersion(options.fallbackVersion); + if (fallbackVersion) { + return { + version: fallbackVersion, + source: 'fallback', + path: null, + }; + } + + return { + version: null, + source: null, + path: null, + }; +} + +async function findPackageJsonPath(moduleName, moduleSourcePath) { + const roots = await buildSearchRoots(moduleName, moduleSourcePath); + + for (const root of roots) { + const packageJsonPath = await findNearestUpwardFile(root.searchDir, 'package.json', { boundaryDir: root.boundaryDir }); + if (packageJsonPath) { + return packageJsonPath; + } + } + + return null; +} + +async function findModuleYamlPath(moduleName, moduleSourcePath) { + if (moduleSourcePath) { + const directModuleYamlPath = path.join(moduleSourcePath, 'module.yaml'); + if (await fs.pathExists(directModuleYamlPath)) { + return directModuleYamlPath; + } + } + + return resolveInstalledModuleYaml(moduleName); +} + +async function findMarketplaceVersion(moduleName, moduleSourcePath, marketplacePluginNames) { + const roots = await buildSearchRoots(moduleName, moduleSourcePath); + + for (const root of roots) { + const marketplacePath = await findNearestUpwardFile(root.searchDir, path.join('.claude-plugin', 'marketplace.json'), { + boundaryDir: root.boundaryDir, + }); + if (!marketplacePath) { + continue; + } + + const data = await readJsonFile(marketplacePath); + if (!data) { + continue; + } + + const version = extractMarketplaceVersion(data, moduleName, marketplacePluginNames); + if (version) { + return { + version, + source: 'marketplace.json', + path: marketplacePath, + }; + } + } + + return null; +} + +async function buildSearchRoots(moduleName, moduleSourcePath) { + const roots = []; + const seen = new Set(); + + const addRoot = async (candidate) => { + const normalized = await normalizeExistingDirectory(candidate); + if (!normalized || seen.has(normalized)) { + return; + } + + seen.add(normalized); + roots.push({ + searchDir: normalized, + boundaryDir: await findSearchBoundary(normalized), + }); + }; + + await addRoot(moduleSourcePath); + + if (moduleName === 'core' || moduleName === 'bmm') { + await addRoot(getModulePath(moduleName)); + } else { + await addRoot(getExternalModuleCachePath(moduleName)); + } + + return roots; +} + +async function findNearestUpwardFile(startDir, relativeFilePath, options = {}) { + const normalizedStartDir = await normalizeExistingDirectory(startDir); + if (!normalizedStartDir) { + return null; + } + + const maxDepth = options.maxDepth ?? DEFAULT_PARENT_DEPTH; + const normalizedBoundaryDir = await normalizeDirectoryPath(options.boundaryDir); + let currentDir = normalizedStartDir; + for (let depth = 0; depth <= maxDepth; depth++) { + const candidate = path.join(currentDir, relativeFilePath); + if (await fs.pathExists(candidate)) { + return candidate; + } + + if (normalizedBoundaryDir && currentDir === normalizedBoundaryDir) { + break; + } + + const parentDir = path.dirname(currentDir); + if (parentDir === currentDir) { + break; + } + currentDir = parentDir; + } + + return null; +} + +async function findSearchBoundary(startDir) { + const normalizedStartDir = await normalizeExistingDirectory(startDir); + if (!normalizedStartDir) { + return null; + } + + let currentDir = normalizedStartDir; + for (let depth = 0; depth <= DEFAULT_PARENT_DEPTH; depth++) { + if ( + (await fs.pathExists(path.join(currentDir, 'package.json'))) || + (await fs.pathExists(path.join(currentDir, '.claude-plugin', 'marketplace.json'))) || + (await fs.pathExists(path.join(currentDir, '.git'))) + ) { + return currentDir; + } + + const parentDir = path.dirname(currentDir); + if (parentDir === currentDir) { + break; + } + currentDir = parentDir; + } + + return normalizedStartDir; +} + +async function normalizeDirectoryPath(candidate) { + if (!candidate) { + return null; + } + + const resolvedPath = path.resolve(candidate); + try { + const stats = await fs.stat(resolvedPath); + return stats.isDirectory() ? resolvedPath : path.dirname(resolvedPath); + } catch { + return resolvedPath; + } +} + +async function normalizeExistingDirectory(candidate) { + const normalized = await normalizeDirectoryPath(candidate); + if (!normalized) { + return null; + } + + if (!(await fs.pathExists(normalized))) { + return null; + } + + return normalized; +} + +async function readPackageJsonVersion(packageJsonPath) { + const data = await readJsonFile(packageJsonPath); + return normalizeVersion(data?.version); +} + +async function readModuleYamlVersion(moduleYamlPath) { + try { + const content = await fs.readFile(moduleYamlPath, 'utf8'); + const data = yaml.parse(content); + return normalizeVersion(data?.version || data?.module_version || data?.moduleVersion); + } catch { + return null; + } +} + +async function readJsonFile(filePath) { + try { + const content = await fs.readFile(filePath, 'utf8'); + return JSON.parse(content); + } catch { + return null; + } +} + +function extractMarketplaceVersion(data, moduleName, marketplacePluginNames = []) { + const plugins = Array.isArray(data?.plugins) ? data.plugins : []; + if (plugins.length === 0) { + return null; + } + + const preferredNames = new Set( + [moduleName, ...marketplacePluginNames] + .filter((value) => typeof value === 'string') + .map((value) => value.trim()) + .filter(Boolean), + ); + + const exactMatches = []; + const fallbackVersions = []; + + for (const plugin of plugins) { + const version = normalizeVersion(plugin?.version); + if (!version) { + continue; + } + + fallbackVersions.push(version); + + const pluginNames = [plugin?.name, plugin?.code].filter((value) => typeof value === 'string').map((value) => value.trim()); + if (pluginNames.some((name) => preferredNames.has(name))) { + exactMatches.push(version); + } + } + + return pickBestVersion(exactMatches.length > 0 ? exactMatches : fallbackVersions); +} + +function pickBestVersion(versions) { + const candidates = versions.map(normalizeVersion).filter(Boolean); + if (candidates.length === 0) { + return null; + } + + candidates.sort(compareVersionsDescending); + return candidates[0]; +} + +function compareVersionsDescending(left, right) { + const leftSemver = normalizeSemver(left); + const rightSemver = normalizeSemver(right); + + if (leftSemver && rightSemver) { + return semver.rcompare(leftSemver, rightSemver); + } + + if (leftSemver) { + return -1; + } + + if (rightSemver) { + return 1; + } + + return right.localeCompare(left, undefined, { numeric: true, sensitivity: 'base' }); +} + +function normalizeSemver(version) { + return semver.valid(version) || semver.valid(semver.coerce(version)); +} + +function normalizeVersion(version) { + if (typeof version !== 'string') { + return null; + } + + const trimmed = version.trim(); + return trimmed || null; +} + +module.exports = { + resolveModuleVersion, +}; diff --git a/tools/installer/project-root.js b/tools/installer/project-root.js index 26063f81f..84ecde5b0 100644 --- a/tools/installer/project-root.js +++ b/tools/installer/project-root.js @@ -1,5 +1,7 @@ const path = require('node:path'); -const fs = require('fs-extra'); +const os = require('node:os'); +const yaml = require('yaml'); +const fs = require('./fs-native'); /** * Find the BMAD project root directory by looking for package.json @@ -69,9 +71,154 @@ function getModulePath(moduleName, ...segments) { return getSourcePath('modules', moduleName, ...segments); } +/** + * Path to the local external-module clone cache. + * External official modules (bmb, cis, gds, tea, wds, etc.) are cloned here + * by ExternalModuleManager during install and are not copied into /modules/. + */ +function getExternalModuleCachePath(moduleName, ...segments) { + const base = process.env.BMAD_EXTERNAL_MODULES_CACHE || path.join(os.homedir(), '.bmad', 'cache', 'external-modules'); + return path.join(base, moduleName, ...segments); +} + +/** + * Locate an installed module's `module.yaml` by filesystem lookup only. + * + * Built-in modules (core, bmm) live under . External official modules are + * cloned into ~/.bmad/cache/external-modules// with varying internal + * layouts (some at src/module.yaml, some at skills/module.yaml, some nested). + * Url-source custom modules are cloned into ~/.bmad/cache/custom-modules//// + * and are resolved by walking the cache and matching `code` or `name` from the + * discovered module.yaml. Local custom-source modules are not cached; their + * path is read from the CustomModuleManager resolution cache set during the + * same install run. + * This mirrors the candidate-path search in + * ExternalModuleManager.findExternalModuleSource but performs no git/network + * work, which keeps it safe to call during manifest writing. + * + * @param {string} moduleName + * @returns {Promise} Absolute path to module.yaml, or null if not found. + */ +async function resolveInstalledModuleYaml(moduleName) { + const builtIn = path.join(getModulePath(moduleName), 'module.yaml'); + if (await fs.pathExists(builtIn)) return builtIn; + + // Collect every module.yaml under a root using the standard candidate paths. + // Url-source repos can host multiple plugins (discovery mode), so we need all + // matches, not just the first. Returned in priority order. + async function searchRootAll(root) { + const results = []; + for (const dir of ['skills', 'src']) { + const direct = path.join(root, dir, 'module.yaml'); + if (await fs.pathExists(direct)) results.push(direct); + + const dirPath = path.join(root, dir); + if (await fs.pathExists(dirPath)) { + const entries = await fs.readdir(dirPath, { withFileTypes: true }); + for (const entry of entries) { + if (!entry.isDirectory()) continue; + const nested = path.join(dirPath, entry.name, 'module.yaml'); + if (await fs.pathExists(nested)) results.push(nested); + } + } + } + + // BMB standard: {setup-skill}/assets/module.yaml (setup skill is any *-setup directory). + // Check at the repo root, and also under src/skills/ and skills/ since + // marketplace plugins commonly nest skills under src/skills//. + const setupSearchRoots = [root, path.join(root, 'src', 'skills'), path.join(root, 'skills')]; + for (const setupRoot of setupSearchRoots) { + if (!(await fs.pathExists(setupRoot))) continue; + const entries = await fs.readdir(setupRoot, { withFileTypes: true }); + for (const entry of entries) { + if (!entry.isDirectory() || !entry.name.endsWith('-setup')) continue; + const setupAssets = path.join(setupRoot, entry.name, 'assets', 'module.yaml'); + if (await fs.pathExists(setupAssets)) results.push(setupAssets); + } + } + + const atRoot = path.join(root, 'module.yaml'); + if (await fs.pathExists(atRoot)) results.push(atRoot); + return results; + } + + // Backwards-compatible single-result variant for the existing external-cache + // and resolution-cache fallbacks (one module per root by construction). + async function searchRoot(root) { + const all = await searchRootAll(root); + return all.length > 0 ? all[0] : null; + } + + const cacheRoot = getExternalModuleCachePath(moduleName); + if (await fs.pathExists(cacheRoot)) { + const found = await searchRoot(cacheRoot); + if (found) return found; + } + + // Community modules are cloned to ~/.bmad/cache/community-modules// + // (parallel to the external-modules cache used above). Search there too so + // collectAgentsFromModuleYaml and writeCentralConfig can locate community + // module.yaml files regardless of how nested the layout is. + const communityCacheRoot = path.join(os.homedir(), '.bmad', 'cache', 'community-modules', moduleName); + if (await fs.pathExists(communityCacheRoot)) { + const found = await searchRoot(communityCacheRoot); + if (found) return found; + } + + // Fallback: local custom-source modules store their source path in the + // CustomModuleManager resolution cache populated during the same install run. + // Match by code OR name since callers may use either form. + try { + const { CustomModuleManager } = require('./modules/custom-module-manager'); + for (const [, mod] of CustomModuleManager._resolutionCache) { + if ((mod.code === moduleName || mod.name === moduleName) && mod.localPath) { + const found = await searchRoot(mod.localPath); + if (found) return found; + } + } + } catch { + // Resolution cache unavailable — continue + } + + // Fallback: url-source custom modules cloned to ~/.bmad/cache/custom-modules/. + // Walk every cached repo, enumerate ALL module.yaml files via searchRootAll + // (a single repo can host multiple plugins in discovery mode), and match by + // the yaml's `code` or `name` field. This works on re-install runs where + // _resolutionCache is empty and covers both discovery-mode (with marketplace.json) + // and direct-mode modules, since we identify repo roots by .bmad-source.json + // (written by cloneRepo) or .claude-plugin/ rather than by marketplace.json. + try { + const customCacheDir = path.join(os.homedir(), '.bmad', 'cache', 'custom-modules'); + if (await fs.pathExists(customCacheDir)) { + const { CustomModuleManager } = require('./modules/custom-module-manager'); + const customMgr = new CustomModuleManager(); + const repoRoots = await customMgr._findCacheRepoRoots(customCacheDir); + for (const { repoPath } of repoRoots) { + const candidates = await searchRootAll(repoPath); + for (const candidate of candidates) { + try { + const parsed = yaml.parse(await fs.readFile(candidate, 'utf8')); + if (parsed && (parsed.code === moduleName || parsed.name === moduleName)) { + return candidate; + } + } catch { + // Malformed yaml — skip + } + } + } + } + } catch { + // Custom-modules cache walk failed — continue + } + + return null; +} + module.exports = { getProjectRoot, getSourcePath, getModulePath, + getExternalModuleCachePath, + resolveInstalledModuleYaml, findProjectRoot, }; diff --git a/tools/installer/prompts.js b/tools/installer/prompts.js index 24500700b..4f46e69b1 100644 --- a/tools/installer/prompts.js +++ b/tools/installer/prompts.js @@ -498,26 +498,6 @@ async function password(options) { return result; } -/** - * Group multiple prompts together - * @param {Object} prompts - Object of prompt functions - * @param {Object} [options] - Group options - * @returns {Promise} Object with all answers - */ -async function group(prompts, options = {}) { - const clack = await getClack(); - - const result = await clack.group(prompts, { - onCancel: () => { - clack.cancel('Operation cancelled'); - process.exit(0); - }, - ...options, - }); - - return result; -} - /** * Run tasks with spinner feedback * @param {Array} tasks - Array of task objects [{title, task, enabled?}] @@ -578,42 +558,6 @@ async function box(content, title, options) { clack.box(content, title, options); } -/** - * Create a progress bar for visualizing task completion - * @param {Object} [options] - Progress options (max, style, etc.) - * @returns {Promise} Progress controller with start, advance, stop methods - */ -async function progress(options) { - const clack = await getClack(); - return clack.progress(options); -} - -/** - * Create a task log for displaying scrolling subprocess output - * @param {Object} options - TaskLog options (title, limit, retainLog) - * @returns {Promise} TaskLog controller with message, success, error methods - */ -async function taskLog(options) { - const clack = await getClack(); - return clack.taskLog(options); -} - -/** - * File system path prompt with autocomplete - * @param {Object} options - Path options - * @param {string} options.message - The prompt message - * @param {string} [options.initialValue] - Initial path value - * @param {boolean} [options.directory=false] - Only allow directories - * @param {Function} [options.validate] - Validation function - * @returns {Promise} Selected path - */ -async function pathPrompt(options) { - const clack = await getClack(); - const result = await clack.path(options); - await handleCancel(result); - return result; -} - /** * Autocomplete single-select prompt with type-ahead filtering * @param {Object} options - Autocomplete options @@ -631,50 +575,6 @@ async function autocomplete(options) { return result; } -/** - * Key-based instant selection prompt - * @param {Object} options - SelectKey options - * @param {string} options.message - The prompt message - * @param {Array} options.options - Array of choices [{value, label, hint?}] - * @returns {Promise} Selected value - */ -async function selectKey(options) { - const clack = await getClack(); - const result = await clack.selectKey(options); - await handleCancel(result); - return result; -} - -/** - * Stream messages with dynamic content (for LLMs, generators, etc.) - */ -const stream = { - async info(generator) { - const clack = await getClack(); - return clack.stream.info(generator); - }, - async success(generator) { - const clack = await getClack(); - return clack.stream.success(generator); - }, - async step(generator) { - const clack = await getClack(); - return clack.stream.step(generator); - }, - async warn(generator) { - const clack = await getClack(); - return clack.stream.warn(generator); - }, - async error(generator) { - const clack = await getClack(); - return clack.stream.error(generator); - }, - async message(generator, options) { - const clack = await getClack(); - return clack.stream.message(generator, options); - }, -}; - /** * Get the color utility (picocolors instance from @clack/prompts) * @returns {Promise} The color utility (picocolors) @@ -790,20 +690,14 @@ module.exports = { note, box, spinner, - progress, - taskLog, select, multiselect, autocompleteMultiselect, autocomplete, - selectKey, confirm, text, - path: pathPrompt, password, - group, tasks, log, - stream, prompt, }; diff --git a/tools/installer/ui.js b/tools/installer/ui.js index 03d38e4da..7b720743b 100644 --- a/tools/installer/ui.js +++ b/tools/installer/ui.js @@ -1,23 +1,109 @@ const path = require('node:path'); const os = require('node:os'); -const fs = require('fs-extra'); +const semver = require('semver'); +const fs = require('./fs-native'); +const installerPackageJson = require('../../package.json'); const { CLIUtils } = require('./cli-utils'); -const { CustomHandler } = require('./custom-handler'); const { ExternalModuleManager } = require('./modules/external-manager'); +const { resolveModuleVersion } = require('./modules/version-resolver'); +const { Manifest } = require('./core/manifest'); +const { + parseChannelOptions, + buildPlan, + decideChannelForModule, + orphanPinWarnings, + bundledTargetWarnings, +} = require('./modules/channel-plan'); +const channelResolver = require('./modules/channel-resolver'); const prompts = require('./prompts'); -// Separator class for visual grouping in select/multiselect prompts -// Note: @clack/prompts doesn't support separators natively, they are filtered out -class Separator { - constructor(text = '────────') { - this.line = text; - this.name = text; +const manifest = new Manifest(); + +/** + * Format a resolved version for display in installer labels. + * Semver-like values are normalized to a single leading "v". + * @param {string|null|undefined} version + * @returns {string} + */ +function formatDisplayVersion(version) { + const trimmed = typeof version === 'string' ? version.trim() : ''; + if (!trimmed) return ''; + + const normalized = semver.valid(semver.coerce(trimmed)); + if (normalized) { + return `v${normalized}`; } - type = 'separator'; + + return trimmed; } -// Separator for choice lists (compatible interface) -const choiceUtils = { Separator }; +/** + * Build the display label for a module, showing an upgrade arrow when an + * installed semver differs from the latest resolvable semver. + * @param {string} name + * @param {string} latestVersion + * @param {string} installedVersion + * @returns {string} + */ +function buildModuleLabel(name, latestVersion, installedVersion = '') { + const latestDisplay = formatDisplayVersion(latestVersion); + if (!latestDisplay) return name; + + const installedDisplay = formatDisplayVersion(installedVersion); + const latestSemver = semver.valid(semver.coerce(latestVersion || '')); + const installedSemver = semver.valid(semver.coerce(installedVersion || '')); + + if (installedDisplay && latestSemver && installedSemver && semver.neq(installedSemver, latestSemver)) { + return `${name} (${installedDisplay} → ${latestDisplay})`; + } + + return `${name} (${latestDisplay})`; +} + +/** + * Resolve the version to show for a module picker entry. External modules use + * the same channel/tag resolver as installs; bundled modules fall back to local + * source metadata. + * @param {string} moduleCode - Module code (e.g., 'core', 'bmm', 'cis') + * @param {Object} options + * @param {string|null} [options.repoUrl] - Module repository URL for tag resolution + * @param {string|null} [options.registryDefault] - Registry default channel + * @param {Object|null} [options.channelOptions] - Parsed installer channel options + * @returns {Promise<{version: string, lookupAttempted: boolean, lookupSucceeded: boolean}>} + */ +async function getModuleVersion(moduleCode, { repoUrl = null, registryDefault = null, channelOptions = null } = {}) { + if (repoUrl) { + const plan = decideChannelForModule({ + code: moduleCode, + channelOptions, + registryDefault, + }); + + try { + const resolved = await channelResolver.resolveChannel({ + channel: plan.channel, + pin: plan.pin, + repoUrl, + }); + if (resolved?.version) { + return { + version: resolved.version, + lookupAttempted: plan.channel === 'stable', + lookupSucceeded: true, + }; + } + } catch { + // Fall back to local metadata when tag resolution is unavailable. + } + } + + const versionInfo = await resolveModuleVersion(moduleCode); + return { + version: versionInfo.version || '', + lookupAttempted: !!repoUrl, + lookupSucceeded: false, + }; +} /** * UI utilities for the installer @@ -36,6 +122,31 @@ class UI { const messageLoader = new MessageLoader(); await messageLoader.displayStartMessage(); + // Parse channel flags (--channel/--all-*/--next=/--pin) once. Warnings + // are surfaced immediately so the user sees them before any git ops run. + const channelOptions = parseChannelOptions(options); + for (const warning of channelOptions.warnings) { + await prompts.log.warn(warning); + } + + // When the user launched the installer from a prerelease (npx bmad-method@next), + // mirror that intent for external modules: seed the global channel to 'next' so + // the module picker's version labels resolve from main HEAD (matching what + // actually gets installed) and the interactive channel gate skips — the user + // already declared "next" intent by typing @next. Explicit channel flags + // override this seed. + if ( + semver.prerelease(installerPackageJson.version) !== null && + !channelOptions.global && + channelOptions.nextSet.size === 0 && + channelOptions.pins.size === 0 + ) { + channelOptions.global = 'next'; + await prompts.log.info( + 'Launched from a prerelease — installing all external modules from main HEAD (next channel). Pass --all-stable or --pin to override.', + ); + } + // Get directory from options or prompt let confirmedDirectory; if (options.directory) { @@ -58,11 +169,6 @@ class UI { // Check if there's an existing BMAD installation const hasExistingInstall = await fs.pathExists(bmadDir); - let customContentConfig = { hasCustomContent: false }; - if (!hasExistingInstall) { - customContentConfig._shouldAsk = true; - } - // Track action type (only set if there's an existing installation) let actionType; @@ -70,17 +176,14 @@ class UI { if (hasExistingInstall) { // Get version information const { existingInstall, bmadDir } = await this.getExistingInstallation(confirmedDirectory); - const packageJsonPath = path.join(__dirname, '../../package.json'); - const currentVersion = require(packageJsonPath).version; - const installedVersion = existingInstall.installed ? existingInstall.version || 'unknown' : 'unknown'; // Build menu choices dynamically const choices = []; // Always show Quick Update first (allows refreshing installation even on same version) - if (installedVersion !== 'unknown') { + if (existingInstall.installed) { choices.push({ - name: `Quick Update (v${installedVersion} → v${currentVersion})`, + name: 'Quick Update', value: 'quick-update', }); } @@ -97,12 +200,15 @@ class UI { actionType = options.action; await prompts.log.info(`Using action from command-line: ${actionType}`); } else if (options.yes) { - // Default to quick-update if available, otherwise first available choice + // Default to quick-update if available, unless flags that require the + // full update path are present (e.g. --custom-source which re-clones + // modules at a new version — quick-update skips that entirely). if (choices.length === 0) { throw new Error('No valid actions available for this installation'); } const hasQuickUpdate = choices.some((c) => c.value === 'quick-update'); - actionType = hasQuickUpdate ? 'quick-update' : choices[0].value; + const needsFullUpdate = !!options.customSource; + actionType = hasQuickUpdate && !needsFullUpdate ? 'quick-update' : (choices.find((c) => c.value === 'update') || choices[0]).value; await prompts.log.info(`Non-interactive mode (--yes): defaulting to ${actionType}`); } else { actionType = await prompts.select({ @@ -114,48 +220,9 @@ class UI { // Handle quick update separately if (actionType === 'quick-update') { - // Pass --custom-content through so installer can re-cache if cache is missing - let customContentForQuickUpdate = { hasCustomContent: false }; - if (options.customContent) { - const paths = options.customContent - .split(',') - .map((p) => p.trim()) - .filter(Boolean); - if (paths.length > 0) { - const customPaths = []; - const selectedModuleIds = []; - const sources = []; - for (const customPath of paths) { - const expandedPath = this.expandUserPath(customPath); - const validation = this.validateCustomContentPathSync(expandedPath); - if (validation) continue; - let moduleMeta; - try { - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - moduleMeta = require('yaml').parse(await fs.readFile(moduleYamlPath, 'utf-8')); - } catch { - continue; - } - if (!moduleMeta?.code) continue; - customPaths.push(expandedPath); - selectedModuleIds.push(moduleMeta.code); - sources.push({ path: expandedPath, id: moduleMeta.code, name: moduleMeta.name || moduleMeta.code }); - } - if (customPaths.length > 0) { - customContentForQuickUpdate = { - hasCustomContent: true, - selected: true, - sources, - selectedFiles: customPaths.map((p) => path.join(p, 'module.yaml')), - selectedModuleIds, - }; - } - } - } return { actionType: 'quick-update', directory: confirmedDirectory, - customContent: customContentForQuickUpdate, skipPrompts: options.yes || false, }; } @@ -164,7 +231,7 @@ class UI { // Return early with modify configuration if (actionType === 'update') { // Get existing installation info - const { installedModuleIds } = await this.getExistingInstallation(confirmedDirectory); + const { installedModuleIds, installedModuleVersions } = await this.getExistingInstallation(confirmedDirectory); await prompts.log.message(`Found existing modules: ${[...installedModuleIds].join(', ')}`); @@ -177,127 +244,27 @@ class UI { .map((m) => m.trim()) .filter(Boolean); await prompts.log.info(`Using modules from command-line: ${selectedModules.join(', ')}`); + } else if (options.customSource && !options.yes) { + // Custom source without --modules or --yes: start with empty list + // (only custom source modules + core will be installed). + // When --yes is also set, fall through to the --yes branch so all + // installed modules are included alongside the custom source modules. + selectedModules = []; } else if (options.yes) { selectedModules = await this.getDefaultModules(installedModuleIds); await prompts.log.info( `Non-interactive mode (--yes): using default modules (installed + defaults): ${selectedModules.join(', ')}`, ); } else { - selectedModules = await this.selectAllModules(installedModuleIds); + selectedModules = await this.selectAllModules(installedModuleIds, installedModuleVersions, channelOptions); } - // After module selection, ask about custom modules - let customModuleResult = { selectedCustomModules: [], customContentConfig: { hasCustomContent: false } }; - - if (options.customContent) { - // Use custom content from command-line - const paths = options.customContent - .split(',') - .map((p) => p.trim()) - .filter(Boolean); - await prompts.log.info(`Using custom content from command-line: ${paths.join(', ')}`); - - // Build custom content config similar to promptCustomContentSource - const customPaths = []; - const selectedModuleIds = []; - const sources = []; - - for (const customPath of paths) { - const expandedPath = this.expandUserPath(customPath); - const validation = this.validateCustomContentPathSync(expandedPath); - if (validation) { - await prompts.log.warn(`Skipping invalid custom content path: ${customPath} - ${validation}`); - continue; - } - - // Read module metadata - let moduleMeta; - try { - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - const moduleYaml = await fs.readFile(moduleYamlPath, 'utf-8'); - const yaml = require('yaml'); - moduleMeta = yaml.parse(moduleYaml); - } catch (error) { - await prompts.log.warn(`Skipping custom content path: ${customPath} - failed to read module.yaml: ${error.message}`); - continue; - } - - if (!moduleMeta) { - await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml is empty`); - continue; - } - - if (!moduleMeta.code) { - await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml missing 'code' field`); - continue; - } - - customPaths.push(expandedPath); - selectedModuleIds.push(moduleMeta.code); - sources.push({ - path: expandedPath, - id: moduleMeta.code, - name: moduleMeta.name || moduleMeta.code, - }); + // Resolve custom sources from --custom-source flag + if (options.customSource) { + const customCodes = await this._resolveCustomSourcesCli(options.customSource); + for (const code of customCodes) { + if (!selectedModules.includes(code)) selectedModules.push(code); } - - if (customPaths.length > 0) { - customModuleResult = { - selectedCustomModules: selectedModuleIds, - customContentConfig: { - hasCustomContent: true, - selected: true, - sources, - selectedFiles: customPaths.map((p) => path.join(p, 'module.yaml')), - selectedModuleIds: selectedModuleIds, - }, - }; - } - } else if (options.yes) { - // Non-interactive mode: preserve existing custom modules (matches default: false) - const cacheDir = path.join(bmadDir, '_config', 'custom'); - if (await fs.pathExists(cacheDir)) { - const entries = await fs.readdir(cacheDir, { withFileTypes: true }); - for (const entry of entries) { - if (entry.isDirectory()) { - customModuleResult.selectedCustomModules.push(entry.name); - } - } - await prompts.log.info( - `Non-interactive mode (--yes): preserving ${customModuleResult.selectedCustomModules.length} existing custom module(s)`, - ); - } else { - await prompts.log.info('Non-interactive mode (--yes): no existing custom modules found'); - } - } else { - const changeCustomModules = await prompts.confirm({ - message: 'Modify custom modules, agents, or workflows?', - default: false, - }); - - if (changeCustomModules) { - customModuleResult = await this.handleCustomModulesInModifyFlow(confirmedDirectory, selectedModules); - } else { - // Preserve existing custom modules if user doesn't want to modify them - const { Installer } = require('./core/installer'); - const installer = new Installer(); - const { bmadDir } = await installer.findBmadDir(confirmedDirectory); - - const cacheDir = path.join(bmadDir, '_config', 'custom'); - if (await fs.pathExists(cacheDir)) { - const entries = await fs.readdir(cacheDir, { withFileTypes: true }); - for (const entry of entries) { - if (entry.isDirectory()) { - customModuleResult.selectedCustomModules.push(entry.name); - } - } - } - } - } - - // Merge any selected custom modules - if (customModuleResult.selectedCustomModules.length > 0) { - selectedModules.push(...customModuleResult.selectedCustomModules); } // Ensure core is in the modules list @@ -305,10 +272,38 @@ class UI { selectedModules.unshift('core'); } + // For existing installs, resolve per-module update decisions BEFORE + // we clone anything. Reads the existing manifest's recorded channel + // per module and prompts the user on available upgrades (patch/minor + // default Y, major default N). Legacy entries with no channel are + // migrated here too. Mutates channelOptions.pins to lock rejections. + await this._resolveUpdateChannels({ + bmadDir, + selectedModules, + channelOptions, + yes: options.yes || false, + }); + // Get tool selection const toolSelection = await this.promptToolSelection(confirmedDirectory, options); - const moduleConfigs = await this.collectModuleConfigs(confirmedDirectory, selectedModules, options); + const moduleConfigs = await this.collectModuleConfigs(confirmedDirectory, selectedModules, { + ...options, + channelOptions, + }); + + // Warn about --pin/--next flags that refer to modules the user didn't + // select, or that target bundled modules (core/bmm) where channel + // flags don't apply. + { + const bundledCodes = await this._bundledModuleCodes(); + for (const warning of [ + ...orphanPinWarnings(channelOptions, selectedModules), + ...bundledTargetWarnings(channelOptions, bundledCodes), + ]) { + await prompts.log.warn(warning); + } + } return { actionType: 'update', @@ -318,14 +313,14 @@ class UI { skipIde: toolSelection.skipIde, coreConfig: moduleConfigs.core || {}, moduleConfigs: moduleConfigs, - customContent: customModuleResult.customContentConfig, skipPrompts: options.yes || false, + channelOptions, }; } } // This section is only for new installations (update returns early above) - const { installedModuleIds } = await this.getExistingInstallation(confirmedDirectory); + const { installedModuleIds, installedModuleVersions } = await this.getExistingInstallation(confirmedDirectory); // Unified module selection - all modules in one grouped multiselect let selectedModules; @@ -336,98 +331,56 @@ class UI { .map((m) => m.trim()) .filter(Boolean); await prompts.log.info(`Using modules from command-line: ${selectedModules.join(', ')}`); + } else if (options.customSource) { + // Custom source without --modules: start with empty list (core added below) + selectedModules = []; } else if (options.yes) { // Use default modules when --yes flag is set selectedModules = await this.getDefaultModules(installedModuleIds); await prompts.log.info(`Using default modules (--yes flag): ${selectedModules.join(', ')}`); } else { - selectedModules = await this.selectAllModules(installedModuleIds); + selectedModules = await this.selectAllModules(installedModuleIds, installedModuleVersions, channelOptions); } - // Ask about custom content (local modules/agents/workflows) - if (options.customContent) { - // Use custom content from command-line - const paths = options.customContent - .split(',') - .map((p) => p.trim()) - .filter(Boolean); - await prompts.log.info(`Using custom content from command-line: ${paths.join(', ')}`); - - // Build custom content config similar to promptCustomContentSource - const customPaths = []; - const selectedModuleIds = []; - const sources = []; - - for (const customPath of paths) { - const expandedPath = this.expandUserPath(customPath); - const validation = this.validateCustomContentPathSync(expandedPath); - if (validation) { - await prompts.log.warn(`Skipping invalid custom content path: ${customPath} - ${validation}`); - continue; - } - - // Read module metadata - let moduleMeta; - try { - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - const moduleYaml = await fs.readFile(moduleYamlPath, 'utf-8'); - const yaml = require('yaml'); - moduleMeta = yaml.parse(moduleYaml); - } catch (error) { - await prompts.log.warn(`Skipping custom content path: ${customPath} - failed to read module.yaml: ${error.message}`); - continue; - } - - if (!moduleMeta) { - await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml is empty`); - continue; - } - - if (!moduleMeta.code) { - await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml missing 'code' field`); - continue; - } - - customPaths.push(expandedPath); - selectedModuleIds.push(moduleMeta.code); - sources.push({ - path: expandedPath, - id: moduleMeta.code, - name: moduleMeta.name || moduleMeta.code, - }); + // Resolve custom sources from --custom-source flag + if (options.customSource) { + const customCodes = await this._resolveCustomSourcesCli(options.customSource); + for (const code of customCodes) { + if (!selectedModules.includes(code)) selectedModules.push(code); } - - if (customPaths.length > 0) { - customContentConfig = { - hasCustomContent: true, - selected: true, - sources, - selectedFiles: customPaths.map((p) => path.join(p, 'module.yaml')), - selectedModuleIds: selectedModuleIds, - }; - } - } else if (!options.yes) { - const wantsCustomContent = await prompts.confirm({ - message: 'Add custom modules, agents, or workflows from your computer?', - default: false, - }); - - if (wantsCustomContent) { - customContentConfig = await this.promptCustomContentSource(); - } - } - - // Add custom content modules if any were selected - if (customContentConfig && customContentConfig.selectedModuleIds) { - selectedModules.push(...customContentConfig.selectedModuleIds); } // Ensure core is in the modules list if (!selectedModules.includes('core')) { selectedModules.unshift('core'); } + + // Interactive channel gate: "Ready to install (all stable)? [Y/n]" + // Only shown for fresh installs with no channel flags and an external module + // selected. Skipped for prerelease launches because channelOptions.global + // was already seeded to 'next' upstream. Non-interactive installs skip this + // and fall through to the registry default (stable) or whatever flags were + // supplied. + await this._interactiveChannelGate({ options, channelOptions, selectedModules }); + let toolSelection = await this.promptToolSelection(confirmedDirectory, options); - const moduleConfigs = await this.collectModuleConfigs(confirmedDirectory, selectedModules, options); + const moduleConfigs = await this.collectModuleConfigs(confirmedDirectory, selectedModules, { + ...options, + channelOptions, + }); + + // Warn about --pin/--next flags that refer to modules the user didn't + // select, or that target bundled modules (core/bmm) where channel + // flags don't apply. + { + const bundledCodes = await this._bundledModuleCodes(); + for (const warning of [ + ...orphanPinWarnings(channelOptions, selectedModules), + ...bundledTargetWarnings(channelOptions, bundledCodes), + ]) { + await prompts.log.warn(warning); + } + } return { actionType: 'install', @@ -437,8 +390,8 @@ class UI { skipIde: toolSelection.skipIde, coreConfig: moduleConfigs.core || {}, moduleConfigs: moduleConfigs, - customContent: customContentConfig, skipPrompts: options.yes || false, + channelOptions, }; } @@ -687,7 +640,7 @@ class UI { /** * Get existing installation info and installed modules * @param {string} directory - Installation directory - * @returns {Object} Object with existingInstall, installedModuleIds, and bmadDir + * @returns {Object} Object with existingInstall, installedModuleIds, installedModuleVersions, and bmadDir */ async getExistingInstallation(directory) { const { ExistingInstall } = require('./core/existing-install'); @@ -696,8 +649,26 @@ class UI { const { bmadDir } = await installer.findBmadDir(directory); const existingInstall = await ExistingInstall.detect(bmadDir); const installedModuleIds = new Set(existingInstall.moduleIds); + const installedModuleVersions = new Map(); + const manifestModules = await manifest.getAllModuleVersions(bmadDir); - return { existingInstall, installedModuleIds, bmadDir }; + for (const module of manifestModules) { + if (module?.name && module.version) { + installedModuleVersions.set(module.name, module.version); + } + } + + for (const module of existingInstall.modules) { + if (module?.id && module.version && module.version !== 'unknown' && !installedModuleVersions.has(module.id)) { + installedModuleVersions.set(module.id, module.version); + } + } + + if (existingInstall.hasCore && existingInstall.version && !installedModuleVersions.has('core')) { + installedModuleVersions.set('core', existingInstall.version); + } + + return { existingInstall, installedModuleIds, installedModuleVersions, bmadDir }; } /** @@ -710,7 +681,7 @@ class UI { */ async collectModuleConfigs(directory, modules, options = {}) { const { OfficialModules } = require('./modules/official-modules'); - const configCollector = new OfficialModules(); + const configCollector = new OfficialModules({ channelOptions: options.channelOptions }); // Seed core config from CLI options if provided if (options.userName || options.communicationLanguage || options.documentOutputLanguage || options.outputFolder) { @@ -776,166 +747,132 @@ class UI { } /** - * Get module choices for selection + * Select all modules across three tiers: official, community, and custom URL. * @param {Set} installedModuleIds - Currently installed module IDs - * @param {Object} customContentConfig - Custom content configuration - * @returns {Array} Module choices for prompt + * @param {Map} installedModuleVersions - Installed module versions from the local manifest + * @param {Object|null} channelOptions - Parsed installer channel options + * @returns {Array} Selected module codes (excluding core) */ - async getModuleChoices(installedModuleIds, customContentConfig = null) { - const color = await prompts.getColor(); - const moduleChoices = []; - const isNewInstallation = installedModuleIds.size === 0; + async selectAllModules(installedModuleIds = new Set(), installedModuleVersions = new Map(), channelOptions = null) { + // Phase 1: Official modules + const officialSelected = await this._selectOfficialModules(installedModuleIds, installedModuleVersions, channelOptions); - const customContentItems = []; + // Determine which installed modules are NOT official (community or custom). + // These must be preserved even if the user declines to browse community/custom. + const officialCodes = new Set(officialSelected); + const externalManager = new ExternalModuleManager(); + const registryModules = await externalManager.listAvailable(); + const officialRegistryCodes = new Set(['core', 'bmm', ...registryModules.map((m) => m.code)]); + const installedNonOfficial = [...installedModuleIds].filter((id) => !officialRegistryCodes.has(id)); - // Add custom content items - if (customContentConfig && customContentConfig.hasCustomContent && customContentConfig.customPath) { - // Existing installation - show from directory - const customHandler = new CustomHandler(); - const customFiles = await customHandler.findCustomContent(customContentConfig.customPath); + // Phase 2: Community modules (category drill-down) + // Returns { codes, didBrowse } so we know if the user entered the flow + const communityResult = await this._browseCommunityModules(installedModuleIds); - for (const customFile of customFiles) { - const customInfo = await customHandler.getCustomInfo(customFile); - if (customInfo) { - customContentItems.push({ - name: `${color.cyan('\u2713')} ${customInfo.name} ${color.dim(`(${customInfo.relativePath})`)}`, - value: `__CUSTOM_CONTENT__${customFile}`, // Unique value for each custom content - checked: true, // Default to selected since user chose to provide custom content - path: customInfo.path, // Track path to avoid duplicates - hint: customInfo.description || undefined, - }); - } + // Phase 3: Custom URL modules + const customSelected = await this._addCustomUrlModules(installedModuleIds); + + // Merge all selections + const allSelected = new Set([...officialSelected, ...communityResult.codes, ...customSelected]); + + // Auto-include installed non-official modules that the user didn't get + // a chance to manage (they declined to browse). If they did browse, + // trust their selections - they could have deselected intentionally. + if (!communityResult.didBrowse) { + for (const code of installedNonOfficial) { + allSelected.add(code); } } - // Add official modules - const { OfficialModules } = require('./modules/official-modules'); - const officialModules = new OfficialModules(); - const { modules: availableModules, customModules: customModulesFromCache } = await officialModules.listAvailable(); - - // First, add all items to appropriate sections - const allCustomModules = []; - - // Add custom content items from directory - allCustomModules.push(...customContentItems); - - // Add custom modules from cache - for (const mod of customModulesFromCache) { - // Skip if this module is already in customContentItems (by path) - const isDuplicate = allCustomModules.some((item) => item.path && mod.path && path.resolve(item.path) === path.resolve(mod.path)); - - if (!isDuplicate) { - allCustomModules.push({ - name: `${color.cyan('\u2713')} ${mod.name} ${color.dim('(cached)')}`, - value: mod.id, - checked: isNewInstallation ? mod.defaultSelected || false : installedModuleIds.has(mod.id), - hint: mod.description || undefined, - }); - } - } - - // Add separators and modules in correct order - if (allCustomModules.length > 0) { - // Add separator for custom content, all custom modules, and official content separator - moduleChoices.push( - new choiceUtils.Separator('── Custom Content ──'), - ...allCustomModules, - new choiceUtils.Separator('── Official Content ──'), - ); - } - - // Add official modules (only non-custom ones) - for (const mod of availableModules) { - if (!mod.isCustom) { - moduleChoices.push({ - name: mod.name, - value: mod.id, - checked: isNewInstallation ? mod.defaultSelected || false : installedModuleIds.has(mod.id), - hint: mod.description || undefined, - }); - } - } - - return moduleChoices; + return [...allSelected]; } /** - * Select all modules (official + community) using grouped multiselect. - * Core is shown as locked but filtered from the result since it's always installed separately. + * Select official modules using autocompleteMultiselect. + * Extracted from the original selectAllModules - unchanged behavior. * @param {Set} installedModuleIds - Currently installed module IDs - * @returns {Array} Selected module codes (excluding core) + * @param {Map} installedModuleVersions - Installed module versions from the local manifest + * @param {Object|null} channelOptions - Parsed installer channel options + * @returns {Array} Selected official module codes */ - async selectAllModules(installedModuleIds = new Set()) { + async _selectOfficialModules(installedModuleIds = new Set(), installedModuleVersions = new Map(), channelOptions = null) { + // Built-in modules (core, bmm) come from local source, not the registry const { OfficialModules } = require('./modules/official-modules'); - const officialModulesSource = new OfficialModules(); - const { modules: localModules } = await officialModulesSource.listAvailable(); + const builtInModules = (await new OfficialModules().listAvailable()).modules || []; - // Get external modules + // External modules come from the registry (with fallback) const externalManager = new ExternalModuleManager(); - const externalModules = await externalManager.listAvailable(); + const registryModules = await externalManager.listAvailable(); - // Build flat options list with group hints for autocompleteMultiselect const allOptions = []; const initialValues = []; const lockedValues = ['core']; - // Core module is always installed — show it locked at the top - allOptions.push({ label: 'BMad Core Module', value: 'core', hint: 'Core configuration and shared resources' }); - initialValues.push('core'); - - // Helper to build module entry with proper sorting and selection - const buildModuleEntry = (mod, value, group) => { - const isInstalled = installedModuleIds.has(value); + const buildModuleEntry = async (code, name, description, isDefault, repoUrl = null, registryDefault = null) => { + const isInstalled = installedModuleIds.has(code); + const installedVersion = installedModuleVersions.get(code) || ''; + const versionState = await getModuleVersion(code, { repoUrl, registryDefault, channelOptions }); + const label = buildModuleLabel(name, versionState.version, installedVersion); return { - label: mod.name, - value, - hint: mod.description || group, - // Pre-select only if already installed (not on fresh install) - selected: isInstalled, + label, + value: code, + hint: description, + selected: isInstalled || isDefault, + lookupAttempted: versionState.lookupAttempted, + lookupSucceeded: versionState.lookupSucceeded, }; }; - // Local modules (BMM, BMB, etc.) - const localEntries = []; - for (const mod of localModules) { - if (!mod.isCustom && mod.id !== 'core') { - const entry = buildModuleEntry(mod, mod.id, 'Local'); - localEntries.push(entry); - if (entry.selected) { - initialValues.push(mod.id); - } + // Add built-in modules first (always available regardless of network) + const builtInCodes = new Set(); + for (const mod of builtInModules) { + const code = mod.id; + builtInCodes.add(code); + const entry = await buildModuleEntry(code, mod.name, mod.description, mod.defaultSelected); + allOptions.push({ label: entry.label, value: entry.value, hint: entry.hint }); + if (entry.selected) { + initialValues.push(code); } } - allOptions.push(...localEntries.map(({ label, value, hint }) => ({ label, value, hint }))); - // Group 2: BMad Official Modules (type: bmad-org) - const officialModules = []; - for (const mod of externalModules) { - if (mod.type === 'bmad-org') { - const entry = buildModuleEntry(mod, mod.code, 'Official'); - officialModules.push(entry); - if (entry.selected) { - initialValues.push(mod.code); - } - } - } - allOptions.push(...officialModules.map(({ label, value, hint }) => ({ label, value, hint }))); + // Add external registry modules (skip built-in duplicates) + const externalRegistryModules = registryModules.filter((mod) => !mod.builtIn && !builtInCodes.has(mod.code)); + let externalRegistryEntries = []; + if (externalRegistryModules.length > 0) { + const spinner = await prompts.spinner(); + spinner.start('Checking latest module versions...'); - // Group 3: Community Modules (type: community) - const communityModules = []; - for (const mod of externalModules) { - if (mod.type === 'community') { - const entry = buildModuleEntry(mod, mod.code, 'Community'); - communityModules.push(entry); - if (entry.selected) { - initialValues.push(mod.code); - } + externalRegistryEntries = await Promise.all( + externalRegistryModules.map(async (mod) => ({ + code: mod.code, + entry: await buildModuleEntry( + mod.code, + mod.name, + mod.description, + mod.defaultSelected, + mod.url || null, + mod.defaultChannel || null, + ), + })), + ); + + spinner.stop('Checked latest module versions.'); + + const attemptedLookups = externalRegistryEntries.filter(({ entry }) => entry.lookupAttempted).length; + const successfulLookups = externalRegistryEntries.filter(({ entry }) => entry.lookupSucceeded).length; + if (attemptedLookups > 0 && successfulLookups === 0) { + await prompts.log.warn('Could not check latest module versions; showing cached/local versions.'); + } + } + for (const { code, entry } of externalRegistryEntries) { + allOptions.push({ label: entry.label, value: entry.value, hint: entry.hint }); + if (entry.selected) { + initialValues.push(code); } } - allOptions.push(...communityModules.map(({ label, value, hint }) => ({ label, value, hint }))); const selected = await prompts.autocompleteMultiselect({ - message: 'Select modules to install:', + message: 'Select official modules to install:', options: allOptions, initialValues: initialValues.length > 0 ? initialValues : undefined, lockedValues, @@ -945,34 +882,482 @@ class UI { const result = selected ? [...selected] : []; - // Display selected modules as bulleted list if (result.length > 0) { const moduleLines = result.map((moduleId) => { const opt = allOptions.find((o) => o.value === moduleId); return ` \u2022 ${opt?.label || moduleId}`; }); - await prompts.log.message('Selected modules:\n' + moduleLines.join('\n')); + await prompts.log.message('Selected official modules:\n' + moduleLines.join('\n')); } return result; } + /** + * Browse and select community modules using category drill-down. + * Featured/promoted modules appear at the top. + * @param {Set} installedModuleIds - Currently installed module IDs + * @returns {Object} { codes: string[], didBrowse: boolean } + */ + async _browseCommunityModules(installedModuleIds = new Set()) { + const browseCommunity = await prompts.confirm({ + message: 'Would you like to browse community modules?', + default: false, + }); + if (!browseCommunity) return { codes: [], didBrowse: false }; + + const { CommunityModuleManager } = require('./modules/community-manager'); + const communityMgr = new CommunityModuleManager(); + + const s = await prompts.spinner(); + s.start('Loading community module catalog...'); + + let categories, featured, allCommunity; + try { + [categories, featured, allCommunity] = await Promise.all([ + communityMgr.getCategoryList(), + communityMgr.listFeatured(), + communityMgr.listAll(), + ]); + s.stop(`Community catalog loaded (${allCommunity.length} modules)`); + } catch (error) { + s.error('Failed to load community catalog'); + await prompts.log.warn(` ${error.message}`); + return { codes: [], didBrowse: false }; + } + + if (allCommunity.length === 0) { + await prompts.log.info('No community modules are currently available.'); + return { codes: [], didBrowse: false }; + } + + const selectedCodes = new Set(); + let browsing = true; + + while (browsing) { + const categoryChoices = []; + + // Featured section at top + if (featured.length > 0) { + categoryChoices.push({ + value: '__featured__', + label: `\u2605 Featured (${featured.length} module${featured.length === 1 ? '' : 's'})`, + }); + } + + // Categories with module counts + for (const cat of categories) { + categoryChoices.push({ + value: cat.slug, + label: `${cat.name} (${cat.moduleCount} module${cat.moduleCount === 1 ? '' : 's'})`, + }); + } + + // Special actions at bottom + categoryChoices.push( + { value: '__all__', label: '\u25CE View all community modules' }, + { value: '__search__', label: '\u25CE Search by keyword' }, + { value: '__done__', label: '\u2713 Done browsing' }, + ); + + const selectedCount = selectedCodes.size; + const categoryChoice = await prompts.select({ + message: `Browse community modules${selectedCount > 0 ? ` (${selectedCount} selected)` : ''}:`, + choices: categoryChoices, + }); + + if (categoryChoice === '__done__') { + browsing = false; + continue; + } + + let modulesToShow; + switch (categoryChoice) { + case '__featured__': { + modulesToShow = featured; + + break; + } + case '__all__': { + modulesToShow = allCommunity; + + break; + } + case '__search__': { + const query = await prompts.text({ + message: 'Search community modules:', + placeholder: 'e.g., design, testing, game', + }); + if (!query || query.trim() === '') continue; + modulesToShow = await communityMgr.searchByKeyword(query.trim()); + if (modulesToShow.length === 0) { + await prompts.log.warn('No matching modules found.'); + continue; + } + + break; + } + default: { + modulesToShow = await communityMgr.listByCategory(categoryChoice); + } + } + + // Build options for autocompleteMultiselect + const trustBadge = (tier) => { + if (tier === 'bmad-certified') return '\u2713'; + if (tier === 'community-reviewed') return '\u25CB'; + return '\u26A0'; + }; + + const options = modulesToShow.map((mod) => { + const versionStr = mod.version ? ` (v${mod.version})` : ''; + const badge = trustBadge(mod.trustTier); + return { + label: `${mod.displayName}${versionStr} [${badge}]`, + value: mod.code, + hint: mod.description, + }; + }); + + // Pre-check modules that are already selected or installed + const initialValues = modulesToShow.filter((m) => selectedCodes.has(m.code) || installedModuleIds.has(m.code)).map((m) => m.code); + + const selected = await prompts.autocompleteMultiselect({ + message: 'Select community modules:', + options, + initialValues: initialValues.length > 0 ? initialValues : undefined, + required: false, + maxItems: Math.min(options.length, 10), + }); + + // Update accumulated selections: sync with what user selected in this view + const shownCodes = new Set(modulesToShow.map((m) => m.code)); + for (const code of shownCodes) { + if (selected && selected.includes(code)) { + selectedCodes.add(code); + } else { + selectedCodes.delete(code); + } + } + } + + if (selectedCodes.size > 0) { + const moduleLines = []; + for (const code of selectedCodes) { + const mod = await communityMgr.getModuleByCode(code); + moduleLines.push(` \u2022 ${mod?.displayName || code}`); + } + await prompts.log.message('Selected community modules:\n' + moduleLines.join('\n')); + } + + return { codes: [...selectedCodes], didBrowse: true }; + } + + /** + * Prompt user to install modules from custom sources (Git URLs or local paths). + * @param {Set} installedModuleIds - Currently installed module IDs + * @returns {Array} Selected custom module code strings + */ + async _addCustomUrlModules(installedModuleIds = new Set()) { + const addCustom = await prompts.confirm({ + message: 'Would you like to install from a custom source (Git URL or local path)?', + default: false, + }); + if (!addCustom) return []; + + const { CustomModuleManager } = require('./modules/custom-module-manager'); + const customMgr = new CustomModuleManager(); + const selectedModules = []; + + let addMore = true; + while (addMore) { + const sourceInput = await prompts.text({ + message: 'Git URL or local path:', + placeholder: 'https://github.com/owner/repo or /path/to/module', + validate: (input) => { + if (!input || input.trim() === '') return 'Source is required'; + const result = customMgr.parseSource(input.trim()); + return result.isValid ? undefined : result.error; + }, + }); + + const s = await prompts.spinner(); + s.start('Resolving source...'); + + let sourceResult; + try { + sourceResult = await customMgr.resolveSource(sourceInput.trim(), { skipInstall: true, silent: true }); + s.stop(sourceResult.parsed.type === 'local' ? 'Local source resolved' : 'Repository cloned'); + } catch (error) { + s.error('Failed to resolve source'); + await prompts.log.error(` ${error.message}`); + addMore = await prompts.confirm({ message: 'Try another source?', default: false }); + continue; + } + + if (sourceResult.parsed.type === 'local') { + await prompts.log.info('LOCAL MODULE: Pointing directly at local source (changes take effect on reinstall).'); + } else { + await prompts.log.warn( + 'UNVERIFIED MODULE: This module has not been reviewed by the BMad team.\n' + ' Only install modules from sources you trust.', + ); + } + + // Resolve plugins based on discovery mode vs direct mode + s.start('Analyzing plugin structure...'); + const allResolved = []; + const localPath = sourceResult.parsed.type === 'local' ? sourceResult.rootDir : null; + + if (sourceResult.mode === 'discovery') { + // Discovery mode: marketplace.json found, list available plugins + let plugins; + try { + plugins = await customMgr.discoverModules(sourceResult.marketplace, sourceResult.sourceUrl); + } catch (discoverError) { + s.error('Failed to discover modules'); + await prompts.log.error(` ${discoverError.message}`); + addMore = await prompts.confirm({ message: 'Try another source?', default: false }); + continue; + } + + const effectiveRepoPath = sourceResult.repoPath || sourceResult.rootDir; + for (const plugin of plugins) { + try { + const resolved = await customMgr.resolvePlugin(effectiveRepoPath, plugin.rawPlugin, sourceResult.sourceUrl, localPath); + if (resolved.length > 0) { + allResolved.push(...resolved); + } else { + // No skills array or empty - use plugin metadata as-is (legacy) + allResolved.push({ + code: plugin.code, + name: plugin.displayName || plugin.name, + version: plugin.version, + description: plugin.description, + strategy: 0, + pluginName: plugin.name, + skillPaths: [], + }); + } + } catch (resolveError) { + await prompts.log.warn(` Could not resolve ${plugin.name}: ${resolveError.message}`); + } + } + } else { + // Direct mode: no marketplace.json, scan directory for skills and resolve + const directPlugin = { + name: sourceResult.parsed.displayName || path.basename(sourceResult.rootDir), + source: '.', + skills: [], + }; + + // Scan for SKILL.md directories to populate skills array + try { + const entries = await fs.readdir(sourceResult.rootDir, { withFileTypes: true }); + for (const entry of entries) { + if (entry.isDirectory()) { + const skillMd = path.join(sourceResult.rootDir, entry.name, 'SKILL.md'); + if (await fs.pathExists(skillMd)) { + directPlugin.skills.push(entry.name); + } + } + } + } catch (scanError) { + s.error('Failed to scan directory'); + await prompts.log.error(` ${scanError.message}`); + addMore = await prompts.confirm({ message: 'Try another source?', default: false }); + continue; + } + + if (directPlugin.skills.length > 0) { + try { + const resolved = await customMgr.resolvePlugin(sourceResult.rootDir, directPlugin, sourceResult.sourceUrl, localPath); + allResolved.push(...resolved); + } catch (resolveError) { + await prompts.log.warn(` Could not resolve: ${resolveError.message}`); + } + } + } + s.stop(`Found ${allResolved.length} installable module${allResolved.length === 1 ? '' : 's'}`); + + if (allResolved.length === 0) { + await prompts.log.warn('No installable modules found in this source.'); + addMore = await prompts.confirm({ message: 'Try another source?', default: false }); + continue; + } + + // Build multiselect choices + // Already-installed modules are pre-checked (update). New modules are unchecked (opt-in). + // Unchecking an installed module means "skip update" - removal is handled elsewhere. + const choices = allResolved.map((mod) => { + const versionStr = mod.version ? ` v${mod.version}` : ''; + const skillCount = mod.skillPaths ? mod.skillPaths.length : 0; + const skillStr = skillCount > 0 ? ` (${skillCount} skill${skillCount === 1 ? '' : 's'})` : ''; + const alreadyInstalled = installedModuleIds.has(mod.code); + const hint = alreadyInstalled ? 'update' : undefined; + + return { + name: `${mod.name}${versionStr}${skillStr}`, + value: mod.code, + hint, + checked: alreadyInstalled, + }; + }); + + // Show descriptions before the multiselect + for (const mod of allResolved) { + const versionStr = mod.version ? ` v${mod.version}` : ''; + await prompts.log.info(` ${mod.name}${versionStr}\n ${mod.description}`); + } + + const selected = await prompts.multiselect({ + message: 'Select modules to install:', + choices, + required: false, + }); + + if (selected && selected.length > 0) { + for (const code of selected) { + selectedModules.push(code); + } + } + + addMore = await prompts.confirm({ + message: 'Add another custom source?', + default: false, + }); + } + + if (selectedModules.length > 0) { + await prompts.log.message('Selected custom modules:\n' + selectedModules.map((c) => ` \u2022 ${c}`).join('\n')); + } + + return selectedModules; + } + + /** + * Resolve custom sources from --custom-source CLI flag (non-interactive). + * Auto-selects all discovered modules from each source. + * @param {string} sourcesArg - Comma-separated Git URLs or local paths + * @returns {Array} Module codes from all resolved sources + */ + async _resolveCustomSourcesCli(sourcesArg) { + const { CustomModuleManager } = require('./modules/custom-module-manager'); + const customMgr = new CustomModuleManager(); + const allCodes = []; + + const sources = sourcesArg + .split(',') + .map((s) => s.trim()) + .filter(Boolean); + + for (const source of sources) { + const s = await prompts.spinner(); + s.start(`Resolving ${source}...`); + + let sourceResult; + try { + sourceResult = await customMgr.resolveSource(source, { skipInstall: true, silent: true }); + s.stop(sourceResult.parsed.type === 'local' ? 'Local source resolved' : 'Repository cloned'); + } catch (error) { + s.error(`Failed to resolve ${source}`); + await prompts.log.error(` ${error.message}`); + continue; + } + + const s2 = await prompts.spinner(); + s2.start('Analyzing plugin structure...'); + const allResolved = []; + const localPath = sourceResult.parsed.type === 'local' ? sourceResult.rootDir : null; + + if (sourceResult.mode === 'discovery') { + try { + const plugins = await customMgr.discoverModules(sourceResult.marketplace, sourceResult.sourceUrl); + const effectiveRepoPath = sourceResult.repoPath || sourceResult.rootDir; + for (const plugin of plugins) { + try { + const resolved = await customMgr.resolvePlugin(effectiveRepoPath, plugin.rawPlugin, sourceResult.sourceUrl, localPath); + if (resolved.length > 0) { + allResolved.push(...resolved); + } + } catch { + // Skip unresolvable plugins + } + } + } catch (discoverError) { + s2.error('Failed to discover modules'); + await prompts.log.error(` ${discoverError.message}`); + continue; + } + } else { + // Direct mode: scan for SKILL.md directories + const directPlugin = { + name: sourceResult.parsed.displayName || path.basename(sourceResult.rootDir), + source: '.', + skills: [], + }; + try { + const entries = await fs.readdir(sourceResult.rootDir, { withFileTypes: true }); + for (const entry of entries) { + if (entry.isDirectory()) { + const skillMd = path.join(sourceResult.rootDir, entry.name, 'SKILL.md'); + if (await fs.pathExists(skillMd)) { + directPlugin.skills.push(entry.name); + } + } + } + } catch { + // Skip unreadable directories + } + + if (directPlugin.skills.length > 0) { + try { + const resolved = await customMgr.resolvePlugin(sourceResult.rootDir, directPlugin, sourceResult.sourceUrl, localPath); + allResolved.push(...resolved); + } catch { + // Skip unresolvable + } + } + } + s2.stop(`Found ${allResolved.length} module${allResolved.length === 1 ? '' : 's'}`); + + for (const mod of allResolved) { + allCodes.push(mod.code); + const versionStr = mod.version ? ` v${mod.version}` : ''; + await prompts.log.info(` Custom module: ${mod.name}${versionStr}`); + } + } + + return allCodes; + } + /** * Get default modules for non-interactive mode * @param {Set} installedModuleIds - Already installed module IDs * @returns {Array} Default module codes */ async getDefaultModules(installedModuleIds = new Set()) { + // Built-in modules with default_selected come from local source const { OfficialModules } = require('./modules/official-modules'); - const officialModules = new OfficialModules(); - const { modules: localModules } = await officialModules.listAvailable(); + const builtInModules = (await new OfficialModules().listAvailable()).modules || []; const defaultModules = []; + const seen = new Set(); - // Add default-selected local modules (typically BMM) - for (const mod of localModules) { - if (mod.defaultSelected === true || installedModuleIds.has(mod.id)) { + for (const mod of builtInModules) { + if (mod.defaultSelected || installedModuleIds.has(mod.id)) { defaultModules.push(mod.id); + seen.add(mod.id); + } + } + + // Add external registry defaults + const externalManager = new ExternalModuleManager(); + const registryModules = await externalManager.listAvailable(); + + for (const mod of registryModules) { + if (mod.builtIn || seen.has(mod.code)) continue; + if (mod.defaultSelected || installedModuleIds.has(mod.code)) { + defaultModules.push(mod.code); } } @@ -1273,282 +1658,6 @@ class UI { return existingInstall.ides; } - /** - * Validate custom content path synchronously - * @param {string} input - User input path - * @returns {string|undefined} Error message or undefined if valid - */ - validateCustomContentPathSync(input) { - // Allow empty input to cancel - if (!input || input.trim() === '') { - return; // Allow empty to exit - } - - try { - // Expand the path - const expandedPath = this.expandUserPath(input.trim()); - - // Check if path exists - if (!fs.pathExistsSync(expandedPath)) { - return 'Path does not exist'; - } - - // Check if it's a directory - const stat = fs.statSync(expandedPath); - if (!stat.isDirectory()) { - return 'Path must be a directory'; - } - - // Check for module.yaml in the root - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - if (!fs.pathExistsSync(moduleYamlPath)) { - return 'Directory must contain a module.yaml file in the root'; - } - - // Try to parse the module.yaml to get the module ID - try { - const yaml = require('yaml'); - const content = fs.readFileSync(moduleYamlPath, 'utf8'); - const moduleData = yaml.parse(content); - if (!moduleData.code) { - return 'module.yaml must contain a "code" field for the module ID'; - } - } catch (error) { - return 'Invalid module.yaml file: ' + error.message; - } - - return; // Valid - } catch (error) { - return 'Error validating path: ' + error.message; - } - } - - /** - * Prompt user for custom content source location - * @returns {Object} Custom content configuration - */ - async promptCustomContentSource() { - const customContentConfig = { hasCustomContent: true, sources: [] }; - - // Keep asking for more sources until user is done - while (true) { - // First ask if user wants to add another module or continue - if (customContentConfig.sources.length > 0) { - const action = await prompts.select({ - message: 'Would you like to:', - choices: [ - { name: 'Add another custom module', value: 'add' }, - { name: 'Continue with installation', value: 'continue' }, - ], - default: 'continue', - }); - - if (action === 'continue') { - break; - } - } - - let sourcePath; - let isValid = false; - - while (!isValid) { - // Use sync validation because @clack/prompts doesn't support async validate - const inputPath = await prompts.text({ - message: 'Path to custom module folder (press Enter to skip):', - validate: (input) => this.validateCustomContentPathSync(input), - }); - - // If user pressed Enter without typing anything, exit the loop - if (!inputPath || inputPath.trim() === '') { - // If we have no modules yet, return false for no custom content - if (customContentConfig.sources.length === 0) { - return { hasCustomContent: false }; - } - return customContentConfig; - } - - sourcePath = this.expandUserPath(inputPath); - isValid = true; - } - - // Read module.yaml to get module info - const yaml = require('yaml'); - const moduleYamlPath = path.join(sourcePath, 'module.yaml'); - const moduleContent = await fs.readFile(moduleYamlPath, 'utf8'); - const moduleData = yaml.parse(moduleContent); - - // Add to sources - customContentConfig.sources.push({ - path: sourcePath, - id: moduleData.code, - name: moduleData.name || moduleData.code, - }); - - await prompts.log.success(`Confirmed local custom module: ${moduleData.name || moduleData.code}`); - } - - // Ask if user wants to add these to the installation - const shouldInstall = await prompts.confirm({ - message: `Install these ${customContentConfig.sources.length} custom modules?`, - default: true, - }); - - if (shouldInstall) { - customContentConfig.selected = true; - // Store paths to module.yaml files, not directories - customContentConfig.selectedFiles = customContentConfig.sources.map((s) => path.join(s.path, 'module.yaml')); - // Also include module IDs for installation - customContentConfig.selectedModuleIds = customContentConfig.sources.map((s) => s.id); - } - - return customContentConfig; - } - - /** - * Handle custom modules in the modify flow - * @param {string} directory - Installation directory - * @param {Array} selectedModules - Currently selected modules - * @returns {Object} Result with selected custom modules and custom content config - */ - async handleCustomModulesInModifyFlow(directory, selectedModules) { - // Get existing installation to find custom modules - const { existingInstall } = await this.getExistingInstallation(directory); - - // Check if there are any custom modules in cache - const { Installer } = require('./core/installer'); - const installer = new Installer(); - const { bmadDir } = await installer.findBmadDir(directory); - - const cacheDir = path.join(bmadDir, '_config', 'custom'); - const cachedCustomModules = []; - - if (await fs.pathExists(cacheDir)) { - const entries = await fs.readdir(cacheDir, { withFileTypes: true }); - for (const entry of entries) { - if (entry.isDirectory()) { - const moduleYamlPath = path.join(cacheDir, entry.name, 'module.yaml'); - if (await fs.pathExists(moduleYamlPath)) { - const yaml = require('yaml'); - const content = await fs.readFile(moduleYamlPath, 'utf8'); - const moduleData = yaml.parse(content); - - cachedCustomModules.push({ - id: entry.name, - name: moduleData.name || entry.name, - description: moduleData.description || 'Custom module from cache', - checked: selectedModules.includes(entry.name), - fromCache: true, - }); - } - } - } - } - - const result = { - selectedCustomModules: [], - customContentConfig: { hasCustomContent: false }, - }; - - // Ask user about custom modules - await prompts.log.info('Custom Modules'); - if (cachedCustomModules.length > 0) { - await prompts.log.message('Found custom modules in your installation:'); - } else { - await prompts.log.message('No custom modules currently installed.'); - } - - // Build choices dynamically based on whether we have existing modules - const choices = []; - if (cachedCustomModules.length > 0) { - choices.push( - { name: 'Keep all existing custom modules', value: 'keep' }, - { name: 'Select which custom modules to keep', value: 'select' }, - { name: 'Add new custom modules', value: 'add' }, - { name: 'Remove all custom modules', value: 'remove' }, - ); - } else { - choices.push({ name: 'Add new custom modules', value: 'add' }, { name: 'Cancel (no custom modules)', value: 'cancel' }); - } - - const customAction = await prompts.select({ - message: cachedCustomModules.length > 0 ? 'Manage custom modules?' : 'Add custom modules?', - choices: choices, - default: cachedCustomModules.length > 0 ? 'keep' : 'add', - }); - - switch (customAction) { - case 'keep': { - // Keep all existing custom modules - result.selectedCustomModules = cachedCustomModules.map((m) => m.id); - await prompts.log.message(`Keeping ${result.selectedCustomModules.length} custom module(s)`); - break; - } - - case 'select': { - // Let user choose which to keep - const selectChoices = cachedCustomModules.map((m) => ({ - name: `${m.name} (${m.id})`, - value: m.id, - checked: m.checked, - })); - - // Add "None / I changed my mind" option at the end - const choicesWithSkip = [ - ...selectChoices, - { - name: '⚠ None / I changed my mind - keep no custom modules', - value: '__NONE__', - checked: false, - }, - ]; - - const keepModules = await prompts.multiselect({ - message: 'Select custom modules to keep (use arrow keys, space to toggle):', - choices: choicesWithSkip, - required: true, - }); - - // If user selected both "__NONE__" and other modules, honor the "None" choice - if (keepModules && keepModules.includes('__NONE__') && keepModules.length > 1) { - await prompts.log.warn('"None / I changed my mind" was selected, so no custom modules will be kept.'); - result.selectedCustomModules = []; - } else { - // Filter out the special '__NONE__' value - result.selectedCustomModules = keepModules ? keepModules.filter((m) => m !== '__NONE__') : []; - } - break; - } - - case 'add': { - // By default, keep existing modules when adding new ones - // User chose "Add new" not "Replace", so we assume they want to keep existing - result.selectedCustomModules = cachedCustomModules.map((m) => m.id); - - // Then prompt for new ones (reuse existing method) - const newCustomContent = await this.promptCustomContentSource(); - if (newCustomContent.hasCustomContent && newCustomContent.selected) { - result.selectedCustomModules.push(...newCustomContent.selectedModuleIds); - result.customContentConfig = newCustomContent; - } - break; - } - - case 'remove': { - // Remove all custom modules - await prompts.log.warn('All custom modules will be removed from the installation'); - break; - } - - case 'cancel': { - // User cancelled - no custom modules - await prompts.log.message('No custom modules will be added'); - break; - } - } - - return result; - } - /** * Display module versions with update availability * @param {Array} modules - Array of module info objects with version info @@ -1558,6 +1667,7 @@ class UI { // Group modules by source const builtIn = modules.filter((m) => m.source === 'built-in'); const external = modules.filter((m) => m.source === 'external'); + const community = modules.filter((m) => m.source === 'community'); const custom = modules.filter((m) => m.source === 'custom'); const unknown = modules.filter((m) => m.source === 'unknown'); @@ -1578,6 +1688,7 @@ class UI { formatGroup(builtIn, 'Built-in Modules'); formatGroup(external, 'External Modules (Official)'); + formatGroup(community, 'Community Modules'); formatGroup(custom, 'Custom Modules'); formatGroup(unknown, 'Other Modules'); @@ -1678,6 +1789,351 @@ class UI { }); await prompts.log.message('Selected tools:\n' + toolLines.join('\n')); } + + /** + * Return the set of module codes the registry marks as built-in (core, bmm). + * These ship with the installer binary and have no per-module channel. + */ + async _bundledModuleCodes() { + const externalManager = new ExternalModuleManager(); + try { + const modules = await externalManager.listAvailable(); + return modules.filter((m) => m.builtIn).map((m) => m.code); + } catch { + // Registry unreachable — fall back to the known bundled codes. + return ['core', 'bmm']; + } + } + + /** + * Fast-path channel gate: confirm "all stable" or open the per-module picker. + * + * Skipped when: + * - running non-interactively (--yes) + * - the user already passed channel flags (--channel / --pin / --next), OR + * the installer was launched from a prerelease (which seeds + * channelOptions.global = 'next' upstream in promptInstall) + * - no externals/community modules are selected + * + * Mutates channelOptions.pins and channelOptions.nextSet to reflect picker choices. + */ + async _interactiveChannelGate({ options, channelOptions, selectedModules }) { + if (options.yes) return; + // If the user already declared their channel intent via flags, trust them + // and skip the gate. + const haveFlagIntent = channelOptions.global || channelOptions.nextSet.size > 0 || channelOptions.pins.size > 0; + if (haveFlagIntent) return; + + // Figure out which selected modules actually get a channel (externals + + // community modules). Bundled core/bmm and custom modules skip the picker. + const externalManager = new ExternalModuleManager(); + const externals = await externalManager.listAvailable(); + const externalByCode = new Map(externals.map((m) => [m.code, m])); + + const { CommunityModuleManager } = require('./modules/community-manager'); + const communityMgr = new CommunityModuleManager(); + const community = await communityMgr.listAll(); + const communityByCode = new Map(community.map((m) => [m.code, m])); + + const channelSelectable = selectedModules.filter((code) => { + const info = externalByCode.get(code) || communityByCode.get(code); + return info && !info.builtIn; + }); + if (channelSelectable.length === 0) return; + + const fastPath = await prompts.confirm({ + message: `Ready to install (all stable)? Pick "n" to customize channels or pin versions.`, + default: true, + }); + if (fastPath) return; // stable for all, registry default applies + + // Customize path: per-module picker. + const { fetchStableTags, parseGitHubRepo } = require('./modules/channel-resolver'); + + for (const code of channelSelectable) { + const info = externalByCode.get(code) || communityByCode.get(code); + const repoUrl = info.url; + + // Try to pre-resolve the top stable tag so we can surface it in the picker. + let stableLabel = 'stable (released version)'; + try { + const parsed = repoUrl ? parseGitHubRepo(repoUrl) : null; + if (parsed) { + const tags = await fetchStableTags(parsed.owner, parsed.repo); + if (tags.length > 0) { + stableLabel = `stable ${tags[0].tag} (released version)`; + } + } + } catch { + // fall through with the generic label + } + + const choice = await prompts.select({ + message: `${code}: choose a channel`, + choices: [ + { name: stableLabel, value: 'stable' }, + { name: 'next (main HEAD \u2014 current development)', value: 'next' }, + { name: 'pin (specific version)', value: 'pin' }, + ], + default: 'stable', + }); + + if (choice === 'next') { + channelOptions.nextSet.add(code); + } else if (choice === 'pin') { + const pinValue = await prompts.text({ + message: `Enter a version tag for '${code}' (e.g. v1.6.0):`, + validate: (value) => { + if (!value || !/^[\w.\-+/]+$/.test(String(value).trim())) { + return 'Must be a non-empty tag name (letters, digits, dots, hyphens).'; + } + }, + }); + channelOptions.pins.set(code, String(pinValue).trim()); + } + // 'stable' is the default; nothing to record. + } + } + + /** + * Resolve channel decisions for an update over an existing install. + * + * For each selected external/community module: + * - Read the recorded channel from the existing manifest. + * - On `stable`: query tags; if a newer stable exists, classify the diff + * and prompt. Patch/minor default Y; major defaults N. `--yes` accepts + * defaults (patches/minors) but NOT majors — a major under --yes stays + * frozen unless the user also passes `--pin CODE=NEW_TAG`. + * - On `next`: no prompt (pull HEAD). + * - On `pinned`: no prompt (stays pinned). + * - No channel recorded and `version: null`: one-time migration prompt + * ("Switch to stable / Keep on next"). + * + * Decisions that freeze the current version are applied by adding a pin to + * `channelOptions.pins` so downstream clone logic honors them. + */ + async _resolveUpdateChannels({ bmadDir, selectedModules, channelOptions, yes }) { + const { Manifest } = require('./core/manifest'); + const manifestObj = new Manifest(); + const manifest = await manifestObj.read(bmadDir); + const existingByName = new Map(); + for (const m of manifest?.modulesDetailed || []) { + if (m?.name) existingByName.set(m.name, m); + } + if (existingByName.size === 0) return; + + const externalManager = new ExternalModuleManager(); + const externals = await externalManager.listAvailable(); + const externalByCode = new Map(externals.map((m) => [m.code, m])); + + const { CommunityModuleManager } = require('./modules/community-manager'); + const communityMgr = new CommunityModuleManager(); + const community = await communityMgr.listAll(); + const communityByCode = new Map(community.map((m) => [m.code, m])); + + const { fetchStableTags, classifyUpgrade, releaseNotesUrl } = require('./modules/channel-resolver'); + const { parseGitHubRepo } = require('./modules/channel-resolver'); + + // Interactive-only: offer a one-time gate to review / switch channels for + // selected modules that are already installed. Default N so normal Modify + // flows (add/remove modules) aren't interrupted. + let reviewChannels = false; + if (!yes) { + const existingWithChannel = selectedModules.filter((code) => { + const prev = existingByName.get(code); + if (!prev) return false; + const info = externalByCode.get(code) || communityByCode.get(code); + return info && !info.builtIn; + }); + if (existingWithChannel.length > 0) { + reviewChannels = await prompts.confirm({ + message: 'Review channel assignments (stable / next / pin) for your existing modules?', + default: false, + }); + } + } + + for (const code of selectedModules) { + const prev = existingByName.get(code); + if (!prev) continue; + + const info = externalByCode.get(code) || communityByCode.get(code); + if (!info) continue; + // Bundled modules (core/bmm) ship with the installer binary itself — + // their version is stapled to the CLI version, not a git tag. Skip + // tag-API lookups for them; the "upgrade" mechanism is `npx bmad@X install`. + if (info.builtIn) continue; + + const repoUrl = info.url; + const parsed = repoUrl ? parseGitHubRepo(repoUrl) : null; + + // Legacy migration: manifest carries no channel and a null/empty + // version. Offer the one-time pick between stable and next. + const recordedChannel = prev.channel || null; + const needsMigration = !recordedChannel && (prev.version == null || prev.version === ''); + if (needsMigration) { + if (yes) { + // Conservative headless default: stable. + continue; + } + const chosen = await prompts.select({ + message: `${code}: your existing install tracks the main branch. Switch to stable releases (recommended for production), or keep on main?`, + choices: [ + { name: 'Switch to stable', value: 'stable' }, + { name: 'Keep on main (next)', value: 'next' }, + ], + default: 'stable', + }); + if (chosen === 'next') channelOptions.nextSet.add(code); + continue; + } + + // Optional channel-switch offer. Fires only when the user opted in via + // the gate above. 'keep' falls through to the existing per-channel + // logic (which runs upgrade classification for stable). Any switch + // records the new intent into channelOptions and skips upgrade prompts. + if (reviewChannels && recordedChannel) { + const switchChoices = [ + { + name: `Keep on '${recordedChannel}'${prev.version ? ` @ ${prev.version}` : ''}`, + value: 'keep', + }, + ]; + if (recordedChannel !== 'stable') { + switchChoices.push({ name: 'Switch to stable (released version)', value: 'stable' }); + } + if (recordedChannel !== 'next') { + switchChoices.push({ name: 'Switch to next (main HEAD)', value: 'next' }); + } + switchChoices.push({ name: 'Pin to a specific version tag', value: 'pin' }); + + const choice = await prompts.select({ + message: `${code} channel:`, + choices: switchChoices, + default: 'keep', + }); + + if (choice === 'next') { + channelOptions.nextSet.add(code); + continue; + } + if (choice === 'pin') { + const pinValue = await prompts.text({ + message: `Enter a version tag for '${code}' (e.g. v1.6.0):`, + validate: (value) => { + if (!value || !/^[\w.\-+/]+$/.test(String(value).trim())) { + return 'Must be a non-empty tag name (letters, digits, dots, hyphens).'; + } + }, + }); + channelOptions.pins.set(code, String(pinValue).trim()); + continue; + } + if (choice === 'stable') { + // Switch to stable: install at the top stable tag without an + // upgrade-classification prompt (the user explicitly opted in). + // Also warm the tag cache here so the actual clone step doesn't + // need a second GitHub API call (can hit rate limits). + if (parsed) { + try { + await fetchStableTags(parsed.owner, parsed.repo); + } catch { + // best effort; clone step will surface any failure + } + } + continue; + } + // 'keep' → fall through with recordedChannel below. + } + + if (recordedChannel === 'pinned' || recordedChannel === 'next') { + // Respect any explicit channel intent the user already expressed via + // CLI flags (--channel / --all-* / --next=CODE / --pin CODE=TAG) or + // via the interactive review gate above. Only auto-re-assert the + // recorded channel when the user hasn't opted into anything else — + // otherwise --all-stable (or a review "switch to stable") would be + // silently clobbered by the prior channel. + const alreadyDecided = channelOptions.global || channelOptions.nextSet.has(code) || channelOptions.pins.has(code); + if (!alreadyDecided) { + if (recordedChannel === 'pinned' && prev.version) { + channelOptions.pins.set(code, prev.version); + } else if (recordedChannel === 'next') { + channelOptions.nextSet.add(code); + } + } + continue; + } + + // Stable channel: check for a newer released tag. + if (!parsed) continue; + // Respect explicit CLI intent (--pin / --next=CODE / --all-*) and any + // choice the user already made in the earlier review gate. Without this + // guard the upgrade classifier below would unconditionally call + // `channelOptions.pins.set(code, prev.version)` on decline/major-refuse/ + // fetch-error, silently clobbering the user's override. + const alreadyDecided = channelOptions.global || channelOptions.nextSet.has(code) || channelOptions.pins.has(code); + if (alreadyDecided) continue; + let tags; + try { + tags = await fetchStableTags(parsed.owner, parsed.repo); + } catch (error) { + await prompts.log.warn(`Could not check for updates on ${code} (${error.message}). Leaving at ${prev.version}.`); + if (prev.version) channelOptions.pins.set(code, prev.version); + continue; + } + if (!tags || tags.length === 0) continue; + const topTag = tags[0].tag; // e.g. "v1.7.0" + const currentTag = prev.version || ''; + const diffClass = classifyUpgrade(currentTag, topTag); + + if (diffClass === 'none') continue; // already at or above top tag + + const notes = releaseNotesUrl(repoUrl, topTag); + let accept; + if (diffClass === 'major') { + if (yes) { + // Major under --yes is refused by design. + await prompts.log.warn( + `${code} ${currentTag} → ${topTag} is a new major release; staying on ${currentTag}. ` + + `To accept, rerun with --pin ${code}=${topTag}.`, + ); + channelOptions.pins.set(code, currentTag); + continue; + } + accept = await prompts.confirm({ + message: + `${code} ${topTag} available — new major release (may change behavior).` + + (notes ? ` Release notes: ${notes}.` : '') + + ' Upgrade?', + default: false, + }); + } else if (diffClass === 'minor') { + if (yes) { + accept = true; + } else { + accept = await prompts.confirm({ + message: `${code} ${topTag} available (new features).` + (notes ? ` Release notes: ${notes}.` : '') + ' Upgrade?', + default: true, + }); + } + } else { + // patch + if (yes) { + accept = true; + } else { + accept = await prompts.confirm({ + message: `${code} ${topTag} available. Upgrade?`, + default: true, + }); + } + } + + if (!accept && currentTag) { + // Freeze the current version by pinning it for this run. + channelOptions.pins.set(code, currentTag); + } + } + } } module.exports = { UI }; diff --git a/tools/migrate-custom-module-paths.js b/tools/migrate-custom-module-paths.js index 13aa3e710..b199e8bfe 100755 --- a/tools/migrate-custom-module-paths.js +++ b/tools/migrate-custom-module-paths.js @@ -3,7 +3,7 @@ * This should be run once to update existing installations */ -const fs = require('fs-extra'); +const fs = require('./installer/fs-native'); const path = require('node:path'); const yaml = require('yaml'); const chalk = require('chalk'); diff --git a/tools/platform-codes.yaml b/tools/platform-codes.yaml deleted file mode 100644 index 7227af0ce..000000000 --- a/tools/platform-codes.yaml +++ /dev/null @@ -1,169 +0,0 @@ -# BMAD Platform Codes Configuration -# Central configuration for all platform/IDE codes used in the BMAD system -# -# This file defines the standardized platform codes that are used throughout -# the installation system to identify different platforms (IDEs, tools, etc.) -# -# Format: -# code: Platform identifier used internally -# name: Display name shown to users -# preferred: Whether this platform is shown as a recommended option on install -# category: Type of platform (ide, tool, service, etc.) - -platforms: - # Recommended Platforms - claude-code: - name: "Claude Code" - preferred: true - category: cli - description: "Anthropic's official CLI for Claude" - - cursor: - name: "Cursor" - preferred: true - category: ide - description: "AI-first code editor" - - # Other IDEs and Tools - cline: - name: "Cline" - preferred: false - category: ide - description: "AI coding assistant" - - opencode: - name: "OpenCode" - preferred: false - category: ide - description: "OpenCode terminal coding assistant" - - codebuddy: - name: "CodeBuddy" - preferred: false - category: ide - description: "Tencent Cloud Code Assistant - AI-powered coding companion" - - auggie: - name: "Auggie" - preferred: false - category: cli - description: "AI development tool" - - roo: - name: "Roo Code" - preferred: false - category: ide - description: "Enhanced Cline fork" - - rovo-dev: - name: "Rovo Dev" - preferred: false - category: ide - description: "Atlassian's Rovo development environment" - - kiro: - name: "Kiro" - preferred: false - category: ide - description: "Amazon's AI-powered IDE" - - github-copilot: - name: "GitHub Copilot" - preferred: false - category: ide - description: "GitHub's AI pair programmer" - - codex: - name: "Codex" - preferred: false - category: cli - description: "OpenAI Codex integration" - - qwen: - name: "QwenCoder" - preferred: false - category: ide - description: "Qwen AI coding assistant" - - gemini: - name: "Gemini CLI" - preferred: false - category: cli - description: "Google's CLI for Gemini" - - iflow: - name: "iFlow" - preferred: false - category: ide - description: "AI workflow automation" - - kilo: - name: "KiloCoder" - preferred: false - category: ide - description: "AI coding platform" - - crush: - name: "Crush" - preferred: false - category: ide - description: "AI development assistant" - - antigravity: - name: "Google Antigravity" - preferred: false - category: ide - description: "Google's AI development environment" - - trae: - name: "Trae" - preferred: false - category: ide - description: "AI coding tool" - - windsurf: - name: "Windsurf" - preferred: false - category: ide - description: "AI-powered IDE with cascade flows" - - junie: - name: "Junie" - preferred: false - category: cli - description: "AI coding agent by JetBrains" - - ona: - name: "Ona" - preferred: false - category: ide - description: "Ona AI development environment" - -# Platform categories -categories: - ide: - name: "Integrated Development Environment" - description: "Full-featured code editors with AI assistance" - - cli: - name: "Command Line Interface" - description: "Terminal-based tools" - - tool: - name: "Development Tool" - description: "Standalone development utilities" - - service: - name: "Cloud Service" - description: "Cloud-based development platforms" - - extension: - name: "Editor Extension" - description: "Plugins for existing editors" - -# Naming conventions and rules -conventions: - code_format: "lowercase-kebab-case" - name_format: "Title Case" - max_code_length: 20 - allowed_characters: "a-z0-9-" diff --git a/tools/validate-file-refs.js b/tools/validate-file-refs.js index 5f412eb88..7e137763c 100644 --- a/tools/validate-file-refs.js +++ b/tools/validate-file-refs.js @@ -80,7 +80,7 @@ function escapeTableCell(str) { } // Path prefixes/patterns that only exist in installed structure, not in source -const INSTALL_ONLY_PATHS = ['_config/']; +const INSTALL_ONLY_PATHS = ['_config/', 'custom/']; // Files that are generated at install time and don't exist in the source tree const INSTALL_GENERATED_FILES = ['config.yaml', 'config.user.yaml']; @@ -156,8 +156,15 @@ function mapInstalledToSource(refPath) { // Skip install-only paths (generated at install time, not in source) if (isInstallOnly(cleaned)) return null; - // core/, bmm/, and utility/ are directly under src/ - if (cleaned.startsWith('core/') || cleaned.startsWith('bmm/') || cleaned.startsWith('utility/')) { + // Map installed module names to their source directory names + // _bmad/core/ → src/core-skills/, _bmad/bmm/ → src/bmm-skills/ + if (cleaned.startsWith('core/')) { + return path.join(SRC_DIR, 'core-skills', cleaned.slice('core/'.length)); + } + if (cleaned.startsWith('bmm/')) { + return path.join(SRC_DIR, 'bmm-skills', cleaned.slice('bmm/'.length)); + } + if (cleaned.startsWith('utility/')) { return path.join(SRC_DIR, cleaned); } diff --git a/website/astro.config.mjs b/website/astro.config.mjs index a089a99a2..64ea3e0d9 100644 --- a/website/astro.config.mjs +++ b/website/astro.config.mjs @@ -92,33 +92,55 @@ export default defineConfig({ // Sidebar configuration (Diataxis structure) sidebar: [ - { label: 'Welcome', translations: { 'vi-VN': 'Chào mừng', 'zh-CN': '欢迎', 'fr-FR': 'Bienvenue' }, slug: 'index' }, - { label: 'Roadmap', translations: { 'vi-VN': 'Lộ trình', 'zh-CN': '路线图', 'fr-FR': 'Feuille de route' }, slug: 'roadmap' }, + { + label: 'Welcome', + translations: { 'vi-VN': 'Chào mừng', 'zh-CN': '欢迎', 'fr-FR': 'Bienvenue', 'cs-CZ': 'Vítejte' }, + slug: 'index', + }, + { + label: 'Roadmap', + translations: { 'vi-VN': 'Lộ trình', 'zh-CN': '路线图', 'fr-FR': 'Feuille de route', 'cs-CZ': 'Plán rozvoje' }, + slug: 'roadmap', + }, { label: 'Tutorials', - translations: { 'vi-VN': 'Hướng dẫn nhập môn', 'zh-CN': '教程', 'fr-FR': 'Tutoriels' }, + translations: { 'vi-VN': 'Hướng dẫn nhập môn', 'zh-CN': '教程', 'fr-FR': 'Tutoriels', 'cs-CZ': 'Tutoriály' }, collapsed: false, autogenerate: { directory: 'tutorials' }, }, { label: 'How-To Guides', - translations: { 'vi-VN': 'Hướng dẫn tác vụ', 'zh-CN': '操作指南', 'fr-FR': 'Guides pratiques' }, + translations: { 'vi-VN': 'Hướng dẫn tác vụ', 'zh-CN': '操作指南', 'fr-FR': 'Guides pratiques', 'cs-CZ': 'Praktické návody' }, collapsed: true, autogenerate: { directory: 'how-to' }, }, { label: 'Explanation', - translations: { 'vi-VN': 'Giải thích', 'zh-CN': '概念说明', 'fr-FR': 'Explications' }, + translations: { 'vi-VN': 'Giải thích', 'zh-CN': '概念说明', 'fr-FR': 'Explications', 'cs-CZ': 'Vysvětlení' }, collapsed: true, autogenerate: { directory: 'explanation' }, }, { label: 'Reference', - translations: { 'vi-VN': 'Tham chiếu', 'zh-CN': '参考', 'fr-FR': 'Référence' }, + translations: { 'vi-VN': 'Tham chiếu', 'zh-CN': '参考', 'fr-FR': 'Référence', 'cs-CZ': 'Reference' }, collapsed: true, autogenerate: { directory: 'reference' }, }, // TEA docs moved to standalone module site; keep BMM sidebar focused. + { + label: 'BMad Ecosystem', + collapsed: false, + items: [ + { label: 'BMad Builder', link: 'https://bmad-builder-docs.bmad-method.org/', attrs: { target: '_blank' } }, + { label: 'Creative Intelligence Suite', link: 'https://cis-docs.bmad-method.org/', attrs: { target: '_blank' } }, + { label: 'Game Dev Studio', link: 'https://game-dev-studio-docs.bmad-method.org/', attrs: { target: '_blank' } }, + { + label: 'Test Architect (TEA)', + link: 'https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/', + attrs: { target: '_blank' }, + }, + ], + }, ], // Credits in footer diff --git a/website/public/diagrams/checkpoint-preview-diagram-fr.webp b/website/public/diagrams/checkpoint-preview-diagram-fr.webp new file mode 100644 index 000000000..caa0ac09b Binary files /dev/null and b/website/public/diagrams/checkpoint-preview-diagram-fr.webp differ diff --git a/website/public/workflow-map-diagram-fr.html b/website/public/workflow-map-diagram-fr.html index bc59f23a9..1fde3c038 100644 --- a/website/public/workflow-map-diagram-fr.html +++ b/website/public/workflow-map-diagram-fr.html @@ -93,7 +93,6 @@ .agent-icon.john { background: linear-gradient(135deg, #60a5fa, #3b82f6); } .agent-icon.sally { background: linear-gradient(135deg, #fbbf24, #f59e0b); color: #000; } .agent-icon.winston { background: linear-gradient(135deg, #a78bfa, #8b5cf6); } - .agent-icon.bob { background: linear-gradient(135deg, #34d399, #10b981); color: #000; } .agent-icon.amelia { background: linear-gradient(135deg, #fb7185, #ef4444); } .agent-name { font-size: 0.65rem; } @@ -261,7 +260,7 @@ sprint-planning
-
B
Bob
+
A
Amelia
sprint-status.yaml →
@@ -270,7 +269,7 @@ create-story
-
B
Bob
+
A
Amelia
story-[slug].md →
@@ -308,7 +307,7 @@ par Epic
-
B
Bob
+
A
Amelia
leçons
diff --git a/website/public/workflow-map-diagram.html b/website/public/workflow-map-diagram.html index 897492700..0a17cc2eb 100644 --- a/website/public/workflow-map-diagram.html +++ b/website/public/workflow-map-diagram.html @@ -93,7 +93,6 @@ .agent-icon.john { background: linear-gradient(135deg, #60a5fa, #3b82f6); } .agent-icon.sally { background: linear-gradient(135deg, #fbbf24, #f59e0b); color: #000; } .agent-icon.winston { background: linear-gradient(135deg, #a78bfa, #8b5cf6); } - .agent-icon.bob { background: linear-gradient(135deg, #34d399, #10b981); color: #000; } .agent-icon.amelia { background: linear-gradient(135deg, #fb7185, #ef4444); } .agent-name { font-size: 0.65rem; } @@ -272,7 +271,7 @@ sprint-planning
-
B
Bob
+
A
Amelia
sprint-status.yaml →
@@ -281,7 +280,7 @@ create-story
-
B
Bob
+
A
Amelia
story-[slug].md →
@@ -319,7 +318,7 @@ per epic
-
B
Bob
+
A
Amelia
lessons
diff --git a/website/src/components/Banner.astro b/website/src/components/Banner.astro index 2b607f621..034a7dc85 100644 --- a/website/src/components/Banner.astro +++ b/website/src/components/Banner.astro @@ -7,9 +7,13 @@ const llmsFullUrl = `${getSiteUrl()}/llms-full.txt`;
🤖 Consolidated, AI-optimized BMAD docs: llms-full.txt. Fetch this plain text file for complete context.
+
+ 🚀 Build your own BMad modules and share them with the community! Get started or submit to the marketplace. +