Compare commits

..

1130 Commits

Author SHA1 Message Date
murat
7205451346 fix: addressed Brian 2nd round of comments 2026-01-28 18:47:05 -06:00
murat
6faa25843f fix: addressed Alex's comments 2026-01-28 13:55:56 -06:00
murat
e99a02f409 fix: addressed PR comments 2026-01-28 10:27:27 -06:00
murat
5d1b58b238 feat: removed tea module, added sdet with 1 workflow for automate 2026-01-28 09:38:30 -06:00
Brian Madison
dd8c54cc9f no double agent files and .agent.md file extensions. 2026-01-27 23:08:26 -08:00
Brian Madison
4ded43d707 fix paths in prd edit flow 2026-01-27 22:03:53 -08:00
Davor Racic
181aeac04a fix(ide): add support for Gemini CLI TOML format (#1431)
* fix(ide): add support for Gemini CLI TOML format

* fix(ide): Added normalization for config.extension, added .yml to the extension array

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-27 21:56:12 -08:00
Murat K Ozcan
f7466c2530 feat: added tea module as an external module (#1430) 2026-01-27 17:29:34 -08:00
The Chef
7d3d51ff4f docs: fix typos in README and customization guide (#1424)
- Remove duplicate "for" in README example command
- Fix "this is" to "thing is" in README
- Remove extra "at" in "star project icon at near" in README
- Fix "MEthod" to "Method" in customize-bmad.md
2026-01-26 23:25:08 -08:00
Vladimir Hrusovsky
4c92e0cc88 Fix: Correct workflow_path in bmad-quick-flow/quick-spec steps (#1368)
- Fix workflow_path in step-01-understand.md, step-02-investigate.md, and step-03-generate.md
- Changed from non-existent 'create-tech-spec' to correct 'quick-spec'
- Aligns with step-04-review.md which already had correct path

Co-authored-by: Your Name <you@example.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-26 23:15:22 -08:00
Brian Madison
0d2b8c3429 readme link fix 2026-01-26 18:22:04 -08:00
Brian Madison
984bd9e558 Bump version to 6.0.0-Beta.2 2026-01-26 17:44:49 -06:00
Brian Madison
6a282f86b4 allow updates from any beta, warn on alpha and v4 2026-01-26 17:33:02 -06:00
Brian Madison
6c5381b6dc help system update 2026-01-26 16:30:47 -06:00
Brian Madison
27c18e0020 installer fix 2026-01-26 16:06:00 -06:00
Brian Madison
9ebc4ce9c0 package push 2026-01-26 00:28:14 -06:00
Brian Madison
5ffef8dc35 6.0.0-beta.0 2026-01-26 00:15:32 -06:00
Brian Madison
43c0e290d2 feat(installer): update install messages for Beta.0 release 2026-01-26 00:15:22 -06:00
Brian Madison
cad9be3e89 feat(installer): update install messages for Beta.0 release 2026-01-26 00:09:46 -06:00
Brian Madison
82d211b7ca release: bump to v6.0.0-Beta.0 - Alpha to Beta transition
- Transition BMad Method from Alpha to Beta
- Beta versions now publish to npm 'latest' tag (default for npx)
- Updated manual release workflow to prioritize beta releases
- Updated CHANGELOG with Beta.0 release notes
2026-01-26 00:06:17 -06:00
Brian Madison
8719d828d0 fix width and responsiveness of diagram 2026-01-26 00:06:17 -06:00
Brian
3abcefe1fb feat: make workflow diagram iframe full-width (#1409)
- Add CSS to break workflow diagram iframe out of content container
- iframe now spans full viewport width instead of max-width constraint
- Adjust iframe height to 700px for better fit
- Remove border/border-radius for seamless full-width look

Co-authored-by: Brian Madison <brianmadison@Brians-MacBook-Pro.local>
2026-01-25 23:00:04 -06:00
Brian Madison
9168e00167 fix(build): add iframe support to rehype base path plugin
Allows iframe src attributes to be properly transformed with the base path,
enabling the interactive workflow diagram to be embedded in markdown pages.
2026-01-25 22:43:00 -06:00
Brian Madison
d0c9cd7b0b removed dead code and obsolete levels 0-4 ref 2026-01-25 22:23:36 -06:00
Brian Madison
c352e03d18 add interactive diagram to test final doc build and layout 2026-01-25 22:12:23 -06:00
Brian Madison
9b12f6f86c docs updates 2026-01-25 21:18:09 -06:00
Alex Verkhovsky
91f6c41be1 docs: radical reduction of documentation scope for v6 beta (#1406)
* docs: radical reduction of documentation scope for v6 beta

Archive and basement unreviewed content to ship a focused, minimal doc set.

Changes:
- Archive stale how-to workflow guides (will rewrite for v6)
- Archive outdated explanation and reference content
- Move unreviewed content to basement for later review
- Reorganize TEA docs into dedicated /tea/ section
- Add workflow-map visual reference page
- Simplify getting-started tutorial and sidebar navigation
- Add explanation pages: brainstorming, adversarial-review, party-mode,
  quick-flow, advanced-elicitation
- Fix base URL handling for subdirectory deployments (GitHub Pages forks)

The goal is a minimal, accurate doc set for beta rather than
comprehensive but potentially misleading content.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor: restructure BMM and agents documentation by consolidating and flattening index files.

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-25 14:00:26 -06:00
Alex Verkhovsky
02513c721f fix(workflow): correct stale path references in check-implementation-readiness steps (#1404)
Directory was renamed in 1da77058 but step file contents weren't updated.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-25 03:57:50 -06:00
Brian Madison
e7a34a2b61 installer updates 2026-01-25 03:56:40 -06:00
Brian Madison
85339708e6 normalize commands 2026-01-25 03:56:40 -06:00
Brian Madison
b4f230f565 installer standardization 2026-01-25 03:56:40 -06:00
Brian Madison
b102694c64 Fix: use String.raw for escaped triple quotes in TOML 2026-01-25 03:56:40 -06:00
Brian Madison
5aef6379b9 Fix github-copilot installer to use UnifiedInstaller for prompts
- Add .github/prompts directory alongside .github/agents
- Use UnifiedInstaller with TemplateType.COPILOT for prompts/workflows/tasks/tools
- Fix typo: bmd-custom- -> bmad- prefix for agents
- Update cleanup to handle both directories
- Format fixes for auggie.js and windsurf.js
2026-01-25 03:56:40 -06:00
Brian Madison
4cb5cc7dbc Fix gemini installer to use UnifiedInstaller with .toml support
- Add fileExtension parameter support to path-utils (toColonPath, toDashPath)
- Add TemplateType.GEMINI to unified-installer for TOML output format
- Update task-tool-command-generator to support TOML format
- Refactor gemini.js to use UnifiedInstaller with:
  - NamingStyle.FLAT_DASH for dash-separated filenames
  - TemplateType.GEMINI for TOML format (description + prompt fields)
  - fileExtension: '.toml' for Gemini CLI

TOML format:
description = "BMAD Agent: Title"
prompt = """
Content here
"""
2026-01-25 03:56:40 -06:00
Brian Madison
c5d0fb55ba Fix windsurf installer to use UnifiedInstaller with flat files
- Replace manual artifact collection with UnifiedInstaller class
- Remove nested folder structure (.windsurf/workflows/bmad/[module]/[type]/)
- Now installs flat files to .windsurf/workflows/ (e.g., bmad-bmm-agent-pm.md)
- Use NamingStyle.FLAT_DASH and TemplateType.WINDSURF
- Add customTemplateFn for Windsurf-specific auto_execution_mode frontmatter
- Simplify cleanup() and update installCustomAgentLauncher() for flat structure
2026-01-25 03:56:40 -06:00
Brian Madison
c0adbc4e76 Fix cline installer to use UnifiedInstaller
- Replace individual generators with UnifiedInstaller class
- Use NamingStyle.FLAT_DASH and TemplateType.CLINE
- Remove collectClineArtifacts, flattenAndWriteArtifacts, flattenFilename methods
- Reduce code by ~98 lines (36% reduction)
- Keep cleanup(), installCustomAgentLauncher(), detect() as-is
2026-01-25 03:56:40 -06:00
Brian Madison
f6dab0d0ff Fix crush installer to use UnifiedInstaller
- Replace individual generators with UnifiedInstaller class
- Use NamingStyle.FLAT_COLON and TemplateType.CODEX
- Remove manual counting logic, use counts from UnifiedInstaller
- Keep cleanup() and installCustomAgentLauncher() as-is
2026-01-25 03:56:40 -06:00
Brian Madison
cf6cf779bb Fix auggie installer to use UnifiedInstaller with flat files
- Replace individual generators with UnifiedInstaller class
- Remove nested folder structure (.augment/commands/bmad/agents/, etc.)
- Now installs flat files to .augment/commands/ (e.g., bmad_bmm_agent_pm.md)
- Use NamingStyle.FLAT_COLON and TemplateType.AUGMENT
- Remove createTaskCommand, createToolCommand, createWorkflowCommand methods
- Simplify cleanup() and update installCustomAgentLauncher() for flat structure
2026-01-25 03:56:40 -06:00
Brian Madison
7074395bdd claude cline codex installers use central function 2026-01-25 03:56:40 -06:00
Alex Verkhovsky
9b8ce69f37 fix(quick-spec): reorder final menu to D-B-A-P-R (#1402)
Group "go-on" options first (Done, Begin Dev), then reasoning options
(Advanced Elicitation, Party Mode, Adversarial Review).

Follows established pattern: most common action first, related options grouped.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-24 23:57:08 -06:00
Alex Verkhovsky
79959e75ac fix(quick-flow): standardize menu shortcuts for intuitive UX (#1401)
* fix(quick-spec): change menu shortcuts to avoid Approve/Advanced confusion

Users were typing 'a' expecting to Approve (since it starts with A) but
triggering Advanced Elicitation instead. Changed shortcuts to:
- [C] Continue (was [Y] Approve)
- [E] Edit (was [C] Changes)

This keeps [A] for Advanced Elicitation consistent with other workflows.

Fixes user-reported UX issue with confusing menu shortcuts.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(quick-dev): standardize menu shortcuts to use intuitive letters

- Change [T] to [P] for "Plan first" (P matches the label)
- Change [1][2][3] to [W][F][S] for findings resolution:
  - [W] Walk through
  - [F] Fix automatically
  - [S] Skip

Consistent with letter-based menu pattern used elsewhere.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-24 21:15:01 -06:00
Alex Verkhovsky
8bdf21f65b doc: standardize quick-flow menu patterns to newer format (#1388)
Update quick-spec and quick-dev workflow menus to match established standards:
- Uppercase all menu option letters ([A], [P], [C], [T], [E], [W], etc.)
- Add "Menu Handling Logic:" sections with IF/THEN structure
- Add "EXECUTION RULES:" sections with halt/wait behavior
- Add chat handling for checkpoint menus (A/P/C)
- Remove code blocks from Display patterns, use standard format
- Add header for adversarial review process block

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-24 12:17:28 -06:00
Murat K Ozcan
7d63dcd6a0 docs: fix td leftover (#1394) 2026-01-24 12:16:44 -06:00
forcetrainer
999ece33a9 Interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts (#1396)
* Add interactive workflow guide page

Replace confusing static SVG workflow diagram with an interactive
guide at /workflow-guide. Users select their track (Quick Flow,
BMad Method, Enterprise) and see relevant phases, agents, commands,
and outputs. Update link validator to recognize custom page routes.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add visual dev loop indicator to workflow guide

Wrap create-story, dev-story, and code-review in a dashed border
group with a "Repeat for each story" label to clearly communicate
the iterative development cycle in Phase 4.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Simplify workflow guide to vertical slash command flow

Replace expandable phase cards with a clean vertical flow showing
slash commands as the primary element, with down arrows between
steps, agent badges, required/optional status, and concise
descriptions. Add prominent /bmad-help callout and note that
agent loading is optional.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Simplify README Quick Start with numbered command flows

Replace wordy paragraphs and track table with two clear numbered
paths (Quick Flow: 3 commands, BMad Method: 6 steps) and a
prominent /bmad-help callout as the primary guidance mechanism.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add Party Mode to README, /bmad-help to getting-started

Add Party Mode bullet to Why BMad section, note about agent-based
usage as an alternative to direct workflows, and a /bmad-help
mention in the getting-started tutorial after installation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add link to getting-started tutorial in README Quick Start

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add workflow guide link to docs index New Here section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Update README tagline and format modules table

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix workflow-guide links to use relative paths

The /workflow-guide absolute path breaks with non-root base paths.
Use relative paths since workflow-guide is a custom Astro page
outside the docs collection. Docs-to-docs links keep the /docs/
pattern which the rehype plugin handles.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Revert workflow-guide links to absolute paths

Use /workflow-guide to match the /docs/ convention used throughout.
Works correctly on the production site where base path is /.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-24 12:16:20 -06:00
Alex Verkhovsky
baf2b9daef chore: update package-lock.json and fix markdownlint ignore pattern (#1375)
- Security fixes for transitive dependencies (lodash, etc.)
- npm peer metadata additions
- Fix markdownlint to ignore all node_modules, not just root

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-24 00:25:49 -06:00
Alex Verkhovsky
9abd6654f1 feat: add optional style_guide input to editorial review tasks (#1380)
When provided, the style_guide input overrides all generic principles
(including Microsoft Style Guide baseline, reader-type priorities, and
structure-model selection) except CONTENT IS SACROSANCT.

Changes to both editorial-review-structure.xml and editorial-review-prose.xml:
- Add style_guide input after content input
- Add STYLE GUIDE OVERRIDE instruction in llm section
- Add "Consult style_guide" action in Step 3 for mid-flow refresh

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-24 00:24:54 -06:00
forcetrainer
4346f0bcf3 Remove previous/next article footer navigation from docs site (#1385)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-24 00:24:13 -06:00
Brian Madison
431b961451 Update agent command file naming to include -agent- in filename
- Change agent command files from bmad_module_name to bmad_module_agent_name
- Update path-utils.js to insert 'agent' segment in agent file names
- Update CSV files to reflect new underscore naming convention
- Refactor toUnderscorePath to use toUnderscoreName for consistency
- Update parseUnderscoreName to handle new agent naming pattern

Examples:
- bmm/agents/pm.md → bmad_bmm_agent_pm.md (was bmad_bmm_pm.md)
- cis/agents/brainstorming.md → bmad_cis_agent_brainstorming.md
- Core agents: bmad_agent_name.md
2026-01-23 22:30:14 -06:00
Alex Verkhovsky
def8da0acb refactor: replace 'execute' with 'Read fully and follow:' in workflow prompts (#1387)
Replace ambiguous "execute" terminology with explicit "Read fully and follow:"
phrasing across all workflow files to prevent LLM goal-seeking behavior where
models attempt to "achieve the end result" rather than following step-by-step
instructions verbatim.

Changes:
- Update 5 handler templates with canonical phrasing
- Replace ~150 INSTRUCTIONAL patterns across 87 workflow files
- Add "[Workflow] complete." prefix to 7 workflow endpoints
- Preserve BEHAVIORAL/STRUCTURAL patterns (agent descriptions, XML tags)
- Fix gitignore and markdownlint to ignore all node_modules directories

Closes #1372

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-23 22:25:19 -06:00
Murat K Ozcan
48881f86a6 doc: test design refinements (#1382) 2026-01-23 13:00:48 -06:00
Brian Madison
efbe839a0a installer cleanup 2026-01-23 00:27:26 -06:00
Brian Madison
3f9ad4868c versioned module downloads and manifest 2026-01-23 00:27:26 -06:00
Alex Verkhovsky
aad132c9b1 feat: add optional also_consider input to adversarial review task (#1371)
Add an optional also_consider parameter that allows callers to pass
domain-specific areas to keep in mind during review. This gently nudges
the reviewer toward specific concerns without overriding normal analysis.

Testing showed:
- Specific items steer strongly (questions get directly answered)
- Domain-focused items shift the lens (e.g., security focus = deeper security findings)
- Vague items have minimal effect (similar to baseline)
- Single items nudge without dominating
- Contradictory items handled gracefully

Includes test cases with sample content and 10 configurations to validate
the parameter behavior across different use cases.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-22 22:26:25 -06:00
Brian Madison
c9f2dc51db docs: update README with proper welcome and GitHub links 2026-01-22 21:34:08 -06:00
Murat K Ozcan
6eb7c34752 docs: update test-design workflow to generate two documents for system-level mode (#1367)
* docs: update test-design workflow to generate two documents for system-level mode

* addressed pr comments
2026-01-22 14:29:33 -06:00
Brian Madison
9b9f43fcb9 fix: reorder mergeModuleHelpCatalogs after generateManifests
The mergeModuleHelpCatalogs function depends on agent-manifest.csv
being populated, but was being called before generateManifests.
This caused new modules' agent info to be empty in the help catalog.

Fixes issue where game-dev-studio workflows weren't appearing
in bmad-help.csv and IDE commands weren't being generated.
2026-01-22 00:39:00 -06:00
Brian Madison
77a53a20ed Update module-help.csv format
Refine format documentation and phase ordering guidance
2026-01-22 00:04:32 -06:00
Brian Madison
5d89298fe8 brainstorming docs now go to /brainstorming folder instead of /analysis 2026-01-21 23:18:38 -06:00
Brian Madison
421a811e87 added diagrams to module help 2026-01-21 21:16:44 -06:00
Brian Madison
c9c3d31d3a add the phase four items to the workflow csv for bmm. compile all csv to a install file. improve the bmad-help to know how to work with the csv that contains the workflows from all installed modules 2026-01-21 20:47:43 -06:00
Brian Madison
ec8ab0c638 workflow tracking evolved to bmad-help 2026-01-21 14:05:57 -06:00
Brian Madison
aae7923d5d standardize installer flat command list with naming convention standardization to make workflow update 2026-01-21 12:22:32 -06:00
Brian Madison
3734607994 workflow drastic simplification and more reliable 2026-01-20 01:12:20 -06:00
Brian Madison
e29a1273e1 remove legacy workflow manager 2026-01-19 21:52:04 -06:00
Alex Verkhovsky
01bbe2a3ef fix: add sprint-status.yaml sync to correct-course workflow (#1358)
The correct-course workflow restructures epics but did not update
sprint-status.yaml, leaving tracking out of sync. Added check-item 6.4
to Section 6 (after user approval) to update sprint-status.yaml when
epics are added, removed, renumbered, or stories are modified.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 11:09:10 -06:00
Brian Madison
73135bee8e gitignore ide installs settings and removed gamedev doc reference 2026-01-19 02:18:14 -06:00
Brian Madison
6f8f0871cf Project Cleanup of Agents Menus, BMB module removal to other repo 2026-01-19 02:04:14 -06:00
Brian Madison
14bfa5b224 bmad builder removed to new repo 2026-01-18 20:44:57 -06:00
Brian Madison
83641eee9d improve all install prompts 2026-01-18 17:27:50 -06:00
Brian Madison
a96ea2f19a project licence, contribution and discord noise updates, along with improved simplified issue templates 2026-01-18 17:03:47 -06:00
Brian Madison
28e6dded4d installation for remote modules now indicates its getching or installing so it does not appear to be hung when caching the remote in the local npm cache 2026-01-18 08:11:35 -06:00
Brian Madison
966ca5db0b indicator when external modules are being downloaded during install so installer does not appear to be frozen / unresponsive. 2026-01-18 02:16:25 -06:00
forcetrainer
e0318d9da8 feat: update website header with new BMAD Method branding (#1352)
* docs: apply style guide to TEA Lite quickstart

- Remove duplicate H1 header (frontmatter provides title)
- Remove horizontal rules throughout
- Convert Prerequisites to admonition
- Add Quick Path TL;DR admonition
- Convert Key Takeaway to tip admonition
- Convert TEA Workflows list to Quick Reference table
- Convert Troubleshooting to Common Questions FAQ format
- Rename Need Help to Getting Help section
- Remove redundant Feedback section

Also adds missing @clack/prompts dependency from upstream merge.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: spell out acronyms in TEA Lite quickstart

- MCP → Model Context Protocol
- E2E → End-to-end (also fix missing article)
- CI/CD → Continuous integration/continuous deployment
- ATDD → Acceptance Test-Driven Development
- TDD → Test-Driven Development
- NFR → non-functional requirements
- Remove inaccurate CRUD reference

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: spell out TDD in ATDD link text

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: update branding with new wordmark logo and banner

- Add banner image to README header
- Replace website logo with wordmark, hiding title text
- Left-align logo with sidebar by reducing header padding

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: update README banner to new design with waveform

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: add banner to docs website welcome page

- Revert README to original banner
- Add waveform banner to docs site welcome page

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: use waveform banner as website header logo

- Remove banner from welcome page content
- Update header logo to use banner-bmad-method2.png

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: add separate logo for dark mode

Use banner-bmad-method-dark.png in dark mode for better blending

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: update header logos for light and dark modes

- Light mode: bmad-light.png (dark blue background with lightning)
- Dark mode: bmad-dark.png (light background variant)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore: clean up unused banner images and add readme2

- Remove unused banner-bmad-method2.png and bmad-wordmark.png
- Add readme2.md with upcoming features section
- Update banner-bmad-method-dark.png

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore: remove unused banner image variants

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: finalize header logo graphics

- Rename bmad-light2.png to bmad-light.png as final version
- Remove readme2.md draft

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-18 00:25:12 -06:00
MarkRadaba
4a983d64a7 chore: add .github/agents to gitignore (#1353)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-17 23:35:08 -06:00
Murat K Ozcan
f25fcc686c fix: web bundler entry point (#1341)
* fix: web bundler entry point

* removed the web-bundles folder

* added web-bundles to gitignore

* disabled web bundles

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-17 16:30:59 -06:00
forcetrainer
411cded4d0 docs: apply style guide to TEA Lite quickstart (#1342)
* docs: apply style guide to TEA Lite quickstart

- Remove duplicate H1 header (frontmatter provides title)
- Remove horizontal rules throughout
- Convert Prerequisites to admonition
- Add Quick Path TL;DR admonition
- Convert Key Takeaway to tip admonition
- Convert TEA Workflows list to Quick Reference table
- Convert Troubleshooting to Common Questions FAQ format
- Rename Need Help to Getting Help section
- Remove redundant Feedback section

Also adds missing @clack/prompts dependency from upstream merge.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: spell out acronyms in TEA Lite quickstart

- MCP → Model Context Protocol
- E2E → End-to-end (also fix missing article)
- CI/CD → Continuous integration/continuous deployment
- ATDD → Acceptance Test-Driven Development
- TDD → Test-Driven Development
- NFR → non-functional requirements
- Remove inaccurate CRUD reference

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: spell out TDD in ATDD link text

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Murat K Ozcan <34237651+muratkeremozcan@users.noreply.github.com>
2026-01-17 16:17:18 -06:00
Brian Madison
a50d82df1c remove subagent installation option from CC and antigravity - subagents install have been replaced with the better subprocess request / task agents to allow for more ideas to use the tool they have available to generate needed subagent functionality on the fly. 2026-01-17 02:16:46 -06:00
Brian Madison
d022e569bd remove gamedev and cis docs 2026-01-17 02:03:48 -06:00
Brian Madison
7990ad528c minor doc updates related to cis removal from repo 2026-01-17 01:33:12 -06:00
Murat K Ozcan
5881790068 Merge pull request #1345 from jheyworth/fix-todomvc-url
Fix TodoMVC example URL to include /dist/ path
2026-01-16 11:31:45 -06:00
jheyworth
d83a88da66 Fix remaining TodoMVC URL references in documentation
Updated 2 additional files to use the correct /dist/ path:
- docs/how-to/workflows/run-automate.md: Standalone mode example
- docs/reference/tea/configuration.md: Playwright BASE_URL example

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-16 12:09:19 +00:00
jheyworth
7b68d1a326 Fix TodoMVC example URL to include /dist/ path
Updated all references to TodoMVC URL from https://todomvc.com/examples/react/
to https://todomvc.com/examples/react/dist/ for correct working example.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-16 11:12:20 +00:00
Brian Madison
7cd4926adb project-root stutter fix 2026-01-15 23:03:02 -06:00
Brian Madison
0fa53ad144 removing docs accidentally added to wrong repo docs folder 2026-01-15 22:30:43 -06:00
Brian Madison
afee68ca99 temp disable WDS from installer to first resolve some module issues 2026-01-15 22:20:56 -06:00
Brian Madison
b952d28fb3 Modify installation now will remove modules that get unselected, with an option to confirm the deletion 2026-01-15 22:20:56 -06:00
Brian Madison
577c1aa218 remove modules moved to new repos and update installer to support the remote module isntallation and updates. this is a temporary imlemtation machanism 2026-01-15 22:20:56 -06:00
Murat K Ozcan
abba7ee987 docs: removed enterprise folder (#1340) 2026-01-15 19:32:55 -06:00
Murat K Ozcan
d34efa2695 docs: fixed tea sidebar links (#1338)
* docs: fixed tea sidebar links

* fix: removed the additional label
2026-01-15 19:25:21 -06:00
Murat K Ozcan
87b1292e3f docs: named TEA links consistently (#1337) 2026-01-15 18:01:37 -06:00
Murat K Ozcan
43f7eee29a docs: fix docs build (#1336)
* docs: fix docs build

* docs: conditional pre-commit

* fix: included more LLM exclude patterns

* fix: iclude docs:build

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-15 16:44:14 -06:00
Alex Verkhovsky
96f21be73e docs: optimize style guide for LLM readers (#1321)
* docs: optimize style guide for LLM readers

Restructure documentation style guide with dependency-first ordering
and LLM-optimized content based on editorial-review-structure analysis.

Key changes:
- Add Universal Formatting Rules section at top (consolidated anti-patterns)
- Move Visual Hierarchy and formatting rules before document types
- Add Document Types decision table for type selection
- Move Before/After example to follow Visual Hierarchy
- Merge Links/Images into single Assets table
- Move tutorial-specific checklist into Tutorial Structure section
- Move Validation Steps to end (submission workflow)
- Cut abstract Quick Principles (no execution value for LLMs)
- Remove emotional/orientation language throughout
- Condense FAQ Sections structure

Result: ~35% reduction (539 deletions, 383 insertions) with improved
parseability for AI agents writing documentation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: clarify explanation checklist admonition limit

Disambiguate 2-3 admonitions max to explicitly show it is a per-document
limit that still respects the universal per-section rule.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: clarify header budget vs structure template relationship

Add note explaining that structure templates show content flow, not 1:1
header mapping. Admonitions and inline elements are within sections.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: remove horizontal rules to follow own guidelines

Remove all --- section separators to comply with Universal Formatting
Rules. The ## headers provide sufficient visual separation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: address PR review findings for style guide

- Fix forward reference in Header Budget section
- Clarify descriptions rule scope (tables and 5+ item lists)
- Restore realistic FAQ examples
- Add qualifier to admonition content length guideline

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: further optimize style guide as delta-only document

- Add opener declaring adherence to Google Style Guide and Diataxis
- Remove generic Google style guide sections (Visual Hierarchy patterns,
  Tables constraints, Code Blocks, Lists, Assets)
- Remove Diataxis explainer content (Document Types table, "X documents
  do Y" explanatory sentences, Before/After example)
- Keep all project-specific structure templates and checklists
- Consolidate rules into single Project-Specific Rules table

Result: 367 lines (down from 597), pure delta document assuming
LLM training knowledge of baseline standards.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-15 16:41:57 -06:00
Murat K Ozcan
66e7d3a36d docs: tea in 4; Diátaxis (#1320)
* docs: tea in 4; Diátaxis

* docs: addressed review comments

* docs: refined the docs
2026-01-15 13:18:37 -06:00
Brian Madison
2b7f7ff421 minor updates to installer multiselects 2026-01-14 23:48:50 -06:00
Brian Madison
3360666c2a remove hard inclusion of AV from installer, to replace with module soon 2026-01-14 23:04:19 -06:00
Nwokoma Chukwuma U.
274dea16fa Fix YAML indentation in kilo.js customInstructions field (#1291)
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-14 21:26:10 -06:00
Kevin Heidt
dcd581c84a Fix glob pattern to use forward slashes (#1241)
Normalize source directory path for glob pattern compatibility.

Reviewed-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
2026-01-14 21:16:23 -06:00
Murat K Ozcan
6d84a60a78 docs: tea entry points and resume tip (#1246)
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-14 21:13:48 -06:00
Eduard Voiculescu
59e1b7067c remove remember the users name is {user_name}, it is already present in the activation-steps.txt (#1315) 2026-01-14 21:04:43 -06:00
sjennings
1d8df63ac5 feat(bmgd): Add E2E testing methodology and scaffold workflow (#1322)
* feat(bmgd): Add E2E testing methodology and scaffold workflow

- Add comprehensive e2e-testing.md knowledge fragment
- Add e2e-scaffold workflow for infrastructure generation
- Update qa-index.csv with e2e-testing fragment reference
- Update game-qa.agent.yaml with ES trigger
- Update test-design and automate instructions with E2E guidance
- Update unity-testing.md with E2E section reference

* fix(bmgd): improve E2E testing infrastructure robustness

- Add WaitForValueApprox overloads for float/double comparisons
- Fix assembly definition to use precompiledReferences for test runners
- Fix CaptureOnFailure to yield before screenshot capture (main thread)
- Add error handling to test file cleanup with try/catch
- Fix ClickButton to use FindObjectsByType and check scene.isLoaded
- Add engine-specific output paths (Unity/Unreal/Godot) to workflow
- Fix knowledge_fragments paths to use correct relative paths

* feat(bmgd): add E2E testing support for Godot and Unreal

Godot:
- Add C# testing with xUnit/NSubstitute alongside GDScript GUT
- Add E2E infrastructure: GameE2ETestFixture, ScenarioBuilder,
  InputSimulator, AsyncAssert (all GDScript)
- Add example E2E tests and quick checklist

Unreal:
- Add E2E infrastructure extending AFunctionalTest
- Add GameE2ETestBase, ScenarioBuilder, InputSimulator classes
- Add AsyncTestHelpers with latent commands and macros
- Add example E2E tests for combat and turn cycle
- Add CLI commands for running E2E tests

---------

Co-authored-by: Scott Jennings <scott.jennings+CIGINT@cloudimperiumgames.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-14 20:53:40 -06:00
VJSai
993d02b8b3 Enhance security policy documentation (#1312)
Expanded the security policy to include supported versions, reporting guidelines, response timelines, security scope, and best practices for users.

Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
2026-01-14 16:27:52 -06:00
Davor Racic
5cb5606ba3 fix(cli): replace inquirer with @clack/prompts for Windows compatibility (#1316)
* fix(cli): replace inquirer with @clack/prompts for Windows compatibility

- Add new prompts.js wrapper around @clack/prompts to fix Windows arrow
  key navigation issues (libuv #852)
- Fix validation logic in github-copilot.js that always returned true
- Add support for primitive choice values (string/number) in select/multiselect
- Add 'when' property support for conditional questions in prompt()
- Update all IDE installers to use new prompts module

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): address code review feedback for prompts migration

- Move @clack/prompts from devDependencies to dependencies (critical)
- Remove unused inquirer dependency
- Fix potential crash in multiselect when initialValues is undefined
- Add async validator detection with explicit error message
- Extract validateCustomContentPathSync method in ui.js
- Extract promptInstallLocation methods in claude-code.js and antigravity.js
- Fix moduleId -> missing.id in installer.js remove flow
- Update multiselect to support native clack API (options/initialValues)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore: update comments to reference @clack/prompts instead of inquirer

- Update bmad-cli.js comment about CLI prompts
- Update config-collector.js JSDoc comments
- Rename inquirer variable to choiceUtils in ui.js
- Update JSDoc returns and calls documentation

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): add spacing between prompts and installation progress

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): add multiselect usage hints for inexperienced users

Add inline navigation hints to all multiselect prompts showing
(↑/↓ navigate, SPACE select, ENTER confirm) to help users
unfamiliar with terminal multiselect controls.

Also restore detailed warning when no tools are selected,
explaining that SPACE must be pressed to select items.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(cli): restore IDE grouping using groupMultiselect

Replace flat multiselect with native @clack/prompts groupMultiselect
component to restore visual grouping of IDE/tool options:
- "Previously Configured" - pre-selected IDEs from existing install
- "Recommended Tools" - starred preferred options
- "Additional Tools" - other available options

This restores the grouped UX that was lost during the Inquirer.js
to @clack/prompts migration.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-14 16:25:35 -06:00
Murat K Ozcan
eeebf152af docs: tea editorial review (#1313)
* docs: tea editorial review

* fix: addressed nit pick
2026-01-13 02:27:25 +08:00
Alex Verkhovsky
d419ac8a70 feat: add editorial review tasks for structure and prose (#1307)
* feat: add editorial review tasks for structure and prose

Add two complementary editorial review tasks:

- editorial-review-structure.xml: Structural editor that proposes cuts,
  reorganization, and simplification. Includes 5 document archetype models
  (Tutorial, Reference, Explanation, Prompt, Strategic) for targeted evaluation.

- editorial-review-prose.xml: Clinical copy-editor for prose improvements
  using Microsoft Writing Style Guide as baseline.

Both tasks support humans and llm target audiences with different principles.

* fix: add content-sacrosanct guardrail to editorial review tasks

Both editorial review tasks (prose and structure) were missing the key
constraint that reviewers should never challenge the ideas/knowledge
themselves—only how clearly they are communicated. This restores the
original design intent.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: align reader_type parameter naming across editorial tasks

Prose task was using 'target_audience' for the humans/llm optimization
flag while structure task correctly separates 'target_audience' (who
reads) from 'reader_type' (optimization mode). Aligns to reader_type.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-13 00:20:04 +08:00
Murat K Ozcan
568249e985 Merge pull request #1309 from forcetrainer/main
docs: comprehensive documentation overhaul with style guide expansion
2026-01-12 06:04:45 -06:00
forcetrainer
c0f6401902 docs: add token usage FAQ and fix broken links
- Add "Why does BMad use so many tokens?" FAQ explaining design tradeoff
  (decision quality over code velocity)
- Fix stale anchor #adversarial-review-general → #adversarial-review
- Remove link to archived customize-workflows.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-12 00:31:54 -05:00
forcetrainer
e535f94325 docs: comprehensive style guide update with reference and glossary standards
Style Guide Additions:
- Add Reference Structure section with 6 document types (Index, Catalog,
  Deep-Dive, Configuration, Glossary, Comprehensive)
- Add Glossary Structure section with table-based format leveraging
  Starlight's right-nav for navigation
- Include checklists for both new document types

Reference Docs Updated:
- agents/index.md: Catalog format, universal commands tip admonition
- configuration/core-tasks.md: Configuration format with admonitions
- configuration/global-config.md: Table-based config reference
- workflows/index.md: Minimal index format
- workflows/core-workflows.md: Catalog format
- workflows/document-project.md: Deep-dive with Quick Facts admonition
- workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules

Glossary Rewritten:
- Converted from 373 lines with ### headers to 123 lines with tables
- Right nav now shows 9 categories instead of 50+ terms
- Added italic context markers (*BMGD.*, *Brownfield.*, etc.)
- Alphabetized terms within categories
- Removed redundant inline TOC

All Docs:
- Remove horizontal rules (---) per style guide
- Remove "Related" sections (sidebar handles navigation)
- Standardize admonition usage
- Archive deleted workflow customization docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-12 00:23:05 -05:00
forcetrainer
e465ce4bb5 docs: fix year typo in README (2025 -> 2026)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-11 12:01:37 -05:00
forcetrainer
9d328082eb Merge upstream/main 2026-01-11 11:46:30 -05:00
Alex Verkhovsky
d4f6642333 fix: add missing review menu and HALT to quick-spec step 4 (#1305)
Step 4 was missing a structured menu at the spec review checkpoint.
This caused agents to skip past the approval step without waiting for
explicit user confirmation.

Added:
- Review menu with [y] Approve, [c] Changes, [q] Questions, [a] Advanced Elicitation, [p] Party Mode
- Explicit HALT instruction
- Menu handling section

This aligns step 4 with the menu-driven pattern used in steps 1-3.

Fixes #1304

Also fixes pre-existing prettier issue in src/modules/cis/module.yaml.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-11 17:04:52 +08:00
forcetrainer
9f85dade25 docs: capitalize support section descriptions
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-11 00:28:29 -05:00
forcetrainer
5870651bad docs: enhance README free/open source messaging and support section
- Expand tagline: "No gated Discord", "empowering everyone"
- Add emojis and stronger CTAs to Support section
- Consolidate star/subscribe asks into Support section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-11 00:24:58 -05:00
forcetrainer
eff826eef9 docs: add open source philosophy and support options to README
- Add "100% free and open source" tagline at top
- Update YouTube line with upcoming master class/podcast
- Add "Help us grow" CTA for stars and subs
- Add new "Support BMad" section with donation and speaking info

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-11 00:18:34 -05:00
Brian Madison
0a3cc1d12c release: bump to v6.0.0-alpha.23 2026-01-11 13:16:49 +08:00
Brian
c3b7e98241 Workflow Creator and Validator Tools with Sub Process Support and PRD Validation Step now available!
* critical file issues in prd refactor resolved caught using the BMB workflow validator!!
* subprocess optimization and path violation checks in the workflow validator, along with fixes to the BMM PRD workflow
* standardize workflow and PRD step markdown formatting
- Improve consistency across workflow validation steps
- Standardize PRD innovation step structure
* Workflow Validation Max Parallel Mode POC
* prd trimodal compliant
* correct PRD completion suggested next steps
2026-01-11 11:13:38 +08:00
Murat K Ozcan
2f98f9130a docs: add TEA design philosophy callout and context engineering glossary entry (#1303) 2026-01-11 09:23:25 +08:00
Alex Verkhovsky
c18904d674 refactor: rename create-tech-spec to quick-spec for QuickFlow branding (#1290) 2026-01-10 11:33:00 +08:00
Murat K Ozcan
3e3c92ed3e docs: expand TEA documentation with cheat sheets, MCP enhancements, a… (#1289)
* docs: expand TEA documentation with cheat sheets, MCP enhancements, and API testing patterns

* docs: update TEA fragment counts and fix playwright-utils code examples

* docs: addressed PR review concerns

* docs: update TEA MCP configuration link to point to documentation site
2026-01-10 02:55:57 +08:00
forcetrainer
12d3492e0c Add link auditor, reorganize documentation, and README update (#1277)
* feat: add link auditor tools and fix broken docs links

- Add audit-doc-links.js to scan docs for broken links with auto-resolution
- Add fix-doc-links.js to apply suggested fixes (dry-run by default)
- Remove stale "Back to Core Concepts" breadcrumb links
- Update BMad acronym to "Breakthrough Method of Agile AI Driven Development"
- Update README links to docs.bmad-method.org
- Simplify upgrade callout in getting-started tutorial

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: reorganize docs structure and archive v4 tutorial

- Remove unused section index files (tutorials, how-to, explanation, reference)
- Move getting-started-bmadv4.md to _archive
- Update quick-start-bmgd.md to remove archived file reference
- Update upgrade-to-v6.md
- Update astro.config.mjs for new structure

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: ignore underscore directories in link checker

Update check-doc-links.js to skip _archive, _planning, and other
underscore-prefixed directories when validating links.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: add v4 users section to README

Add links to v4 documentation archive and upgrade guide for users
migrating from previous versions.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: convert docs to site-relative links and add validation tools

- Convert all relative links (./  ../) to site-relative paths (/path/)
- Strip .md extensions and use trailing slashes for Astro/Starlight
- Add fix-doc-links.js to convert relative links to site-relative
- Add validate-doc-links.js to check links point to existing files
- Remove old audit-doc-links.js and check-doc-links.js
- Update build-docs.js to use new validation script
- Add npm scripts: docs:fix-links, docs:validate-links
- Update style guide with validation steps

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: standardize acronym to BMad across documentation

Replace incorrect "BMAD" with correct "BMad" in text and frontmatter
while preserving "BMAD-METHOD" in GitHub URLs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: fix BMad acronym and remove draft README

- Correct acronym to "Breakthrough Method of Agile AI Driven Development"
- Remove unused README-draft.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: standardize BMad acronym in README

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: standardize FAQ format across all FAQ pages

- Add TOC with jump links under "## Questions"
- Use ### headers for questions (no Q: prefix)
- Direct answers without **A:** prefix
- Remove horizontal rules and "Related Documentation" sections
- End each FAQ with issue/Discord CTA
- Update style guide with new FAQ guidelines
- Delete redundant faq/index.md (sidebar handles navigation)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: use repo-relative links with .md for GitHub compatibility

Convert all documentation links to repo-relative format (/docs/path/file.md)
so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix
and converts .md to trailing slash at build time for Astro/Starlight.

- Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths
- Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension
- Convert 217 links across 64 files to new format

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: handle /docs/ prefix in link validator

Update resolveLink to strip /docs/ prefix from repo-relative links
before checking if files exist.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: restore FAQ index page

Re-add the FAQ index page that was accidentally deleted, with
updated repo-relative link format.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
2026-01-10 02:55:33 +08:00
Phil
677a00280b feat: refactor Cursor IDE setup to do command generation and cleanup instead of rules (#1283)
* feat: refactor Cursor IDE setup to do  command generation and cleanup instead of rules

- Added support for command generation in the Cursor IDE setup, including the creation of a new commands directory.
- Implemented cleanup for old BMAD commands alongside existing rules.
- Integrated TaskToolCommandGenerator for generating task and tool commands.
- Updated logging to reflect the number of agents, tasks, tools, and workflow commands generated during setup.

* style: adjust constructor formatting and update command path in Cursor IDE setup

- Reformatted the constructor method for consistency.
- Updated the command path syntax in the Cursor IDE setup to use a more standard format.

* fix: update Cursor command paths in documentation

- Changed the command path for Cursor IDE setup from `.cursor/rules/bmad/` to `.cursor/commands/bmad/` in both installers.md and modules.md.
- Updated file extension references to use `.md` instead of `.mdc` for consistency.
2026-01-09 16:39:32 +08:00
Q00
d19cca79d2 fix: resolve ERR_REQUIRE_ESM by using dynamic import for inquirer (#1278)
Inquirer v9+ is ESM-only, causing ERR_REQUIRE_ESM when loaded via
require() in CommonJS. Convert all require('inquirer') calls to
dynamic import('inquirer') across 8 CLI files.

Fixes #1197
2026-01-08 15:42:22 +08:00
Alex Verkhovsky
8e165b9b57 chore: enable CodeRabbit auto-review on new PRs (#1276) 2026-01-08 07:59:30 +08:00
Alex Verkhovsky
67b70288a6 docs: update README links to new documentation site (#1274) 2026-01-08 07:58:53 +08:00
Brian Madison
5c76657732 Add CNAME file 2026-01-07 18:18:12 +08:00
Brian Madison
7bf05c9d9d fix missing scripts from installation, and add ability to exclude workflows from being added as commands in tools, the first being the example workflow meant just for workflow example to the workflow builder 2026-01-07 16:21:25 +08:00
Alex Verkhovsky
692f14f2e7 docs: add how-to guide for getting BMAD answers + fix Discord channels (#1265)
* docs: add how-to guide for getting BMAD answers + fix Discord channels

- New guide: docs/how-to/get-answers-about-bmad.md
  Teaches users to point LLMs at BMAD sources for self-serve answers

- Fixed outdated Discord channel references across 8 files:
  #general-dev → #bmad-development
  #bugs-issues → #report-bugs-and-issues
  Added #suggestions-feedback and #bmad-method-help where appropriate

* docs: add Mayakovsky-style poem to how-to guide
2026-01-07 16:05:05 +08:00
Alex Verkhovsky
2e16650067 feat(docs): Diataxis restructure + Astro/Starlight migration (#1263)
* feat(docs): add Diataxis folder structure and update sidebar styling

- Create tutorials, how-to, explanation, reference directories with subdirectories
- Add index.md files for each main Diataxis section
- Update homepage with Diataxis card navigation layout
- Implement clean React Native-inspired sidebar styling
- Convert sidebar to autogenerated for both Diataxis and legacy sections
- Update docusaurus config with dark mode default and navbar changes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): migrate Phase 1 files to Diataxis structure

Move 21 files to new locations:
- Tutorials: quick-start guides, agent creation guide
- How-To: installation, customization, workflows
- Explanation: core concepts, features, game-dev, builder
- Reference: merged glossary from BMM and BMGD

Also:
- Copy images to new locations
- Update internal links via migration script (73 links updated)
- Build verified successfully

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(docs): add category labels for sidebar folders

Add _category_.json files to control display labels and position
for autogenerated sidebar categories.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style(docs): improve welcome page and visual styling

- Rewrite index.md with React Native-inspired welcoming layout
- Add Diataxis section cards with descriptions
- Remove sidebar separator, add spacing instead
- Increase navbar padding with responsive breakpoints
- Add rounded admonitions without left border bar
- Use system font stack for better readability
- Add lighter chevron styling in sidebar
- Constrain max-width to 1600px for wide viewports

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: use baseUrl in meta tag paths for correct deployment URLs

* feat(docs): complete Phase 2 - split files and fix broken links

Phase 2 of Diataxis migration:
- Split 16 large legacy files into 42+ focused documents
- Created FAQ section with 7 topic-specific files
- Created brownfield how-to guides (3 files)
- Created workflow how-to guides (15+ files)
- Created architecture explanation files (3 files)
- Created TEA/testing explanation files
- Moved remaining legacy module files to proper Diataxis locations

Link fixes:
- Fixed ~50 broken internal links across documentation
- Updated relative paths for new file locations
- Created missing index files for installation, advanced tutorials
- Simplified TOC anchors to fix Docusaurus warnings

Cleanup:
- Removed legacy sidebar entries for deleted folders
- Deleted duplicate and empty placeholder files
- Moved workflow diagram assets to tutorials/images

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(build): use file glob instead of sidebar parsing for llms-full.txt

Replace brittle sidebar.js regex parsing with recursive file glob.
The old approach captured non-file strings like 'autogenerated' and
category labels, resulting in only 5 files being processed.

Now correctly processes all 86+ markdown files (~95k tokens).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(seo): use absolute URLs in AI meta tags for agent discoverability

AI web-browsing agents couldn't follow relative paths in meta tags due to
URL security restrictions. Changed llms-full.txt and llms.txt meta tag
URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): recategorize misplaced files per Diataxis analysis

Phase 2.5 categorization fixes based on post-migration analysis:

Moved to correct Diataxis categories:
- tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md)
- tutorials/brownfield-onboarding.md → how-to/brownfield/index.md
- reference/faq/* (8 files) → explanation/faq/
- reference/agents/barry-quick-flow.md → explanation/agents/
- reference/agents/bmgd-agents.md → explanation/game-dev/agents.md

Created:
- explanation/agents/index.md

Fixed all broken internal links (14 total)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add Getting Started tutorial and simplify build script

- Add comprehensive Getting Started tutorial with installation as Step 1
- Simplify build-docs.js to read directly from docs/ (no consolidation)
- Remove backup/restore dance that could corrupt docs folder on build failure
- Remove ~150 lines of unused consolidation code

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(css): use fixed width layout to prevent content shifting

Apply React Native docs approach: set both width and max-width at
largest breakpoint (1400px) so content area maintains consistent
size regardless of content length. Switches to fluid 100% below
1416px breakpoint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): restructure tutorials with renamed entry point

- Rename index.md to bmad-tutorial.md for clearer navigation
- Remove redundant tutorials/index.md
- Update sidebar and config references

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add tutorial style guide and AI agent announcement bar

- Add docs/_contributing/ with tutorial style guide
- Reformat quick-start-bmm.md and bmad-tutorial.md per style guide
- Remove horizontal separators, add strategic admonitions
- Add persistent announcement bar for AI agents directing to llms-full.txt
- Fix footer broken link to tutorials

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add markdown demo page and UI refinements

- Add comprehensive markdown-demo.md for style testing
- Remove doc category links from navbar (use sidebar instead)
- Remove card buttons from welcome page
- Add dark mode styling for announcement bar
- Clean up index.md card layout

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): apply unified tutorial style and update references

- Reformat create-custom-agent.md to follow tutorial style guide
- Update tutorial-style.md with complete unified structure
- Update all internal references to renamed tutorial files
- Remove obsolete advanced/index.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): migrate from Docusaurus to Astro+Starlight

Replace Docusaurus with Astro and the Starlight documentation theme
for improved performance, better customization, and modern tooling.

Build pipeline changes:
- New build-docs.js orchestrates link checking, artifact generation,
  and Astro build in sequence
- Add check-doc-links.js for validating internal links and anchors
- Generate llms.txt and llms-full.txt for LLM-friendly documentation
- Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip)
- Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build
- Output directly to build/site for cleaner deployment

Website architecture:
- Add rehype-markdown-links.js plugin to transform .md links to routes
- Add site-url.js helper for GitHub Pages URL resolution with strict
  validation (throws on invalid GITHUB_REPOSITORY format)
- Custom Astro components: Banner, Header, MobileMenuFooter
- Symlink docs/ into website/src/content/docs for Starlight

Documentation cleanup:
- Remove Docusaurus _category_.json files (Starlight uses frontmatter)
- Convert all docs to use YAML frontmatter with title field
- Move downloads.md from website/src/pages to docs/
- Consolidate style guide and workflow diagram docs
- Add 404.md and tutorials/index.md

---------

Co-authored-by: forcetrainer <bryan@inagaki.us>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-07 14:42:15 +08:00
dependabot[bot]
dc7a7f8c43 Bump qs from 6.14.0 to 6.14.1 (#1244)
Bumps [qs](https://github.com/ljharb/qs) from 6.14.0 to 6.14.1.
- [Changelog](https://github.com/ljharb/qs/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ljharb/qs/compare/v6.14.0...v6.14.1)

---
updated-dependencies:
- dependency-name: qs
  dependency-version: 6.14.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-07 11:21:14 +08:00
Brian Madison
987410eb75 workflows doc addition 2026-01-07 10:29:50 +08:00
Brian Madison
f838486caa agent and workflow doc 2026-01-07 10:29:50 +08:00
Davor Racic
51aa3dda2f fix: brainstorming (#1251)
* fix(brainstorming): extend ideation phase with 100+ idea goal

Add emphasis on quantity-first approach to unlock better quality ideas.
Introduce energy checkpoints, multiple continuation options, and clearer
success metrics to keep users in generative exploration mode longer.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(brainstorming): improve exploration menus and fix workflow paths

- Change menu options from numbers [1-4] to letters [K/T/A/B/C] for clearer navigation
- Fix workflow references from .yaml to .md across agents and patterns
- Add universal facilitation rules emphasizing 100+ idea quantity goal
- Update exploration menu with Keep/Try/Advanced/Break/Continue options

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(brainstorming): implement research-backed procedural rigor

Phase 4 achievements:
- Added Anti-Bias Protocol (Every 10 ideas domain pivot)
- Added Chain-of-Thought requirements (Reasoning before generation)
- Implemented Simulated Temperature prompts for higher divergence
- Standardized Idea Format Template for quality control
- Fixed undefined Advanced Elicitation variables
- Synchronized documentation with new [K, T, A, P, C] pattern

* fix(brainstorming): align ideation goals and fix broken workflow paths

- Standardized quantity goals to 100+ ideas across all brainstorming steps
- Fixed broken .yaml references pointing to renamed .md workflow files
- Aligned documentation summaries with mandatory IDEA FORMAT TEMPLATE
- Cleaned up misplaced mindset/goal sections in core workflow file
- Fixed spelling and inconsistencies in facilitation rules

* Fix ambiguous variable names in brainstorming ideation step

* fix(brainstorming): enforce quality growth alongside quantity

* fix: correct dependency format and add missing frontmatter variable

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-07 09:09:03 +08:00
Brian Madison
35ae4fd024 quadrivariate module workflow 2026-01-03 17:12:00 +08:00
Brian Madison
f31659765e trimodal viarate workflow creation 2026-01-03 17:12:00 +08:00
forcetrainer
d1f3844449 Docusaurus build fix - Sidebar and missing image issues (#1243)
* fix(docs): align sidebar with actual docs structure and fix image path

Sidebar referenced non-existent paths (modules/bmm/, getting-started/, etc.)
while actual docs live in different locations (modules/bmm-bmad-method/,
bmad-core-concepts/, etc.). Updated sidebar to match reality so Docusaurus
can build successfully.

Also fixed broken image reference in workflows-guide.md that used an
incorrect relative path.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(docs): update build script to include docs/modules directory

The build script was excluding the modules folder when copying from docs/,
but module docs now live in docs/modules/ instead of src/modules/*/docs/.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(docs): correct broken internal links

Fixed relative paths that were pointing to non-existent locations:
- bmgd index: ../../bmm/docs/index.md → ../bmm/index.md
- cis index: ../../bmm/docs/index.md → ../bmm/index.md
- bmm faq: ./README.md → GitHub URL

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-03 17:09:42 +08:00
Alex Verkhovsky
05ddc2d29b fix(dev): allow full project-context usage with conflict precedence (#1220) 2026-01-03 09:14:09 +08:00
Brian Madison
c748f0f6cc paths for workflow and sprint tatus files fixed 2026-01-01 21:20:14 +08:00
Andaman Lekawat
4142972b6a fix: standardize variable naming from {project_root} to {project-root} (#1217)
Fixed inconsistent variable naming in workflow instruction files across
CIS, BMGD, and BMM modules. The standard variable format uses hyphens
({project-root}) not underscores ({project_root}).

Affected files:
- CIS: problem-solving, innovation-strategy, design-thinking, storytelling
- BMGD: brainstorm-game, narrative, create-story checklist
- BMM: excalidraw diagrams, create-story checklist

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-01 21:14:21 +08:00
Murat K Ozcan
cd45d22eb6 docs: chose your tea engagement (#1228)
* docs: chose your tea engagement

* docs: addressed PR comments

* docs: made refiements to the mermaid diagram

* docs: wired in test architect discoverability nudges

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2026-01-01 19:06:55 +08:00
Nick Pirocanac
a297235862 fix: *code-review is picking up non-application files (#1232)
Co-authored-by: Nick Pirocanac <nick.pirocanac@rtktickets.com>
2026-01-01 13:22:51 +08:00
Brian Madison
d8b13bdb2e agents all indicate hasSidecar true or false, validation requires it, agent builder and validator and editor use the field. Added a better brownfield doc 2025-12-31 21:30:19 +08:00
lkrysik
8699d7d968 Mixed line endings (Windows CRLF problem) (#1222)
Co-authored-by: lukasz.krysik <lukasz.krysik@effem.com>
2025-12-31 14:44:53 +08:00
Brian Madison
8b92e5ee59 Release 6.0.0-alpha.22
Major features:
- Unified Agent Workflow: Create/Edit/Validate consolidated into single workflow
- Agent Knowledge System: Comprehensive data file architecture for agent building
- Deep Language Integration: All sharded workflows support language choice
- Core Module Documentation: New docs for brainstorming, party mode, advanced elicitation
- BMAD Core Concepts: New documentation structure for agents, workflows, modules
- Create-Tech-Spec Sharded: Converted to sharded format with orient-first pattern

466 files changed, 12,983 insertions(+), 12,047 deletions(-)
2025-12-31 03:06:16 +08:00
Brian Madison
9f53d896b7 agent-workflow create edit validate consolidation 2025-12-31 02:58:03 +08:00
Brian Madison
b46409e71d agent create workflow overhaul to use data files efficiently. updated and created separate user guides for the create agent workflow along with general concept docs of what an agent and workflow are in regards to0 bmad generally. 2025-12-30 22:44:38 +08:00
Brian Madison
8cffd09fb7 agent build intel complete 2025-12-30 17:46:29 +08:00
Brian Madison
2b89ee1302 agent build data optimized 2025-12-30 14:19:00 +08:00
Brian Madison
b72c810a1f bmb agent knowledge streamline in progress 2025-12-30 12:34:54 +08:00
Brian Madison
484990de50 all sharded progressive workflows integrate language choice deeply with each step biased towards configured language. Tested with Spanish and Pirate Speak, worked really well. 2025-12-29 19:35:20 +08:00
Brian Madison
b8836ced24 another inquirer default addition missed, maybe this will fix windows issues also 2025-12-29 15:56:00 +08:00
Brian Madison
c7fcf16eae fix install for alpha instruction in the readme 2025-12-29 15:45:38 +08:00
Brian Madison
529d4a8c95 doc fixes 2025-12-29 09:36:54 +08:00
Brian Madison
f0520c39d9 fix wording in create-epics-and-stories doc discovery continuation 2025-12-29 09:25:56 +08:00
Brian Madison
ff0517f4d0 workflow-status phase paths corrected with current reality 2025-12-29 09:25:56 +08:00
Luke Finch
b509fb9a1e bump version to 6.0.0-alpha.21 and enhance stdin handling for Windows in CLI (#1200) 2025-12-28 22:09:22 +08:00
Brian Madison
e0090e5602 more docs migrations 2025-12-28 21:13:44 +08:00
Brian Madison
8d679b177b advanced elicitation moved to workflows folder. core module extensive documentation added. 2025-12-28 19:44:55 +08:00
Brian Madison
ea421adbf9 create and edit workflow minor fixes 2025-12-27 21:35:39 +08:00
Brian Madison
2a8a4388a9 v4 detection cleanup 2025-12-27 20:31:12 +08:00
Brian Madison
d4a94df29a doc cleanup round 1 2025-12-27 18:29:35 +08:00
Brian Madison
949cf64d3b workflow status, init and phase 4 items aligned with planning_artifacts and implementation_artifacts for discovery and output 2025-12-27 10:59:44 +08:00
Brian Madison
aba9d11c88 quick flow updates to aid discovery and implementation 2025-12-27 10:40:23 +08:00
Alex Verkhovsky
208f27dcdb refactor: convert create-tech-spec to sharded workflow with orient-first pattern (#1185)
* refactor: convert create-tech-spec to sharded workflow with orient-first pattern

* docs: reposition deep exploration isolation guideline within universal code investigation section

* docs: Update terminology from 'Requirement Delta' to 'Problem Statement' in step-02-investigate.md context.

* Update src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-04-review.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-01-understand.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-27 09:43:59 +08:00
Brian Madison
c15ad174ed chore: bump version to 6.0.0-alpha.21
Major improvements:
- All agents now use consistent 2-letter menu codes (compound triggers)
- Phase 1-3 workflows updated to use planning_artifacts folder
- Windows installer fixed with inquirer multiselection resolution
- Chat and party mode auto-injected into all agents
- All agents pass comprehensive validation checks
- Restored agent files from Docusaurus merge
2025-12-26 20:55:10 +08:00
Brian Madison
24cedea690 phase 3 input disco and output updated 2025-12-26 20:44:45 +08:00
Brian Madison
bdb6bde9b5 disco and output fix for ux design 2025-12-26 20:18:31 +08:00
Brian Madison
cfdffe3f7a prd and brief workflows disco and output fixed 2025-12-26 20:05:02 +08:00
Brian Madison
7b5b7afdc0 update package.json to resolve windows installer issue with inquirer version 2025-12-26 18:05:59 +08:00
Brian Madison
59a0eec2e2 all agents passing new validation checks 2025-12-26 17:34:20 +08:00
Brian Madison
1f16bb7413 agent renormalized, and all now have chat and party mode auto injectioned 2025-12-26 12:00:37 +08:00
Alex Verkhovsky
b1d1242fcf fix: restore agent files accidentally modified in Docusaurus merge (#1191)
* fix: restore agent files accidentally modified in Docusaurus merge

Restores 25 agent files to their pre-merge state:
- Trigger format with shortcuts (WS, CH, BP, etc.) restored
- Fuzzy matching syntax restored
- BMB module: restores separate agent-builder, module-builder,
  workflow-builder agents; removes consolidated bmad-builder

Also updates test to match restored trigger format.

Note: Schema validation needs update in follow-up commit.

* fix: normalize trigger fuzzy match format for schema validation

- Add dashes to fuzzy match text to match kebab-case triggers
- Add missing 'chat' kebab in CH triggers (CH or chat or fuzzy match on chat)
- Relax schema to allow 1-3 char shortcuts and skip shortcut derivation check
- Remove compound-wrong-shortcut test fixture (no longer validated)

All 24 agent files now pass schema validation.
2025-12-26 06:59:39 +08:00
Brian Madison
47a0ebda4f chore: bump version to 6.0.0-alpha.20
Major improvements:
- Path segregation implementation across 90+ workflow files
- Windows installer fixed with inquirer v9.x upgrade
- Custom installation messages via install-messages.yaml
- Two-version auto upgrade with config preservation
- Quick-dev workflow refactor with adversarial review
- Doc site auto-generation on merge
- Streamlined personas and cleaned up documentation
2025-12-23 23:17:36 +08:00
Murat K Ozcan
1a1a806d99 docs: remove old links in test architect (#1183)
* docs: remove dead links in  test architecture documentation

* docs: updated test architecture documentation for clarity and consistenc

* docs: update test architecture documentation for clarity and consistency

* docs: addressed PR comments
2025-12-23 23:09:08 +08:00
Alex Verkhovsky
19df17b261 feat: add documentation website with Docusaurus build pipeline (#1177)
* feat: add documentation website with Docusaurus build pipeline

* feat(docs): add AI discovery meta tags for llms.txt files

- Add global headTags with ai-terms, llms, llms-full meta tags
- Update landing page link to clarify AI context purpose

* fix(docs): restore accidentally deleted faq.md and glossary.md

Files were removed in 12dd97fe during path restructuring.

* fix(docs): update broken project-readme links to GitHub URL

* feat(schema): add compound trigger format validation
2025-12-23 23:01:36 +08:00
Brian Madison
925b715d4f prettier no longer should screw up md files underscores 2025-12-23 22:29:51 +08:00
Brian Madison
e4a4f47a1e remove unnecessary \ before _ and disable md auto fix 2025-12-23 22:21:59 +08:00
Brian Madison
4195eb3b30 installation intro and outtro custom messages, configurable in install-messages.yaml 2025-12-23 21:43:29 +08:00
Brian Madison
c0f5d33c61 core module always asks its questions (no accept defaults 2025-12-23 20:52:06 +08:00
Brian Madison
3f76c2de74 ensure config vars are retained in a quick update 2025-12-23 20:17:32 +08:00
Brian Madison
45ff3840a8 2 version auto upgrade only 2025-12-23 20:05:17 +08:00
Alex Verkhovsky
dcaa892ce1 refactor(bmm): convert quick-dev workflow to sharded format with adversarial review (#1182)
convert quick-dev workflow to sharded format with adversarial review
2025-12-23 17:48:47 +08:00
Brian Madison
00a380a03f remove unused commands that need to be replaced 2025-12-23 17:32:53 +08:00
Brian Madison
12dd97fe9b start implementing new bm paths into phases 1-4 2025-12-23 11:40:38 +08:00
Brian Madison
00ad756acf remove unneeded folder 2025-12-22 19:44:15 +08:00
Brian Madison
021936eaa9 update inquirer to v9.x for better windows support 2025-12-22 18:18:16 +08:00
Brian Madison
da21790531 quickinstall duplicate success message removed 2025-12-22 14:17:32 +08:00
Brian Madison
34cfdddd3a refac tools part 1 2025-12-22 13:12:25 +08:00
Brian Madison
1e721f7fd0 consolidate and remove some duplication 2025-12-22 10:13:56 +08:00
Brian Madison
9c268f8190 remove asterix insertion into agent files 2025-12-22 08:18:53 +08:00
sjennings
e59c7b79ed fix(bmgd): correct workflow-status filename and add sprint-planning update (#1172)
* fix(bmgd): add workflow status update to game-architecture completion

The game-architecture workflow was not updating the bmgd-workflow-status.yaml
file on completion, unlike other BMGD workflows (narrative, brainstorm-game).

Changes:
- Add step 4 "Update Workflow Status" to update create-architecture status
- Renumber subsequent steps (5-8 → 6-9)
- Add success metric for workflow status update
- Add failure condition for missing status update

* feat(bmgd): add generate-project-context workflow for game development

Adds a new workflow to create optimized project-context.md files for AI agent
consistency in game development projects.

New workflow files:
- workflow.md: Main workflow entry point
- project-context-template.md: Template for context file
- steps/step-01-discover.md: Context discovery & initialization
- steps/step-02-generate.md: Rules generation with A/P/C menus
- steps/step-03-complete.md: Finalization & optimization

Integration:
- Added generate-project-context trigger to game-architect agent menu
- Added project context creation option to game-architecture completion step
- Renumbered steps 6-9 → 7-10 to accommodate new step 6

Adapted from BMM generate-project-context with game-specific:
- Engine patterns (Unity, Unreal, Godot)
- Performance and frame budget rules
- Platform-specific requirements
- Game testing patterns

* fix(bmgd): correct workflow-status filename and add sprint-planning update

- Fix all BMGD workflows to reference bmgd-workflow-status.yaml instead of bmm-workflow-status.yaml
- Add workflow-status update to sprint-planning workflow completion

Affected workflows:
- brainstorm-game (instructions.md, step-01-init.md, step-04-complete.md)
- game-brief (instructions.md)
- narrative (instructions-narrative.md, step-11-complete.md)
- game-architecture (instructions.md)
- sprint-planning (instructions.md)

---------

Co-authored-by: Scott Jennings <scott.jennings+CIGINT@cloudimperiumgames.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-21 09:30:17 +08:00
Brian Madison
a20198b94b workflow step location fixed in create product brief 2025-12-20 16:39:43 +08:00
Serhii
4271fe5f2b fix(bmm): resolve dead references and syntax errors in agents and workflows (#1164)
- Fix XML syntax error in dev-story/instructions.xml:20 (goto element)
- Fix path typo in tech-writer.agent.yaml (_bmadbmm → _bmad/bmm)
- Fix wrong route in analyst.agent.yaml (edit-agent → party-mode)
- Comment out unimplemented validate-create-story in sm.agent.yaml
- Comment out unimplemented validate-design in ux-designer.agent.yaml
- Remove misleading validate-create-story reference in create-story output

Fixes #1075
Related to #1163

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-20 13:37:09 +08:00
Alex Verkhovsky
b276d5a387 refactor: streamline quick-flow-solo-dev persona for clarity and accuracy (#1167)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-20 13:33:55 +08:00
Alex Verkhovsky
7b762fe211 fix: sync package-lock.json with package.json version (#1168) 2025-12-20 13:31:54 +08:00
sjennings
e39aa33eea fix(bmgd): add workflow status update to game-architecture completion (#1161)
* fix(bmgd): add workflow status update to game-architecture completion

The game-architecture workflow was not updating the bmgd-workflow-status.yaml
file on completion, unlike other BMGD workflows (narrative, brainstorm-game).

Changes:
- Add step 4 "Update Workflow Status" to update create-architecture status
- Renumber subsequent steps (5-8 → 6-9)
- Add success metric for workflow status update
- Add failure condition for missing status update

* feat(bmgd): add generate-project-context workflow for game development

Adds a new workflow to create optimized project-context.md files for AI agent
consistency in game development projects.

New workflow files:
- workflow.md: Main workflow entry point
- project-context-template.md: Template for context file
- steps/step-01-discover.md: Context discovery & initialization
- steps/step-02-generate.md: Rules generation with A/P/C menus
- steps/step-03-complete.md: Finalization & optimization

Integration:
- Added generate-project-context trigger to game-architect agent menu
- Added project context creation option to game-architecture completion step
- Renumbered steps 6-9 → 7-10 to accommodate new step 6

Adapted from BMM generate-project-context with game-specific:
- Engine patterns (Unity, Unreal, Godot)
- Performance and frame budget rules
- Platform-specific requirements
- Game testing patterns

---------

Co-authored-by: Scott Jennings <scott.jennings+CIGINT@cloudimperiumgames.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-18 16:14:18 +08:00
Alex Verkhovsky
2da9aebaa8 docs: add DigitalOcean sponsor attribution (#1162) 2025-12-18 15:58:54 +08:00
Brian Madison
5c756b6404 chore: bump version to 6.0.0-alpha.19
Bug fix:
- Fixed _bmad folder stutter with agent custom files
- Removed unnecessary backup file causing installer bloat
- Improved path handling for agent customizations
2025-12-18 12:52:10 +08:00
Brian Madison
23f650ff4d fixed _bmad folder stutter with agent custom files 2025-12-18 03:22:46 +08:00
Brian Madison
363915b0c6 chore: bump version to 6.0.0-alpha.18
Major improvements:
- BMGD module complete overhaul with professional game development workflows
- New Game QA (GLaDOS) and Game Solo Dev (Indie) agents
- 15 comprehensive testing guides for all major game engines
- Agent recompile feature for quick updates without full reinstall
- Full agent customization support - ALL fields now customizable
- Enhanced custom module installation and management
- Complete BMGD documentation suite with 9 guides
2025-12-17 18:07:41 +08:00
Brian Madison
f36369512b fixed issue with agent customization application, now all fields are customized form the custom yaml. also added a recompile agents menu item 2025-12-17 17:58:37 +08:00
sjennings
ccb64623bc feat(bmgd): comprehensive BMGD module upgrade (#1151)
* feat(bmgd): comprehensive BMGD module upgrade

## New Agents
- **Game QA (GLaDOS)**: Game QA Architect + Test Automation Specialist
  - Engine-specific testing (Unity, Unreal, Godot)
  - Knowledge base with 15+ testing topics
  - Workflows: test-framework, test-design, automate, playtest-plan, performance-test, test-review

- **Game Solo Dev (Indie)**: Elite Indie Game Developer + Quick Flow Specialist
  - Rapid prototyping and iteration focused
  - Quick-flow workflows for solo/small team development

## Production Workflow Alignment
Aligned BMGD 4-production workflows with BMM 4-implementation:

### Removed Obsolete Workflows
- story-done (merged into dev-story)
- story-ready (merged into create-story)
- story-context (merged into create-story)
- epic-tech-context (no longer separate workflow)

### Added Workflows
- sprint-status: View sprint progress, surface risks, recommend next action

### Updated Workflows (now standalone, copied from BMM)
- code-review: Adversarial review with instructions.xml
- correct-course: Sprint change management
- create-story: Direct ready-for-dev marking
- dev-story: TDD implementation with instructions.xml
- retrospective: Epic completion review
- sprint-planning: Sprint status generation

## Game Testing Architecture (gametest/)
New knowledge base for game-specific testing:
- qa-index.csv: Knowledge fragment index
- 15 knowledge files covering:
  - Engine-specific: Unity, Unreal, Godot testing
  - Game-specific: Playtesting, balance, save systems, multiplayer
  - Platform: Certification (TRC/XR), localization, input
  - General QA: Automation, performance, regression, smoke tests

## Quick-Flow Workflows (bmgd-quick-flow/)
- quick-prototype: Rapid mechanic testing
- quick-dev: Flexible feature implementation

## Documentation
Complete documentation suite in docs/:
- README.md: Documentation index
- quick-start.md: Getting started guide
- agents-guide.md: All 6 agents reference
- workflows-guide.md: Complete workflow reference
- quick-flow-guide.md: Rapid development guide
- game-types-guide.md: 24 game type templates
- glossary.md: Game dev terminology
- troubleshooting.md: Common issues

## Teams & Installer
- Updated team-gamedev.yaml with all 6 agents and workflows
- Updated default-party.csv with Game QA and Game Solo Dev
- Created _module-installer/ with:
  - installer.js: Creates directories, logs engine selection
  - platform-specifics/: Claude Code and Windsurf handlers

## Agent Updates
All agents now reference standalone BMGD workflows:
- game-architect: correct-course → BMGD
- game-dev: dev-story, code-review → BMGD
- game-scrum-master: All production workflows → BMGD
- game-solo-dev: code-review → BMGD

## Module Configuration
- Added sprint_artifacts alias for workflow compatibility
- All workflows use bmgd/config.yaml

* fix(bmgd): update sprint-status workflow to reference bmgd instead of bmm

Replace all /bmad:bmm:workflows references with /bmad:bmgd:workflows
in the sprint-status workflow instructions.

* feat(bmgd): add workflow-status and create-tech-spec workflows

Add BMGD-native workflow-status and create-tech-spec workflows,
replacing all BMM references with BMGD paths.

## New Workflows

### workflow-status
- Multi-mode status checker for game projects
- Game-specific project levels (Game Jam → AAA)
- Workflow paths: gamedev-greenfield, gamedev-brownfield,
  quickflow-greenfield, quickflow-brownfield
- Init workflow for new game project setup

### create-tech-spec
- Game-focused spec engineering workflow
- Engine-aware (Unity/Unreal/Godot)
- Performance and gameplay feel considerations

## Agent Updates
Updated all BMGD agents to reference BMGD workflows:
- game-architect, game-designer, game-dev, game-qa,
  game-scrum-master, game-solo-dev

All agents now use /bmad:bmgd:workflows instead of /bmad:bmm:workflows

* fix(bmgd): address PR review findings and enhance playtesting docs

## PR Review Fixes (F1-F20)

### Configuration & Naming
- F1: Changed user_skill_level to game_dev_experience in module.yaml
- F3: Renamed gametest/framework to gametest/test-framework

### Cleanup
- F2: Deleted 4 orphaned root-level template files
- F6: Removed duplicate code block in create-story/instructions.xml
- F9: Removed trailing empty line from qa-index.csv
- F20: Deleted orphaned docs/unnamed.jpg

### Installer Improvements
- F7: Simplified platform handler stubs (removed unused code)
- F8: Added return value checking for platform handlers
- F13: Added path traversal validation (isWithinProjectRoot)
- F18: Added type validation for config string values

### Agent Fixes
- F10: Added workflow-status and advanced-elicitation to game-solo-dev
- F12: Fixed "GOTO step 2a" → "GOTO step 2" references
- F14: Removed duplicate project-context.md from principles in 5 agents

### Workflow Updates
- F17: Added input_file_patterns to playtest-plan workflow

### Documentation
- F4-F5: Updated quick-start.md with 6 agents and fixed table
- Updated workflows-guide.md with test-framework reference

### Knowledge Base Updates (from earlier CodeRabbit comments)
- Updated unity-testing.md to Test Framework 1.6.0
- Fixed unreal-testing.md (MarkAsGarbage, UnrealEditor.exe)
- Added FVerifyPlayerMoved note to smoke-testing.md
- Fixed certification-testing.md table formatting

### Playtesting Documentation Enhancement
- Added "Playtesting by Game Type" section (7 genres)
- Added "Processing Feedback Effectively" section
- Expanded from ~138 to ~340 lines

* refactor(bmgd): use exec for step-file workflows and multi format

Update agent menu items to use correct notation for step-file workflows:

**game-designer.agent.yaml:**
- Convert 4 step-file workflows to multi format with shortcodes:
  - [BG] brainstorm-game
  - [GB] create-game-brief
  - [GDD] create-gdd
  - [ND] narrative
- Changed from workflow: .yaml to exec: .md

**game-architect.agent.yaml:**
- Changed create-architecture from workflow: to exec: with workflow.md

---------

Co-authored-by: Scott Jennings <scott.jennings+CIGINT@cloudimperiumgames.com>
2025-12-17 14:33:22 +08:00
Brian Madison
e37edf098c modify install now supports adding custom modules even if there were no custom modules originally 2025-12-16 20:45:27 +08:00
Brian Madison
e3eb374218 chore: bump version to 6.0.0-alpha.17 with comprehensive changelog
Major improvements include:
- Revolutionary installer overhaul with unified flow for core and custom modules
- Full custom content support re-enabled with streamlined sharing
- Critical migration from .bmad to _bmad for AI visibility
- Agent memory system rollout with _bmad/_memory location
- Quick default selection for faster module installation
- BMM Phase 4 workflow improvements and standardization
- Sample modules demonstrating custom content creation
- Future-ready architecture for content segregation
2025-12-16 18:25:50 +08:00
Brian Madison
83b0df0f21 .17 changelog and link to changelog in installer output 2025-12-16 18:23:15 +08:00
Alex Verkhovsky
00a3af3eb0 fix(bmm): sprint-status workflow improvements (#1141)
* fix(bmm): sprint-status workflow improvements

- Remove dead by_epic template block and context_status variable (#1116, #1117)
- Define "first" story ordering as epic number then story number (#1119)
- Clarify retrospective check: "any retrospective status == optional" (#1120)
- Strengthen validate mode: check required metadata fields and valid statuses (#1121)
- Expand risk detection: stale file, orphaned stories, empty epics (#1122)
- Fix retrospective valid status: use "done" instead of "completed" for consistency

Fixes #1116, fixes #1117, fixes #1119, fixes #1120, fixes #1121, fixes #1122

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(bmm): address CodeRabbit review feedback

- Improve retrospective status descriptions for clarity
- Fix empty epic detection to only warn on in-progress epics
- Add 'generated' to required metadata field validation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-16 17:59:42 +08:00
Brian Madison
d0e0a0963a examples of custom modules, custom module and readme doc updates 2025-12-16 17:45:41 +08:00
Brian Madison
32615afaf9 memory location is non configurable _bmad/_memory for sidecar content 2025-12-16 15:43:38 +08:00
Brian Madison
59e4cc7b82 minor code cleanup 2025-12-16 13:09:20 +08:00
Brian Madison
c24821b6ed menu wording updates 2025-12-16 01:25:49 +08:00
Brian Madison
2c4c2d9717 reduce installer log output 2025-12-15 23:53:26 +08:00
Brian Madison
901b39de9a fixed duplicate entry in files manfest issue 2025-12-15 20:47:21 +08:00
Brian Madison
4d8d1f84f7 quick update works and retains custom content also 2025-12-15 19:54:40 +08:00
Brian Madison
48795d46de core and custom modules all install through the same flow now 2025-12-15 19:16:03 +08:00
Brian Madison
bbda7171bd quick update output modified 2025-12-15 17:30:12 +08:00
Brian Madison
08f05cf9a4 update menu updated 2025-12-15 16:25:01 +08:00
Brian Madison
c7827bf031 less verbose final output during install 2025-12-15 15:55:28 +08:00
Brian Madison
5716282898 roo installer had some bugs 2025-12-15 15:08:19 +08:00
Brian Madison
60238d2854 default accepted for installer quesitons 2025-12-15 12:55:57 +08:00
Brian Madison
6513c77d1b single install panel, no clearing disjointed between modules 2025-12-15 11:54:37 +08:00
Brian Madison
3cbe330b8e improved ui for initial install question intake 2025-12-15 11:33:01 +08:00
Brian Madison
ecc2901649 remove header display before tool selection 2025-12-15 11:05:27 +08:00
Brian Madison
d4eccf07cf reorganize order of questions to make more logical sense 2025-12-15 10:59:15 +08:00
Brian Madison
1da7705821 folder workflow naming alignment for consistency 2025-12-15 10:17:58 +08:00
Brian Madison
7f742d4af6 custom modules install after any non custom modules selected and after the core, manifest tracks custom modules separately to ensure always installed from the custom cache 2025-12-15 09:14:16 +08:00
Alex Verkhovsky
9fe79882b2 fix(release): restore automated release workflow for v6 (#1139)
* fix(release): update workflow to sync package-lock.json

- Call 'npm version' directly with --no-git-tag-version flag to ensure
  both package.json and package-lock.json are updated together
- Add 'alpha' option (default) for alpha version bumps
- Add 'beta' option to transition to/bump beta series
- Temporarily disable web bundles (tools/cli/bundlers/ is missing)

The workflow was previously calling non-existent npm scripts
(version:patch/minor/major) that were removed in the v6 refactor.

Note: This change cannot be fully tested without triggering an actual
release. The web bundles functionality requires a separate fix.

Fixes #1104

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(release): simplify version bump logic

Modern npm (v11+) correctly handles --preid flag transitions:
- prerelease --preid=beta on alpha.X produces beta.0 (works!)
- prerelease --preid=alpha on alpha.X produces alpha.X+1 (works!)

CodeRabbit warning was based on outdated npm behavior.
Consolidate alpha|beta into single case for cleaner code.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-15 07:34:04 +08:00
Alex Verkhovsky
ebb20f675f chore(discord): suppress link embeds and handle truncated URLs (#1126)
* chore(discord): suppress link embeds and handle truncated URLs

- Add wrap_urls() to wrap URLs in <> to suppress Discord embeds
- Add strip_trailing_url() to remove partial URLs from truncated text
- Update all 6 workflow jobs with body text to use the new helpers
- Partial URLs (from truncation) are removed since they are unusable
- Complete URLs are wrapped to prevent large embed previews

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(discord): preserve URLs when escaping markdown

- Replace sed-based esc() with awk version that skips content inside
  <URL> wrappers, preventing URL corruption from backslash escaping
- Reorder pipeline: wrap_urls | esc (wrap first, then escape)
- Update comment: "partial" → "incomplete" for clarity

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-15 07:19:44 +08:00
Alex Verkhovsky
82cc10824a fix(bmm): improve sprint-status validation and epic status handling (#1125)
* fix(bmm): improve sprint-status validation and epic status handling

- Add status validation with interactive correction for unknown values
- Update epic statuses to match state machine: backlog, in-progress, done
- Map legacy "contexted" status to "in-progress" explicitly
- Add retrospective status counting (optional, completed)
- Rewrite risk detection rules for LLM clarity
- Fix warnings vs risks naming inconsistency in data mode

Closes #1106
Closes #1118

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style: fix prettier formatting in sprint-status instructions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-15 07:17:30 +08:00
Brian Madison
4c65f3a006 quick install fixed 2025-12-13 23:45:47 +08:00
Brian Madison
401e8e481c a few minor agent workflow main file cleanup actions 2025-12-13 23:04:54 +08:00
Brian Madison
cba7cf223f standardize custom agent workflow and module output, and improve module folder selection 2025-12-13 22:59:58 +08:00
Brian Madison
add789a408 remove unused code 2025-12-13 19:53:03 +08:00
Brian Madison
ae9851acab _cfg -> _config 2025-12-13 19:41:09 +08:00
Brian Madison
ac5fa5c23f agent customization now gets allied on quick update and compile agents 2025-12-13 19:23:02 +08:00
Brian Madison
8642553bd7 we only need one yaml lib 2025-12-13 18:35:07 +08:00
Brian Madison
ce42d56fdd agent customzation almost working again 2025-12-13 17:50:33 +08:00
Brian Madison
25c79e3fe5 folder rename from .bmad to _bmad 2025-12-13 16:22:34 +08:00
Brian Madison
0c873638ab remove dead and unused functionality - the web bundler will be replaced 2025-12-13 14:08:14 +08:00
Brian Madison
e6f911d791 remove dead and unused functionality - the web bundler will be replaced 2025-12-13 14:06:35 +08:00
Alex Verkhovsky
f11be2b2e2 chore: disable CodeRabbit walkthrough (#1115)
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-13 13:34:41 +08:00
Murat K Ozcan
572074d2a6 Merge pull request #1109 from alexeyv/fix/normalize-dev-story-trigger
fix(bmm): normalize dev-story trigger naming
2025-12-12 12:45:14 -06:00
Murat K Ozcan
0ed546619f Merge branch 'main' into fix/normalize-dev-story-trigger 2025-12-12 12:44:12 -06:00
Murat K Ozcan
c3b54c5fc6 Merge pull request #1108 from alexeyv/fix/normalize-status-kebab-case
fix(bmm): normalize story status references to lowercase kebab-case
2025-12-12 12:44:03 -06:00
Murat K Ozcan
e34f53d6f8 Merge branch 'main' into fix/normalize-status-kebab-case 2025-12-12 12:42:49 -06:00
Murat K Ozcan
ebbb44f961 Merge pull request #1107 from alexeyv/fix/remove-drafted-status-bmm
fix(bmm): remove stale 'drafted' story state from docs and workflows
2025-12-12 12:42:35 -06:00
Alex Verkhovsky
76185937c6 fix(bmm): normalize dev-story trigger naming
Rename 'develop-story' to 'dev-story' across agent triggers and documentation
to match the actual workflow folder and YAML configuration naming.

- Update dev.agent.yaml trigger from develop-story to dev-story
- Update game-dev.agent.yaml trigger from develop-story to dev-story
- Update 7 references in agents-guide.md documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-11 23:48:00 -07:00
Alex Verkhovsky
7a9f1d4a3c fix(bmm): normalize story status references to lowercase kebab-case
Updated status references to use canonical lowercase kebab-case format:

- dev-story/instructions.xml: Status field set to "review" (was "Ready for Review")
- dev-story/instructions.xml: Output messages reference actual "review" status
- dev-story/checklist.md: Status field instruction uses "review"
- daily-standup.xml: Status examples use "in-progress, review"

Story lifecycle: backlog → ready-for-dev → in-progress → review → done

Fixes #1105

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-11 23:22:05 -07:00
Alex Verkhovsky
7d6aae1b78 fix(bmm): remove stale 'drafted' story state from docs and workflows
The `drafted` story state is no longer used since create-story now sets
status directly to `ready-for-dev`. This PR removes all references to
this legacy state from BMM documentation and workflow files.

Changes:
- Remove `drafted` from story status definitions and state machine docs
- Remove dead story-context file detection (story-context files no longer exist)
- Replace "draft" verb with "create" in story-related messaging
- Add legacy `drafted` → `ready-for-dev` migration in sprint-status
- Clarify that validate-create-story is optional and doesn't change status
- Document story handoff sequence: create-story → (optional) validate → dev-story

Story lifecycle is now: backlog → ready-for-dev → in-progress → review → done

Closes #1089

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-11 21:20:44 -07:00
Dicky Moore
ed0defbe08 fix: normalize workflow manifest schema (#1071)
* fix: normalize workflow manifest schema

* fix: escape workflow manifest values safely

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-12 07:20:43 +08:00
Kevin Heidt
3bc485d0ed Enhance config collector to support static fields (#1086)
Refactor config collection to handle both interactive and static fields. Update logic to process new static fields and merge answers accordingly.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-12 06:56:31 +08:00
Alex Verkhovsky
0f5a9cf0dd fix: correct grammar in PRD workflow description (#1087) 2025-12-12 06:43:40 +08:00
Alex Verkhovsky
e2d9d35ce9 fix(bmm): improve code review completion message (#1095)
Change "Story is ready for next work!" to "Code review complete!"

The original phrasing was misleading - when a code review finishes
with status "done", it means the review itself is complete and the
story is marked done in tracking. However, the user may choose to
do additional reviews or the story may genuinely be finished.
"Code review complete" more accurately describes what actually
happened without implying next steps.
2025-12-12 06:42:52 +08:00
Alex Verkhovsky
82e6433b69 refactor: standardize file naming to use dashes instead of underscores (#1094)
Rename output/template files and update all references to use kebab-case
(dashes) instead of snake_case (underscores) for consistency:

- project_context.md -> project-context.md (13 references)
- backlog_template.md -> backlog-template.md
- agent_commands.md -> agent-commands.md
- agent_persona.md -> agent-persona.md
- agent_purpose_and_type.md -> agent-purpose-and-type.md
2025-12-12 06:42:24 +08:00
Alex Verkhovsky
be7e07cc1a fix: fully silence CodeRabbit unless explicitly invoked (#1096)
- Disable high_level_summary to stop PR description modifications
- Disable commit_status to stop GitHub status checks
- Disable issue_enrichment.auto_enrich to stop auto-commenting on issues

These settings complement the existing review_status: false and
auto_review.enabled: false to ensure CodeRabbit only responds
when explicitly tagged with @coderabbitai review.
2025-12-12 06:32:24 +08:00
Alex Verkhovsky
079f79aba5 Merge pull request #1103 from bmad-code-org/docs/test-architect-ADR-usage-update-2
docs: test arch ADR usage update
2025-12-11 12:35:12 -07:00
murat
b4d7e1adef docs: addressed further PR comments 2025-12-11 13:13:44 -06:00
murat
6e9fe6c9a2 fix: addressed review comment 2025-12-11 11:36:33 -06:00
Murat K Ozcan
d2d9010a8e Update src/modules/bmm/docs/test-architecture.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-11 10:15:23 -06:00
murat
6d5a1084eb docs: test arch ADR usage update 2 2025-12-11 09:43:25 -06:00
murat
978a93ed33 docs: test arch ADR usage update 2025-12-11 09:34:22 -06:00
Alex Verkhovsky
ec90699016 Merge pull request #1090 from alexeyv/fix/issue-1088-remove-stale-workflow-refs
docs: remove stale references to deleted Phase 4 workflows
2025-12-11 04:38:31 -07:00
Alex Verkhovsky
0f06ef724b Merge branch 'main' into fix/issue-1088-remove-stale-workflow-refs 2025-12-10 16:00:11 -07:00
Brian Madison
26e47562dd Release: 6.0.0-alpha.16
- Update changelog with recent changes
- Version bump to 6.0.0-alpha.16
- Document temporary custom content installation disable
- Document BMB workflow path fixes and package updates
2025-12-10 21:10:57 +09:00
Brian Madison
3256bda42f package updates 2025-12-10 21:04:38 +09:00
Brian Madison
3d2727e190 fix bmb path in step file issues 2025-12-10 20:56:56 +09:00
Brian Madison
446a0359ab fix bmb workflow paths 2025-12-10 20:50:24 +09:00
Brian Madison
45a97b070a disable custom content installation temporarily 2025-12-10 19:11:18 +09:00
Brian Madison
a2d01813f0 temp removal of example modules 2025-12-10 19:05:15 +09:00
Alex Verkhovsky
b9ba98d3f8 docs: remove stale references to deleted Phase 4 workflows
Removes references to epic-tech-context, story-context, story-done,
and story-ready workflows that were deleted in the Phase 4 transformation.

Also renames mislabeled excalidraw element IDs from proc-story-done
to proc-code-review to match the actual displayed text.

Fixes #1088
2025-12-09 21:50:39 -07:00
Murat K Ozcan
5971a88553 Merge pull request #1069 from alexeyv/chore/silence-coderabbit-status
chore: disable CodeRabbit review status comments
2025-12-09 17:10:13 -06:00
Murat K Ozcan
08642a0420 Merge pull request #1084 from alexeyv/fix/issue-1080-product-brief-next-steps
fix: correct markdown formatting in product-brief next steps
2025-12-09 17:09:46 -06:00
Alex Verkhovsky
ec73e44097 fix: correct markdown formatting in product-brief next steps
Fixes #1080
2025-12-09 12:45:56 -07:00
Alex Verkhovsky
d55f518a96 chore: disable CodeRabbit review status comments
Suppress the automatic "Review skipped" comments on PRs.
CodeRabbit can still be invoked on-demand with @coderabbitai review.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-08 14:02:33 -07:00
Alex Verkhovsky
cf50f4935d fix: address code review issues from alpha.14 to alpha.15 (#1068)
* fix: remove debug console.log statements from ui.js

* fix: add error handling and rollback for temp directory cleanup

* fix: use streaming for hash calculation to reduce memory usage

* refactor: hoist CustomHandler require to top of installer.js and ui.js

* fix: fail fast on malformed custom module YAML

User customizations must be valid - silent skip hides broken configs.

* refactor: use consistent return type in handleMissingCustomSources

* refactor: clone config at install() entry to prevent mutation
2025-12-08 13:24:30 -06:00
Brian Madison
55cb4681bc party mode and brainstorming had bmm config instead of core config listed causing loading error when bmm is not an installed module - fixed. 2025-12-08 08:11:39 -06:00
Brian Madison
eb4325fab9 restore bmm as default selected module. 2025-12-08 08:04:39 -06:00
Brian Madison
57ceaf9fa9 conflict marker removed from docs 2025-12-08 08:01:00 -06:00
OhSeungWan
1513b2d478 fix: collect module.yaml prompts for custom modules (#1065)
Custom modules with module.yaml configuration prompts were not being
collected during installation. Added customModulePaths option to
ConfigCollector to resolve custom module paths from selectedFiles
and cachedModules sources.
2025-12-08 07:33:53 -06:00
Brian Madison
2da016f797 chore: bump version to alpha.15
- Module installation standardization with module.yaml
- Enhanced custom content installation with interactive search
- Added CodeRabbit AI and Raven's Verdict integrations
- Documentation improvements and cleanup
- Breaking change: _module-installer/install-config.yaml → module.yaml
2025-12-07 22:16:42 -06:00
Brian Madison
6947851393 module updates 2025-12-07 22:00:52 -06:00
Brian Madison
9d7b09d065 bmad_folder replacement working properly with custom and defauly modules 2025-12-07 21:58:44 -06:00
Brian Madison
86f2786dde remove hardcoded .bmad folders from demo content 2025-12-07 21:41:37 -06:00
Brian Madison
a638f062b9 some debug output when installer errors 2025-12-07 21:03:05 -06:00
Brian Madison
738237b4ae custom install module cached 2025-12-07 20:46:09 -06:00
Brian Madison
6430173738 all modules custom or core use the same installer and have consistent behavior now. 2025-12-07 17:17:50 -06:00
Brian Madison
baaa984a90 almost working installer updates 2025-12-07 15:38:49 -06:00
Brian Madison
38e65abd83 moved code of conduct to github folder, readme links to it 2025-12-07 14:55:44 -06:00
Alex Verkhovsky
ff9a085dd0 feat: add Raven's Verdict PR review tool (#1054)
* feat: add Raven's Verdict PR review tool

* docs: add usage guidance to Raven's Verdict README

* docs: add guidance to skip PRs that shouldn't merge
2025-12-07 14:13:33 -06:00
Brian Madison
d5c687d99d custom content installation guide 2025-12-07 14:11:17 -06:00
Brian Madison
b68e5c0225 add custom content installation question to indicate location of custom content 2025-12-07 13:39:27 -06:00
Alex Verkhovsky
987f81ff64 feat: add CodeRabbit AI code review integration (#1053)
- Add .coderabbit.yaml with minimal config and path instructions
- Exclude node_modules from review scope
- Document pilot research and conclusions in docs/planning/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-07 10:36:24 -06:00
Wendy Smoak
0c2afdd2bb Change Gem creation link to Gemini Gem manager (#1057)
Updated the link for creating a Gem to the Gemini Gem manager.
2025-12-07 10:16:49 -06:00
Brian Madison
a65ff90b44 example-custom-* disabled so installer does not find them when trying to install from npx 2025-12-07 07:48:44 -06:00
Brian Madison
80a90c01d4 chore: bump version to alpha.14
- Updated CHANGELOG.md with comprehensive Alpha.14 release notes
- Added advanced builder features and custom installation improvements
- IDE configuration preservation during upgrades
- Breaking change: removed legacy agent-install command
2025-12-07 02:21:49 -06:00
Brian Madison
119187a1e7 custom module installer improved, and removed agent-install 2025-12-07 02:10:03 -06:00
Brian Madison
b252778043 custom inst imporove 2025-12-07 01:43:44 -06:00
Brian Madison
eacfba2e5b custom agents and workflows can now also be installed with a simple custom.yaml designation 2025-12-06 22:45:02 -06:00
Brian Madison
903c7a4133 remove hardcoded agent sidecar locations to fully use config option 2025-12-06 21:37:43 -06:00
Brian Madison
8c04ccf3f0 rename default folder location for agent_sidecar_folder installation location 2025-12-06 21:21:03 -06:00
Brian Madison
6d98864ec1 sidecar files retained on updates 2025-12-06 21:17:13 -06:00
Brian Madison
1697a45376 sidecar content goes to custom core config location 2025-12-06 21:08:57 -06:00
Brian Madison
ba2c81263b remove: all legacy file cleanup functionality
- Removed scanForLegacyFiles, performCleanup, and related methods from installer.js
- Removed --skip-cleanup option from install command
- Deleted cleanup.js command file entirely
- Simplified installation flow by removing cleanup prompts
- All tests passing after removal
2025-12-06 17:11:40 -06:00
Brian Madison
8d044f8c3e fix: prevent modules from showing as obsolete during reinstall
- Skip module selection prompt during update/reinstall
- Keep all existing installed modules by default
- This prevents inquirer from showing modules as 'obsolete items' with confusing delete options
- Modules are now preserved during update/reinstall operations
2025-12-06 16:56:09 -06:00
Brian Madison
74d071708d fix: nested agents now appear in CLI commands
- Fix getAgentsFromDir in bmad-artifacts.js to recursively scan subdirectories
- This ensures agents like cbt-coach and wellness-companion that are in subdirectories are properly found
- Agents now correctly get slash commands in .claude/commands/bmad/mwm/agents/
- All agents from the manifest now have corresponding IDE commands
2025-12-06 16:39:28 -06:00
Brian Madison
86e2daabba fix: ManifestGenerator now recursively scans for agents
- Updated getAgentsFromDir to search subdirectories for .md files
- Fixed installPath construction to include nested directory structure
- This ensures agents in subdirectories (like cbt-coach/cbt-coach.md) get added to agent-manifest.csv
- All agents now get proper CLI slash commands regardless of nesting depth
2025-12-06 16:31:32 -06:00
Brian Madison
aad7a71718 fix: ManifestGenerator now scans for all installed modules
- Previously only scanned selectedModules, missing modules installed from custom locations
- Now scans the bmad directory to find all actually installed modules
- Any module with agents/workflows/tasks/tools will be included in manifests
- This fixes issue where MWM workflows weren't getting slash commands
- All modules now get equal treatment in IDE integration
2025-12-06 16:16:48 -06:00
Brian Madison
f052967f65 fix: ModuleManager now creates customize.yaml files for agents
- Added logic to create customize template files during agent compilation
- ModuleManager was only using existing customize files, not creating them
- Now customize.yaml files will be created for all module agents
- This fixes issue where agents in subdirectories had no customization support

Next: Need to fix agent-manifest.csv to find agents in subdirectories
2025-12-06 16:02:07 -06:00
Brian Madison
1bd01e1ce6 feat: implement recursive agent discovery and compilation
- Module agents now discovered recursively at any depth in agents folder
- .agent.yaml files are compiled to .md format during module installation
- Custom agents also support subdirectory structure
- Agents maintain their directory structure when installed
- YAML files are skipped during file copying as they're compiled separately
- Added compileModuleAgents method to handle YAML-to-MD compilation
- Updated discoverAgents to recursively search for .agent.yaml files
- Agents in subdirectories are properly placed in _cfg/agents with relative paths

This fixes issue where agents like cbt-coach were not being compiled
and were only copied as YAML files.
2025-12-06 15:38:38 -06:00
Brian Madison
0d83799ecf refactor: simplify module discovery to scan entire project
- Module discovery now scans entire project recursively for install-config.yaml
- Removed hardcoded module locations (bmad-custom-src, etc.)
- Modules can exist anywhere with _module-installer/install-config.yaml
- All modules treated equally regardless of location
- No special UI handling for 'custom' modules
- Core module excluded from selection list (always installed first)
- Only install-config.yaml is valid (removed support for legacy config.yaml)

Modules are now discovered by structure, not location.
2025-12-06 15:28:37 -06:00
Brian Madison
7c5c97a914 atl rovo dev not in preferred list until fully tested 2025-12-06 14:25:29 -06:00
Brian Madison
7545bf9227 remove custom test content from src control 2025-12-06 12:53:43 -06:00
Brian Madison
228dfa28a5 installer updates working with basic flow 2025-12-06 12:53:43 -06:00
Alex Verkhovsky
e3f756488a feat(quality): add markdownlint-cli2 to quality checks (#1039)
- Add markdownlint-cli2 as dev dependency
- Add lint:md script to package.json
- Add markdownlint job to CI workflow
- Configure 5 rules: heading-increment, no-duplicate-heading,
  no-trailing-punctuation, no-bare-urls, no-space-in-emphasis
- Fix existing violations across 19 markdown files
- No auto-fix to prevent destructive changes

Closes #1034

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-06 12:40:07 -06:00
Alex Verkhovsky
d85090060b fix: read version from package.json instead of hardcoded fallback (#1041)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-06 12:39:39 -06:00
Alex Verkhovsky
a0442d4fb7 chore(cli): remove broken build caching (#1042)
The agent build caching never worked - BUILD-META comments were
never written to output files, so every build acted like --force.

Since building all 29 agents takes ~300ms, caching provided no
meaningful benefit. Removed ~190 lines of dead code including
checkIfNeedsRebuild, checkBuildStatus, buildMetadataComment,
and the --force flag.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-06 12:38:56 -06:00
Alex Verkhovsky
e979b47fe5 fix(workflows): remove hardcoded years from WebSearch queries (#1040)
* update 2024 to 2025

* fix(workflows): remove hardcoded years from WebSearch queries

Years in search queries (2024/2025) do not improve results - search
engines already prioritize current documentation. Tested all patterns
and confirmed identical quality results with/without years.

Removes years from:
- step-03-starter.md (5 queries)
- step-04-decisions.md (2 queries)
- game-architecture/instructions.md (2 queries)

Leaves file-utils.md unchanged (test fixture data, not a search query).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix(workflows): remove year placeholders from research WebSearch queries

Search engines return current results regardless of year - removes
{{current_year}} and hardcoded 2025 from step-05-technical-trends.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor(workflows): replace {{current_year}} with semantic alternatives

Replaces year placeholder with context-appropriate wording:
- 'current data' for up-to-date information
- 'web searches' without year qualifier
- Updated failure mode to focus on using web searches

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix(workflows): clarify failure mode about stale training data

Rephrased to explicitly mention training data cutoff as the reason
to use web searches for current technology trends.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor(workflows): make web search references platform-agnostic

- Remove hardcoded year references from WebSearch queries
- Replace `WebSearch` tool name with natural language "search the web"
- Soften "training data is stale" to "verify and supplement your knowledge"
- Add web search prerequisite check to research workflow
- Add platform-agnostic design note to CLAUDE.md

This framework targets 15+ agentic platforms, not just Claude Code.
Tool-specific syntax like `WebSearch:` won't work across all platforms.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(research): clean up prompts and routing

---------

Co-authored-by: Pomazan Bohdan <pomazan.bogdan@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>
2025-12-06 12:37:50 -06:00
Alex Verkhovsky
a6dffb4706 fix(installer): remove hardcoded 'bmad' prefix from files-manifest.csv paths (#1043)
The manifest writer hardcoded 'bmad' as the path prefix regardless of
the actual folder name (.bmad, bmad, etc). The reader had a matching
hardcoded strip, so it worked by accident.

Now paths are stored relative to bmadDir without any prefix. Legacy
fallback strips 'bmad/' on read - safe because no real path inside
bmadDir would start with 'bmad/'.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-06 12:36:17 -06:00
Hang
282bc27c7e feat(bmm): enhance PRD workflow with brownfield project support (#1047)
- Add three-branch conditional logic for document-based discovery:
  - PATH A: Has Product Brief (any project type)
  - PATH B: No Brief + Has Project Docs (brownfield)
  - PATH C: No Documents (greenfield from scratch)
- Add YAML frontmatter to all 12 PRD step files
- Add documentCounts to frontmatter for state tracking
- Fix step count (11 steps, not 10) and path typos
- Remove non-existent workflow references (story-context, validate-architecture)
- Update workflow chains and glossary definitions

Key insight: Branch based on DOCUMENT TYPE, not PROJECT TYPE.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-06 12:35:30 -06:00
Alex Verkhovsky
5ee1551b5b fix(bmm): remove stale validate-prd references (fixes #1030) (#1038)
- Remove validate-prd workflow references from all workflow path YAML files
- Update Excalidraw diagram: remove Validate PRD box and zombie JSON elements
- Re-export SVG at 1x scale
- Standardize implementation-readiness descriptions across all docs
- Add validation script (validate-svg-changes.sh) and README for SVG export process
- Correct Excalidraw timestamps

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-05 21:35:46 -06:00
Alex Verkhovsky
c95b65f462 fix(bmm): correct code-review workflow status logic and checklist (#1015) (#1028)
- Fix checklist to only accept 'review' status (not 'ready-for-review')
- Include MEDIUM issues in done/in-progress status determination
- Initialize and track fixed_count/action_count variables for summary
- Add sprint-status.yaml sync when story status changes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-05 21:27:11 -06:00
Nguyen Quang Huy
72ef9e9722 fix: use backticks for quoted phrase in code-review description (#1025)
Replace 'looks good' with `looks good` to avoid nested single quote
issues when IDEs generate command files from workflow YAML.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-05 21:26:04 -06:00
Paul Preibisch
8265bbf295 feat(installer): Enhanced TTS injection summary with tracking and documentation (#1037)
## Summary
- Track all files with TTS injection applied during installation
- Display informative summary explaining what TTS injection does
- Show backup location and restore command for recovery

## What is TTS Injection?
TTS (Text-to-Speech) injection adds voice instructions to BMAD agents,
enabling them to speak their responses aloud using AgentVibes.

Example: When you activate the PM agent, it will greet you with
spoken audio like "Hey! I'm your Project Manager. How can I help?"

## Changes
- **installer.js**: Track files in `processAgentFiles()`, `buildStandaloneAgents()`,
  and `rebuildAgentFiles()` when TTS markers are processed
- **compiler.js**: Add TTS injection support for custom agent compilation
- **ui.js**: Enhanced installation summary showing:
  - Explanation of what TTS injection is with example
  - List of all files with TTS injection applied (grouped by type)
  - Backup location (~/.bmad-tts-backups/)
  - Restore command for recovery

## Example Output
```
═══════════════════════════════════════════════════
            AgentVibes TTS Injection Summary
═══════════════════════════════════════════════════

What is TTS Injection?

  TTS (Text-to-Speech) injection adds voice instructions to BMAD agents,
  enabling them to speak their responses aloud using AgentVibes.

  Example: When you activate the PM agent, it will greet you with
  spoken audio like "Hey! I'm your Project Manager. How can I help?"

 TTS injection applied to 11 file(s):

  Party Mode (multi-agent conversations):
    • .bmad/core/workflows/party-mode/instructions.md
  Agent TTS (individual agent voices):
    • .bmad/bmm/agents/analyst.md
    • .bmad/bmm/agents/architect.md
    ...

Backups & Recovery:

  Pre-injection backups are stored in:
    ~/.bmad-tts-backups/

  To restore original files (removes TTS instructions):
    bmad-tts-injector.sh --restore /path/to/.bmad
```

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Paul Preibisch <paul@paulpreibisch.com>
Co-authored-by: Claude <noreply@anthropic.com>
2025-12-05 18:54:03 -06:00
Murat K Ozcan
f99e192e74 fix: tea ci nvmrc (#1036) 2025-12-05 12:30:20 -06:00
Brian Madison
0b9290789e installer fixes 2025-12-03 22:44:13 -06:00
Brian Madison
aa1cf76f88 new workflow types generate slash commands 2025-12-03 21:36:24 -06:00
Alex Verkhovsky
b8b4b65c10 feat(discord): compact plain-text notifications with bug fixes (#1021)
- Fix esc() bracket expression (] must be first in POSIX regex)
- Fix delete job: inline helper to avoid checkout of deleted ref
- Fix issue notifications: attribute close/reopen to actor, not author
- Simplify trunc() comment (remove false Unicode-safe claim)
- Smart truncation with wall-of-text detection
- Escape markdown and @mentions for safe display

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-03 20:22:59 -06:00
Brian Madison
73db5538bf roo installer improovement 2025-12-03 19:56:23 -06:00
Philip Louw
41f9cc1913 feat: add kiro-cli installer with BMad Core compliance (#993)
- Implement KiroCliSetup class extending BaseIdeSetup
- Generate 21 agents from YAML sources with JSON configs and markdown prompts
- Add runtime resource loading and numbered menu formatting
- Include BMad Core validation for required agent fields
- Fix agent naming conventions to prevent double prefixes
- Add .kiro/ directory to gitignore

Follows BMad Method standards for IDE installer integration.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-03 12:17:02 -06:00
Alex Verkhovsky
686af5b0ee feat: add intelligent routing to quick-dev workflow (#1019)
Add escalation threshold and scale-adaptive routing to quick-dev:
- Simple requests get standard [t]/[e] choice
- Complex requests evaluated against project-levels.yaml
- Level 1-2 or uncertain → tech-spec recommended
- Level 3+ → BMad Method (workflow-init) recommended

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-03 12:14:36 -06:00
Dicky Moore
65658a499b Feat/sprint status command (#1012)
* feat: add sprint-status command

* minor changes to reduce the change radius

---------

Co-authored-by: mq-bot <mq-bot@local>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-12-03 12:00:34 -06:00
Alex Verkhovsky
d553a09f73 docs: create CODE_OF_CONDUCT.md (#1013)
* docs: create CODE_OF_CONDUCT.md

* chore: exclude CODE_OF_CONDUCT.md from Prettier

Third-party artifact should not be reformatted.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add Discord as enforcement contact channel

Uses permanent invite link. Discord is common practice for
open source project Code of Conduct enforcement.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-03 10:42:28 -06:00
Brian Madison
c79d081128 fix pm and architect agents menu items to load new step sharded workflows 2025-12-02 22:40:57 -06:00
Brian Madison
0b3964902a workflow builder has template LOD output options 2025-12-02 22:36:44 -06:00
Brian Madison
1e6fc4ba14 workflow creation update 2025-12-02 21:44:30 -06:00
Brian Madison
aa30ef3e79 convert create epics and stories and implementation readiness to the new workflow step format 2025-12-02 19:22:15 -06:00
Brian Madison
6365a63dff workflow builder understands how to build continuable workflows 2025-12-02 19:22:15 -06:00
Alex Verkhovsky
fe0817f590 fix(bmm): complete cleanup of epic-tech-context workflow removal (#1001)
- Remove references to deprecated epic-tech-context, story-context,
  validate-epic-tech-context, validate-story-context, and story-done workflows
- Simplify epic status: backlog → in-progress → done (was backlog → contexted)
- Update create-story to handle legacy 'contexted' status for backward compat
- Clean up sprint-planning instructions and status template
- Update docs: agents-guide, brownfield-guide, faq, glossary, quick-start

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-30 23:52:04 -06:00
Brian Madison
afd2a163bf chore: bump version to alpha.13 2025-11-30 23:23:08 -06:00
Brian Madison
9223174f40 remove legacy workflows from bmb that were upgraded to step sharded flows and prep .13 changelog 2025-11-30 23:18:01 -06:00
Brian Madison
47ad645f22 complience check of workflow fix 2025-11-30 22:47:28 -06:00
Brian Madison
788c746857 product brief compliance with documented workflow standards 2025-11-30 22:45:48 -06:00
Brian Madison
ad053a6508 create workflow validation check fixes 2025-11-30 21:51:46 -06:00
Brian Madison
4539ca7436 feat: implement granular step-file workflow architecture with multi-menu support
## Major Features Added
- **Step-file workflow architecture**: Transform monolithic workflows into granular step files for improved LLM adherence and consistency
- **Multi-menu handler system**: New `handler-multi.xml` enables grouped menu items with fuzzy matching
- **Workflow compliance checker**: Added automated compliance validation for all workflows
- **Create/edit agent workflows**: New structured workflows for agent creation and editing

## Workflow Enhancements
- **Create-workflow**: Expanded from 6 to 14 detailed steps covering tools, design, compliance
- **Granular step execution**: Each workflow step now has dedicated files for focused execution
- **New documentation**: Added CSV data standards, intent vs prescriptive spectrum, and common tools reference

## Complete Migration Status
- **4 workflows fully migrated**: `create-agent`, `edit-agent`, `create-workflow`, and `edit-workflow` now use the new granular step-file architecture
- **Legacy transformation**: `edit-workflow` includes built-in capability to transform legacy single-file workflows into the new improved granular format
- **Future cleanup**: Legacy versions will be removed in a future commit after validation

## Schema Updates
- **Multi-menu support**: Updated agent schema to support `triggers` array for grouped menu items
- **Legacy compatibility**: Maintains backward compatibility with single `trigger` field
- **Discussion enhancements**: Added conversational_knowledge recommendation for discussion agents

## File Structure Changes
- Added: `create-agent/`, `edit-agent/`, `edit-workflow/`, `workflow-compliance-check/` workflows
- Added: Documentation standards and CSV reference files
- Refactored: `create-workflow/steps/` with detailed granular step files

## Handler Improvements
- Enhanced `handler-exec.xml` with clearer execution instructions
- Improved data passing context for executed files
- Better error handling and user guidance

This architectural change significantly improves workflow execution consistency across all LLM models by breaking complex processes into manageable, focused steps. The edit-workflow transformation tool ensures smooth migration of existing workflows to the new format.
2025-11-30 15:09:23 -06:00
Brian Madison
829d051c91 move agent builder docs, create workflow builder docs, and a new workflow builder to conform to stepwise workflow creation 2025-11-29 23:23:35 -06:00
Brian Madison
a0732df56c more step sharded workflows added for architecture and some fixes across all workflows to improve their file loading and reduction of time based estimates. 2025-11-29 01:49:15 -06:00
Brian Madison
4e254d7c63 brainstorming, research and partymode updated to use sharded step flow workflows 2025-11-29 01:49:15 -06:00
Brian Madison
00e72e66f8 Initial stepwise converstion of the phase 1 and 2 workflows complete. 2025-11-29 01:49:15 -06:00
Brian Madison
5a11519dc1 converted ux design to sharded step workflow 2025-11-29 01:49:14 -06:00
Alex Verkhovsky
5ea02d7091 feat: add adversarial code review recommendation to quick-dev workflow (#989)
* feat: add adversarial code review recommendation to quick-dev workflow

* fix: clarify scope of code review with 'in it' reference
2025-11-27 23:38:54 -06:00
Alex Verkhovsky
7b21708868 feat: recommend different LLM for code review in dev-story (#984)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-27 23:38:32 -06:00
Brian Madison
3c81d78991 the first reworked sharded workflow, prd, works great and resolves the issues with latest sonnet udpates 2025-11-27 22:33:03 -06:00
Brian Madison
dcaf02f665 Fix phase numbering throughout documentation
- Removed all references to Phase 0 (should be Documentation prerequisite)
- Updated phase transitions from 'Phase 3→4' to 'Phase 3 to Phase 4'
- Ensured all phases are numbered 1-4 consistently
- Documentation for brownfield projects is now correctly referred to as 'Documentation prerequisite' rather than Phase 0
2025-11-26 20:59:46 -06:00
Brian Madison
04b328bd2a Fix workflow documentation - remove non-existent workflows and Mermaid diagrams
- Updated workflows-implementation.md: removed validate workflows, epic-tech-context, story-context
- Updated workflows-analysis.md: removed brainstorm-game, game-brief, added domain-research
- Updated workflows-planning.md: removed gdd, narrative, moved create-epics-and-stories to Phase 3
- Updated workflows-solutioning.md: already correct with create-epics-and-stories in Phase 3
- Removed all Mermaid diagrams and replaced with text descriptions
- Updated quick reference tables to reflect actual workflows
- Fixed flow examples to match current implementation
2025-11-26 20:42:20 -06:00
Brian Madison
355ccebca2 workflow-status can call workflow init 2025-11-26 19:48:47 -06:00
Brian Madison
dfc35f35f8 BMad Agents menu items are logically ordered and marked with optional or recommended and some required tags 2025-11-26 18:22:24 -06:00
Brian Madison
677c000820 github uses agents folder now instead of chatmodes 2025-11-26 17:46:26 -06:00
Brian Madison
3ac539b61f npm vulnerabilities resolved 2025-11-26 17:07:09 -06:00
Brian Madison
331a67eeb3 installer allows cleanup of unneeded files in upgrades 2025-11-26 16:47:15 -06:00
Brian Madison
fbdb91b991 standard greenfield workflow updated diagrams 2025-11-26 15:14:34 -06:00
Jorge Castillo
54e6745a55 fix: update GitHub Copilot tools names for consistency (#880)
Copilot was triggering warning or errors in the chatmode files due to some changes in tool names.
- findTestFiles is internal tool, cannot be used.
- Other tools have change names.
- Added new tools: todos and runSubAgents.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-26 14:49:17 -06:00
Serhii
f793cf8fcd fix: add radix parameter to parseInt() calls (#862)
Add explicit radix=10 to parseInt() calls and NaN validation to prevent
unexpected hex parsing and invalid config values.

Changes:
- Line 52: Add radix and NaN check in input validation
- Line 189-192: Add radix and NaN fallback for config parsing

Fixes potential issues:
- Hex input (0x10) now rejected instead of parsed as 16
- Invalid strings return default value instead of NaN→null

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-26 14:44:12 -06:00
fikri-kompanion
9223e2be21 fix: give kilocode tool access to bmad modes (#961)
Co-authored-by: Ahmad Fikrizaman <ahmadfikrizaman@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-26 13:48:16 -06:00
Brian Madison
2cac74cfb5 agent vibes injection and installer update 2025-11-26 11:00:46 -06:00
Paul Preibisch
5702195ef7 Add Text-to-Speech Integration via TTS_INJECTION System (#934)
* feat: Add provider-agnostic TTS integration via injection point system

Implements comprehensive Text-to-Speech integration for BMAD agents using a generic
TTS_INJECTION marker system. When AgentVibes (or any compatible TTS provider) is
installed, all BMAD agents can speak their responses with unique AI voices.

## Key Features

**Provider-Agnostic Architecture**
- Uses generic `TTS_INJECTION` markers instead of vendor-specific naming
- Future-proof for multiple TTS providers beyond AgentVibes
- Clean separation - BMAD stays TTS-agnostic, providers handle injection

**Installation Flow**
- BMAD → AgentVibes: TTS instructions injected when AgentVibes detects existing BMAD installation
- AgentVibes → BMAD: TTS instructions injected during BMAD installation when AgentVibes detected
- User must manually create voice assignment file when AgentVibes installs first (documented limitation)

**Party Mode Voice Support**
- Each agent speaks with unique assigned voice in multi-agent discussions
- PM, Architect, Developer, Analyst, UX Designer, etc. - all with distinct voices

**Zero Breaking Changes**
- Fully backward compatible - works without any TTS provider
- `TTS_INJECTION` markers are benign HTML comments if not processed
- No changes to existing agent behavior or non-TTS workflows

## Implementation Details

**Files Modified:**
- `tools/cli/installers/lib/core/installer.js` - TTS injection processing logic
- `tools/cli/lib/ui.js` - AgentVibes detection and installation prompts
- `tools/cli/commands/install.js` - Post-install guidance for AgentVibes setup
- `src/utility/models/fragments/activation-rules.xml` - TTS_INJECTION marker for agents
- `src/core/workflows/party-mode/instructions.md` - TTS_INJECTION marker for party mode

**Injection Point System:**
```xml
<rules>
  - ALWAYS communicate in {communication_language}
  <!-- TTS_INJECTION:agent-tts -->
  - Stay in character until exit selected
</rules>
```

When AgentVibes is detected, the installer replaces this marker with:
```
- When responding to user messages, speak your responses using TTS:
  Call: `.claude/hooks/bmad-speak.sh '{agent-id}' '{response-text}'` after each response
  IMPORTANT: Use single quotes - do NOT escape special characters like ! or $
```

**Special Character Handling:**
- Explicit guidance to use single quotes without escaping
- Prevents "backslash exclamation" artifacts in speech

**User Experience:**
```
User: "How should we architect this feature?"
Architect: [Text response] + 🔊 [Professional voice explains architecture]
```

Party Mode:
```
PM (John): "I'll focus on user value..." 🔊 [Male professional voice]
UX Designer (Sara): "From a user perspective..." 🔊 [Female voice]
Architect (Marcus): "The technical approach..." 🔊 [Male technical voice]
```

## Testing

**Unit Tests:**  62/62 passing
- 49/49 schema validation tests
- 13/13 installation component tests

**Integration Testing:**
-  BMAD → AgentVibes (automatic injection)
-  AgentVibes → BMAD (automatic injection)
-  No TTS provider (markers remain as comments)

## Documentation

Comprehensive testing guide created with:
- Both installation scenario walkthroughs
- Verification commands and expected outputs
- Troubleshooting guidance

## Known Limitations

**AgentVibes → BMAD Installation Order:**
When AgentVibes installs first, voice assignment file must be created manually:
```bash
mkdir -p .bmad/_cfg
cat > .bmad/_cfg/agent-voice-map.csv << 'EOF'
agent_id,voice_name
pm,en_US-ryan-high
architect,en_US-danny-low
dev,en_US-joe-medium
EOF
```

This limitation exists to prevent false legacy v4 detection warnings from BMAD installer.

**Recommended:** Install BMAD first, then AgentVibes for automatic voice assignment.

## Related Work

**Companion Implementation:**
- Repository: paulpreibisch/AgentVibes
- Commits: 6 commits implementing injection processing and voice routing
- Features: Retroactive injection, file path extraction, escape stripping

**GitHub Issues:**
- paulpreibisch/AgentVibes#36 - BMAD agent ID support

## Breaking Changes

None. Feature is opt-in and requires separate TTS provider installation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Enforce project hooks over global hooks in party mode

before, claude would sometimes favor global agent vibes hooks over project specific

* feat: Automate AgentVibes installer invocation after BMAD install

Instead of showing manual installation instructions, the installer now:
- Prompts "Press Enter to start AgentVibes installer..."
- Automatically runs npx agentvibes@latest install
- Handles errors gracefully with fallback instructions

This provides a seamless installation flow matching the test script's
interactive approach.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: Add automated testing script and guide for PR #934

Added comprehensive testing tools for AgentVibes party mode integration:

- test-bmad-pr.sh: Fully automated installation and verification script
  - Interactive mode selection (official PR or custom fork)
  - Automatic BMAD CLI setup and linking
  - AgentVibes installation with guided prompts
  - Built-in verification checks for voice maps and hooks
  - Saved configuration for quick re-testing

- TESTING.md: Complete testing documentation
  - Quick start with one-line npx command
  - Manual installation alternative
  - Troubleshooting guide
  - Cleanup instructions

Testers can now run a single command to test the full AgentVibes integration
without needing to understand the complex setup process.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Add shell: true to npx execSync to prevent permission denied error

The execSync call for 'npx agentvibes@latest install' was failing with
'Permission denied' because the shell was trying to execute 'agentvibes@latest'
directly instead of passing it as an argument to npx.

Adding shell: true ensures the command runs in a proper shell context
where npx can correctly interpret the @latest version syntax.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Remove duplicate AgentVibes installation step from test script

The test script was calling AgentVibes installer twice:
1. BMAD installer now automatically runs AgentVibes (new feature)
2. Test script had a separate Step 6 that also ran AgentVibes

This caused the installer to run twice, with the second call failing
because it was already installed.

Changes:
- Removed redundant Step 6 (AgentVibes installation)
- Updated Step 5 to indicate it includes AgentVibes
- Updated step numbers from 7 to 6 throughout
- Added guidance that AgentVibes runs automatically

Now the flow is cleaner: BMAD installer handles everything!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Address bmadcode review - preserve variables and move TTS logic to injection

Fixes requested changes from PR review:

1. Preserve {bmad_folder} variable placeholder
   - Changed: {project_root}/.bmad/core/tasks/workflow.xml
   - To: {project_root}/{bmad_folder}/core/tasks/workflow.xml
   - Allows users to choose custom BMAD folder names during installation

2. Move TTS-specific hook guidance to injection system
   - Removed hardcoded hook enforcement from source files
   - Added hook guidance to processTTSInjectionPoints() in installer.js
   - Now only appears when AgentVibes is installed (via TTS_INJECTION)

3. Maintain TTS-agnostic source architecture
   - Source files remain clean of TTS-specific instructions
   - TTS details injected at install-time only when needed
   - Preserves provider-agnostic design principle

Changes made:
- src/core/workflows/party-mode/instructions.md
  - Reverted .bmad to {bmad_folder} variable
  - Replaced hardcoded hook guidance with <!-- TTS_INJECTION:party-mode -->
  - Removed <note> about play-tts.sh hook location

- tools/cli/installers/lib/core/installer.js
  - Added hook enforcement to party-mode injection replacement
  - Guidance now injected only when enableAgentVibes is true

Addresses review comments from bmadcode:
- "needs to remain the variable. it will get set in the file at the install destination."
- "items like this we will need to inject if user is using claude and TTS"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Change 'claude-code' to 'claude' in test script instructions

The correct command to start Claude is 'claude', not 'claude-code'.
Updated line 362-363 in test-bmad-pr.sh to show the correct command.

* fix: Remove npm link from test script to avoid global namespace pollution

- Removed 'npm link' command that was installing BMAD globally
- Changed 'bmad install' to direct node execution using local clone
- Updated success message to reflect no global installation

This keeps testing fully isolated and prevents conflicts with:
- Existing BMAD installations
- Future official BMAD installs
- Orphaned symlinks when test directory is deleted

The test script now runs completely self-contained without modifying
the user's global npm environment.

---------

Co-authored-by: Claude Code <claude@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Paul Preibisch <paul@paulpreibisch.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-26 09:51:57 -06:00
mreis-atlassian
11a1dbaefc feat: Adding support for Rovo Dev (#975)
- Adding support for rovo dev
- Adding rovo dev translation wrappers
2025-11-26 09:05:04 -06:00
Brian Madison
d6b98afd2b minor udpates to prd, architecture, and create epics and stories flows. 2025-11-26 00:28:49 -06:00
Brian Madison
24e952c511 updated code review 2025-11-25 16:59:00 -06:00
Brian Madison
3740a554f0 fix: optimize agent compiler and complete handler cleanup
- Add deployment-aware handler generation (filters web-only/ide-only commands)
- Remove unused run-workflow handler type (ghost handler cleanup)
- Implement missing validate-workflow and data handler generation
- Update schema validation to support exactly 6 active handler types
- Clean up activation templates and web bundler logic
- Prevent generation of unused handler instructions for better performance
- All 62 tests pass with backward compatibility maintained
2025-11-23 21:28:50 -06:00
Brian Madison
cd98a7f5bb feat: complete Phase 4 workflow transformation - simpler, faster, better results
MAJOR BREAKING CHANGES: Phase 4 completely reengineered for developer efficiency and quality

🚀 **Phase 4 Streamlined & Supercharged:**
- **Reduced from 11 to 5 essential workflows** (55% reduction in complexity)
- **Eliminated redundant steps** that created token waste and confusion
- **Created single source of truth** story files with comprehensive implementation context
- **Achieved more reliable results** with fewer steps and better developer guidance

💡 **Revolutionary Dev Agent Behavior Fixes:**
- **Story file is now LAW:** Tasks/subtasks sequence is absolutely binding
- **Red-green-refactor enforcement:** Tests written first, validated, then implementation
- **Zero tolerance for cheating:** Tests must ACTUALLY exist and pass before marking complete
- **Sequential execution only:** No more "doing whatever you want" - follow the story exactly
- **Continuous execution:** No premature pausing until all tasks complete

🎯 **Quality Competition System:**
- **Enhanced story context engine** prevents common LLM development mistakes
- **Quality competition between LLMs** ensures optimal story preparation
- **Comprehensive anti-pattern prevention** stops wheel reinvention and wrong approaches
- **Developer optimization focus** for maximum clarity with minimum verbosity

📋 **Enhanced Definition of Done:**
- **27-point validation checklist** covers all implementation aspects
- **Multiple validation gates** prevent claiming work that isn't actually done
- **Comprehensive test requirements** ensure no functionality goes untested
- **File tracking and documentation** for complete project visibility

🔧 **Technical Improvements:**
- **Variable consistency** throughout all workflow files
- **XML instruction format** for better workflow engine compatibility
- **Proper ask tag handling** for user interaction clarity
- **Project context integration** without blocking implementation
- **Fixed all agent schema compliance** for proper array formatting

**Result:** Phase 4 now delivers superior development outcomes with:
-  **55% fewer workflows** to learn and maintain
-  **Dramatically reduced token usage** and context switching
-  **Eliminated dev agent behavioral issues** that caused quality problems
-  **Faster time-to-completion** with more reliable, predictable results
-  **Better developer experience** with clearer guidance and validation

This represents the most significant Phase 4 improvement since BMAD Method inception - fundamentally fixing developer workflow quality while drastically simplifying the implementation process.
2025-11-23 16:43:04 -06:00
Brian Madison
4308b36d4d feat: add custom agents and quick-flow workflows, remove tech-spec track
Major Changes:
- Add sample custom agents demonstrating installable agent system
  - commit-poet: Generates semantic commit messages (BMAD Method repo sample)
  - toolsmith: Development tooling expert with knowledge base covering bundlers, deployment, docs, installers, modules, and tests (BMAD Method repo sample)
  - Both agents demonstrate custom agent architecture and are installable to projects via BMAD installer system
  - Include comprehensive installation guides and sidecar knowledge bases

- Add bmad-quick-flow methodology for rapid development
  - create-tech-spec: Direct technical specification workflow
  - quick-dev: Flexible execution workflow supporting both tech-spec-driven and direct instruction development
  - quick-flow-solo-dev (Barry): 1 man show agent specialized in bmad-quick-flow methodology
  - Comprehensive documentation for quick-flow approach and solo development

- Remove deprecated tech-spec workflow track
  - Delete entire tech-spec workflow directory and templates
  - Remove quick-spec-flow.md documentation (replaced by quick-flow docs)
  - Clean up unused epic and story templates

- Fix custom agent installation across IDE installers
  - Repair antigravity and multiple IDE installers to properly support custom agents
  - Enable custom agent installation via quick installer, agent installer, regular installer, and special agent installer
  - All installation methods now accessible via npx with full documentation

Infrastructure:
- Update BMM module configurations and team setups
- Modify workflow status paths to support quick-flow integration
- Reorganize documentation with new agent and workflow guides
- Add custom/ directory for user customizations
- Update platform codes and installer configurations
2025-11-23 08:51:26 -06:00
Brian Madison
6907d44810 fix: display proper persona names in custom agent manifests
## Problem
Custom agents showed generic names (like "Commit Poet") instead of their
actual persona names (like "Inkwell Von Comitizen") in the agent manifest.

## Root Cause
The extractManifestData function was using metadata.name/title instead of
extracting the persona name from the compiled agent XML.

## Solution
1. Added extractAgentAttribute function to pull attributes from <agent> tag
2. Prioritize XML extraction over metadata for persona info:
   - displayName: uses agent title attribute from XML
   - title: uses agent title attribute from XML
   - icon: uses agent icon attribute from XML
   - Falls back to metadata if XML extraction fails

## Result
Custom agents now display their actual persona names in manifests:
- Before: "Commit Poet"
- After: "Inkwell Von Comitizen"

This provides better user experience with proper agent identification
in IDE integrations and manifests.
2025-11-23 08:51:26 -06:00
Brian Madison
efc2b6d0df feat: complete custom agent support for ALL remaining IDEs
## Added installCustomAgentLauncher to remaining IDEs:

 Qwen (.qwen/commands/BMad/)
- TOML format with proper description and prompt fields
- Uses existing processAgentLauncherContent method
- Format: custom-{agent-name}.toml

 Trae (.trae/rules/)
- Markdown format with bmad-agent-custom- prefix
- Follows existing BMAD naming pattern
- Format: bmad-agent-custom-{agent-name}.md

 Roo (.roomodes)
- YAML format appends to existing customModes section
- Creates customModes section if missing
- Format: bmad-custom-{agent-name} (slug-based)

 Kilo (.kilocodemodes)
- YAML format identical to Roo pattern
- Handles existing customModes gracefully
- Format: bmad-custom-{agent-name} (slug-based)

 Auggie (.augment/commands/bmad/)
- Frontmatter + Markdown format
- Follows existing Auggie command pattern
- Format: custom-{agent-name}.md

## Complete IDE Coverage:
ALL IDEs now support custom agent installation:
- 16 total IDEs with custom agent support
- Various formats: TOML, YAML, Markdown, file-based
- All include @agentPath references and usage instructions
- Proper IDE-specific naming and directory structures

Custom agents from .bmad/custom/src/agents/ now install to EVERY configured IDE!
2025-11-23 08:51:25 -06:00
Brian Madison
98342f2174 feat: add custom agent support to more IDEs
## Added installCustomAgentLauncher function to:

 Cline (.clinerules/workflows/)
- Creates workflow files with custom agent launchers
- Format: bmad-custom-{agent-name}.md

 Crush (.crush/commands/bmad/)
- Creates command files with custom agent launchers
- Format: custom-{agent-name}.md

 Gemini (.gemini/commands/)
- Creates TOML command files with custom agent launchers
- Format: bmad-custom-{agent-name}.toml

 iFlow (.iflow/commands/bmad/)
- Creates command files with custom agent launchers
- Format: custom-{agent-name}.md

## All Custom Agent Launchers Include:
- @agentPath reference to load complete agent
- Usage instructions for loading first, then activating
- Proper IDE-specific formatting and file structure
- Return values for tracking installations

Now custom agents install to 8+ IDEs instead of just 4!
2025-11-23 08:51:25 -06:00
Brian Madison
2edadd11ae fix: add custom agent support to Antigravity IDE
## Problem
Custom agents were only installing to Claude Code (.claude/commands/)
but not to Antigravity (.agent/) or other IDEs that lack installCustomAgentLauncher function.

## Root Cause
Antigravity was missing the installCustomAgentLauncher function that the
IdeManager calls to install custom agents during agent installation.

## Solution
Added installCustomAgentLauncher function to Antigravity that:
- Creates .agent directory if needed
- Generates custom agent launchers with @agentPath references
- Uses same pattern as existing Antigravity agent launchers
- Returns proper installation result for tracking

## Result
Custom agents now install to:
- Claude Code: .claude/commands/bmad/custom/agents/ 
- Antigravity: .agent/bmad-custom-agents-{agentName}.md 
- Codex: (already working) 

All configured IDEs now receive custom agent installations!
2025-11-23 08:51:25 -06:00
Brian Madison
0aeaa5b2ea fix: compile agents now checks multiple source locations
## Problem
Compile Agents ignored custom agents in source locations like:
- {project-root}/custom/src/agents/
- {bmad-folder}/custom/src/agents/

## Solution
Update reinstallCustomAgents to check all locations:
1. _cfg/custom/agents/ (backup location)
2. {bmad-folder}/custom/src/agents/ (source in BMAD folder)
3. {project-root}/custom/src/agents/ (source at project root)

## Changes
- Search multiple locations for agents during compile
- Avoid duplicate processing with Set tracking
- Auto-backup source YAML to _cfg/custom/agents/ if needed
- Works with any custom bmad_folder name from config

Now 'Compile Agents' works with agents in any source location!
2025-11-23 08:51:25 -06:00
Brian Madison
b20773e7f7 docs: remove fluff from installation guide
- Remove verbose explanations and marketing language
- Keep only essential commands and process steps
- Reduce from verbose guide to concise reference
- Focus on what users need to know, not explanations
2025-11-23 08:51:25 -06:00
Brian Madison
c57ada4d9c feat: improve agent creation workflow and documentation
## BMB Agent Workflow Improvements
- Always create folders for agents (even simple ones)
- Add compact info-and-installation-guide.md (20 lines max)
- Include installation guide with every created agent
- Update workflow to use standalone_output_folder structure

## Documentation Updates
- Clarify --defaults makes installation non-interactive
- Update all parameter documentation for clarity
- Fix npm package references (bmad-method only)

## New Agent Structure
Every agent now gets:
  agent-folder/
  ├── agent-name.agent.yaml    # Source YAML
  └── info-and-installation-guide.md  # Quick install guide + description

## Quick Install Commands (added to guide)
- Interactive: npx bmad-method agent-install --source ./agent.yaml
- Non-interactive: npx bmad-method agent-install --source ./agent.yaml --defaults

This makes agent installation much more user-friendly and consistent.
2025-11-23 08:51:25 -06:00
Brian Madison
05cbc6ccb8 feat: rename agent-install parameters for clarity
- Change --path → --source (much clearer purpose)
- Change --target → --destination (more intuitive)
- Update all code references and documentation
- Add advanced parameter examples to installation guide
- Keep short aliases: -s for --source, -t for --destination

Parameters are now much more self-explanatory:
- --source: where to find the agent YAML
- --destination: where to install the compiled agent
2025-11-23 08:51:25 -06:00
Brian Madison
905f9ca346 docs: fix incorrect npm package references
- Fix npx bmad → npx bmad-method in documentation
- Only bmad-method is registered in npm registry, not bmad
- Clarify that bmad command works locally when BMAD is installed
- Update installation guides to use correct package name

Ensures users don't get 'package not found' errors when trying npx bmad
2025-11-23 08:51:25 -06:00
Brian Madison
90af352247 docs: update installation guide with npx support
- Add npx bmad-method agent-install option for users without cloned repo
- Show both local and npx commands side by side
- Clarify when to use each installation option
- Update automatic updates section with npx option
- Add prominent note about npx capability

Users can now install custom agents without needing to clone the BMAD repository.
2025-11-23 08:51:25 -06:00
Brian Madison
13b1fc7517 fix: remove remaining webskip keys from presentation-master.agent.yaml
All menu items now conform to agent schema validation.
2025-11-23 08:51:25 -06:00
Murat K Ozcan
9d510fc075 docs: playwright untils note in test-architecture.md (#957)
Co-authored-by: Murat Ozcan <murat@Murats-MacBook-Pro.local>
2025-11-21 09:19:22 -06:00
Murat K Ozcan
00b541f5d4 feat: playwright-utils integration (#954)
* feat: playwright-utils integration

* removed the temp plan file, and addressed changelog

* feat: edited the installer question for pw-utils

* feat: even more n00b friendly install prompt

* Update README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/modules/bmm/_module-installer/install-config.yaml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-11-20 17:34:08 -06:00
Murat K Ozcan
55fd621664 fix: enabled web bundles for test and dev (#948)
* fix: enabled web bundles for test and dev

* fix: only bundle non webskip agents

* fix: addressed pr comments

* fix: addressed pr comments

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-20 13:44:48 -06:00
Alex Verkhovsky
da00b295a9 fix: remove .agent from gitignore for Antigravity workflow access (#953)
Antigravity respects .gitignore rules which blocks access to workflow files
in .agent/workflows/, preventing custom workflows from being discovered.
Removing .agent from gitignore to allow Antigravity to scan workflow files.

Note: Codex and Claude Code ignore .gitignore when scanning for custom
prompts, so this only affects Antigravity users.
2025-11-20 12:33:14 -06:00
Brian Madison
a6f089cfd2 feat: add empty IDE selection warning and promote Antigravity to recommended
- Add persistent warning loop when no tools selected in installer
- Users must press spacebar to select, not just highlight
- Red warning explains the issue and offers to go back
- Only way to proceed without tools is explicit "No" confirmation
- Promote Google Antigravity to preferred/recommended IDE section
2025-11-19 22:12:45 -06:00
Alex Verkhovsky
09533e4abb Chore/update gitignore (#945)
* feat: Add Google Antigravity IDE installer

Implements installer for Google Antigravity IDE with flattened slash command
naming to match Antigravity's namespace requirements.

Key features:
- Flattened file naming (bmad-module-agents-name.md) for proper slash commands
- Subagent installation support (project-level or user-level)
- Module-specific injection configuration
- Agent, workflow, task, and tool command generation

Implementation:
- Added AntigravitySetup class extending BaseIdeSetup
- Extracted flattenFilename() to BaseIdeSetup for reuse across IDE handlers
- Uses .agent/workflows directory structure
- Supports both interactive and non-interactive configuration

Fixes:
- Proper namespace isolation: /bmad-module-agents-dev instead of /dev
- Prevents conflicts between modules with same agent names

Note: This installer shares 95% of its code with claude-code.js.
Future refactoring could extract common patterns to IdeWithSlashCommandsSetup
base class (see design documents for details).

* chore: update gitignore for antigravity installer

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-19 20:41:08 -06:00
Dicky Moore
d7f045b11e Align UX design workflow references (#935)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-11-19 20:40:07 -06:00
Alex Verkhovsky
e8e13a9aa3 feat: default installer username to system user (#939)
good idea here, thank you!
2025-11-19 20:36:54 -06:00
Brian Madison
be04d687dc chore: bump version to 6.0.0-alpha.12 and add yaml dependency
- Add missing yaml package dependency to fix MODULE_NOT_FOUND error
- Update CHANGELOG.md with alpha.12 release notes
2025-11-19 00:36:31 -06:00
Brian Madison
047dfc1462 chore: bump version to 6.0.0-alpha.11 2025-11-18 23:17:01 -06:00
Brian Madison
ece3eefd13 docs: Update CHANGELOG and README for v6.0.0-alpha.11 release
- Comprehensive alpha.11 changelog capturing all major features
- Condensed earlier alpha releases (0-10) to 5 key bullets each
- Reduced changelog from 1,744 to 609 lines for better readability
- Updated README status badges and installation instructions
2025-11-18 23:16:23 -06:00
Brian Madison
f17e4ef0b7 refactor(bmm,cis,core): Align diagram workflows with agile roles and distribute capabilities
## The Tale of the Frame Expert

Once upon a time, BMad Method had a specialized agent called Frame Expert.
This agent was the master of all visual artifacts - flowcharts, diagrams,
wireframes, data flows. Whenever anyone needed a diagram, they called upon
Frame Expert. The agent lived in its own isolated domain with four dedicated
workflows and a library of shared templates.

## The Awakening

But something felt wrong. Teams using BMad Method were meant to mirror real
agile teams - Product Managers, Architects, UX Designers, Tech Writers,
Developers. Each agent represented an authentic role you'd find in any
software team.

Except Frame Expert.

No real agile team has a "Frame Expert" or "Diagram Specialist" who creates
all visual artifacts. In real teams, Architects diagram system architecture.
PMs flowchart processes. UX Designers wireframe interfaces. Tech Writers
create documentation diagrams. The visuals emerge from the domain experts
who need them, not from a centralized diagram factory.

Frame Expert was an abstraction that made technical sense but violated the
very soul of BMad Method - authentic agile role modeling.

## The Transformation

And so Frame Expert was dissolved, its knowledge distributed to those who
truly needed it:

**The Architect** inherited system architecture diagrams and data flows -
the blueprints of technical systems they design.

**The Product Manager** received process flowcharts - the visual maps of
features and workflows they orchestrate.

**The UX Designer** claimed wireframes - the interface sketches that bring
their vision to life.

**The Tech Writer** gained all diagram types - the visual aids that clarify
their documentation.

Each agent now creates diagrams in their domain, using their expertise,
serving their purpose.

## The Shared Knowledge

But the wisdom of diagram creation itself - the Excalidraw templates, the
component libraries, the validation patterns - this knowledge was too
valuable to scatter. It was elevated to core resources, where both BMM
agents AND the new CIS presentation-master agent could draw upon it.

Shared infrastructure for common needs. Distributed execution for domain
expertise.

## The Ripple Effects

With diagrams now properly distributed, other misalignments became visible:

Epic creation was happening in Phase 2 (Planning), before Architecture
existed. But epics need architectural context - API contracts, data models,
technical decisions. So epic creation migrated to Phase 3 (Solutioning),
after Architecture provides that foundation.

Workflow paths were updated. Documentation gained visual flowcharts showing
the complete journey. Agent naming standards were clarified - filenames are
stable roles, persona names are user dreams.

## What Changed

**Removed:**
- frame-expert.agent.yaml (the centralized specialist)
- All frame-expert workflows and shared resources
- Phase 2 epic creation workflow (wrong timing)
- game-design workflow path (consolidated to method track)
- v6-open-items.md (planning doc, now complete)

**Distributed Diagram Capabilities:**
- Architect: create-excalidraw-diagram, create-excalidraw-dataflow
- PM: create-excalidraw-flowchart
- Tech Writer: create-excalidraw-{diagram,dataflow,flowchart}, generate-mermaid
- UX Designer: create-excalidraw-wireframe

**Created:**
- src/core/resources/ (shared diagram context for all modules)
- src/modules/cis/agents/presentation-master.agent.yaml (visual comms specialist)
- src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/ (epic creation's new home)
- src/modules/bmm/workflows/diagrams/ (distributed diagram implementations)
- src/modules/bmm/docs/images/ (workflow visualization assets)

**Enhanced:**
- All agent definitions with domain-appropriate diagram workflows
- Documentation with embedded workflow diagrams and visual guides
- Agent compilation docs with critical naming convention rules
- All 4 workflow paths (enterprise/method × brownfield/greenfield)

**Fixed:**
- Epic creation now in Phase 3 after Architecture
- Story context path variables in BMGD module
- PRD workflow descriptions (epics moved to Phase 3)

## For Users

The Frame Expert commands are gone. In their place:

- Need architecture diagrams? Ask `/architect`
- Need process flows? Ask `/pm`
- Need wireframes? Ask `/ux-designer`
- Need documentation visuals? Ask `/tech-writer`

Each expert creates diagrams in their domain, with their context, using
their judgment.

This is how real teams work.
2025-11-18 21:55:47 -06:00
Brian Madison
224af173ef feat: Comprehensive edit-agent workflow enhancement with Expert agent support and unified validation
## Overview
Major enhancement to edit-agent workflow to match create-agent quality standards, plus critical addition of Expert agent sidecar file support and consolidation of validation checklists into single source of truth.

## 1. edit-agent Workflow Comprehensive Enhancement

### Documentation Reference Updates (workflow.yaml)
**Fixed all broken references** - replaced deleted docs with new comprehensive guides:
-  Removed: agent-types.md, agent-architecture.md, agent-command-patterns.md, communication-styles.md
-  Added structured references:
  * Core Concepts: understanding_agent_types, agent_compilation
  * Architecture Guides: simple_architecture, expert_architecture, module_architecture
  * Design Patterns: menu_patterns, communication_presets, brainstorm_context
  * Reference Agents: commit-poet, journal-keeper, module examples, BMM agents

### Critical Persona Field Guidance Added (instructions.md +59 lines)
**The #1 issue in legacy agents** - comprehensive guidance on persona field separation:

- Explains how LLMs interpret each field:
  * role → "What knowledge/skills/capabilities do I possess?"
  * identity → "What background/experience/context shapes my responses?"
  * communication_style → "What verbal patterns/word choice do I use?"
  * principles → "What beliefs/philosophy drive my choices?"

- BEFORE/AFTER examples showing common mistakes
- Red flag word detection guide (ensures, experienced, believes in, etc.)
- Pure communication style examples from reference agents

### Enhanced Step 1: Analysis (instructions.md +57 lines)
- References all new comprehensive documentation
- **CRITICAL: Persona field separation analysis**
  * Checks for behaviors/role/identity mixed into communication_style
  * Compares against communication_presets for purity
  * Compares against reference agents for quality
- Warm, conversational feedback explaining issues found

### Massive Step 3 Enhancement: Communication Style Refinement (+122 lines)
**7-step prescriptive pattern for fixing the #1 quality issue:**

1. Diagnose Current Communication Style - red flag word detection
2. Extract Non-Style Content - working copy methodology
3. Discover TRUE Communication Style - interview questions + preset exploration
4. Craft Pure Communication Style - good/bad examples from references
5. Show Before/After With Full Context - complete transformation
6. Validate Against Standards - zero red flags, compare to presets/references
7. Confirm With User - explain changes, read dramatically, refine

Examples from actual reference agents:
- "Treats analysis like a treasure hunt - excited by every clue" (Mary/analyst)
- "Ultra-succinct. Speaks in file paths and AC IDs" (Amelia/dev)
- "Poetic drama and flair with every turn of a phrase" (commit-poet)

### Legacy Type Migration Pattern (+42 lines)
**Comprehensive guide for full/hybrid/standalone → Simple/Expert/Module migration:**

- Clear explanations of modern types (architecture, NOT capability)
- Migration patterns with decision tree
- Structural conversion guides (Simple ↔ Expert)
- Module = design intent clarification

### Enhanced Validation (Step 4)
- Persona field separation validation emphasized
- Updated success message with all quality standards
- Comprehensive checklist validation

### Complete README Documentation (200 lines created)
- Purpose emphasizing persona field separation as #1 issue
- 14 common editing scenarios (persona separation listed FIRST)
- Complete doc reference listing by category
- Dedicated "Critical: Persona Field Separation" section
- Red flag words guide
- 3 detailed usage scenarios
- Quality standards checklist

## 2. Expert Agent Sidecar File Support (NEW)

### Step 1: Smart Path Detection and Loading (+35 lines)
**Automatically detects and loads based on path type:**

```yaml
If path is .agent.yaml → Simple Agent (load single file)
If path is folder → Expert Agent:
  - Load .agent.yaml from inside folder
  - Load ALL sidecar files (*.md, *.txt, *.csv, *.json, *.yaml)
  - Create inventory for reference
  - Present: "Loaded agent.yaml + 5 sidecar files: [list]"
```

**Sidecar analysis:**
- Maps which menu items reference which sidecar files (tmpl="path", data="path")
- Checks if all sidecar references actually exist
- Identifies unused/orphaned sidecar files
- Assesses sidecar organization

**Warm expert agent feedback:**
"This is beautifully organized as an Expert agent! The sidecar files include 3 journal templates (daily, weekly, breakthrough) and a mood-patterns knowledge file. Your menu items reference them nicely. I do notice 'old-template.md' isn't referenced anywhere - we could clean that up."

### Step 3: Sidecar Editing Patterns (+47 lines)
**5 complete sidecar editing scenarios:**

1. **Updating templates** - Edit content, verify references work, test variables
2. **Adding new sidecar files** - Create file + add menu item with reference
3. **Removing unused sidecar files** - Confirm unused, ask to delete, clean references
4. **Reorganizing sidecar structure** - Move files, update ALL YAML references
5. **Updating knowledge base files** - Edit .csv/.json/.yaml data directly

**Critical mindset:** "Sidecar files are as much a part of the agent as the YAML!"

### Step 4: Sidecar Validation (+16 lines)
**Conversational validation:**
- "Your menu item 'daily-journal' references 'templates/daily.md'... checking... ✓ exists!"
- Check for orphaned files not referenced anywhere
- Verify sidecar file formats (YAML parses, CSV has headers, markdown well-formed)
- Success message: "✓ All sidecar file references valid - 5 sidecar files, all referenced correctly!"

### README Updates
- "What You'll Need" distinguishes Simple vs Expert paths
- Scenario 2b: Complete Expert agent editing example (journal-keeper template update)
- Updated common scenarios list

## 3. Unified Validation Checklist (Single Source of Truth)

### Problem Solved
- create-agent had outdated checklist (62 lines, no persona field separation)
- edit-agent had enhanced checklist (112 lines, with our improvements)
- Risk of drift and inconsistency between workflows

### Solution: agent-validation-checklist.md (160 lines)
**Canonical location:** `/src/modules/bmb/workflows/create-agent/`

**Comprehensive coverage combining best of both:**
- YAML structure validation
- **Persona field separation** (field separation check, purity check, quality benchmarking)
- Menu validation (including sidecar file path validation)
- Type-specific validation (Simple/Expert/Module)
- Compilation validation
- Common issues and fixes section

**Key sections:**
- Persona Validation (CRITICAL - #1 Quality Issue)
  * Field Separation Check (what belongs where)
  * Communication Style Purity Check (red flag word detection)
  * Quality Benchmarking (compare to presets and references)
- Expert Agent validation (9 sidecar-specific checks)
- Module Agent validation (design intent verification)
- Common Issues and Fixes (real examples with solutions)

### References Updated
**create-agent/workflow.yaml:**
```yaml
validation: "{installed_path}/agent-validation-checklist.md"
```

**edit-agent/workflow.yaml:**
```yaml
# Shared validation checklist (canonical location in create-agent folder)
validation: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-validation-checklist.md"
```

**edit-agent/instructions.md:**
```xml
<note>The validation checklist is shared between create-agent and edit-agent workflows to ensure consistent quality standards.</note>
```

### Files Changed
-  Created: agent-validation-checklist.md (160 lines)
-  Deleted: create-agent/checklist.md (62 lines)
-  Deleted: edit-agent/checklist.md (112 lines)
- Updated: Both workflow.yaml files to reference unified checklist

## Statistics

**Overall changes:** 6 files changed, +553 insertions, -264 deletions

**edit-agent enhancements:**
- instructions.md: +396 lines (comprehensive guidance)
- README.md: +213 lines (complete documentation)
- workflow.yaml: +32 lines (proper doc references)

**Validation unification:**
- Net result: Better quality, less duplication, easier maintenance
- Single source of truth for all agent validation

## Impact

### For Users Editing Agents
- Automatically detects and handles Expert agents with sidecar files
- Clear guidance on fixing #1 issue (persona field separation)
- 7-step prescriptive pattern for communication style refinement
- Warm, educational feedback throughout
- Validates against same standards as create-agent

### For Agent Quality
- Both create and edit workflows use same validation standards
- Persona field separation gets proper attention
- Expert agent sidecar files treated as first-class citizens
- Legacy agents can be migrated to modern standards
- All agents validated against reference implementations

### For Maintenance
- ONE checklist to maintain instead of two
- Consistent quality standards across workflows
- Documentation properly linked to new comprehensive guides
- No risk of checklist drift

This brings edit-agent to the same quality level as create-agent while adding critical Expert agent support and establishing single source of truth for validation.
2025-11-18 21:55:47 -06:00
Brian Madison
054b031c1d feat: Complete BMAD agent creation system with install tooling, references, and field guidance
## Overview
This commit represents a complete overhaul of the BMAD agent creation system, establishing clear standards for agent development, installation workflows, and persona design. The changes span documentation, tooling, reference implementations, and field-specific guidance.

## Key Components

### 1. Agent Installation Infrastructure
**New CLI Command: `agent-install`**
- Interactive agent installation with persona customization
- Supports Simple (single YAML), Expert (sidecar files), and Module agents
- Template variable processing with Handlebars-style syntax
- Automatic compilation from YAML to XML (.md) format
- Manifest tracking and IDE integration (Claude Code, Cursor, Windsurf, etc.)
- Source preservation in `_cfg/custom/agents/` for reinstallation

**Files Created:**
- `tools/cli/commands/agent-install.js` - Main CLI command
- `tools/cli/lib/agent/compiler.js` - YAML to XML compilation engine
- `tools/cli/lib/agent/installer.js` - Installation orchestration
- `tools/cli/lib/agent/template-engine.js` - Handlebars template processing

**Compiler Features:**
- Auto-injects frontmatter, activation, handlers, help/exit menu items
- Smart handler inclusion (only includes action/workflow/exec/tmpl handlers actually used)
- Proper XML escaping and formatting
- Persona name customization (e.g., "Fred the Commit Poet")

### 2. Documentation Overhaul
**Deleted Bloated/Outdated Docs (2,651 lines removed):**
- Old verbose architecture docs
- Redundant pattern files
- Outdated workflow guides

**Created Focused, Type-Specific Docs:**
- `src/modules/bmb/docs/understanding-agent-types.md` - Architecture vs capability distinction
- `src/modules/bmb/docs/simple-agent-architecture.md` - Self-contained agents
- `src/modules/bmb/docs/expert-agent-architecture.md` - Agents with sidecar files
- `src/modules/bmb/docs/module-agent-architecture.md` - Workflow-integrated agents
- `src/modules/bmb/docs/agent-compilation.md` - YAML → XML process
- `src/modules/bmb/docs/agent-menu-patterns.md` - Menu design patterns
- `src/modules/bmb/docs/index.md` - Documentation hub

**Net Result:** ~1,930 line reduction while adding MORE value through focused content

### 3. Create-Agent Workflow Enhancements
**Critical Persona Field Guidance Added to Step 4:**
Explains how the LLM interprets each persona field when the agent activates:

- **role** → "What knowledge, skills, and capabilities do I possess?"
- **identity** → "What background, experience, and context shape my responses?"
- **communication_style** → "What verbal patterns, word choice, quirks, and phrasing do I use?"
- **principles** → "What beliefs and operating philosophy drive my choices?"

**Key Insight:** `communication_style` should ONLY describe HOW the agent talks, not restate role/identity/principles. The `communication-presets.csv` provides 60 pure communication styles with NO role/identity/principles mixed in.

**Files Updated:**
- `src/modules/bmb/workflows/create-agent/instructions.md` - Added persona field interpretation guide
- `src/modules/bmb/workflows/create-agent/brainstorm-context.md` - Refined to 137 lines
- `src/modules/bmb/workflows/create-agent/communication-presets.csv` - 60 styles across 13 categories

### 4. Reference Agent Cleanup
**Removed install_config Personality Bloat:**
Understanding: Future installer will handle personality customization, so stripped all personality toggles from reference agents.

**commit-poet.agent.yaml** (Simple Agent):
- BEFORE: 36 personality combinations (3 enthusiasm × 3 depths × 4 styles) = decision fatigue
- AFTER: Single concise persona with pure communication style
- Changed from verbose conditionals to: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution."
- Reduction: 248 lines → 153 lines (38% reduction)

**journal-keeper.agent.yaml** (Expert Agent):
- Stripped install_config, simplified communication_style
- Shows proper Expert agent structure with sidecar files

**security-engineer.agent.yaml & trend-analyst.agent.yaml** (Module Agents):
- Added header comments explaining WHY Module Agent (design intent, not just location)
- Clarified: Module agents are designed FOR ecosystem integration, not capability-limited

**Files Updated:**
- `src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml`
- `src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml`
- `src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml`
- `src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml`

### 5. BMM Agent Voice Enhancement
**Gave all 9 BMM agents distinct, memorable communication voices:**

**Mary (analyst)** - The favorite! Changed from generic "systematic and probing" to:
"Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge. Asks questions that spark 'aha!' moments while structuring insights with precision."

**Other Notable Voices:**
- **John (pm):** "Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters."
- **Winston (architect):** "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works."
- **Amelia (dev):** "Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision."
- **Bob (sm):** "Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity."
- **Sally (ux-designer):** "Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair."

**Pattern Applied:** Moved behaviors from communication_style to principles, keeping communication_style as PURE verbal patterns.

**Files Updated:**
- `src/modules/bmm/agents/analyst.agent.yaml`
- `src/modules/bmm/agents/pm.agent.yaml`
- `src/modules/bmm/agents/architect.agent.yaml`
- `src/modules/bmm/agents/dev.agent.yaml`
- `src/modules/bmm/agents/sm.agent.yaml`
- `src/modules/bmm/agents/tea.agent.yaml`
- `src/modules/bmm/agents/tech-writer.agent.yaml`
- `src/modules/bmm/agents/ux-designer.agent.yaml`
- `src/modules/bmm/agents/frame-expert.agent.yaml`

### 6. Linting Fixes
**ESLint Compliance:**
- Replaced all `'utf-8'` with `'utf8'` (unicorn/text-encoding-identifier-case)
- Changed `variables.hasOwnProperty(varName)` to `Object.hasOwn(variables, varName)` (unicorn/prefer-object-has-own)
- Replaced `JSON.parse(JSON.stringify(...))` with `structuredClone(...)` (unicorn/prefer-structured-clone)
- Fixed empty YAML mapping values in sample files

**Files Fixed:**
- 7 JavaScript files across agent tooling (compiler, installer, commands, IDE integration)
- 1 YAML sample file

## Architecture Decisions

### Agent Types Are About Architecture, Not Capability
- **Simple:** Self-contained in single YAML (NOT limited in capability)
- **Expert:** Includes sidecar files (templates, docs, etc.)
- **Module:** Designed for BMAD ecosystem integration (workflows, cross-agent coordination)

### Persona Field Separation Critical for LLM Interpretation
The LLM needs distinct fields to understand its role:
- Mixing role/identity/principles into communication_style confuses the persona
- Pure communication styles (from communication-presets.csv) have ZERO role/identity/principles content
- Example DON'T: "Experienced analyst who uses systematic approaches..." (mixing identity + style)
- Example DO: "Systematic and probing. Structures findings hierarchically." (pure style)

### Install-Time vs Runtime Configuration
- Template variables ({{var}}) resolve at compile-time
- Runtime variables ({user_name}, {bmad_folder}) resolve when agent activates
- Future installer will handle personality customization, so agents should ship with single default persona

## Testing
- All linting passes (ESLint with max-warnings=0)
- Agent compilation tested with commit-poet, journal-keeper examples
- Install workflow validated with Simple and Expert agent types
- Manifest tracking and IDE integration verified

## Impact
This establishes BMAD as having a complete, production-ready agent creation and installation system with:
- Clear documentation for all agent types
- Automated compilation and installation
- Strong persona design guidance
- Reference implementations showing best practices
- Distinct, memorable agent voices throughout BMM module

Co-Authored-By: BMad Builder <builder@bmad.dev>
Co-Authored-By: Mary the Analyst <analyst@bmad.dev>
Co-Authored-By: Paige the Tech Writer <tech-writer@bmad.dev>
2025-11-18 21:55:47 -06:00
Alex Verkhovsky
7b7f984cd2 feat: Add Google Antigravity IDE installer (#938)
Implements installer for Google Antigravity IDE with flattened slash command
naming to match Antigravity's namespace requirements.

Key features:
- Flattened file naming (bmad-module-agents-name.md) for proper slash commands
- Subagent installation support (project-level or user-level)
- Module-specific injection configuration
- Agent, workflow, task, and tool command generation

Implementation:
- Added AntigravitySetup class extending BaseIdeSetup
- Extracted flattenFilename() to BaseIdeSetup for reuse across IDE handlers
- Uses .agent/workflows directory structure
- Supports both interactive and non-interactive configuration

Fixes:
- Proper namespace isolation: /bmad-module-agents-dev instead of /dev
- Prevents conflicts between modules with same agent names

Note: This installer shares 95% of its code with claude-code.js.
Future refactoring could extract common patterns to IdeWithSlashCommandsSetup
base class (see design documents for details).
2025-11-18 20:09:06 -06:00
Alex Verkhovsky
073597a8ff feat: Add project-specific installation option for Codex CLI (#937)
Add support for choosing between global and project-specific installation
locations for Codex CLI prompts with CODEX_HOME configuration instructions.

Changes:
- Add collectConfiguration() to prompt for installation location (default: global)
- Support global (~/.codex/prompts) and project-specific (<project>/.codex/prompts)
- Display OS-specific CODEX_HOME setup instructions before user confirms
- Update detect() and cleanup() to handle both installation locations

Installation options:
- Global: Simple, works immediately, but prompts reference specific .bmad path
- Project-specific: Requires CODEX_HOME, better for multi-project workflows
  - Unix/Mac: alias codex='CODEX_HOME="$PWD/.codex" codex'
  - Windows: codex.cmd wrapper with %~dp0
2025-11-18 18:48:32 -06:00
Brian Madison
0ca164de34 chore: release v6.0.0-alpha.10
Major milestone: Epics & Stories now generated AFTER Architecture
- New Frame Expert agent with Excalidraw workflows
- Time estimate prohibition across all workflows
- Platform-specific command filtering (ide-only/web-only)
- Agent customization enhancement (prompts & memories)
- Workflow configuration standardization
2025-11-16 00:52:51 -06:00
fxomo
f38905628a Fix: Add prompts and memories merging from customize.yaml (#889)
- Add merging logic for customizeYaml.prompts and customizeYaml.memories in loadAndMergeAgent()
- Implement buildMemoriesXml() method to output memories XML section
- Update buildPromptsXml() to use <content> wrapper instead of CDATA for better compatibility
- Integrate memories output into convertToXml() between persona and prompts sections

Changes:
1. Line 123-131: Added prompts and memories append logic in loadAndMergeAgent()
2. Line 215-218: Added memories XML output in convertToXml()
3. Line 286-301: New buildMemoriesXml() method
4. Line 312-315: Updated prompts to use <content> wrapper for consistency

This allows users to customize agents via bmad/_cfg/agents/*.customize.yaml with:
- prompts: Array of {id, content} objects for action handlers
- memories: Array of strings for persistent agent memories
2025-11-16 00:36:32 -06:00
Brian Madison
6f7e9f0653 refactor: Major v6 epic creation improvements and documentation overhaul
## Key Changes

### 1. Epic Creation Workflow Enhancements
- Added user-value focused epic structure principles (NO technical layer breakdown)
- Implemented multi-mode detection: CONTINUE, REPLACE, or UPDATE existing epics
- Added comprehensive anti-pattern examples showing wrong vs right epic breakdown
- Epics now created AFTER architecture for technically-informed story breakdown
- Added checkpoint protocol for interactive workflow progression

### 2. Removed Deprecated Solutioning Gate Check
- Deleted entire solutioning-gate-check workflow (682 lines)
- Replaced by new implementation-readiness workflow
- Cleaner separation of concerns in solutioning phase

### 3. PRD Template Simplification
- Removed hardcoded "Implementation Planning", "References", and "Next Steps" sections
- PRD now focuses purely on requirements, not workflow orchestration
- Epics/stories created as separate step after architecture

### 4. Documentation Overhaul (15+ docs updated)
- Updated quick-start guide with v6 workflow sequence
- Clarified that epics are created AFTER architecture, not during PRD
- Updated solutioning docs to reflect implementation-readiness pattern
- Improved agents-guide, brownfield-guide, enterprise docs
- Enhanced glossary, FAQ, and workflow reference documentation

### 5. Workflow Path Adjustments
- All 4 paths updated (enterprise/method × brownfield/greenfield)
- Version bumps across BMGD, BMM, and CIS workflow YAMLs
- Minor instruction file updates for consistency

### Files Changed
- 65 files total: 468 insertions, 978 deletions (net reduction of 510 lines)
- 4 files deleted (entire solutioning-gate-check workflow)
- 1 new directory added (implementation-readiness placeholder)
2025-11-16 00:23:47 -06:00
Brian Madison
5980e41a28 feat: Add ide-only and web-only menu item filtering for platform-specific commands
## Summary
- Add ide-only and web-only boolean fields to agent menu schema
- Filter menu items based on build target (web bundle vs local IDE)
- Update BMM agent definitions with platform restrictions and improved descriptions
- Update frame-expert agent icon to 📐 and add webskip flag

## Changes

### Schema & Bundler Updates
- tools/schema/agent.js: Add ide-only and web-only optional boolean fields
- tools/cli/lib/yaml-xml-builder.js: Filter ide-only items from web bundles
- tools/cli/lib/xml-handler.js: Pass forWebBundle flag through build chain

### Agent Updates
- frame-expert: Change icon to 📐, add webskip flag, improve principle formatting
- pm: Mark workflow-init and correct-course as ide-only, advanced-elicitation as web-only
- ux-designer: Rename trigger to create-ux-design, mark advanced-elicitation as web-only
- sm: Rename triggers for consistency (story-context → create-story-context)
- analyst: Add research workflow after brainstorm, mark advanced-elicitation as web-only
- architect: Remove document field from validate-architecture, add web-only flag
- dev: Update persona and critical actions for clarity
- tech-writer: Add party-mode workflow, mark advanced-elicitation as web-only
- tea: Mark advanced-elicitation as web-only
- All agents: Standardize party-mode description

This enables platform-specific functionality where some commands only make sense
in IDE environments (workflow-init) or web interfaces (advanced-elicitation).
2025-11-15 19:39:53 -06:00
mrsaifullah52
05ccd1904c Feature/frame expert agent #890 (#905)
* feat: add frame-expert agent definition

- Add frame-expert.agent.yaml with persona and workflow menu
- Agent specializes in Excalidraw visual representations
- Supports flowcharts, diagrams, dataflows, and wireframes

Closes #890

* feat: add frame-expert workflows and shared resources

- Add 4 workflows: create-flowchart, create-diagram, create-dataflow, create-wireframe
- Include shared Excalidraw helpers, library, templates, and validation
- Each workflow has instructions, checklist, and workflow.yaml

Related to #890

* feat: register frame-expert workflows in manifest

- Add create-flowchart workflow entry
- Add create-diagram workflow entry
- Add create-dataflow workflow entry
- Add create-wireframe workflow entry

Related to #890

* feat: integrate frame-expert into team configurations

- Add frame-expert to default-party.csv with full agent details
- Add frame-expert to team-fullstack.yaml agent list
- Frame-expert now available in fullstack team workflows

Related to #890
2025-11-15 09:39:46 -06:00
Brian Madison
f14014f0c7 refactor: Major workflow enhancements - time estimates prohibition, progressive epic creation, and workflow simplification
## Key Changes

### 1. Time Estimate Prohibition (All Modules)
- Added critical warnings against providing ANY time estimates (hours/days/weeks/months)
- Acknowledges AI has fundamentally changed development speed
- Applied to 33 workflow instruction files across BMB, BMGD, BMM, and CIS modules
- Updated workflow creation guide with prohibition guidelines

### 2. Enhanced Epic Creation Workflow
- Added intelligent UPDATE vs CREATE mode detection
- Detects available context (UX, Architecture, Domain brief, Product brief)
- Progressive enhancement: creates basic epics, then enriches with UX/Architecture
- Living document approach with continuous updates
- Added 305 lines of sophisticated workflow logic

### 3. Workflow Status Initialization Refactoring
- Simplified from 893 to 318 lines (65% reduction)
- Streamlined state detection: CLEAN, PLANNING, ACTIVE, LEGACY, UNCLEAR
- Cleaner path selection and initialization logic
- Removed redundant complexity while maintaining functionality

### 4. Workflow Path Updates
- Updated all 4 workflow paths (enterprise/method × brownfield/greenfield)
- Added multiple optional epic creation steps at different phases:
  - After PRD (basic structure)
  - After UX Design (with interaction context)
  - After Architecture (final with full context)
- Changed PRD output description from "with epics and stories" to "with FRs and NFRs"

### 5. Architecture & Innovation Updates
- Made epics input optional in architecture workflow (falls back to PRD FRs)
- Updated innovation strategy phases to remove time-based language
- Phases now: Immediate Impact → Foundation Building → Scale & Optimization

### Files Changed
- 33 instruction files updated with time estimate prohibition
- 2 workflow.yaml files updated (create-epics-and-stories, architecture)
- 4 workflow path YAML files updated
- 1 workflow creation guide enhanced

This refactor significantly improves workflow intelligence, removes harmful time-based planning assumptions, and creates more adaptive, context-aware workflows that better leverage AI capabilities.
2025-11-14 23:54:29 -06:00
Brian Madison
3223975fd0 Summary of changes:
- Removed 32 recommended_inputs: sections
  - Added description: fields to all input_file_patterns (25 workflows)
  - Added missing load_strategy fields (5 workflows)
  - Fixed BMB workflows with proper reference doc variables
  - Updated BMB instructions to use new variables
2025-11-14 20:43:15 -06:00
Brian Madison
3f283066b1 removed items from source that should not be included 2025-11-14 11:29:57 -06:00
Brian Madison
70a642318d prd updated to properly use the project-types csv 2025-11-14 08:06:19 -06:00
Brian Madison
e6b4f3f051 update doc 2025-11-14 07:10:01 -06:00
Brian Madison
7208610db8 web bundler fixes 2025-11-13 22:10:49 -06:00
Brian Madison
aa4c7e4446 web bundle links updated in docs 2025-11-13 20:17:20 -06:00
Brian Madison
face4e4367 resolved blocking issues when folder name is changed during install 2025-11-13 20:17:20 -06:00
Daniel Dabrowski
4aed5a1193 fix: update file paths in agent and workflow configurations to use {bmad_folder} variable (#917) 2025-11-13 19:44:12 -06:00
Anton Lvovych
94d01961f3 fix(shard-doc): use proper command for markdown-tree-parser (#911) 2025-11-13 18:23:54 -06:00
Brian Madison
1a52a19978 chore: bump version to 6.0.0-alpha.9 2025-11-12 22:59:52 -06:00
Brian Madison
6d14147c26 docs: add comprehensive changelog for v6.0.0-alpha.9 release
- Document workflow engine revolution with intelligent file discovery protocol
- Highlight track-based project system replacing Level 0-4 terminology
- Detail unified folder structure and ephemeral folder removal
- Include migration notes for users upgrading from alpha.8
- Emphasize sprint-artifacts location changes and backward compatibility
2025-11-12 22:59:07 -06:00
Brian Madison
15a94a94b6 accept a story status of review or ready-for-review, treat them the same. 2025-11-12 22:46:48 -06:00
Brian Madison
b63bf9d067 installer update to quick install and agent rebuild 2025-11-12 22:40:45 -06:00
Brian Madison
8f57effda4 clean up of hardcoded stale configurable paths 2025-11-12 20:46:47 -06:00
Brian Madison
1868477238 refactor(config): replace hardcoded .bmad paths with {bmad_folder} placeholder
Remove hardcoded .bmad folder references throughout documentation and source files, replacing them with the configurable {bmad_folder} placeholder. This change enables users to customize the BMAD installation folder name via configuration, improving flexibility and reducing coupling to a specific directory structure.

Changes include:
- Update all documentation to reference {bmad_folder} instead of .bmad
- Remove legacy configuration files from .bmad and .claude directories
- Update workflow.xml and CLI documentation with new placeholder syntax
2025-11-12 20:22:47 -06:00
Brian Madison
48cf5c8056 feat(workflows): Implement intelligent file discovery protocol and Phase 4 BMGD workflows
## Core Workflow Engine Enhancements

### discover_inputs Protocol (MAJOR)
- Added reusable `discover_inputs` protocol to workflow.xml for intelligent file loading
- Supports three loading strategies:
  - FULL_LOAD: Load all shards for PRD, Architecture, UX (changed pattern from /index.md to /*/*.md)
  - SELECTIVE_LOAD: Load specific shard via template variable (e.g., epic-{{epic_num}}.md)
  - INDEX_GUIDED: Load index, analyze TOC, intelligently load relevant docs (with "DO NOT BE LAZY" mandate)
- Auto-discovers whole vs sharded documents with proper fallback
- Provides transparent reporting of loaded content with file counts
- Invoked via <invoke-protocol name="discover_inputs" /> tag in workflow instructions

### Advanced Elicitation Improvements
- Renamed adv-elicit.xml to advanced-elicitation.xml for clarity
- Updated all references across agents and commands

### Shard Document Tool Enhancement
- Added Step 6: Handle Original Document with three options:
  - [d] Delete - Remove original (recommended, prevents confusion)
  - [m] Move to archive - Backup original to archive folder
  - [k] Keep - Warning about defeating sharding purpose
- Prevents issue where both whole and sharded versions exist, confusing discover_inputs protocol

## BMM Module - Input File Pattern Standardization

### Phase 1 - Analysis (1 workflow)
- product-brief: Added load_strategy (FULL_LOAD for research/brainstorming, INDEX_GUIDED for document_project)
- Updated instructions.md to use invoke-protocol, replaced manual fuzzy matching

### Phase 2 - Planning (4 workflows)
- prd: Added load_strategy, updated instructions to reference {product_brief_content}, {research_content}
- create-ux-design: Added load_strategy, removed fuzzy matching from instructions
- tech-spec: Added load_strategy for brownfield context discovery
- All epics patterns updated to support SELECTIVE_LOAD for specific epic shards

### Phase 3 - Solutioning (2 workflows)
- architecture: Added load_strategy, updated instructions to use pre-loaded {prd_content}, {epics_content}, {ux_design_content}
- solutioning-gate-check: Added load_strategy, replaced manual discovery with protocol invocation

### Phase 4 - Implementation (8 workflows)
- code-review: Added load_strategy, fixed sharded patterns to /*/*.md, added step 1.5 for protocol
- correct-course: Added complete input_file_patterns section (was missing), added step 0.5
- create-story: Added load_strategy, updated to SELECTIVE_LOAD for epics, added step 1.5
- dev-story: Added complete input_file_patterns section (was missing), added step 0.5
- epic-tech-context: Added load_strategy, updated PRD extraction to use {prd_content}, added step 1.5
- retrospective: Added load_strategy for architecture/prd (FULL_LOAD), epics (SELECTIVE_LOAD), added step 0.5
- sprint-planning: Fixed sharded pattern to load ALL epics (/*/*.md), added step 0.5
- story-context: Added load_strategy, updated doc collection to reference pre-loaded content, added step 1.5

### Sprint Artifacts Path Corrections
- story-done: Added missing sprint_artifacts variable, fixed sprint_status path from {context_dir} to {sprint_artifacts}
- story-ready: Added missing sprint_artifacts variable
- story-context: Fixed undefined {context_dir} -> {sprint_artifacts}
- correct-course: Added sprint_artifacts and sprint_status variables

## BMGD Module - Phase 4 Production Workflows (NEW)

Added complete Phase 4 implementation workflows for game development:
- code-review: Senior developer review for completed game features
- correct-course: Sprint change management for game projects
- create-story: Story generation for game mechanics/features
- dev-story: Feature implementation workflow
- epic-tech-context: Technical spec generation per game epic
- retrospective: Epic completion review and lessons learned
- sprint-planning: Game development sprint status tracking
- story-context: Dynamic context assembly for game stories
- story-done: Story completion workflow
- story-ready: Story readiness workflow

All BMGD workflows follow BMM patterns with game-specific adaptations.

## Agent Updates

### BMM Agents
- Updated all 7 BMM agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer)
- Standardized web bundle configurations

### BMGD Agents
- Updated 4 game development agents (game-architect, game-designer, game-dev, game-scrum-master)
- Aligned with BMM agent structure

### CIS Agents
- Updated 5 creative intelligence agents for consistency

## Documentation & Configuration

- Updated CHANGELOG.md with Phase 4 workflow additions
- Updated files-manifest.csv and task-manifest.csv
- Updated .claude commands for all agents
- Fixed formatting issues from previous commits

## Breaking Changes

NONE - All changes are backward compatible. Workflows without input_file_patterns continue to work.
Workflows with input_file_patterns now benefit from intelligent auto-loading.

## Migration Notes

Existing workflows can gradually adopt discover_inputs protocol by:
1. Adding load_strategy to existing input_file_patterns in workflow.yaml
2. Adding <invoke-protocol name="discover_inputs" /> step in instructions.md
3. Replacing manual file loading with references to {pattern_name_content} variables
2025-11-12 19:18:38 -06:00
Brian Madison
8f7d259c81 remaining bad character removal 2025-11-11 20:10:33 -06:00
Brian Madison
74f54a088a removed some bad formatting that was injected previously 2025-11-11 17:30:43 -06:00
Brian Madison
4d745532aa refactor(tech-spec): unify story generation and adopt intent-based approach
Major refactoring of tech-spec workflow for quick-flow projects:

## Unified Story Generation
- Consolidated instructions-level0-story.md and instructions-level1-stories.md into single instructions-generate-stories.md
- Always generates epic + stories (minimal epic for 1 story, detailed for multiple)
- Consistent naming: story-{epic-slug}-N.md for all stories (1-5)
- Eliminated branching logic and duplicate code

## Intent-Based Intelligence
- Removed 150+ lines of hardcoded stack detection examples (Node.js, Python, Ruby, Java, Go, Rust, PHP)
- Replaced prescriptive instructions with intelligent guidance that trusts LLM capabilities
- PHASE 2 stack detection now adapts to ANY project type automatically
- Step 2 discovery changed from scripted Q&A to adaptive conversation goals

## Terminology Updates
- Replaced "Level 0" and "Level 1" with "quick-flow" terminology throughout
- Updated to "single story" vs "multiple stories (2-5)" language
- Consistent modern terminology across all files

## Variable and Structure Improvements
- Fixed variable references: now uses {instructions_generate_stories} instead of hardcoded paths
- Updated workflow.yaml with cleaner variable structure
- Removed unused variables (project_level, development_context)
- Added story_count and epic_slug runtime variables

## Files Changed
- Deleted: instructions-level0-story.md (7,259 bytes)
- Deleted: instructions-level1-stories.md (16,274 bytes)
- Created: instructions-generate-stories.md (13,109 bytes)
- Updated: instructions.md (reduced from 35,028 to 32,006 bytes)
- Updated: workflow.yaml, checklist.md

## Impact
- 50% fewer workflow files (3 → 1 for story generation)
- More adaptable to any tech stack
- Clearer, more maintainable code
- Better developer and user experience
- Trusts modern LLM intelligence instead of constraining with examples
2025-11-11 17:30:43 -06:00
Brian Madison
2d99833b9e feat: Add documentation guides, simplify folder structure, and major workflow refactoring
Created two comprehensive guides for v6 features:

**docs/agent-customization-guide.md**
- Complete guide for customizing agent names, personas, memories, and behaviors
- Update-safe customization via bmad/_cfg/agents/ configuration files
- Real-world examples (TDD setup, multilingual agents, custom workflows)
- Troubleshooting and best practices

**docs/web-bundles-gemini-gpt-guide.md**
- Comprehensive guide for using BMad agents in Gemini Gems and Custom GPTs
- Critical setup rules with exact configuration text required
- Cost-saving strategy: web planning → local implementation (60-80% savings)
- Platform comparison (Gemini Gems strongly recommended over Custom GPTs)
- Complete workflow examples showing full planning-to-implementation cycle
- Team bundle guidance (Gemini 2.5 Pro+ only)

**README.md updates**
- Added prominent links in v6 Core Enhancements section
- Created new "Customization & Sharing" documentation category
- Web Bundles feature highlighted with direct guide link

**Unified output folder structure across all modules:**

**Before (confusing):**
- output_folder: Main docs
- game_design_docs: Separate design folder
- tech_docs: Separate technical folder
- dev_ephemeral_location: Separate ephemeral folder outside docs

**After (simplified):**
- output_folder: Single location for ALL AI-generated artifacts (default: "docs")
  - Clearer prompt: "Where should AI Generated Artifacts be saved?"
- sprint_artifacts: Phase 4 ephemeral content now WITHIN output_folder
  - BMM: {output_folder}/stories (stories, context, reports)
  - BMGD: {output_folder}/sprint-artifacts
  - No longer in separate {bmad_folder}-ephemeral location

**Benefits:**
- One clear location for all planning artifacts (PRD, Architecture, UX, etc.)
- Phase 4 ephemeral items logically grouped within output folder
- Eliminated confusing separate folder proliferation
- sprint_artifacts now configurable per module

**Files changed:**
- src/core/_module-installer/install-config.yaml
- src/modules/bmm/_module-installer/install-config.yaml
- src/modules/bmgd/_module-installer/install-config.yaml

**Also cleaned up BMGD config:**
- Renamed: specified_framework → primary_platform (clearer naming)
- Removed: unused data_path variable

Replaced old "project_level" (0-4) system with new "selected_track" terminology:
- **quick-flow**: Bug fixes and small features (replaces Level 0-1)
- **bmad-method**: Full planning track (replaces Level 2-3)
- **enterprise-bmad-method**: Extended planning (replaces Level 4)

**Core workflow updates:**
- solutioning-gate-check: Complete rewrite of validation logic for track-based artifacts
- architecture: Updated context detection, error handling, and messaging for tracks
- workflow-init: Updated artifact detection patterns for track-based paths
- All workflow status paths updated (method-greenfield, method-brownfield, enterprise-*)

Unified variable naming conventions across all workflows:
- {output_folder} → {output-folder} (hyphenated format)
- {dev_ephemeral_location} → {sprint_artifacts} (clearer purpose)
- Hardcoded status file paths → {workflow_status_file} variable

Fixed corrupted variable patterns throughout workflow files:
- {output*folder} → {output-folder}
- {ephemeral*location} → {sprint_artifacts}
- \_prd* → *prd* (escaped underscore artifacts)
- **\*\***\_\_\_**\*\*** → proper field placeholders

Affected patterns included malformed glob patterns, template variables, and markdown formatting artifacts from previous edits.

**Architecture workflow (create-architecture):**
- Fixed: "Decision Architecture" → "Create Architecture" (consistent naming)
- Improved PRD not found handling with exit/continue options
- Better user guidance when running standalone vs. within workflow path
- Removed hardcoded Level checks, now track-aware
- Enhanced validation checklist formatting (□ → - [])
- Typo fixes: "mulitple" → "multiple"

**Solutioning gate check:**
- Complete validation logic rewrite for track-based system
- Removed Level-specific artifact expectations
- Simplified document discovery (track determines what exists)
- Better analysis prompts and user feedback

**Workflow-init:**
- Updated artifact detection patterns for new folder structure
- Fixed corrupt glob patterns throughout
- Better sprint_artifacts location detection
- Improved workflow path assignment logic

**Various workflows:**
- Consistent variable naming across 40+ workflow files
- Improved error messages and user guidance
- Better markdown formatting (checkboxes, lists)
- Removed redundant validation criteria files (now inline)

Removed duplicate BMGD 4-production workflows (12 workflows):
- code-review, correct-course, create-story, dev-story
- epic-tech-context, retrospective, sprint-planning
- story-context, story-done, story-ready

**Why:** BMGD now uses shared BMM Phase 4 implementation workflows
**Benefit:** Single source of truth, no duplication to maintain

Also removed:
- validation-criteria.yaml (validation now inline in instructions)
- architecture-patterns.yaml references (patterns now managed differently)
- AUDIT-REPORT.md files (stale audit artifacts)

**BMB workflows:**
- Updated checklists for workflow and module creation
- Improved agent architecture documentation
- Minor instruction clarifications

**Core brainstorming workflow:**
- Updated README with usage examples
- Enhanced instructions and template clarity
- Better integration with other modules

**BMM installer:**
- Updated for track-based system
- sprint_artifacts configuration

**Tech Writer agent:**
- Minor configuration update for documentation workflows

Removed 200+ files that should not be in repository:
- Installed agent markdown files (analyst, architect, dev, pm, sm, tea, etc.)
- Complete workflow instruction copies
- Documentation duplicates (quick-start, agents-guide, workflows-*)
- Test architecture knowledge base (22 files, 14,000+ lines)
- Configuration files (config.yaml, team definitions)

These are generated during installation and should not be version controlled.

Removed 21 pre-generated XML bundles:
- BMM agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer)
- BMGD agents (game-architect, game-designer, game-dev, game-scrum-master)
- CIS agents (brainstorming-coach, creative-problem-solver, etc.)
- Team bundles (team-fullstack, team-gamedev, creative-squad)

**Why:** Users should generate fresh bundles via `npm run bundle` to get latest changes and customizations.

- **2 new documentation files** (comprehensive guides)
- **98 source files modified** (299 insertions, 6,567 deletions)
- **3 installer config files simplified** (major folder structure improvement)
- **200+ .bmad/ artifacts removed** (should not be in repo)
- **21 web-bundle files removed** (users regenerate as needed)
- **12 duplicate workflows removed** (BMGD consolidation)
- **40+ workflows updated** (track system, variable standardization, corruption fixes)
2025-11-11 17:30:43 -06:00
Murat K Ozcan
280652566c chore: fixed directory browsing + zip Downloads (#902)
Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-11 16:48:03 -06:00
Murat K Ozcan
2ae99135a2 chore: fix bundle urls (#901)
Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-11 16:37:03 -06:00
Murat K Ozcan
449b5b3d29 chore: github pages for web bundle (#898)
* chore: github pages for web bundle

* docs: updated Bundle distribution setup

* chore: addressed PR comments

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-11 13:35:30 -06:00
Murat K Ozcan
487d1582a0 feat: test design for architecture level (phase 3) (#897)
* feat: test design for architecture level (phase 3)

* addressed review comments

---------

Co-authored-by: Murat Ozcan <murat@Murats-MacBook-Pro.local>
Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-11 10:03:00 -06:00
Brian Madison
03fbd2ae24 Release v6.0.0-alpha.8
## Installation Path Enhancements
- **Configurable Installation Directory**: Users can now specify custom installation directories during setup
- **New Default Location**: Changed default installation to `.bmad` (hidden directory) for cleaner project organization
- **Ephemeral File Handling**: Updated phase 4 implementation to use ephemeral file locations for better artifact organization

## CLI & Agent Loading Improvements
- **Optimized Agent Loading**: CLI commands now load from installed agent files, eliminating duplication
- **Installer UX Improvements**: Enhanced installer interface with version display
- **VS Code Integration**: Updated settings for new `.bmad` directory structure

## Web Bundle Enhancements
- **Party Mode Support**: All web bundles (single agent and team) now include party mode for multi-agent collaboration
- **Advanced Elicitation**: Integrated advanced elicitation capabilities into standalone agents
- **Expanded Agent Bundles**: New web bundle outputs for all agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer, game-*, creative-squad)
- **Team Customization**: Added default-party.csv files to bmm, bmgd, and cis modules with customizable party configurations

## Phase 4 Workflow Updates (In Progress)
- **Artifact Separation**: Initiated separation of phase 4 implementation artifacts from documentation
- **Dedicated Artifact Path**: Phase 4 items (stories, code review, sprint plan, context files) moving to dedicated location outside docs folder
- **Updated Workflows**: Modified workflow.yaml files for code-review, sprint-planning, story-context, epic-tech-context, and retrospective workflows
- **Configuration Support**: Added installer questions for artifact path selection

## IDE Integration
- **Gemini TOML**: Improved with clear loading instructions using @ commands
- **Centralized Templates**: Agent launcher markdown files now use centralized critical indication templates
- **GitHub Copilot**: Updated tool names to match official VS Code documentation (November 2025)

## Bug Fixes
- Fixed duplicate manifest entries by deduplicating module lists using Set
- Cleaned up legacy bmad/, bmd/, and web-bundles directories
- Various improvements to phase 4 workflow artifact handling

## Additional Changes
- New agent and action command header models for standardization
- Enhanced web-bundle-activation-steps fragment
- Updated web-bundler.js to support new structure
- Improved party mode instructions and workflow orchestration
2025-11-09 23:24:25 -06:00
Brian Madison
665e140638 more updates to use ephemeral file location for phase 4 items 2025-11-09 23:17:29 -06:00
Brian Madison
f49a4731e7 agents now are not duplicated and isntead cli commmands load from installed agent files 2025-11-09 20:24:56 -06:00
Brian Madison
7eb52520fa Major Enhancements:
- Installation path is now fully configurable, allowing users to specify custom installation directories during setup
  - Default installation location changed to .bmad (hidden directory) for cleaner project root organization

    Web Bundle Improvements:

    - All web bundles (single agent and team) now include party mode support for multi-agent collaboration!
    - Advanced elicitation capabilities integrated into standalone agents
    - All bundles enhanced with party mode agent manifests
    - Added default-party.csv files to bmm, bmgd, and cis module teams
    - The default party file is what will be used with single agent bundles. teams can customize for different party configurations before web bundling through a setting in the team yaml file
    - New web bundle outputs for all agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer, game-*, creative-squad)

    Phase 4 Workflow Updates (In Progress):

    - Initiated shift to separate phase 4 implementation artifacts from documentation
        - Phase 4 implementation artifacts (stories, code review, sprint plan, context files) will move to dedicated location outside docs folder
        - Installer questions and configuration added for artifact path selection
        - Updated workflow.yaml files for code-review, sprint-planning, story-context, epic-tech-context, and retrospective workflows to support this, but still might require some udpates

    Additional Changes:

    - New agent and action command header models for standardization
    - Enhanced web-bundle-activation-steps fragment
    - Updated web-bundler.js to support new structure
    - VS Code settings updated for new .bmad directory
    - Party mode instructions and workflow enhanced for better orchestration

   IDE Installer Updates:

    - Show version number of installer in cli
    - improved Installer UX
    - Gemini TOML Improved to have clear loading instructions with @ commands
    - All tools agent launcher mds improved to use a central file template critical indication isntead of hardcoding in 2 different locations.
2025-11-09 17:39:05 -06:00
Brian Madison
fd2521ec69 customize installation folder for the bmad content 2025-11-08 15:19:19 -06:00
Brian Madison
1728acfb0f The install directory is now configurable, with a few minute issues 2025-11-08 13:58:43 -06:00
Brian Madison
a4bbfc4b6e fix: Prevent duplicate manifest entries and update GitHub Copilot tool names
- Deduplicate module lists in manifest generator using Set to prevent duplicate entries in installed manifests
- Update GitHub Copilot tool names to match official VS Code documentation (November 2025)
- Clean up legacy bmad/, bmd/, and web-bundles directories
2025-11-08 01:06:09 -06:00
Brian Madison
61955e8e96 release: bump to v6.0.0-alpha.7 2025-11-07 00:50:04 -06:00
Brian Madison
03d757292b fix: Add missing adv-elicit-methods.csv to workflow bundles
- Add adv-elicit-methods.csv dependency to all workflows using adv-elicit.xml
  - architecture workflow
  - prd workflow
  - tech-spec workflow
- Include BMM web bundles (8 agents + team-fullstack)
- Update v6 open items list

This fixes runtime failures when advanced elicitation is invoked in bundled
workflows by ensuring the 39 elicitation methods CSV is properly included.

Note: Web bundler still has optimizations and known issues to address in
upcoming commits.
2025-11-07 00:38:28 -06:00
Brian Madison
91302d9c7a claude and a few other ide tools installation fix to not add a readme file slash comand regression, and cleanup bmad folders in tools on install 2025-11-06 22:45:29 -06:00
Murat K Ozcan
1343859874 chore: CC PR review with GH token (#874)
* chore: CC PR review with GH token

* debug CC output

* turn off CC output

* turn off CC PR review

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-06 13:05:36 -06:00
Brian Madison
8ed4a548ea web bundler improvements part 1 2025-11-05 23:54:04 -06:00
Brian Madison
80a04bfce3 fix: Remove menu items for workflows with web_bundle: false
Enhanced removeSkippedWorkflowCommands() to properly remove all menu item
formats that reference workflows with web_bundle: false:

1. <item> tags with workflow attribute
2. <item> tags with run-workflow attribute
3. <c> tags with run-workflow attribute (legacy)

This ensures that workflows not designed for web bundles (like workflow-status
which requires filesystem access) are completely excluded from web bundles,
including their menu items.

Verified:
- workflow-status menu item removed from SM agent
- workflow-status YAML not included in bundle dependencies
2025-11-05 21:33:59 -06:00
Brian Madison
9a37cbb7fc fix: Show positive message when no missing dependencies
Instead of displaying an empty "⚠ Missing Dependencies by Agent:" section
when all dependencies are resolved, now shows a positive message:
"✓ No missing dependencies"

This improves the user experience by providing clear feedback that workflow
vendoring successfully resolved all dependencies.
2025-11-05 21:10:18 -06:00
Brian Madison
281eac3373 feat: Add workflow vendoring to web bundler
The web bundler now performs workflow vendoring before bundling agents,
similar to the module installer. This ensures that workflows referenced
via workflow-install attributes are copied from their source locations
to their destination locations before the bundler attempts to resolve
and bundle them.

Changes:
- Added vendorCrossModuleWorkflows() method to WebBundler class
- Added updateWorkflowConfigSource() helper method
- Integrated vendoring into bundleAll(), bundleModule(), and bundleAgent()
- Workflows are vendored before agent discovery and bundling
- Config_source is updated in vendored workflows to reference target module

This fixes missing dependency warnings for BMGD agents that vendor
BMM workflows for Phase 4 (Production) workflows.
2025-11-05 21:05:08 -06:00
Brian Madison
f84e18760f feat: Extract BMGD module and implement workflow vendoring
This commit extracts game development functionality from BMM into a standalone
BMGD (BMad Game Development) module and implements workflow vendoring to enable
module independence.

BMGD Module Creation:
- Moved agents: game-designer, game-dev, game-architect from BMM to BMGD
- Moved team config: team-gamedev
- Created new Game Dev Scrum Master agent using workflow vendoring pattern
- Reorganized workflows into industry-standard game dev phases:
  * Phase 1 (Preproduction): brainstorm-game, game-brief
  * Phase 2 (Design): gdd, narrative
  * Phase 3 (Technical): game-architecture
  * Phase 4 (Production): vendored from BMM workflows
- Updated all module metadata and config_source references

Workflow Vendoring Feature:
- Enables modules to copy workflows from other modules during installation
- Build-time process that updates config_source in vendored workflows
- New agent YAML attribute: workflow-install (build-time metadata)
- Final compiled agents use workflow-install value for workflow attribute
- Implementation in module manager: vendorCrossModuleWorkflows()
- Allows standalone module installation without forced dependencies

Technical Changes:
- tools/cli/lib/yaml-xml-builder.js: Use workflow-install for workflow attribute
- tools/cli/installers/lib/modules/manager.js: Add vendoring functions
- tools/schema/agent.js: Add workflow-install to menu item schema
- Updated 3 documentation files with workflow vendoring details

BMM Workflow Updates:
- workflow-status/init: Added game detection checkpoint
- workflow-status/paths/game-design.yaml: Redirect to BMGD module
- prd/instructions.md: Route game projects to BMGD
- research/instructions-market.md: Reference BMGD for game development

Documentation:
- Created comprehensive BMGD module README
- Added workflow vendoring documentation
- Updated BMB agent creation and module creation guides
2025-11-05 20:44:22 -06:00
Murat K Ozcan
bc76d25be6 chore: added CC PR review (#871)
* chore: added CC PR review

* remove CLAUDE.md

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-05 14:14:31 -06:00
Murat K Ozcan
c20ead1acb refactor: update TEA documentation to align with BMad 4-phase methodology (#870)
* refactor: update TEA documentation to align with BMad 4-phase methodology

* reafactor: address review comments

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-05 13:37:51 -06:00
Brian Madison
6fa6ebab12 More document Updtes and diagram improvements 2025-11-05 07:52:08 -06:00
Brian Madison
412a7d1ed8 release: bump to v6.0.0-alpha.6
Bug Fixes:
- Fix manifestPath error in ide-config-manager causing installation failures
- Fix installer option display to show full labels instead of just values for single/multi-select
- Add conditional documentation installation - users can now opt out of installing docs

Improvements:
- Add install_user_docs configuration option (defaults to true)
- Improve config question display with descriptive labels for better UX
- Update CONTRIBUTING.md to remove references to non-existent 'next' branch

Maintenance:
- Closed 54 legacy v4 issues (older than 1 month) to maintain clean issue tracker
2025-11-04 22:28:28 -06:00
Brian Madison
f8ba15c6f8 installer doc install option for bmad method module - user can opt to not install all the docs to the destination installation path 2025-11-04 22:17:12 -06:00
Brian Madison
1f0dfe05e4 windows powershell install fix 2025-11-04 21:58:41 -06:00
Brian Madison
7552ee2e3b fix quick udpate status bug in installer 2025-11-04 21:16:52 -06:00
Serhii
c283344a54 fix: ensure POSIX-compliant newlines in generated files (#856)
- Add final newline check to YAML config generation
- Add final newline check to YAML manifest generation
- Add final newline check to agent .md file generation
- Ensures all text files end with \n per POSIX standard
- Fixes 'No newline at end of file' git warnings
2025-11-04 20:18:12 -06:00
Brian Madison
ba5f76c37d Doc cleanup and mermaid diagram drafts added 2025-11-04 15:02:19 -06:00
Murat K Ozcan
84ec72fb94 fix: tea-readme 3 (#855)
* fix: tea-readme 3

* fix: tea-readme 3

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-11-04 10:31:36 -06:00
Brian Madison
ccd6cacd89 release: bump to v6.0.0-alpha.5 2025-11-04 00:15:34 -06:00
Brian Madison
accae5d789 refactor: comprehensive workflow modernization and standardization
## Major Improvements

### 1. Elicitation System Modernization
- Removed legacy `<elicit-required />` tag from workflow.xml
- Replaced with direct `<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>` pattern
- More explicit, self-documenting, and eliminates indirection layer
- Added strategic elicitation points across all planning workflows:
  - PRD: After success criteria, scope, functional requirements, and final review
  - Create-Epics-And-Stories: After epic proposals and each epic's stories
  - Architecture: After decisions, structure, patterns, implementation patterns, and final doc
  - Updated audit-workflow tag scanner to remove obsolete elicit-required reference

### 2. Input Document Discovery Streamlined
- Replaced verbose 19-line "Input Document Discovery" sections with single critical tag
- New format: `<critical>Input documents specified in workflow.yaml input_file_patterns...</critical>`
- Eliminates duplication - workflow.yaml already defines patterns
- Updated across 6 workflows (PRD, create-epics-and-stories, architecture, tech-spec, UX, gate-check)
- Saved ~114 lines of repeated bloat

### 3. Scale System Migration (Levels 0-4 → 3 Tracks)
- Updated PRD workflow from "Level 0-4" to "Quick Flow / BMad Method / Enterprise Method"
- Changed `project_level` variable to `project_track`
- Removed `target_scale` variable (no longer needed)
- Updated workflow.yaml descriptions to reference tracks not levels
- Updated checklist from "Level 2" and "Level 3-4" to "BMad Method" and "Enterprise Method"
- Aligns with new scale-adaptive-system.md (3-track methodology)

### 4. Epic/Story Template Standardization
- Replaced hardcoded 8-epic template with clean repeating pattern using N/M variables
- Added BDD-style acceptance criteria (Given/When/Then/And)
- Removed instructional bloat from templates (moved to instructions.md where it belongs)
- Template shows OUTPUT structure, instructions show PROCESS
- Applied to both create-epics-and-stories and tech-spec workflows
- Templates now use HTML comments to indicate repeating sections

### 5. Workflow.yaml Pattern Consistency
- Standardized input_file_patterns across all workflows
- Separated `recommended_inputs` (semantic WHAT) from `input_file_patterns` (file discovery WHERE)
- Removed duplication between recommended_inputs file paths and input_file_patterns
- Create-epics-and-stories now uses proper whole/sharded pattern like architecture workflow
- Solutioning-gate-check cleaned up to use semantic descriptions not file paths

## Files Changed (18)
- Core: workflow.xml (removed elicit-required tag and references)
- Audit workflow: Updated tag pattern scanner
- PRD workflow: Elicitation points, track migration, input discovery
- Create-epics-and-stories: Template rebuild, BDD format, elicitation, input patterns
- Tech-spec: Template rebuild, BDD format, input discovery
- UX Design: Input discovery streamlined
- Architecture: Elicitation at 5 key decision points, input discovery
- Gate-check: Input pattern cleanup, input discovery

## Impact
- More consistent elicitation across workflows
- Cleaner, more maintainable templates
- Better separation of concerns (templates vs instructions)
- Aligned with v6 3-track scale system
- Reduced bloat and duplication significantly
2025-11-04 00:09:19 -06:00
Brian Madison
c5117e5382 readme update 2025-11-03 21:46:49 -06:00
Brian Madison
e7d51739e4 update local install 2025-11-03 21:05:18 -06:00
Brian Madison
17f81a84f3 docs: comprehensive documentation accuracy overhaul and PM/UX evolution analysis
This commit represents a major documentation quality improvement, fixing critical inaccuracies and adding forward-looking guidance on the evolving role of PMs/UX in AI-driven development.

## Documentation Accuracy Fixes (Agent YAML as Source of Truth)

### Critical Corrections in agents-guide.md
- **Game Developer workflows**: Fixed incorrect workflow names (dev-story → develop-story, added story-done, removed non-existent create-story and retro)
- **Technical Writer naming**: Added agent name "Paige" to match all other agent naming patterns
- **Agent reference tables**: Updated to reflect actual agent capabilities from YAML configs
- **epic-tech-context ownership**: Corrected across all docs - belongs to SM agent, not Architect

### Critical Corrections in workflows-implementation.md
- **Line 16 + 75**: Fixed epic-tech-context agent from "Architect" → "SM" (matches sm.agent.yaml)
- **Line 258**: Updated epic-tech-context section header to show correct agent ownership
- **Multi-agent workflow table**: Moved epic-tech-context to SM agent row where it belongs

### Principle Applied
**Agent YAML files are source of truth** - All documentation now accurately reflects what agents can actually do per their YAML configurations, not assumptions or outdated info.

## Brownfield Development: Phase 0 Documentation Reality Check

### Rewrote brownfield-guide.md Phase 0 Section
Replaced oversimplified 3-scenario model with **real-world guidance**:

**Before**: Assumed docs are either perfect or non-existent
**After**: Handles messy reality of brownfield projects

**New Scenarios (4 instead of 3)**:
- **Scenario A**: No documentation → document-project (was covered)
- **Scenario B**: Docs exist but massive/outdated/incomplete → **document-project** (NEW - very common)
- **Scenario C**: Good docs but no structure → **shard-doc → index-docs** (NEW - handles massive files)
- **Scenario D**: Confirmed AI-optimized docs → Skip Phase 0 (was "Scenario C", now correctly marked RARE)

**Key Additions**:
- Default recommendation: "Run document-project unless you have confirmed, trusted, AI-optimized docs"
- Quality assessment checklist (current, AI-optimized, comprehensive, trusted)
- Massive document handling with shard-doc tool (>500 lines, 10+ level 2 sections)
- Explicit guidance on why regenerate vs index (outdated docs cause hallucinations)
- Impact explanation: how bad docs break AI workflows (token limits, wrong assumptions, broken integrations)

**Principle**: "When in doubt, run document-project" - Better to spend 10-30 minutes generating fresh docs than waste hours debugging AI agents with bad documentation.

## PM/UX Evolution: Enterprise Agentic Development

### New Content: The Evolving Role of Product Managers & UX Designers

Added comprehensive section based on **November 2025 industry research**:

**Industry Data**:
- 56% of product professionals cite AI/ML as top focus
- PRD-to-Code automation: build and deploy apps in 10-15 minutes
- By 2026: Roles converging into "Full-Stack Product Lead" (PM + Design + Engineering)
- Very high salaries for AI agent PMs who orchestrate autonomous systems

**Role Transformation**:
- From spec writers → code orchestrators
- PMs writing AI-optimized PRDs that **feed agentic pipelines directly**
- UX designers generating code with Figma-to-code tools
- Technical fluency becoming **table stakes**, not optional
- Review PRs from AI agents alongside human developers

**New Section: "How BMad Method Enables PM/UX Technical Evolution"** (10 ways):
1. **AI-Executable PRD Generation** - PRDs become work packages for cloud agents
2. **Automated Epic/Story Breakdown** - No more story refinement sessions
3. **Human-in-the-Loop Architecture** - PMs learn while validating technical decisions
4. **Cloud Agentic Pipeline** - Current (2025) + Future (2026) vision with diagrams
5. **UX Design Integration** - Designs validated through working prototypes
6. **PM Technical Skills Development** - Learn by doing through conversational workflows
7. **Organizational Leverage** - 1 PM → 20-50 AI agents (5-10× multiplier)
8. **Quality Consistency** - What gets built matches what was specified
9. **Rapid Prototyping** - Hours to validate ideas vs months
10. **Career Path Evolution** - Positions PMs for AI Agent PM, Full-Stack Product Lead roles

**Cloud Agentic Pipeline Vision**:
```
Current (2025): PM PRD → Stories → Human devs + BMad agents → PRs → Review → Deploy
Future (2026): PM PRD → Stories → Cloud AI agents → Auto PRs → Review → Auto-merge → Deploy
Time savings: 6-8 weeks → 2-5 days
```

**What Remains Human**:
- Product vision, empathy, creativity, judgment, ethics
- PMs spend MORE time on human elements (AI handles execution)
- Product leaders become "builder-thinkers" not just spec writers

### Document Tightening (enterprise-agentic-development.md)
- **Reduced from 1207 → 640 lines (47% reduction)**
- **10× more BMad-centric** - Every section ties back to how BMad enables the future
- Removed redundant examples, consolidated sections, kept actionable insights
- Stronger value propositions for PMs, UX, enterprise teams throughout

**Key Message**: "The future isn't AI replacing PMs—it's AI-augmented PMs becoming 10× more powerful through BMad Method."

## Impact

These changes bring documentation quality from **D- to A+**:
- **Accuracy**: Agent capabilities now match YAML source of truth (zero hallucination risk)
- **Reality**: Brownfield guidance handles messy real-world scenarios, not idealized ones
- **Forward-looking**: PM/UX evolution section positions BMad as essential framework for emerging roles
- **Actionable**: Concrete workflows, commands, examples throughout
- **Concise**: 47% reduction while strengthening value proposition

Users now have **trustworthy, reality-based, future-oriented guidance** for using BMad Method in both current workflows and emerging agentic development patterns.
2025-11-03 19:38:50 -06:00
Brian Madison
88d043245f 5 levels of scale adaption compressed to 3 clear distinctions driven by user preference and project needs 2025-11-03 17:06:15 -06:00
Brian Madison
750024fb14 release: bump to v6.0.0-alpha.4 2025-11-02 22:00:12 -06:00
Brian Madison
cfedecbd53 docs: massive documentation overhaul + introduce Paige (Documentation Guide agent)
## 📚 Complete Documentation Restructure

**BMM Documentation Hub Created:**
- New centralized documentation system at `src/modules/bmm/docs/`
- 18 comprehensive guides organized by topic (7000+ lines total)
- Clear learning paths for greenfield, brownfield, and quick spec flows
- Professional technical writing standards throughout

**New Documentation:**
- `README.md` - Complete documentation hub with navigation
- `quick-start.md` - 15-minute getting started guide
- `agents-guide.md` - Comprehensive 12-agent reference (45 min read)
- `party-mode.md` - Multi-agent collaboration guide (20 min read)
- `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read)
- `brownfield-guide.md` - Existing codebase development (53 min read)
- `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read)
- `workflows-analysis.md` - Phase 1 workflows (12 min read)
- `workflows-planning.md` - Phase 2 workflows (19 min read)
- `workflows-solutioning.md` - Phase 3 workflows (13 min read)
- `workflows-implementation.md` - Phase 4 workflows (33 min read)
- `workflows-testing.md` - Testing & QA workflows (29 min read)
- `workflow-architecture-reference.md` - Architecture workflow deep-dive
- `workflow-document-project-reference.md` - Document-project workflow reference
- `enterprise-agentic-development.md` - Team collaboration patterns
- `faq.md` - Comprehensive Q&A covering all topics
- `glossary.md` - Complete terminology reference
- `troubleshooting.md` - Common issues and solutions

**Documentation Improvements:**
- Removed all version/date footers (git handles versioning)
- Agent customization docs now include full rebuild process
- Cross-referenced links between all guides
- Reading time estimates for all major docs
- Consistent professional formatting and structure

**Consolidated & Streamlined:**
- Module README (`src/modules/bmm/README.md`) streamlined to lean signpost
- Root README polished with better hierarchy and clear CTAs
- Moved docs from root `docs/` to module-specific locations
- Better separation of user docs vs. developer reference

## 🤖 New Agent: Paige (Documentation Guide)

**Role:** Technical documentation specialist and information architect

**Expertise:**
- Professional technical writing standards
- Documentation structure and organization
- Information architecture and navigation
- User-focused content design
- Style guide enforcement

**Status:** Work in progress - Paige will evolve as documentation needs grow

**Integration:**
- Listed in agents-guide.md, glossary.md, FAQ
- Available for all phases (documentation is continuous)
- Can be customized like all BMM agents

## 🔧 Additional Changes

- Updated agent manifest with Paige
- Updated workflow manifest with new documentation workflows
- Fixed workflow-to-agent mappings across all guides
- Improved root README with clearer Quick Start section
- Better module structure explanations
- Enhanced community links with Discord channel names

**Total Impact:**
- 18 new/restructured documentation files
- 7000+ lines of professional technical documentation
- Complete navigation system with cross-references
- Clear learning paths for all user types
- Foundation for knowledge base (coming in beta)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-02 21:18:33 -06:00
Brian Madison
8a00f8ad70 feat: transform tech-spec workflow into intelligent Quick Spec Flow for Level 0-1
This major enhancement revolutionizes the tech-spec workflow from a basic template-filling exercise into a context-aware, intelligent planning system for rapid development of bug fixes and small features.

## Tech-Spec Workflow Transformation (11 files)

### Core Workflow Intelligence (instructions.md)
- Add standalone mode with interactive level/field-type detection
- Implement brownfield convention detection and user confirmation
- Integrate WebSearch for current framework versions and starter templates
- Add comprehensive context discovery (stack, patterns, dependencies)
- Implement auto-validation with quality scoring (always runs)
- Add UX/UI considerations capture for user-facing changes
- Add test framework detection and pattern analysis
- Transform from batch generation to living document approach

### Comprehensive Tech-Spec Template (tech-spec-template.md)
- Expand from 8 to 23 sections for complete context
- Add Context section (available docs, project stack, existing structure)
- Add Development Context (conventions, test framework, existing code)
- Add UX/UI Considerations section
- Add Developer Resources (file paths, key locations, testing)
- Add Integration Points and Configuration Changes
- All sections populated via template-output tags during workflow

### Enhanced Story Generation
- Level 0 (instructions-level0-story.md): Extract from comprehensive tech-spec
- Level 1 (instructions-level1-stories.md): Add story sequence validation, AC quality checks
- User Story Template: Add Dev Agent Record sections for implementation tracking
- Epic Template: Complete rewrite with proper structure and variables

### Validation & Quality (checklist.md)
- Add context gathering completeness checks
- Add definitiveness validation (no "use X or Y" statements)
- Add brownfield integration quality scoring
- Add stack alignment verification
- Add implementation readiness assessment
- Auto-generates validation report with scores

### Configuration (workflow.yaml)
- Add runtime variables: project_level, project_type, development_context, change_type, field_type
- Enable standalone operation without workflow-status.yaml
- Support both workflow-init integration and quick-start mode

## Phase 4 Integration (3 files)

### Story Context Workflow
- Add tech_spec to input_file_patterns (recognizes as authoritative source)
- Update instructions to prioritize tech-spec for Level 0-1 projects
- Tech-spec provides brownfield analysis, framework details, existing patterns

### Create Story Workflow
- Add tech_spec to input_file_patterns
- Enable story generation from tech-spec (alternative to PRD)
- Supports both Quick Spec Flow and traditional BMM flow

## Documentation (2 new files)

### Quick Spec Flow Guide (docs/quick-spec-flow.md)
- Comprehensive 595-line guide for Level 0-1 rapid development
- Complete user journey examples (bug fix, small feature)
- Context discovery explanation (stack, brownfield, conventions)
- Auto-validation details and benefits
- Integration with Phase 4 workflows
- Comparison: Quick Spec vs Full BMM
- Real-world examples and best practices

### Scale Adaptive System (docs/scale-adaptive-system.md)
- Complete 950-line technical guide to BMad Method's 5-level system
- Key terminology: Analysis, Tech-Spec, Epic-Tech-Spec, Architecture
- Level 0-4 workflows, planning docs, and progression
- Brownfield emphasis: document-project required first
- Tech-spec (upfront, Level 0-1) vs epic-tech-spec (during implementation, Level 2-4)
- Architecture document replaces tech-spec at Level 2+ (scales with complexity)
- Retrospectives after each epic in multi-epic projects
- Workflow path configuration reference

### README Updates
- Add Quick Spec Flow announcement with benefits
- Link to Scale Adaptive System documentation
- Clarify when to use Quick Spec Flow vs Full BMM

## Key Features

### Context-Aware Intelligence
- Auto-detects project stack from package.json, requirements.txt, etc.
- Analyzes brownfield codebases using document-project output
- Detects code conventions and confirms with user before proceeding
- Uses WebSearch for up-to-date framework info and starter templates

### Brownfield Respect
- Detects existing patterns (code style, test framework, naming conventions)
- Asks user for confirmation before applying conventions
- Adapts to existing code vs forcing changes
- References document-project analysis for comprehensive context

### Auto-Validation
- Always runs (not optional)
- Validates context gathering, definitiveness, brownfield integration
- Scores tech-spec quality and implementation readiness
- Validates story sequence for Level 1 (no forward dependencies)

### Living Document Approach
- Write to tech-spec continuously during discovery
- Progressive refinement vs batch generation
- Template variables populated via template-output tags in real-time

## Breaking Changes

None - all changes are additive and backward compatible.

## Impact

This transformation enables:
- Bug fixes and small features implemented in minutes vs hours
- Automatic stack detection and brownfield analysis
- Respect for existing conventions and patterns
- Current best practices via WebSearch integration
- Comprehensive context that can replace story-context for simple efforts
- Seamless integration with Phase 4 implementation workflows

Quick Spec Flow now provides a **true fast path from idea to implementation** for Level 0-1 projects while maintaining quality through auto-validation and comprehensive context gathering.
2025-11-02 08:17:23 -06:00
Brian Madison
3d4ea5ffd2 feat: add universal document sharding support with dual-strategy loading
Implement comprehensive document sharding system across all BMM workflows enabling 90%+ token savings for large multi-epic projects through selective loading optimization.

## Document Sharding System

### Core Features
- **Universal Support**: All 12 BMM workflows (Phase 1-4) handle both whole and sharded documents
- **Dual Loading Strategy**: Full Load (Phase 1-3) vs Selective Load (Phase 4)
- **Automatic Discovery**: Workflows detect format transparently (whole → sharded priority)
- **Efficiency Optimization**: 90%+ token reduction for 10+ epic projects in Phase 4

### Implementation Details

**Phase 1-3 Workflows (7 workflows) - Full Load Strategy:**
- product-brief, prd, gdd, create-ux-design, tech-spec, architecture, solutioning-gate-check
- Load entire sharded documents when present
- Transparent to user experience
- Better organization for large projects

**Phase 4 Workflows (5 workflows) - Selective Load Strategy:**
- sprint-planning (Full Load exception - needs all epics)
- epic-tech-context, create-story, story-context, code-review (Selective Load)
- Load ONLY the specific epic needed (e.g., epic-3.md for Epic 3 stories)
- Massive efficiency: Skip loading 9 other epics in 10-epic project

### Workflow Enhancements

**Added to all workflows:**
- `input_file_patterns` in workflow.yaml with wildcard discovery
- Document Discovery section in instructions.md
- Support for sharded index + section files
- Brownfield `docs/index.md` support

**Pattern standardization:**
```yaml
input_file_patterns:
  document:
    whole: "{output_folder}/*doc*.md"
    sharded: "{output_folder}/*doc*/index.md"
    sharded_single: "{output_folder}/*doc*/section-{{id}}.md"  # Selective load
```

### Retrospective Workflow Major Overhaul

Transformed retrospective into immersive, interactive team experience:

**Epic Discovery Priority (Fixed):**
- Priority 1: Check sprint-status.yaml for last completed epic
- Priority 2: Ask user directly
- Priority 3: Scan stories folder (last resort)

**New Capabilities:**
- Deep story analysis: Extract dev notes, mistakes, review feedback, lessons learned
- Previous retro integration: Track action items, verify lessons applied
- Significant change detection: Alert when discoveries require epic updates
- Intent-based facilitation: Natural conversation vs scripted phrases
- Party mode protocol: Clear speaker identification (Name (Role): dialogue)
- Team dynamics: Drama, disagreements, diverse perspectives, authentic conflict

**Structure:**
- 12 whole-number steps (no decimals)
- Highly interactive with constant user engagement
- Cross-references previous retro for accountability
- Synthesizes patterns across all stories
- Detects architectural assumption changes

## Documentation

**Created:**
- `docs/document-sharding-guide.md` - Comprehensive 300+ line guide
  - What is sharding, when to use it (token thresholds)
  - How sharding works (discovery system, loading strategies)
  - Using shard-doc tool
  - Full Load vs Selective Load patterns
  - Complete examples and troubleshooting
  - Custom workflow integration patterns

**Updated:**
- `README.md` - Added Document Sharding feature section
- `docs/index.md` - Added under Advanced Topics → Optimization
- `src/modules/bmm/workflows/README.md` - Added sharding section with usage
- `src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md` - Added complete implementation patterns for workflow builders

**Documentation levels:**
1. Overview (README.md) - Quick feature highlight
2. User guide (BMM workflows README) - Practical usage
3. Reference (document-sharding-guide.md) - Complete details
4. Builder guide (workflow-creation-guide.md) - Implementation patterns

## Efficiency Gains

**Example: 10-Epic Project**

Before sharding:
- epic-tech-context for Epic 3: Load all 10 epics (~50k tokens)
- create-story for Epic 3: Load all 10 epics (~50k tokens)
- story-context for Epic 3: Load all 10 epics (~50k tokens)

After sharding with selective load:
- epic-tech-context for Epic 3: Load Epic 3 only (~5k tokens) = 90% reduction
- create-story for Epic 3: Load Epic 3 only (~5k tokens) = 90% reduction
- story-context for Epic 3: Load Epic 3 only (~5k tokens) = 90% reduction

## Breaking Changes

None - fully backward compatible. Workflows work with existing whole documents.

## Files Changed

**Workflows Updated (25 files):**
- 7 Phase 1-3 workflows: Added full load sharding support
- 5 Phase 4 workflows: Added selective load sharding support
- 1 retrospective workflow: Complete overhaul with sharding support

**Documentation (5 files):**
- Created: document-sharding-guide.md
- Updated: README.md, docs/index.md, BMM workflows README, BMB workflow-creation-guide
- Removed: Old conversion report (obsolete)

## Future Extensibility

- BMB workflows now aware of sharding patterns
- Custom modules can easily implement sharding support
- Standard patterns documented for consistency
- No need to explain concept in future development
2025-11-02 00:13:33 -05:00
Brian Madison
f77babcd5e feat: major overhaul of BMM planning workflows with intent-driven discovery
This comprehensive update transforms the Product Brief and PRD workflows from rigid template-filling exercises into adaptive, context-aware discovery processes. Changes span workflow instructions, templates, agent configurations, and supporting infrastructure.

## Product Brief Workflow (96% audit compliance)

### Intent-Driven Facilitation
- Transform from linear Q&A to natural conversational discovery
- Adaptive questioning based on project context (hobby/startup/enterprise)
- Real-time document building instead of end-of-session generation
- Skill-level aware facilitation (expert/intermediate/beginner)
- Context detection from user responses to guide exploration depth

### Living Document Approach
- Continuous template updates throughout conversation
- Progressive refinement vs batch generation
- Template-output tags aligned with discovery flow
- Better variable mapping between instructions and template

### Enhanced Discovery Areas
- Problem exploration with context-appropriate probing
- Solution vision shaping based on user's mental model
- User understanding through storytelling vs demographics
- Success metrics tailored to project type
- Ruthless MVP scope management with feature prioritization

### Template Improvements
- Added context-aware conditional sections
- Better organization of optional vs required content
- Clearer structure for different project types
- Improved reference material handling

## PRD Workflow (improved from 65% to 85%+ compliance)

### Critical Fixes
- Add missing `date: system-generated` config variable
- Fix status file extension mismatch (.yaml not .md)
- Remove 38% bloat (unused technical_decisions variables)
- Add explicit template-output tags for runtime variables

### Scale-Adaptive Intelligence
- Project type detection (API/Web App/Mobile/SaaS/etc)
- Domain complexity mapping (14 domain types)
- Automatic requirement tailoring based on detected context
- CSV-driven project type and domain knowledge base

### Separated Epic Planning
- Move epic/story breakdown to dedicated child workflow
- Create create-epics-and-stories workflow for Phase 2
- Cleaner separation: PRD defines WHAT, epics define HOW
- Updated PM agent menu with new workflow triggers

### Enhanced Requirements Coverage
- Project-type specific requirement sections (endpoints, auth, platform)
- Domain-specific considerations (healthcare compliance, fintech security)
- UX principles with interaction patterns
- Non-functional requirements with integration needs
- Technical preferences capture

### Template Restructuring
- Separate PRD template from epic planning
- Context-aware conditional sections
- Better scale level indicators (L0-L4)
- Improved reference document handling
- Clearer success criteria sections

## Architecture Workflow Updates

### Template Enhancements
- Add domain complexity context support
- Better integration with PRD outputs
- Improved technical decision capture
- Enhanced system architecture sections

### Instruction Improvements
- Reference new domain-research workflow
- Better handling of PRD inputs
- Clearer architectural decision framework

## Agent Configuration Updates

### BMad Master Agent
- Fix workflow invocation instructions
- Better fuzzy matching guidance
- Clearer menu handler documentation
- Remove workflow invention warnings

### PM Agent
- Add create-prd trigger (renamed from 'prd')
- Add create-epics-and-stories workflow trigger
- Add validate-prd workflow trigger with checklist
- Better workflow status integration

### Game Designer Agent
- Rename triggers for consistency (create-game-brief, create-gdd)
- Align with PM agent naming conventions

## New Supporting Infrastructure

### Domain Research Workflow
- New discovery workflow for domain-specific research
- Complements product brief for complex domains
- Web research integration for domain insights

### Create Epics and Stories Workflow
- Dedicated epic/story breakdown process
- Separates planning (PRD) from decomposition
- Better Epic → Story → Task hierarchy
- Acceptance criteria generation

### Data Files
- project-types.csv: 12 project type definitions with requirements
- domain-complexity.csv: 14 domain types with complexity indicators

## Quality Improvements

### Validation & Compliance
- Product Brief: 96% BMAD v6 compliance (EXCELLENT rating)
- PRD: Improved from 65% to ~85% after critical fixes
- Zero bloat in Product Brief (0%)
- Reduced PRD bloat from 38% to ~15%

### Template Variable Mapping
- All template variables explicitly populated via template-output tags
- Runtime variables properly tracked
- Config variables consistently used
- Better separation of concerns

### Web Bundle Configuration
- Complete web_bundle sections for all workflows
- Proper child workflow references
- Data file inclusions (CSV files)
- Correct bmad/-relative paths

## Breaking Changes

### File Removals
- Delete src/modules/bmm/workflows/2-plan-workflows/prd/epics-template.md
  (replaced by create-epics-and-stories child workflow)

### Workflow Trigger Changes
- PM agent: 'prd' → 'create-prd'
- PM agent: 'gdd' → 'create-gdd'
- New: 'create-epics-and-stories'
- New: 'validate-prd'

## Impact

This update significantly improves the BMM module's ability to:
- Adapt to different project types and scales
- Guide users through discovery naturally vs mechanically
- Generate higher quality planning documents
- Support complex domains with specialized knowledge
- Scale from Level 0 quick changes to Level 4 enterprise projects

The workflows now feel like collaborative discovery sessions with an expert consultant rather than form-filling exercises.
2025-11-01 19:37:20 -05:00
Brian Madison
4f4b191e8f research will use the web more, use system date to understand what the read current date is. 2025-11-01 00:14:41 -05:00
Brian Madison
a1be5d7292 rename deep research options for chatgpt 2025-10-31 19:43:13 -05:00
Brian Madison
b056b42892 fixed installer note 2025-10-31 19:39:06 -05:00
Brian Madison
1c9fcbb73b shard doc uses npx command 2025-10-31 16:51:25 -05:00
Brian Madison
88e7ede452 remove voice hooks 2025-10-30 15:34:21 -05:00
Brian Madison
d4879d373b 6.0.0-alpha.3 2025-10-30 11:37:03 -05:00
Brian Madison
663b76a072 docs updates 2025-10-30 11:26:15 -05:00
Brian Madison
ec111972a0 some output should be improved and not run together in chat windows 2025-10-30 08:13:18 -05:00
Brian Madison
6d7f42dbec v6 greenfield quickstart guide 2025-10-29 22:39:13 -05:00
Brian Madison
519e2f3d59 manifest version comes from package 2025-10-29 20:04:04 -05:00
Brian Madison
d6036e18dd docs: fix v4 branch link in readme 2025-10-29 09:38:26 -05:00
Brian Madison
6d2b6810c2 fix: preserve user's cwd when running via npx 2025-10-29 09:31:38 -05:00
Brian Madison
06dab16a75 6.0.0-alpha.2 2025-10-29 09:14:03 -05:00
Brian Madison
5a70512a30 chore: remove version prompt from npx installer 2025-10-29 09:12:27 -05:00
Brian Madison
b05f4751d7 6.0.0-alpha.1 2025-10-29 08:35:02 -05:00
Brian Madison
b5262f78ee still alpha 2025-10-29 08:34:48 -05:00
Brian Madison
5ee57ea8df cleanup a few more items 2025-10-29 08:19:11 -05:00
Brian Madison
fd620d0183 marked sm menu items as optional that are optional 2025-10-28 23:47:48 -05:00
Brian Madison
ad8717845d cline workflows added to support slash commands 2025-10-28 23:16:48 -05:00
Brian Madison
503a394218 party mode fix 2025-10-28 22:52:03 -05:00
jheyworth
8376ca0ba2 fix: add CommonMark-compliant markdown formatting rules (#830)
* fix: add CommonMark-compliant markdown formatting rules to workflow

Problem:
--------
BMAD generates markdown that violates CommonMark specification by omitting
required blank lines around lists, tables, and code blocks. While GitHub's
renderer (GFM) handles this gracefully, strict parsers like Mac Markdown.app
break completely, rendering lists as plain text and losing document structure.

Solution:
---------
Add 6 mandatory markdown formatting rules to workflow.xml (line 73) that
enforce proper spacing and consistency:

1. ALWAYS add blank line before and after bullet lists
2. ALWAYS add blank line before and after numbered lists
3. ALWAYS add blank line before and after tables
4. ALWAYS add blank line before and after code blocks
5. Use - for bullets consistently (not * or +)
6. Use language identifier for code fences

Impact:
-------
- Makes BMAD output CommonMark compliant
- Ensures compatibility with ALL markdown parsers, not just GitHub
- Follows industry best practices for professional documentation
- Future-proofs against stricter parser implementations
- Zero content changes - only formatting improved

Testing:
--------
Comprehensive three-phase testing completed:
- Phase 1: Synthetic test validating fix mechanism
- Phase 2: Fresh install end-to-end test (API Gateway project)
- Phase 3: GitHub validation with visual proof

Results: 1,112 lines of formatting improvements, 0 content changes,
100% CommonMark compliance achieved.

Test Evidence:
--------------
Complete test repository with before/after comparison, Mac Markdown.app
screenshot proving the issue, and comprehensive documentation:
https://github.com/jheyworth/bmad-markdown-formatting-test

See TEST.md for full documentation, test methodology, and evidence.

🤖 Generated with Claude Code (https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Remove TEST.md per maintainer feedback

As requested by @bmadcode - the test documentation was useful during review but is not needed in the repository. Testing evidence remains documented in the PR description and external test repository.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-10-28 22:27:48 -05:00
Brian Madison
44bc96fadc readme update 2025-10-28 22:27:23 -05:00
Brian Madison
7710d9941d document-project moved out of phase 1 to right below workflows and documents updated to clarify its not a phase-0 but a prereq and also a post project tool to use. 2025-10-28 22:21:13 -05:00
Brian Madison
1cfd58ebb1 installer for delete and replace fixed 2025-10-28 21:44:04 -05:00
Brian Madison
1c5b30f361 some v5 references lingered - change to v6 2025-10-28 20:32:08 -05:00
Brian Madison
d9c7980b1d remove unused csv columns from cis 2025-10-28 19:17:44 -05:00
Brian Madison
95b875792b remove tts again 2025-10-28 19:12:10 -05:00
Brian Madison
0ee4fa920a installer fixed to not add game assets to slash commands in some ides that read from the manifest. and fixed the manifest. 2025-10-28 19:09:43 -05:00
Brian Madison
e93b208902 file cleanup 2025-10-28 17:22:31 -05:00
Brian Madison
3fff30ca61 opencode moved agents back to agent folder 2025-10-28 17:18:53 -05:00
Brian Madison
ee58586f39 installer improvements 2025-10-28 12:47:45 -05:00
Brian Madison
ed3603f7b2 vast improvements to create story, review story, draft story checklist validation, sm menu items and dev agent menu items fixed 2025-10-28 10:03:19 -05:00
Brian Madison
0354d1ae45 story review was missing detailed instructions to review AC and task adherance. 2025-10-28 08:51:58 -05:00
Brian Madison
0dab278e7b story-review renamed code-review and dev-agent performs this 2025-10-28 08:30:44 -05:00
Brian Madison
66c66f602d all workflows can optionally run without a workflow 2025-10-27 23:51:22 -05:00
Brian Madison
7ad841964d installer for bmm includes option to include game assets or not when adding to a project. 2025-10-27 22:38:34 -05:00
Brian Madison
f55e822338 brownfield guide draft 2025-10-27 21:18:55 -05:00
Brian Madison
24a2271520 update open items list 2025-10-27 18:27:10 -05:00
Brian Madison
a484b9975c claude code flattened commands 2025-10-27 15:18:22 -05:00
Brian Madison
913ec47123 fix: CSV column mismatch when upgrading manifest schemas
When preserving CSV rows from existing manifest files during module updates,
rows from older schema versions (without the 'standalone' column) were being
added to CSVs with new schema headers, causing "Invalid Record Length" errors
during parsing.

Added schema upgrade logic to detect old column structure and upgrade preserved
rows by adding missing columns with appropriate default values. This ensures all
CSV rows match the header column count, fixing installation errors.

Fixes column count mismatch in:
- workflow-manifest.csv (added standalone column)
- task-manifest.csv (added standalone column)
- tool-manifest.csv (added standalone column)
- agent-manifest.csv (schema validation for future-proofing)
2025-10-27 15:00:57 -05:00
Brian Madison
8ed721d029 npx with version selector 2025-10-26 23:42:56 -05:00
Brian Madison
334e24823a doc updates 2025-10-26 23:25:48 -05:00
Brian Madison
b753fb293b workflows tasks and tools can be configured wether they are able to be run standalone from agents with ide commands 2025-10-26 20:06:34 -05:00
Brian Madison
63ef5b7bc6 installer fixes 2025-10-26 19:38:38 -05:00
Brian Madison
1cb88728e8 installer fixes 2025-10-26 17:04:27 -05:00
Brian Madison
8d81edf847 install quick updates 2025-10-26 16:17:37 -05:00
Brian Madison
0067fb4880 path fixes, documentation updates, md-xplodr added to core tools 2025-10-26 15:40:43 -05:00
Cameron Pitt
8220c819e6 Add Opencode IDE installer (#820)
- Added docs/ide-info/opencode.md
- Added tool/cli/installers/lib/ide/opencode.js
- Modified tools/installers/lib/ide/core/detector.js to include
detection for opencode command dir
- Modified tools/cli/platform-codes.yaml to include opencode config
- Modified tools/cli/installers/lib/ide/workflow-command-template.md to
include frontmatter with description as opencode requires this for
commands and adding it to the template by default does not seem to
impact other IDEs
- Modified src/modules/bmm/workflows/workflow-status/workflow.yaml
description so that it properly escapes quotes when interpolated in the
teplate
2025-10-26 11:16:57 -05:00
Brian Madison
b7e6bfcde5 a few more instruction cleanup items 2025-10-25 23:57:27 -05:00
Brian Madison
bfd49faf2d tech context improved 2025-10-25 23:29:41 -05:00
Brian Madison
52b8edb01d phase 4 more workflow cleanup 2025-10-25 19:25:28 -05:00
Brian Madison
061b7d94c4 status normalization 2025-10-25 15:41:13 -05:00
Brian Madison
5762941321 better status loading and updating for phase 4 2025-10-25 14:26:30 -05:00
Brian Madison
994f251687 workflow phase 4 only has single sprint planning item in it now 2025-10-25 10:44:46 -05:00
Brian Madison
cf13e81dd5 sprint plan clearer comments 2025-10-25 00:30:49 -05:00
Brian Madison
92bff333b1 plan-project gone, and all level 1-3 workflows are dynamic from the workflow in suggesting what is next 2025-10-24 23:16:08 -05:00
Brian Madison
f37c960a4d validation tasks added 2025-10-23 23:20:48 -05:00
Brian Madison
2d297c82da fix create-design workflow path 2025-10-23 15:58:05 -05:00
Brian Madison
a175f46f1b create-ux-design refactor 2025-10-23 14:20:13 -05:00
Brian Madison
44e09e4487 ux expert -> ux designer 2025-10-22 16:58:18 -05:00
Brian Madison
be5556bf42 checks checked 2025-10-22 15:40:51 -05:00
Brian Madison
be5b06f55e check alignment 2025-10-22 12:36:39 -05:00
Brian Madison
c8776aa9ac inline tag reference updtges 2025-10-21 23:48:35 -05:00
Brian Madison
ddaefa3284 use sprint plan for al workflow level 4 implementations 2025-10-21 23:03:46 -05:00
Brian Madison
abaa24513a sprint status helpers, remove workflow integration from phase 4 items in prep of using sprint-planning status 2025-10-21 22:25:26 -05:00
Brian Madison
71330b6aac updates to the paths 2025-10-21 20:37:59 -05:00
Brian Madison
949d818db8 sprint status story location relative 2025-10-21 18:41:40 -05:00
Brian Madison
1b1947d240 sprint-planning placeholder for future integration with jira linear and trello 2025-10-21 18:13:34 -05:00
Brian Madison
419043e704 sprint planning 2025-10-21 08:24:02 -05:00
Brian Madison
b8db0806ed architecture name standardization 2025-10-20 19:01:18 -05:00
Tiki
60475ac6f8 feat(tools/cli): Refactor Qwen IDE configuration logic to support modular command structure (#762)
- Unify BMad directory name from 'BMad' to lowercase 'bmad'
- Use shared utility functions [getAgentsFromBmad] and [getTasksFromBmad] to fetch agents and tasks
- Create independent subdirectory structures (agents, tasks) for each module
- Update file writing paths to store TOML files by module classification
- Remove legacy QWEN.md merged documentation generation logic
- Add TOML metadata header support (not available in previous versions)
- Clean up old version configuration directories (including uppercase BMad and bmad-method)
2025-10-20 08:34:42 -05:00
Alex Verkhovsky
69d1f75435 fix: remove empty tasks directories from Claude Code installer (#776)
Previously, the installer created empty tasks/ directories under
.claude/commands/bmad/{module}/ and attempted to copy task files.
Since getTasksFromDir() filters for .md files only and all actual
tasks are .xml files, these directories remained empty.

Tasks are utility files referenced by agents via exec attributes
(e.g., exec="{project-root}/bmad/core/tasks/workflow.xml") and
should remain in the bmad/ directory - they are not slash commands.

Changes:
- Removed tasks directory creation in module setup
- Removed tasks copying logic (15 lines)
- Removed taskCount from console output
- Removed tasks property from return value
- Removed unused getTasksFromBmad and getTasksFromDir imports
- Updated comment to clarify agents-only installation

Verified: No tasks/ directories created in .claude/commands/bmad/
while task files remain accessible in bmad/core/tasks/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-10-20 07:20:36 -05:00
Jrakru
c2b3e797e7 fix(retrospective): align SM ownership in workflow paths and handoff (#770) 2025-10-20 07:19:11 -05:00
Alex Verkhovsky
31666c1f0f feat: add agent schema validation with comprehensive testing (#774)
Introduce automated validation for agent YAML files using Zod to ensure
schema compliance across all agent definitions. This feature validates
17 agent files across core and module directories, catching structural
errors and maintaining consistency.

Schema Validation (tools/schema/agent.js):
- Zod-based schema validating metadata, persona, menu, prompts, and critical actions
- Module-aware validation: module field required for src/modules/**/agents/,
  optional for src/core/agents/
- Enforces kebab-case unique triggers and at least one command target per menu item
- Validates persona.principles as array (not string)
- Comprehensive refinements for data integrity

CLI Validator (tools/validate-agent-schema.js):
- Scans src/{core,modules/*}/agents/*.agent.yaml
- Parses with js-yaml and validates using Zod schema
- Reports detailed errors with file paths and field paths
- Exits 1 on failures, 0 on success
- Accepts optional project_root parameter for testing

Testing (679 lines across 3 test files):
- test/test-cli-integration.sh: CLI behavior and error handling tests
- test/unit-test-schema.js: Direct schema validation unit tests
- test/test-agent-schema.js: Comprehensive fixture-based tests
- 50 test fixtures covering valid and invalid scenarios
- ESLint configured to support CommonJS test files
- Prettier configured to ignore intentionally broken fixtures

CI Integration (.github/workflows/lint.yaml):
- Renamed from format-check.yaml to lint.yaml
- Added schema-validation job running npm run validate:schemas
- Runs in parallel with prettier and eslint jobs
- Validates on all pull requests

Data Cleanup:
- Fixed src/core/agents/bmad-master.agent.yaml: converted persona.principles
  from string to array format

Documentation:
- Updated schema-classification.md with validation section
- Documents validator usage, enforcement rules, and CI integration

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-10-20 07:14:50 -05:00
Brian Madison
2a6eb71612 massive architecture creation overhaul 2025-10-19 23:28:38 -05:00
Brian Madison
d3402c3132 architecture reorganization in preparation of architecture solutioning rework 2025-10-19 15:28:33 -05:00
Brian Madison
0a048f2ccc installer updates, bmd module added and moved out of src, created a plan for module installation tool for custom modules, minor flow improvements 2025-10-19 11:59:27 -05:00
Brian Madison
eb9a214115 readme updated 2025-10-18 12:19:47 -05:00
Brian Madison
940cc15751 cli installer bundler documentation added 2025-10-18 10:20:29 -05:00
Brian Madison
c0a2c55267 clearer codex install note 2025-10-18 09:41:38 -05:00
Brian Madison
a1fc8da03c workflow init added to analyst pm and game agents 2025-10-18 01:34:03 -05:00
Brian Madison
36231173d1 workflows consistent method to update status file 2025-10-17 23:44:43 -05:00
Brian Madison
5788be64d0 installer temp updates 2025-10-17 22:42:36 -05:00
Brian Madison
b54bb9e47d workflow references to moved workflow status workflow 2025-10-17 22:34:21 -05:00
Brian Madison
af8e296e6f all phase 4 workflows use status check workflow update 2025-10-17 20:33:38 -05:00
Brian Madison
e92f138f3d doc output lang vs com lang 2025-10-17 19:46:25 -05:00
Brian Madison
ffd354b605 arch alignment with workflows 2025-10-17 16:44:06 -05:00
Brian Madison
9519eae666 workflow plan realignment 2025-10-17 00:44:05 -05:00
Brian Madison
bc7d679366 workflow simplified 2025-10-17 00:19:45 -05:00
Brian Madison
54985778f2 minor fixes 2025-10-16 21:50:50 -05:00
Murat K Ozcan
84a70d8331 reafactor: test arch audit (#758)
Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-10-16 19:58:37 -05:00
Murat K Ozcan
bee9c5dce7 feat: migrate test architect entirely (#750)
* feat: migrate test architect entirely to v6

* format fixed

* feat: integrated new playwright mcp

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-10-16 11:09:51 -05:00
Brian Madison
7f0e57e466 bmb updates 2025-10-16 09:50:29 -05:00
Brian Madison
790c4cedf4 remaining bmm workflows bloat removed 2025-10-16 08:58:09 -05:00
Brian Madison
e77a1c036b 1-analysis workflow-state yaml streamlined 2025-10-16 08:26:26 -05:00
Brian Madison
1fe405eb64 1-analysis intentionalized 2025-10-16 08:11:22 -05:00
Brian Madison
516fa1a917 intent based workflow 2025-10-16 07:58:28 -05:00
Brian Madison
a28a350e14 workflow builder understand existing_workflows tag for web bundles, and cleanup comtinues 2025-10-16 07:24:38 -05:00
Brian Madison
73ba7afa90 update additional location audit workflow 2025-10-16 00:15:18 -05:00
Brian Madison
fb5e40319f added audit workflow worfklow 2025-10-16 00:09:19 -05:00
Brian Madison
bcac484319 remove old webbundles 2025-10-15 23:51:07 -05:00
Brian Madison
72b6640f4b workflow cleanup 2025-10-15 23:50:34 -05:00
Brian Madison
f4b16bfacf planning workflow alignment 2025-10-15 23:10:33 -05:00
Brian Madison
b9b219a13b prd cleanup 2025-10-15 21:17:09 -05:00
Brian Madison
9b427a4e2b planning tech spec cleanup 2025-10-14 20:20:55 -05:00
Brian Madison
0f126b7f87 consolidated prd isntruction 2025-10-14 19:58:44 -05:00
Brian Madison
4b6f34dff8 date removed from status file, status file renamed 2025-10-13 22:32:35 -05:00
Brian Madison
27586e6a40 context should use relative paths 2025-10-13 21:11:20 -05:00
Brian Madison
5eb410d622 update config re deprecated removed file 2025-10-13 19:29:19 -05:00
Brian Madison
f1965810a6 adv elicitation project updated to hopefully not be skipped as optional anymore. further workflow updates. 2025-10-13 00:33:06 -05:00
Brian Madison
36bf506241 all workflows aware 2025-10-12 22:19:28 -05:00
Brian Madison
88989d5403 master workflow integration 2025-10-12 18:10:23 -05:00
Brian Madison
c3c51945bb docs update 2025-10-12 16:59:54 -05:00
Brian Madison
79ac3c91fe central source of trust for workflow status, current, and next story or epic 2025-10-12 16:14:29 -05:00
Brian Madison
e61d58d480 workflow level 0 and 1 aligned with brownfield and quick dev 2025-10-12 15:53:24 -05:00
Brian Madison
1b7a3b396f removed bmad folder 2025-10-12 01:41:09 -05:00
Brian Madison
ab05cdcdd2 \split analyze workflow 2025-10-12 01:39:24 -05:00
Brian Madison
2b736a8594 brownfield document project workflow added to analyst 2025-10-12 00:49:12 -05:00
Brian Madison
4f16d368ac minor dev agent updates 2025-10-11 19:45:25 -05:00
Brian Madison
b4cc579009 create-agent now adds agent to ide agents list also 2025-10-10 09:27:50 -05:00
Carson
9ba4805aa7 Update README.md (#715) 2025-10-10 09:27:32 -05:00
PinkyD
d76bcb5586 chore: cleaned up bad architecture file calls, legacy doc references, and case sensitivity issues to remove ambiguity (#718) 2025-10-10 09:26:49 -05:00
MeetNexus
5977227efc fix: Correct path to instructions in bmad-init workflow (#663)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-10-09 19:07:56 -05:00
PinkyD
b62e169bac adjusted workflow installed_path to proper bmm workflow folders (#688) 2025-10-07 16:07:30 -05:00
Dylan Buchi
709fb72bc5 fix: install auggie commands to augment directory (#683) 2025-10-07 16:07:06 -05:00
Alex Verkhovsky
d444ca3f31 fix(installer): enforce manifest ide selection (#684) 2025-10-06 14:08:36 -05:00
Alex Verkhovsky
b999dd1315 refactor(ide): delegate detection to handlers (#680) 2025-10-05 22:13:11 -05:00
Alex Verkhovsky
c9ffe202d5 feat(installer): default project name to directory (#681) 2025-10-05 22:12:37 -05:00
Alex Verkhovsky
c49f4b2e9b feat(codex): activate with custom prompts instead of AGENTS.md (#679) 2025-10-05 17:52:48 -05:00
Brian Madison
33d893bef2 workflows added to sub items in plan project phase. updated single action checks to be ifs on the action. 2025-10-05 11:32:45 -05:00
Brian Madison
aefe72fd60 gdd updated 2025-10-04 22:52:38 -05:00
Brian Madison
d23643b53b removed some files 2025-10-04 21:34:37 -05:00
Brian Madison
16984c3d92 fix path bug 2025-10-04 21:33:19 -05:00
PinkyD
47658c00d5 Fixed bug with activation-steps.xml injecting wrong path (#674) 2025-10-04 21:04:33 -05:00
Brian Madison
1a92e6823f fix: ensure IDE configurations are collected during full reinstall
- Remember previously configured IDEs before deleting bmad directory
- During full reinstall, treat all selected IDEs as newly selected
- Properly prompt for IDE configuration questions during reinstall
- Remove debug logging
2025-10-04 19:54:47 -05:00
Brian Madison
6181a0bd07 fix: installer IDE selection and cancellation handling
- Fix manifest reading to use manifest.yaml instead of manifest.csv
- Show previously configured IDEs as selected by default in UI
- Skip configuration prompts for already configured IDEs during updates
- Properly collect IDE configurations during full reinstall
- Handle installation cancellation without throwing errors
2025-10-04 19:46:16 -05:00
Brian Madison
c632564849 finish move of brainstorming to the core 2025-10-04 19:33:34 -05:00
Brian Madison
9ea68ab8c3 remove bmad installs 2025-10-04 19:28:49 -05:00
Brian Madison
c7d76a3037 agent manifest generation, party mode uses it, and tea persona compression 2025-10-04 19:28:10 -05:00
Brian Madison
bbb37a7a86 brainstorming moved to core workflows part 2 2025-10-04 19:02:29 -05:00
Brian Madison
b6d8823d51 brainstorming moved to core workflows 2025-10-04 19:01:37 -05:00
Brian Madison
e60d5cc42d removed deprecated src_impact 2025-10-04 18:43:24 -05:00
Brian Madison
3147589d0f bomb agent updates 2025-10-04 17:35:37 -05:00
Brian Madison
94a2dad104 name and language will now persisten better with most models 2025-10-04 16:12:42 -05:00
Brian Madison
67bf3b81c8 remove errant bmad folder 2025-10-04 11:19:31 -05:00
OverlordBaconPants
106c32c513 Add TDD Agent validation test story
Created a simple Calculator implementation story to test the TDD Developer Agent:
- Story with 3 acceptance criteria (add, subtract, error handling)
- Comprehensive Story Context JSON with test cases
- Designed to validate RED-GREEN-REFACTOR workflow
- Status set to 'Approved' for immediate testing

Test story location: test-stories/story-tdd-agent-validation.md

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-04 10:09:05 -04:00
OverlordBaconPants
9810f4255e Add TDD Developer Agent with RED-GREEN-REFACTOR workflow
- Created dev-tdd.md agent with strict test-first development methodology
- Implemented complete TDD workflow with RED-GREEN-REFACTOR cycles
- Added comprehensive validation checklist (250+ items)
- Integrated RVTM traceability for requirement-test-implementation tracking
- Includes ATDD test generation and Story Context integration
- Agent name: Ted (TDD Developer Agent) with  icon

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-04 10:01:35 -04:00
Brian Madison
9300ad1d71 subagaents updated with consistent return info and missing frontmatter where it was missing 2025-10-04 08:24:21 -05:00
Brian Madison
46cabf72cd doc status updates 2025-10-04 01:29:40 -05:00
Brian Madison
a747017520 docs updated and agent standalone builder working now from the main install flow 2025-10-04 01:26:38 -05:00
Brian Madison
5ee4cf535c BoMB updates 2025-10-04 00:22:59 -05:00
Brian Madison
9e8c7f3503 bundle agents front matter optimized, along with the orchestrators activation instructions; 2025-10-03 21:46:53 -05:00
Brian Madison
5ac18cb55c agent teams orchesatraion prompt improved 2025-10-03 19:08:34 -05:00
Brian Madison
fd01ad69f8 remove uneeded files 2025-10-03 11:54:32 -05:00
Brian Madison
3f40ef4756 agent updates 2025-10-02 21:45:59 -05:00
Brian Madison
c6704b4b6e web bundles for team complete 2025-10-01 22:22:40 -05:00
Brian Madison
15dc68cd29 remove unneeded commit files 2025-10-01 18:29:08 -05:00
Brian Madison
f077a31aa0 docs updated 2025-10-01 18:29:08 -05:00
Brian Madison
7ebbe9fd5f Qwen tasks and agents 2025-10-01 18:29:07 -05:00
PinkyD
5f0a318bdf feature: Added detailed epics file generation that was missing (#669) 2025-10-01 14:01:56 -05:00
Brian Madison
25c3d50673 SubAgents in sub folders. installer improvements. BMM Flow document added 2025-10-01 09:12:21 -05:00
Brian Madison
56e7a61bd3 v6 flow documented and subagent organization 2025-10-01 08:50:16 -05:00
Brian Madison
05a3b4f3f1 hash file change checking integrated 2025-09-30 21:20:13 -05:00
Brian Madison
c42cd48421 Fix installer upgrade issues from v4 to v6. and v6 custom files will no longer be lost (modified ones will though for now still) 2025-09-30 20:06:02 -05:00
Brian Madison
e7fcc56cc3 v4-v6 upgrade improvement and warning about file auto backup 2025-09-30 19:42:12 -05:00
Murat K Ozcan
df0c3e4bae Port TEA commands into workflows and preload Murat knowledge (#660)
* Port TEA commands into workflows and preload Murat knowledge

* Broke the giant knowledge dump into curated fragments under src/modules/bmm/testarch/knowledge/

* Broke the giant knowledge dump into curated fragments under src/modules/bmm/testarch/knowledge/

* updated the web bunles for tea, and spot updates for analyst and sm

* Replaced the old TEA brief with an indexed knowledge system: the agent now loads topic-specific
  docs from knowledge/ via tea-index.csv, workflows reference those fragments, and risk/level/
  priority guidance lives in the new fragment files

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-09-30 15:19:55 -05:00
Brian Madison
30fb0e67e1 analyst command fix 2025-09-30 01:41:09 -05:00
Brian Madison
e1fac26156 all agent bundles working 2025-09-30 01:38:39 -05:00
Brian Madison
acdea01141 web bundling update 2025-09-30 00:45:16 -05:00
Brian Madison
108e4d8eb4 feat: add web activation instructions to bundled agents
- Created agent-activation-web.xml with bundled file access instructions
- Updated web-bundler to inject web activation into all agent bundles
- Agents now understand how to access <file> elements instead of filesystem
- Includes workflow execution instructions for bundled environments
- Generated new web bundles with activation blocks
2025-09-30 00:32:20 -05:00
Brian Madison
688a841127 missed a workflow update 2025-09-30 00:24:27 -05:00
Brian Madison
c26220daec installer and bundler progress 2025-09-30 00:24:27 -05:00
Brian Madison
ae136ceb03 web_bundle info added to workflow yamls 2025-09-30 00:24:27 -05:00
Brian Madison
9934224230 workflows indicate web_bundle file inclusions 2025-09-30 00:24:27 -05:00
Murat K Ozcan
023edd1b7b Merge pull request #657 from bmad-code-org/docs/spot-update-tea
docs: spot update test architect
2025-09-29 19:54:27 -05:00
Murat Ozcan
24b3a42f85 docs: improved tea wording 2025-09-29 17:01:50 -05:00
Murat Ozcan
bf24530ba6 docs: spot update test architect 2025-09-29 16:58:44 -05:00
Murat K Ozcan
9645a8ed0d Docs/update test architect for brian (#655)
Update Docs for TestArch

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
2025-09-29 16:43:20 -05:00
Brian Madison
eb999e8c82 readme updates and open items published 2025-09-29 10:13:22 -05:00
Brian Madison
b97376f8fa simpler install for just the branch suggestion added to readme 2025-09-29 08:32:23 -05:00
Brian Madison
83b09212ca readme installation instruction update 2025-09-29 08:27:48 -05:00
Brian Madison
bd79dd9752 readupme install instruction update 2025-09-29 08:00:30 -05:00
Brian Madison
0a6a3f3015 feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
lihangmissu
52f6889089 fix: BMAD Brownfield Document Naming Inconsistency Bug (#627) 2025-09-19 18:08:31 -05:00
Javier Gomez
f09e282d72 feat(opencode): add JSON-only integration and compact AGENTS.md generator (#570)
* feat: add OpenCode integration implementation plan for BMAD-METHOD

* installer(opencode): add OpenCode target metadata in install.config.yaml

* chore(deps): add comment-json for JSONC parsing in OpenCode integration

* feat(installer/opencode): implement setupOpenCode with minimal instructions merge and BMAD-managed agents/commands

* feat(installer): add OpenCode (SST) to IDE selector and CLI --ide help

* fix(opencode): align generated opencode.json(c) with schema (instructions as strings; agent.prompt; command.template; remove unsupported fields)

* feat(installer): enhance OpenCode setup with agent selection and prefix options

* fix: update configuration file references from `bmad-core/core-config.yaml` to `.bmad-core/core-config.yaml` across multiple agent and task files for consistency and clarity.

* refactor: streamline OpenCode configuration prompts and normalize instruction paths for agents and tasks

* feat: add tools property to agent definitions for enhanced functionality. Otherwise opencode consders the subagents as readonly

* feat: add extraction of 'whenToUse'  from agents markdown files for improved agent configuration in opencode

* feat: enhance task purpose extraction from markdown files with improved parsing and cleanup logic

* feat: add collision warnings for non-BMAD-managed agent and command keys during setup

* feat: generate and update AGENTS.md for OpenCode integration with agent and task details

* feat: add compact AGENTS.md generator and JSON-only integration for OpenCode

* chore(docs): remove completed OpenCode integration implementation plans

* feat: enable default prefixes for agent and command keys to avoid collisions

* fix: remove unnecessary line breaks in 'whenToUse' descriptions for QA agents to mathc the rest of the agents definitions and improve programatic parsing of whenToUse prop

* fix: update OpenCode references to remove 'SST' for consistency across documentation and configuration

* fix: update agent mode from 'subagent' to 'all' for consistency in agent definitions

* fix: consolidate 'whenToUse' description format for clarity and consistent parsing
2025-09-11 17:44:41 -05:00
Daniel Dabrowski
2b247ea385 fix: Changed title to coding standards section of brownfield architecture template (#564)
* fix: simplify title in coding standards section of brownfield architecture template

* fix: update section titles in brownfield architecture template for clarity
2025-09-09 18:52:03 -05:00
Brian Madison
925099dd8c remove errant command from readme 2025-09-08 19:36:08 -05:00
Daniel Dabrowski
a19561a16c fix: update workflow file extensions from .md to .yaml in bmad-master.md (#562) 2025-09-08 19:34:23 -05:00
Brian Madison
de6c14df07 documentation updates 2025-09-06 18:30:37 -05:00
sjennings
f20d572216 Godot Game Dev expansion pack for BMAD (#532)
* Godot Game Dev expansion pack for BMAD

* Workflow changes

* Workflow changes

* Fixing config.yaml, editing README.md to indicate correct workflow

* Fixing references to config.yaml, adding missing QA review to game-dev agent

* More game story creation fixes

* More game story creation fixes

* Adding built web agent file

* - Adding ability for QA agent to have preloaded context files similar to Dev agent.
- Fixing stray Unity references in game-architecture-tmpl.yaml

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:49:21 -05:00
liyuyun-lyy
076c104b2c feat: add iflow cli support to bmad installer. (#510)
* feat: add iflow cli support

* chore: update project dependencies and development tooling (#508)

- Update various direct and transitive project dependencies.
- Remove the circular `bmad-method` self-dependency.
- Upgrade ESLint, Prettier, Jest, and other dev tools.
- Update semantic-release and related GitHub packages.

Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>

* refactor: refactor by format

---------

Co-authored-by: Kayvan Sylvan <kayvan@sylvan.com>
Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>
Co-authored-by: PinkyD <paulbeanjr@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:44:48 -05:00
Armel BOBDA
87d68d31fd fix: update .gitignore to correct cursor file entry (#485)
This change modifies the .gitignore file to ensure the cursor file is properly ignored by removing the incorrect entry and adding the correct one. This helps maintain a cleaner repository by preventing unnecessary files from being tracked.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:43:05 -05:00
Drilmo
a05b05cec0 fix: Template file extension in validation next story steps (#523)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:40:30 -05:00
VansonLeung
af36864625 Update ide-setup.js - add missing glob require (#514)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:38:29 -05:00
Yoav Gal
5ae4c51883 added gemini cli custom commands! (#549)
* added gemini cli custom commands!

* improvements and changes post review

* updated bmad to BMad

* removed gemini-extension.json

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:19:47 -05:00
Yuewen Ma
ac7f2437f8 Fixed: "glob" is not defined (#504)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:16:10 -05:00
Daniel Dabrowski
94f67000b2 feat: enhance file exclusion capabilities with .bmad-flattenignore support (#531)
- Added support for a new optional `.bmad-flattenignore` file to allow users to specify additional files to exclude from the flattened XML output.
- Updated README and documentation to reflect the new feature and provide examples for usage.
- Modified ignore rules to incorporate patterns from the `.bmad-flattenignore` file after applying `.gitignore` rules.

Benefits:
- Greater flexibility in managing file exclusions for AI model consumption.
2025-09-06 13:14:24 -05:00
Hau Vo
155f9591ea feat: Add Auggie CLI (Augment Code) Integration (#520)
* feat: add Augment Code IDE support with multi-location installation options

- Add Augment Code to supported IDE list in installer CLI and interactive prompts
- Configure multi-location setup for Augment Code commands:
  - User Commands: ~/.augment/commands/bmad/ (global, user-wide)
  - Workspace Commands: ./.augment/commands/bmad/ (project-specific, team-shared)
- Update IDE configuration with proper location handling and tilde expansion
- Add interactive prompt for users to select installation locations
- Update documentation in bmad-kb.md to include Augment Code in supported IDEs
- Implement setupAugmentCode method with location selection and file installation

This enables BMAD Method integration with Augment Code's custom command system,
allowing users to access BMad agents via /agent-name slash commands in both
global and project-specific contexts.

* Added options to choose the rule locations

* Update instruction to match with namespace for commands

* Update instruction to match with namespace for commands

* Renamed Augment Code to Auggie CLI (Augment Code)

---------

Co-authored-by: Hau Vo <hauvo@Haus-Mac-mini.local>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-02 12:16:26 -05:00
Mikhail Romanov
6919049eae fix: Codex options missing from the IDE selection menu (#535) 2025-09-02 12:13:00 -05:00
Brian Madison
fbd8f1fd73 Expansion pack doc correction 2025-08-31 22:15:40 -05:00
Brian Madison
384e17ff2b docs: remove misplaced Codex section from README
- Remove IDE-specific Codex documentation from end of README
- This content was oddly placed after the footer
- IDE-specific docs should be in separate documentation
2025-08-31 22:05:29 -05:00
Brian Madison
b9bc196e7f chore: sync version to 4.42.1 after release
- Update package.json to match published npm version
- Update installer package.json to match
2025-08-31 21:57:39 -05:00
Brian Madison
0a6cbd72cc chore: bump version to 4.42.0 for release
- Update main package.json to 4.42.0
- Update installer package.json to 4.42.0
- Add PR validation workflow and contribution checks
- Add pre-release and fix scripts
- Update CONTRIBUTING.md with validation requirements
2025-08-31 21:45:21 -05:00
Brian
e2e8d44e5d test: trigger PR validation (#533)
Co-authored-by: Brian Madison <brianmadison@Brians-MacBook-Pro.local>
2025-08-31 20:34:39 -05:00
Brian Madison
fb70c20067 feat: add PR validation workflow and contribution checks 2025-08-31 20:30:52 -05:00
Jonathan Borgwing
05736fa069 feat(installer): add Codex CLI + Codex Web modes, generate AGENTS.md, inject npm scripts, and docs (#529) 2025-08-31 17:48:03 -05:00
Bragatte
052e84dd4a feat: implement fork-friendly CI/CD with opt-in mechanism (#476)
- CI/CD disabled by default in forks to conserve resources
- Users can enable via ENABLE_CI_IN_FORK repository variable
- Added comprehensive Fork Guide documentation
- Updated README with Contributing section
- Created automation script for future implementations

Benefits:
- Saves GitHub Actions minutes across 1,600+ forks
- Cleaner fork experience for contributors
- Full control for fork owners
- PR validation still runs automatically

BREAKING CHANGE: CI/CD no longer runs automatically in forks.
Fork owners must set ENABLE_CI_IN_FORK=true to enable workflows.

Co-authored-by: Brian <bmadcode@gmail.com>
Co-authored-by: PinkyD <paulbeanjr@gmail.com>
2025-08-30 22:15:31 -05:00
Piatra Automation
f054d68c29 fix: correct dependency path format in bmad-master agent (#495)
- Change 'Dependencies map to root/type/name' to 'Dependencies map to {root}/{type}/{name}'
- Fixes path resolution issue where 'root' was treated as literal directory name
- Ensures proper variable interpolation for dependency file loading
- Resolves agent inability to find core-config.yaml and other project files
2025-08-30 22:14:52 -05:00
Wang-tianhao
44836512e7 Update dev.md (#491)
To avoid AI creating new folder for a new story tasks
2025-08-30 22:10:02 -05:00
Chris Calo
bf97f05190 typo in README.md (#515) 2025-08-26 23:57:41 -05:00
Kayvan Sylvan
a900d28080 chore: update project dependencies and development tooling (#508)
- Update various direct and transitive project dependencies.
- Remove the circular `bmad-method` self-dependency.
- Upgrade ESLint, Prettier, Jest, and other dev tools.
- Update semantic-release and related GitHub packages.

Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>
2025-08-24 21:45:18 -05:00
circus
ab70baca59 fix: remove incorrect else branch causing flatten command regression (#452)
This fixes a regression bug where the flatten command would fail with an
error message even when valid arguments were provided.

The bug was:
- First introduced in commit 0fdbca7
- Fixed in commit fab9d5e (v5.0.0-beta.2)
- Accidentally reintroduced in commit ed53943

The else branch at lines 130-134 was incorrectly handling the case when
users provided arguments, showing a misleading error about
'no arguments provided' when arguments were actually present.

Fixes all flatten command variations:
- npx bmad-method flatten
- npx bmad-method flatten --input /path
- npx bmad-method flatten --output file.xml
- npx bmad-method flatten --input /path --output file.xml

Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-17 22:09:56 -05:00
Brian Madison
80d73d9093 fix: documentation and trademark updates 2025-08-17 19:23:50 -05:00
Brian Madison
f3cc410fb0 patch: move script to tools folder 2025-08-17 11:04:27 -05:00
Brian Madison
868ae23455 fix: previous merge set wrong default install location 2025-08-17 11:01:20 -05:00
Brian Madison
9de873777a fix: prettier fixes 2025-08-17 07:51:46 -05:00
Brian Madison
04c485b72e chore: bump to 4.39.1 to fix installer version display 2025-08-17 07:13:09 -05:00
Brian Madison
68eb31da77 fix: update installer version display to show 4.39.0 2025-08-17 07:12:53 -05:00
Brian Madison
c00d0aec88 chore: rollback to v4.39.0 from v5.x semantic versioning 2025-08-17 07:07:30 -05:00
Brian Madison
6543cb2a97 chore: bump version to 5.1.4 2025-08-17 00:30:15 -05:00
Brian Madison
b6fe44b16e fix: alphabetize agent commands and dependencies for improved organization
- Alphabetized all commands in agent files while maintaining help first and exit last
- Alphabetized all dependency categories (checklists, data, tasks, templates, utils, workflows)
- Alphabetized items within each dependency category across all 10 core agents:
  - analyst.md: commands and dependencies reorganized
  - architect.md: commands and dependencies reorganized
  - bmad-master.md: commands and dependencies reorganized, fixed YAML parsing issue
  - bmad-orchestrator.md: commands and dependencies reorganized
  - dev.md: commands and dependencies reorganized
  - pm.md: commands and dependencies reorganized
  - po.md: commands and dependencies reorganized
  - qa.md: commands and dependencies reorganized
  - sm.md: commands and dependencies reorganized
  - ux-expert.md: commands and dependencies reorganized
- Fixed YAML parsing error in bmad-master.md by properly quoting activation instructions
- Rebuilt all agent bundles and team bundles successfully
- Updated expansion pack bundles including new creative writing agents

This improves consistency and makes it easier to locate specific commands and dependencies
across all agent configurations.
2025-08-17 00:30:04 -05:00
Brian Madison
ac09300075 temporarily remove GCP agent system until it is completed in the experimental branch 2025-08-17 00:06:09 -05:00
DrBalls
b756790c17 Add Creative Writing expansion pack (#414)
* Add Creative Writing expansion pack
- 10 specialized writing agents for fiction and narrative design
- 8 complete workflows (novel, screenplay, short story, series)
- 27 quality checklists for genre and technical validation
- 22 writing tasks covering full creative process
- 8 professional templates for structured writing
- KDP publishing integration support

* Fix bmad-creative-writing expansion pack formatting and structure

- Convert all agents to standard BMAD markdown format with embedded YAML
- Add missing core dependencies (create-doc, advanced-elicitation, execute-checklist)
- Add bmad-kb.md customized for creative writing context
- Fix agent dependency references to only include existing files
- Standardize agent command syntax and activation instructions
- Clean up agent dependencies for beta-reader, dialog-specialist, editor, genre-specialist, narrative-designer, and world-builder

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-16 23:55:43 -05:00
Anthony
49347a8cde Feat(Expansion Pack): Part 2 - Agent System Templates (#370)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-16 23:47:30 -05:00
Brian, with AI
335e1da271 fix: add default current directory to installer prompt (#444)
Previously users had to manually type the full path or run pwd to get
the current directory when installing BMad. Now the installer prefills
the current working directory as the default, improving UX.

Co-authored-by: its-brianwithai <brian@ultrawideturbodev.com>
2025-08-16 22:08:06 -05:00
Brian Madison
6e2fbc6710 docs: add sync-version.sh script to troubleshooting section 2025-08-16 22:03:19 -05:00
Brian Madison
45dd7d1bc5 add: sync-version.sh script for easy version syncing 2025-08-16 22:02:12 -05:00
manjaroblack
db80eda9df refactor: centralize qa paths in core-config.yaml and update agent activation flows (#451)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-16 21:38:33 -05:00
Brian Madison
f5272f12e4 sync: update to published version 5.1.3 2025-08-16 21:35:12 -05:00
Brian Madison
26890a0a03 sync: update versions to 5.1.2 to match published release 2025-08-16 21:20:17 -05:00
Brian Madison
cf22fd98f3 fix: correct version to 5.1.1 after patch release
- npm latest tag now correctly points to 5.1.0
- package.json updated to 5.1.1 (what patch should have made)
- installer version synced
2025-08-16 21:10:46 -05:00
Brian Madison
fe318ecc07 sync: update package.json to match published version 5.0.1 2025-08-16 21:09:36 -05:00
Brian Madison
f959a07bda fix: update installer package.json version to 5.1.0
- Fixes version reporting in npx bmad-method --version
- Ensures installer displays correct version number
2025-08-16 21:04:32 -05:00
Brian Madison
c0899432c1 fix: simplify npm publishing to use latest tag only
- Remove stable tag complexity from workflow
- Publish directly to latest tag (default for npx)
- Update documentation to reflect single tag approach
2025-08-16 20:58:22 -05:00
Brian Madison
8573852a6e docs: update versioning and releases documentation
- Replace old semantic-release documentation with new simplified system
- Document command line release workflow (npm run release:*)
- Explain automatic release notes generation and categorization
- Add troubleshooting section and preview functionality
- Reflect current single @stable tag installation approach
2025-08-16 20:50:22 -05:00
Brian Madison
39437e9268 fix: handle protected branch in manual release workflow
- Allow workflow to continue even if push to main fails
- This is expected behavior with protected branches
- NPM publishing and GitHub releases will still work
2025-08-16 20:44:00 -05:00
Brian Madison
1772a30368 fix: enable version bumping in manual release workflow
- Fix version-bump.js to actually update package.json version
- Add tag existence check to prevent duplicate tag errors
- Remove semantic-release dependency from version bumping
2025-08-16 20:42:35 -05:00
Brian Madison
ba4fb4d084 feat: add convenient npm scripts for command line releases
- npm run release:patch/minor/major for triggering releases
- npm run release:watch for monitoring workflow progress
- One-liner workflow: preview:release && release:minor && release:watch
2025-08-16 20:38:58 -05:00
Brian Madison
3eb706c49a feat: enhance manual release workflow with automatic release notes
- Add automatic release notes generation from commit history
- Categorize commits into Features, Bug Fixes, and Maintenance
- Include installation instructions and changelog links
- Add preview-release-notes script for testing
- Update GitHub release creation to use generated notes
2025-08-16 20:35:41 -05:00
Brian Madison
3f5abf347d feat: simplify installation to single @stable tag
- Remove automatic versioning and dual publishing strategy
- Delete release.yaml and promote-to-stable.yaml workflows
- Add manual-release.yaml for controlled releases
- Remove semantic-release dependencies and config
- Update all documentation to use npx bmad-method install
- Configure NPM to publish to @stable tag by default
- Users can now use simple npx bmad-method install command
2025-08-16 20:23:23 -05:00
manjaroblack
ed539432fb chore: add code formatting config and pre-commit hooks (#450) 2025-08-16 19:08:39 -05:00
Brian Madison
51284d6ecf fix: handle existing tags in promote-to-stable workflow
- Check for existing git tags when calculating new version
- Automatically increment version if tag already exists
- Prevents workflow failure when tag v5.1.0 already exists
2025-08-16 17:14:38 -05:00
Brian Madison
6cba05114e fix: stable tag 2025-08-16 17:10:10 -05:00
Murat K Ozcan
ac360cd0bf chore: configure changelog file path in semantic-release config (#448)
Co-authored-by: Murat Ozcan <murat@Murats-MacBook-Pro.local>
2025-08-16 16:27:45 -05:00
manjaroblack
fab9d5e1f5 feat(flattener): prompt for detailed stats; polish .stats.md with emojis (#422)
* feat: add detailed statistics and markdown report generation to flattener tool

* fix: remove redundant error handling for project root detection
2025-08-16 08:03:28 -05:00
Brian Madison
93426c2d2f feat: publish stable release 5.0.0
BREAKING CHANGE: Promote beta features to stable release for v5.0.0

This commit ensures the stable release gets properly published to NPM and GitHub releases.
2025-08-15 23:06:28 -05:00
github-actions[bot]
f56d37a60a release: promote to stable 5.0.0
- Promote beta features to stable release
- Update version from 4.38.0 to 5.0.0
- Automated promotion via GitHub Actions
2025-08-15 23:06:28 -05:00
github-actions[bot]
224cfc05dc release: promote to stable 4.38.0
- Promote beta features to stable release
- Update version from 4.37.0 to 4.38.0
- Automated promotion via GitHub Actions
2025-08-15 23:06:27 -05:00
Brian Madison
6cb2fa68b3 fix: update package-lock.json for semver dependency 2025-08-15 23:06:27 -05:00
Brian Madison
d21ac491a0 release: create stable 4.37.0 release
Promote beta features to stable release with dual publishing support
2025-08-15 23:06:27 -05:00
Thiago Freitas
848e33fdd9 Feature: Installer commands for Crush CLI (#429)
* feat: add support for Crush IDE configuration and commands

* fix: update Crush IDE instructions for clarity on persona/task switching

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-15 22:38:44 -05:00
Murat K Ozcan
0b61175d98 feat: transform QA agent into Test Architect with advanced quality ca… (#433)
* feat: transform QA agent into Test Architect with advanced quality capabilities

  - Add 6 specialized quality assessment commands
  - Implement risk-based testing with scoring
  - Create quality gate system with deterministic decisions
  - Add comprehensive test design and NFR validation
  - Update documentation with stage-based workflow integration

* feat: transform QA agent into Test Architect with advanced quality capabilities

  - Add 6 specialized quality assessment commands
  - Implement risk-based testing with scoring
  - Create quality gate system with deterministic decisions
  - Add comprehensive test design and NFR validation
  - Update documentation with stage-based workflow integration

* docs: refined the docs for test architect

* fix: addressed review comments from manjaroblack, round 1

* fix: addressed review comments from manjaroblack, round 1

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-15 21:02:37 -05:00
cecil-the-coder
33269c888d fix: resolve CommonJS import compatibility for chalk, inquirer, and ora (#442)
Adds .default fallback for CommonJS imports to resolve compatibility issues
with newer versions of chalk, inquirer, and ora packages.

Fixes installer failures when error handlers or interactive prompts are triggered.

Changes:
- chalk: require('chalk').default || require('chalk')
- inquirer: require('inquirer').default || require('inquirer')
- ora: require('ora').default || require('ora')

Affects: installer.js, ide-setup.js, file-manager.js, ide-base-setup.js, bmad.js

Co-authored-by: Cecil <cecilthecoder@gmail.com>
2025-08-15 21:01:30 -05:00
Brian Madison
7f016d0020 fix: add permissions and authentication for promotion workflow
- Add contents:write permission for GitHub Actions
- Configure git to use GITHUB_TOKEN for authentication
- Set remote URL with access token for push operations
- This should resolve the 403 permission denied error
2025-08-15 20:25:12 -05:00
Brian Madison
8b0b72b7b4 docs: document dual publishing strategy and automated promotion
- Add comprehensive documentation for dual publishing workflow
- Document GitHub Actions promotion process
- Clarify user experience for stable vs beta installations
- Include step-by-step promotion instructions
2025-08-15 20:18:36 -05:00
Brian Madison
1c3420335b test: trigger beta release to test current workflow
This will create a new beta version that we can then promote to stable using the new automated workflow
2025-08-15 20:17:58 -05:00
Brian Madison
fb02234b59 feat: add automated promotion workflow for stable releases
- Add GitHub Actions workflow for one-click promotion to stable
- Supports patch/minor/major version bumps
- Automatically merges main to stable and handles version updates
- Eliminates manual git operations for stable releases
2025-08-15 20:17:49 -05:00
Brian Madison
e0dcbcf527 fix: update versions for dual publishing beta releases 2025-08-15 20:03:10 -05:00
Brian Madison
75ba8d82e1 feat: republish beta with corrected dependencies and tags 2025-08-15 19:39:35 -05:00
Brian Madison
f3e429d746 feat: trigger new beta release with fixed dependencies
This creates a new beta version that includes the semver dependency fix
2025-08-15 19:38:06 -05:00
Brian Madison
5ceca3aeb9 fix: add semver dependency and correct NPM dist-tag configuration
- Add missing semver dependency to installer package.json
- Configure semantic-release to use correct channels (beta/latest)
- This ensures beta releases publish to @beta tag correctly
2025-08-15 19:33:07 -05:00
Brian Madison
8e324f60b0 fix: remove git plugin to resolve branch protection conflicts
- Beta releases don't need to commit version bumps back to repo
- This allows semantic-release to complete successfully
- NPM publishing will still work for @beta tag
2025-08-15 19:15:55 -05:00
Brian Madison
8a29f0e319 test: verify dual publishing workflow 2025-08-15 19:14:32 -05:00
Brian Madison
d92ba835fa feat: implement dual NPM publishing strategy
- Configure semantic-release for @beta and @latest tags
- Main branch publishes to @beta (bleeding edge)
- Stable branch publishes to @latest (production)
- Enable CI/CD workflow for both branches
2025-08-15 19:03:48 -05:00
Aaron
9868437f10 Add update-check command (#423)
* Add update-check command

* Adding additional information to update-check command and aligning with cli theme

* Correct update-check message to exclude global
2025-08-14 22:24:37 -05:00
Stefan Klümpers
d563266b97 feat: install Cursor rules to subdirectory (#438)
* feat: install Cursor rules to subdirectory

Implement feature request #376 to avoid filename collisions and confusion
between repo-specific and BMAD-specific rules.

Changes:
- Move Cursor rules from .cursor/rules/ to .cursor/rules/bmad/
- Update installer configuration to use new subdirectory structure
- Update upgrader to reflect new rule directory path

This keeps BMAD Method files separate from existing project rules,
reducing chance of conflicts and improving organization.

Fixes #376

* chore: correct formatting in cursor rules directory path

---------

Co-authored-by: Stefan Klümpers <stefan.kluempers@materna.group>
2025-08-14 22:23:44 -05:00
Yongjip Kim
3efcfd54d4 fix(docs): fix broken link in GUIDING-PRINCIPLES.md (#428)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-14 13:40:11 -05:00
Benjamin Wiese
31e44b110e Remove bmad-core/bmad-core including empty file (#431)
Co-authored-by: Ben Wiese <benjamin.wiese@simplifier.io>
2025-08-14 13:39:28 -05:00
semantic-release-bot
ffcb4d4bf2 chore(release): 4.36.2 [skip ci]
## [4.36.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.36.1...v4.36.2) (2025-08-10)

### Bug Fixes

* align installer dependencies with root package versions for ESM compatibility ([#420](https://github.com/bmadcode/BMAD-METHOD/issues/420)) ([3f6b674](3f6b67443d))
2025-08-10 14:26:15 +00:00
circus
3f6b67443d fix: align installer dependencies with root package versions for ESM compatibility (#420)
Downgrade chalk, inquirer, and ora in tools/installer to CommonJS-compatible versions:
- chalk: ^5.4.1 -> ^4.1.2
- inquirer: ^12.6.3 -> ^8.2.6
- ora: ^8.2.0 -> ^5.4.1

Resolves 'is not a function' errors caused by ESM/CommonJS incompatibility.
2025-08-10 09:25:46 -05:00
semantic-release-bot
85a0d83fc5 chore(release): 4.36.1 [skip ci]
## [4.36.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.36.0...v4.36.1) (2025-08-09)

### Bug Fixes

* update Node.js version to 20 in release workflow and reduce Discord spam ([3f7e19a](3f7e19a098))
2025-08-09 20:49:42 +00:00
Brian Madison
3f7e19a098 fix: update Node.js version to 20 in release workflow and reduce Discord spam
- Update release workflow Node.js version from 18 to 20 to match package.json requirements
- Remove push trigger from Discord workflow to reduce notification spam

This should resolve the semantic-release content-length header error after org migration.
2025-08-09 15:49:13 -05:00
semantic-release-bot
23df54c955 chore(release): 4.36.0 [skip ci]
# [4.36.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.35.3...v4.36.0) (2025-08-09)

### Features

* modularize flattener tool into separate components with improved project root detection ([#417](https://github.com/bmadcode/BMAD-METHOD/issues/417)) ([0fdbca7](0fdbca73fc))
2025-08-09 20:33:49 +00:00
manjaroblack
0fdbca73fc feat: modularize flattener tool into separate components with improved project root detection (#417) 2025-08-09 15:33:23 -05:00
Daniel Willitzer
5d7d7c9015 Merge pull request #369 from antmikinka/pr/part-1-gcp-setup
Feat(Expansion Pack): Part 1 - Google Cloud Setup
2025-08-08 19:23:48 -07:00
Brian Madison
dd2b4ed5ac discord PR spam 2025-08-08 20:07:32 -05:00
Lior Assouline
8f40576681 Flatten venv & many other bins dir fix (#408)
* added .venv to ignore list of flattener

* more files pattern to ignore

---------

Co-authored-by: Lior Assouline <Lior.Assouline@harmonicinc.com>
2025-08-08 07:54:47 -05:00
Yanqing Wang
fe86675c5f Update link in README.md (#384) 2025-08-07 07:49:14 -05:00
semantic-release-bot
8211d2daff chore(release): 4.35.3 [skip ci]
## [4.35.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.35.2...v4.35.3) (2025-08-06)

### Bug Fixes

* doc location improvement ([1676f51](1676f5189e))
2025-08-06 05:01:55 +00:00
Brian Madison
1676f5189e fix: doc location improvement 2025-08-06 00:00:26 -05:00
semantic-release-bot
3c3d58939f chore(release): 4.35.2 [skip ci]
## [4.35.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.35.1...v4.35.2) (2025-08-06)

### Bug Fixes

* npx status check ([f7c2a4f](f7c2a4fb6c))
2025-08-06 03:34:49 +00:00
Brian Madison
2d954d3481 merge 2025-08-05 22:34:21 -05:00
Brian Madison
f7c2a4fb6c fix: npx status check 2025-08-05 22:33:47 -05:00
semantic-release-bot
9df28d5313 chore(release): 4.35.1 [skip ci]
## [4.35.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.35.0...v4.35.1) (2025-08-06)

### Bug Fixes

* npx hanging commands ([2cf322e](2cf322ee0d))
2025-08-06 03:22:35 +00:00
Brian Madison
2cf322ee0d fix: npx hanging commands 2025-08-05 22:22:04 -05:00
semantic-release-bot
5dc4043577 chore(release): 4.35.0 [skip ci]
# [4.35.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.34.0...v4.35.0) (2025-08-04)

### Features

* add qwen-code ide support to bmad installer. ([#392](https://github.com/bmadcode/BMAD-METHOD/issues/392)) ([a72b790](a72b790f3b))
2025-08-04 01:24:35 +00:00
Houston Zhang
a72b790f3b feat: add qwen-code ide support to bmad installer. (#392)
Co-authored-by: Djanghao <hstnz>
2025-08-03 20:24:09 -05:00
semantic-release-bot
55f834954f chore(release): 4.34.0 [skip ci]
# [4.34.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.33.1...v4.34.0) (2025-08-03)

### Features

* add KiloCode integration support to BMAD installer ([#390](https://github.com/bmadcode/BMAD-METHOD/issues/390)) ([dcebe91](dcebe91d5e))
2025-08-03 14:50:09 +00:00
Mbosinwa Awunor
dcebe91d5e feat: add KiloCode integration support to BMAD installer (#390) 2025-08-03 09:49:39 -05:00
caseyrubin
ce5b37b628 Update user-guide.md (#378)
Align pre-dev validation cycle with BMad method.
2025-07-30 22:07:19 -05:00
yaksh gandhi
c079c28dc4 Update README.md (#338) 2025-07-28 21:07:24 -05:00
semantic-release-bot
4fc8e752a6 chore(release): 4.33.1 [skip ci]
## [4.33.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.33.0...v4.33.1) (2025-07-29)

### Bug Fixes

* dev agent yaml syntax for develop-story command ([#362](https://github.com/bmadcode/BMAD-METHOD/issues/362)) ([bcb3728](bcb3728f88))
2025-07-29 02:05:28 +00:00
Duane Cilliers
bcb3728f88 fix: dev agent yaml syntax for develop-story command (#362) 2025-07-28 21:05:00 -05:00
semantic-release-bot
f7963cbaa9 chore(release): 4.33.0 [skip ci]
# [4.33.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.32.0...v4.33.0) (2025-07-28)

### Features

* version bump ([e9dd4e7](e9dd4e7beb))
2025-07-28 04:54:52 +00:00
Brian Madison
e9dd4e7beb feat: version bump 2025-07-27 23:54:23 -05:00
manjaroblack
a80ea150f2 eat: enhance flattener tool with improved CLI integration and custom directory support (#372)
* feat(cli): move flatten command to installer and update docs

Refactor the flatten command from tools/cli.js to tools/installer/bin/bmad.js for better integration. Add support for custom input directory and improve error handling. Update documentation in README.md and working-in-the-brownfield.md to reflect new command usage. Also clean up package-lock.json and add it to .gitignore.

* chore: update gitignore and add package-lock.json for installer tool

Remove package-lock.json from root gitignore since it's now needed for the installer tool
Add package-lock.json with dependencies for the bmad-method installer

---------

Co-authored-by: Devin Stagner <devin@blackstag.family>
2025-07-27 18:02:08 -05:00
antmikinka
c7fc5d3606 Feat(Expansion Pack): Part 1 - Google Cloud Setup 2025-07-27 12:26:53 -07:00
semantic-release-bot
a2ddf926e5 chore(release): 4.32.0 [skip ci]
# [4.32.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.31.0...v4.32.0) (2025-07-27)

### Bug Fixes

* Add package-lock.json to fix GitHub Actions dependency resolution ([cce7a75](cce7a758a6))
* GHA fix ([62ccccd](62ccccdc9e))

### Features

* Overhaul and Enhance 2D Unity Game Dev Expansion Pack ([#350](https://github.com/bmadcode/BMAD-METHOD/issues/350)) ([a7038d4](a7038d43d1))
2025-07-27 03:35:50 +00:00
Brian Madison
62ccccdc9e fix: GHA fix 2025-07-26 22:35:23 -05:00
Brian Madison
cce7a758a6 fix: Add package-lock.json to fix GitHub Actions dependency resolution 2025-07-26 14:59:02 -05:00
manjaroblack
5efbff3227 Feat/flattener-tool (#337)
* This PR introduces a powerful new Codebase Flattener Tool that aggregates entire codebases into AI-optimized XML format, making it easy to share project context with AI assistants for analysis, debugging, and development assistance.

- AI-Optimized XML Output : Generates clean, structured XML specifically designed for AI model consumption
- Smart File Discovery : Recursive file scanning with intelligent filtering using glob patterns
- Binary File Detection : Automatically identifies and excludes binary files, focusing on source code
- Progress Tracking : Real-time progress indicators with comprehensive completion statistics
- Flexible Output : Customizable output file location and naming via CLI arguments
- Gitignore Integration : Automatically respects .gitignore patterns to exclude unnecessary files
- CDATA Handling : Proper XML CDATA sections with escape sequence handling for ]]> patterns
- Content Indentation : Beautiful XML formatting with properly indented file content (4-space indentation)
- Error Handling : Robust error handling with detailed logging for problematic files
- Hierarchical Formatting : Clean XML structure with proper indentation and formatting
- File Content Preservation : Maintains original file formatting within indented CDATA sections
- Exclusion Logic : Prevents self-inclusion of output files ( flattened-codebase.xml , repomix-output.xml )
- tools/flattener/main.js - Complete flattener implementation with CLI interface
- package.json - Added new dependencies (glob, minimatch, fs-extra, commander, ora, chalk)
- package-lock.json - Updated dependency tree
- .gitignore - Added exclusions for flattener outputs
- README.md - Comprehensive documentation with usage examples
- docs/bmad-workflow-guide.md - Integration guidance
- tools/cli.js - CLI integration
- .vscode/settings.json - SonarLint configuration
```
current directory
npm run flatten

npm run flatten -- --output my-project.xml
npm run flatten -- -o /path/to/output/codebase.xml
```
The tool provides comprehensive completion summaries including:

- File count and breakdown (text/binary/errors)
- Source code size and generated XML size
- Total lines of code and estimated token count
- Processing progress and performance metrics
- Bug Fix : Corrected typo in exclusion patterns ( repromix-output.xml → repomix-output.xml )
- Performance : Efficient file processing with streaming and progress indicators
- Reliability : Comprehensive error handling and validation
- Maintainability : Clean, well-documented code with modular functions
- AI Integration : Perfect for sharing codebase context with AI assistants
- Code Reviews : Streamlined code review process with complete project context
- Documentation : Enhanced project documentation and analysis capabilities
- Development Workflow : Improved development assistance and debugging support
This tool significantly enhances the BMad-Method framework's AI integration capabilities, providing developers with a seamless way to share complete project context for enhanced AI-assisted development workflows.

* docs(bmad-core): update documentation for enhanced workflow and user guide

- Fix typos and improve clarity in user guide
- Add new enhanced development workflow documentation
- Update brownfield workflow with flattened codebase instructions
- Improve consistency in documentation formatting

* chore: remove unused files and configurations

- Delete deprecated bmad workflow guide and roomodes file
- Remove sonarlint project configuration
- Downgrade ora dependency version
- Remove jest test script

* Update package.json

Removed jest as it is not needed.

* Update working-in-the-brownfield.md

added documentation for sharding docs

* perf(flattener): improve memory efficiency by streaming xml output

- Replace in-memory XML generation with streaming approach
- Add comprehensive common ignore patterns list
- Update statistics calculation to use file size instead of content length

* fix/chore: Update console.log for user-guide.md install path. Cleaned up config files/folders and updated .gitignore (#347)

* fix: Update console.log for user-guide.md install path

Changed
IMPORTANT: Please read the user guide installed at docs/user-guilde.md
to
IMPORTANT: Please read the user guide installed at .bmad-core/user-guide.md

WHY: the actual install location of the user-guide.md is in the .bmad-core directory.

* chore: remove formatting configs and clean up gitignore

- Delete husky pre-commit hook and prettier config files
- Remove VS Code chat/copilot settings
- Reorganize and clean up gitignore entries

* feat: Overhaul and Enhance 2D Unity Game Dev Expansion Pack (#350)

* Updated game-sm agent to match the new core framework patterns

* feat:Created more comprehensive game story matching new format system as well

* feat:Added Game specific course correct task

* feat:Updated dod-checklist to match new DoD format

* feat:Added new Architect agent for appropriate architecture doc creation and design

* feat:Overhaul of game-architecture-tmpl template

* feat:Updated rest of templates besides level which doesnt really need it

* feat: Finished extended architecture documentation needed for new game story tasks

* feat: Updated game Developer to new format

* feat: Updated last agent to new format and updated bmad-kb. bmad-kb I did my best with but im not sure of it's valid usage in the expansion pack, the AI generated more of the file then myself. I made sure to include it due to the new core-config file

* feat: Finished updating designer agent to new format and cleaned up template linting errors

* Built dist for web bundle

* Increased expansion pack minor verison number

* Updated architecht and design for sharding built-in

* chore: bump bmad-2d-unity-game-dev version (minor)

* updated config.yaml for game-specific pieces to supplement core-config.yaml

* Updated game-core-config and epic processing for game story and game design. Initial implementation was far too generic

* chore: bump bmad-2d-unity-game-dev version (patch)

* feat: Fixed issue with multi-configs being needed. chore: bump bmad-2d-unity-game-dev version (patch)

* Chore: Built web-bundle

* feat: Added the ability to specify the unity editor install location.\nchore: bump bmad-2d-unity-game-dev version (patch)

* feat: core-config must be in two places to support inherited tasks at this time so added instructions to copy and create one in expansion pack folder as well. chore: bump bmad-2d-unity-game-dev version (patch)

* This PR introduces a powerful new Codebase Flattener Tool that aggregates entire codebases into AI-optimized XML format, making it easy to share project context with AI assistants for analysis, debugging, and development assistance.

- AI-Optimized XML Output : Generates clean, structured XML specifically designed for AI model consumption
- Smart File Discovery : Recursive file scanning with intelligent filtering using glob patterns
- Binary File Detection : Automatically identifies and excludes binary files, focusing on source code
- Progress Tracking : Real-time progress indicators with comprehensive completion statistics
- Flexible Output : Customizable output file location and naming via CLI arguments
- Gitignore Integration : Automatically respects .gitignore patterns to exclude unnecessary files
- CDATA Handling : Proper XML CDATA sections with escape sequence handling for ]]> patterns
- Content Indentation : Beautiful XML formatting with properly indented file content (4-space indentation)
- Error Handling : Robust error handling with detailed logging for problematic files
- Hierarchical Formatting : Clean XML structure with proper indentation and formatting
- File Content Preservation : Maintains original file formatting within indented CDATA sections
- Exclusion Logic : Prevents self-inclusion of output files ( flattened-codebase.xml , repomix-output.xml )
- tools/flattener/main.js - Complete flattener implementation with CLI interface
- package.json - Added new dependencies (glob, minimatch, fs-extra, commander, ora, chalk)
- package-lock.json - Updated dependency tree
- .gitignore - Added exclusions for flattener outputs
- README.md - Comprehensive documentation with usage examples
- docs/bmad-workflow-guide.md - Integration guidance
- tools/cli.js - CLI integration
- .vscode/settings.json - SonarLint configuration
```
current directory
npm run flatten

npm run flatten -- --output my-project.xml
npm run flatten -- -o /path/to/output/codebase.xml
```
The tool provides comprehensive completion summaries including:

- File count and breakdown (text/binary/errors)
- Source code size and generated XML size
- Total lines of code and estimated token count
- Processing progress and performance metrics
- Bug Fix : Corrected typo in exclusion patterns ( repromix-output.xml → repomix-output.xml )
- Performance : Efficient file processing with streaming and progress indicators
- Reliability : Comprehensive error handling and validation
- Maintainability : Clean, well-documented code with modular functions
- AI Integration : Perfect for sharing codebase context with AI assistants
- Code Reviews : Streamlined code review process with complete project context
- Documentation : Enhanced project documentation and analysis capabilities
- Development Workflow : Improved development assistance and debugging support
This tool significantly enhances the BMad-Method framework's AI integration capabilities, providing developers with a seamless way to share complete project context for enhanced AI-assisted development workflows.

* chore: remove unused files and configurations

- Delete deprecated bmad workflow guide and roomodes file
- Remove sonarlint project configuration
- Downgrade ora dependency version
- Remove jest test script

* docs: update command names and agent references in documentation

- Change `*create` to `*draft` in workflow guide
- Update PM agent commands to use consistent naming
- Replace `analyst` references with `architect`
- Fix command examples to match new naming conventions

---------

Co-authored-by: PinkyD <paulbeanjr@gmail.com>
2025-07-26 14:56:00 -05:00
PinkyD
a7038d43d1 feat: Overhaul and Enhance 2D Unity Game Dev Expansion Pack (#350)
* Updated game-sm agent to match the new core framework patterns

* feat:Created more comprehensive game story matching new format system as well

* feat:Added Game specific course correct task

* feat:Updated dod-checklist to match new DoD format

* feat:Added new Architect agent for appropriate architecture doc creation and design

* feat:Overhaul of game-architecture-tmpl template

* feat:Updated rest of templates besides level which doesnt really need it

* feat: Finished extended architecture documentation needed for new game story tasks

* feat: Updated game Developer to new format

* feat: Updated last agent to new format and updated bmad-kb. bmad-kb I did my best with but im not sure of it's valid usage in the expansion pack, the AI generated more of the file then myself. I made sure to include it due to the new core-config file

* feat: Finished updating designer agent to new format and cleaned up template linting errors

* Built dist for web bundle

* Increased expansion pack minor verison number

* Updated architecht and design for sharding built-in

* chore: bump bmad-2d-unity-game-dev version (minor)

* updated config.yaml for game-specific pieces to supplement core-config.yaml

* Updated game-core-config and epic processing for game story and game design. Initial implementation was far too generic

* chore: bump bmad-2d-unity-game-dev version (patch)

* feat: Fixed issue with multi-configs being needed. chore: bump bmad-2d-unity-game-dev version (patch)

* Chore: Built web-bundle

* feat: Added the ability to specify the unity editor install location.\nchore: bump bmad-2d-unity-game-dev version (patch)

* feat: core-config must be in two places to support inherited tasks at this time so added instructions to copy and create one in expansion pack folder as well. chore: bump bmad-2d-unity-game-dev version (patch)
2025-07-23 07:14:06 -05:00
manjaroblack
9afe4fbdaf fix/chore: Update console.log for user-guide.md install path. Cleaned up config files/folders and updated .gitignore (#347)
* fix: Update console.log for user-guide.md install path

Changed
IMPORTANT: Please read the user guide installed at docs/user-guilde.md
to
IMPORTANT: Please read the user guide installed at .bmad-core/user-guide.md

WHY: the actual install location of the user-guide.md is in the .bmad-core directory.

* chore: remove formatting configs and clean up gitignore

- Delete husky pre-commit hook and prettier config files
- Remove VS Code chat/copilot settings
- Reorganize and clean up gitignore entries
2025-07-22 21:22:48 -05:00
semantic-release-bot
bfaaa0ee11 chore(release): 4.31.0 [skip ci]
# [4.31.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.30.4...v4.31.0) (2025-07-20)

### Bug Fixes

* enhanced user guide with better diagrams ([c445962](c445962f25))

### Features

* Installation includes a getting started user guide with detailed mermaid diagram ([df57d77](df57d772ca))
2025-07-20 02:18:34 +00:00
Brian Madison
df57d772ca feat: Installation includes a getting started user guide with detailed mermaid diagram 2025-07-19 21:18:06 -05:00
Brian Madison
c445962f25 fix: enhanced user guide with better diagrams 2025-07-19 20:54:41 -05:00
semantic-release-bot
e44271b191 chore(release): 4.30.4 [skip ci]
## [4.30.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.30.3...v4.30.4) (2025-07-19)

### Bug Fixes

* docs ([8619006](8619006c16))
* lint fix ([49e4897](49e489701e))
2025-07-19 15:07:57 +00:00
Brian Madison
49e489701e fix: lint fix 2025-07-19 10:07:34 -05:00
Brian Madison
8619006c16 fix: docs 2025-07-19 00:36:13 -05:00
Brian Madison
a72f1cc3bd merge 2025-07-19 00:35:53 -05:00
Brian Madison
c6dc345b95 direct commands in agents 2025-07-19 00:30:42 -05:00
semantic-release-bot
1062cad9bc chore(release): 4.30.3 [skip ci]
## [4.30.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.30.2...v4.30.3) (2025-07-19)

### Bug Fixes

* improve code in the installer to be more memory efficient ([849e428](849e42871a))
2025-07-19 05:04:46 +00:00
Brian Madison
3367fa18f7 version alignment 2025-07-19 00:04:16 -05:00
Brian Madison
849e42871a fix: improve code in the installer to be more memory efficient 2025-07-18 23:51:16 -05:00
A. R.
4d252626de single readme typo corrected (#331) 2025-07-18 21:24:11 -05:00
PinkyD
5d81c75f4d Feature/expansionpack 2d unity game dev (#332)
* Added 1.0 files

* Converted agents, and templates to new format. Updated filenames to include extensions like in unity-2d-game-team.yaml, Updated some wordage in workflow, config, and increased minor version number

* Forgot to remove unused startup section in game-sm since it's moved to activation-instructions, now fixed.

* Updated verbosity for development workflow in development-guidenlines.md

* built the web-dist files for the expansion pack

* Synched with main repo and rebuilt dist

* Added enforcement of game-design-checklist to designer persona

* Updated with new changes to phaser epack that seem relevant to discussion we had on discord for summarizing documentation updates

* updated dist build for our epack
2025-07-18 19:14:12 -05:00
Jorge Castillo
47b014efa1 Update ide-setup.js (#324)
Add missing tools required for editing and executing commands
2025-07-17 20:10:14 -05:00
MIPAN
aa0e9f9bc4 chore(tools): clean up and refactor bump scripts for clarity and consistency (#325)
* refactor: simplify installer package version sync script and add comments

* chore: bump core version based on provided semver type

* chore(expansion): bump bmad-creator-tools version (patch)
2025-07-17 20:09:09 -05:00
Zach
d1bed26e5d Fix team-fullstack.txt path in bmad-workflow-guide.md (#327) 2025-07-17 20:02:39 -05:00
semantic-release-bot
0089110e3c chore(release): 4.30.2 [skip ci]
## [4.30.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.30.1...v4.30.2) (2025-07-17)

### Bug Fixes

* remove z2 ([dcb36a9](dcb36a9b44))
2025-07-17 04:37:47 +00:00
Brian Madison
dcb36a9b44 fix: remove z2 2025-07-16 23:36:50 -05:00
Brian Madison
d0a8c581af fixed roomodes double bmad 2025-07-16 23:36:24 -05:00
semantic-release-bot
4fd72a6dcb chore(release): 4.30.1 [skip ci]
## [4.30.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.30.0...v4.30.1) (2025-07-15)

### Bug Fixes

* added logo to installer, because why not... ([2cea37a](2cea37aa8c))
2025-07-15 00:48:18 +00:00
Brian Madison
f51697f09a merge 2025-07-14 19:47:55 -05:00
Brian Madison
2cea37aa8c fix: added logo to installer, because why not... 2025-07-14 19:47:23 -05:00
semantic-release-bot
00285c9250 chore(release): 4.30.0 [skip ci]
# [4.30.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.7...v4.30.0) (2025-07-15)

### Features

* installer is now VERY clear about IDE selection being a multiselect ([e24b6f8](e24b6f84fd))
2025-07-15 00:39:46 +00:00
Brian Madison
e24b6f84fd feat: installer is now VERY clear about IDE selection being a multiselect 2025-07-14 19:39:10 -05:00
semantic-release-bot
2c20531883 chore(release): 4.29.7 [skip ci]
## [4.29.7](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.6...v4.29.7) (2025-07-14)

### Bug Fixes

* bundle build ([0723eed](0723eed881))
2025-07-14 05:08:00 +00:00
Brian Madison
0723eed881 fix: bundle build 2025-07-14 00:07:29 -05:00
semantic-release-bot
bddb5b05c4 chore(release): 4.29.6 [skip ci]
## [4.29.6](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.5...v4.29.6) (2025-07-14)

### Bug Fixes

* improve agent task folowing in agressing cost saving ide model combos ([3621c33](3621c330e6))
2025-07-14 05:06:57 +00:00
Brian Madison
3621c330e6 fix: improve agent task folowing in agressing cost saving ide model combos 2025-07-14 00:06:25 -05:00
semantic-release-bot
ef32eddcd6 chore(release): 4.29.5 [skip ci]
## [4.29.5](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.4...v4.29.5) (2025-07-14)

### Bug Fixes

* windows regex issue ([9f48c1a](9f48c1a869))
2025-07-14 03:48:54 +00:00
Brian Madison
9f48c1a869 fix: windows regex issue 2025-07-13 22:48:19 -05:00
semantic-release-bot
733a085370 chore(release): 4.29.4 [skip ci]
## [4.29.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.3...v4.29.4) (2025-07-14)

### Bug Fixes

* empty .roomodes, support Windows-style newlines in YAML block regex ([#311](https://github.com/bmadcode/BMAD-METHOD/issues/311)) ([551e30b](551e30b65e))
2025-07-14 03:45:02 +00:00
Hossam Ghanam
551e30b65e fix: empty .roomodes, support Windows-style newlines in YAML block regex (#311) 2025-07-13 22:44:40 -05:00
semantic-release-bot
5b8f6cc85d chore(release): 4.29.3 [skip ci]
## [4.29.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.2...v4.29.3) (2025-07-13)

### Bug Fixes

* annoying YAML lint error ([afea271](afea271e5e))
2025-07-13 20:52:18 +00:00
Brian Madison
afea271e5e fix: annoying YAML lint error 2025-07-13 15:51:46 -05:00
semantic-release-bot
c39164789d chore(release): 4.29.2 [skip ci]
## [4.29.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.1...v4.29.2) (2025-07-13)

### Bug Fixes

* add readme note about discord joining issues ([4ceaced](4ceacedd73))
2025-07-13 16:56:32 +00:00
Brian Madison
f4366f223a merge 2025-07-13 11:56:06 -05:00
Brian Madison
4ceacedd73 fix: add readme note about discord joining issues 2025-07-13 11:55:33 -05:00
Brian Madison
6b860bfee4 improve agent performance in claude code slash commands 2025-07-13 11:53:22 -05:00
semantic-release-bot
192c6a403b chore(release): 4.29.1 [skip ci]
## [4.29.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.29.0...v4.29.1) (2025-07-13)

### Bug Fixes

* brianstorming facilitation output ([f62c05a](f62c05ab0f))
2025-07-13 16:33:31 +00:00
Brian Madison
f62c05ab0f fix: brianstorming facilitation output 2025-07-13 11:33:06 -05:00
semantic-release-bot
5c588d008e chore(release): 4.29.0 [skip ci]
# [4.29.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.28.0...v4.29.0) (2025-07-13)

### Features

* Claude Code slash commands for Tasks and Agents! ([e9e541a](e9e541a52e))
2025-07-13 02:08:47 +00:00
Brian Madison
e9e541a52e feat: Claude Code slash commands for Tasks and Agents! 2025-07-12 21:08:13 -05:00
Brian Madison
24a35ff2c4 core agents alignment 2025-07-12 20:16:05 -05:00
semantic-release-bot
f32a5fe08a chore(release): 4.28.0 [skip ci]
# [4.28.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.6...v4.28.0) (2025-07-12)

### Features

* bmad-master can load kb properly ([3c13c56](3c13c56498))
2025-07-12 15:27:50 +00:00
Brian Madison
3c13c56498 feat: bmad-master can load kb properly 2025-07-12 10:27:21 -05:00
Gabriel Lemire
97f01f6931 refactor: nest Claude Code commands under BMad subdirectory (#307)
- Update installer config to use .claude/commands/BMad/ path
- Modify setupClaudeCode function to create nested directory structure
- Update documentation and upgrader to reflect new command location
- Improves organization by grouping all BMad commands together
2025-07-12 10:02:46 -05:00
Davor Racic
c42002f1ea refactor(gemini-cli): change agent storage from multiple files to single (#308)
* refactor(gemini-cli): change agent storage from multiple files to single concatenated file

- Update configuration to use .gemini/bmad-method/ directory instead of .gemini/agents/
- Implement new logic to concatenate all agent files into single GEMINI.md
- Add backward compatibility for existing settings.json
- Remove old agents directory and update related documentation
- Ensure all agent settings are properly loaded

* fix(ide-setup): change agent trigger symbol from @ to *

The change was made to standardize the agent trigger symbol across the system and avoid confusion with other special characters.

* docs: update gemini cli syntax and file structure

- Change agent mention syntax from @ to * in docs and config
- Update file structure documentation from .gemini/agents/ to .gemini/bmad-method/
- Add gemini cli syntax to workflow guide

* fix(ide-setup): remove redundant contextFileNames handling
2025-07-12 09:55:12 -05:00
semantic-release-bot
b5cbffd608 chore(release): 4.27.6 [skip ci]
## [4.27.6](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.5...v4.27.6) (2025-07-08)

### Bug Fixes

* installer improvement ([db30230](db302309f4))
2025-07-08 03:11:59 +00:00
Brian Madison
db302309f4 fix: installer improvement 2025-07-07 22:11:32 -05:00
semantic-release-bot
c97d76c797 chore(release): 4.27.5 [skip ci]
## [4.27.5](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.4...v4.27.5) (2025-07-08)

### Bug Fixes

* installer for github copilot asks follow up questions right away now so it does not seem to hang, and some minor doc improvements ([cadf8b6](cadf8b6750))
2025-07-08 01:47:25 +00:00
Brian Madison
cadf8b6750 fix: installer for github copilot asks follow up questions right away now so it does not seem to hang, and some minor doc improvements 2025-07-07 20:46:55 -05:00
semantic-release-bot
ba9e3f3272 chore(release): 4.27.4 [skip ci]
## [4.27.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.3...v4.27.4) (2025-07-07)

### Bug Fixes

* doc updates ([1b86cd4](1b86cd4db3))
2025-07-07 01:52:36 +00:00
Brian Madison
412f152547 merge 2025-07-06 20:52:09 -05:00
Brian Madison
1b86cd4db3 fix: doc updates 2025-07-06 20:51:40 -05:00
semantic-release-bot
c8b26d8eae chore(release): 4.27.3 [skip ci]
## [4.27.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.2...v4.27.3) (2025-07-07)

### Bug Fixes

* remove test zoo folder ([908dcd7](908dcd7e9a))
2025-07-07 01:48:17 +00:00
Brian Madison
9cf8a6b72b merge 2025-07-06 20:47:51 -05:00
Brian Madison
908dcd7e9a fix: remove test zoo folder 2025-07-06 20:47:24 -05:00
semantic-release-bot
92c9589f7d chore(release): 4.27.2 [skip ci]
## [4.27.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.1...v4.27.2) (2025-07-07)

### Bug Fixes

* improve output ([a5ffe7b](a5ffe7b9b2))
2025-07-07 01:41:08 +00:00
Brian Madison
c2b5da7f6e merge 2025-07-06 20:40:39 -05:00
Brian Madison
a5ffe7b9b2 fix: improve output 2025-07-06 20:40:08 -05:00
semantic-release-bot
63aabe435e chore(release): 4.27.1 [skip ci]
## [4.27.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.0...v4.27.1) (2025-07-07)

### Bug Fixes

* build web bundles with new file extension includsion ([92201ae](92201ae7ed))
2025-07-07 00:55:24 +00:00
Brian Madison
2601fa7205 version bump 2025-07-06 19:54:46 -05:00
Brian Madison
92201ae7ed fix: build web bundles with new file extension includsion 2025-07-06 19:39:34 -05:00
Brian Madison
97590e5e1d missed save on the phaser expansion 2025-07-06 18:49:03 -05:00
Brian Madison
746ba573fa specify md ot yaml 2025-07-06 18:26:09 -05:00
Brian Madison
339745c3f3 combine startup with activation in agent files 2025-07-06 16:07:39 -05:00
semantic-release-bot
1ac0d2bd91 chore(release): 4.27.0 [skip ci]
# [4.27.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.26.0...v4.27.0) (2025-07-06)

### Bug Fixes

* readme consolidation and version bumps ([0a61d3d](0a61d3de4a))

### Features

* big improvement to advanced elicitation ([1bc9960](1bc9960808))
* experimental doc creator v2 and template system ([b785371](b78537115d))
* Massive improvement to the brainstorming task! ([9f53caf](9f53caf4c6))
* WIP create-docv2 ([c107af0](c107af0598))
2025-07-06 17:12:23 +00:00
Brian Madison
b78537115d feat: experimental doc creator v2 and template system 2025-07-06 12:11:55 -05:00
Brian Madison
0ca3f9ebbd create-doc2 update 2025-07-06 12:08:41 -05:00
Brian Madison
0a61d3de4a fix: readme consolidation and version bumps 2025-07-06 11:13:09 -05:00
Brian Madison
4e03f8f982 merge conflicts resolved 2025-07-06 10:34:53 -05:00
Brian Madison
5fc69d773a web build optimization 2025-07-06 10:32:39 -05:00
David Elisma
9e6940e8ee refactor: Standardize on 'GitHub Copilot' branding (#296)
* refactor: Standardize on 'GitHub Copilot' branding

- Update all references from 'Github Copilot' to 'GitHub Copilot' (official branding)
- Simplify GitHub Copilot guide reference in README
- Rebuild distribution files to reflect changes
- Ensure consistent branding across documentation and configuration

* fix: add Trae IDE support while maintaining GitHub Copilot branding
2025-07-06 08:49:22 -05:00
Brian Madison
4b0a9235ab WIP: createdoc2 2025-07-06 00:23:10 -05:00
Brian Madison
c107af0598 feat: WIP create-docv2 2025-07-06 00:10:00 -05:00
Brian Madison
be9453f234 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-07-05 23:19:45 -05:00
manjaroblack
de549673a7 ReadMe (#299)
* fix: correct typos in documentation and agent files

Fix multiple instances of "assest" typo to "assets" in documentation
Correct "quetsions" typo to "questions" in repository structure sections
Add new words to cSpell dictionary in VS Code settings

* feat(trae): add support for trae ide integration

- Add trae guide documentation
- Update installer to support trae configuration
- Include trae in ide options and documentation references
- Fix typo in architect agent documentation

* chore: ignore windsurf and trae directories in git

* docs: add npm install step to README

The npm install step was missing from the setup instructions, which is required before running build commands.

---------

Co-authored-by: Devin Stagner <devin@blackstag.family>
2025-07-05 21:12:46 -05:00
semantic-release-bot
400f7b8f41 chore(release): 4.26.0 [skip ci]
# [4.26.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.1...v4.26.0) (2025-07-06)

### Features

* **trae:** add support for trae ide integration ([#298](https://github.com/bmadcode/BMAD-METHOD/issues/298)) ([fae0f5f](fae0f5ff73))
2025-07-06 02:12:03 +00:00
manjaroblack
fae0f5ff73 feat(trae): add support for trae ide integration (#298)
* fix: correct typos in documentation and agent files

Fix multiple instances of "assest" typo to "assets" in documentation
Correct "quetsions" typo to "questions" in repository structure sections
Add new words to cSpell dictionary in VS Code settings

* feat(trae): add support for trae ide integration

- Add trae guide documentation
- Update installer to support trae configuration
- Include trae in ide options and documentation references
- Fix typo in architect agent documentation

* chore: ignore windsurf and trae directories in git

* docs: add npm install step to README

The npm install step was missing from the setup instructions, which is required before running build commands.

---------

Co-authored-by: Devin Stagner <devin@blackstag.family>
2025-07-05 21:11:38 -05:00
semantic-release-bot
d6183b4bb1 chore(release): 4.25.1 [skip ci]
## [4.25.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.0...v4.25.1) (2025-07-06)

### Bug Fixes

* spelling errors in documentation. ([#297](https://github.com/bmadcode/BMAD-METHOD/issues/297)) ([47b9d9f](47b9d9f3e8))
2025-07-06 02:08:48 +00:00
manjaroblack
47b9d9f3e8 fix: spelling errors in documentation. (#297)
* fix: correct typos in documentation and agent files

Fix multiple instances of "assest" typo to "assets" in documentation
Correct "quetsions" typo to "questions" in repository structure sections
Add new words to cSpell dictionary in VS Code settings

* feat(trae): add support for trae ide integration

- Add trae guide documentation
- Update installer to support trae configuration
- Include trae in ide options and documentation references
- Fix typo in architect agent documentation

---------

Co-authored-by: Devin Stagner <devin@blackstag.family>
2025-07-05 21:08:26 -05:00
Brian Madison
b9223a4976 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-07-05 14:01:55 -05:00
Brian Madison
1bc9960808 feat: big improvement to advanced elicitation 2025-07-05 14:01:29 -05:00
Brian Madison
9f53caf4c6 feat: Massive improvement to the brainstorming task! 2025-07-04 23:36:18 -05:00
semantic-release-bot
e17ecf1a3d chore(release): 4.25.0 [skip ci]
# [4.25.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.6...v4.25.0) (2025-07-05)

### Bug Fixes

* update web bundles ([42684e6](42684e68af))

### Features

* improvements to agent task usage, sm story drafting, dev implementation, qa review process, and addition of a new sm independant review of a draft story ([2874a54](2874a54a9b))
2025-07-05 02:32:21 +00:00
Brian Madison
42684e68af fix: update web bundles 2025-07-04 21:31:52 -05:00
Brian Madison
3520fae655 minor updates 2025-07-04 21:27:50 -05:00
Brian Madison
2874a54a9b feat: improvements to agent task usage, sm story drafting, dev implementation, qa review process, and addition of a new sm independant review of a draft story 2025-07-04 21:18:16 -05:00
semantic-release-bot
5f1966329b chore(release): 4.24.6 [skip ci]
## [4.24.6](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.5...v4.24.6) (2025-07-04)

### Bug Fixes

* version bump and web build fix ([1c845e5](1c845e5b2c))
2025-07-04 17:39:44 +00:00
Brian Madison
1c845e5b2c fix: version bump and web build fix 2025-07-04 12:39:17 -05:00
semantic-release-bot
8766506cb3 chore(release): 4.24.5 [skip ci]
## [4.24.5](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.4...v4.24.5) (2025-07-04)

### Bug Fixes

* yaml standardization in files and installer actions ([094f9f3](094f9f3eab))
2025-07-04 16:54:31 +00:00
Brian Madison
094f9f3eab fix: yaml standardization in files and installer actions 2025-07-04 11:53:57 -05:00
semantic-release-bot
ddd3e53d12 chore(release): 4.24.4 [skip ci]
## [4.24.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.3...v4.24.4) (2025-07-04)

### Bug Fixes

* documentation updates ([2018ad0](2018ad07c7))
2025-07-04 13:36:00 +00:00
Brian Madison
2018ad07c7 fix: documentation updates 2025-07-04 08:35:28 -05:00
Brian Madison
38dd71db7f doc reference changes from vs-code-copilot to github-copilot 2025-07-04 08:04:27 -05:00
Brian Madison
eb960f99f2 readd dist back 2025-07-04 07:48:29 -05:00
Brian Madison
f440d14565 doc and text cleanup 2025-07-04 07:47:57 -05:00
semantic-release-bot
be4fcd8668 chore(release): 4.24.3 [skip ci]
## [4.24.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.2...v4.24.3) (2025-07-04)

### Bug Fixes

* update YAML library from 'yaml' to 'js-yaml' in resolveExpansionPackCoreAgents for consistency ([#295](https://github.com/bmadcode/BMAD-METHOD/issues/295)) ([03f30ad](03f30ad28b))
2025-07-04 12:23:13 +00:00
Davor Racic
03f30ad28b fix: update YAML library from 'yaml' to 'js-yaml' in resolveExpansionPackCoreAgents for consistency (#295) 2025-07-04 07:22:49 -05:00
Serhii
e32b477e42 docs: add vs-code-copilot-guide (#290)
* docs: add vs-code-copilot-guide

* fix: correct broken link in vs-code-copilot-guide
2025-07-03 20:32:27 -05:00
semantic-release-bot
e7b1ee37e3 chore(release): 4.24.2 [skip ci]
## [4.24.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.1...v4.24.2) (2025-07-03)

### Bug Fixes

* version bump and restore dist folder ([87c451a](87c451a5c3))
2025-07-03 04:15:20 +00:00
Brian Madison
87c451a5c3 fix: version bump and restore dist folder 2025-07-02 23:14:54 -05:00
semantic-release-bot
a96fce793b chore(release): 4.24.1 [skip ci]
## [4.24.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.0...v4.24.1) (2025-07-03)

### Bug Fixes

* centralized yamlExtraction function and all now fix character issues for windows ([e2985d6](e2985d6093))
* filtering extension stripping logic update ([405954a](405954ad92))
* standardize on file extension .yaml instead of a mix of yml and yaml ([a4c0b18](a4c0b1839d))
2025-07-03 02:09:14 +00:00
Brian Madison
e2985d6093 fix: centralized yamlExtraction function and all now fix character issues for windows 2025-07-02 21:08:43 -05:00
Brian Madison
405954ad92 fix: filtering extension stripping logic update 2025-07-02 20:04:12 -05:00
Brian Madison
a4c0b1839d fix: standardize on file extension .yaml instead of a mix of yml and yaml 2025-07-02 19:59:49 -05:00
semantic-release-bot
ffae072143 chore(release): 4.24.0 [skip ci]
# [4.24.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.23.0...v4.24.0) (2025-07-02)

### Bug Fixes

* corrected cursor agent update instructions ([84e394a](84e394ac11))

### Features

* workflow plans introduced, preliminary feature under review ([731589a](731589aa28))
2025-07-02 03:55:08 +00:00
Brian Madison
84e394ac11 fix: corrected cursor agent update instructions 2025-07-01 22:54:39 -05:00
Brian Madison
b89aa48f7b conflicts 2025-07-01 22:48:10 -05:00
Brian Madison
731589aa28 feat: workflow plans introduced, preliminary feature under review 2025-07-01 22:46:59 -05:00
木炭
b7361d244c Update dependency-resolver.js (#286)
When cloning a project in a Windows environment, Git may automatically convert line endings from `\n` to `\r\n`. This can cause a mismatch in the `yaml` configuration, leading to a build failure. To resolve this, a step has been added to enforce the replacement of `\r` characters, ensuring the build can proceed normally.
2025-07-01 20:21:58 -05:00
semantic-release-bot
b2f8525bbf chore(release): 4.23.0 [skip ci]
# [4.23.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.1...v4.23.0) (2025-07-01)

### Features

* VS Code Copilot integration ([#284](https://github.com/bmadcode/BMAD-METHOD/issues/284)) ([1a4ca4f](1a4ca4ffa6))
2025-07-01 12:54:38 +00:00
David Elisma
1a4ca4ffa6 feat: VS Code Copilot integration (#284) 2025-07-01 07:54:13 -05:00
semantic-release-bot
3e2e43dd88 chore(release): 4.22.1 [skip ci]
## [4.22.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.0...v4.22.1) (2025-06-30)

### Bug Fixes

* update expansion versions ([6905fe7](6905fe72f6))
2025-06-30 05:14:32 +00:00
Brian Madison
6905fe72f6 fix: update expansion versions 2025-06-30 00:14:04 -05:00
semantic-release-bot
95ab8bbd9c chore(release): 4.22.0 [skip ci]
# [4.22.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.2...v4.22.0) (2025-06-30)

### Features

* create doc more explicit and readme improvement ([a1b30d9](a1b30d9341))
2025-06-30 05:11:29 +00:00
Brian Madison
a1b30d9341 feat: create doc more explicit and readme improvement 2025-06-30 00:11:03 -05:00
semantic-release-bot
6e094c8359 chore(release): 4.21.2 [skip ci]
## [4.21.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.1...v4.21.2) (2025-06-30)

### Bug Fixes

* improve create-doc task clarity for template execution ([86d5139](86d5139aea))
2025-06-30 05:08:08 +00:00
Brian Madison
86d5139aea fix: improve create-doc task clarity for template execution
- Add critical execution rules upfront
- Clarify STOP signals for task execution
- Include key execution patterns with examples
- Restore missing functionality (agent context, template locations, validation)
- Maintain concise format while ensuring proper template instruction handling
2025-06-30 00:07:37 -05:00
semantic-release-bot
62ccb640e6 chore(release): 4.21.1 [skip ci]
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)

### Bug Fixes

* readme clarifies that the installer handles installs upgrades and expansion installation ([9371a57](9371a5784f))
2025-06-30 02:09:46 +00:00
Brian Madison
9371a5784f fix: readme clarifies that the installer handles installs upgrades and expansion installation 2025-06-29 21:09:13 -05:00
semantic-release-bot
62c5d92089 chore(release): 4.21.0 [skip ci]
# [4.21.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.20.0...v4.21.0) (2025-06-30)

### Bug Fixes

* remove unneeded files ([c48f200](c48f200727))

### Features

* massive installer improvement update ([c151bda](c151bda938))
2025-06-30 01:53:38 +00:00
Brian Madison
c48f200727 fix: remove unneeded files 2025-06-29 20:53:09 -05:00
Brian Madison
c151bda938 feat: massive installer improvement update 2025-06-29 20:52:23 -05:00
Brian Madison
ab70b8dc73 contribution updates 2025-06-29 11:30:15 -05:00
semantic-release-bot
0ec4ad26c2 chore(release): 4.20.0 [skip ci]
# [4.20.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.19.2...v4.20.0) (2025-06-29)

### Features

* Massive documentation refactor, added explanation of the new expanded role of the QA agent that will make your code quality MUCH better. 2 new diagram clearly explain the role of the pre dev ideation cycle (prd and architecture) and the details of how the dev cycle works. ([c881dcc](c881dcc48f))
2025-06-29 14:06:11 +00:00
Brian Madison
c881dcc48f feat: Massive documentation refactor, added explanation of the new expanded role of the QA agent that will make your code quality MUCH better. 2 new diagram clearly explain the role of the pre dev ideation cycle (prd and architecture) and the details of how the dev cycle works. 2025-06-29 09:05:41 -05:00
Brian Madison
5aed8f7603 cleanup 2025-06-28 22:26:37 -05:00
Brian
929461a2fe Create FUNDING.yml 2025-06-28 17:11:51 -05:00
Brian Madison
f5fa2559f0 doc: readme fixes 2025-06-28 16:12:01 -05:00
Brian
ead2c04b5b Update issue templates 2025-06-28 16:05:26 -05:00
Brian
b9970c9d73 Update issue templates 2025-06-28 15:57:17 -05:00
semantic-release-bot
8182a3f4bc chore(release): 4.19.2 [skip ci]
## [4.19.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.19.1...v4.19.2) (2025-06-28)

### Bug Fixes

* docs update and correction ([2408068](2408068884))
2025-06-28 20:49:22 +00:00
Brian Madison
2408068884 fix: docs update and correction 2025-06-28 15:46:52 -05:00
Miguel Tomas
9cafbe7014 Align Brownfield workflow descriptions and artifact naming (#277)
* chore: Update brownfield-fullstack.yml

- Update descriptions, status messages, and artifact names in brownfield-fullstack

* chore: Update brownfield-service.yml

- Update descriptions, status messages, and artifact names in brownfield-service

* chore: Update brownfield-ui.yml

- Update descriptions, status messages, and artifact names in brownfield-ui workflows
2025-06-28 15:25:40 -05:00
semantic-release-bot
466bef4398 chore(release): 4.19.1 [skip ci]
## [4.19.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.19.0...v4.19.1) (2025-06-28)

### Bug Fixes

* discord link ([2ea806b](2ea806b3af))
2025-06-28 13:36:44 +00:00
Brian Madison
2ea806b3af fix: discord link 2025-06-28 08:36:12 -05:00
semantic-release-bot
60c147aa75 chore(release): 4.19.0 [skip ci]
# [4.19.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.18.0...v4.19.0) (2025-06-28)

### Bug Fixes

* expansion install config ([50d17ed](50d17ed65d))

### Features

* install for ide now sets up rules also for expansion agents! ([b82978f](b82978fd38))
2025-06-28 07:23:35 +00:00
Brian Madison
ba91cb17cf Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-28 02:23:06 -05:00
Brian Madison
b82978fd38 feat: install for ide now sets up rules also for expansion agents! 2025-06-28 02:22:57 -05:00
Brian Madison
50d17ed65d fix: expansion install config 2025-06-28 01:57:02 -05:00
semantic-release-bot
aa15b7a2ca chore(release): 4.18.0 [skip ci]
# [4.18.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.17.0...v4.18.0) (2025-06-28)

### Features

* expansion teams can now include core agents and include their assets automatically ([c70f1a0](c70f1a056b))
* remove hardcoding from installer for agents, improve expansion pack installation to its own locations, common files moved to common folder ([95e833b](95e833beeb))
2025-06-28 06:12:41 +00:00
Brian Madison
c70f1a056b feat: expansion teams can now include core agents and include their assets automatically 2025-06-28 01:12:16 -05:00
Brian Madison
95e833beeb feat: remove hardcoding from installer for agents, improve expansion pack installation to its own locations, common files moved to common folder 2025-06-28 01:01:26 -05:00
Brian Madison
1ea367619a installer updates part 1 2025-06-27 23:38:34 -05:00
Brian Madison
6cdecec61f fix minor lint issue 2025-06-27 20:33:07 -05:00
semantic-release-bot
a5915934fd chore(release): 4.17.0 [skip ci]
# [4.17.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.16.1...v4.17.0) (2025-06-27)

### Features

* add GEMINI.md to agent context files ([#272](https://github.com/bmadcode/BMAD-METHOD/issues/272)) ([b557570](b557570081))
2025-06-27 23:26:51 +00:00
Davor Racic
b557570081 feat: add GEMINI.md to agent context files (#272)
thanks Davor
2025-06-27 18:26:28 -05:00
semantic-release-bot
4bbb251730 chore(release): 4.16.1 [skip ci]
## [4.16.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.16.0...v4.16.1) (2025-06-26)

### Bug Fixes

* remove accidental folder add ([b1c2de1](b1c2de1fb5))
2025-06-26 03:13:31 +00:00
Brian Madison
3cb8c02747 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-25 22:13:01 -05:00
Brian Madison
b1c2de1fb5 fix: remove accidental folder add 2025-06-25 22:12:51 -05:00
semantic-release-bot
263d9c7618 chore(release): 4.16.0 [skip ci]
# [4.16.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.15.0...v4.16.0) (2025-06-26)

### Features

* repo builds all rules sets for supported ides for easy copy if desired ([ea945bb](ea945bb43f))
2025-06-26 02:42:17 +00:00
Brian Madison
08f541195d Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-25 21:41:41 -05:00
Brian Madison
ea945bb43f feat: repo builds all rules sets for supported ides for easy copy if desired 2025-06-25 21:41:32 -05:00
semantic-release-bot
dd27531151 chore(release): 4.15.0 [skip ci]
# [4.15.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.14.1...v4.15.0) (2025-06-26)

### Features

* Add Gemini CLI Integration ([#271](https://github.com/bmadcode/BMAD-METHOD/issues/271)) ([44b9d7b](44b9d7bcb5))
2025-06-26 02:34:23 +00:00
hieu.sats
44b9d7bcb5 feat: Add Gemini CLI Integration (#271) 2025-06-25 21:33:58 -05:00
semantic-release-bot
429a3d41e9 chore(release): 4.14.1 [skip ci]
## [4.14.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.14.0...v4.14.1) (2025-06-26)

### Bug Fixes

* add updated web builds ([6dabbcb](6dabbcb670))
2025-06-26 02:19:50 +00:00
Brian Madison
6dabbcb670 fix: add updated web builds 2025-06-25 21:19:23 -05:00
semantic-release-bot
8cf9e5d916 chore(release): 4.14.0 [skip ci]
# [4.14.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.13.0...v4.14.0) (2025-06-25)

### Features

* enhance QA agent as senior developer with code review capabilities and major brownfield improvements ([3af3d33](3af3d33d4a))
2025-06-25 04:57:50 +00:00
Brian Madison
3af3d33d4a feat: enhance QA agent as senior developer with code review capabilities and major brownfield improvements
This release introduces significant enhancements across multiple areas:

QA Agent Transformation:
- Transform QA agent into senior developer role with active code refactoring abilities
- Add review-story task enabling QA to review, refactor, and improve code directly
- Integrate QA review step into standard development workflow (SM → Dev → QA)
- QA can fix small issues directly and leave checklist for remaining items
- Updated dev agent to maintain File List for QA review focus

Knowledge Base Improvements:
- Add extensive brownfield development documentation and best practices
- Clarify Web UI vs IDE usage with cost optimization strategies
- Document PRD-first approach for large codebases/monorepos
- Add comprehensive expansion packs explanation
- Update IDE workflow to include QA review step
- Clarify agent usage (bmad-master vs specialized agents)

Brownfield Enhancements:
- Create comprehensive Working in the Brownfield guide
- Add document-project task to analyst agent capabilities
- Implement PRD-first workflow option for focused documentation
- Transform document-project to create practical brownfield architecture docs
- Document technical debt, workarounds, and real-world constraints
- Reference actual files instead of duplicating content
- Add impact analysis when PRD is provided

Documentation Task Improvements:
- Simplify to always create ONE unified architecture document
- Add deep codebase analysis phase with targeted questions
- Focus on documenting reality including technical debt
- Include Quick Reference section with key file paths
- Add practical sections: useful commands, debugging tips, known issues

Workflow Updates:
- Update all 6 workflow files with detailed IDE transition instructions
- Add clear SM → Dev → QA → Dev cycle explanation
- Emphasize Gemini Web for brownfield analysis (1M+ context advantage)
- Support both PRD-first and document-first approaches

This release significantly improves the brownfield development experience and introduces a powerful shift-left QA approach with senior developer mentoring.
2025-06-24 23:56:57 -05:00
semantic-release-bot
fb0be544ad chore(release): 4.13.0 [skip ci]
# [4.13.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.12.0...v4.13.0) (2025-06-24)

### Features

* **ide-setup:** add support for Cline IDE and configuration rules ([#262](https://github.com/bmadcode/BMAD-METHOD/issues/262)) ([913dbec](913dbeced6))
2025-06-24 02:47:45 +00:00
Reider Olivér
913dbeced6 feat(ide-setup): add support for Cline IDE and configuration rules (#262) 2025-06-23 21:47:21 -05:00
Brian Madison
00a9891793 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-22 22:11:33 -05:00
Brian Madison
47c33d6482 clarify contributing 2025-06-22 22:10:15 -05:00
Brian Madison
febe7e149d doc: clarified contributions and guiding principles to align ideals for contribution to BMad Method 2025-06-22 22:08:21 -05:00
semantic-release-bot
730d51eb95 chore(release): 4.12.0 [skip ci]
# [4.12.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.11.0...v4.12.0) (2025-06-23)

### Features

* **dev-agent:** add quality gates to prevent task completion with failing validations ([#261](https://github.com/bmadcode/BMAD-METHOD/issues/261)) ([45110ff](45110ffffe))
2025-06-23 02:49:40 +00:00
gabadi
45110ffffe feat(dev-agent): add quality gates to prevent task completion with failing validations (#261)
Issue Being Solved:
Dev agent was marking tasks as complete even when tests/lint/typecheck failed,
causing broken code to reach merge and creating technical debt.

Gap in System:
Missing explicit quality gates in dev agent configuration to block task completion
until all automated validations pass.

Solution:
- Add "Quality Gate Discipline" core principle
- Update task execution flow: Execute validations→Only if ALL pass→Update [x]
- Add "Failing validations" to blocking conditions
- Simplify completion criteria to focus on validation success

Alignment with BMAD Core Principles:
- Quality-First: Prevents defective code progression through workflow
- Agent Excellence: Ensures dev agent maintains high standards
- Technology Agnostic: Uses generic "validations" concept vs specific tools

Small, focused change that strengthens existing dev agent without architectural changes.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-06-22 21:49:18 -05:00
semantic-release-bot
c19772498a chore(release): 4.11.0 [skip ci]
# [4.11.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.3...v4.11.0) (2025-06-21)

### Bug Fixes

* resolve web bundles directory path when using relative paths in NPX installer ([5c8485d](5c8485d09f))

### Features

* add markdown-tree integration for document sharding ([540578b](540578b39d))
2025-06-21 20:26:47 +00:00
Brian Madison
540578b39d feat: add markdown-tree integration for document sharding
- Add markdownExploder setting to core-config.yml
- Update shard-doc task to use md-tree command when enabled
- Implement proper fallback handling when tool is unavailable
- Update core-config structure to remove nested wrapper
- Fix field naming to use camelCase throughout
2025-06-21 15:26:09 -05:00
Brian Madison
5c8485d09f fix: resolve web bundles directory path when using relative paths in NPX installer
When users enter "." as the installation directory, the web bundles directory
path was not being resolved correctly, causing the bundles to not be copied.
This fix ensures the web bundles directory is resolved using the same logic
as the main installation directory, resolving relative paths from the original
working directory where npx was executed.
2025-06-21 14:55:44 -05:00
Brian Madison
cd058ee7ed correct config name to source-tree in dev agent loader 2025-06-20 16:21:27 -05:00
semantic-release-bot
835075e992 chore(release): 4.10.3 [skip ci]
## [4.10.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.2...v4.10.3) (2025-06-20)

### Bug Fixes

* bundle update ([2cf3ba1](2cf3ba1ab8))
2025-06-20 04:50:24 +00:00
Brian Madison
2cf3ba1ab8 fix: bundle update 2025-06-19 23:49:57 -05:00
semantic-release-bot
f217bdf07e chore(release): 4.10.2 [skip ci]
## [4.10.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.1...v4.10.2) (2025-06-20)

### Bug Fixes

* file formatting ([c78a35f](c78a35f547))
2025-06-20 03:48:25 +00:00
Brian Madison
c78a35f547 fix: file formatting 2025-06-19 22:47:57 -05:00
Brian Madison
d619068ccc more explicity to not skip stories without asking first 2025-06-19 22:46:46 -05:00
semantic-release-bot
1e5c0b5351 chore(release): 4.10.1 [skip ci]
## [4.10.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.0...v4.10.1) (2025-06-20)

### Bug Fixes

* SM sometimes would skip the rest of the epic stories, fixed ([1148b32](1148b32fa9))
2025-06-20 03:30:30 +00:00
Brian Madison
1148b32fa9 fix: SM sometimes would skip the rest of the epic stories, fixed 2025-06-19 22:27:11 -05:00
semantic-release-bot
b07a8b367d chore(release): 4.10.0 [skip ci]
# [4.10.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.9.2...v4.10.0) (2025-06-19)

### Features

* Core Config and doc sharding is now optional in v4 ([ff6112d](ff6112d6c2))
2025-06-19 23:57:45 +00:00
Brian Madison
ff6112d6c2 feat: Core Config and doc sharding is now optional in v4 2025-06-19 18:57:19 -05:00
semantic-release-bot
42a41969b0 chore(release): 4.9.2 [skip ci]
## [4.9.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.9.1...v4.9.2) (2025-06-19)

### Bug Fixes

* bad brownfield yml ([09d2ad6](09d2ad6aea))
2025-06-19 23:07:55 +00:00
Brian Madison
c685b9e328 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-19 18:07:29 -05:00
Brian Madison
09d2ad6aea fix: bad brownfield yml 2025-06-19 18:07:22 -05:00
semantic-release-bot
f723e0b0e8 chore(release): 4.9.1 [skip ci]
## [4.9.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.9.0...v4.9.1) (2025-06-19)

### Bug Fixes

* dist bundles updated ([d9a989d](d9a989dbe5))
2025-06-19 22:13:03 +00:00
Brian Madison
d9a989dbe5 fix: dist bundles updated 2025-06-19 17:12:38 -05:00
Brian Madison
bbcc30ac29 more list cleanup 2025-06-19 17:09:17 -05:00
titocr
3267144248 Clean up markdown nesting. (#252)
Co-authored-by: TC <>
2025-06-19 16:54:47 -05:00
semantic-release-bot
651c0d2a9e chore(release): 4.9.0 [skip ci]
# [4.9.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.8.0...v4.9.0) (2025-06-19)

### Features

* dev can use debug log configured in core-config.yml ([0e5aaf0](0e5aaf07bb))
2025-06-19 18:36:57 +00:00
Brian Madison
1e46c8f324 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-19 13:36:27 -05:00
Brian Madison
0e5aaf07bb feat: dev can use debug log configured in core-config.yml 2025-06-19 13:36:21 -05:00
semantic-release-bot
3dc21db649 chore(release): 4.8.0 [skip ci]
# [4.8.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.7.0...v4.8.0) (2025-06-19)

### Bug Fixes

* installer has fast v4 update option now to keep the bmad method up to date with changes easily without breaking any customizations from the user. The SM and DEV are much more configurable to find epics stories and architectureal information when the prd and architecture are deviant from v4 templates and/or have not been sharded. so a config will give the user the option to configure the SM to use the full large documents or the sharded versions! ([aea7f3c](aea7f3cc86))
* prevent double installation when updating v4 ([af0e767](af0e767ecf))
* resolve undefined config properties in performUpdate ([0185e01](0185e012bb))
* update file-manager to properly handle YAML manifest files ([724cdd0](724cdd07a1))

### Features

* add early v4 detection for improved update flow ([29e7bbf](29e7bbf4c5))
* add file resolution context for IDE agents ([74d9bb4](74d9bb4b2b))
* update web builder to remove IDE-specific properties from agent bundles ([2f2a1e7](2f2a1e72d6))
2025-06-19 18:25:32 +00:00
Brian Madison
dfe8bc982a Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-19 13:25:01 -05:00
Brian Madison
b53b3a5b28 agents have clear file resolution and fuzzy task resolution instructions 2025-06-19 13:24:49 -05:00
Brian Madison
2f2a1e72d6 feat: update web builder to remove IDE-specific properties from agent bundles
- Remove 'root' property from YAML when building web bundles
- Remove 'IDE-FILE-RESOLUTION' and 'REQUEST-RESOLUTION' properties
- Filter out IDE-specific activation instructions
- Keep agent header minimal for web bundles
- Ensures web bundles are clean of IDE-specific configuration

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 13:21:26 -05:00
Brian Madison
d75cf9e032 refactor: simplify file resolution to concise activation instructions
- Added two concise activation instructions to SM agent
- IDE-FILE-RESOLUTION: One-line explanation of file path mapping
- REQUEST-RESOLUTION: One-line instruction for flexible request matching
- Simplified file-resolution-context.md to be a quick reference
- Removed verbose documentation in favor of clear, actionable instructions

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 13:06:45 -05:00
Brian Madison
74d9bb4b2b feat: add file resolution context for IDE agents
- Added file resolution section to SM agent explaining path patterns
- Created reusable file-resolution-context.md utility
- Documents how agents resolve tasks/templates/checklists to file paths
- Provides natural language to command mapping examples
- Helps IDE agents understand file system structure

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 13:02:17 -05:00
Brian Madison
aea7f3cc86 fix: installer has fast v4 update option now to keep the bmad method up to date with changes easily without breaking any customizations from the user. The SM and DEV are much more configurable to find epics stories and architectureal information when the prd and architecture are deviant from v4 templates and/or have not been sharded. so a config will give the user the option to configure the SM to use the full large documents or the sharded versions! 2025-06-19 12:55:16 -05:00
Brian Madison
9af2463fae docs: add update announcement to README
- Added prominent section about updating existing installations
- Explains how npx bmad-method install detects and updates v4
- Highlights backup feature for custom modifications
- Makes it clear that updates are safe and preserve customizations

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:47:22 -05:00
Brian Madison
af0e767ecf fix: prevent double installation when updating v4
- Added flag to prevent installer.install() being called twice
- Fixed undefined 'directory' error by using answers.directory
- Update flow now completes without errors
- Prevents 'Cannot read properties of undefined' error after successful update

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:43:58 -05:00
Brian Madison
0185e012bb fix: resolve undefined config properties in performUpdate
- Added optional chaining for newConfig.ide access
- Added ides array to config object in performUpdate
- Fixes 'Cannot read properties of undefined' error after update
- Ensures all required config properties are present for showSuccessMessage

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:41:19 -05:00
Brian Madison
29e7bbf4c5 feat: add early v4 detection for improved update flow
- Now detects existing v4 installations immediately after directory prompt
- Offers update option upfront for existing v4 installations
- If user declines update, continues with normal installation flow
- Added 'update' install type handling in installer
- Improves user experience by streamlining the update process

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:38:06 -05:00
Brian Madison
724cdd07a1 fix: update file-manager to properly handle YAML manifest files
- Added js-yaml import for YAML parsing
- Updated readManifest to parse YAML instead of JSON
- Updated createManifest to write YAML instead of JSON
- Fixes installation error when updating existing BMAD installations

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:31:27 -05:00
semantic-release-bot
91272a0077 chore(release): 4.7.0 [skip ci]
# [4.7.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.3...v4.7.0) (2025-06-19)

### Features

* extensive bmad-kb for web orchestrator to be much more helpful ([e663a11](e663a1146b))
2025-06-19 14:18:16 +00:00
Brian Madison
e663a1146b feat: extensive bmad-kb for web orchestrator to be much more helpful 2025-06-19 09:17:48 -05:00
semantic-release-bot
6dca9cc5ba chore(release): 4.6.3 [skip ci]
## [4.6.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.2...v4.6.3) (2025-06-19)

### Bug Fixes

* SM fixed file resolution issue in v4 ([61ab116](61ab1161e5))
2025-06-19 03:55:00 +00:00
Brian Madison
0881735a20 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-18 22:54:14 -05:00
Brian Madison
61ab1161e5 fix: SM fixed file resolution issue in v4 2025-06-18 22:53:26 -05:00
semantic-release-bot
93d3a47326 chore(release): 4.6.2 [skip ci]
## [4.6.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.1...v4.6.2) (2025-06-19)

### Bug Fixes

* installer upgrade path fixed ([bd6a558](bd6a558929))
2025-06-19 00:58:56 +00:00
Brian Madison
bd6a558929 fix: installer upgrade path fixed 2025-06-18 19:58:28 -05:00
semantic-release-bot
a314df4f22 chore(release): 4.6.1 [skip ci]
## [4.6.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.0...v4.6.1) (2025-06-19)

### Bug Fixes

* expansion pack builder now includes proper dependencies from core as needed, and default template file name save added to template llm instructions ([9dded00](9dded00356))
2025-06-19 00:17:38 +00:00
Brian Madison
9dded00356 fix: expansion pack builder now includes proper dependencies from core as needed, and default template file name save added to template llm instructions 2025-06-18 19:17:09 -05:00
Matt
7f3a0be7e8 update web-builder.js to read agents from yaml. Import agents from core if not detected in expansion. (#246) 2025-06-18 18:07:21 -05:00
Kayvan Sylvan
3c658ac297 update @kayvan/markdown-tree-parser to v1.6.0 to support CJK characters (#244)
* chore: update `@kayvan/markdown-tree-parser` to version 1.5.1

### CHANGES
- Upgrade `@kayvan/markdown-tree-parser` to version 1.5.1
- Update package integrity for security improvements

* chore: update @kayvan//markdown-tree-parser to 1.6.0 to support CJK chars
2025-06-18 17:18:47 -05:00
semantic-release-bot
70fa3aa624 chore(release): 4.6.0 [skip ci]
# [4.6.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.5.1...v4.6.0) (2025-06-18)

### Bug Fixes

* orchestractor yml ([3727cc7](3727cc764a))

### Features

* removed some templates that are not ready for use ([b03aece](b03aece79e))
2025-06-18 03:22:28 +00:00
Brian Madison
3727cc764a fix: orchestractor yml 2025-06-17 22:22:05 -05:00
Brian Madison
7ecf47f8cf more template fixes from botched husky job 2025-06-17 22:13:07 -05:00
Brian Madison
b03aece79e feat: removed some templates that are not ready for use 2025-06-17 22:04:24 -05:00
Brian Madison
bc7cc0439a removed bad template updates from previous autoformatter 2025-06-17 21:40:59 -05:00
Kayvan Sylvan
e8208ec277 chore: update @kayvan/markdown-tree-parser to version 1.5.1 (#240)
### CHANGES
- Upgrade `@kayvan/markdown-tree-parser` to version 1.5.1
- Update package integrity for security improvements
2025-06-17 21:00:00 -05:00
semantic-release-bot
96826cf26a chore(release): 4.5.1 [skip ci]
## [4.5.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.5.0...v4.5.1) (2025-06-18)

### Bug Fixes

* docs had some ide specific errors ([a954c7e](a954c7e242))
2025-06-18 00:42:09 +00:00
Brian Madison
a954c7e242 fix: docs had some ide specific errors 2025-06-17 19:41:38 -05:00
semantic-release-bot
d78649746b chore(release): 4.5.0 [skip ci]
# [4.5.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.4.2...v4.5.0) (2025-06-17)

### Bug Fixes

* installer relative path issue for npx resolved ([8b9bda5](8b9bda5639))
* readme updated to indicate move of web-bundles ([7e9574f](7e9574f571))
* temp disable yml linting ([296c2fb](296c2fbcbd))
* update documentation and installer to reflect .roomodes file location in project root ([#236](https://github.com/bmadcode/BMAD-METHOD/issues/236)) ([bd7f030](bd7f03016b))

### Features

* bmad the creator expansion with some basic tools for modifying bmad method ([2d61df4](2d61df419a))
* can now select different web bundles from what ide agents are installed ([0c41633](0c41633b07))
* installer offers option to install web bundles ([e934769](e934769a5e))
* robust installer ([1fbeed7](1fbeed75ea))
2025-06-17 20:32:24 +00:00
Brian Madison
296c2fbcbd fix: temp disable yml linting 2025-06-17 15:31:58 -05:00
Brian Madison
8b9bda5639 fix: installer relative path issue for npx resolved 2025-06-17 15:24:00 -05:00
Brian Madison
7cf925fe1d readme fix from bad listing autoformatter 2025-06-17 10:59:33 -05:00
Reider Olivér
bd7f03016b fix: update documentation and installer to reflect .roomodes file location in project root (#236) 2025-06-17 10:51:52 -05:00
Brian Madison
0c41633b07 feat: can now select different web bundles from what ide agents are installed 2025-06-17 10:50:54 -05:00
Brian Madison
e934769a5e feat: installer offers option to install web bundles 2025-06-17 09:55:21 -05:00
Brian Madison
fe27d68319 expansion packs updates in progress 2025-06-17 09:35:39 -05:00
Brian Madison
2d61df419a feat: bmad the creator expansion with some basic tools for modifying bmad method 2025-06-16 22:40:30 -05:00
Brian Madison
9d4558b271 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-16 22:26:48 -05:00
Brian Madison
7e9574f571 fix: readme updated to indicate move of web-bundles 2025-06-16 22:26:30 -05:00
Brian Madison
1fbeed75ea feat: robust installer 2025-06-16 21:57:51 -05:00
semantic-release-bot
210c7d240d chore(release): 4.4.2 [skip ci]
## [4.4.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.4.1...v4.4.2) (2025-06-17)

### Bug Fixes

* single agent install and team installation support ([18a382b](18a382baa4))
2025-06-17 02:27:04 +00:00
Brian Madison
18a382baa4 fix: single agent install and team installation support 2025-06-16 21:26:32 -05:00
Brian Madison
449e42440a Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-16 20:31:40 -05:00
Brian Madison
aa482b6454 readme correction 2025-06-16 20:31:27 -05:00
semantic-release-bot
34759d0799 chore(release): 4.4.1 [skip ci]
## [4.4.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.4.0...v4.4.1) (2025-06-17)

### Bug Fixes

* installer no longer suggests the bmad-method directory as defauly ([e2e1658](e2e1658c07))
2025-06-17 00:32:39 +00:00
Brian Madison
e2e1658c07 fix: installer no longer suggests the bmad-method directory as defauly 2025-06-16 19:32:10 -05:00
Brian
595342cb10 Node 20, installer improvements, agent improvements and Expansion Pack for game dev (#232)
* feat: add expansion pack installation system with game dev and infrastructure expansion packs

- Added expansion pack discovery and installation to BMAD installer
- Supports interactive and CLI installation of expansion packs
- Expansion pack files install to destination root (.bmad-core)
- Added game development expansion pack (.bmad-2d-phaser-game-dev)
  - Game designer, developer, and scrum master agents
  - Game-specific templates, tasks, workflows, and guidelines
  - Specialized for Phaser 3 + TypeScript development
- Added infrastructure devops expansion pack (.bmad-infrastructure-devops)
  - Platform engineering agent and infrastructure templates
- Expansion pack agents automatically integrate with IDE rules
- Added list:expansions command and --expansion-packs CLI option

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>

* alpha expansion packs and installer update to support installing expansion packs optionally

* node20

---------

Co-authored-by: Brian Madison <brianmadison@Brians-MacBook-Pro.local>
Co-authored-by: Claude <noreply@anthropic.com>
2025-06-16 18:34:12 -05:00
semantic-release-bot
7df4f4cd0f chore(release): 4.4.0 [skip ci]
# [4.4.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.3.0...v4.4.0) (2025-06-16)

### Features

* improve docs, technical preference usage ([764e770](764e7702b3))
* web bundles updated ([f39b495](f39b4951e9))
2025-06-16 02:28:52 +00:00
Brian Madison
f39b4951e9 feat: web bundles updated 2025-06-15 21:28:21 -05:00
Brian Madison
764e7702b3 feat: improve docs, technical preference usage 2025-06-15 21:27:37 -05:00
Brian Madison
ac291c8dbe removing generating tools to a new folder` 2025-06-15 21:12:22 -05:00
Brian Madison
d59aa191fc random updates 2025-06-15 19:46:32 -05:00
Brian Madison
b2a0725002 lots of docs updates 2025-06-15 18:07:29 -05:00
Brian Madison
9bebbc9064 remove temp doc shard test target 2025-06-15 14:55:21 -05:00
Brian Madison
180c6a7b72 docs: add beginner-friendly pull request guide for new contributors
- Create comprehensive PR guide at docs/how-to-contribute-with-pull-requests.md
- Add prominent links in README.md and CONTRIBUTING.md
- Include step-by-step instructions for GitHub newcomers
- Explain what makes good vs bad PRs with examples
- Add Discord community as primary support channel

This addresses issues with inexperienced contributors submitting
poorly formatted PRs or code dumps instead of proper contributions.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:51:17 -05:00
Brian Madison
39e6db82b1 fix: rollback version from 5.0.0 to 4.3.0 and improve lint-staged config
- Reset both package.json files to version 4.3.0
- The v5.0.0 bump was accidental due to BREAKING CHANGE in commit message
- Enhanced lint-staged to check all YAML files in project including .bmad-core/
- This ensures husky catches YAML formatting issues before push

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:30:20 -05:00
semantic-release-bot
fbc3444240 chore(release): 5.0.0 [skip ci]
# [5.0.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v5.0.0) (2025-06-15)

### Bug Fixes

* add docs ([48ef875](48ef875f5e))
* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* BMAD install creates `.bmad-core/.bmad-core/` directory structure + updates ([#223](https://github.com/bmadcode/BMAD-METHOD/issues/223)) ([28b313c](28b313c01d))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))
* update dependency resolver to support both yml and yaml code blocks ([ba1e5ce](ba1e5ceb36))
* update glob usage to modern async API ([927515c](927515c089))
* update yaml-format.js to use dynamic chalk imports ([b53d954](b53d954b7a))

### Features

* enhance installer with multi-IDE support and sync version bumping ([ebfd4c7](ebfd4c7dd5))
* improve semantic-release automation and disable manual version bumping ([38a5024](38a5024026))
* sync IDE configurations across all platforms ([b6a2f5b](b6a2f5b25e))
* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
* web bundles include a simplified prd with architecture now for simpler project folderes not needing a full plown architecture doc! ([8773545](877354525e))

### BREAKING CHANGES

* Manual version bumping via npm scripts is now disabled. Use conventional commits for automated releases.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 19:25:50 +00:00
Brian Madison
b6a2f5b25e feat: sync IDE configurations across all platforms
- Updated .bmad-core/web-bundles to include latest agent definitions
- Synced sm.md agent configuration across .claude, .windsurf, and .roo platforms
- Added fullstack-architecture-tmpl.md template to architect agent bundles
- Updated Roo Code README.md with current agent list
- Ensured consistent agent personas and commands across all IDEs

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:25:21 -05:00
Brian Madison
49e34f41b6 style: apply formatting fixes and yaml standardization
- Auto-formatting applied by prettier and yaml-format tools
- Standardized YAML code blocks to use 'yaml' instead of 'yml'
- Fixed quote escaping in YAML strings

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:23:33 -05:00
Brian Madison
ba1e5ceb36 fix: update dependency resolver to support both yml and yaml code blocks
- Fix regex pattern to match both yml and yaml in agent markdown files
- This resolves validation failures after yaml-format standardized to 'yaml'

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:23:25 -05:00
Brian Madison
c5fe28e76b style: apply prettier and yaml formatting
Auto-formatting applied by prettier and yaml-format tools.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:20:19 -05:00
Brian Madison
b53d954b7a fix: update yaml-format.js to use dynamic chalk imports
- Convert all functions to async to support chalk ES module import
- Replace string.replace with manual regex processing for async formatYamlContent calls
- This resolves the ERR_REQUIRE_ESM error in GitHub Actions format step

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:20:12 -05:00
Brian Madison
38a5024026 feat: improve semantic-release automation and disable manual version bumping
- Add custom semantic-release plugin to sync installer package.json
- Update semantic-release config to include installer package.json in releases
- Disable manual version bump script in favor of conventional commits
- Add helper script for version synchronization
- This ensures semantic-release fully manages both package.json files

BREAKING CHANGE: Manual version bumping via npm scripts is now disabled. Use conventional commits for automated releases.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:16:01 -05:00
Brian Madison
6d70c588c6 chore: reset version to 4.2.0 for semantic-release sync
Reset manual version bump to let semantic-release handle versioning going forward.
This aligns with the last semantic-release version (4.2.0) and allows proper
automated releases based on conventional commits.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:14:49 -05:00
Brian Madison
927515c089 fix: update glob usage to modern async API
- Remove promisify wrapper for glob since modern glob package is already async
- Fix ERR_INVALID_ARG_TYPE error in v3-to-v4-upgrader.js
- This resolves GitHub Actions validation failures

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-15 14:13:09 -05:00
Brian Madison
ebdafa41b6 packagelock 2025-06-15 14:08:53 -05:00
Brian Madison
c3c971781a chore: bump version to v4.2.1 2025-06-15 14:08:17 -05:00
Brian Madison
e9f1cc7d88 chore: remove test directories from commit 2025-06-15 14:07:41 -05:00
Brian Madison
ebfd4c7dd5 feat: enhance installer with multi-IDE support and sync version bumping 2025-06-15 14:07:25 -05:00
Brian Madison
877354525e feat: web bundles include a simplified prd with architecture now for simpler project folderes not needing a full plown architecture doc! 2025-06-15 13:00:01 -05:00
Kayvan Sylvan
28b313c01d fix: BMAD install creates .bmad-core/.bmad-core/ directory structure + updates (#223)
* chore: fix installation directory handling to use .bmad-core as default path

- Remove redundant ./ prefix from default directory
- Update all default paths from ./.bmad-core to .bmad-core
- Add logic to handle direct .bmad-core path selection
- Treat parent as project root when .bmad-core specified
- Simplify directory state detection for existing files
- Remove unknown_existing state type from installer logic

* chore: refactor installer to use modern JS patterns and improve code clarity

## CHANGES

- Replace require with node:path import
- Add block scoping to switch cases
- Remove unused options parameter from update
- Use optional chaining for ideConfig check
- Replace forEach with for...of loops
- Use template literals for string concatenation
- Add early return to avoid else block
- Update spell check dictionary entries

* chore: update dependencies to latest major versions

## CHANGES

- Update @kayvan/markdown-tree-parser to v1.5.0
- Update chalk to v5.4.1 for ESM support
- Update commander to v14.0.0 with Node 20 requirement
- Update fs-extra to v11.3.0
- Update glob to v11.0.3 with new API
- Update inquirer to v12.6.3 with modular design
- Update ora to v8.2.0 with improved features
2025-06-15 12:50:40 -05:00
semantic-release-bot
9a10a153fb chore(release): 4.2.0 [skip ci]
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

### Bug Fixes

* add docs ([48ef875](48ef875f5e))
* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 16:05:39 +00:00
Brian Madison
e08add957d simple prd workflow 2025-06-15 11:05:06 -05:00
semantic-release-bot
25c356b415 chore(release): 4.2.0 [skip ci]
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

### Bug Fixes

* add docs ([48ef875](48ef875f5e))
* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 14:59:49 +00:00
Kayvan Sylvan
732d536542 chore: update imports to Node.js prefix and add error handling improvements (#221)
## CHANGES

- Replace require('fs') with require('node:fs')
- Replace require('path') with require('node:path')
- Add debug logging for directory cleanup
- Add roomodes to VSCode dictionary
- Format README workflow guides section
- Improve error handling in installer
- Add fallback error message display
2025-06-15 09:59:25 -05:00
semantic-release-bot
e753d02a4b chore(release): 4.2.0 [skip ci]
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

### Bug Fixes

* add docs ([48ef875](48ef875f5e))
* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 06:19:47 +00:00
Brian Madison
54b6c90317 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-15 01:19:04 -05:00
Brian Madison
48ef875f5e fix: add docs 2025-06-15 01:18:55 -05:00
semantic-release-bot
813c380785 chore(release): 4.2.0 [skip ci]
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

### Bug Fixes

* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 06:06:35 +00:00
Brian Madison
6c661adaff rules for driving agents 2025-06-15 01:05:56 -05:00
Brian Madison
193ed8f11f prd migration works well enough 2025-06-15 00:02:17 -05:00
Brian Madison
8b60410f7a fix upgrade of existing project 2025-06-14 23:49:10 -05:00
semantic-release-bot
6bdc0a82bb chore(release): 4.2.0 [skip ci]
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

### Bug Fixes

* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 01:41:03 +00:00
Brian Madison
6b920ebdb0 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-14 20:40:10 -05:00
Brian Madison
1913aeec0a updates to doc and package 2025-06-14 20:39:46 -05:00
semantic-release-bot
c0ceed94c1 chore(release): 4.2.0 [skip ci]
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

### Bug Fixes

* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* resolve NPM token configuration ([620b09a](620b09a556))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 01:31:05 +00:00
Brian Madison
2e4f9f0210 chore: bump version to v4.2.0 2025-06-14 20:30:36 -05:00
semantic-release-bot
00b9168963 chore(release): 1.1.0 [skip ci]
# [1.1.0](https://github.com/bmadcode/BMAD-METHOD/compare/v1.0.1...v1.1.0) (2025-06-15)

### Features

* update badges to use dynamic NPM version ([5a6fe36](5a6fe361d0))
2025-06-15 01:30:10 +00:00
Brian Madison
3fd683d0a7 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-14 20:29:36 -05:00
Brian Madison
5a6fe361d0 feat: update badges to use dynamic NPM version 2025-06-14 20:29:28 -05:00
semantic-release-bot
9b3d2faeb7 chore(release): 1.0.1 [skip ci]
## [1.0.1](https://github.com/bmadcode/BMAD-METHOD/compare/v1.0.0...v1.0.1) (2025-06-15)

### Bug Fixes

* resolve NPM token configuration ([620b09a](620b09a556))
2025-06-15 01:26:42 +00:00
Brian Madison
421a25771e git statusMerge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-14 20:22:33 -05:00
Brian Madison
620b09a556 fix: resolve NPM token configuration 2025-06-14 20:21:25 -05:00
semantic-release-bot
d8e906ba1f chore(release): 1.0.0 [skip ci]
# 1.0.0 (2025-06-15)

### Bug Fixes

* Add bin field to root package.json for npx execution ([01cb46e](01cb46e43d)), closes [bmadcode/BMAD-METHOD#v4](https://github.com/bmadcode/BMAD-METHOD/issues/v4)
* Add glob dependency for installer ([8d788b6](8d788b6f49))
* Add installer dependencies to root package.json ([0a838e9](0a838e9d57))
* auto semantic versioning fix ([166ed04](166ed04767))
* auto semantic versioning fix again ([11260e4](11260e4395))
* Remove problematic install script from package.json ([cb1836b](cb1836bd6d))
* resolve NPM token configuration ([b447a8b](b447a8bd57))

### Features

* add versioning and release automation ([0ea5e50](0ea5e50aa7))
2025-06-15 01:21:07 +00:00
Brian Madison
b447a8bd57 fix: resolve NPM token configuration 2025-06-14 20:20:39 -05:00
Brian Madison
11260e4395 fix: auto semantic versioning fix again 2025-06-14 20:12:29 -05:00
Brian Madison
166ed04767 fix: auto semantic versioning fix 2025-06-14 20:09:20 -05:00
Brian Madison
8d5814c7f5 remove unneeded script and deps 2025-06-14 18:27:25 -05:00
Brian Madison
bc3f60df91 versioning doc 2025-06-14 18:27:08 -05:00
Brian Madison
ebfd2ef543 chore: bump version to v4.1.0 2025-06-14 18:20:06 -05:00
Brian Madison
0ea5e50aa7 feat: add versioning and release automation
- Add semantic-release with changelog and git plugins
- Add manual version bump script (patch/minor/major)
- Add GitHub Actions workflow for automated releases
- Add npm scripts for version management
- Setup .releaserc.json for semantic-release configuration
2025-06-14 18:19:44 -05:00
Brian Madison
413c7230e4 formatter updates 2025-06-14 18:11:58 -05:00
Brian Madison
fcbfc608f1 formatter updates 2025-06-14 18:11:16 -05:00
Brian Madison
2cbbf61d92 cursor, correted roo, and windsurf rules readded and will update on project build 2025-06-14 16:38:37 -05:00
Brian Madison
442166f2f4 update doc migration script - migrates any old version docs to any new version template! 2025-06-14 16:19:33 -05:00
Brian Madison
70f13743b6 readme update to indicate install:bmad handles both install and upgrade 2025-06-14 15:17:07 -05:00
Brian Madison
3e84140f0b install and upgrade consolidated into install:bmad 2025-06-14 15:14:26 -05:00
Brian Madison
5a7ded34e9 install update 2025-06-14 15:06:41 -05:00
Brian Madison
2902221069 auto upgrader from v3-> v4 and readme updates 2025-06-14 13:00:58 -05:00
Brian Madison
1e45d9cc14 merge doc fixes and fix merge conflicts 2025-06-14 08:48:38 -05:00
Kayvan Sylvan
009c77f0f5 refactor: standardize formatting and improve readability across core documents (#211)
### CHANGES

- Add newlines and spacing for improved readability
- Standardize instructional text for consistency
- Renumber lists within tasks for better clarity
- Add language identifiers to various code blocks
- Update placeholder text for improved consistency
- Adjust descriptions and wording in multiple files
- Update VS Code settings and dictionary words
2025-06-14 08:33:59 -05:00
Brian Madison
86649a50ad prior version cleanup 2025-06-14 08:30:53 -05:00
Brian Madison
262c410cee readme spacing fix 2025-06-13 20:57:06 -05:00
Brian Madison
37dcbe581b readme quickstart improved 2025-06-13 20:56:00 -05:00
Brian Madison
726c3d35b6 delete ide file 2025-06-13 20:29:25 -05:00
Brian Madison
62de770bc7 readme version links 2025-06-13 20:20:21 -05:00
Brian Madison
a0763b41be readme update 2025-06-13 20:16:33 -05:00
Brian Madison
0bf5dca4c0 tools fix 2025-06-13 19:42:56 -05:00
Kayvan Sylvan
fdfaa1f81f chore: add VSCode settings and update README.md (markdown-lint) (#209)
* chore: add VSCode settings and update README for clarity**

### CHANGES
- Add recommended extensions for VSCode in `extensions.json`
- Create `settings.json` for custom spell-checker words
- Update README to specify plaintext in code block

* chore: add other technical words to cspell dictionary

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-06-13 19:35:17 -05:00
Brian Madison
7c71e1f815 moved bmad-core to dot folder so when adding to project it is clear its not part of the project it is added to 2025-06-13 19:11:17 -05:00
Brian Madison
03241a73d6 pkg update 2025-06-13 16:36:48 -05:00
Brian Madison
6e63bf2241 Fix npx execution issue with bmad CLI
- Added wrapper script (bmad.js) at root to handle npx execution context
- Fixed module resolution in tools/installer/bin/bmad.js for both local and npx contexts
- Updated package.json bin paths to use the wrapper script
- Handles temporary npx directories properly using execSync

This fixes the issue where `npx github:bmadcode/BMAD-METHOD#v4-alpha bmad`
was dropping into a shell instead of executing the command.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-13 09:01:52 -05:00
Brian Madison
8d788b6f49 fix: Add glob dependency for installer
- Adds missing glob package used by file-manager.js
- Fixes MODULE_NOT_FOUND error for glob

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-13 08:52:51 -05:00
Brian Madison
0a838e9d57 fix: Add installer dependencies to root package.json
- Adds chalk, fs-extra, inquirer, ora for installer functionality
- Fixes MODULE_NOT_FOUND errors when running via npx

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-13 08:50:34 -05:00
Brian Madison
cb1836bd6d fix: Remove problematic install script from package.json
- Prevents circular dependency during npm install
- Fixes npx execution issues

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-13 08:48:59 -05:00
Brian Madison
01cb46e43d fix: Add bin field to root package.json for npx execution
- Points to installer CLI at tools/installer/bin/bmad.js
- Enables npx github:bmadcode/BMAD-METHOD#v4-alpha to work

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-13 08:39:56 -05:00
Brian Madison
204012b35e added kayvans tree parser 2025-06-13 08:05:58 -05:00
Brian Madison
e4d64c8f05 docs update 2025-06-13 07:27:22 -05:00
Brian Madison
8916211ba9 installer functional 2025-06-12 22:38:24 -05:00
Brian Madison
bf09224e05 web bundles and build script updated 2025-06-12 20:52:41 -05:00
Brian Madison
195aad300a minor exp pack fix for infra 2025-06-12 19:56:25 -05:00
Brian Madison
70db485a10 remove v3 docs, clarify contribution guidlines, fix teams to use proper bmad agent. 2025-06-12 19:47:38 -05:00
Brian Madison
576f05a9d0 agent consolidation 2025-06-12 19:36:12 -05:00
Brian Madison
213f4f169d agent udpate 2025-06-11 08:13:36 -05:00
Brian Madison
66dd2a3ec3 remove temp file 2025-06-10 21:42:50 -05:00
Brian Madison
fa97136909 build is back 2025-06-10 21:41:58 -05:00
Brian Madison
52b82651f7 minor updates 2025-06-10 21:07:27 -05:00
Brian Madison
a18ad8bc24 expansion update 2025-06-10 18:14:45 -05:00
Brian Madison
e3a8f0315c build tools temporarily removed, replacement incoming 2025-06-10 17:04:57 -05:00
Brian Madison
cd5fc44de1 a few things are broken, and big folder move incoming.... 2025-06-10 17:03:25 -05:00
Brian Madison
0d59c686dd schema standardization and bmad ide orchesatrtor can do anything 2025-06-10 07:17:19 -05:00
Brian Madison
810a39658a sm and dev idea agent aligned with v4 sharding standards 2025-06-09 21:02:20 -05:00
Brian Madison
39a1ab1f2e files moved and converted to tasks 2025-06-09 19:19:49 -05:00
Brian Madison
ced1123533 claude code tip added to readme 2025-06-09 00:05:06 -05:00
Brian Madison
e2a216477c commands create custom entities with a . at the start of the file name keeping them gitignored by default. 2025-06-09 00:02:58 -05:00
Brian Madison
9bbf613b4c web build functional 2025-06-08 23:18:48 -05:00
Brian Madison
f62a8202a0 build cleans first 2025-06-08 23:06:21 -05:00
Brian Madison
6251fd9f9d fixes 2025-06-08 23:01:50 -05:00
Brian Madison
3a46f93047 rebuild corrected a few bmad agent errors in orchestration where it thought tasks were actual configurations 2025-06-08 22:24:35 -05:00
Brian Madison
5647fff955 alpha build v4 2025-06-08 20:55:44 -05:00
Brian Madison
8ad54024d5 build cleanup 2025-06-08 20:46:44 -05:00
Brian Madison
8788c1d20f checklist standardization and improvement with llm eliciatation 2025-06-08 20:34:07 -05:00
Brian Madison
460c47f5c8 brownfield experimental docs added to templates 2025-06-08 19:22:57 -05:00
Brian Madison
f1fa6256f0 agent team workflows 2025-06-08 17:34:38 -05:00
Brian Madison
54406fa871 expansion-packs 2025-06-08 16:18:35 -05:00
Brian Madison
aa3d8eba67 doc updates, build folder renamed to tools, readme clarity for v4 2025-06-08 10:36:23 -05:00
Davor Racic
92c346e65f Fix story-dod-checklist file extension (#186) 2025-06-08 09:53:38 -05:00
Brian Madison
6c4ff90c50 windsurf agent switcher 2025-06-08 02:38:40 -05:00
Brian Madison
7a63b95e00 infra not algined yet with v4 standards, moved to subfolder until ready for alignment 2025-06-08 02:34:07 -05:00
Brian Madison
b22255762d docs updated 2025-06-08 02:30:28 -05:00
Brian Madison
219198f05b build updates 2025-06-08 02:12:13 -05:00
Brian Madison
e30ad2a5f8 added md-tree-parser suggested install and usage 2025-06-08 01:06:23 -05:00
Brian Madison
335b288c91 FEA and A updated 2025-06-08 00:43:02 -05:00
Brian Madison
d8f75c30df missed a few file saves 2025-06-07 21:32:01 -05:00
Brian Madison
18281f1a34 dev agent for ide improvement in progress, need to finish architecture template improvements before finishing dev agent and sm agent finalization for v4 2025-06-07 21:29:10 -05:00
Brian Madison
673f29c72d initial draft of qa testing ide agent 2025-06-07 18:45:15 -05:00
Brian Madison
3ec0b565bc Major v4 framework restructuring and IDE agent improvements
This commit represents a significant milestone in the BMAD-METHOD v4 framework restructuring effort, focusing on cleaning up legacy v3 content and enhancing IDE agent configurations.

Key Changes:

1. Legacy Content Cleanup:
   - Removed entire _old/ directory containing v3 framework content (55 files, ~6900 lines)
   - Deleted deprecated checklists, personas, tasks, and templates from v3
   - Cleaned up obsolete web orchestrator configurations

2. IDE Agent Enhancements:
   - Added new IDE agent configurations for all major roles:
     * analyst.ide.md - Business Analyst agent
     * architect.ide.md - Architecture specialist agent
     * pm.ide.md - Product Manager agent
     * po.ide.md - Product Owner agent
     * devops.ide.md - DevOps/Platform Engineer agent (replacing devops-pe.ide.md)
   - Updated dev.ide.md with improved structure and commands
   - Enhanced sm.ide.md with proper persona naming (Bob)

3. New Persona Definitions:
   - Added missing persona files: dev.md, devops.md, qa.md
   - Standardized persona format across all roles

4. QA Agent Addition:
   - Added qa.yml configuration for Quality Assurance agent

5. IDE Integration Improvements:
   - Added .claude/commands/ directory for Claude Code command definitions
   - Added .cursor/rules/ for Cursor IDE integration
   - Created agent-switcher.ide.md utility for seamless agent switching

6. Command Updates:
   - Renamed /exit command to /exit-agent for clarity and consistency

7. Build System Updates:
   - Minor fixes to web-builder.js for improved bundle generation

This restructuring aligns with the v4 architecture goals of modularity, reusability, and improved developer experience across different IDE environments.

Authored-By: BMad
2025-06-07 16:39:40 -05:00
Brian Madison
e3ed97a690 Simplify agent configurations and fix team bundle builds
Major refactoring to streamline agent configuration structure and improve build reliability:

Agent Configuration Simplification:
- Remove environment sections from all agent YAML files
- Add single 'persona' property to agent configs pointing to persona file
- All agents now use consistent, simplified structure without web/ide environment splits
- Fix dev agent to be available for web environment (was causing team-dev bundle build failure)

Build System Updates:
- Update dependency-resolver.js to use new persona property instead of environments.web.persona_file
- Update bundle-optimizer.js to load personas using agent's persona property
- Remove environment availability checks since all agents are now web-compatible
- Change output directory from dist/web/bundles/ to dist/web/teams/ for clarity

File Organization:
- Move IDE-specific personas (dev.ide.md, devops-pe.ide.md, sm.ide.md) to bmad-core/ide-agents/
- Rename team bundles for clarity:
  - team-full.yml → team-full-app.yml (web application teams)
  - team-planning.yml → team-small-service.yml (backend service teams)
- Remove team-full-ide.yml (IDE teams will be handled separately)

This change ensures all 3 web team bundles build successfully and simplifies future agent maintenance.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-06 23:12:58 -05:00
Brian Madison
f91f49a6d9 massive v4 framework WIP part 1 2025-06-06 02:24:31 -05:00
Brian Madison
c7995bd1f0 v1 and v2 removed - exist in branches and linked in readme 2025-06-05 21:38:54 -05:00
Brian
04972720d0 Task template standardization improvements (#163)
create-doc-from-template used with create-prd template with new template with llm instruction standardization format.
ide-web agent simplifications, removal of overlap, and agent name alignment
advanced elicitation streamlined throughout creation of PRD
2025-06-05 21:22:01 -05:00
Kayvan Sylvan
fa470c92fd Improve developer experience with shared tooling, cleaner docs. (#170)
* docs: add headers and improve formatting for BMAD orchestrator agent documentation

## CHANGES

- Add configuration header to cfg file
- Improve numbered list formatting consistency
- Add proper heading punctuation throughout
- Enhance readability with cleaner structure
- Standardize markdown formatting conventions

* gitignore update

* Plaform Engineer role for a robust infrastructure (#135)

* Add Platform Engineer role to support a robust and validated infrastructure

* Platform Engineer and Architect boundaries, confidence levels, domain expertise

* remove duplicate task, leftover artifact

* Consistency, workflow, feedback loops between architect and PE

* PE customization generalized, updated Architect, consistency check

* style: add VSCode integration and standardize document formatting

CHANGES
- Introduce VSCode recommended extensions and project-specific settings.
- Update `.gitignore` to track the `.vscode` directory.
- Apply consistent markdown formatting to all checklist documents.
- Standardize spacing, list styles, and headers in personas.
- Refine formatting and sectioning in task definition files.
- Ensure newline termination for all modified text files.
- Correct code block specifiers and minor textual content.

* docs: remove exclamation from header

* fix: spacing at end of line

---------

Co-authored-by: Brian Madison <brianmadison@Brians-MacBook-Pro.local>
Co-authored-by: Sebastian Ickler <icklers@users.noreply.github.com>
2025-06-05 07:42:07 -05:00
548 changed files with 87789 additions and 13135 deletions

40
.coderabbit.yaml Normal file
View File

@@ -0,0 +1,40 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
early_access: true
reviews:
profile: chill
high_level_summary: false # don't post summary until explicitly invoked
request_changes_workflow: false
review_status: false
commit_status: false
walkthrough: false
poem: false
auto_review:
enabled: true
drafts: false # Don't review drafts automatically
auto_incremental_review: false # always review the whole PR, not just new commits
base_branches:
- main
path_filters:
- "!**/node_modules/**"
path_instructions:
- path: "**/*"
instructions: |
Focus on inconsistencies, contradictions, edge cases and serious issues.
Avoid commenting on minor issues such as linting, formatting and style issues.
When providing code suggestions, use GitHub's suggestion format:
```suggestion
<code changes>
```
- path: "**/*.js"
instructions: |
CLI tooling code. Check for: missing error handling on fs operations,
path.join vs string concatenation, proper cleanup in error paths.
Flag any process.exit() without error message.
chat:
auto_reply: true # Response to mentions in comments, a la @coderabbit review
issue_enrichment:
auto_enrich:
enabled: false # don't auto-comment on issues

128
.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
the official BMAD Discord server (<https://discord.com/invite/gk8jAdXWmj>) - DM a moderator or flag a post.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.

15
.github/FUNDING.yaml vendored Normal file
View File

@@ -0,0 +1,15 @@
# These are supported funding model platforms
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project_name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project_name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: bmad
thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

8
.github/ISSUE_TEMPLATE/config.yaml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: http://docs.bmad-method.org
about: Check the docs first — tutorials, guides, and reference
- name: 💬 Discord Community
url: https://discord.gg/gk8jAdXWmj
about: Join for questions, discussion, and help before opening an issue

View File

@@ -0,0 +1,22 @@
---
name: Feature Request
about: Suggest an idea or new feature
title: ''
labels: ''
assignees: ''
---
**Describe your idea**
A clear and concise description of what you'd like to see added or changed.
**Why is this needed?**
Explain the problem this solves or the benefit it brings to the BMad community.
**How should it work?**
Describe your proposed solution. If you have ideas on implementation, share them here.
**PR**
If you'd like to contribute, please indicate you're working on this or link to your PR. Please review [CONTRIBUTING.md](../../CONTRIBUTING.md) — contributions are always welcome!
**Additional context**
Add any other context, screenshots, or links that help explain your idea.

32
.github/ISSUE_TEMPLATE/issue.md vendored Normal file
View File

@@ -0,0 +1,32 @@
---
name: Issue
about: Report a problem or something that's not working
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**Steps to reproduce**
1. What were you doing when the bug occurred?
2. What steps can recreate the issue?
**Expected behavior**
A clear and concise description of what you expected to happen.
**Environment (if relevant)**
- Model(s) used:
- Agentic IDE used:
- BMad version:
- Project language:
**Screenshots or links**
If applicable, add screenshots or links to help explain the problem.
**PR**
If you'd like to contribute a fix, please indicate you're working on it or link to your PR. See [CONTRIBUTING.md](../../CONTRIBUTING.md) — contributions are always welcome!
**Additional context**
Add any other context about the problem here. The more information you provide, the easier it is to help.

34
.github/scripts/discord-helpers.sh vendored Normal file
View File

@@ -0,0 +1,34 @@
#!/bin/bash
# Discord notification helper functions
# Escape markdown special chars and @mentions for safe Discord display
# Skips content inside <URL> wrappers to preserve URLs intact
esc() {
awk '{
result = ""; in_url = 0; n = length($0)
for (i = 1; i <= n; i++) {
c = substr($0, i, 1)
if (c == "<" && substr($0, i, 8) ~ /^<https?:/) in_url = 1
if (in_url) { result = result c; if (c == ">") in_url = 0 }
else if (c == "@") result = result "@ "
else if (index("[]\\*_()~`", c) > 0) result = result "\\" c
else result = result c
}
print result
}'
}
# Truncate to $1 chars (or 80 if wall-of-text with <3 spaces)
trunc() {
local max=$1
local txt=$(tr '\n\r' ' ' | cut -c1-"$max")
local spaces=$(printf '%s' "$txt" | tr -cd ' ' | wc -c)
[ "$spaces" -lt 3 ] && [ ${#txt} -gt 80 ] && txt=$(printf '%s' "$txt" | cut -c1-80)
printf '%s' "$txt"
}
# Remove incomplete URL at end of truncated text (incomplete URLs are useless)
strip_trailing_url() { sed -E 's~<?https?://[^[:space:]]*$~~'; }
# Wrap URLs in <> to suppress Discord embeds (keeps links clickable)
wrap_urls() { sed -E 's~https?://[^[:space:]<>]+~<&>~g'; }

90
.github/workflows/discord.yaml vendored Normal file
View File

@@ -0,0 +1,90 @@
name: Discord Notification
on:
pull_request:
types: [opened, closed]
issues:
types: [opened]
env:
MAX_TITLE: 100
MAX_BODY: 250
jobs:
pull_request:
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.repository.default_branch }}
sparse-checkout: .github/scripts
sparse-checkout-cone-mode: false
- name: Notify Discord
env:
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
ACTION: ${{ github.event.action }}
MERGED: ${{ github.event.pull_request.merged }}
PR_NUM: ${{ github.event.pull_request.number }}
PR_URL: ${{ github.event.pull_request.html_url }}
PR_TITLE: ${{ github.event.pull_request.title }}
PR_USER: ${{ github.event.pull_request.user.login }}
PR_BODY: ${{ github.event.pull_request.body }}
run: |
set -o pipefail
source .github/scripts/discord-helpers.sh
[ -z "$WEBHOOK" ] && exit 0
if [ "$ACTION" = "opened" ]; then ICON="🔀"; LABEL="New PR"
elif [ "$ACTION" = "closed" ] && [ "$MERGED" = "true" ]; then ICON="🎉"; LABEL="Merged"
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"; fi
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
BODY=$(printf '%s' "$PR_BODY" | trunc $MAX_BODY)
if [ -n "$PR_BODY" ] && [ ${#PR_BODY} -gt $MAX_BODY ]; then
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
fi
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
[ -n "$PR_BODY" ] && [ ${#PR_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
[ -n "$BODY" ] && BODY=" · $BODY"
USER=$(printf '%s' "$PR_USER" | esc)
MSG="$ICON **[$LABEL #$PR_NUM: $TITLE](<$PR_URL>)**"$'\n'"by @$USER$BODY"
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
issues:
if: github.event_name == 'issues'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.repository.default_branch }}
sparse-checkout: .github/scripts
sparse-checkout-cone-mode: false
- name: Notify Discord
env:
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
ISSUE_NUM: ${{ github.event.issue.number }}
ISSUE_URL: ${{ github.event.issue.html_url }}
ISSUE_TITLE: ${{ github.event.issue.title }}
ISSUE_USER: ${{ github.event.issue.user.login }}
ISSUE_BODY: ${{ github.event.issue.body }}
run: |
set -o pipefail
source .github/scripts/discord-helpers.sh
[ -z "$WEBHOOK" ] && exit 0
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
if [ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ]; then
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
fi
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
[ -n "$BODY" ] && BODY=" · $BODY"
USER=$(printf '%s' "$ISSUE_USER" | esc)
MSG="🐛 **[Issue #$ISSUE_NUM: $TITLE](<$ISSUE_URL>)**"$'\n'"by @$USER$BODY"
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-

63
.github/workflows/docs.yaml vendored Normal file
View File

@@ -0,0 +1,63 @@
name: Deploy Documentation
on:
push:
branches:
- main
paths:
- "docs/**"
- "src/modules/*/docs/**"
- "website/**"
- "tools/build-docs.js"
- ".github/workflows/docs.yaml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Build documentation
env:
# Override site URL from GitHub repo variable if set
# Otherwise, astro.config.mjs will compute from GITHUB_REPOSITORY
SITE_URL: ${{ vars.SITE_URL }}
run: npm run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: build/site
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

193
.github/workflows/manual-release.yaml vendored Normal file
View File

@@ -0,0 +1,193 @@
name: Manual Release
on:
workflow_dispatch:
inputs:
version_bump:
description: Version bump type
required: true
default: beta
type: choice
options:
- beta
- alpha
- patch
- minor
- major
permissions:
contents: write
packages: write
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: npm
registry-url: https://registry.npmjs.org
- name: Install dependencies
run: npm ci
- name: Run tests and validation
run: |
npm run validate
npm run format:check
npm run lint
- name: Configure Git
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
- name: Bump version
run: |
case "${{ github.event.inputs.version_bump }}" in
alpha|beta) npm version prerelease --no-git-tag-version --preid=${{ github.event.inputs.version_bump }} ;;
*) npm version ${{ github.event.inputs.version_bump }} --no-git-tag-version ;;
esac
- name: Get new version and previous tag
id: version
run: |
echo "new_version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
echo "previous_tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
- name: Update installer package.json
run: |
sed -i 's/"version": ".*"/"version": "${{ steps.version.outputs.new_version }}"/' tools/installer/package.json
# TODO: Re-enable web bundles once tools/cli/bundlers/ is restored
# - name: Generate web bundles
# run: npm run bundle
- name: Commit version bump
run: |
git add .
git commit -m "release: bump to v${{ steps.version.outputs.new_version }}"
- name: Generate release notes
id: release_notes
run: |
# Get commits since last tag
COMMITS=$(git log ${{ steps.version.outputs.previous_tag }}..HEAD --pretty=format:"- %s" --reverse)
# Categorize commits
FEATURES=$(echo "$COMMITS" | grep -E "^- (feat|Feature)" || true)
FIXES=$(echo "$COMMITS" | grep -E "^- (fix|Fix)" || true)
CHORES=$(echo "$COMMITS" | grep -E "^- (chore|Chore)" || true)
OTHERS=$(echo "$COMMITS" | grep -v -E "^- (feat|Feature|fix|Fix|chore|Chore|release:|Release:)" || true)
# Build release notes
cat > release_notes.md << 'EOF'
## 🚀 What's New in v${{ steps.version.outputs.new_version }}
EOF
if [ ! -z "$FEATURES" ]; then
echo "### ✨ New Features" >> release_notes.md
echo "$FEATURES" >> release_notes.md
echo "" >> release_notes.md
fi
if [ ! -z "$FIXES" ]; then
echo "### 🐛 Bug Fixes" >> release_notes.md
echo "$FIXES" >> release_notes.md
echo "" >> release_notes.md
fi
if [ ! -z "$OTHERS" ]; then
echo "### 📦 Other Changes" >> release_notes.md
echo "$OTHERS" >> release_notes.md
echo "" >> release_notes.md
fi
if [ ! -z "$CHORES" ]; then
echo "### 🔧 Maintenance" >> release_notes.md
echo "$CHORES" >> release_notes.md
echo "" >> release_notes.md
fi
cat >> release_notes.md << 'EOF'
## 📦 Installation
```bash
npx bmad-method install
```
**Full Changelog**: https://github.com/bmad-code-org/BMAD-METHOD/compare/${{ steps.version.outputs.previous_tag }}...v${{ steps.version.outputs.new_version }}
EOF
# Output for GitHub Actions
echo "RELEASE_NOTES<<EOF" >> $GITHUB_OUTPUT
cat release_notes.md >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
- name: Create and push tag
run: |
# Check if tag already exists
if git rev-parse "v${{ steps.version.outputs.new_version }}" >/dev/null 2>&1; then
echo "Tag v${{ steps.version.outputs.new_version }} already exists, skipping tag creation"
else
git tag -a "v${{ steps.version.outputs.new_version }}" -m "Release v${{ steps.version.outputs.new_version }}"
git push origin "v${{ steps.version.outputs.new_version }}"
fi
- name: Push changes to main
run: |
if git push origin HEAD:main 2>/dev/null; then
echo "✅ Successfully pushed to main branch"
else
echo "⚠️ Could not push to main (protected branch). This is expected."
echo "📝 Version bump and tag were created successfully."
fi
- name: Publish to NPM
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
VERSION="${{ steps.version.outputs.new_version }}"
if [[ "$VERSION" == *"alpha"* ]]; then
echo "Publishing alpha prerelease version with --tag alpha"
npm publish --tag alpha
elif [[ "$VERSION" == *"beta"* ]]; then
echo "Publishing beta prerelease version with --tag latest"
npm publish --tag latest
else
echo "Publishing stable version with --tag latest"
npm publish --tag latest
fi
- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: v${{ steps.version.outputs.new_version }}
name: "BMad Method v${{ steps.version.outputs.new_version }}"
body: |
${{ steps.release_notes.outputs.RELEASE_NOTES }}
draft: false
prerelease: ${{ contains(steps.version.outputs.new_version, 'alpha') || contains(steps.version.outputs.new_version, 'beta') }}
- name: Summary
run: |
echo "## 🎉 Successfully released v${{ steps.version.outputs.new_version }}!" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "### 📦 Distribution" >> $GITHUB_STEP_SUMMARY
echo "- **NPM**: Published with @latest tag" >> $GITHUB_STEP_SUMMARY
echo "- **GitHub Release**: https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v${{ steps.version.outputs.new_version }}" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "### ✅ Installation" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
echo "npx bmad-method@${{ steps.version.outputs.new_version }} install" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY

115
.github/workflows/quality.yaml vendored Normal file
View File

@@ -0,0 +1,115 @@
name: Quality & Validation
# Runs comprehensive quality checks on all PRs:
# - Prettier (formatting)
# - ESLint (linting)
# - markdownlint (markdown quality)
# - Schema validation (YAML structure)
# - Agent schema tests (fixture-based validation)
# - Installation component tests (compilation)
# - Bundle validation (web bundle integrity)
"on":
pull_request:
branches: ["**"]
workflow_dispatch:
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Prettier format check
run: npm run format:check
eslint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: ESLint
run: npm run lint
markdownlint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: markdownlint
run: npm run lint:md
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Validate documentation links
run: npm run docs:validate-links
- name: Build documentation
run: npm run docs:build
validate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Validate YAML schemas
run: npm run validate:schemas
- name: Run agent schema validation tests
run: npm run test:schemas
- name: Test agent compilation components
run: npm run test:install

69
.gitignore vendored
View File

@@ -1,21 +1,68 @@
# Node modules
node_modules/
# Dependencies
**/node_modules/
pnpm-lock.yaml
bun.lock
deno.lock
pnpm-workspace.yaml
package-lock.json
test-output/*
coverage/
# Logs
logs
logs/
*.log
npm-debug.log*
# Build output
dist/
build/
# System files
.DS_Store
build/*.txt
# Environment variables
.env
# VSCode settings
.vscode/
CLAUDE.md
# System files
.DS_Store
Thumbs.db
# Development tools and configs
.prettierrc
# AI assistant files
CLAUDE.md
.ai/*
cursor
.gemini
.mcp.json
CLAUDE.local.md
.serena/
.claude/settings.local.json
z*/
_bmad
_bmad-output
.clinerules
.augment
.crush
.cursor
.iflow
.opencode
.qwen
.rovodev
.kilocodemodes
.claude
.codex
.github/chatmodes
.github/agents
.agent
.agentvibes
.kiro
.roo
.trae
.windsurf
# Astro / Documentation Build
website/.astro/
website/dist/
build/

20
.husky/pre-commit Executable file
View File

@@ -0,0 +1,20 @@
#!/usr/bin/env sh
# Auto-fix changed files and stage them
npx --no-install lint-staged
# Validate everything
npm test
# Validate docs links only when docs change
if command -v rg >/dev/null 2>&1; then
if git diff --cached --name-only | rg -q '^docs/'; then
npm run docs:validate-links
npm run docs:build
fi
else
if git diff --cached --name-only | grep -Eq '^docs/'; then
npm run docs:validate-links
npm run docs:build
fi
fi

41
.markdownlint-cli2.yaml Normal file
View File

@@ -0,0 +1,41 @@
# markdownlint-cli2 configuration
# https://github.com/DavidAnson/markdownlint-cli2
ignores:
- "**/node_modules/**"
- test/fixtures/**
- CODE_OF_CONDUCT.md
- _bmad/**
- _bmad*/**
- .agent/**
- .claude/**
- .roo/**
- .codex/**
- .kiro/**
- sample-project/**
- test-project-install/**
- z*/**
# Rule configuration
config:
# Disable all rules by default
default: false
# Heading levels should increment by one (h1 -> h2 -> h3, not h1 -> h3)
MD001: true
# Duplicate sibling headings (same heading text at same level under same parent)
MD024:
siblings_only: true
# Trailing commas in headings (likely typos)
MD026:
punctuation: ","
# Bare URLs - may not render as links in all parsers
# Should use <url> or [text](url) format
MD034: true
# Spaces inside emphasis markers - breaks rendering
# e.g., "* text *" won't render as emphasis
MD037: true

1
.npmrc Normal file
View File

@@ -0,0 +1 @@
registry=https://registry.npmjs.org

1
.nvmrc Normal file
View File

@@ -0,0 +1 @@
22

9
.prettierignore Normal file
View File

@@ -0,0 +1,9 @@
# Test fixtures with intentionally broken/malformed files
test/fixtures/**
# Contributor Covenant (external standard)
CODE_OF_CONDUCT.md
# BMAD runtime folders (user-specific, not in repo)
_bmad/
_bmad*/

97
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,97 @@
{
"chat.agent.enabled": true,
"chat.agent.maxRequests": 15,
"github.copilot.chat.agent.runTasks": true,
"chat.mcp.discovery.enabled": {
"claude-desktop": true,
"windsurf": true,
"cursor-global": true,
"cursor-workspace": true
},
"github.copilot.chat.agent.autoFix": true,
"chat.tools.autoApprove": false,
"cSpell.words": [
"Agentic",
"atlasing",
"Biostatistician",
"bmad",
"Cordova",
"customresourcedefinitions",
"dashboarded",
"Decisioning",
"eksctl",
"elicitations",
"Excalidraw",
"filecomplete",
"fintech",
"fluxcd",
"frontmatter",
"gamedev",
"gitops",
"implementability",
"Improv",
"inclusivity",
"ingressgateway",
"istioctl",
"metroidvania",
"NACLs",
"nodegroup",
"platformconfigs",
"Playfocus",
"playtesting",
"pointerdown",
"pointerup",
"Polyrepo",
"replayability",
"roguelike",
"roomodes",
"Runbook",
"runbooks",
"Shardable",
"Softlock",
"solutioning",
"speedrunner",
"substep",
"tekton",
"tilemap",
"tileset",
"tmpl",
"Trae",
"Unsharded",
"VNET",
"webskip"
],
"json.schemas": [
{
"fileMatch": ["package.json"],
"url": "https://json.schemastore.org/package.json"
},
{
"fileMatch": [".vscode/settings.json"],
"url": "vscode://schemas/settings/folder"
}
],
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[javascript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"[json]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[yaml]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[markdown]": {
"editor.defaultFormatter": "yzhang.markdown-all-in-one"
},
"yaml.format.enable": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
"editor.rulers": [140],
"[xml]": {
"editor.defaultFormatter": "redhat.vscode-xml"
},
"xml.format.maxLineWidth": 140
}

1488
CHANGELOG.md Normal file

File diff suppressed because it is too large Load Diff

1
CNAME Normal file
View File

@@ -0,0 +1 @@
docs.bmad-method.org

167
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,167 @@
# Contributing to BMad
Thank you for considering contributing! We believe in **Human Amplification, Not Replacement** — bringing out the best thinking in both humans and AI through guided collaboration.
💬 **Discord**: [Join our community](https://discord.gg/gk8jAdXWmj) for real-time discussions, questions, and collaboration.
---
## 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?"**
**✅ What we welcome:**
- Enhanced collaboration patterns and workflows
- Improved agent personas and prompts
- Domain-specific modules leveraging BMad Core
- Better planning and context continuity
**❌ What doesn't fit:**
- Purely automated solutions that sideline humans
- Complexity that creates barriers to adoption
- Features that fragment BMad Core's foundation
---
## Reporting Issues
**ALL bug reports and feature requests MUST go through GitHub Issues.**
### Before Creating an Issue
1. **Search existing issues** — Use the GitHub issue search to check if your bug or feature has already been reported
2. **Search closed issues** — Your issue may have been fixed or addressed previously
3. **Check discussions** — Some conversations happen in [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
### Bug Reports
After searching, if the bug is unreported, use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md) and include:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Your environment (model, IDE, BMad version)
- Screenshots or error messages if applicable
### Feature Requests
After searching, use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md) and explain:
- What the feature is
- Why it would benefit the BMad community
- How it strengthens human-AI collaboration
**For community modules**, review [TRADEMARK.md](TRADEMARK.md) for proper naming conventions (e.g., "My Module (BMad Community Module)").
---
## 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.
---
## Pull Request Guidelines
### Target Branch
Submit PRs to the `main` branch.
### PR Size
- **Ideal**: 200-400 lines of code changes
- **Maximum**: 800 lines (excluding generated files)
- **One feature/fix per PR**
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
### New to Pull Requests?
1. **Fork** the repository
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
3. **Create a branch**: `git checkout -b fix/description` or `git checkout -b feature/description`
4. **Make changes** — keep them focused
5. **Commit**: `git commit -m "fix: correct typo in README"`
6. **Push**: `git push origin fix/description`
7. **Open PR** from your fork on GitHub
### PR Description Template
```markdown
## What
[1-2 sentences describing WHAT changed]
## Why
[1-2 sentences explaining WHY this change is needed]
Fixes #[issue number]
## How
- [2-3 bullets listing HOW you implemented it]
-
## Testing
[1-2 sentences on how you tested this]
```
**Keep it under 200 words.**
### Commit Messages
Use conventional commits:
- `feat:` New feature
- `fix:` Bug fix
- `docs:` Documentation only
- `refactor:` Code change (no bug/feature)
- `test:` Adding tests
- `chore:` Build/tools changes
Keep messages under 72 characters. Each commit = one logical change.
---
## What Makes a Good PR?
| ✅ Do | ❌ Don't |
| --------------------------- | ---------------------------- |
| Change one thing per PR | Mix unrelated changes |
| Clear title and description | Vague or missing explanation |
| Reference related issues | Reformat entire files |
| Small, focused commits | Copy your whole project |
| Work on a branch | Work directly on `main` |
---
## Prompt & Agent Guidelines
- Keep dev agents lean — focus on coding context, not documentation
- Web/planning agents can be larger with complex tasks
- Everything is natural language (markdown) — no code in core framework
- Use BMad modules for domain-specific features
- Validate YAML schemas: `npm run validate:schemas`
---
## Need Help?
- 💬 **Discord**: [Join the community](https://discord.gg/gk8jAdXWmj)
- 🐛 **Bugs**: Use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
- 💡 **Features**: Use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
---
## Code of Conduct
By participating, you agree to abide by our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
## License
By contributing, your contributions are licensed under the same MIT License. See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.

32
CONTRIBUTORS.md Normal file
View File

@@ -0,0 +1,32 @@
# Contributors
BMad Core, BMad Method and BMad and Community BMad Modules are made possible by contributions from our community. We gratefully acknowledge everyone who has helped improve this project.
## How We Credit Contributors
- **Git history** — Every contribution is preserved in the project's commit history
- **Contributors badge** — See the dynamic contributors list on our [README](README.md)
- **GitHub contributors graph** — Visual representation at <https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors>
## Becoming a Contributor
Anyone who submits a pull request that is merged becomes a contributor. Contributions include:
- Bug fixes
- New features or workflows
- Documentation improvements
- Bug reports and issue triaging
- Code reviews
- Helping others in discussions
There are no minimum contribution requirements — whether it's a one-character typo fix or a major feature, we value all contributions.
## Copyright
The BMad Method project is copyrighted by BMad Code, LLC. Individual contributions are licensed under the same MIT License as the project. Contributors retain authorship credit through Git history and the contributors graph.
---
**Thank you to everyone who has helped make BMad Method better!**
For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).

30
LICENSE Normal file
View File

@@ -0,0 +1,30 @@
MIT License
Copyright (c) 2025 BMad Code, LLC
This project incorporates contributions from the open source community.
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
TRADEMARK NOTICE:
BMad™, BMad Method™, and BMad Core™ are trademarks of BMad Code, LLC, covering all
casings and variations (including BMAD, bmad, BMadMethod, BMAD-METHOD, etc.). The use of
these trademarks in this software does not grant any rights to use the trademarks
for any other purpose. See [TRADEMARK.md](TRADEMARK.md) for detailed guidelines.

151
README.md
View File

@@ -1,13 +1,150 @@
# BMad Method V2
![BMad Method](banner-bmad-method.png)
V2 was the major fix to the shortcomings of V1.
[![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)
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
Templates were introduced, and separated from the agents themselves. Also aside from templates, checklists were introduced to give more power in actually vetting the the documents or artifacts being produced were valid and of high quality through a forced round of advanced elicitation.
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
During V2, this is where the discovery of the power of Gemini Gems and Custom GPTs came to light, really indicating how powerful and cost effective it can be to utilize the Web for a lot of the initial planning, but doing it in a structured repeatable way!
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
The Web Agents were all granular and clearly defined - a much simpler system, but also somewhat of a pain to create each agent separately in the web while also having to manually export and reimport each document when going agent to agent.
## Why BMad?
Also one confusing aspect was that there were duplicates of temples and checklists for the web versions and the ide versions.
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
But - overall, this was a very low bar to entry to pick up and start using it - The agent personas were all still pretty self contained, aside from calling out to separate template files for the documents.
- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project
- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way
## Quick Start
**Prerequisites**: [Node.js](https://nodejs.org) v20+
```bash
npx bmad-method install
```
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
- `/bmad-help I just finished the architecture, I am not sure what to do next`
And the amazing thing is BMad Help evolves depending on what modules you install also!
- `/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?`, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
### Simple Path (Quick Flow)
Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
2. `/dev-story` — implements each story
3. `/code-review` — validates quality
### Full Planning Path (BMad Method)
Products, platforms, complex features — structured planning then build:
1. `/product-brief` — define problem, users, and MVP scope
2. `/create-prd` — full requirements with personas, metrics, and risks
3. `/create-architecture` — technical decisions and system design
4. `/create-epics-and-stories` — break work into prioritized stories
5. `/sprint-planning` — initialize sprint tracking
6. **Repeat per story:** `/create-story``/dev-story``/code-review`
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/).
## Modules
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.
| Module | GitHub | NPM | Purpose |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
| **Test Architect (TEA)** 🆕 | [bmad-code-org/tea](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise) | [tea](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise) | Risk-based test strategy, automation, and release gates (8 workflows) |
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!
## Testing Agents
BMad provides two testing options to fit your needs:
### Quinn (QA) - Built-in
**Quick test automation for rapid coverage**
-**Always available** in BMM module (no separate install)
-**Simple**: One workflow (`QA` - Automate)
-**Beginner-friendly**: Standard test framework patterns
-**Fast**: Generate tests and ship
**Use Quinn for:** Small projects, quick coverage, standard patterns
### Test Architect (TEA) - Optional Module
**Enterprise-grade test strategy and quality engineering**
- 🆕 **Standalone module** (install separately)
- 🏗️ **Comprehensive**: 8 workflows covering full test lifecycle
- 🎯 **Advanced**: Risk-based planning, quality gates, NFR assessment
- 📚 **Knowledge-driven**: 34 testing patterns and best practices
- 📖 [Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
**Use TEA for:** Enterprise projects, test strategy, compliance, release gates
---
## Documentation
**[BMad Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
**[Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)** — TEA standalone module documentation
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
- [Test Architect Migration Guide](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/migration/) — Upgrading from BMM-embedded TEA
### For v4 Users
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
## 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)
- [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)
## Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## License
MIT License — see [LICENSE](LICENSE) for details.
---
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. See [TRADEMARK.md](TRADEMARK.md) for details.
[![Contributors](https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD)](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.

85
SECURITY.md Normal file
View File

@@ -0,0 +1,85 @@
# Security Policy
## Supported Versions
We release security patches for the following versions:
| Version | Supported |
| ------- | ------------------ |
| Latest | :white_check_mark: |
| < Latest | :x: |
We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.
## Reporting a Vulnerability
We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly.
### How to Report
**Do NOT report security vulnerabilities through public GitHub issues.**
Instead, please report them via one of these methods:
1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report.
2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj).
### What to Include
Please include as much of the following information as possible:
- Type of vulnerability (e.g., prompt injection, path traversal, etc.)
- Full paths of source file(s) related to the vulnerability
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if available)
- Impact assessment of the vulnerability
### Response Timeline
- **Initial Response**: Within 48 hours of receiving your report
- **Status Update**: Within 7 days with our assessment
- **Resolution Target**: Critical issues within 30 days; other issues within 90 days
### What to Expect
1. We will acknowledge receipt of your report
2. We will investigate and validate the vulnerability
3. We will work on a fix and coordinate disclosure timing with you
4. We will credit you in the security advisory (unless you prefer to remain anonymous)
## Security Scope
### In Scope
- Vulnerabilities in BMad Method core framework code
- Security issues in agent definitions or workflows that could lead to unintended behavior
- Path traversal or file system access issues
- Prompt injection vulnerabilities that bypass intended agent behavior
- Supply chain vulnerabilities in dependencies
### Out of Scope
- Security issues in user-created custom agents or modules
- Vulnerabilities in third-party AI providers (Claude, GPT, etc.)
- Issues that require physical access to a user's machine
- Social engineering attacks
- Denial of service attacks that don't exploit a specific vulnerability
## Security Best Practices for Users
When using BMad Method:
1. **Review Agent Outputs**: Always review AI-generated code before executing it
2. **Limit File Access**: Configure your AI IDE to limit file system access where possible
3. **Keep Updated**: Regularly update to the latest version
4. **Validate Dependencies**: Review any dependencies added by generated code
5. **Environment Isolation**: Consider running AI-assisted development in isolated environments
## Acknowledgments
We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories.
---
Thank you for helping keep BMad Method and our community safe.

55
TRADEMARK.md Normal file
View File

@@ -0,0 +1,55 @@
# Trademark Notice & Guidelines
## Trademark Ownership
The following names and logos are trademarks of BMad Code, LLC:
- **BMad** (word mark, all casings: BMad, bmad, BMAD)
- **BMad Method** (word mark, includes BMadMethod, BMAD-METHOD, and all variations)
- **BMad Core** (word mark, includes BMadCore, BMAD-CORE, and all variations)
- **BMad Code** (word mark)
- BMad Method logo and visual branding
- The "Build More, Architect Dreams" tagline
**All casings, stylings, and variations** of the above names (with or without hyphens, spaces, or specific capitalization) are covered by these trademarks.
These trademarks are protected under trademark law and are **not** licensed under the MIT License. The MIT License applies to the software code only, not to the BMad brand identity.
## What This Means
You may:
- Use the BMad software under the terms of the MIT License
- Refer to BMad to accurately describe compatibility or integration (e.g., "Compatible with BMad Method v6")
- Link to <https://github.com/bmad-code-org/BMAD-METHOD>
- Fork the software and distribute your own version under a different name
You may **not**:
- Use "BMad" or any confusingly similar variation as your product name, service name, company name, or domain name
- Present your product as officially endorsed, approved, or certified by BMad Code, LLC when it is not, without written consent from an authorized representative of BMad Code, LLC
- Use BMad logos or branding in a way that suggests your product is an official or endorsed BMad product
- Register domain names, social media handles, or trademarks that incorporate BMad branding
## Examples
| Permitted | Not Permitted |
| ------------------------------------------------------ | -------------------------------------------- |
| "My workflow tool, compatible with BMad Method" | "BMadFlow" or "BMad Studio" |
| "An alternative implementation inspired by BMad" | "BMad Pro" or "BMad Enterprise" |
| "My Awesome Healthcare Module (Bmad Community Module)" | "The Official BMad Core Healthcare Module" |
| Accurately stating you use BMad as a dependency | Implying official endorsement or partnership |
## Commercial Use
You may sell products that incorporate or work with BMad software. However:
- Your product must have its own distinct name and branding
- You must not use BMad trademarks in your marketing, domain names, or product identity
- You may truthfully describe technical compatibility (e.g., "Works with BMad Method")
## Questions?
If you have questions about trademark usage or would like to discuss official partnership or endorsement opportunities, please reach out:
- **Email**: <contact@bmadcode.com>

View File

@@ -1,48 +0,0 @@
# Documentation Index
## Overview
This index catalogs all documentation files for the BMAD-METHOD project, organized by category for easy reference and AI discoverability.
## Product Documentation
- **[prd.md](prd.md)** - Product Requirements Document outlining the core project scope, features and business objectives.
- **[final-brief-with-pm-prompt.md](final-brief-with-pm-prompt.md)** - Finalized project brief with Product Management specifications.
- **[demo.md](demo.md)** - Main demonstration guide for the BMAD-METHOD project.
## Architecture & Technical Design
- **[architecture.md](architecture.md)** - System architecture documentation detailing technical components and their interactions.
- **[tech-stack.md](tech-stack.md)** - Overview of the technology stack used in the project.
- **[project-structure.md](project-structure.md)** - Explanation of the project's file and folder organization.
- **[data-models.md](data-models.md)** - Documentation of data models and database schema.
- **[environment-vars.md](environment-vars.md)** - Required environment variables and configuration settings.
## API Documentation
- **[api-reference.md](api-reference.md)** - Comprehensive API endpoints and usage reference.
## Epics & User Stories
- **[epic1.md](epic1.md)** - Epic 1 definition and scope.
- **[epic2.md](epic2.md)** - Epic 2 definition and scope.
- **[epic3.md](epic3.md)** - Epic 3 definition and scope.
- **[epic4.md](epic4.md)** - Epic 4 definition and scope.
- **[epic5.md](epic5.md)** - Epic 5 definition and scope.
- **[epic-1-stories-demo.md](epic-1-stories-demo.md)** - Detailed user stories for Epic 1.
- **[epic-2-stories-demo.md](epic-2-stories-demo.md)** - Detailed user stories for Epic 2.
- **[epic-3-stories-demo.md](epic-3-stories-demo.md)** - Detailed user stories for Epic 3.
## Development Standards
- **[coding-standards.md](coding-standards.md)** - Coding conventions and standards for the project.
- **[testing-strategy.md](testing-strategy.md)** - Approach to testing, including methodologies and tools.
## AI & Prompts
- **[prompts.md](prompts.md)** - AI prompt templates and guidelines for project assistants.
- **[combined-artifacts-for-posm.md](combined-artifacts-for-posm.md)** - Consolidated project artifacts for Product Owner and Solution Manager.
## Reference Documents
- **[botched-architecture-draft.md](botched-architecture-draft.md)** - Archived architecture draft (for reference only).

View File

@@ -1,97 +0,0 @@
# BMad Hacker Daily Digest API Reference
This document describes the external APIs consumed by the BMad Hacker Daily Digest application.
## External APIs Consumed
### Algolia Hacker News (HN) Search API
- **Purpose:** Used to fetch the top Hacker News stories and the comments associated with each story.
- **Base URL:** `http://hn.algolia.com/api/v1`
- **Authentication:** None required for public search endpoints.
- **Key Endpoints Used:**
- **`GET /search` (for Top Stories)**
- Description: Retrieves stories based on search parameters. Used here to get top stories from the front page.
- Request Parameters:
- `tags=front_page`: Required to filter for front-page stories.
- `hitsPerPage=10`: Specifies the number of stories to retrieve (adjust as needed, default is typically 20).
- Example Request (Conceptual using native `Workspace`):
```typescript
// Using Node.js native Workspace API
const url =
"[http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10](http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10)";
const response = await fetch(url);
const data = await response.json();
```
- Success Response Schema (Code: `200 OK`): See "Algolia HN API - Story Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing story objects.
- Error Response Schema(s): Standard HTTP errors (e.g., 4xx, 5xx). May return JSON with an error message.
- **`GET /search` (for Comments)**
- Description: Retrieves comments associated with a specific story ID.
- Request Parameters:
- `tags=comment,story_{storyId}`: Required to filter for comments belonging to the specified `storyId`. Replace `{storyId}` with the actual ID (e.g., `story_12345`).
- `hitsPerPage={maxComments}`: Specifies the maximum number of comments to retrieve (value from `.env` `MAX_COMMENTS_PER_STORY`).
- Example Request (Conceptual using native `Workspace`):
```typescript
// Using Node.js native Workspace API
const storyId = "..."; // HN Story ID
const maxComments = 50; // From config
const url = `http://hn.algolia.com/api/v1/search?tags=comment,story_${storyId}&hitsPerPage=${maxComments}`;
const response = await fetch(url);
const data = await response.json();
```
- Success Response Schema (Code: `200 OK`): See "Algolia HN API - Comment Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing comment objects.
- Error Response Schema(s): Standard HTTP errors.
- **Rate Limits:** Subject to Algolia's public API rate limits (typically generous for HN search but not explicitly defined/guaranteed). Implementations should handle potential 429 errors gracefully if encountered.
- **Link to Official Docs:** [https://hn.algolia.com/api](https://hn.algolia.com/api)
### Ollama API (Local Instance)
- **Purpose:** Used to generate text summaries for scraped article content and HN comment discussions using a locally running LLM.
- **Base URL:** Configurable via the `OLLAMA_ENDPOINT_URL` environment variable (e.g., `http://localhost:11434`).
- **Authentication:** None typically required for default local installations.
- **Key Endpoints Used:**
- **`POST /api/generate`**
- Description: Generates text based on a model and prompt. Used here for summarization.
- Request Body Schema: See `OllamaGenerateRequest` in `docs/data-models.md`. Requires `model` (from `.env` `OLLAMA_MODEL`), `prompt`, and `stream: false`.
- Example Request (Conceptual using native `Workspace`):
```typescript
// Using Node.js native Workspace API
const ollamaUrl =
process.env.OLLAMA_ENDPOINT_URL || "http://localhost:11434";
const requestBody: OllamaGenerateRequest = {
model: process.env.OLLAMA_MODEL || "llama3",
prompt: "Summarize this text: ...",
stream: false,
};
const response = await fetch(`${ollamaUrl}/api/generate`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(requestBody),
});
const data: OllamaGenerateResponse | { error: string } =
await response.json();
```
- Success Response Schema (Code: `200 OK`): See `OllamaGenerateResponse` in `docs/data-models.md`. Key field is `response` containing the generated text.
- Error Response Schema(s): May return non-200 status codes or a `200 OK` with a JSON body like `{ "error": "error message..." }` (e.g., if the model is unavailable).
- **Rate Limits:** N/A for a typical local instance. Performance depends on local hardware.
- **Link to Official Docs:** [https://github.com/ollama/ollama/blob/main/docs/api.md](https://github.com/ollama/ollama/blob/main/docs/api.md)
## Internal APIs Provided
- **N/A:** The application is a self-contained CLI tool and does not expose any APIs for other services to consume.
## Cloud Service SDK Usage
- **N/A:** The application runs locally and uses the native Node.js `Workspace` API for HTTP requests, not cloud provider SDKs.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Draft based on PRD/Epics/Models | 3-Architect |

View File

@@ -1,97 +0,0 @@
# BMad Hacker Daily Digest API Reference
This document describes the external APIs consumed by the BMad Hacker Daily Digest application.
## External APIs Consumed
### Algolia Hacker News (HN) Search API
- **Purpose:** Used to fetch the top Hacker News stories and the comments associated with each story.
- **Base URL:** `http://hn.algolia.com/api/v1`
- **Authentication:** None required for public search endpoints.
- **Key Endpoints Used:**
- **`GET /search` (for Top Stories)**
- Description: Retrieves stories based on search parameters. Used here to get top stories from the front page.
- Request Parameters:
- `tags=front_page`: Required to filter for front-page stories.
- `hitsPerPage=10`: Specifies the number of stories to retrieve (adjust as needed, default is typically 20).
- Example Request (Conceptual using native `Workspace`):
```typescript
// Using Node.js native Workspace API
const url =
"[http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10](http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10)";
const response = await fetch(url);
const data = await response.json();
```
- Success Response Schema (Code: `200 OK`): See "Algolia HN API - Story Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing story objects.
- Error Response Schema(s): Standard HTTP errors (e.g., 4xx, 5xx). May return JSON with an error message.
- **`GET /search` (for Comments)**
- Description: Retrieves comments associated with a specific story ID.
- Request Parameters:
- `tags=comment,story_{storyId}`: Required to filter for comments belonging to the specified `storyId`. Replace `{storyId}` with the actual ID (e.g., `story_12345`).
- `hitsPerPage={maxComments}`: Specifies the maximum number of comments to retrieve (value from `.env` `MAX_COMMENTS_PER_STORY`).
- Example Request (Conceptual using native `Workspace`):
```typescript
// Using Node.js native Workspace API
const storyId = "..."; // HN Story ID
const maxComments = 50; // From config
const url = `http://hn.algolia.com/api/v1/search?tags=comment,story_${storyId}&hitsPerPage=${maxComments}`;
const response = await fetch(url);
const data = await response.json();
```
- Success Response Schema (Code: `200 OK`): See "Algolia HN API - Comment Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing comment objects.
- Error Response Schema(s): Standard HTTP errors.
- **Rate Limits:** Subject to Algolia's public API rate limits (typically generous for HN search but not explicitly defined/guaranteed). Implementations should handle potential 429 errors gracefully if encountered.
- **Link to Official Docs:** [https://hn.algolia.com/api](https://hn.algolia.com/api)
### Ollama API (Local Instance)
- **Purpose:** Used to generate text summaries for scraped article content and HN comment discussions using a locally running LLM.
- **Base URL:** Configurable via the `OLLAMA_ENDPOINT_URL` environment variable (e.g., `http://localhost:11434`).
- **Authentication:** None typically required for default local installations.
- **Key Endpoints Used:**
- **`POST /api/generate`**
- Description: Generates text based on a model and prompt. Used here for summarization.
- Request Body Schema: See `OllamaGenerateRequest` in `docs/data-models.md`. Requires `model` (from `.env` `OLLAMA_MODEL`), `prompt`, and `stream: false`.
- Example Request (Conceptual using native `Workspace`):
```typescript
// Using Node.js native Workspace API
const ollamaUrl =
process.env.OLLAMA_ENDPOINT_URL || "http://localhost:11434";
const requestBody: OllamaGenerateRequest = {
model: process.env.OLLAMA_MODEL || "llama3",
prompt: "Summarize this text: ...",
stream: false,
};
const response = await fetch(`${ollamaUrl}/api/generate`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(requestBody),
});
const data: OllamaGenerateResponse | { error: string } =
await response.json();
```
- Success Response Schema (Code: `200 OK`): See `OllamaGenerateResponse` in `docs/data-models.md`. Key field is `response` containing the generated text.
- Error Response Schema(s): May return non-200 status codes or a `200 OK` with a JSON body like `{ "error": "error message..." }` (e.g., if the model is unavailable).
- **Rate Limits:** N/A for a typical local instance. Performance depends on local hardware.
- **Link to Official Docs:** [https://github.com/ollama/ollama/blob/main/docs/api.md](https://github.com/ollama/ollama/blob/main/docs/api.md)
## Internal APIs Provided
- **N/A:** The application is a self-contained CLI tool and does not expose any APIs for other services to consume.
## Cloud Service SDK Usage
- **N/A:** The application runs locally and uses the native Node.js `Workspace` API for HTTP requests, not cloud provider SDKs.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Draft based on PRD/Epics/Models | 3-Architect |

View File

@@ -1,254 +0,0 @@
# BMad Hacker Daily Digest Architecture Document
## Technical Summary
The BMad Hacker Daily Digest is a command-line interface (CLI) tool designed to provide users with concise summaries of top Hacker News (HN) stories and their associated comment discussions . Built with TypeScript and Node.js (v22) , it operates entirely on the user's local machine . The core functionality involves a sequential pipeline: fetching story and comment data from the Algolia HN Search API , attempting to scrape linked article content , generating summaries using a local Ollama LLM instance , persisting intermediate data to the local filesystem , and finally assembling and emailing an HTML digest using Nodemailer . The architecture emphasizes modularity and testability, including mandatory standalone scripts for testing each pipeline stage . The project starts from the `bmad-boilerplate` template .
## High-Level Overview
The application follows a simple, sequential pipeline architecture executed via a manual CLI command (`npm run dev` or `npm start`) . There is no persistent database; the local filesystem is used to store intermediate data artifacts (fetched data, scraped text, summaries) between steps within a date-stamped directory . All external HTTP communication (Algolia API, article scraping, Ollama API) utilizes the native Node.js `Workspace` API .
```mermaid
graph LR
subgraph "BMad Hacker Daily Digest (Local CLI)"
A[index.ts / CLI Trigger] --> B(core/pipeline.ts);
B --> C{Fetch HN Data};
B --> D{Scrape Articles};
B --> E{Summarize Content};
B --> F{Assemble & Email Digest};
C --> G["Local FS (_data.json)"];
D --> H["Local FS (_article.txt)"];
E --> I["Local FS (_summary.json)"];
F --> G;
F --> H;
F --> I;
end
subgraph External Services
X[Algolia HN API];
Y[Article Websites];
Z["Ollama API (Local)"];
W[SMTP Service];
end
C --> X;
D --> Y;
E --> Z;
F --> W;
style G fill:#eee,stroke:#333,stroke-width:1px
style H fill:#eee,stroke:#333,stroke-width:1px
style I fill:#eee,stroke:#333,stroke-width:1px
```
## Component View
The application code (`src/`) is organized into logical modules based on the defined project structure (`docs/project-structure.md`). Key components include:
- **`src/index.ts`**: The main entry point, handling CLI invocation and initiating the pipeline.
- **`src/core/pipeline.ts`**: Orchestrates the sequential execution of the main pipeline stages (fetch, scrape, summarize, email).
- **`src/clients/`**: Modules responsible for interacting with external APIs.
- `algoliaHNClient.ts`: Communicates with the Algolia HN Search API.
- `ollamaClient.ts`: Communicates with the local Ollama API.
- **`src/scraper/articleScraper.ts`**: Handles fetching and extracting text content from article URLs.
- **`src/email/`**: Manages digest assembly, HTML rendering, and email dispatch via Nodemailer.
- `contentAssembler.ts`: Reads persisted data.
- `templates.ts`: Renders HTML.
- `emailSender.ts`: Sends the email.
- **`src/stages/`**: Contains standalone scripts (`Workspace_hn_data.ts`, `scrape_articles.ts`, etc.) for testing individual pipeline stages independently using local data where applicable.
- **`src/utils/`**: Shared utilities for configuration loading (`config.ts`), logging (`logger.ts`), and date handling (`dateUtils.ts`).
- **`src/types/`**: Shared TypeScript interfaces and types.
```mermaid
graph TD
subgraph AppComponents ["Application Components (src/)"]
Idx(index.ts) --> Pipe(core/pipeline.ts);
Pipe --> HNClient(clients/algoliaHNClient.ts);
Pipe --> Scraper(scraper/articleScraper.ts);
Pipe --> OllamaClient(clients/ollamaClient.ts);
Pipe --> Assembler(email/contentAssembler.ts);
Pipe --> Renderer(email/templates.ts);
Pipe --> Sender(email/emailSender.ts);
Pipe --> Utils(utils/*);
Pipe --> Types(types/*);
HNClient --> Types;
OllamaClient --> Types;
Assembler --> Types;
Renderer --> Types;
subgraph StageRunnersSubgraph ["Stage Runners (src/stages/)"]
SFetch(fetch_hn_data.ts) --> HNClient;
SFetch --> Utils;
SScrape(scrape_articles.ts) --> Scraper;
SScrape --> Utils;
SSummarize(summarize_content.ts) --> OllamaClient;
SSummarize --> Utils;
SEmail(send_digest.ts) --> Assembler;
SEmail --> Renderer;
SEmail --> Sender;
SEmail --> Utils;
end
end
subgraph Externals ["Filesystem & External"]
FS["Local Filesystem (output/)"]
Algolia((Algolia HN API))
Websites((Article Websites))
Ollama["Ollama API (Local)"]
SMTP((SMTP Service))
end
HNClient --> Algolia;
Scraper --> Websites;
OllamaClient --> Ollama;
Sender --> SMTP;
Pipe --> FS;
Assembler --> FS;
SFetch --> FS;
SScrape --> FS;
SSummarize --> FS;
SEmail --> FS;
%% Apply style to the subgraph using its ID after the block
style StageRunnersSubgraph fill:#f9f,stroke:#333,stroke-width:1px
```
## Key Architectural Decisions & Patterns
- **Architecture Style:** Simple Sequential Pipeline executed via CLI.
- **Execution Environment:** Local machine only; no cloud deployment, no database for MVP.
- **Data Handling:** Intermediate data persisted to local filesystem in a date-stamped directory.
- **HTTP Client:** Mandatory use of native Node.js v22 `Workspace` API for all external HTTP requests.
- **Modularity:** Code organized into distinct modules for clients, scraping, email, core logic, utilities, and types to promote separation of concerns and testability.
- **Stage Testing:** Mandatory standalone scripts (`src/stages/*`) allow independent testing of each pipeline phase.
- **Configuration:** Environment variables loaded natively from `.env` file; no `dotenv` package required.
- **Error Handling:** Graceful handling of scraping failures (log and continue); basic logging for other API/network errors.
- **Logging:** Basic console logging via a simple wrapper (`src/utils/logger.ts`) for MVP; structured file logging is a post-MVP consideration.
- **Key Libraries:** `@extractus/article-extractor`, `date-fns`, `nodemailer`, `yargs`. (See `docs/tech-stack.md`)
## Core Workflow / Sequence Diagram (Main Pipeline)
```mermaid
sequenceDiagram
participant CLI_User as CLI User
participant Idx as src/index.ts
participant Pipe as core/pipeline.ts
participant Cfg as utils/config.ts
participant Log as utils/logger.ts
participant HN as clients/algoliaHNClient.ts
participant FS as Local FS [output/]
participant Scr as scraper/articleScraper.ts
participant Oll as clients/ollamaClient.ts
participant Asm as email/contentAssembler.ts
participant Tpl as email/templates.ts
participant Snd as email/emailSender.ts
participant Alg as Algolia HN API
participant Web as Article Website
participant Olm as Ollama API [Local]
participant SMTP as SMTP Service
Note right of CLI_User: Triggered via 'npm run dev'/'start'
CLI_User ->> Idx: Execute script
Idx ->> Cfg: Load .env config
Idx ->> Log: Initialize logger
Idx ->> Pipe: runPipeline()
Pipe ->> Log: Log start
Pipe ->> HN: fetchTopStories()
HN ->> Alg: Request stories
Alg -->> HN: Story data
HN -->> Pipe: stories[]
loop For each story
Pipe ->> HN: fetchCommentsForStory(storyId, max)
HN ->> Alg: Request comments
Alg -->> HN: Comment data
HN -->> Pipe: comments[]
Pipe ->> FS: Write {storyId}_data.json
end
Pipe ->> Log: Log HN fetch complete
loop For each story with URL
Pipe ->> Scr: scrapeArticle(story.url)
Scr ->> Web: Request article HTML [via Workspace]
alt Scraping Successful
Web -->> Scr: HTML content
Scr -->> Pipe: articleText: string
Pipe ->> FS: Write {storyId}_article.txt
else Scraping Failed / Skipped
Web -->> Scr: Error / Non-HTML / Timeout
Scr -->> Pipe: articleText: null
Pipe ->> Log: Log scraping failure/skip
end
end
Pipe ->> Log: Log scraping complete
loop For each story
alt Article content exists
Pipe ->> Oll: generateSummary(prompt, articleText)
Oll ->> Olm: POST /api/generate [article]
Olm -->> Oll: Article Summary / Error
Oll -->> Pipe: articleSummary: string | null
else No article content
Pipe -->> Pipe: Set articleSummary = null
end
alt Comments exist
Pipe ->> Pipe: Format comments to text block
Pipe ->> Oll: generateSummary(prompt, commentsText)
Oll ->> Olm: POST /api/generate [comments]
Olm -->> Oll: Discussion Summary / Error
Oll -->> Pipe: discussionSummary: string | null
else No comments
Pipe -->> Pipe: Set discussionSummary = null
end
Pipe ->> FS: Write {storyId}_summary.json
end
Pipe ->> Log: Log summarization complete
Pipe ->> Asm: assembleDigestData(dateDirPath)
Asm ->> FS: Read _data.json, _summary.json files
FS -->> Asm: File contents
Asm -->> Pipe: digestData[]
alt Digest data assembled
Pipe ->> Tpl: renderDigestHtml(digestData, date)
Tpl -->> Pipe: htmlContent: string
Pipe ->> Snd: sendDigestEmail(subject, htmlContent)
Snd ->> Cfg: Load email config
Snd ->> SMTP: Send email
SMTP -->> Snd: Success/Failure
Snd -->> Pipe: success: boolean
Pipe ->> Log: Log email result
else Assembly failed / No data
Pipe ->> Log: Log skipping email
end
Pipe ->> Log: Log finished
```
## Infrastructure and Deployment Overview
- **Cloud Provider(s):** N/A. Executes locally on the user's machine.
- **Core Services Used:** N/A (relies on external Algolia API, local Ollama, target websites, SMTP provider).
- **Infrastructure as Code (IaC):** N/A.
- **Deployment Strategy:** Manual execution via CLI (`npm run dev` or `npm run start` after `npm run build`). No CI/CD pipeline required for MVP.
- **Environments:** Single environment: local development machine.
## Key Reference Documents
- `docs/prd.md`
- `docs/epic1.md` ... `docs/epic5.md`
- `docs/tech-stack.md`
- `docs/project-structure.md`
- `docs/data-models.md`
- `docs/api-reference.md`
- `docs/environment-vars.md`
- `docs/coding-standards.md`
- `docs/testing-strategy.md`
- `docs/prompts.md`
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | -------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on PRD | 3-Architect |

View File

@@ -1,254 +0,0 @@
# BMad Hacker Daily Digest Architecture Document
## Technical Summary
The BMad Hacker Daily Digest is a command-line interface (CLI) tool designed to provide users with concise summaries of top Hacker News (HN) stories and their associated comment discussions . Built with TypeScript and Node.js (v22) , it operates entirely on the user's local machine . The core functionality involves a sequential pipeline: fetching story and comment data from the Algolia HN Search API , attempting to scrape linked article content , generating summaries using a local Ollama LLM instance , persisting intermediate data to the local filesystem , and finally assembling and emailing an HTML digest using Nodemailer . The architecture emphasizes modularity and testability, including mandatory standalone scripts for testing each pipeline stage . The project starts from the `bmad-boilerplate` template .
## High-Level Overview
The application follows a simple, sequential pipeline architecture executed via a manual CLI command (`npm run dev` or `npm start`) . There is no persistent database; the local filesystem is used to store intermediate data artifacts (fetched data, scraped text, summaries) between steps within a date-stamped directory . All external HTTP communication (Algolia API, article scraping, Ollama API) utilizes the native Node.js `Workspace` API .
```mermaid
graph LR
subgraph "BMad Hacker Daily Digest (Local CLI)"
A[index.ts / CLI Trigger] --> B(core/pipeline.ts);
B --> C{Fetch HN Data};
B --> D{Scrape Articles};
B --> E{Summarize Content};
B --> F{Assemble & Email Digest};
C --> G["Local FS (_data.json)"];
D --> H["Local FS (_article.txt)"];
E --> I["Local FS (_summary.json)"];
F --> G;
F --> H;
F --> I;
end
subgraph External Services
X[Algolia HN API];
Y[Article Websites];
Z["Ollama API (Local)"];
W[SMTP Service];
end
C --> X;
D --> Y;
E --> Z;
F --> W;
style G fill:#eee,stroke:#333,stroke-width:1px
style H fill:#eee,stroke:#333,stroke-width:1px
style I fill:#eee,stroke:#333,stroke-width:1px
```
## Component View
The application code (`src/`) is organized into logical modules based on the defined project structure (`docs/project-structure.md`). Key components include:
- **`src/index.ts`**: The main entry point, handling CLI invocation and initiating the pipeline.
- **`src/core/pipeline.ts`**: Orchestrates the sequential execution of the main pipeline stages (fetch, scrape, summarize, email).
- **`src/clients/`**: Modules responsible for interacting with external APIs.
- `algoliaHNClient.ts`: Communicates with the Algolia HN Search API.
- `ollamaClient.ts`: Communicates with the local Ollama API.
- **`src/scraper/articleScraper.ts`**: Handles fetching and extracting text content from article URLs.
- **`src/email/`**: Manages digest assembly, HTML rendering, and email dispatch via Nodemailer.
- `contentAssembler.ts`: Reads persisted data.
- `templates.ts`: Renders HTML.
- `emailSender.ts`: Sends the email.
- **`src/stages/`**: Contains standalone scripts (`Workspace_hn_data.ts`, `scrape_articles.ts`, etc.) for testing individual pipeline stages independently using local data where applicable.
- **`src/utils/`**: Shared utilities for configuration loading (`config.ts`), logging (`logger.ts`), and date handling (`dateUtils.ts`).
- **`src/types/`**: Shared TypeScript interfaces and types.
```mermaid
graph TD
subgraph AppComponents ["Application Components (src/)"]
Idx(index.ts) --> Pipe(core/pipeline.ts);
Pipe --> HNClient(clients/algoliaHNClient.ts);
Pipe --> Scraper(scraper/articleScraper.ts);
Pipe --> OllamaClient(clients/ollamaClient.ts);
Pipe --> Assembler(email/contentAssembler.ts);
Pipe --> Renderer(email/templates.ts);
Pipe --> Sender(email/emailSender.ts);
Pipe --> Utils(utils/*);
Pipe --> Types(types/*);
HNClient --> Types;
OllamaClient --> Types;
Assembler --> Types;
Renderer --> Types;
subgraph StageRunnersSubgraph ["Stage Runners (src/stages/)"]
SFetch(fetch_hn_data.ts) --> HNClient;
SFetch --> Utils;
SScrape(scrape_articles.ts) --> Scraper;
SScrape --> Utils;
SSummarize(summarize_content.ts) --> OllamaClient;
SSummarize --> Utils;
SEmail(send_digest.ts) --> Assembler;
SEmail --> Renderer;
SEmail --> Sender;
SEmail --> Utils;
end
end
subgraph Externals ["Filesystem & External"]
FS["Local Filesystem (output/)"]
Algolia((Algolia HN API))
Websites((Article Websites))
Ollama["Ollama API (Local)"]
SMTP((SMTP Service))
end
HNClient --> Algolia;
Scraper --> Websites;
OllamaClient --> Ollama;
Sender --> SMTP;
Pipe --> FS;
Assembler --> FS;
SFetch --> FS;
SScrape --> FS;
SSummarize --> FS;
SEmail --> FS;
%% Apply style to the subgraph using its ID after the block
style StageRunnersSubgraph fill:#f9f,stroke:#333,stroke-width:1px
```
## Key Architectural Decisions & Patterns
- **Architecture Style:** Simple Sequential Pipeline executed via CLI.
- **Execution Environment:** Local machine only; no cloud deployment, no database for MVP.
- **Data Handling:** Intermediate data persisted to local filesystem in a date-stamped directory.
- **HTTP Client:** Mandatory use of native Node.js v22 `Workspace` API for all external HTTP requests.
- **Modularity:** Code organized into distinct modules for clients, scraping, email, core logic, utilities, and types to promote separation of concerns and testability.
- **Stage Testing:** Mandatory standalone scripts (`src/stages/*`) allow independent testing of each pipeline phase.
- **Configuration:** Environment variables loaded natively from `.env` file; no `dotenv` package required.
- **Error Handling:** Graceful handling of scraping failures (log and continue); basic logging for other API/network errors.
- **Logging:** Basic console logging via a simple wrapper (`src/utils/logger.ts`) for MVP; structured file logging is a post-MVP consideration.
- **Key Libraries:** `@extractus/article-extractor`, `date-fns`, `nodemailer`, `yargs`. (See `docs/tech-stack.md`)
## Core Workflow / Sequence Diagram (Main Pipeline)
```mermaid
sequenceDiagram
participant CLI_User as CLI User
participant Idx as src/index.ts
participant Pipe as core/pipeline.ts
participant Cfg as utils/config.ts
participant Log as utils/logger.ts
participant HN as clients/algoliaHNClient.ts
participant FS as Local FS [output/]
participant Scr as scraper/articleScraper.ts
participant Oll as clients/ollamaClient.ts
participant Asm as email/contentAssembler.ts
participant Tpl as email/templates.ts
participant Snd as email/emailSender.ts
participant Alg as Algolia HN API
participant Web as Article Website
participant Olm as Ollama API [Local]
participant SMTP as SMTP Service
Note right of CLI_User: Triggered via 'npm run dev'/'start'
CLI_User ->> Idx: Execute script
Idx ->> Cfg: Load .env config
Idx ->> Log: Initialize logger
Idx ->> Pipe: runPipeline()
Pipe ->> Log: Log start
Pipe ->> HN: fetchTopStories()
HN ->> Alg: Request stories
Alg -->> HN: Story data
HN -->> Pipe: stories[]
loop For each story
Pipe ->> HN: fetchCommentsForStory(storyId, max)
HN ->> Alg: Request comments
Alg -->> HN: Comment data
HN -->> Pipe: comments[]
Pipe ->> FS: Write {storyId}_data.json
end
Pipe ->> Log: Log HN fetch complete
loop For each story with URL
Pipe ->> Scr: scrapeArticle(story.url)
Scr ->> Web: Request article HTML [via Workspace]
alt Scraping Successful
Web -->> Scr: HTML content
Scr -->> Pipe: articleText: string
Pipe ->> FS: Write {storyId}_article.txt
else Scraping Failed / Skipped
Web -->> Scr: Error / Non-HTML / Timeout
Scr -->> Pipe: articleText: null
Pipe ->> Log: Log scraping failure/skip
end
end
Pipe ->> Log: Log scraping complete
loop For each story
alt Article content exists
Pipe ->> Oll: generateSummary(prompt, articleText)
Oll ->> Olm: POST /api/generate [article]
Olm -->> Oll: Article Summary / Error
Oll -->> Pipe: articleSummary: string | null
else No article content
Pipe -->> Pipe: Set articleSummary = null
end
alt Comments exist
Pipe ->> Pipe: Format comments to text block
Pipe ->> Oll: generateSummary(prompt, commentsText)
Oll ->> Olm: POST /api/generate [comments]
Olm -->> Oll: Discussion Summary / Error
Oll -->> Pipe: discussionSummary: string | null
else No comments
Pipe -->> Pipe: Set discussionSummary = null
end
Pipe ->> FS: Write {storyId}_summary.json
end
Pipe ->> Log: Log summarization complete
Pipe ->> Asm: assembleDigestData(dateDirPath)
Asm ->> FS: Read _data.json, _summary.json files
FS -->> Asm: File contents
Asm -->> Pipe: digestData[]
alt Digest data assembled
Pipe ->> Tpl: renderDigestHtml(digestData, date)
Tpl -->> Pipe: htmlContent: string
Pipe ->> Snd: sendDigestEmail(subject, htmlContent)
Snd ->> Cfg: Load email config
Snd ->> SMTP: Send email
SMTP -->> Snd: Success/Failure
Snd -->> Pipe: success: boolean
Pipe ->> Log: Log email result
else Assembly failed / No data
Pipe ->> Log: Log skipping email
end
Pipe ->> Log: Log finished
```
## Infrastructure and Deployment Overview
- **Cloud Provider(s):** N/A. Executes locally on the user's machine.
- **Core Services Used:** N/A (relies on external Algolia API, local Ollama, target websites, SMTP provider).
- **Infrastructure as Code (IaC):** N/A.
- **Deployment Strategy:** Manual execution via CLI (`npm run dev` or `npm run start` after `npm run build`). No CI/CD pipeline required for MVP.
- **Environments:** Single environment: local development machine.
## Key Reference Documents
- `docs/prd.md`
- `docs/epic1.md` ... `docs/epic5.md`
- `docs/tech-stack.md`
- `docs/project-structure.md`
- `docs/data-models.md`
- `docs/api-reference.md`
- `docs/environment-vars.md`
- `docs/coding-standards.md`
- `docs/testing-strategy.md`
- `docs/prompts.md`
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | -------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on PRD | 3-Architect |

View File

@@ -1,226 +0,0 @@
# BMad Hacker Daily Digest Architecture Document
## Technical Summary
This document outlines the technical architecture for the BMad Hacker Daily Digest, a command-line tool built with TypeScript and Node.js v22. It adheres to the structure provided by the "bmad-boilerplate". The system fetches the top 10 Hacker News stories and their comments daily via the Algolia HN API, attempts to scrape linked articles, generates summaries for both articles (if scraped) and discussions using a local Ollama instance, persists intermediate data locally, and sends an HTML digest email via Nodemailer upon manual CLI execution. The architecture emphasizes modularity through distinct clients and processing stages, facilitating independent stage testing as required by the PRD. Execution is strictly local for the MVP.
## High-Level Overview
The application follows a sequential pipeline architecture triggered by a single CLI command (`npm run dev` or `npm start`). Data flows through distinct stages: HN Data Acquisition, Article Scraping, LLM Summarization, and Digest Assembly/Email Dispatch. Each stage persists its output to a date-stamped local directory, allowing subsequent stages to operate on this data and enabling stage-specific testing utilities.
**(Diagram Suggestion for Canvas: Create a flowchart showing the stages below)**
```mermaid
graph TD
A[CLI Trigger (npm run dev/start)] --> B(Initialize: Load Config, Setup Logger, Create Output Dir);
B --> C{Fetch HN Data (Top 10 Stories + Comments)};
C -- Story/Comment Data --> D(Persist HN Data: ./output/YYYY-MM-DD/{storyId}_data.json);
D --> E{Attempt Article Scraping (per story)};
E -- Scraped Text (if successful) --> F(Persist Article Text: ./output/YYYY-MM-DD/{storyId}_article.txt);
F --> G{Generate Summaries (Article + Discussion via Ollama)};
G -- Summaries --> H(Persist Summaries: ./output/YYYY-MM-DD/{storyId}_summary.json);
H --> I{Assemble Digest (Read persisted data)};
I -- HTML Content --> J{Send Email via Nodemailer};
J --> K(Log Final Status & Exit);
subgraph Stage Testing Utilities
direction LR
T1[npm run stage:fetch] --> D;
T2[npm run stage:scrape] --> F;
T3[npm run stage:summarize] --> H;
T4[npm run stage:email] --> J;
end
C --> |Error/Skip| G; // If no comments
E --> |Skip/Fail| G; // If no URL or scrape fails
G --> |Summarization Fail| H; // Persist null summaries
I --> |Assembly Fail| K; // Skip email if assembly fails
```
## Component View
The application logic resides primarily within the `src/` directory, organized into modules responsible for specific pipeline stages or cross-cutting concerns.
**(Diagram Suggestion for Canvas: Create a component diagram showing modules and dependencies)**
```mermaid
graph TD
subgraph src ["Source Code (src/)"]
direction LR
Entry["index.ts (Main Orchestrator)"]
subgraph Config ["Configuration"]
ConfMod["config.ts"]
EnvFile[".env File"]
end
subgraph Utils ["Utilities"]
Logger["logger.ts"]
end
subgraph Clients ["External Service Clients"]
Algolia["clients/algoliaHNClient.ts"]
Ollama["clients/ollamaClient.ts"]
end
Scraper["scraper/articleScraper.ts"]
subgraph Email ["Email Handling"]
Assembler["email/contentAssembler.ts"]
Templater["email/templater.ts (or within Assembler)"]
Sender["email/emailSender.ts"]
Nodemailer["(nodemailer library)"]
end
subgraph Stages ["Stage Testing Scripts (src/stages/)"]
FetchStage["fetch_hn_data.ts"]
ScrapeStage["scrape_articles.ts"]
SummarizeStage["summarize_content.ts"]
SendStage["send_digest.ts"]
end
Entry --> ConfMod;
Entry --> Logger;
Entry --> Algolia;
Entry --> Scraper;
Entry --> Ollama;
Entry --> Assembler;
Entry --> Templater;
Entry --> Sender;
Algolia -- uses --> NativeFetch["Node.js v22 Native Workspace"];
Ollama -- uses --> NativeFetch;
Scraper -- uses --> NativeFetch;
Scraper -- uses --> ArticleExtractor["(@extractus/article-extractor)"];
Sender -- uses --> Nodemailer;
ConfMod -- reads --> EnvFile;
Assembler -- reads --> LocalFS["Local Filesystem (./output)"];
Entry -- writes --> LocalFS;
FetchStage --> Algolia;
FetchStage --> LocalFS;
ScrapeStage --> Scraper;
ScrapeStage --> LocalFS;
SummarizeStage --> Ollama;
SummarizeStage --> LocalFS;
SendStage --> Assembler;
SendStage --> Templater;
SendStage --> Sender;
SendStage --> LocalFS;
end
CLI["CLI (npm run ...)"] --> Entry;
CLI -- runs --> FetchStage;
CLI -- runs --> ScrapeStage;
CLI -- runs --> SummarizeStage;
CLI -- runs --> SendStage;
```
_Module Descriptions:_
- **`src/index.ts`**: The main entry point, orchestrating the entire pipeline flow from initialization to final email dispatch. Imports and calls functions from other modules.
- **`src/config.ts`**: Responsible for loading and validating environment variables from the `.env` file using the `dotenv` library.
- **`src/logger.ts`**: Provides a simple console logging utility used throughout the application.
- **`src/clients/algoliaHNClient.ts`**: Encapsulates interaction with the Algolia Hacker News Search API using the native `Workspace` API for fetching stories and comments.
- **`src/clients/ollamaClient.ts`**: Encapsulates interaction with the local Ollama API endpoint using the native `Workspace` API for generating summaries.
- **`src/scraper/articleScraper.ts`**: Handles fetching article HTML using native `Workspace` and extracting text content using `@extractus/article-extractor`. Includes robust error handling for fetch and extraction failures.
- **`src/email/contentAssembler.ts`**: Reads persisted story data and summaries from the local output directory.
- **`src/email/templater.ts` (or integrated)**: Renders the HTML email content using the assembled data.
- **`src/email/emailSender.ts`**: Configures and uses Nodemailer to send the generated HTML email.
- **`src/stages/*.ts`**: Individual scripts designed to run specific pipeline stages independently for testing, using persisted data from previous stages as input where applicable.
## Key Architectural Decisions & Patterns
- **Pipeline Architecture:** A sequential flow where each stage processes data and passes artifacts to the next via the local filesystem. Chosen for simplicity and to easily support independent stage testing.
- **Local Execution & File Persistence:** All execution is local, and intermediate artifacts (`_data.json`, `_article.txt`, `_summary.json`) are stored in a date-stamped `./output` directory. This avoids database setup for MVP and facilitates debugging/stage testing.
- **Native `Workspace` API:** Mandated by constraints for all HTTP requests (Algolia, Ollama, Article Scraping). Ensures usage of the latest Node.js features.
- **Modular Clients:** External interactions (Algolia, Ollama) are encapsulated in dedicated client modules (`src/clients/`). This promotes separation of concerns and makes swapping implementations (e.g., different LLM API) easier.
- **Configuration via `.env`:** Standard approach using `dotenv` for managing API keys, endpoints, and behavioral parameters (as per boilerplate).
- **Stage Testing Utilities:** Dedicated scripts (`src/stages/*.ts`) allow isolated testing of fetching, scraping, summarization, and emailing, fulfilling a key PRD requirement.
- **Graceful Error Handling (Scraping):** Article scraping failures are logged but do not halt the main pipeline, allowing the process to continue with discussion summaries only, as required. Other errors (API, LLM) are logged.
## Core Workflow / Sequence Diagrams (Simplified)
**(Diagram Suggestion for Canvas: Create a Sequence Diagram showing interactions)**
```mermaid
sequenceDiagram
participant CLI
participant Index as index.ts
participant Config as config.ts
participant Logger as logger.ts
participant OutputDir as Output Dir Setup
participant Algolia as algoliaHNClient.ts
participant Scraper as articleScraper.ts
participant Ollama as ollamaClient.ts
participant Assembler as contentAssembler.ts
participant Templater as templater.ts
participant Sender as emailSender.ts
participant FS as Local Filesystem (./output/YYYY-MM-DD)
CLI->>Index: npm run dev
Index->>Config: Load .env vars
Index->>Logger: Initialize
Index->>OutputDir: Create/Verify Date Dir
Index->>Algolia: fetchTopStories()
Algolia-->>Index: stories[]
loop For Each Story
Index->>Algolia: fetchCommentsForStory(storyId, MAX_COMMENTS)
Algolia-->>Index: comments[]
Index->>FS: Write {storyId}_data.json
alt Has Valid story.url
Index->>Scraper: scrapeArticle(story.url)
Scraper-->>Index: articleContent (string | null)
alt Scrape Success
Index->>FS: Write {storyId}_article.txt
end
end
alt Has articleContent
Index->>Ollama: generateSummary(ARTICLE_PROMPT, articleContent)
Ollama-->>Index: articleSummary (string | null)
end
alt Has comments[]
Index->>Ollama: generateSummary(DISCUSSION_PROMPT, formattedComments)
Ollama-->>Index: discussionSummary (string | null)
end
Index->>FS: Write {storyId}_summary.json
end
Index->>Assembler: assembleDigestData(dateDirPath)
Assembler->>FS: Read _data.json, _summary.json files
Assembler-->>Index: digestData[]
alt digestData is not empty
Index->>Templater: renderDigestHtml(digestData, date)
Templater-->>Index: htmlContent
Index->>Sender: sendDigestEmail(subject, htmlContent)
Sender-->>Index: success (boolean)
end
Index->>Logger: Log final status
```
## Infrastructure and Deployment Overview
- **Cloud Provider(s):** N/A (Local Machine Execution Only for MVP)
- **Core Services Used:** N/A
- **Infrastructure as Code (IaC):** N/A
- **Deployment Strategy:** Manual CLI execution (`npm run dev` for development with `ts-node`, `npm run build && npm start` for running compiled JS). No automated deployment pipeline for MVP.
- **Environments:** Single: Local development machine.
## Key Reference Documents
- docs/prd.md
- docs/epic1-draft.txt, docs/epic2-draft.txt, ... docs/epic5-draft.txt
- docs/tech-stack.md
- docs/project-structure.md
- docs/coding-standards.md
- docs/api-reference.md
- docs/data-models.md
- docs/environment-vars.md
- docs/testing-strategy.md
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ---------------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on PRD & Epics | 3-Architect |

View File

@@ -1,80 +0,0 @@
# BMad Hacker Daily Digest Coding Standards and Patterns
This document outlines the coding standards, design patterns, and best practices to be followed during the development of the BMad Hacker Daily Digest project. Adherence to these standards is crucial for maintainability, readability, and collaboration.
## Architectural / Design Patterns Adopted
- **Sequential Pipeline:** The core application follows a linear sequence of steps (fetch, scrape, summarize, email) orchestrated within `src/core/pipeline.ts`.
- **Modular Design:** The application is broken down into distinct modules based on responsibility (e.g., `clients/`, `scraper/`, `email/`, `utils/`) to promote separation of concerns, testability, and maintainability. See `docs/project-structure.md`.
- **Client Abstraction:** External service interactions (Algolia, Ollama) are encapsulated within dedicated client modules in `src/clients/`.
- **Filesystem Persistence:** Intermediate data is persisted to the local filesystem instead of a database, acting as a handoff between pipeline stages.
## Coding Standards
- **Primary Language:** TypeScript (v5.x, as configured in boilerplate)
- **Primary Runtime:** Node.js (v22.x, as required by PRD )
- **Style Guide & Linter:** ESLint and Prettier. Configuration is provided by the `bmad-boilerplate`.
- **Mandatory:** Run `npm run lint` and `npm run format` regularly and before committing code. Code must be free of lint errors.
- **Naming Conventions:**
- Variables & Functions: `camelCase`
- Classes, Types, Interfaces: `PascalCase`
- Constants: `UPPER_SNAKE_CASE`
- Files: `kebab-case.ts` (e.g., `article-scraper.ts`) or `camelCase.ts` (e.g., `ollamaClient.ts`). Be consistent within module types (e.g., all clients follow one pattern, all utils another). Let's default to `camelCase.ts` for consistency with class/module names where applicable (e.g. `ollamaClient.ts`) and `kebab-case.ts` for more descriptive utils or stage runners (e.g. `Workspace-hn-data.ts`).
- Test Files: `*.test.ts` (e.g., `ollamaClient.test.ts`)
- **File Structure:** Adhere strictly to the layout defined in `docs/project-structure.md`.
- **Asynchronous Operations:** **Mandatory:** Use `async`/`await` for all asynchronous operations (e.g., native `Workspace` HTTP calls , `fs/promises` file operations, Ollama client calls, Nodemailer `sendMail`). Avoid using raw Promises `.then()`/`.catch()` syntax where `async/await` provides better readability.
- **Type Safety:** Leverage TypeScript's static typing. Use interfaces and types defined in `src/types/` where appropriate. Assume `strict` mode is enabled in `tsconfig.json` (from boilerplate). Avoid using `any` unless absolutely necessary and justified.
- **Comments & Documentation:**
- Use JSDoc comments for exported functions, classes, and complex logic.
- Keep comments concise and focused on the _why_, not the _what_, unless the code is particularly complex.
- Update READMEs as needed for setup or usage changes.
- **Dependency Management:**
- Use `npm` for package management.
- Keep production dependencies minimal, as required by the PRD . Justify any additions.
- Use `devDependencies` for testing, linting, and build tools.
## Error Handling Strategy
- **General Approach:** Use standard JavaScript `try...catch` blocks for operations that can fail (I/O, network requests, parsing, etc.). Throw specific `Error` objects with descriptive messages. Avoid catching errors without logging or re-throwing unless intentionally handling a specific case.
- **Logging:**
- **Mandatory:** Use the central logger utility (`src/utils/logger.ts`) for all console output (INFO, WARN, ERROR). Do not use `console.log` directly in application logic.
- **Format:** Basic text format for MVP. Structured JSON logging to files is a post-MVP enhancement.
- **Levels:** Use appropriate levels (`logger.info`, `logger.warn`, `logger.error`).
- **Context:** Include relevant context in log messages (e.g., Story ID, function name, URL being processed) to aid debugging.
- **Specific Handling Patterns:**
- **External API Calls (Algolia, Ollama via `Workspace`):**
- Wrap `Workspace` calls in `try...catch`.
- Check `response.ok` status; if false, log the status code and potentially response body text, then treat as an error (e.g., return `null` or throw).
- Log network errors caught by the `catch` block.
- No automated retries required for MVP.
- **Article Scraping (`articleScraper.ts`):**
- Wrap `Workspace` and text extraction (`article-extractor`) logic in `try...catch`.
- Handle non-2xx responses, timeouts, non-HTML content types, and extraction errors.
- **Crucial:** If scraping fails for any reason, log the error/reason using `logger.warn` or `logger.error`, return `null`, and **allow the main pipeline to continue processing the story** (using only comment summary). Do not throw an error that halts the entire application.
- **File I/O (`fs` module):**
- Wrap `fs` operations (especially writes) in `try...catch`. Log any file system errors using `logger.error`.
- **Email Sending (`Nodemailer`):**
- Wrap `transporter.sendMail()` in `try...catch`. Log success (including message ID) or failure clearly using the logger.
- **Configuration Loading (`config.ts`):**
- Check for the presence of all required environment variables at startup. Throw a fatal error and exit if required variables are missing.
- **LLM Interaction (Ollama Client):**
- **LLM Prompts:** Use the standardized prompts defined in `docs/prompts.md` when interacting with the Ollama client for consistency.
- Wrap `generateSummary` calls in `try...catch`. Log errors from the client (which handles API/network issues).
- **Comment Truncation:** Before sending comments for discussion summary, check for the `MAX_COMMENT_CHARS_FOR_SUMMARY` env var. If set to a positive number, truncate the combined comment text block to this length. Log a warning if truncation occurs. If not set, send the full text.
## Security Best Practices
- **Input Sanitization/Validation:** While primarily a local tool, validate critical inputs like external URLs (`story.articleUrl`) before attempting to fetch them. Basic checks (e.g., starts with `http://` or `https://`) are sufficient for MVP .
- **Secrets Management:**
- **Mandatory:** Store sensitive data (`EMAIL_USER`, `EMAIL_PASS`) only in the `.env` file.
- **Mandatory:** Ensure the `.env` file is included in `.gitignore` and is never committed to version control.
- Do not hardcode secrets anywhere in the source code.
- **Dependency Security:** Periodically run `npm audit` to check for known vulnerabilities in dependencies. Consider enabling Dependabot if using GitHub.
- **HTTP Client:** Use the native `Workspace` API as required ; avoid introducing less secure or overly complex HTTP client libraries.
- **Scraping User-Agent:** Set a default User-Agent header in the scraper code (e.g., "BMadHackerDigest/0.1"). Allow overriding this default via the optional SCRAPER_USER_AGENT environment variable.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | --------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on Arch | 3-Architect |

View File

@@ -1,80 +0,0 @@
# BMad Hacker Daily Digest Coding Standards and Patterns
This document outlines the coding standards, design patterns, and best practices to be followed during the development of the BMad Hacker Daily Digest project. Adherence to these standards is crucial for maintainability, readability, and collaboration.
## Architectural / Design Patterns Adopted
- **Sequential Pipeline:** The core application follows a linear sequence of steps (fetch, scrape, summarize, email) orchestrated within `src/core/pipeline.ts`.
- **Modular Design:** The application is broken down into distinct modules based on responsibility (e.g., `clients/`, `scraper/`, `email/`, `utils/`) to promote separation of concerns, testability, and maintainability. See `docs/project-structure.md`.
- **Client Abstraction:** External service interactions (Algolia, Ollama) are encapsulated within dedicated client modules in `src/clients/`.
- **Filesystem Persistence:** Intermediate data is persisted to the local filesystem instead of a database, acting as a handoff between pipeline stages.
## Coding Standards
- **Primary Language:** TypeScript (v5.x, as configured in boilerplate)
- **Primary Runtime:** Node.js (v22.x, as required by PRD )
- **Style Guide & Linter:** ESLint and Prettier. Configuration is provided by the `bmad-boilerplate`.
- **Mandatory:** Run `npm run lint` and `npm run format` regularly and before committing code. Code must be free of lint errors.
- **Naming Conventions:**
- Variables & Functions: `camelCase`
- Classes, Types, Interfaces: `PascalCase`
- Constants: `UPPER_SNAKE_CASE`
- Files: `kebab-case.ts` (e.g., `article-scraper.ts`) or `camelCase.ts` (e.g., `ollamaClient.ts`). Be consistent within module types (e.g., all clients follow one pattern, all utils another). Let's default to `camelCase.ts` for consistency with class/module names where applicable (e.g. `ollamaClient.ts`) and `kebab-case.ts` for more descriptive utils or stage runners (e.g. `Workspace-hn-data.ts`).
- Test Files: `*.test.ts` (e.g., `ollamaClient.test.ts`)
- **File Structure:** Adhere strictly to the layout defined in `docs/project-structure.md`.
- **Asynchronous Operations:** **Mandatory:** Use `async`/`await` for all asynchronous operations (e.g., native `Workspace` HTTP calls , `fs/promises` file operations, Ollama client calls, Nodemailer `sendMail`). Avoid using raw Promises `.then()`/`.catch()` syntax where `async/await` provides better readability.
- **Type Safety:** Leverage TypeScript's static typing. Use interfaces and types defined in `src/types/` where appropriate. Assume `strict` mode is enabled in `tsconfig.json` (from boilerplate). Avoid using `any` unless absolutely necessary and justified.
- **Comments & Documentation:**
- Use JSDoc comments for exported functions, classes, and complex logic.
- Keep comments concise and focused on the _why_, not the _what_, unless the code is particularly complex.
- Update READMEs as needed for setup or usage changes.
- **Dependency Management:**
- Use `npm` for package management.
- Keep production dependencies minimal, as required by the PRD . Justify any additions.
- Use `devDependencies` for testing, linting, and build tools.
## Error Handling Strategy
- **General Approach:** Use standard JavaScript `try...catch` blocks for operations that can fail (I/O, network requests, parsing, etc.). Throw specific `Error` objects with descriptive messages. Avoid catching errors without logging or re-throwing unless intentionally handling a specific case.
- **Logging:**
- **Mandatory:** Use the central logger utility (`src/utils/logger.ts`) for all console output (INFO, WARN, ERROR). Do not use `console.log` directly in application logic.
- **Format:** Basic text format for MVP. Structured JSON logging to files is a post-MVP enhancement.
- **Levels:** Use appropriate levels (`logger.info`, `logger.warn`, `logger.error`).
- **Context:** Include relevant context in log messages (e.g., Story ID, function name, URL being processed) to aid debugging.
- **Specific Handling Patterns:**
- **External API Calls (Algolia, Ollama via `Workspace`):**
- Wrap `Workspace` calls in `try...catch`.
- Check `response.ok` status; if false, log the status code and potentially response body text, then treat as an error (e.g., return `null` or throw).
- Log network errors caught by the `catch` block.
- No automated retries required for MVP.
- **Article Scraping (`articleScraper.ts`):**
- Wrap `Workspace` and text extraction (`article-extractor`) logic in `try...catch`.
- Handle non-2xx responses, timeouts, non-HTML content types, and extraction errors.
- **Crucial:** If scraping fails for any reason, log the error/reason using `logger.warn` or `logger.error`, return `null`, and **allow the main pipeline to continue processing the story** (using only comment summary). Do not throw an error that halts the entire application.
- **File I/O (`fs` module):**
- Wrap `fs` operations (especially writes) in `try...catch`. Log any file system errors using `logger.error`.
- **Email Sending (`Nodemailer`):**
- Wrap `transporter.sendMail()` in `try...catch`. Log success (including message ID) or failure clearly using the logger.
- **Configuration Loading (`config.ts`):**
- Check for the presence of all required environment variables at startup. Throw a fatal error and exit if required variables are missing.
- **LLM Interaction (Ollama Client):**
- **LLM Prompts:** Use the standardized prompts defined in `docs/prompts.md` when interacting with the Ollama client for consistency.
- Wrap `generateSummary` calls in `try...catch`. Log errors from the client (which handles API/network issues).
- **Comment Truncation:** Before sending comments for discussion summary, check for the `MAX_COMMENT_CHARS_FOR_SUMMARY` env var. If set to a positive number, truncate the combined comment text block to this length. Log a warning if truncation occurs. If not set, send the full text.
## Security Best Practices
- **Input Sanitization/Validation:** While primarily a local tool, validate critical inputs like external URLs (`story.articleUrl`) before attempting to fetch them. Basic checks (e.g., starts with `http://` or `https://`) are sufficient for MVP .
- **Secrets Management:**
- **Mandatory:** Store sensitive data (`EMAIL_USER`, `EMAIL_PASS`) only in the `.env` file.
- **Mandatory:** Ensure the `.env` file is included in `.gitignore` and is never committed to version control.
- Do not hardcode secrets anywhere in the source code.
- **Dependency Security:** Periodically run `npm audit` to check for known vulnerabilities in dependencies. Consider enabling Dependabot if using GitHub.
- **HTTP Client:** Use the native `Workspace` API as required ; avoid introducing less secure or overly complex HTTP client libraries.
- **Scraping User-Agent:** Set a default User-Agent header in the scraper code (e.g., "BMadHackerDigest/0.1"). Allow overriding this default via the optional SCRAPER_USER_AGENT environment variable.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | --------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on Arch | 3-Architect |

View File

@@ -1,614 +0,0 @@
# Epic 1 file
# Epic 1: Project Initialization & Core Setup
**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
## Story List
### Story 1.1: Initialize Project from Boilerplate
- **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
- **Detailed Requirements:**
- Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
- Initialize a git repository in the project root directory (if not already done by cloning).
- Ensure the `.gitignore` file from the boilerplate is present.
- Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
- Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
- **Acceptance Criteria (ACs):**
- AC1: The project directory contains the files and structure from `bmad-boilerplate`.
- AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
- AC3: `npm run lint` command completes successfully without reporting any linting errors.
- AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
- AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
- AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
- AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
---
### Story 1.2: Setup Environment Configuration
- **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
- **Detailed Requirements:**
- Add a production dependency for loading `.env` files (e.g., `dotenv`). Run `npm install dotenv --save-prod` (or similar library).
- Verify the `.env.example` file exists (from boilerplate).
- Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
- Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
- Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
- The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
- Ensure the `.env` file is listed in `.gitignore` and is not committed.
- **Acceptance Criteria (ACs):**
- AC1: The chosen `.env` library (e.g., `dotenv`) is listed under `dependencies` in `package.json` and `package-lock.json` is updated.
- AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
- AC3: The `.env` file exists locally but is NOT tracked by git.
- AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
- AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
---
### Story 1.3: Implement Basic CLI Entry Point & Execution
- **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
- **Detailed Requirements:**
- Create the main application entry point file at `src/index.ts`.
- Implement minimal code within `src/index.ts` to:
- Import the configuration loading mechanism (from Story 1.2).
- Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
- (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
- Confirm execution using boilerplate scripts.
- **Acceptance Criteria (ACs):**
- AC1: The `src/index.ts` file exists.
- AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
- AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
- AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
---
### Story 1.4: Setup Basic Logging and Output Directory
- **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
- **Detailed Requirements:**
- Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
- Refactor `src/index.ts` to use this `logger` for its startup message(s).
- In `src/index.ts` (or a setup function called by it):
- Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
- Determine the current date in 'YYYY-MM-DD' format.
- Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
- Check if the base output directory exists; if not, create it.
- Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
- Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
- **Acceptance Criteria (ACs):**
- AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
- AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
- AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
- AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
- AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
- AC6: The application exits gracefully after performing these setup steps (for now).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 1 | 2-pm |
# Epic 2 File
# Epic 2: HN Data Acquisition & Persistence
**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
## Story List
### Story 2.1: Implement Algolia HN API Client
- **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
- **Detailed Requirements:**
- Create a new module: `src/clients/algoliaHNClient.ts`.
- Implement an async function `WorkspaceTopStories` within the client:
- Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
- Parse the JSON response.
- Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
- Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
- Return an array of structured story objects.
- Implement a separate async function `WorkspaceCommentsForStory` within the client:
- Accept `storyId` and `maxComments` limit as arguments.
- Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
- Parse the JSON response.
- Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
- Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
- Return an array of structured comment objects.
- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
- Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
- **Acceptance Criteria (ACs):**
- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
- AC4: Both functions use the native `Workspace` API internally.
- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
- AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
---
### Story 2.2: Integrate HN Data Fetching into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts` (or a main async function called by it).
- Import the `algoliaHNClient` functions.
- Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
- After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
- Log the number of stories fetched.
- Iterate through the array of fetched `Story` objects.
- For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
- Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
- Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
- AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
- AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
---
### Story 2.3: Persist Fetched HN Data Locally
- **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
- **Detailed Requirements:**
- Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
- Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
- In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
- Get the full path to the date-stamped output directory (determined in Epic 1).
- Construct the filename for the story's data: `{storyId}_data.json`.
- Construct the full file path using `path.join()`.
- Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
- Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
- Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
---
### Story 2.4: Implement Stage Testing Utility for HN Fetching
- **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
- This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
- The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
- The script should log its progress using the logger utility.
- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/fetch_hn_data.ts` exists.
- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 2 | 2-pm |
# Epic 3 File
# Epic 3: Article Scraping & Persistence
**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
## Story List
### Story 3.1: Implement Basic Article Scraper Module
- **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
- **Detailed Requirements:**
- Create a new module: `src/scraper/articleScraper.ts`.
- Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
- Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
- Inside the function:
- Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
- Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
- Check the `response.ok` status. If not okay, log error and return `null`.
- Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
- If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
- Wrap the extraction logic in a `try...catch` to handle library-specific errors.
- Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
- Return `null` if extraction fails or results in empty content.
- Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
- Define TypeScript types/interfaces as needed.
- **Acceptance Criteria (ACs):**
- AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
- AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
- AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
- AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
- AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
- AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
- AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
---
### Story 3.2: Integrate Article Scraping into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
- Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
- Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
- If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
- If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
- Call `await scrapeArticle(story.url)`.
- Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
- Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
- AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
- AC3: For stories with valid URLs, the `scrapeArticle` function is called.
- AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
- AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
---
### Story 3.3: Persist Scraped Article Text Locally
- **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
- **Detailed Requirements:**
- Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
- In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
- Retrieve the full path to the current date-stamped output directory.
- Construct the filename: `{storyId}_article.txt`.
- Construct the full file path using `path.join()`.
- Get the successfully scraped article text string (`articleContent`).
- Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
- Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
- Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
- AC2: The name of each article text file is `{storyId}_article.txt`.
- AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
- AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
- AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
---
### Story 3.4: Implement Stage Testing Utility for Scraping
- **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/scrape_articles.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
- The script should:
- Initialize the logger.
- Load configuration (to get `OUTPUT_DIR_PATH`).
- Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
- Read the directory contents and identify all `{storyId}_data.json` files.
- For each `_data.json` file found:
- Read and parse the JSON content.
- Extract the `storyId` and `url`.
- If a valid `url` exists, call `await scrapeArticle(url)`.
- If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
- Log the progress and outcome (skip/success/fail) for each story processed.
- Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/scrape_articles.ts` exists.
- AC2: The script `stage:scrape` is defined in `package.json`.
- AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
- AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
- AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
- AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
- AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 3 | 2-pm |
# Epic 4 File
# Epic 4: LLM Summarization & Persistence
**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
## Story List
### Story 4.1: Implement Ollama Client Module
- **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
- **Detailed Requirements:**
- **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
- Create a new module: `src/clients/ollamaClient.ts`.
- Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
- Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
- Inside `generateSummary`:
- Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
- Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
- Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
- Handle `Workspace` errors (network, timeout) using `try...catch`.
- Check `response.ok`. If not OK, log the status/error and return `null`.
- Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
- Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
- Return the extracted summary string on success. Return `null` on any failure.
- Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
- Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
- **Acceptance Criteria (ACs):**
- AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
- AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
- AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
- AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
- AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
* AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
* AC7: Logs provide visibility into the client's interaction with the Ollama API.
---
### Story 4.2: Define Summarization Prompts
* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
* **Detailed Requirements:**
* Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
* Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
* **Acceptance Criteria (ACs):**
* AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
---
### Story 4.3: Integrate Summarization into Main Workflow
* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
* **Detailed Requirements:**
* Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
* Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
* Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
* Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
* **Article Summary Generation:**
* Check if the `story` object has non-null `articleContent`.
* If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
* If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
* **Discussion Summary Generation:**
* Check if the `story` object has a non-empty `comments` array.
* If yes:
* Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
* **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
* Log "Attempting discussion summarization for story {storyId}".
* Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
* Store the result (string or null) as `story.discussionSummary`. Log success/failure.
* If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
* **Acceptance Criteria (ACs):**
* AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
* AC2: Article summary is attempted only if `articleContent` exists for a story.
* AC3: Discussion summary is attempted only if `comments` exist for a story.
* AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
* AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
* AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
---
### Story 4.4: Persist Generated Summaries Locally
*(No changes needed for this story based on recent decisions)*
- **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
- **Detailed Requirements:**
- Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
- Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
- In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
- Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
- Get the full path to the date-stamped output directory.
- Construct the filename: `{storyId}_summary.json`.
- Construct the full file path using `path.join()`.
- Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
- Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
- Log the successful saving of the summary file or any file writing errors.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
- AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
- AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
- AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
- AC5: A valid ISO timestamp is present in the `summarizedAt` field.
- AC6: Logs confirm successful writing of each summary file or report file system errors.
---
### Story 4.5: Implement Stage Testing Utility for Summarization
*(Changes needed to reflect prompt sourcing and optional truncation)*
* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
* **Detailed Requirements:**
* Create a new standalone script file: `src/stages/summarize_content.ts`.
* Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
* The script should:
* Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
* Determine target date-stamped directory path.
* Find all `{storyId}_data.json` files in the directory.
* For each `storyId` found:
* Read `{storyId}_data.json` to get comments. Format them into a single text block.
* *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
* Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
* **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
* Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
* Construct the summary result object (with summaries or nulls, and timestamp).
* Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
* Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
* Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
* **Acceptance Criteria (ACs):**
* AC1: The file `src/stages/summarize_content.ts` exists.
* AC2: The script `stage:summarize` is defined in `package.json`.
* AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
* AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
* AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
* AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
* AC8: The script does not call Algolia API or the article scraper module.
## Change Log
| Change | Date | Version | Description | Author |
| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
| Integrate prompts.md refs | 2025-05-04 | 0.3 | Updated stories 4.2, 4.3, 4.5 | 3-Architect |
| Added Ollama Prereq Note | 2025-05-04 | 0.2 | Added note about local Ollama setup | 2-pm |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 4 | 2-pm |
# Epic 5 File
# Epic 5: Digest Assembly & Email Dispatch
**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
## Story List
### Story 5.1: Implement Email Content Assembler
- **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
- **Detailed Requirements:**
- Create a new module: `src/email/contentAssembler.ts`.
- Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
- Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
- The function should:
- Use Node.js `fs` to read the contents of the `dateDirPath`.
- Identify all files matching the pattern `{storyId}_data.json`.
- For each `storyId` found:
- Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
- Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
- Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
- Collect all successfully constructed `DigestData` objects into an array.
- Return the array. It should ideally contain 10 items if all previous stages succeeded.
- Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
- **Acceptance Criteria (ACs):**
- AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
- AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
- AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
- AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
- AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
---
### Story 5.2: Create HTML Email Template & Renderer
- **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
- **Detailed Requirements:**
- Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
- Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
- The function should generate an HTML string with:
- A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
- A loop through the `data` array.
- For each `story` in `data`:
- Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
- Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
- Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
- Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
- Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
- Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
- Return the complete HTML document as a string.
- **Acceptance Criteria (ACs):**
- AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
- AC2: The function returns a single, complete HTML string.
- AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
- AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
- AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
---
### Story 5.3: Implement Nodemailer Email Sender
- **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
- **Detailed Requirements:**
- Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
- Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
- Create a new module: `src/email/emailSender.ts`.
- Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
- Inside the function:
- Load the `EMAIL_*` variables from the config module.
- Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
- Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
- Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
- Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
- Call `await transporter.sendMail(mailOptions)`.
- If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
- If `sendMail` fails (throws error), log the error using the logger. Return `false`.
- **Acceptance Criteria (ACs):**
- AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
- AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
- AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
- AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
- AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
- AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
- AC7: Email sending success (including message ID) or failure is logged clearly.
- AC8: The function returns `true` on successful sending, `false` otherwise.
---
### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
- **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
- Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
- Log "Starting final digest assembly and email dispatch...".
- Determine the path to the current date-stamped output directory.
- Call `const digestData = await assembleDigestData(dateDirPath)`.
- Check if `digestData` array is not empty.
- If yes:
- Get the current date string (e.g., 'YYYY-MM-DD').
- `const htmlContent = renderDigestHtml(digestData, currentDate)`.
- `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
- `const emailSent = await sendDigestEmail(subject, htmlContent)`.
- Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
- If no (`digestData` is empty or assembly failed):
- Log an error: "Failed to assemble digest data or no data found. Skipping email."
- Log "BMad Hacker Daily Digest process finished."
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
- AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
- AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
- AC4: The final success or failure of the email sending step is logged.
- AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
- AC6: The application logs a final completion message.
---
### Story 5.5: Implement Stage Testing Utility for Emailing
- **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
- **Detailed Requirements:**
- Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
- Create a new standalone script file: `src/stages/send_digest.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
- Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
- The script should:
- Initialize logger, load config.
- Determine the target date-stamped directory path (from arg or default). Log the target directory.
- Call `await assembleDigestData(dateDirPath)`.
- If data is assembled and not empty:
- Determine the date string for the subject/title.
- Call `renderDigestHtml(digestData, dateString)` to get HTML.
- Construct the subject string.
- Check the `dryRun` flag:
- If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
- If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
- If data assembly fails or is empty, log the error.
- Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
- AC2: The script `stage:email` is defined in `package.json` allowing arguments.
- AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
- AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
- AC5: The script correctly identifies and acts upon the `--dry-run` flag.
- AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
- AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 5 | 2-pm |
# END EPIC FILES

View File

@@ -1,614 +0,0 @@
# Epic 1 file
# Epic 1: Project Initialization & Core Setup
**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
## Story List
### Story 1.1: Initialize Project from Boilerplate
- **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
- **Detailed Requirements:**
- Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
- Initialize a git repository in the project root directory (if not already done by cloning).
- Ensure the `.gitignore` file from the boilerplate is present.
- Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
- Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
- **Acceptance Criteria (ACs):**
- AC1: The project directory contains the files and structure from `bmad-boilerplate`.
- AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
- AC3: `npm run lint` command completes successfully without reporting any linting errors.
- AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
- AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
- AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
- AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
---
### Story 1.2: Setup Environment Configuration
- **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
- **Detailed Requirements:**
- Add a production dependency for loading `.env` files (e.g., `dotenv`). Run `npm install dotenv --save-prod` (or similar library).
- Verify the `.env.example` file exists (from boilerplate).
- Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
- Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
- Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
- The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
- Ensure the `.env` file is listed in `.gitignore` and is not committed.
- **Acceptance Criteria (ACs):**
- AC1: The chosen `.env` library (e.g., `dotenv`) is listed under `dependencies` in `package.json` and `package-lock.json` is updated.
- AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
- AC3: The `.env` file exists locally but is NOT tracked by git.
- AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
- AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
---
### Story 1.3: Implement Basic CLI Entry Point & Execution
- **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
- **Detailed Requirements:**
- Create the main application entry point file at `src/index.ts`.
- Implement minimal code within `src/index.ts` to:
- Import the configuration loading mechanism (from Story 1.2).
- Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
- (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
- Confirm execution using boilerplate scripts.
- **Acceptance Criteria (ACs):**
- AC1: The `src/index.ts` file exists.
- AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
- AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
- AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
---
### Story 1.4: Setup Basic Logging and Output Directory
- **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
- **Detailed Requirements:**
- Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
- Refactor `src/index.ts` to use this `logger` for its startup message(s).
- In `src/index.ts` (or a setup function called by it):
- Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
- Determine the current date in 'YYYY-MM-DD' format.
- Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
- Check if the base output directory exists; if not, create it.
- Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
- Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
- **Acceptance Criteria (ACs):**
- AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
- AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
- AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
- AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
- AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
- AC6: The application exits gracefully after performing these setup steps (for now).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 1 | 2-pm |
# Epic 2 File
# Epic 2: HN Data Acquisition & Persistence
**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
## Story List
### Story 2.1: Implement Algolia HN API Client
- **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
- **Detailed Requirements:**
- Create a new module: `src/clients/algoliaHNClient.ts`.
- Implement an async function `WorkspaceTopStories` within the client:
- Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
- Parse the JSON response.
- Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
- Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
- Return an array of structured story objects.
- Implement a separate async function `WorkspaceCommentsForStory` within the client:
- Accept `storyId` and `maxComments` limit as arguments.
- Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
- Parse the JSON response.
- Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
- Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
- Return an array of structured comment objects.
- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
- Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
- **Acceptance Criteria (ACs):**
- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
- AC4: Both functions use the native `Workspace` API internally.
- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
- AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
---
### Story 2.2: Integrate HN Data Fetching into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts` (or a main async function called by it).
- Import the `algoliaHNClient` functions.
- Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
- After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
- Log the number of stories fetched.
- Iterate through the array of fetched `Story` objects.
- For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
- Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
- Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
- AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
- AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
---
### Story 2.3: Persist Fetched HN Data Locally
- **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
- **Detailed Requirements:**
- Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
- Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
- In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
- Get the full path to the date-stamped output directory (determined in Epic 1).
- Construct the filename for the story's data: `{storyId}_data.json`.
- Construct the full file path using `path.join()`.
- Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
- Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
- Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
---
### Story 2.4: Implement Stage Testing Utility for HN Fetching
- **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
- This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
- The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
- The script should log its progress using the logger utility.
- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/fetch_hn_data.ts` exists.
- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 2 | 2-pm |
# Epic 3 File
# Epic 3: Article Scraping & Persistence
**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
## Story List
### Story 3.1: Implement Basic Article Scraper Module
- **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
- **Detailed Requirements:**
- Create a new module: `src/scraper/articleScraper.ts`.
- Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
- Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
- Inside the function:
- Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
- Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
- Check the `response.ok` status. If not okay, log error and return `null`.
- Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
- If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
- Wrap the extraction logic in a `try...catch` to handle library-specific errors.
- Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
- Return `null` if extraction fails or results in empty content.
- Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
- Define TypeScript types/interfaces as needed.
- **Acceptance Criteria (ACs):**
- AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
- AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
- AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
- AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
- AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
- AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
- AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
---
### Story 3.2: Integrate Article Scraping into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
- Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
- Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
- If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
- If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
- Call `await scrapeArticle(story.url)`.
- Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
- Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
- AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
- AC3: For stories with valid URLs, the `scrapeArticle` function is called.
- AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
- AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
---
### Story 3.3: Persist Scraped Article Text Locally
- **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
- **Detailed Requirements:**
- Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
- In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
- Retrieve the full path to the current date-stamped output directory.
- Construct the filename: `{storyId}_article.txt`.
- Construct the full file path using `path.join()`.
- Get the successfully scraped article text string (`articleContent`).
- Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
- Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
- Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
- AC2: The name of each article text file is `{storyId}_article.txt`.
- AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
- AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
- AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
---
### Story 3.4: Implement Stage Testing Utility for Scraping
- **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/scrape_articles.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
- The script should:
- Initialize the logger.
- Load configuration (to get `OUTPUT_DIR_PATH`).
- Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
- Read the directory contents and identify all `{storyId}_data.json` files.
- For each `_data.json` file found:
- Read and parse the JSON content.
- Extract the `storyId` and `url`.
- If a valid `url` exists, call `await scrapeArticle(url)`.
- If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
- Log the progress and outcome (skip/success/fail) for each story processed.
- Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/scrape_articles.ts` exists.
- AC2: The script `stage:scrape` is defined in `package.json`.
- AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
- AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
- AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
- AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
- AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 3 | 2-pm |
# Epic 4 File
# Epic 4: LLM Summarization & Persistence
**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
## Story List
### Story 4.1: Implement Ollama Client Module
- **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
- **Detailed Requirements:**
- **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
- Create a new module: `src/clients/ollamaClient.ts`.
- Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
- Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
- Inside `generateSummary`:
- Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
- Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
- Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
- Handle `Workspace` errors (network, timeout) using `try...catch`.
- Check `response.ok`. If not OK, log the status/error and return `null`.
- Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
- Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
- Return the extracted summary string on success. Return `null` on any failure.
- Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
- Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
- **Acceptance Criteria (ACs):**
- AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
- AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
- AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
- AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
- AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
* AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
* AC7: Logs provide visibility into the client's interaction with the Ollama API.
---
### Story 4.2: Define Summarization Prompts
* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
* **Detailed Requirements:**
* Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
* Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
* **Acceptance Criteria (ACs):**
* AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
---
### Story 4.3: Integrate Summarization into Main Workflow
* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
* **Detailed Requirements:**
* Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
* Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
* Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
* Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
* **Article Summary Generation:**
* Check if the `story` object has non-null `articleContent`.
* If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
* If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
* **Discussion Summary Generation:**
* Check if the `story` object has a non-empty `comments` array.
* If yes:
* Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
* **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
* Log "Attempting discussion summarization for story {storyId}".
* Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
* Store the result (string or null) as `story.discussionSummary`. Log success/failure.
* If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
* **Acceptance Criteria (ACs):**
* AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
* AC2: Article summary is attempted only if `articleContent` exists for a story.
* AC3: Discussion summary is attempted only if `comments` exist for a story.
* AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
* AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
* AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
---
### Story 4.4: Persist Generated Summaries Locally
*(No changes needed for this story based on recent decisions)*
- **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
- **Detailed Requirements:**
- Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
- Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
- In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
- Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
- Get the full path to the date-stamped output directory.
- Construct the filename: `{storyId}_summary.json`.
- Construct the full file path using `path.join()`.
- Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
- Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
- Log the successful saving of the summary file or any file writing errors.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
- AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
- AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
- AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
- AC5: A valid ISO timestamp is present in the `summarizedAt` field.
- AC6: Logs confirm successful writing of each summary file or report file system errors.
---
### Story 4.5: Implement Stage Testing Utility for Summarization
*(Changes needed to reflect prompt sourcing and optional truncation)*
* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
* **Detailed Requirements:**
* Create a new standalone script file: `src/stages/summarize_content.ts`.
* Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
* The script should:
* Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
* Determine target date-stamped directory path.
* Find all `{storyId}_data.json` files in the directory.
* For each `storyId` found:
* Read `{storyId}_data.json` to get comments. Format them into a single text block.
* *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
* Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
* **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
* Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
* Construct the summary result object (with summaries or nulls, and timestamp).
* Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
* Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
* Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
* **Acceptance Criteria (ACs):**
* AC1: The file `src/stages/summarize_content.ts` exists.
* AC2: The script `stage:summarize` is defined in `package.json`.
* AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
* AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
* AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
* AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
* AC8: The script does not call Algolia API or the article scraper module.
## Change Log
| Change | Date | Version | Description | Author |
| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
| Integrate prompts.md refs | 2025-05-04 | 0.3 | Updated stories 4.2, 4.3, 4.5 | 3-Architect |
| Added Ollama Prereq Note | 2025-05-04 | 0.2 | Added note about local Ollama setup | 2-pm |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 4 | 2-pm |
# Epic 5 File
# Epic 5: Digest Assembly & Email Dispatch
**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
## Story List
### Story 5.1: Implement Email Content Assembler
- **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
- **Detailed Requirements:**
- Create a new module: `src/email/contentAssembler.ts`.
- Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
- Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
- The function should:
- Use Node.js `fs` to read the contents of the `dateDirPath`.
- Identify all files matching the pattern `{storyId}_data.json`.
- For each `storyId` found:
- Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
- Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
- Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
- Collect all successfully constructed `DigestData` objects into an array.
- Return the array. It should ideally contain 10 items if all previous stages succeeded.
- Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
- **Acceptance Criteria (ACs):**
- AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
- AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
- AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
- AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
- AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
---
### Story 5.2: Create HTML Email Template & Renderer
- **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
- **Detailed Requirements:**
- Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
- Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
- The function should generate an HTML string with:
- A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
- A loop through the `data` array.
- For each `story` in `data`:
- Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
- Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
- Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
- Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
- Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
- Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
- Return the complete HTML document as a string.
- **Acceptance Criteria (ACs):**
- AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
- AC2: The function returns a single, complete HTML string.
- AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
- AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
- AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
---
### Story 5.3: Implement Nodemailer Email Sender
- **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
- **Detailed Requirements:**
- Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
- Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
- Create a new module: `src/email/emailSender.ts`.
- Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
- Inside the function:
- Load the `EMAIL_*` variables from the config module.
- Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
- Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
- Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
- Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
- Call `await transporter.sendMail(mailOptions)`.
- If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
- If `sendMail` fails (throws error), log the error using the logger. Return `false`.
- **Acceptance Criteria (ACs):**
- AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
- AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
- AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
- AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
- AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
- AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
- AC7: Email sending success (including message ID) or failure is logged clearly.
- AC8: The function returns `true` on successful sending, `false` otherwise.
---
### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
- **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
- Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
- Log "Starting final digest assembly and email dispatch...".
- Determine the path to the current date-stamped output directory.
- Call `const digestData = await assembleDigestData(dateDirPath)`.
- Check if `digestData` array is not empty.
- If yes:
- Get the current date string (e.g., 'YYYY-MM-DD').
- `const htmlContent = renderDigestHtml(digestData, currentDate)`.
- `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
- `const emailSent = await sendDigestEmail(subject, htmlContent)`.
- Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
- If no (`digestData` is empty or assembly failed):
- Log an error: "Failed to assemble digest data or no data found. Skipping email."
- Log "BMad Hacker Daily Digest process finished."
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
- AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
- AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
- AC4: The final success or failure of the email sending step is logged.
- AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
- AC6: The application logs a final completion message.
---
### Story 5.5: Implement Stage Testing Utility for Emailing
- **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
- **Detailed Requirements:**
- Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
- Create a new standalone script file: `src/stages/send_digest.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
- Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
- The script should:
- Initialize logger, load config.
- Determine the target date-stamped directory path (from arg or default). Log the target directory.
- Call `await assembleDigestData(dateDirPath)`.
- If data is assembled and not empty:
- Determine the date string for the subject/title.
- Call `renderDigestHtml(digestData, dateString)` to get HTML.
- Construct the subject string.
- Check the `dryRun` flag:
- If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
- If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
- If data assembly fails or is empty, log the error.
- Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
- AC2: The script `stage:email` is defined in `package.json` allowing arguments.
- AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
- AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
- AC5: The script correctly identifies and acts upon the `--dry-run` flag.
- AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
- AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 5 | 2-pm |
# END EPIC FILES

View File

@@ -1,202 +0,0 @@
# BMad Hacker Daily Digest Data Models
This document defines the core data structures used within the application, the format of persisted data files, and relevant API payload schemas. These types would typically reside in `src/types/`.
## 1. Core Application Entities / Domain Objects (In-Memory)
These TypeScript interfaces represent the main data objects manipulated during the pipeline execution.
### `Comment`
- **Description:** Represents a single Hacker News comment fetched from the Algolia API.
- **Schema / Interface Definition (`src/types/hn.ts`):**
```typescript
export interface Comment {
commentId: string; // Unique identifier (from Algolia objectID)
commentText: string | null; // Text content of the comment (nullable from API)
author: string | null; // Author's HN username (nullable from API)
createdAt: string; // ISO 8601 timestamp string of comment creation
}
```
### `Story`
- **Description:** Represents a Hacker News story, initially fetched from Algolia and progressively augmented with comments, scraped content, and summaries during pipeline execution.
- **Schema / Interface Definition (`src/types/hn.ts`):**
```typescript
import { Comment } from "./hn";
export interface Story {
storyId: string; // Unique identifier (from Algolia objectID)
title: string; // Story title
articleUrl: string | null; // URL of the linked article (can be null from API)
hnUrl: string; // URL to the HN discussion page (constructed)
points?: number; // HN points (optional)
numComments?: number; // Number of comments reported by API (optional)
// Data added during pipeline execution
comments: Comment[]; // Fetched comments [Added in Epic 2]
articleContent: string | null; // Scraped article text [Added in Epic 3]
articleSummary: string | null; // Generated article summary [Added in Epic 4]
discussionSummary: string | null; // Generated discussion summary [Added in Epic 4]
fetchedAt: string; // ISO 8601 timestamp when story/comments were fetched [Added in Epic 2]
summarizedAt?: string; // ISO 8601 timestamp when summaries were generated [Added in Epic 4]
}
```
### `DigestData`
- **Description:** Represents the consolidated data needed for a single story when assembling the final email digest. Created by reading persisted files.
- **Schema / Interface Definition (`src/types/email.ts`):**
```typescript
export interface DigestData {
storyId: string;
title: string;
hnUrl: string;
articleUrl: string | null;
articleSummary: string | null;
discussionSummary: string | null;
}
```
## 2. API Payload Schemas
These describe the relevant parts of request/response payloads for external APIs.
### Algolia HN API - Story Response Subset
- **Description:** Relevant fields extracted from the Algolia HN Search API response for front-page stories.
- **Schema (Conceptual JSON):**
```json
{
"hits": [
{
"objectID": "string", // Used as storyId
"title": "string",
"url": "string | null", // Used as articleUrl
"points": "number",
"num_comments": "number"
// ... other fields ignored
}
// ... more hits (stories)
]
// ... other top-level fields ignored
}
```
### Algolia HN API - Comment Response Subset
- **Description:** Relevant fields extracted from the Algolia HN Search API response for comments associated with a story.
- **Schema (Conceptual JSON):**
```json
{
"hits": [
{
"objectID": "string", // Used as commentId
"comment_text": "string | null",
"author": "string | null",
"created_at": "string" // ISO 8601 format
// ... other fields ignored
}
// ... more hits (comments)
]
// ... other top-level fields ignored
}
```
### Ollama `/api/generate` Request
- **Description:** Payload sent to the local Ollama instance to generate a summary.
- **Schema (`src/types/ollama.ts` or inline):**
```typescript
export interface OllamaGenerateRequest {
model: string; // e.g., "llama3" (from config)
prompt: string; // The full prompt including context
stream: false; // Required to be false for single response
// system?: string; // Optional system prompt (if used)
// options?: Record<string, any>; // Optional generation parameters
}
```
### Ollama `/api/generate` Response
- **Description:** Relevant fields expected from the Ollama API response when `stream: false`.
- **Schema (`src/types/ollama.ts` or inline):**
```typescript
export interface OllamaGenerateResponse {
model: string;
created_at: string; // ISO 8601 timestamp
response: string; // The generated summary text
done: boolean; // Should be true if stream=false and generation succeeded
// Optional fields detailing context, timings, etc. are ignored for MVP
// total_duration?: number;
// load_duration?: number;
// prompt_eval_count?: number;
// prompt_eval_duration?: number;
// eval_count?: number;
// eval_duration?: number;
}
```
_(Note: Error responses might have a different structure, e.g., `{ "error": "message" }`)_
## 3. Database Schemas
- **N/A:** This application does not use a database for MVP; data is persisted to the local filesystem.
## 4. State File Schemas (Local Filesystem Persistence)
These describe the format of files saved in the `output/YYYY-MM-DD/` directory.
### `{storyId}_data.json`
- **Purpose:** Stores fetched story metadata and associated comments.
- **Format:** JSON
- **Schema Definition (Matches `Story` type fields relevant at time of saving):**
```json
{
"storyId": "string",
"title": "string",
"articleUrl": "string | null",
"hnUrl": "string",
"points": "number | undefined",
"numComments": "number | undefined",
"fetchedAt": "string", // ISO 8601 timestamp
"comments": [
// Array of Comment objects
{
"commentId": "string",
"commentText": "string | null",
"author": "string | null",
"createdAt": "string" // ISO 8601 timestamp
}
// ... more comments
]
}
```
### `{storyId}_article.txt`
- **Purpose:** Stores the successfully scraped plain text content of the linked article.
- **Format:** Plain Text (`.txt`)
- **Schema Definition:** N/A (Content is the raw extracted string). File only exists if scraping was successful.
### `{storyId}_summary.json`
- **Purpose:** Stores the generated article and discussion summaries.
- **Format:** JSON
- **Schema Definition:**
```json
{
"storyId": "string",
"articleSummary": "string | null", // Null if scraping failed or summarization failed
"discussionSummary": "string | null", // Null if no comments or summarization failed
"summarizedAt": "string" // ISO 8601 timestamp
}
```
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ---------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on Epics | 3-Architect |

View File

@@ -1,202 +0,0 @@
# BMad Hacker Daily Digest Data Models
This document defines the core data structures used within the application, the format of persisted data files, and relevant API payload schemas. These types would typically reside in `src/types/`.
## 1. Core Application Entities / Domain Objects (In-Memory)
These TypeScript interfaces represent the main data objects manipulated during the pipeline execution.
### `Comment`
- **Description:** Represents a single Hacker News comment fetched from the Algolia API.
- **Schema / Interface Definition (`src/types/hn.ts`):**
```typescript
export interface Comment {
commentId: string; // Unique identifier (from Algolia objectID)
commentText: string | null; // Text content of the comment (nullable from API)
author: string | null; // Author's HN username (nullable from API)
createdAt: string; // ISO 8601 timestamp string of comment creation
}
```
### `Story`
- **Description:** Represents a Hacker News story, initially fetched from Algolia and progressively augmented with comments, scraped content, and summaries during pipeline execution.
- **Schema / Interface Definition (`src/types/hn.ts`):**
```typescript
import { Comment } from "./hn";
export interface Story {
storyId: string; // Unique identifier (from Algolia objectID)
title: string; // Story title
articleUrl: string | null; // URL of the linked article (can be null from API)
hnUrl: string; // URL to the HN discussion page (constructed)
points?: number; // HN points (optional)
numComments?: number; // Number of comments reported by API (optional)
// Data added during pipeline execution
comments: Comment[]; // Fetched comments [Added in Epic 2]
articleContent: string | null; // Scraped article text [Added in Epic 3]
articleSummary: string | null; // Generated article summary [Added in Epic 4]
discussionSummary: string | null; // Generated discussion summary [Added in Epic 4]
fetchedAt: string; // ISO 8601 timestamp when story/comments were fetched [Added in Epic 2]
summarizedAt?: string; // ISO 8601 timestamp when summaries were generated [Added in Epic 4]
}
```
### `DigestData`
- **Description:** Represents the consolidated data needed for a single story when assembling the final email digest. Created by reading persisted files.
- **Schema / Interface Definition (`src/types/email.ts`):**
```typescript
export interface DigestData {
storyId: string;
title: string;
hnUrl: string;
articleUrl: string | null;
articleSummary: string | null;
discussionSummary: string | null;
}
```
## 2. API Payload Schemas
These describe the relevant parts of request/response payloads for external APIs.
### Algolia HN API - Story Response Subset
- **Description:** Relevant fields extracted from the Algolia HN Search API response for front-page stories.
- **Schema (Conceptual JSON):**
```json
{
"hits": [
{
"objectID": "string", // Used as storyId
"title": "string",
"url": "string | null", // Used as articleUrl
"points": "number",
"num_comments": "number"
// ... other fields ignored
}
// ... more hits (stories)
]
// ... other top-level fields ignored
}
```
### Algolia HN API - Comment Response Subset
- **Description:** Relevant fields extracted from the Algolia HN Search API response for comments associated with a story.
- **Schema (Conceptual JSON):**
```json
{
"hits": [
{
"objectID": "string", // Used as commentId
"comment_text": "string | null",
"author": "string | null",
"created_at": "string" // ISO 8601 format
// ... other fields ignored
}
// ... more hits (comments)
]
// ... other top-level fields ignored
}
```
### Ollama `/api/generate` Request
- **Description:** Payload sent to the local Ollama instance to generate a summary.
- **Schema (`src/types/ollama.ts` or inline):**
```typescript
export interface OllamaGenerateRequest {
model: string; // e.g., "llama3" (from config)
prompt: string; // The full prompt including context
stream: false; // Required to be false for single response
// system?: string; // Optional system prompt (if used)
// options?: Record<string, any>; // Optional generation parameters
}
```
### Ollama `/api/generate` Response
- **Description:** Relevant fields expected from the Ollama API response when `stream: false`.
- **Schema (`src/types/ollama.ts` or inline):**
```typescript
export interface OllamaGenerateResponse {
model: string;
created_at: string; // ISO 8601 timestamp
response: string; // The generated summary text
done: boolean; // Should be true if stream=false and generation succeeded
// Optional fields detailing context, timings, etc. are ignored for MVP
// total_duration?: number;
// load_duration?: number;
// prompt_eval_count?: number;
// prompt_eval_duration?: number;
// eval_count?: number;
// eval_duration?: number;
}
```
_(Note: Error responses might have a different structure, e.g., `{ "error": "message" }`)_
## 3. Database Schemas
- **N/A:** This application does not use a database for MVP; data is persisted to the local filesystem.
## 4. State File Schemas (Local Filesystem Persistence)
These describe the format of files saved in the `output/YYYY-MM-DD/` directory.
### `{storyId}_data.json`
- **Purpose:** Stores fetched story metadata and associated comments.
- **Format:** JSON
- **Schema Definition (Matches `Story` type fields relevant at time of saving):**
```json
{
"storyId": "string",
"title": "string",
"articleUrl": "string | null",
"hnUrl": "string",
"points": "number | undefined",
"numComments": "number | undefined",
"fetchedAt": "string", // ISO 8601 timestamp
"comments": [
// Array of Comment objects
{
"commentId": "string",
"commentText": "string | null",
"author": "string | null",
"createdAt": "string" // ISO 8601 timestamp
}
// ... more comments
]
}
```
### `{storyId}_article.txt`
- **Purpose:** Stores the successfully scraped plain text content of the linked article.
- **Format:** Plain Text (`.txt`)
- **Schema Definition:** N/A (Content is the raw extracted string). File only exists if scraping was successful.
### `{storyId}_summary.json`
- **Purpose:** Stores the generated article and discussion summaries.
- **Format:** JSON
- **Schema Definition:**
```json
{
"storyId": "string",
"articleSummary": "string | null", // Null if scraping failed or summarization failed
"discussionSummary": "string | null", // Null if no comments or summarization failed
"summarizedAt": "string" // ISO 8601 timestamp
}
```
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ---------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial draft based on Epics | 3-Architect |

View File

@@ -1,158 +0,0 @@
# Demonstration of the Full BMad Workflow Agent Gem Usage
**Welcome to the complete end-to-end walkthrough of the BMad Method V2!** This demonstration showcases the power of AI-assisted software development using a phased agent approach. You'll see how each specialized agent (BA, PM, Architect, PO/SM) contributes to the project lifecycle - from initial concept to implementation-ready plans.
Each section includes links to **full Gemini interaction transcripts**, allowing you to witness the remarkable collaborative process between human and AI. The demo folder contains all output artifacts that flow between agents, creating a cohesive development pipeline.
What makes this V2 methodology exceptional is how the agents work in **interactive phases**, pausing at key decision points for your input rather than dumping massive documents at once. This creates a truly collaborative experience where you shape the outcome while the AI handles the heavy lifting.
Follow along from concept to code-ready project plan and see how this workflow transforms software development!
## BA Brainstorming
The following link shows the full chat thread with the BA demonstrating many features of this amazing agent. I started out not even knowing what to build, and it helped me ideate with the goal of something interesting for tutorial purposes, refine it, do some deep research (in thinking mode, I did not switch models), gave some great alternative details and ideas, prompted me section by section eventually to produce the brief. It worked amazingly well. You can read the full transcript and output here:
https://gemini.google.com/share/fec063449737
## PM Brainstorming (Oops it was not the PM LOL)
I took the final output md brief with prompt for the PM at the end of the last chat and created a google doc to make it easier to share with the PM (I could have probably just pasted it into the new chat, but it's easier if I want to start over). In Google Docs it's so easy to just create a new doc, right click and select 'Paste from Markdown', then click in the title and it will automatically name and save it with the title of the document. I then started a chat with the 2-PM Gem, also in Gemini 2.5 Pro thinking mode by attaching the Google doc and telling it to reference the prompt. This is the transcript. I realized that I accidentally had pasted the BA prompt also into the PM prompt, so this actually ended up producing a pretty nicely refined brief 2.0 instead LOL
https://g.co/gemini/share/3e09f04138f2
So I took that output file and put it into the actual BA again to produce a new version with prompt as seen in [this file](final-brief-with-pm-prompt.txt) ([md version](final-brief-with-pm-prompt.md)).
## PM Brainstorming Take 2
I will be going forward with the rest of the process not use Google Docs even though it's preferred and instead attach txt attachments of previous phase documents, this is required or else the link will be un-sharable.
Of note here is how I am not passive in this process and you should not be either - I looked at its proposed epics in its first PRD draft after answering the initial questions and spotting something really dumb, it had a final epic for doing file output and logging all the way at the end - when really this should be happening incrementally with each epic. The Architect or PO I hope would have caught this later and the PM might also if I let it get to the checklist phase, but if you can work with it you will have quicker results and better outcomes.
Also notice, since we came to the PM with the amazing brief + prompt embedded in it - it only had like 1 question before producing the first draft - amazing!!!
The PM did a great job of asking the right questions, and producing the [Draft PRD](prd.txt) ([md version](prd.md)), and each epic, [1](epic1.txt) ([md version](epic1.md)), [2](epic2.txt) ([md version](epic2.md)), [3](epic3.txt) ([md version](epic3.md)), [4](epic4.txt) ([md version](epic4.md)), [5](epic5.txt) ([md version](epic5.md)).
The beauty of these new V2 Agents is they pause for you to answer questions or review the document generation section by section - this is so much better than receiving a massive document dump all at once and trying to take it all in. in between each piece you can ask questions or ask for changes - so easy - so powerful!
After the drafts were done, it then ran the checklist - which is the other big game changer feature of the V2 BMAD Method. Waiting for the output final decision from the checklist run can be exciting haha!
Getting that final PRD & EPIC VALIDATION SUMMARY and seeing it all passing is a great feeling.
[Here is the full chat summary](https://g.co/gemini/share/abbdff18316b).
## Architect (Terrible Architect - already fired and replaced in take 2)
I gave the architect the drafted PRD and epics. I call them all still drafts because the architect or PO could still have some findings or updates - but hopefully not for this very simple project.
I started off the fun with the architect by saying 'the prompt to respond to is in the PRD at the end in a section called 'Initial Architect Prompt' and we are in architecture creation mode - all PRD and epics planned by the PM are attached'
NOTE - The architect just plows through and produces everything at once and runs the checklist - need to improve the gem and agent to be more workflow focused in a future update! Here is the [initial crap it produced](botched-architecture.md) - don't worry I fixed it, it's much better in take 2!
There is one thing that is a pain with both Gemini and ChatGPT - output of markdown with internal markdown or mermaid sections screws up the output formatting where it thinks the start of inner markdown is the end to its total output block - this is because the reality is everything you are seeing in response from the LLM is already markdown, just being rendered by the UI! So the fix is simple - I told it "Since you already default respond in markdown - can you not use markdown blocks and just give the document as standard chat output" - this worked perfect, and nested markdown was properly still wrapped!
I updated the agent at this point to fix this output formatting for all gems and adjusted the architect to progress document by document prompting in between to get clarifications, suggest tradeoffs or what it put in place, etc., and then confirm with me if I like all the draft docs we got 1 by 1 and then confirm I am ready for it to run the checklist assessment. Improved usage of this is shown in the next section Architect Take 2 next.
If you want to see my annoying chat with this lame architect gem that is now much better - [here you go](https://g.co/gemini/share/0a029a45d70b).
{I corrected the interaction model and added YOLO mode to the architect, and tried a fresh start with the improved gem in take 2.}
## Architect Take 2 (Our amazing new architect)
Same initial prompt as before but with the new and improved architect! I submitted that first prompt again and waited in anticipation to see if it would go insane again.
So far success - it confirmed it was not to go all YOLO on me!
Our new architect is SO much better, and also fun '(Pirate voice) Aye, yargs be a fine choice, matey!' - firing the previous architect was a great decision!
It gave us our [tech stack](tech-stack.txt) ([md version](tech-stack.md)) - the tech-stack looks great, it did not produce wishy-washy ambiguous selections like the previous architect would!
I did mention we should call out the specific decisions to not use axios and dotenv so the LLM would not try to use it later. Also I suggested adding Winston and it helped me know it had a better simpler idea for MVP for file logging! Such a great helper now! I really hope I never see that old V1 architect again, I don't think he was at all qualified to even mop the floors.
When I got the [project structure document](project-structure.txt) ([md version](project-structure.md)), I was blown away - you will see in the chat transcript how it was formatted - I was able to copy the whole response put it in an md file and no more issues with sub sections, just removed the text basically saying here is your file! Once confirmed it was md, I changed it to txt for pass off later potentially to the PO.
Here are the remaining docs it did with me one at a time before running the checklist:
- [Architecture](architecture.txt) ([md version](architecture.md)) - the 'Core Workflow / Sequence Diagram (Main Pipeline)' diagram was impressive - one other diagram had a mermaid bugs - I updated the agent and fixed the bugs, these should hopefully not occur again - it was the most common LLM mermaid bug I have gotten across models
- [Data Models](data-models.txt) ([md version](data-models.md)) - another complex file easy to just get the end of message ... copy the response and paste into markdown, perfect result!
- [API Reference](api-reference.txt) ([md version](api-reference.md))
- [Env Vars](environment-vars.txt) ([md version](environment-vars.md))
- [Coding Standards](coding-standards.txt) ([md version](coding-standards.md))
- [Testing Strategy](testing-strategy.txt) ([md version](testing-strategy.md)) - It really nailed this one, even having me ensure it captured by concerns about testing each epic with scripts incrementally - which I did confirm was awesome!
It then confirmed it was done with all the artifacts and ready to assess with its checklist! Here are the results: 5 minor points and great questions - some I answered, one I didn't understand and it explained it to me in detail!
I made the updates, and it also proposed a new file for this project specifically! [Prompts](prompts.txt) ([md version](prompts.md)) - I did have it take the output from that to ensure its referenced where needed including epic 4 and coding standards, it helped me regenerate epic 4 with the changes.
We were done, I told it great job, the output it gave me next was perfect showing the complete function of the multiphased agent! Here is a snippet!
```text
Next Steps:
The project can now move into the implementation phase, using these architecture documents as the blueprint. Development agents can be tasked with implementing the stories within each Epic, following the defined structure, standards, and testing strategy.
As the 3-Architect, I can switch to Mode 3: Master Architect Advisory if you need further assistance during development, such as:
Explaining architectural concepts.
Advising on implementation challenges.
Evaluating potential changes or enhancements.
Helping manage technical debt.
```
Here is the [full massive architecture discussion link](https://g.co/gemini/share/4fedc292e068)!
## PO-SM
This mode is WILD in Gemini 2.5 Pro with its massive 1 million context window - holy crap! It was able to analyze every artifact together - since there is a 10 document attach limit I created a [Combined Artifacts](combined-artifacts-for-posm.txt) ([md version](combined-artifacts-for-posm.md)) which adds all 5 epic files in it.
There was a ton of output running through the checklist - but the amazing part is it considered it all and output this (in better formatted markdown I didn't capture here well). TL;DR of the following - it caught two great finds! It called out that story 1.2 still calls for dotenv which we are not going to use after working with the architect, and also it is looking for a prompts.md that is called out - but I forgot to attach it, so it caught that! So I corrected story 1.2 and we are ready to proceed with development!
VALIDATION SUMMARY
Category Statuses
Category Status Critical Issues
1. Project Setup & Initialization PASS
2. Infrastructure & Deployment Sequencing PASS
3. External Dependencies & Integrations PASS
4. User/Agent Responsibility Delineation PASS
5. Feature Sequencing & Dependencies PASS
6. MVP Scope Alignment PASS
7. Risk Management & Practicality PASS
8. Documentation & Handoff PASS
9. Post-MVP Considerations PASS
OVERALL PASS No critical deficiencies identified.
Export to Sheets
Critical Deficiencies
None identified.
Recommendations
While not critical, Story 1.2 could explicitly state npm install {dotenv library} rather than just referencing the library name, for absolute clarity, although the plan specifies native Node.js .env support which negates the need for a library [111, 549]. Correction: The plan correctly states native support is used and no external package is needed [549], removing this minor concern. The reference to installing dotenv in Story 1.2 [111-112] seems contradictory to the environment-vars.txt [549] and tech-stack.txt [867] which state native support is used and dotenv is not needed. This should be clarified/corrected in Story 1.2. Update: Reviewing Story 1.2 [111], it does explicitly require installing dotenv, which contradicts ENV [549], ARCH [72], TS [867], and PRD [752] (which implies native support via .env.example). This inconsistency needs resolution. Decision: Assuming ENV, ARCH, TS, PRD are correct and Story 1.2 requirement for dotenv package is an error. Will proceed assuming NO dotenv package required.
Consider adding a docs/prompts.md file explicitly, as referenced in ARCH [89] and E4 Story 4.2 [321], even if prompts are simple initially. Update: E4 Story 4.2 [321-325] does require creating docs/prompts.md and referencing it. This seems sufficient.
Final Decision
APPROVED: The plan is comprehensive, meticulously detailed across PRD, Architecture, Epics, and supporting documents. The sequencing is logical, dependencies are managed, risks acknowledged, and the scope aligns tightly with MVP goals. The technical constraints are respected, and the use of stage testing utilities significantly enhances testability and validation. The identified inconsistency regarding the dotenv package is noted but assumed resolved in favour of native Node.js support based on multiple other document references. The plan is ready for implementation.
Transitioning to SM Mode can proceed upon user confirmation or if auto-proceeding.
(full chat link in the next section)
## PO-SM Story Generation
This is only for demonstration as I do not like to work this way, at this point I want to be into the project - but for fun and testing, I wanted to verify the gem can produce quality stories, potentially multiple at once in case someone were wanting to use this more like taskmaster.
The output looks decent, I still prefer doing this in the IDE with Sonnet 3.5/3.7 though 1 story at a time with the SM, then use the Dev. Mainly because it's still possible you might want to change something story to story - but this is just a preference, and this method of generating all the stories at once might work well for you - experiment and let me know what you find!
- [Story Drafts Epic 1](epic-1-stories-demo.md)
- [Story Drafts Epic 2](epic-2-stories-demo.md)
- [Story Drafts Epic 3](epic-3-stories-demo.md)
etc...
Here is the full [4-POSM chat record](https://g.co/gemini/share/9ab02d1baa18).
Ill post the link to the video and final project here if you want to see the final results of the app build - but I am beyond extatic at how well this planning workflow is now tuned with V2.
Thanks if you read this far.
- BMad

View File

@@ -1,43 +0,0 @@
# BMad Hacker Daily Digest Environment Variables
## Configuration Loading Mechanism
Environment variables for this project are managed using a standard `.env` file in the project root. The application leverages the native support for `.env` files built into Node.js (v20.6.0 and later) , meaning **no external `dotenv` package is required**.
Variables defined in the `.env` file are automatically loaded into `process.env` when the Node.js application starts. Accessing and potentially validating these variables should be centralized, ideally within the `src/utils/config.ts` module .
## Required Variables
The following table lists the environment variables used by the application. An `.env.example` file should be maintained in the repository with these variables set to placeholder or default values .
| Variable Name | Description | Example / Default Value | Required? | Sensitive? | Source |
| :------------------------------ | :---------------------------------------------------------------- | :--------------------------------------- | :-------- | :--------- | :------------ |
| `OUTPUT_DIR_PATH` | Filesystem path for storing output data artifacts | `./output` | Yes | No | Epic 1 |
| `MAX_COMMENTS_PER_STORY` | Maximum number of comments to fetch per HN story | `50` | Yes | No | PRD |
| `OLLAMA_ENDPOINT_URL` | Base URL for the local Ollama API instance | `http://localhost:11434` | Yes | No | Epic 4 |
| `OLLAMA_MODEL` | Name of the Ollama model to use for summarization | `llama3` | Yes | No | Epic 4 |
| `EMAIL_HOST` | SMTP server hostname for sending email | `smtp.example.com` | Yes | No | Epic 5 |
| `EMAIL_PORT` | SMTP server port | `587` | Yes | No | Epic 5 |
| `EMAIL_SECURE` | Use TLS/SSL (`true` for port 465, `false` for 587/STARTTLS) | `false` | Yes | No | Epic 5 |
| `EMAIL_USER` | Username for SMTP authentication | `user@example.com` | Yes | **Yes** | Epic 5 |
| `EMAIL_PASS` | Password for SMTP authentication | `your_smtp_password` | Yes | **Yes** | Epic 5 |
| `EMAIL_FROM` | Sender email address (may need specific format) | `"BMad Digest <digest@example.com>"` | Yes | No | Epic 5 |
| `EMAIL_RECIPIENTS` | Comma-separated list of recipient email addresses | `recipient1@example.com,r2@test.org` | Yes | No | Epic 5 |
| `NODE_ENV` | Runtime environment (influences some library behavior) | `development` | No | No | Standard Node |
| `SCRAPE_TIMEOUT_MS` | _Optional:_ Timeout in milliseconds for article scraping requests | `15000` (15s) | No | No | Good Practice |
| `OLLAMA_TIMEOUT_MS` | _Optional:_ Timeout in milliseconds for Ollama API requests | `120000` (2min) | No | No | Good Practice |
| `LOG_LEVEL` | _Optional:_ Control log verbosity (e.g., debug, info) | `info` | No | No | Good Practice |
| `MAX_COMMENT_CHARS_FOR_SUMMARY` | _Optional:_ Max chars of combined comments sent to LLM | 10000 / null (uses all if not set) | No | No | Arch Decision |
| `SCRAPER_USER_AGENT` | _Optional:_ Custom User-Agent header for scraping requests | "BMadHackerDigest/0.1" (Default in code) | No | No | Arch Decision |
## Notes
- **Secrets Management:** Sensitive variables (`EMAIL_USER`, `EMAIL_PASS`) must **never** be committed to version control. The `.env` file should be included in `.gitignore` (as per boilerplate ).
- **`.env.example`:** Maintain an `.env.example` file in the repository mirroring the variables above, using placeholders or default values for documentation and local setup .
- **Validation:** It is recommended to implement validation logic in `src/utils/config.ts` to ensure required variables are present and potentially check their format on application startup .
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Draft based on PRD/Epics requirements | 3-Architect |

View File

@@ -1,43 +0,0 @@
# BMad Hacker Daily Digest Environment Variables
## Configuration Loading Mechanism
Environment variables for this project are managed using a standard `.env` file in the project root. The application leverages the native support for `.env` files built into Node.js (v20.6.0 and later) , meaning **no external `dotenv` package is required**.
Variables defined in the `.env` file are automatically loaded into `process.env` when the Node.js application starts. Accessing and potentially validating these variables should be centralized, ideally within the `src/utils/config.ts` module .
## Required Variables
The following table lists the environment variables used by the application. An `.env.example` file should be maintained in the repository with these variables set to placeholder or default values .
| Variable Name | Description | Example / Default Value | Required? | Sensitive? | Source |
| :------------------------------ | :---------------------------------------------------------------- | :--------------------------------------- | :-------- | :--------- | :------------ |
| `OUTPUT_DIR_PATH` | Filesystem path for storing output data artifacts | `./output` | Yes | No | Epic 1 |
| `MAX_COMMENTS_PER_STORY` | Maximum number of comments to fetch per HN story | `50` | Yes | No | PRD |
| `OLLAMA_ENDPOINT_URL` | Base URL for the local Ollama API instance | `http://localhost:11434` | Yes | No | Epic 4 |
| `OLLAMA_MODEL` | Name of the Ollama model to use for summarization | `llama3` | Yes | No | Epic 4 |
| `EMAIL_HOST` | SMTP server hostname for sending email | `smtp.example.com` | Yes | No | Epic 5 |
| `EMAIL_PORT` | SMTP server port | `587` | Yes | No | Epic 5 |
| `EMAIL_SECURE` | Use TLS/SSL (`true` for port 465, `false` for 587/STARTTLS) | `false` | Yes | No | Epic 5 |
| `EMAIL_USER` | Username for SMTP authentication | `user@example.com` | Yes | **Yes** | Epic 5 |
| `EMAIL_PASS` | Password for SMTP authentication | `your_smtp_password` | Yes | **Yes** | Epic 5 |
| `EMAIL_FROM` | Sender email address (may need specific format) | `"BMad Digest <digest@example.com>"` | Yes | No | Epic 5 |
| `EMAIL_RECIPIENTS` | Comma-separated list of recipient email addresses | `recipient1@example.com,r2@test.org` | Yes | No | Epic 5 |
| `NODE_ENV` | Runtime environment (influences some library behavior) | `development` | No | No | Standard Node |
| `SCRAPE_TIMEOUT_MS` | _Optional:_ Timeout in milliseconds for article scraping requests | `15000` (15s) | No | No | Good Practice |
| `OLLAMA_TIMEOUT_MS` | _Optional:_ Timeout in milliseconds for Ollama API requests | `120000` (2min) | No | No | Good Practice |
| `LOG_LEVEL` | _Optional:_ Control log verbosity (e.g., debug, info) | `info` | No | No | Good Practice |
| `MAX_COMMENT_CHARS_FOR_SUMMARY` | _Optional:_ Max chars of combined comments sent to LLM | 10000 / null (uses all if not set) | No | No | Arch Decision |
| `SCRAPER_USER_AGENT` | _Optional:_ Custom User-Agent header for scraping requests | "BMadHackerDigest/0.1" (Default in code) | No | No | Arch Decision |
## Notes
- **Secrets Management:** Sensitive variables (`EMAIL_USER`, `EMAIL_PASS`) must **never** be committed to version control. The `.env` file should be included in `.gitignore` (as per boilerplate ).
- **`.env.example`:** Maintain an `.env.example` file in the repository mirroring the variables above, using placeholders or default values for documentation and local setup .
- **Validation:** It is recommended to implement validation logic in `src/utils/config.ts` to ensure required variables are present and potentially check their format on application startup .
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Draft based on PRD/Epics requirements | 3-Architect |

View File

@@ -1,391 +0,0 @@
Okay, transitioning to **SM Mode**.
I will now generate the stories for **Epic 1: Project Initialization & Core Setup**, as requested for demonstration purposes.
I will use the details from Epic 1 in `combined-artifacts-for-posm.txt`, the `story-template.txt`, and extract relevant technical context from the supporting documents (`architecture.txt`, `project-structure.txt`, `tech-stack.txt`, `environment-vars.txt`, `testing-strategy.txt`).
**Note:** As identified during PO Mode validation, Story 1.2 contained a requirement to install the `dotenv` package [111-112], which contradicts multiple other documents stating native Node.js support is used and the package is unnecessary (`ENV` [549], `ARCH` [72], `TS` [867], `PRD` [752]). The following story for 1.2 has been generated based on the **correction** that the `dotenv` package is **not required** and native Node.js functionality should be used.
Here is the report containing the generated stories for Epic 1:
---
## **Stories Report: Epic 1**
**File: ai/stories/1.1.story.md**
```markdown
# Story 1.1: Initialize Project from Boilerplate
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place. [96]
**Context:** This is the foundational story for the entire project. It establishes the core development environment, tooling, and standard scripts based on the `bmad-boilerplate` template, as required by the PRD [706, 713, 784] and Architecture [43]. All subsequent development relies on the successful completion of this setup.
## Detailed Requirements
- Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory. [97]
- Initialize a git repository in the project root directory (if not already done by cloning). [98]
- Ensure the `.gitignore` file from the boilerplate is present. [99]
- Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`. [100]
- Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase. [101]
## Acceptance Criteria (ACs)
- AC1: The project directory contains the files and structure from `bmad-boilerplate`. [102]
- AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`. [103]
- AC3: `npm run lint` command completes successfully without reporting any linting errors. [104]
- AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. [105] Running it a second time should result in no changes. [106]
- AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage). [107]
- AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output. [108]
- AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate. [109, 632]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create/Copy: All files from `bmad-boilerplate` (e.g., `package.json`, `tsconfig.json`, `.eslintrc.js`, `.prettierrc.js`, `.gitignore`, initial `src/` structure if any).
- Files to Modify: None initially, verification via script execution.
- _(Hint: See `docs/project-structure.md` [813-825] for the target overall layout derived from the boilerplate)._
- **Key Technologies:**
- Node.js 22.x [851], npm [100], Git [98], TypeScript [846], Jest [889], ESLint [893], Prettier [896].
- _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
- **API Interactions / SDK Usage:**
- N/A for this story.
- **Data Structures:**
- N/A for this story.
- **Environment Variables:**
- N/A directly used, but `.gitignore` [109] should cover `.env`. Boilerplate includes `.env.example` [112].
- _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
- **Coding Standards Notes:**
- Ensure boilerplate scripts (`lint`, `format`) run successfully. [101]
- Adhere to ESLint/Prettier rules defined in the boilerplate. [746]
## Tasks / Subtasks
- [ ] Obtain the `bmad-boilerplate` content (clone or copy).
- [ ] Place boilerplate content into the project's root directory.
- [ ] Initialize git repository (`git init`).
- [ ] Verify `.gitignore` exists and is correctly sourced from boilerplate.
- [ ] Run `npm install` to install dependencies.
- [ ] Execute `npm run lint` and verify successful completion without errors.
- [ ] Execute `npm run format` and verify successful completion. Run again to confirm no further changes.
- [ ] Execute `npm run test` and verify successful execution (no tests found is OK).
- [ ] Execute `npm run build` and verify `dist/` directory creation and successful completion.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** N/A for this story (focus is project setup). [915]
- **Integration Tests:** N/A for this story. [921]
- **Manual/CLI Verification:**
- Verify file structure matches boilerplate (AC1).
- Check for `node_modules/` directory (AC2).
- Run `npm run lint` (AC3).
- Run `npm run format` twice (AC4).
- Run `npm run test` (AC5).
- Run `npm run build`, check for `dist/` (AC6).
- Inspect `.gitignore` contents (AC7).
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/1.2.story.md**
```markdown
# Story 1.2: Setup Environment Configuration
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions and utilizing native Node.js support. [110, 549]
**Context:** This story builds on the initialized project (Story 1.1). It sets up the critical mechanism for managing configuration parameters like API keys and file paths using standard `.env` files, which is essential for security and flexibility. It leverages Node.js's built-in `.env` file loading [549, 867], meaning **no external package installation is required**. This corrects the original requirement [111-112] based on `docs/environment-vars.md` [549] and `docs/tech-stack.md` [867].
## Detailed Requirements
- Verify the `.env.example` file exists (from boilerplate). [112]
- Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`. [113]
- Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default). [114]
- Implement a utility module (e.g., `src/utils/config.ts`) that reads environment variables **directly from `process.env`** (populated natively by Node.js from the `.env` file at startup). [115, 550]
- The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`). [116] It is recommended to include basic validation (e.g., checking if required variables are present). [634]
- Ensure the `.env` file is listed in `.gitignore` and is not committed. [117, 632]
## Acceptance Criteria (ACs)
- AC1: **(Removed)** The chosen `.env` library... is listed under `dependencies`. (Package not needed [549]).
- AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`. [119]
- AC3: The `.env` file exists locally but is NOT tracked by git. [120]
- AC4: A configuration module (`src/utils/config.ts` or similar) exists and successfully reads the `OUTPUT_DIR_PATH` value **from `process.env`** when the application starts. [121]
- AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code via the config module. [122]
- AC6: The `.env` file is listed in the `.gitignore` file. [117]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/utils/config.ts`.
- Files to Modify: `.env.example`, `.gitignore` (verify inclusion of `.env`). Create local `.env`.
- _(Hint: See `docs/project-structure.md` [822] for utils location)._
- **Key Technologies:**
- Node.js 22.x (Native `.env` support >=20.6) [549, 851]. TypeScript [846].
- **No `dotenv` package required.** [549, 867]
- _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
- **API Interactions / SDK Usage:**
- N/A for this story.
- **Data Structures:**
- Potentially an interface for the exported configuration object in `config.ts`.
- _(Hint: See `docs/data-models.md` [498-547] for key project data structures)._
- **Environment Variables:**
- Reads `OUTPUT_DIR_PATH` from `process.env`. [116]
- Defines `OUTPUT_DIR_PATH` in `.env.example`. [113]
- _(Hint: See `docs/environment-vars.md` [559] for this variable)._
- **Coding Standards Notes:**
- `config.ts` should export configuration values clearly.
- Consider adding validation logic in `config.ts` to check for the presence of required environment variables on startup. [634]
## Tasks / Subtasks
- [ ] Verify `bmad-boilerplate` provided `.env.example`.
- [ ] Add `OUTPUT_DIR_PATH=./output` to `.env.example`.
- [ ] Create `.env` file by copying `.env.example`.
- [ ] Verify `.env` is included in `.gitignore`.
- [ ] Create `src/utils/config.ts`.
- [ ] Implement logic in `config.ts` to read `OUTPUT_DIR_PATH` directly from `process.env`.
- [ ] Export the loaded `OUTPUT_DIR_PATH` value from `config.ts`.
- [ ] (Optional but Recommended) Add validation in `config.ts` to ensure `OUTPUT_DIR_PATH` is defined in `process.env`.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:**
- Write unit tests for `src/utils/config.ts`. [915]
- Use `process.env` manipulation (e.g., temporarily setting `process.env.OUTPUT_DIR_PATH` within the test) to verify the module reads and exports the value correctly.
- Test validation logic (e.g., if it throws an error when a required variable is missing). [920]
- **Integration Tests:** N/A for this story. [921]
- **Manual/CLI Verification:**
- Check `.env.example` content (AC2).
- Verify `.env` exists locally but not in git status (AC3, AC6).
- Code inspection of `src/utils/config.ts` (AC4).
- Later stories (1.3, 1.4) will consume this module, verifying AC5 implicitly.
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Implemented using native Node.js .env support, no external package installed. Added basic validation.}
- **Change Log:**
- Initial Draft (Corrected requirement to use native .env support instead of installing `dotenv` package).
```
---
**File: ai/stories/1.3.story.md**
```markdown
# Story 1.3: Implement Basic CLI Entry Point & Execution
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic. [123]
**Context:** This story builds upon the project setup (Story 1.1) and environment configuration (Story 1.2). It creates the main starting point (`src/index.ts`) for the CLI application. This file will be executed by the `npm run dev` (using `ts-node`) and `npm run start` (using compiled code) scripts provided by the boilerplate. It verifies that the basic execution flow and configuration loading are functional. [730, 755]
## Detailed Requirements
- Create the main application entry point file at `src/index.ts`. [124]
- Implement minimal code within `src/index.ts` to:
- Import the configuration loading mechanism (from Story 1.2, e.g., `import config from './utils/config';`). [125]
- Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up..."). [126]
- (Optional) Log the loaded `OUTPUT_DIR_PATH` from the imported config object to verify config loading. [127]
- Confirm execution using boilerplate scripts (`npm run dev`, `npm run build`, `npm run start`). [127]
## Acceptance Criteria (ACs)
- AC1: The `src/index.ts` file exists. [128]
- AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console. [129]
- AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports like `config.ts`) into the `dist` directory. [130]
- AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console. [131]
- AC5: (If implemented) The loaded `OUTPUT_DIR_PATH` is logged to the console during execution via `npm run dev` or `npm run start`. [127]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/index.ts`.
- Files to Modify: None.
- _(Hint: See `docs/project-structure.md` [822] for entry point location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Uses scripts from `package.json` (`dev`, `start`, `build`) defined in the boilerplate.
- _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
- **API Interactions / SDK Usage:**
- N/A for this story.
- **Data Structures:**
- Imports configuration object from `src/utils/config.ts` (Story 1.2).
- _(Hint: See `docs/data-models.md` [498-547] for key project data structures)._
- **Environment Variables:**
- Implicitly uses variables loaded by `config.ts` if the optional logging step [127] is implemented.
- _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
- **Coding Standards Notes:**
- Use standard `import` statements.
- Use `console.log` initially for the startup message (Logger setup is in Story 1.4).
## Tasks / Subtasks
- [ ] Create the file `src/index.ts`.
- [ ] Add import statement for the configuration module (`src/utils/config.ts`).
- [ ] Add `console.log("BMad Hacker Daily Digest - Starting Up...");` (or similar).
- [ ] (Optional) Add `console.log(\`Output directory: \${config.OUTPUT_DIR_PATH}\`);`
- [ ] Run `npm run dev` and verify console output (AC2, AC5 optional).
- [ ] Run `npm run build` and verify successful compilation to `dist/` (AC3).
- [ ] Run `npm start` and verify console output from compiled code (AC4, AC5 optional).
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** Low value for this specific story, as it's primarily wiring and execution setup. Testing `config.ts` was covered in Story 1.2. [915]
- **Integration Tests:** N/A for this story. [921]
- **Manual/CLI Verification:**
- Verify `src/index.ts` exists (AC1).
- Run `npm run dev`, check console output (AC2, AC5 opt).
- Run `npm run build`, check `dist/` exists (AC3).
- Run `npm start`, check console output (AC4, AC5 opt).
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/1.4.story.md**
```markdown
# Story 1.4: Setup Basic Logging and Output Directory
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics. [132]
**Context:** This story refines the basic execution setup from Story 1.3. It introduces a simple, reusable logger utility (`src/utils/logger.ts`) for standardized console output [871] and implements the logic to create the necessary date-stamped output directory (`./output/YYYY-MM-DD/`) based on the `OUTPUT_DIR_PATH` configured in Story 1.2. This directory is crucial for persisting intermediate data in later epics (Epics 2, 3, 4). [68, 538, 734, 788]
## Detailed Requirements
- Implement a simple, reusable logging utility module (e.g., `src/utils/logger.ts`). [133] Initially, it can wrap `console.log`, `console.warn`, `console.error`. Provide simple functions like `logInfo`, `logWarn`, `logError`. [134]
- Refactor `src/index.ts` to use this `logger` for its startup message(s) instead of `console.log`. [134]
- In `src/index.ts` (or a setup function called by it):
- Retrieve the `OUTPUT_DIR_PATH` from the configuration (imported from `src/utils/config.ts` - Story 1.2). [135]
- Determine the current date in 'YYYY-MM-DD' format (e.g., using `date-fns` library is recommended [878], needs installation `npm install date-fns --save-prod`). [136]
- Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/${formattedDate}`). [137]
- Check if the base output directory exists; if not, create it. [138]
- Check if the date-stamped subdirectory exists; if not, create it recursively. [139] Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`). Need to import `fs`. [140]
- Log (using the new logger utility) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04"). [141]
- The application should exit gracefully after performing these setup steps (for now). [147]
## Acceptance Criteria (ACs)
- AC1: A logger utility module (`src/utils/logger.ts` or similar) exists and is used for console output in `src/index.ts`. [142]
- AC2: Running `npm run dev` or `npm start` logs the startup message via the logger. [143]
- AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist. [144]
- AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`, based on current date) within the base output directory if it doesn't already exist. [145]
- AC5: The application logs a message via the logger indicating the full path to the date-stamped output directory created/used for the current execution. [146]
- AC6: The application exits gracefully after performing these setup steps (for now). [147]
- AC7: `date-fns` library is added as a production dependency.
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/utils/logger.ts`, `src/utils/dateUtils.ts` (recommended for date formatting logic).
- Files to Modify: `src/index.ts`, `package.json` (add `date-fns`), `package-lock.json`.
- _(Hint: See `docs/project-structure.md` [822] for utils location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], `fs` module (native) [140], `path` module (native, for joining paths).
- `date-fns` library [876] for date formatting (needs `npm install date-fns --save-prod`).
- _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
- **API Interactions / SDK Usage:**
- Node.js `fs.mkdirSync`. [140]
- **Data Structures:**
- N/A specific to this story, uses config from 1.2.
- _(Hint: See `docs/data-models.md` [498-547] for key project data structures)._
- **Environment Variables:**
- Uses `OUTPUT_DIR_PATH` loaded via `config.ts`. [135]
- _(Hint: See `docs/environment-vars.md` [559] for this variable)._
- **Coding Standards Notes:**
- Logger should provide simple info/warn/error functions. [134]
- Use `path.join` to construct file paths reliably.
- Handle potential errors during directory creation (e.g., permissions) using try/catch, logging errors via the new logger.
## Tasks / Subtasks
- [ ] Install `date-fns`: `npm install date-fns --save-prod`.
- [ ] Create `src/utils/logger.ts` wrapping `console` methods (e.g., `logInfo`, `logWarn`, `logError`).
- [ ] Create `src/utils/dateUtils.ts` (optional but recommended) with a function to get current date as 'YYYY-MM-DD' using `date-fns`.
- [ ] Refactor `src/index.ts` to import and use the `logger` instead of `console.log`.
- [ ] In `src/index.ts`, import `fs` and `path`.
- [ ] In `src/index.ts`, import and use the date formatting function.
- [ ] In `src/index.ts`, retrieve `OUTPUT_DIR_PATH` from config.
- [ ] In `src/index.ts`, construct the full date-stamped directory path using `path.join`.
- [ ] In `src/index.ts`, add logic using `fs.mkdirSync` (with `{ recursive: true }`) inside a try/catch block to create the directory. Log errors using the logger.
- [ ] In `src/index.ts`, log the full path of the created/used directory using the logger.
- [ ] Ensure the script completes and exits after these steps.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:**
- Test `src/utils/logger.ts` functions (can spy on `console` methods). [915]
- Test `src/utils/dateUtils.ts` function for correct date formatting.
- Testing `fs` operations in unit tests can be complex; consider focusing on integration or manual verification for directory creation. Mocking `fs` is an option but might be brittle. [918]
- **Integration Tests:**
- Could write a test that runs the core logic of `src/index.ts` (directory creation part) and uses `mock-fs` or actual file system checks (with cleanup) to verify directory creation. [921, 924]
- **Manual/CLI Verification:**
- Run `npm run dev` or `npm start`.
- Check console output uses the logger format (AC1, AC2).
- Verify the base output directory (e.g., `./output`) is created if it didn't exist (AC3).
- Verify the date-stamped subdirectory (e.g., `./output/2025-05-04`) is created (AC4). Use current date. Delete directories before re-running to confirm creation.
- Check console log for the message confirming the output directory path (AC5).
- Confirm the process exits cleanly (AC6).
- Check `package.json` for `date-fns` dependency (AC7).
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
- **Change Log:**
- Initial Draft
```
---
## **End of Report for Epic 1**

View File

@@ -1,925 +0,0 @@
Okay, continuing in **SM Mode**.
Generating the stories for **Epic 2: HN Data Acquisition & Persistence**. This assumes that the foundational work from Epic 1 (project initialization, configuration setup via `src/utils/config.ts`, logger via `src/utils/logger.ts`, and output directory creation logic in `src/index.ts`) is complete and available for use.
---
## **Stories Report: Epic 2**
**File: ai/stories/2.1.story.md**
```markdown
# Story 2.1: Implement Algolia HN API Client
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API. [155]
**Context:** This story creates the primary interface for retrieving data from the external Hacker News API provided by Algolia. It encapsulates the specific API calls (`GET /search` for stories and comments) and data extraction logic into a reusable module (`src/clients/algoliaHNClient.ts`). This client will be used by the main pipeline (Story 2.2) and the stage testing utility (Story 2.4). It builds upon the logger created in Epic 1 (Story 1.4). [54, 60, 62, 77]
## Detailed Requirements
- Create a new module: `src/clients/algoliaHNClient.ts`. [156]
- Implement an async function `WorkspaceTopStories` within the client: [157]
- Use native `Workspace` [749] to call the Algolia HN Search API endpoint for front-page stories (`http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). [4, 6, 7, 157] Adjust `hitsPerPage` if needed to ensure 10 stories.
- Parse the JSON response. [158]
- Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (use as `articleUrl`), `points`, `num_comments`. [159, 522] Handle potential missing `url` field gracefully (log warning using logger from Story 1.4, treat as null). [160]
- Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`). [161]
- Return an array of structured story objects (define a `Story` type, potentially in `src/types/hn.ts`). [162, 506-511]
- Implement a separate async function `WorkspaceCommentsForStory` within the client: [163]
- Accept `storyId` (string) and `maxComments` limit (number) as arguments. [163]
- Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (`http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`). [12, 13, 14, 164]
- Parse the JSON response. [165]
- Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`. [165, 524]
- Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned. [166]
- Return an array of structured comment objects (define a `Comment` type, potentially in `src/types/hn.ts`). [167, 500-505]
- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. [168] Log errors using the logger utility from Epic 1 (Story 1.4). [169]
- Define TypeScript interfaces/types for the expected structures of API responses (subset needed) and the data returned by the client functions (`Story`, `Comment`). Place these in `src/types/hn.ts`. [169, 821]
## Acceptance Criteria (ACs)
- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions. [170]
- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint (`search?tags=front_page&hitsPerPage=10`) and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `num_comments`). [171]
- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint (`search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`) and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones. [172]
- AC4: Both functions use the native `Workspace` API internally. [173]
- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger from Story 1.4. [174] Functions should likely return an empty array or throw a specific error in failure cases for the caller to handle.
- AC6: Relevant TypeScript types (`Story`, `Comment`) are defined in `src/types/hn.ts` and used within the client module. [175]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/clients/algoliaHNClient.ts`, `src/types/hn.ts`.
- Files to Modify: Potentially `src/types/index.ts` if using a barrel file.
- _(Hint: See `docs/project-structure.md` [817, 821] for location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], Native `Workspace` API [863].
- Uses `logger` utility from Epic 1 (Story 1.4).
- _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
- **API Interactions / SDK Usage:**
- Algolia HN Search API `GET /search` endpoint. [2]
- Base URL: `http://hn.algolia.com/api/v1` [3]
- Parameters: `tags=front_page`, `hitsPerPage=10` (for stories) [6, 7]; `tags=comment,story_{storyId}`, `hitsPerPage={maxComments}` (for comments) [13, 14].
- Check `response.ok` and parse JSON response (`response.json()`). [168, 158, 165]
- Handle potential network errors with `try...catch`. [168]
- No authentication required. [3]
- _(Hint: See `docs/api-reference.md` [2-21] for details)._
- **Data Structures:**
- Define `Comment` interface: `{ commentId: string, commentText: string | null, author: string | null, createdAt: string }`. [501-505]
- Define `Story` interface (initial fields): `{ storyId: string, title: string, articleUrl: string | null, hnUrl: string, points?: number, numComments?: number }`. [507-511]
- (These types will be augmented in later stories [512-517]).
- Reference Algolia response subset schemas in `docs/data-models.md` [521-525].
- _(Hint: See `docs/data-models.md` for full details)._
- **Environment Variables:**
- No direct environment variables needed for this client itself (uses hardcoded base URL, fetches comment limit via argument).
- _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
- **Coding Standards Notes:**
- Use `async/await` for `Workspace` calls.
- Use logger for errors and significant events (e.g., warning if `url` is missing). [160]
- Export types and functions clearly.
## Tasks / Subtasks
- [ ] Create `src/types/hn.ts` and define `Comment` and initial `Story` interfaces.
- [ ] Create `src/clients/algoliaHNClient.ts`.
- [ ] Import necessary types and the logger utility.
- [ ] Implement `WorkspaceTopStories` function:
- [ ] Construct Algolia URL for top stories.
- [ ] Use `Workspace` with `try...catch`.
- [ ] Check `response.ok`, log errors if not OK.
- [ ] Parse JSON response.
- [ ] Map `hits` to `Story` objects, extracting required fields, handling null `url`, constructing `hnUrl`.
- [ ] Return array of `Story` objects (or handle error case).
- [ ] Implement `WorkspaceCommentsForStory` function:
- [ ] Accept `storyId` and `maxComments` arguments.
- [ ] Construct Algolia URL for comments using arguments.
- [ ] Use `Workspace` with `try...catch`.
- [ ] Check `response.ok`, log errors if not OK.
- [ ] Parse JSON response.
- [ ] Map `hits` to `Comment` objects, extracting required fields.
- [ ] Filter out comments with null/empty `comment_text`.
- [ ] Limit results to `maxComments`.
- [ ] Return array of `Comment` objects (or handle error case).
- [ ] Export functions and types as needed.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Write unit tests for `src/clients/algoliaHNClient.ts`. [919]
- Mock the native `Workspace` function (e.g., using `jest.spyOn(global, 'fetch')`). [918]
- Test `WorkspaceTopStories`: Provide mock successful responses (valid JSON matching Algolia structure [521-523]) and verify correct parsing, mapping to `Story` objects [171], and `hnUrl` construction. Test with missing `url` field. Test mock error responses (network error, non-OK status) and verify error logging [174] and return value.
- Test `WorkspaceCommentsForStory`: Provide mock successful responses [524-525] and verify correct parsing, mapping to `Comment` objects, filtering of empty comments, and limiting by `maxComments` [172]. Test mock error responses and verify logging [174].
- Verify `Workspace` was called with the correct URLs and parameters [171, 172].
- **Integration Tests:** N/A for this client module itself, but it will be used in pipeline integration tests later. [921]
- **Manual/CLI Verification:** Tested indirectly via Story 2.2 execution and directly via Story 2.4 stage runner. [912]
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/2.2.story.md**
```markdown
# Story 2.2: Integrate HN Data Fetching into Main Workflow
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1. [176]
**Context:** This story connects the HN API client created in Story 2.1 to the main application entry point (`src/index.ts`) established in Epic 1 (Story 1.3). It modifies the main execution flow to call the client functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) after the initial setup (logger, config, output directory). It uses the `MAX_COMMENTS_PER_STORY` configuration value loaded in Story 1.2. The fetched data (stories and their associated comments) is held in memory at the end of this stage. [46, 77]
## Detailed Requirements
- Modify the main execution flow in `src/index.ts` (or a main async function called by it, potentially moving logic to `src/core/pipeline.ts` as suggested by `ARCH` [46, 53] and `PS` [818]). **Recommendation:** Create `src/core/pipeline.ts` and a `runPipeline` async function, then call this function from `src/index.ts`.
- Import the `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) from Story 2.1. [177]
- Import the configuration module (`src/utils/config.ts`) to access `MAX_COMMENTS_PER_STORY`. [177, 563] Also import the logger.
- In the main pipeline function, after the Epic 1 setup (config load, logger init, output dir creation):
- Call `await fetchTopStories()`. [178]
- Log the number of stories fetched (e.g., "Fetched X stories."). [179] Use the logger from Story 1.4.
- Retrieve the `MAX_COMMENTS_PER_STORY` value from the config module. Ensure it's parsed as a number. Provide a default if necessary (e.g., 50, matching `ENV` [564]).
- Iterate through the array of fetched `Story` objects. [179]
- For each `Story`:
- Log progress (e.g., "Fetching up to Y comments for story {storyId}..."). [182]
- Call `await fetchCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY` value. [180]
- Store the fetched comments (the returned `Comment[]`) within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` type/object). [181] Augment the `Story` type definition in `src/types/hn.ts`. [512]
- Ensure errors from the client functions are handled appropriately (e.g., log error and potentially skip comment fetching for that story).
## Acceptance Criteria (ACs)
- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story using the `algoliaHNClient`. [183]
- AC2: Logs (via logger) clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories. [184]
- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config, parsed as a number, and used in the calls to `WorkspaceCommentsForStory`. [185]
- AC4: After successful execution (before persistence in Story 2.3), `Story` objects held in memory contain a `comments` property populated with an array of fetched `Comment` objects. [186] (Verification via debugger or temporary logging).
- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `comments: Comment[]` field. [512]
- AC6: (If implemented) Core logic is moved to `src/core/pipeline.ts` and called from `src/index.ts`. [818]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/core/pipeline.ts` (recommended).
- Files to Modify: `src/index.ts`, `src/types/hn.ts`.
- _(Hint: See `docs/project-structure.md` [818, 821, 822])._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Uses `algoliaHNClient` (Story 2.1), `config` (Story 1.2), `logger` (Story 1.4).
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Calls internal `algoliaHNClient.fetchTopStories()` and `algoliaHNClient.fetchCommentsForStory()`.
- **Data Structures:**
- Augment `Story` interface in `src/types/hn.ts` to include `comments: Comment[]`. [512]
- Manipulates arrays of `Story` and `Comment` objects in memory.
- _(Hint: See `docs/data-models.md` [500-517])._
- **Environment Variables:**
- Reads `MAX_COMMENTS_PER_STORY` via `config.ts`. [177, 563]
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Use `async/await` for calling client functions.
- Structure fetching logic cleanly (e.g., within a loop).
- Use the logger for progress and error reporting. [182, 184]
- Consider putting the main loop logic inside the `runPipeline` function in `src/core/pipeline.ts`.
## Tasks / Subtasks
- [ ] (Recommended) Create `src/core/pipeline.ts` and define an async `runPipeline` function.
- [ ] Modify `src/index.ts` to import and call `runPipeline`. Move existing setup logic (logger init, config load, dir creation) into `runPipeline` or ensure it runs before it.
- [ ] In `pipeline.ts` (or `index.ts`), import `WorkspaceTopStories`, `WorkspaceCommentsForStory` from `algoliaHNClient`.
- [ ] Import `config` and `logger`.
- [ ] Call `WorkspaceTopStories` after initial setup. Log count.
- [ ] Retrieve `MAX_COMMENTS_PER_STORY` from `config`, ensuring it's a number.
- [ ] Update `Story` type in `src/types/hn.ts` to include `comments: Comment[]`.
- [ ] Loop through the fetched stories:
- [ ] Log comment fetching start for the story ID.
- [ ] Call `WorkspaceCommentsForStory` with `storyId` and `maxComments`.
- [ ] Handle potential errors from the client function call.
- [ ] Assign the returned comments array to the `comments` property of the current story object.
- [ ] Add temporary logging or use debugger to verify stories in memory contain comments (AC4).
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- If logic is moved to `src/core/pipeline.ts`, unit test `runPipeline`. [916]
- Mock `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`). [918]
- Mock `config` to provide `MAX_COMMENTS_PER_STORY`.
- Mock `logger`.
- Verify `WorkspaceTopStories` is called once.
- Verify `WorkspaceCommentsForStory` is called for each story returned by the mocked `WorkspaceTopStories`, and that it receives the correct `storyId` and `maxComments` value from config [185].
- Verify the results from mocked `WorkspaceCommentsForStory` are correctly assigned to the `comments` property of the story objects.
- **Integration Tests:**
- Could have an integration test for the fetch stage that uses the real `algoliaHNClient` (or a lightly mocked version checking calls) and verifies the in-memory data structure, but this is largely covered by the stage runner (Story 2.4). [921]
- **Manual/CLI Verification:**
- Run `npm run dev`.
- Check logs for fetching stories and comments messages [184].
- Use debugger or temporary `console.log` in the pipeline code to inspect a story object after the loop and confirm its `comments` property is populated [186].
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Logic moved to src/core/pipeline.ts. Verified in-memory data structure.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/2.3.story.md**
```markdown
# Story 2.3: Persist Fetched HN Data Locally
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging. [187]
**Context:** This story follows Story 2.2 where HN data (stories with comments) was fetched and stored in memory. Now, this data needs to be saved to the local filesystem. It uses the date-stamped output directory created in Epic 1 (Story 1.4) and writes one JSON file per story, containing the story metadata and its comments. This persisted data (`{storyId}_data.json`) is the input for subsequent stages (Scraping - Epic 3, Summarization - Epic 4, Email Assembly - Epic 5). [48, 734, 735]
## Detailed Requirements
- Define a consistent JSON structure for the output file content. [188] Example from `docs/data-models.md` [539]: `{ storyId: "...", title: "...", articleUrl: "...", hnUrl: "...", points: ..., numComments: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", commentText: "...", author: "...", createdAt: "...", ... }, ...] }`. Include a timestamp (`WorkspaceedAt`) for when the data was fetched/saved. [190]
- Import Node.js `fs` (specifically `writeFileSync`) and `path` modules in the pipeline module (`src/core/pipeline.ts` or `src/index.ts`). [190] Import `date-fns` or use `new Date().toISOString()` for timestamp.
- In the main workflow (`pipeline.ts`), within the loop iterating through stories (immediately after comments have been fetched and added to the story object in Story 2.2): [191]
- Get the full path to the date-stamped output directory (this path should be determined/passed from the initial setup logic from Story 1.4). [191]
- Generate the current timestamp in ISO 8601 format (e.g., `new Date().toISOString()`) and add it to the story object as `WorkspaceedAt`. [190] Update `Story` type in `src/types/hn.ts`. [516]
- Construct the filename for the story's data: `{storyId}_data.json`. [192]
- Construct the full file path using `path.join()`. [193]
- Prepare the data object to be saved, matching the defined JSON structure (including `storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`).
- Serialize the prepared story data object to a JSON string using `JSON.stringify(storyData, null, 2)` for readability. [194]
- Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling around the file write. [195]
- Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing. [196]
## Acceptance Criteria (ACs)
- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json` (assuming 10 stories were fetched successfully). [197]
- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`), a `WorkspaceedAt` ISO timestamp, and an array of its fetched `comments`, matching the structure defined in `docs/data-models.md` [538-540]. [198]
- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`. [199]
- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors. [200]
- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `WorkspaceedAt: string` field. [516]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Modify: `src/core/pipeline.ts` (or `src/index.ts`), `src/types/hn.ts`.
- _(Hint: See `docs/project-structure.md` [818, 821, 822])._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Native `fs` module (`writeFileSync`) [190].
- Native `path` module (`join`) [193].
- `JSON.stringify` [194].
- Uses `logger` (Story 1.4).
- Uses output directory path created in Story 1.4 logic.
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- `fs.writeFileSync(filePath, jsonDataString, 'utf-8')`. [195]
- **Data Structures:**
- Uses `Story` and `Comment` types from `src/types/hn.ts`.
- Augment `Story` type to include `WorkspaceedAt: string`. [516]
- Creates JSON structure matching `{storyId}_data.json` schema in `docs/data-models.md`. [538-540]
- _(Hint: See `docs/data-models.md`)._
- **Environment Variables:**
- N/A directly, but relies on `OUTPUT_DIR_PATH` being available from config (Story 1.2) used by the directory creation logic (Story 1.4).
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Use `try...catch` for `writeFileSync` calls. [195]
- Use `JSON.stringify` with indentation (`null, 2`) for readability. [194]
- Log success/failure clearly using the logger. [196]
## Tasks / Subtasks
- [ ] In `pipeline.ts` (or `index.ts`), import `fs` and `path`.
- [ ] Update `Story` type in `src/types/hn.ts` to include `WorkspaceedAt: string`.
- [ ] Ensure the full path to the date-stamped output directory is available within the story processing loop.
- [ ] Inside the loop (after comments are fetched for a story):
- [ ] Get the current ISO timestamp (`new Date().toISOString()`).
- [ ] Add the timestamp to the story object as `WorkspaceedAt`.
- [ ] Construct the output filename: `{storyId}_data.json`.
- [ ] Construct the full file path using `path.join(outputDirPath, filename)`.
- [ ] Create the data object matching the specified JSON structure, including comments.
- [ ] Serialize the data object using `JSON.stringify(data, null, 2)`.
- [ ] Use `try...catch` block:
- [ ] Inside `try`: Call `fs.writeFileSync(fullPath, jsonString, 'utf-8')`.
- [ ] Inside `try`: Log success message with filename.
- [ ] Inside `catch`: Log file writing error with filename.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Testing file system interactions directly in unit tests can be brittle. [918]
- Focus unit tests on the data preparation logic: ensure the object created before `JSON.stringify` has the correct structure (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`) based on a sample input `Story` object. [920]
- Verify the `WorkspaceedAt` timestamp is added correctly.
- **Integration Tests:** [921]
- Could test the file writing aspect using `mock-fs` or actual file system writes within a temporary directory (created during setup, removed during teardown). [924]
- Verify that the correct filename is generated and the content written to the mock/temporary file matches the expected JSON structure [538-540] and content.
- **Manual/CLI Verification:** [912]
- Run `npm run dev`.
- Inspect the `output/YYYY-MM-DD/` directory (use current date).
- Verify 10 files named `{storyId}_data.json` exist (AC1).
- Open a few files, visually inspect the JSON structure, check for all required fields (metadata, `WorkspaceedAt`, `comments` array), and verify comment count <= `MAX_COMMENTS_PER_STORY` (AC2, AC3).
- Check console logs for success messages for file writing or any errors (AC4).
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Files saved successfully in ./output/YYYY-MM-DD/ directory.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/2.4.story.md**
```markdown
# Story 2.4: Implement Stage Testing Utility for HN Fetching
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a separate, executable script that _only_ performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline. [201]
**Context:** This story addresses the PRD requirement [736] for stage-specific testing utilities [764]. It creates a standalone Node.js script (`src/stages/fetch_hn_data.ts`) that replicates the core logic of Stories 2.1, 2.2 (partially), and 2.3. This script will initialize necessary components (logger, config), call the `algoliaHNClient` to fetch stories and comments, and persist the results to the date-stamped output directory, just like the main pipeline does up to this point. This allows isolated testing of the Algolia API interaction and data persistence without running subsequent scraping, summarization, or emailing stages. [57, 62, 912]
## Detailed Requirements
- Create a new standalone script file: `src/stages/fetch_hn_data.ts`. [202]
- This script should perform the essential setup required _for this stage_:
- Initialize the logger utility (from Story 1.4). [203]
- Load configuration using the config utility (from Story 1.2) to get `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH`. [203]
- Determine the current date ('YYYY-MM-DD') using the utility from Story 1.4. [203]
- Construct the date-stamped output directory path. [203]
- Ensure the output directory exists (create it recursively if not, reusing logic/utility from Story 1.4). [203]
- The script should then execute the core logic of fetching and persistence:
- Import and use `algoliaHNClient.fetchTopStories` and `algoliaHNClient.fetchCommentsForStory` (from Story 2.1). [204]
- Import `fs` and `path`.
- Replicate the fetch loop logic from Story 2.2 (fetch stories, then loop to fetch comments for each using loaded `MAX_COMMENTS_PER_STORY` limit). [204]
- Replicate the persistence logic from Story 2.3 (add `WorkspaceedAt` timestamp, prepare data object, `JSON.stringify`, `fs.writeFileSync` to `{storyId}_data.json` in the date-stamped directory). [204]
- The script should log its progress (e.g., "Starting HN data fetch stage...", "Fetching stories...", "Fetching comments for story X...", "Saving data for story X...") using the logger utility. [205]
- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`. [206]
## Acceptance Criteria (ACs)
- AC1: The file `src/stages/fetch_hn_data.ts` exists. [207]
- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section. [208]
- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup (logger, config, output dir), fetch (stories, comments), and persist steps (to JSON files). [209]
- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (up to the end of Epic 2 functionality). [210]
- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages (scraping, summarizing, emailing). [211]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/stages/fetch_hn_data.ts`.
- Files to Modify: `package.json`.
- _(Hint: See `docs/project-structure.md` [820] for stage runner location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], `ts-node` (via `npm run` script).
- Uses `logger` (Story 1.4), `config` (Story 1.2), date util (Story 1.4), directory creation logic (Story 1.4), `algoliaHNClient` (Story 2.1), `fs`/`path` (Story 2.3).
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Calls internal `algoliaHNClient` functions.
- Uses `fs.writeFileSync`.
- **Data Structures:**
- Uses `Story`, `Comment` types.
- Generates `{storyId}_data.json` files [538-540].
- _(Hint: See `docs/data-models.md`)._
- **Environment Variables:**
- Reads `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH` via `config.ts`.
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Structure the script clearly (setup, fetch, persist).
- Use `async/await`.
- Use logger extensively for progress indication. [205]
- Consider wrapping the main logic in an `async` IIFE (Immediately Invoked Function Expression) or a main function call.
## Tasks / Subtasks
- [ ] Create `src/stages/fetch_hn_data.ts`.
- [ ] Add imports for logger, config, date util, `algoliaHNClient`, `fs`, `path`.
- [ ] Implement setup logic: initialize logger, load config, get output dir path, ensure directory exists.
- [ ] Implement main fetch logic:
- [ ] Call `WorkspaceTopStories`.
- [ ] Get `MAX_COMMENTS_PER_STORY` from config.
- [ ] Loop through stories:
- [ ] Call `WorkspaceCommentsForStory`.
- [ ] Add comments to story object.
- [ ] Add `WorkspaceedAt` timestamp.
- [ ] Prepare data object for saving.
- [ ] Construct full file path for `{storyId}_data.json`.
- [ ] Serialize and write to file using `fs.writeFileSync` within `try...catch`.
- [ ] Log progress/success/errors.
- [ ] Add script `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"` to `package.json`.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** Unit tests for the underlying components (logger, config, client, utils) should already exist from previous stories. Unit testing the stage script itself might have limited value beyond checking basic setup calls if the core logic is just orchestrating tested components. [915]
- **Integration Tests:** N/A specifically for the script, as it _is_ an integration test itself. [921]
- **Manual/CLI Verification (Primary Test Method for this Story):** [912, 927]
- Run `npm run stage:fetch`. [209]
- Verify successful execution without errors.
- Check console logs for messages specific to fetching and persisting [211].
- Inspect the `output/YYYY-MM-DD/` directory and verify the content of the generated `{storyId}_data.json` files match expectations (similar to verification for Story 2.3) [210].
- Modify `package.json` to add the script (AC2).
- _(Hint: See `docs/testing-strategy.md` [907-950] which identifies Stage Runners as a key part of Acceptance Testing)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Stage runner script created and tested successfully. package.json updated.}
- **Change Log:**
- Initial Draft
```
---
## **End of Report for Epic 2**
Okay, continuing in **SM Mode**.
Generating the stories for **Epic 2: HN Data Acquisition & Persistence**. This assumes that the foundational work from Epic 1 (project initialization, configuration setup via `src/utils/config.ts`, logger via `src/utils/logger.ts`, and output directory creation logic in `src/index.ts`) is complete and available for use.
---
## **Stories Report: Epic 2**
**File: ai/stories/2.1.story.md**
```markdown
# Story 2.1: Implement Algolia HN API Client
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API. [155]
**Context:** This story creates the primary interface for retrieving data from the external Hacker News API provided by Algolia. It encapsulates the specific API calls (`GET /search` for stories and comments) and data extraction logic into a reusable module (`src/clients/algoliaHNClient.ts`). This client will be used by the main pipeline (Story 2.2) and the stage testing utility (Story 2.4). It builds upon the logger created in Epic 1 (Story 1.4). [54, 60, 62, 77]
## Detailed Requirements
- Create a new module: `src/clients/algoliaHNClient.ts`. [156]
- Implement an async function `WorkspaceTopStories` within the client: [157]
- Use native `Workspace` [749] to call the Algolia HN Search API endpoint for front-page stories (`http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). [4, 6, 7, 157] Adjust `hitsPerPage` if needed to ensure 10 stories.
- Parse the JSON response. [158]
- Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (use as `articleUrl`), `points`, `num_comments`. [159, 522] Handle potential missing `url` field gracefully (log warning using logger from Story 1.4, treat as null). [160]
- Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`). [161]
- Return an array of structured story objects (define a `Story` type, potentially in `src/types/hn.ts`). [162, 506-511]
- Implement a separate async function `WorkspaceCommentsForStory` within the client: [163]
- Accept `storyId` (string) and `maxComments` limit (number) as arguments. [163]
- Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (`http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`). [12, 13, 14, 164]
- Parse the JSON response. [165]
- Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`. [165, 524]
- Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned. [166]
- Return an array of structured comment objects (define a `Comment` type, potentially in `src/types/hn.ts`). [167, 500-505]
- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. [168] Log errors using the logger utility from Epic 1 (Story 1.4). [169]
- Define TypeScript interfaces/types for the expected structures of API responses (subset needed) and the data returned by the client functions (`Story`, `Comment`). Place these in `src/types/hn.ts`. [169, 821]
## Acceptance Criteria (ACs)
- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions. [170]
- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint (`search?tags=front_page&hitsPerPage=10`) and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `num_comments`). [171]
- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint (`search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`) and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones. [172]
- AC4: Both functions use the native `Workspace` API internally. [173]
- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger from Story 1.4. [174] Functions should likely return an empty array or throw a specific error in failure cases for the caller to handle.
- AC6: Relevant TypeScript types (`Story`, `Comment`) are defined in `src/types/hn.ts` and used within the client module. [175]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/clients/algoliaHNClient.ts`, `src/types/hn.ts`.
- Files to Modify: Potentially `src/types/index.ts` if using a barrel file.
- _(Hint: See `docs/project-structure.md` [817, 821] for location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], Native `Workspace` API [863].
- Uses `logger` utility from Epic 1 (Story 1.4).
- _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
- **API Interactions / SDK Usage:**
- Algolia HN Search API `GET /search` endpoint. [2]
- Base URL: `http://hn.algolia.com/api/v1` [3]
- Parameters: `tags=front_page`, `hitsPerPage=10` (for stories) [6, 7]; `tags=comment,story_{storyId}`, `hitsPerPage={maxComments}` (for comments) [13, 14].
- Check `response.ok` and parse JSON response (`response.json()`). [168, 158, 165]
- Handle potential network errors with `try...catch`. [168]
- No authentication required. [3]
- _(Hint: See `docs/api-reference.md` [2-21] for details)._
- **Data Structures:**
- Define `Comment` interface: `{ commentId: string, commentText: string | null, author: string | null, createdAt: string }`. [501-505]
- Define `Story` interface (initial fields): `{ storyId: string, title: string, articleUrl: string | null, hnUrl: string, points?: number, numComments?: number }`. [507-511]
- (These types will be augmented in later stories [512-517]).
- Reference Algolia response subset schemas in `docs/data-models.md` [521-525].
- _(Hint: See `docs/data-models.md` for full details)._
- **Environment Variables:**
- No direct environment variables needed for this client itself (uses hardcoded base URL, fetches comment limit via argument).
- _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
- **Coding Standards Notes:**
- Use `async/await` for `Workspace` calls.
- Use logger for errors and significant events (e.g., warning if `url` is missing). [160]
- Export types and functions clearly.
## Tasks / Subtasks
- [ ] Create `src/types/hn.ts` and define `Comment` and initial `Story` interfaces.
- [ ] Create `src/clients/algoliaHNClient.ts`.
- [ ] Import necessary types and the logger utility.
- [ ] Implement `WorkspaceTopStories` function:
- [ ] Construct Algolia URL for top stories.
- [ ] Use `Workspace` with `try...catch`.
- [ ] Check `response.ok`, log errors if not OK.
- [ ] Parse JSON response.
- [ ] Map `hits` to `Story` objects, extracting required fields, handling null `url`, constructing `hnUrl`.
- [ ] Return array of `Story` objects (or handle error case).
- [ ] Implement `WorkspaceCommentsForStory` function:
- [ ] Accept `storyId` and `maxComments` arguments.
- [ ] Construct Algolia URL for comments using arguments.
- [ ] Use `Workspace` with `try...catch`.
- [ ] Check `response.ok`, log errors if not OK.
- [ ] Parse JSON response.
- [ ] Map `hits` to `Comment` objects, extracting required fields.
- [ ] Filter out comments with null/empty `comment_text`.
- [ ] Limit results to `maxComments`.
- [ ] Return array of `Comment` objects (or handle error case).
- [ ] Export functions and types as needed.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Write unit tests for `src/clients/algoliaHNClient.ts`. [919]
- Mock the native `Workspace` function (e.g., using `jest.spyOn(global, 'fetch')`). [918]
- Test `WorkspaceTopStories`: Provide mock successful responses (valid JSON matching Algolia structure [521-523]) and verify correct parsing, mapping to `Story` objects [171], and `hnUrl` construction. Test with missing `url` field. Test mock error responses (network error, non-OK status) and verify error logging [174] and return value.
- Test `WorkspaceCommentsForStory`: Provide mock successful responses [524-525] and verify correct parsing, mapping to `Comment` objects, filtering of empty comments, and limiting by `maxComments` [172]. Test mock error responses and verify logging [174].
- Verify `Workspace` was called with the correct URLs and parameters [171, 172].
- **Integration Tests:** N/A for this client module itself, but it will be used in pipeline integration tests later. [921]
- **Manual/CLI Verification:** Tested indirectly via Story 2.2 execution and directly via Story 2.4 stage runner. [912]
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/2.2.story.md**
```markdown
# Story 2.2: Integrate HN Data Fetching into Main Workflow
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1. [176]
**Context:** This story connects the HN API client created in Story 2.1 to the main application entry point (`src/index.ts`) established in Epic 1 (Story 1.3). It modifies the main execution flow to call the client functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) after the initial setup (logger, config, output directory). It uses the `MAX_COMMENTS_PER_STORY` configuration value loaded in Story 1.2. The fetched data (stories and their associated comments) is held in memory at the end of this stage. [46, 77]
## Detailed Requirements
- Modify the main execution flow in `src/index.ts` (or a main async function called by it, potentially moving logic to `src/core/pipeline.ts` as suggested by `ARCH` [46, 53] and `PS` [818]). **Recommendation:** Create `src/core/pipeline.ts` and a `runPipeline` async function, then call this function from `src/index.ts`.
- Import the `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) from Story 2.1. [177]
- Import the configuration module (`src/utils/config.ts`) to access `MAX_COMMENTS_PER_STORY`. [177, 563] Also import the logger.
- In the main pipeline function, after the Epic 1 setup (config load, logger init, output dir creation):
- Call `await fetchTopStories()`. [178]
- Log the number of stories fetched (e.g., "Fetched X stories."). [179] Use the logger from Story 1.4.
- Retrieve the `MAX_COMMENTS_PER_STORY` value from the config module. Ensure it's parsed as a number. Provide a default if necessary (e.g., 50, matching `ENV` [564]).
- Iterate through the array of fetched `Story` objects. [179]
- For each `Story`:
- Log progress (e.g., "Fetching up to Y comments for story {storyId}..."). [182]
- Call `await fetchCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY` value. [180]
- Store the fetched comments (the returned `Comment[]`) within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` type/object). [181] Augment the `Story` type definition in `src/types/hn.ts`. [512]
- Ensure errors from the client functions are handled appropriately (e.g., log error and potentially skip comment fetching for that story).
## Acceptance Criteria (ACs)
- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story using the `algoliaHNClient`. [183]
- AC2: Logs (via logger) clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories. [184]
- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config, parsed as a number, and used in the calls to `WorkspaceCommentsForStory`. [185]
- AC4: After successful execution (before persistence in Story 2.3), `Story` objects held in memory contain a `comments` property populated with an array of fetched `Comment` objects. [186] (Verification via debugger or temporary logging).
- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `comments: Comment[]` field. [512]
- AC6: (If implemented) Core logic is moved to `src/core/pipeline.ts` and called from `src/index.ts`. [818]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/core/pipeline.ts` (recommended).
- Files to Modify: `src/index.ts`, `src/types/hn.ts`.
- _(Hint: See `docs/project-structure.md` [818, 821, 822])._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Uses `algoliaHNClient` (Story 2.1), `config` (Story 1.2), `logger` (Story 1.4).
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Calls internal `algoliaHNClient.fetchTopStories()` and `algoliaHNClient.fetchCommentsForStory()`.
- **Data Structures:**
- Augment `Story` interface in `src/types/hn.ts` to include `comments: Comment[]`. [512]
- Manipulates arrays of `Story` and `Comment` objects in memory.
- _(Hint: See `docs/data-models.md` [500-517])._
- **Environment Variables:**
- Reads `MAX_COMMENTS_PER_STORY` via `config.ts`. [177, 563]
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Use `async/await` for calling client functions.
- Structure fetching logic cleanly (e.g., within a loop).
- Use the logger for progress and error reporting. [182, 184]
- Consider putting the main loop logic inside the `runPipeline` function in `src/core/pipeline.ts`.
## Tasks / Subtasks
- [ ] (Recommended) Create `src/core/pipeline.ts` and define an async `runPipeline` function.
- [ ] Modify `src/index.ts` to import and call `runPipeline`. Move existing setup logic (logger init, config load, dir creation) into `runPipeline` or ensure it runs before it.
- [ ] In `pipeline.ts` (or `index.ts`), import `WorkspaceTopStories`, `WorkspaceCommentsForStory` from `algoliaHNClient`.
- [ ] Import `config` and `logger`.
- [ ] Call `WorkspaceTopStories` after initial setup. Log count.
- [ ] Retrieve `MAX_COMMENTS_PER_STORY` from `config`, ensuring it's a number.
- [ ] Update `Story` type in `src/types/hn.ts` to include `comments: Comment[]`.
- [ ] Loop through the fetched stories:
- [ ] Log comment fetching start for the story ID.
- [ ] Call `WorkspaceCommentsForStory` with `storyId` and `maxComments`.
- [ ] Handle potential errors from the client function call.
- [ ] Assign the returned comments array to the `comments` property of the current story object.
- [ ] Add temporary logging or use debugger to verify stories in memory contain comments (AC4).
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- If logic is moved to `src/core/pipeline.ts`, unit test `runPipeline`. [916]
- Mock `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`). [918]
- Mock `config` to provide `MAX_COMMENTS_PER_STORY`.
- Mock `logger`.
- Verify `WorkspaceTopStories` is called once.
- Verify `WorkspaceCommentsForStory` is called for each story returned by the mocked `WorkspaceTopStories`, and that it receives the correct `storyId` and `maxComments` value from config [185].
- Verify the results from mocked `WorkspaceCommentsForStory` are correctly assigned to the `comments` property of the story objects.
- **Integration Tests:**
- Could have an integration test for the fetch stage that uses the real `algoliaHNClient` (or a lightly mocked version checking calls) and verifies the in-memory data structure, but this is largely covered by the stage runner (Story 2.4). [921]
- **Manual/CLI Verification:**
- Run `npm run dev`.
- Check logs for fetching stories and comments messages [184].
- Use debugger or temporary `console.log` in the pipeline code to inspect a story object after the loop and confirm its `comments` property is populated [186].
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Logic moved to src/core/pipeline.ts. Verified in-memory data structure.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/2.3.story.md**
```markdown
# Story 2.3: Persist Fetched HN Data Locally
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging. [187]
**Context:** This story follows Story 2.2 where HN data (stories with comments) was fetched and stored in memory. Now, this data needs to be saved to the local filesystem. It uses the date-stamped output directory created in Epic 1 (Story 1.4) and writes one JSON file per story, containing the story metadata and its comments. This persisted data (`{storyId}_data.json`) is the input for subsequent stages (Scraping - Epic 3, Summarization - Epic 4, Email Assembly - Epic 5). [48, 734, 735]
## Detailed Requirements
- Define a consistent JSON structure for the output file content. [188] Example from `docs/data-models.md` [539]: `{ storyId: "...", title: "...", articleUrl: "...", hnUrl: "...", points: ..., numComments: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", commentText: "...", author: "...", createdAt: "...", ... }, ...] }`. Include a timestamp (`WorkspaceedAt`) for when the data was fetched/saved. [190]
- Import Node.js `fs` (specifically `writeFileSync`) and `path` modules in the pipeline module (`src/core/pipeline.ts` or `src/index.ts`). [190] Import `date-fns` or use `new Date().toISOString()` for timestamp.
- In the main workflow (`pipeline.ts`), within the loop iterating through stories (immediately after comments have been fetched and added to the story object in Story 2.2): [191]
- Get the full path to the date-stamped output directory (this path should be determined/passed from the initial setup logic from Story 1.4). [191]
- Generate the current timestamp in ISO 8601 format (e.g., `new Date().toISOString()`) and add it to the story object as `WorkspaceedAt`. [190] Update `Story` type in `src/types/hn.ts`. [516]
- Construct the filename for the story's data: `{storyId}_data.json`. [192]
- Construct the full file path using `path.join()`. [193]
- Prepare the data object to be saved, matching the defined JSON structure (including `storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`).
- Serialize the prepared story data object to a JSON string using `JSON.stringify(storyData, null, 2)` for readability. [194]
- Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling around the file write. [195]
- Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing. [196]
## Acceptance Criteria (ACs)
- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json` (assuming 10 stories were fetched successfully). [197]
- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`), a `WorkspaceedAt` ISO timestamp, and an array of its fetched `comments`, matching the structure defined in `docs/data-models.md` [538-540]. [198]
- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`. [199]
- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors. [200]
- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `WorkspaceedAt: string` field. [516]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Modify: `src/core/pipeline.ts` (or `src/index.ts`), `src/types/hn.ts`.
- _(Hint: See `docs/project-structure.md` [818, 821, 822])._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Native `fs` module (`writeFileSync`) [190].
- Native `path` module (`join`) [193].
- `JSON.stringify` [194].
- Uses `logger` (Story 1.4).
- Uses output directory path created in Story 1.4 logic.
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- `fs.writeFileSync(filePath, jsonDataString, 'utf-8')`. [195]
- **Data Structures:**
- Uses `Story` and `Comment` types from `src/types/hn.ts`.
- Augment `Story` type to include `WorkspaceedAt: string`. [516]
- Creates JSON structure matching `{storyId}_data.json` schema in `docs/data-models.md`. [538-540]
- _(Hint: See `docs/data-models.md`)._
- **Environment Variables:**
- N/A directly, but relies on `OUTPUT_DIR_PATH` being available from config (Story 1.2) used by the directory creation logic (Story 1.4).
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Use `try...catch` for `writeFileSync` calls. [195]
- Use `JSON.stringify` with indentation (`null, 2`) for readability. [194]
- Log success/failure clearly using the logger. [196]
## Tasks / Subtasks
- [ ] In `pipeline.ts` (or `index.ts`), import `fs` and `path`.
- [ ] Update `Story` type in `src/types/hn.ts` to include `WorkspaceedAt: string`.
- [ ] Ensure the full path to the date-stamped output directory is available within the story processing loop.
- [ ] Inside the loop (after comments are fetched for a story):
- [ ] Get the current ISO timestamp (`new Date().toISOString()`).
- [ ] Add the timestamp to the story object as `WorkspaceedAt`.
- [ ] Construct the output filename: `{storyId}_data.json`.
- [ ] Construct the full file path using `path.join(outputDirPath, filename)`.
- [ ] Create the data object matching the specified JSON structure, including comments.
- [ ] Serialize the data object using `JSON.stringify(data, null, 2)`.
- [ ] Use `try...catch` block:
- [ ] Inside `try`: Call `fs.writeFileSync(fullPath, jsonString, 'utf-8')`.
- [ ] Inside `try`: Log success message with filename.
- [ ] Inside `catch`: Log file writing error with filename.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Testing file system interactions directly in unit tests can be brittle. [918]
- Focus unit tests on the data preparation logic: ensure the object created before `JSON.stringify` has the correct structure (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`) based on a sample input `Story` object. [920]
- Verify the `WorkspaceedAt` timestamp is added correctly.
- **Integration Tests:** [921]
- Could test the file writing aspect using `mock-fs` or actual file system writes within a temporary directory (created during setup, removed during teardown). [924]
- Verify that the correct filename is generated and the content written to the mock/temporary file matches the expected JSON structure [538-540] and content.
- **Manual/CLI Verification:** [912]
- Run `npm run dev`.
- Inspect the `output/YYYY-MM-DD/` directory (use current date).
- Verify 10 files named `{storyId}_data.json` exist (AC1).
- Open a few files, visually inspect the JSON structure, check for all required fields (metadata, `WorkspaceedAt`, `comments` array), and verify comment count <= `MAX_COMMENTS_PER_STORY` (AC2, AC3).
- Check console logs for success messages for file writing or any errors (AC4).
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Files saved successfully in ./output/YYYY-MM-DD/ directory.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/2.4.story.md**
```markdown
# Story 2.4: Implement Stage Testing Utility for HN Fetching
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a separate, executable script that _only_ performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline. [201]
**Context:** This story addresses the PRD requirement [736] for stage-specific testing utilities [764]. It creates a standalone Node.js script (`src/stages/fetch_hn_data.ts`) that replicates the core logic of Stories 2.1, 2.2 (partially), and 2.3. This script will initialize necessary components (logger, config), call the `algoliaHNClient` to fetch stories and comments, and persist the results to the date-stamped output directory, just like the main pipeline does up to this point. This allows isolated testing of the Algolia API interaction and data persistence without running subsequent scraping, summarization, or emailing stages. [57, 62, 912]
## Detailed Requirements
- Create a new standalone script file: `src/stages/fetch_hn_data.ts`. [202]
- This script should perform the essential setup required _for this stage_:
- Initialize the logger utility (from Story 1.4). [203]
- Load configuration using the config utility (from Story 1.2) to get `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH`. [203]
- Determine the current date ('YYYY-MM-DD') using the utility from Story 1.4. [203]
- Construct the date-stamped output directory path. [203]
- Ensure the output directory exists (create it recursively if not, reusing logic/utility from Story 1.4). [203]
- The script should then execute the core logic of fetching and persistence:
- Import and use `algoliaHNClient.fetchTopStories` and `algoliaHNClient.fetchCommentsForStory` (from Story 2.1). [204]
- Import `fs` and `path`.
- Replicate the fetch loop logic from Story 2.2 (fetch stories, then loop to fetch comments for each using loaded `MAX_COMMENTS_PER_STORY` limit). [204]
- Replicate the persistence logic from Story 2.3 (add `WorkspaceedAt` timestamp, prepare data object, `JSON.stringify`, `fs.writeFileSync` to `{storyId}_data.json` in the date-stamped directory). [204]
- The script should log its progress (e.g., "Starting HN data fetch stage...", "Fetching stories...", "Fetching comments for story X...", "Saving data for story X...") using the logger utility. [205]
- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`. [206]
## Acceptance Criteria (ACs)
- AC1: The file `src/stages/fetch_hn_data.ts` exists. [207]
- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section. [208]
- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup (logger, config, output dir), fetch (stories, comments), and persist steps (to JSON files). [209]
- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (up to the end of Epic 2 functionality). [210]
- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages (scraping, summarizing, emailing). [211]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/stages/fetch_hn_data.ts`.
- Files to Modify: `package.json`.
- _(Hint: See `docs/project-structure.md` [820] for stage runner location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], `ts-node` (via `npm run` script).
- Uses `logger` (Story 1.4), `config` (Story 1.2), date util (Story 1.4), directory creation logic (Story 1.4), `algoliaHNClient` (Story 2.1), `fs`/`path` (Story 2.3).
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Calls internal `algoliaHNClient` functions.
- Uses `fs.writeFileSync`.
- **Data Structures:**
- Uses `Story`, `Comment` types.
- Generates `{storyId}_data.json` files [538-540].
- _(Hint: See `docs/data-models.md`)._
- **Environment Variables:**
- Reads `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH` via `config.ts`.
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Structure the script clearly (setup, fetch, persist).
- Use `async/await`.
- Use logger extensively for progress indication. [205]
- Consider wrapping the main logic in an `async` IIFE (Immediately Invoked Function Expression) or a main function call.
## Tasks / Subtasks
- [ ] Create `src/stages/fetch_hn_data.ts`.
- [ ] Add imports for logger, config, date util, `algoliaHNClient`, `fs`, `path`.
- [ ] Implement setup logic: initialize logger, load config, get output dir path, ensure directory exists.
- [ ] Implement main fetch logic:
- [ ] Call `WorkspaceTopStories`.
- [ ] Get `MAX_COMMENTS_PER_STORY` from config.
- [ ] Loop through stories:
- [ ] Call `WorkspaceCommentsForStory`.
- [ ] Add comments to story object.
- [ ] Add `WorkspaceedAt` timestamp.
- [ ] Prepare data object for saving.
- [ ] Construct full file path for `{storyId}_data.json`.
- [ ] Serialize and write to file using `fs.writeFileSync` within `try...catch`.
- [ ] Log progress/success/errors.
- [ ] Add script `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"` to `package.json`.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** Unit tests for the underlying components (logger, config, client, utils) should already exist from previous stories. Unit testing the stage script itself might have limited value beyond checking basic setup calls if the core logic is just orchestrating tested components. [915]
- **Integration Tests:** N/A specifically for the script, as it _is_ an integration test itself. [921]
- **Manual/CLI Verification (Primary Test Method for this Story):** [912, 927]
- Run `npm run stage:fetch`. [209]
- Verify successful execution without errors.
- Check console logs for messages specific to fetching and persisting [211].
- Inspect the `output/YYYY-MM-DD/` directory and verify the content of the generated `{storyId}_data.json` files match expectations (similar to verification for Story 2.3) [210].
- Modify `package.json` to add the script (AC2).
- _(Hint: See `docs/testing-strategy.md` [907-950] which identifies Stage Runners as a key part of Acceptance Testing)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Stage runner script created and tested successfully. package.json updated.}
- **Change Log:**
- Initial Draft
```
---
## **End of Report for Epic 2**

View File

@@ -1,486 +0,0 @@
Okay, remaining in **SM Mode**.
Generating the stories for **Epic 3: Article Scraping & Persistence**. This assumes that Epic 1 (project setup, config, logging, output dir) and Epic 2 (HN client implementation, data fetching integration, and local persistence of `{storyId}_data.json` files) are complete.
---
## **Stories Report: Epic 3**
**File: ai/stories/3.1.story.md**
```markdown
# Story 3.1: Implement Basic Article Scraper Module
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization. [220]
**Context:** This story introduces the article scraping capability. It creates a dedicated module (`src/scraper/articleScraper.ts`) responsible for fetching content from external article URLs (found in the `{storyId}_data.json` files from Epic 2) and extracting plain text. It emphasizes using native `Workspace` and a simple extraction library (`@extractus/article-extractor` is recommended [222, 873]), and crucially, handling failures robustly (timeouts, non-HTML content, extraction errors) as required by the PRD [723, 724, 741]. This module will be used by the main pipeline (Story 3.2) and the stage tester (Story 3.4). [47, 55, 60, 63, 65]
## Detailed Requirements
- Create a new module: `src/scraper/articleScraper.ts`. [221]
- Add `@extractus/article-extractor` dependency: `npm install @extractus/article-extractor --save-prod`. [222, 223, 873]
- Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module. [223, 224]
- Inside the function:
- Use native `Workspace` [749] to retrieve content from the `url`. [224] Set a reasonable timeout (e.g., 15 seconds via `AbortSignal.timeout()`, configure via `SCRAPE_TIMEOUT_MS` [615] if needed). Include a `User-Agent` header (e.g., `"BMadHackerDigest/0.1"` or configurable via `SCRAPER_USER_AGENT` [629]). [225]
- Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`. Log error using logger (from Story 1.4) and return `null`. [226]
- Check the `response.ok` status. If not okay, log error (including status code) and return `null`. [226, 227]
- Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`. [227, 228]
- If HTML is received (`response.text()`), attempt to extract the main article text using `@extractus/article-extractor`. [229]
- Wrap the extraction logic (`await articleExtractor.extract(htmlContent)`) in a `try...catch` to handle library-specific errors. Log error and return `null` on failure. [230]
- Return the extracted plain text (`article.content`) if successful and not empty. Ensure it's just text, not HTML markup. [231]
- Return `null` if extraction fails or results in empty content. [232]
- Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-OK status:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text for {url}") using the logger utility. [233]
- Define TypeScript types/interfaces as needed (though `article-extractor` types might suffice). [234]
## Acceptance Criteria (ACs)
- AC1: The `src/scraper/articleScraper.ts` module exists and exports the `scrapeArticle` function. [234]
- AC2: The `@extractus/article-extractor` library is added to `dependencies` in `package.json` and `package-lock.json` is updated. [235]
- AC3: `scrapeArticle` uses native `Workspace` with a timeout (default or configured) and a User-Agent header. [236]
- AC4: `scrapeArticle` correctly handles fetch errors (network, timeout), non-OK responses, and non-HTML content types by logging the specific reason and returning `null`. [237]
- AC5: `scrapeArticle` uses `@extractus/article-extractor` to attempt text extraction from valid HTML content fetched via `response.text()`. [238]
- AC6: `scrapeArticle` returns the extracted plain text string on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result). [239]
- AC7: Relevant logs are produced using the logger for success, different failure modes, and errors encountered during the process. [240]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/scraper/articleScraper.ts`.
- Files to Modify: `package.json`, `package-lock.json`. Add optional env vars to `.env.example`.
- _(Hint: See `docs/project-structure.md` [819] for scraper location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], Native `Workspace` API [863].
- `@extractus/article-extractor` library. [873]
- Uses `logger` utility (Story 1.4).
- Uses `config` utility (Story 1.2) if implementing configurable timeout/user-agent.
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Native `Workspace(url, { signal: AbortSignal.timeout(timeoutMs), headers: { 'User-Agent': userAgent } })`. [225]
- Check `response.ok`, `response.headers.get('Content-Type')`. [227, 228]
- Get body as text: `await response.text()`. [229]
- `@extractus/article-extractor`: `import articleExtractor from '@extractus/article-extractor'; const article = await articleExtractor.extract(htmlContent); return article?.content || null;` [229, 231]
- **Data Structures:**
- Function signature: `scrapeArticle(url: string): Promise<string | null>`. [224]
- Uses `article` object returned by extractor.
- _(Hint: See `docs/data-models.md` [498-547])._
- **Environment Variables:**
- Optional: `SCRAPE_TIMEOUT_MS` (default e.g., 15000). [615]
- Optional: `SCRAPER_USER_AGENT` (default e.g., "BMadHackerDigest/0.1"). [629]
- Load via `config.ts` if used.
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Use `async/await`.
- Implement comprehensive `try...catch` blocks for `Workspace` and extraction. [226, 230]
- Log errors and reasons for returning `null` clearly. [233]
## Tasks / Subtasks
- [ ] Run `npm install @extractus/article-extractor --save-prod`.
- [ ] Create `src/scraper/articleScraper.ts`.
- [ ] Import logger, (optionally config), and `articleExtractor`.
- [ ] Define the `scrapeArticle` async function accepting a `url`.
- [ ] Implement `try...catch` for the entire fetch/parse logic. Log error and return `null` in `catch`.
- [ ] Inside `try`:
- [ ] Define timeout (default or from config).
- [ ] Define User-Agent (default or from config).
- [ ] Call native `Workspace` with URL, timeout signal, and User-Agent header.
- [ ] Check `response.ok`. If not OK, log status and return `null`.
- [ ] Check `Content-Type` header. If not HTML, log type and return `null`.
- [ ] Get HTML content using `response.text()`.
- [ ] Implement inner `try...catch` for extraction:
- [ ] Call `await articleExtractor.extract(htmlContent)`.
- [ ] Check if result (`article?.content`) is valid text. If yes, log success and return text.
- [ ] If extraction failed or content is empty, log reason and return `null`.
- [ ] In `catch` block for extraction, log error and return `null`.
- [ ] Add optional env vars `SCRAPE_TIMEOUT_MS` and `SCRAPER_USER_AGENT` to `.env.example`.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Write unit tests for `src/scraper/articleScraper.ts`. [919]
- Mock native `Workspace`. Test different scenarios:
- Successful fetch (200 OK, HTML content type) -> Mock `articleExtractor` success -> Verify returned text [239].
- Successful fetch -> Mock `articleExtractor` failure/empty content -> Verify `null` return and logs [239, 240].
- Fetch returns non-OK status (e.g., 404, 500) -> Verify `null` return and logs [237, 240].
- Fetch returns non-HTML content type -> Verify `null` return and logs [237, 240].
- Fetch throws network error/timeout -> Verify `null` return and logs [237, 240].
- Mock `@extractus/article-extractor` to simulate success and failure cases. [918]
- Verify `Workspace` is called with the correct URL, User-Agent, and timeout signal [236].
- **Integration Tests:** N/A for this module itself. [921]
- **Manual/CLI Verification:** Tested indirectly via Story 3.2 execution and directly via Story 3.4 stage runner. [912]
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Implemented scraper module with @extractus/article-extractor and robust error handling.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/3.2.story.md**
```markdown
# Story 3.2: Integrate Article Scraping into Main Workflow
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to integrate the article scraper into the main workflow (`src/core/pipeline.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data. [241]
**Context:** This story connects the scraper module (`articleScraper.ts` from Story 3.1) into the main application pipeline (`src/core/pipeline.ts`) developed in Epic 2. It modifies the main loop over the fetched stories (which contain data loaded in Story 2.2) to include a call to `scrapeArticle` for stories that have an article URL. The result (scraped text or null) is then stored in memory, associated with the story object. [47, 78, 79]
## Detailed Requirements
- Modify the main execution flow in `src/core/pipeline.ts` (assuming logic moved here in Story 2.2). [242]
- Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`. [243] Import the logger.
- Within the main loop iterating through the fetched `Story` objects (after comments are fetched in Story 2.2 and before persistence in Story 2.3):
- Check if `story.articleUrl` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient. [243, 244]
- If the URL is missing or invalid, log a warning using the logger ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next step for this story (e.g., summarization in Epic 4, or persistence in Story 3.3). Set an internal placeholder for scraped content to `null`. [245]
- If a valid URL exists:
- Log ("Attempting to scrape article for story {storyId} from {story.articleUrl}"). [246]
- Call `await scrapeArticle(story.articleUrl)`. [247]
- Store the result (the extracted text string or `null`) in memory, associated with the story object. Define/add property `articleContent: string | null` to the `Story` type in `src/types/hn.ts`. [247, 513]
- Log the outcome clearly using the logger (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}"). [248]
## Acceptance Criteria (ACs)
- AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid `articleUrl`s within the main pipeline loop. [249]
- AC2: Stories with missing or invalid `articleUrl`s are skipped by the scraping step, and a corresponding warning message is logged via the logger. [250]
- AC3: For stories with valid URLs, the `scrapeArticle` function from `src/scraper/articleScraper.ts` is called with the correct URL. [251]
- AC4: Logs (via logger) clearly indicate the start ("Attempting to scrape...") and the success/failure outcome of the scraping attempt for each relevant story. [252]
- AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed. [253] (Verify via debugger/logging).
- AC6: The `Story` type definition in `src/types/hn.ts` is updated to include the `articleContent: string | null` field. [513]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Modify: `src/core/pipeline.ts`, `src/types/hn.ts`.
- _(Hint: See `docs/project-structure.md` [818, 821])._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Uses `articleScraper.scrapeArticle` (Story 3.1), `logger` (Story 1.4).
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Calls internal `scrapeArticle(url)`.
- **Data Structures:**
- Operates on `Story[]` fetched in Epic 2.
- Augment `Story` interface in `src/types/hn.ts` to include `articleContent: string | null`. [513]
- Checks `story.articleUrl`.
- _(Hint: See `docs/data-models.md` [506-517])._
- **Environment Variables:**
- N/A directly, but `scrapeArticle` might use them (Story 3.1).
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Perform the URL check before calling the scraper. [244]
- Clearly log skipping, attempt, success, failure for scraping. [245, 246, 248]
- Ensure the `articleContent` property is always set (either to the result string or explicitly to `null`).
## Tasks / Subtasks
- [ ] Update `Story` type in `src/types/hn.ts` to include `articleContent: string | null`.
- [ ] Modify the main loop in `src/core/pipeline.ts` where stories are processed.
- [ ] Import `scrapeArticle` from `src/scraper/articleScraper.ts`.
- [ ] Import `logger`.
- [ ] Inside the loop (after comment fetching, before persistence steps):
- [ ] Check if `story.articleUrl` exists and starts with `http`.
- [ ] If invalid/missing:
- [ ] Log warning message.
- [ ] Set `story.articleContent = null`.
- [ ] If valid:
- [ ] Log attempt message.
- [ ] Call `const scrapedContent = await scrapeArticle(story.articleUrl)`.
- [ ] Set `story.articleContent = scrapedContent`.
- [ ] Log success (if `scrapedContent` is not null) or failure (if `scrapedContent` is null).
- [ ] Add temporary logging or use debugger to verify `articleContent` property in story objects (AC5).
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Unit test the modified pipeline logic in `src/core/pipeline.ts`. [916]
- Mock the `scrapeArticle` function. [918]
- Provide mock `Story` objects with and without valid `articleUrl`s.
- Verify that `scrapeArticle` is called only for stories with valid URLs [251].
- Verify that the correct URL is passed to `scrapeArticle`.
- Verify that the return value (mocked text or mocked null) from `scrapeArticle` is correctly assigned to the `story.articleContent` property [253].
- Verify that appropriate logs (skip warning, attempt, success/fail) are called based on the URL validity and mocked `scrapeArticle` result [250, 252].
- **Integration Tests:** Less emphasis here; Story 3.4 provides better integration testing for scraping. [921]
- **Manual/CLI Verification:** [912]
- Run `npm run dev`.
- Check console logs for "Attempting to scrape...", "Successfully scraped...", "Failed to scrape...", and "Skipping scraping..." messages [250, 252].
- Use debugger or temporary logging to inspect `story.articleContent` values during or after the pipeline run [253].
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Integrated scraper call into pipeline. Updated Story type. Verified logic for handling valid/invalid URLs.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/3.3.story.md**
```markdown
# Story 3.3: Persist Scraped Article Text Locally
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage. [254]
**Context:** This story adds the persistence step for the article content scraped in Story 3.2. Following a successful scrape (where `story.articleContent` is not null), this logic writes the plain text content to a `.txt` file (`{storyId}_article.txt`) within the date-stamped output directory created in Epic 1. This ensures the scraped text is available for the next stage (Summarization - Epic 4) even if the main script is run in stages or needs to be restarted. No file should be created if scraping failed or was skipped. [49, 734, 735]
## Detailed Requirements
- Import Node.js `fs` (`writeFileSync`) and `path` modules if not already present in `src/core/pipeline.ts`. [255] Import logger.
- In the main workflow (`src/core/pipeline.ts`), within the loop processing each story, _after_ the scraping attempt (Story 3.2) is complete: [256]
- Check if `story.articleContent` is a non-null, non-empty string.
- If yes (scraping was successful and yielded content):
- Retrieve the full path to the current date-stamped output directory (available from setup). [256]
- Construct the filename: `{storyId}_article.txt`. [257]
- Construct the full file path using `path.join()`. [257]
- Get the successfully scraped article text string (`story.articleContent`). [258]
- Use `fs.writeFileSync(fullPath, story.articleContent, 'utf-8')` to save the text to the file. [259] Wrap this call in a `try...catch` block for file system errors. [260]
- Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered, using the logger. [260]
- If `story.articleContent` is null or empty (scraping skipped or failed), ensure _no_ `_article.txt` file is created for this story. [261]
## Acceptance Criteria (ACs)
- AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files _only_ for those stories where `scrapeArticle` (from Story 3.1) succeeded and returned non-empty text content during the pipeline run (Story 3.2). [262]
- AC2: The name of each article text file is `{storyId}_article.txt`. [263]
- AC3: The content of each existing `_article.txt` file is the plain text string stored in `story.articleContent`. [264]
- AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors. [265]
- AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful and returned content. [266]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Modify: `src/core/pipeline.ts`.
- _(Hint: See `docs/project-structure.md` [818])._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851].
- Native `fs` module (`writeFileSync`). [259]
- Native `path` module (`join`). [257]
- Uses `logger` (Story 1.4).
- Uses output directory path (from Story 1.4 logic).
- Uses `story.articleContent` populated in Story 3.2.
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- `fs.writeFileSync(fullPath, articleContentString, 'utf-8')`. [259]
- **Data Structures:**
- Checks `story.articleContent` (string | null).
- Defines output file format `{storyId}_article.txt` [541].
- _(Hint: See `docs/data-models.md` [506-517, 541])._
- **Environment Variables:**
- Relies on `OUTPUT_DIR_PATH` being available (from Story 1.2/1.4).
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Place the file writing logic immediately after the scraping result is known for a story.
- Use a clear `if (story.articleContent)` check. [256]
- Use `try...catch` around `fs.writeFileSync`. [260]
- Log success/failure clearly. [260]
## Tasks / Subtasks
- [ ] In `src/core/pipeline.ts`, ensure `fs` and `path` are imported. Ensure logger is imported.
- [ ] Ensure the output directory path is available within the story processing loop.
- [ ] Inside the loop, after `story.articleContent` is set (from Story 3.2):
- [ ] Add an `if (story.articleContent)` condition.
- [ ] Inside the `if` block:
- [ ] Construct filename: `{storyId}_article.txt`.
- [ ] Construct full path using `path.join`.
- [ ] Implement `try...catch`:
- [ ] `try`: Call `fs.writeFileSync(fullPath, story.articleContent, 'utf-8')`.
- [ ] `try`: Log success message.
- [ ] `catch`: Log error message.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** [915]
- Difficult to unit test filesystem writes effectively. Focus on testing the _conditional logic_ within the pipeline function. [918]
- Mock `fs.writeFileSync`. Provide mock `Story` objects where `articleContent` is sometimes a string and sometimes null.
- Verify `fs.writeFileSync` is called _only when_ `articleContent` is a non-empty string. [262]
- Verify it's called with the correct path (`path.join(outputDir, storyId + '_article.txt')`) and content (`story.articleContent`). [263, 264]
- **Integration Tests:** [921]
- Use `mock-fs` or temporary directory setup/teardown. [924]
- Run the pipeline segment responsible for scraping (mocked) and saving.
- Verify that `.txt` files are created only for stories where the mocked scraper returned text.
- Verify file contents match the mocked text.
- **Manual/CLI Verification:** [912]
- Run `npm run dev`.
- Inspect the `output/YYYY-MM-DD/` directory.
- Check which `{storyId}_article.txt` files exist. Compare this against the console logs indicating successful/failed scraping attempts for corresponding story IDs. Verify files only exist for successful scrapes (AC1, AC5).
- Check filenames are correct (AC2).
- Open a few existing `.txt` files and spot-check the content (AC3).
- Check logs for file saving success/error messages (AC4).
- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Added logic to save article text conditionally. Verified files are created only on successful scrape.}
- **Change Log:**
- Initial Draft
```
---
**File: ai/stories/3.4.story.md**
```markdown
# Story 3.4: Implement Stage Testing Utility for Scraping
**Status:** Draft
## Goal & Context
**User Story:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper. [267]
**Context:** This story implements the standalone stage testing utility for Epic 3, as required by the PRD [736, 764]. It creates `src/stages/scrape_articles.ts`, which reads story data (specifically URLs) from the `{storyId}_data.json` files generated in Epic 2 (or by `stage:fetch`), calls the `scrapeArticle` function (from Story 3.1) for each URL, and persists any successfully scraped text to `{storyId}_article.txt` files (replicating Story 3.3 logic). This allows testing the scraping functionality against real websites using previously fetched story lists, without running the full pipeline or the HN fetching stage. [57, 63, 820, 912, 930]
## Detailed Requirements
- Create a new standalone script file: `src/stages/scrape_articles.ts`. [268]
- Import necessary modules: `fs` (e.g., `readdirSync`, `readFileSync`, `writeFileSync`, `existsSync`, `statSync`), `path`, `logger` (Story 1.4), `config` (Story 1.2), `scrapeArticle` (Story 3.1), date util (Story 1.4). [269]
- The script should:
- Initialize the logger. [270]
- Load configuration (to get `OUTPUT_DIR_PATH`). [271]
- Determine the target date-stamped directory path (e.g., using current date via date util, or potentially allow override via CLI arg later - current date default is fine for now). [271] Ensure this base output directory exists. Log the target directory.
- Check if the target date-stamped directory exists. If not, log an error and exit ("Directory {path} not found. Run fetch stage first?").
- Read the directory contents and identify all files ending with `_data.json`. [272] Use `fs.readdirSync` and filter.
- For each `_data.json` file found:
- Construct the full path and read its content using `fs.readFileSync`. [273]
- Parse the JSON content. Handle potential parse errors gracefully (log error, skip file). [273]
- Extract the `storyId` and `articleUrl` from the parsed data. [274]
- If a valid `articleUrl` exists (starts with `http`): [274]
- Log the attempt: "Attempting scrape for story {storyId} from {url}...".
- Call `await scrapeArticle(articleUrl)`. [274]
- If scraping succeeds (returns a non-null string):
- Construct the output filename `{storyId}_article.txt`. [275]
- Construct the full output path. [275]
- Save the text to the file using `fs.writeFileSync` (replicating logic from Story 3.3, including try/catch and logging). [275] Overwrite if the file exists. [276]
- Log success outcome.
- If scraping fails (`scrapeArticle` returns null):
- Log failure outcome.
- If `articleUrl` is missing or invalid:
- Log skipping message.
- Log overall completion: "Scraping stage finished processing {N} data files.".
- Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. [277]
## Acceptance Criteria (ACs)
- AC1: The file `src/stages/scrape_articles.ts` exists. [279]
- AC2: The script `stage:scrape` is defined in `package.json`'s `scripts` section. [280]
- AC3: Running `npm run stage:scrape` (assuming a date-stamped directory with `_data.json` files exists from a previous fetch run) successfully reads these JSON files. [281]
- AC4: The script calls `scrapeArticle` for stories with valid `articleUrl`s found in the JSON files. [282]
- AC5: The script creates or updates `{storyId}_article.txt` files in the _same_ date-stamped directory, corresponding only to successfully scraped articles. [283]
- AC6: The script logs its actions (reading files, attempting scraping, skipping, saving results/failures) for each story ID processed based on the found `_data.json` files. [284]
- AC7: The script operates solely based on local `_data.json` files as input and fetching from external article URLs via `scrapeArticle`; it does not call the Algolia HN API client. [285, 286]
## Technical Implementation Context
**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
- **Relevant Files:**
- Files to Create: `src/stages/scrape_articles.ts`.
- Files to Modify: `package.json`.
- _(Hint: See `docs/project-structure.md` [820] for stage runner location)._
- **Key Technologies:**
- TypeScript [846], Node.js 22.x [851], `ts-node`.
- Native `fs` module (`readdirSync`, `readFileSync`, `writeFileSync`, `existsSync`, `statSync`). [269]
- Native `path` module. [269]
- Uses `logger` (Story 1.4), `config` (Story 1.2), date util (Story 1.4), `scrapeArticle` (Story 3.1), persistence logic (Story 3.3).
- _(Hint: See `docs/tech-stack.md` [839-905])._
- **API Interactions / SDK Usage:**
- Calls internal `scrapeArticle(url)`.
- Uses `fs` module extensively for reading directory, reading JSON, writing TXT.
- **Data Structures:**
- Reads JSON structure from `_data.json` files [538-540]. Extracts `storyId`, `articleUrl`.
- Creates `{storyId}_article.txt` files [541].
- _(Hint: See `docs/data-models.md`)._
- **Environment Variables:**
- Reads `OUTPUT_DIR_PATH` via `config.ts`. `scrapeArticle` might use others.
- _(Hint: See `docs/environment-vars.md` [548-638])._
- **Coding Standards Notes:**
- Structure script clearly (setup, read data files, loop, process/scrape/save).
- Use `async/await` for `scrapeArticle`.
- Implement robust error handling for file IO (reading dir, reading files, parsing JSON, writing files) using `try...catch` and logging.
- Use logger for detailed progress reporting. [284]
- Wrap main logic in an async IIFE or main function.
## Tasks / Subtasks
- [ ] Create `src/stages/scrape_articles.ts`.
- [ ] Add imports: `fs`, `path`, `logger`, `config`, `scrapeArticle`, date util.
- [ ] Implement setup: Init logger, load config, get output path, get target date-stamped path.
- [ ] Check if target date-stamped directory exists, log error and exit if not.
- [ ] Use `fs.readdirSync` to get list of files in the target directory.
- [ ] Filter the list to get only files ending in `_data.json`.
- [ ] Loop through the `_data.json` filenames:
- [ ] Construct full path for the JSON file.
- [ ] Use `try...catch` for reading and parsing the JSON file:
- [ ] `try`: Read file (`fs.readFileSync`). Parse JSON (`JSON.parse`).
- [ ] `catch`: Log error (read/parse), continue to next file.
- [ ] Extract `storyId` and `articleUrl`.
- [ ] Check if `articleUrl` is valid (starts with `http`).
- [ ] If valid:
- [ ] Log attempt.
- [ ] Call `content = await scrapeArticle(articleUrl)`.
- [ ] `if (content)`:
- [ ] Construct `.txt` output path.
- [ ] Use `try...catch` to write file (`fs.writeFileSync`). Log success/error.
- [ ] `else`: Log scrape failure.
- [ ] If URL invalid: Log skip.
- [ ] Log completion message.
- [ ] Add `"stage:scrape": "ts-node src/stages/scrape_articles.ts"` to `package.json`.
## Testing Requirements
**Guidance:** Verify implementation against the ACs using the following tests.
- **Unit Tests:** Difficult to unit test the entire script effectively due to heavy FS and orchestration logic. Focus on unit testing the core `scrapeArticle` module (Story 3.1) and utilities. [915]
- **Integration Tests:** N/A for the script itself. [921]
- **Manual/CLI Verification (Primary Test Method):** [912, 927, 930]
- Ensure `_data.json` files exist from `npm run stage:fetch` or `npm run dev`.
- Run `npm run stage:scrape`. [281]
- Verify successful execution.
- Check logs for reading files, skipping, attempting scrapes, success/failure messages, and saving messages [284].
- Inspect the `output/YYYY-MM-DD/` directory for newly created/updated `{storyId}_article.txt` files. Verify they correspond to stories where scraping succeeded according to logs [283, 285].
- Verify the script _only_ performed scraping actions based on local files (AC7).
- Modify `package.json` to add the script (AC2).
- _(Hint: See `docs/testing-strategy.md` [907-950] which identifies Stage Runners as a key part of Acceptance Testing)._
## Story Wrap Up (Agent Populates After Execution)
- **Agent Model Used:** `<Agent Model Name/Version>`
- **Completion Notes:** {Stage runner implemented. Reads \_data.json, calls scraper, saves \_article.txt conditionally. package.json updated.}
- **Change Log:**
- Initial Draft
```
---
## **End of Report for Epic 3**

View File

@@ -1,89 +0,0 @@
# Epic 1: Project Initialization & Core Setup
**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
## Story List
### Story 1.1: Initialize Project from Boilerplate
- **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
- **Detailed Requirements:**
- Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
- Initialize a git repository in the project root directory (if not already done by cloning).
- Ensure the `.gitignore` file from the boilerplate is present.
- Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
- Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
- **Acceptance Criteria (ACs):**
- AC1: The project directory contains the files and structure from `bmad-boilerplate`.
- AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
- AC3: `npm run lint` command completes successfully without reporting any linting errors.
- AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
- AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
- AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
- AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
---
### Story 1.2: Setup Environment Configuration
- **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
- **Detailed Requirements:**
- Verify the `.env.example` file exists (from boilerplate).
- Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
- Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
- Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
- The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
- Ensure the `.env` file is listed in `.gitignore` and is not committed.
- **Acceptance Criteria (ACs):**
- AC1: Handle `.env` files with native node 22 support, no need for `dotenv`
- AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
- AC3: The `.env` file exists locally but is NOT tracked by git.
- AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
- AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
---
### Story 1.3: Implement Basic CLI Entry Point & Execution
- **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
- **Detailed Requirements:**
- Create the main application entry point file at `src/index.ts`.
- Implement minimal code within `src/index.ts` to:
- Import the configuration loading mechanism (from Story 1.2).
- Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
- (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
- Confirm execution using boilerplate scripts.
- **Acceptance Criteria (ACs):**
- AC1: The `src/index.ts` file exists.
- AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
- AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
- AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
---
### Story 1.4: Setup Basic Logging and Output Directory
- **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
- **Detailed Requirements:**
- Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
- Refactor `src/index.ts` to use this `logger` for its startup message(s).
- In `src/index.ts` (or a setup function called by it):
- Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
- Determine the current date in 'YYYY-MM-DD' format.
- Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
- Check if the base output directory exists; if not, create it.
- Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
- Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
- **Acceptance Criteria (ACs):**
- AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
- AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
- AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
- AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
- AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
- AC6: The application exits gracefully after performing these setup steps (for now).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 1 | 2-pm |

View File

@@ -1,89 +0,0 @@
# Epic 1: Project Initialization & Core Setup
**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
## Story List
### Story 1.1: Initialize Project from Boilerplate
- **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
- **Detailed Requirements:**
- Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
- Initialize a git repository in the project root directory (if not already done by cloning).
- Ensure the `.gitignore` file from the boilerplate is present.
- Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
- Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
- **Acceptance Criteria (ACs):**
- AC1: The project directory contains the files and structure from `bmad-boilerplate`.
- AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
- AC3: `npm run lint` command completes successfully without reporting any linting errors.
- AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
- AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
- AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
- AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
---
### Story 1.2: Setup Environment Configuration
- **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
- **Detailed Requirements:**
- Verify the `.env.example` file exists (from boilerplate).
- Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
- Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
- Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
- The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
- Ensure the `.env` file is listed in `.gitignore` and is not committed.
- **Acceptance Criteria (ACs):**
- AC1: Handle `.env` files with native node 22 support, no need for `dotenv`
- AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
- AC3: The `.env` file exists locally but is NOT tracked by git.
- AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
- AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
---
### Story 1.3: Implement Basic CLI Entry Point & Execution
- **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
- **Detailed Requirements:**
- Create the main application entry point file at `src/index.ts`.
- Implement minimal code within `src/index.ts` to:
- Import the configuration loading mechanism (from Story 1.2).
- Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
- (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
- Confirm execution using boilerplate scripts.
- **Acceptance Criteria (ACs):**
- AC1: The `src/index.ts` file exists.
- AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
- AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
- AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
---
### Story 1.4: Setup Basic Logging and Output Directory
- **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
- **Detailed Requirements:**
- Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
- Refactor `src/index.ts` to use this `logger` for its startup message(s).
- In `src/index.ts` (or a setup function called by it):
- Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
- Determine the current date in 'YYYY-MM-DD' format.
- Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
- Check if the base output directory exists; if not, create it.
- Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
- Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
- **Acceptance Criteria (ACs):**
- AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
- AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
- AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
- AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
- AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
- AC6: The application exits gracefully after performing these setup steps (for now).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 1 | 2-pm |

View File

@@ -1,99 +0,0 @@
# Epic 2: HN Data Acquisition & Persistence
**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
## Story List
### Story 2.1: Implement Algolia HN API Client
- **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
- **Detailed Requirements:**
- Create a new module: `src/clients/algoliaHNClient.ts`.
- Implement an async function `WorkspaceTopStories` within the client:
- Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
- Parse the JSON response.
- Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
- Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
- Return an array of structured story objects.
- Implement a separate async function `WorkspaceCommentsForStory` within the client:
- Accept `storyId` and `maxComments` limit as arguments.
- Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
- Parse the JSON response.
- Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
- Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
- Return an array of structured comment objects.
- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
- Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
- **Acceptance Criteria (ACs):**
- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
- AC4: Both functions use the native `Workspace` API internally.
- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
- AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
---
### Story 2.2: Integrate HN Data Fetching into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts` (or a main async function called by it).
- Import the `algoliaHNClient` functions.
- Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
- After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
- Log the number of stories fetched.
- Iterate through the array of fetched `Story` objects.
- For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
- Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
- Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
- AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
- AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
---
### Story 2.3: Persist Fetched HN Data Locally
- **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
- **Detailed Requirements:**
- Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
- Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
- In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
- Get the full path to the date-stamped output directory (determined in Epic 1).
- Construct the filename for the story's data: `{storyId}_data.json`.
- Construct the full file path using `path.join()`.
- Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
- Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
- Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
---
### Story 2.4: Implement Stage Testing Utility for HN Fetching
- **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
- This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
- The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
- The script should log its progress using the logger utility.
- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/fetch_hn_data.ts` exists.
- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 2 | 2-pm |

View File

@@ -1,99 +0,0 @@
# Epic 2: HN Data Acquisition & Persistence
**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
## Story List
### Story 2.1: Implement Algolia HN API Client
- **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
- **Detailed Requirements:**
- Create a new module: `src/clients/algoliaHNClient.ts`.
- Implement an async function `WorkspaceTopStories` within the client:
- Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
- Parse the JSON response.
- Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
- Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
- Return an array of structured story objects.
- Implement a separate async function `WorkspaceCommentsForStory` within the client:
- Accept `storyId` and `maxComments` limit as arguments.
- Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
- Parse the JSON response.
- Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
- Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
- Return an array of structured comment objects.
- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
- Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
- **Acceptance Criteria (ACs):**
- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
- AC4: Both functions use the native `Workspace` API internally.
- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
- AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
---
### Story 2.2: Integrate HN Data Fetching into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts` (or a main async function called by it).
- Import the `algoliaHNClient` functions.
- Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
- After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
- Log the number of stories fetched.
- Iterate through the array of fetched `Story` objects.
- For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
- Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
- Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
- AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
- AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
---
### Story 2.3: Persist Fetched HN Data Locally
- **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
- **Detailed Requirements:**
- Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
- Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
- In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
- Get the full path to the date-stamped output directory (determined in Epic 1).
- Construct the filename for the story's data: `{storyId}_data.json`.
- Construct the full file path using `path.join()`.
- Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
- Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
- Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
---
### Story 2.4: Implement Stage Testing Utility for HN Fetching
- **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
- This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
- The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
- The script should log its progress using the logger utility.
- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/fetch_hn_data.ts` exists.
- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 2 | 2-pm |

View File

@@ -1,111 +0,0 @@
# Epic 3: Article Scraping & Persistence
**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
## Story List
### Story 3.1: Implement Basic Article Scraper Module
- **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
- **Detailed Requirements:**
- Create a new module: `src/scraper/articleScraper.ts`.
- Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
- Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
- Inside the function:
- Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
- Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
- Check the `response.ok` status. If not okay, log error and return `null`.
- Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
- If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
- Wrap the extraction logic in a `try...catch` to handle library-specific errors.
- Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
- Return `null` if extraction fails or results in empty content.
- Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
- Define TypeScript types/interfaces as needed.
- **Acceptance Criteria (ACs):**
- AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
- AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
- AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
- AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
- AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
- AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
- AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
---
### Story 3.2: Integrate Article Scraping into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
- Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
- Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
- If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
- If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
- Call `await scrapeArticle(story.url)`.
- Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
- Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
- AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
- AC3: For stories with valid URLs, the `scrapeArticle` function is called.
- AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
- AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
---
### Story 3.3: Persist Scraped Article Text Locally
- **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
- **Detailed Requirements:**
- Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
- In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
- Retrieve the full path to the current date-stamped output directory.
- Construct the filename: `{storyId}_article.txt`.
- Construct the full file path using `path.join()`.
- Get the successfully scraped article text string (`articleContent`).
- Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
- Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
- Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
- AC2: The name of each article text file is `{storyId}_article.txt`.
- AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
- AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
- AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
---
### Story 3.4: Implement Stage Testing Utility for Scraping
- **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/scrape_articles.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
- The script should:
- Initialize the logger.
- Load configuration (to get `OUTPUT_DIR_PATH`).
- Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
- Read the directory contents and identify all `{storyId}_data.json` files.
- For each `_data.json` file found:
- Read and parse the JSON content.
- Extract the `storyId` and `url`.
- If a valid `url` exists, call `await scrapeArticle(url)`.
- If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
- Log the progress and outcome (skip/success/fail) for each story processed.
- Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/scrape_articles.ts` exists.
- AC2: The script `stage:scrape` is defined in `package.json`.
- AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
- AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
- AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
- AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
- AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 3 | 2-pm |

View File

@@ -1,111 +0,0 @@
# Epic 3: Article Scraping & Persistence
**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
## Story List
### Story 3.1: Implement Basic Article Scraper Module
- **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
- **Detailed Requirements:**
- Create a new module: `src/scraper/articleScraper.ts`.
- Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
- Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
- Inside the function:
- Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
- Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
- Check the `response.ok` status. If not okay, log error and return `null`.
- Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
- If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
- Wrap the extraction logic in a `try...catch` to handle library-specific errors.
- Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
- Return `null` if extraction fails or results in empty content.
- Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
- Define TypeScript types/interfaces as needed.
- **Acceptance Criteria (ACs):**
- AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
- AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
- AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
- AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
- AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
- AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
- AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
---
### Story 3.2: Integrate Article Scraping into Main Workflow
- **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
- Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
- Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
- If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
- If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
- Call `await scrapeArticle(story.url)`.
- Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
- Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
- AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
- AC3: For stories with valid URLs, the `scrapeArticle` function is called.
- AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
- AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
---
### Story 3.3: Persist Scraped Article Text Locally
- **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
- **Detailed Requirements:**
- Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
- In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
- Retrieve the full path to the current date-stamped output directory.
- Construct the filename: `{storyId}_article.txt`.
- Construct the full file path using `path.join()`.
- Get the successfully scraped article text string (`articleContent`).
- Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
- Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
- Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
- AC2: The name of each article text file is `{storyId}_article.txt`.
- AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
- AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
- AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
---
### Story 3.4: Implement Stage Testing Utility for Scraping
- **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
- **Detailed Requirements:**
- Create a new standalone script file: `src/stages/scrape_articles.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
- The script should:
- Initialize the logger.
- Load configuration (to get `OUTPUT_DIR_PATH`).
- Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
- Read the directory contents and identify all `{storyId}_data.json` files.
- For each `_data.json` file found:
- Read and parse the JSON content.
- Extract the `storyId` and `url`.
- If a valid `url` exists, call `await scrapeArticle(url)`.
- If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
- Log the progress and outcome (skip/success/fail) for each story processed.
- Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/scrape_articles.ts` exists.
- AC2: The script `stage:scrape` is defined in `package.json`.
- AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
- AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
- AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
- AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
- AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 3 | 2-pm |

View File

@@ -1,146 +0,0 @@
# Epic 4: LLM Summarization & Persistence
**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
## Story List
### Story 4.1: Implement Ollama Client Module
- **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
- **Detailed Requirements:**
- **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
- Create a new module: `src/clients/ollamaClient.ts`.
- Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
- Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
- Inside `generateSummary`:
- Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
- Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
- Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
- Handle `Workspace` errors (network, timeout) using `try...catch`.
- Check `response.ok`. If not OK, log the status/error and return `null`.
- Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
- Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
- Return the extracted summary string on success. Return `null` on any failure.
- Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
- Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
- **Acceptance Criteria (ACs):**
- AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
- AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
- AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
- AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
- AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
* AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
* AC7: Logs provide visibility into the client's interaction with the Ollama API.
---
### Story 4.2: Define Summarization Prompts
* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
* **Detailed Requirements:**
* Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
* Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
* **Acceptance Criteria (ACs):**
* AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
---
### Story 4.3: Integrate Summarization into Main Workflow
* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
* **Detailed Requirements:**
* Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
* Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
* Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
* Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
* **Article Summary Generation:**
* Check if the `story` object has non-null `articleContent`.
* If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
* If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
* **Discussion Summary Generation:**
* Check if the `story` object has a non-empty `comments` array.
* If yes:
* Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
* **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
* Log "Attempting discussion summarization for story {storyId}".
* Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
* Store the result (string or null) as `story.discussionSummary`. Log success/failure.
* If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
* **Acceptance Criteria (ACs):**
* AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
* AC2: Article summary is attempted only if `articleContent` exists for a story.
* AC3: Discussion summary is attempted only if `comments` exist for a story.
* AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
* AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
* AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
---
### Story 4.4: Persist Generated Summaries Locally
*(No changes needed for this story based on recent decisions)*
- **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
- **Detailed Requirements:**
- Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
- Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
- In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
- Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
- Get the full path to the date-stamped output directory.
- Construct the filename: `{storyId}_summary.json`.
- Construct the full file path using `path.join()`.
- Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
- Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
- Log the successful saving of the summary file or any file writing errors.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
- AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
- AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
- AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
- AC5: A valid ISO timestamp is present in the `summarizedAt` field.
- AC6: Logs confirm successful writing of each summary file or report file system errors.
---
### Story 4.5: Implement Stage Testing Utility for Summarization
*(Changes needed to reflect prompt sourcing and optional truncation)*
* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
* **Detailed Requirements:**
* Create a new standalone script file: `src/stages/summarize_content.ts`.
* Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
* The script should:
* Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
* Determine target date-stamped directory path.
* Find all `{storyId}_data.json` files in the directory.
* For each `storyId` found:
* Read `{storyId}_data.json` to get comments. Format them into a single text block.
* *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
* Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
* **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
* Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
* Construct the summary result object (with summaries or nulls, and timestamp).
* Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
* Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
* Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
* **Acceptance Criteria (ACs):**
* AC1: The file `src/stages/summarize_content.ts` exists.
* AC2: The script `stage:summarize` is defined in `package.json`.
* AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
* AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
* AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
* AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
* AC8: The script does not call Algolia API or the article scraper module.
## Change Log
| Change | Date | Version | Description | Author |
| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
| Integrate prompts.md refs | 2025-05-04 | 0.3 | Updated stories 4.2, 4.3, 4.5 | 3-Architect |
| Added Ollama Prereq Note | 2025-05-04 | 0.2 | Added note about local Ollama setup | 2-pm |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 4 | 2-pm |

View File

@@ -1,146 +0,0 @@
# Epic 4: LLM Summarization & Persistence
**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
## Story List
### Story 4.1: Implement Ollama Client Module
- **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
- **Detailed Requirements:**
- **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
- Create a new module: `src/clients/ollamaClient.ts`.
- Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
- Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
- Inside `generateSummary`:
- Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
- Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
- Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
- Handle `Workspace` errors (network, timeout) using `try...catch`.
- Check `response.ok`. If not OK, log the status/error and return `null`.
- Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
- Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
- Return the extracted summary string on success. Return `null` on any failure.
- Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
- Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
- **Acceptance Criteria (ACs):**
- AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
- AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
- AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
- AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
- AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
* AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
* AC7: Logs provide visibility into the client's interaction with the Ollama API.
---
### Story 4.2: Define Summarization Prompts
* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
* **Detailed Requirements:**
* Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
* Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
* **Acceptance Criteria (ACs):**
* AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
* AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
---
### Story 4.3: Integrate Summarization into Main Workflow
* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
* **Detailed Requirements:**
* Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
* Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
* Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
* Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
* **Article Summary Generation:**
* Check if the `story` object has non-null `articleContent`.
* If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
* If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
* **Discussion Summary Generation:**
* Check if the `story` object has a non-empty `comments` array.
* If yes:
* Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
* **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
* Log "Attempting discussion summarization for story {storyId}".
* Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
* Store the result (string or null) as `story.discussionSummary`. Log success/failure.
* If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
* **Acceptance Criteria (ACs):**
* AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
* AC2: Article summary is attempted only if `articleContent` exists for a story.
* AC3: Discussion summary is attempted only if `comments` exist for a story.
* AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
* AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
* AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
---
### Story 4.4: Persist Generated Summaries Locally
*(No changes needed for this story based on recent decisions)*
- **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
- **Detailed Requirements:**
- Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
- Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
- In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
- Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
- Get the full path to the date-stamped output directory.
- Construct the filename: `{storyId}_summary.json`.
- Construct the full file path using `path.join()`.
- Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
- Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
- Log the successful saving of the summary file or any file writing errors.
- **Acceptance Criteria (ACs):**
- AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
- AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
- AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
- AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
- AC5: A valid ISO timestamp is present in the `summarizedAt` field.
- AC6: Logs confirm successful writing of each summary file or report file system errors.
---
### Story 4.5: Implement Stage Testing Utility for Summarization
*(Changes needed to reflect prompt sourcing and optional truncation)*
* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
* **Detailed Requirements:**
* Create a new standalone script file: `src/stages/summarize_content.ts`.
* Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
* The script should:
* Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
* Determine target date-stamped directory path.
* Find all `{storyId}_data.json` files in the directory.
* For each `storyId` found:
* Read `{storyId}_data.json` to get comments. Format them into a single text block.
* *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
* Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
* **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
* Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
* Construct the summary result object (with summaries or nulls, and timestamp).
* Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
* Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
* Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
* **Acceptance Criteria (ACs):**
* AC1: The file `src/stages/summarize_content.ts` exists.
* AC2: The script `stage:summarize` is defined in `package.json`.
* AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
* AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
* AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
* AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
* AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
* AC8: The script does not call Algolia API or the article scraper module.
## Change Log
| Change | Date | Version | Description | Author |
| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
| Integrate prompts.md refs | 2025-05-04 | 0.3 | Updated stories 4.2, 4.3, 4.5 | 3-Architect |
| Added Ollama Prereq Note | 2025-05-04 | 0.2 | Added note about local Ollama setup | 2-pm |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 4 | 2-pm |

View File

@@ -1,152 +0,0 @@
# Epic 5: Digest Assembly & Email Dispatch
**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
## Story List
### Story 5.1: Implement Email Content Assembler
- **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
- **Detailed Requirements:**
- Create a new module: `src/email/contentAssembler.ts`.
- Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
- Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
- The function should:
- Use Node.js `fs` to read the contents of the `dateDirPath`.
- Identify all files matching the pattern `{storyId}_data.json`.
- For each `storyId` found:
- Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
- Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
- Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
- Collect all successfully constructed `DigestData` objects into an array.
- Return the array. It should ideally contain 10 items if all previous stages succeeded.
- Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
- **Acceptance Criteria (ACs):**
- AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
- AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
- AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
- AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
- AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
---
### Story 5.2: Create HTML Email Template & Renderer
- **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
- **Detailed Requirements:**
- Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
- Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
- The function should generate an HTML string with:
- A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
- A loop through the `data` array.
- For each `story` in `data`:
- Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
- Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
- Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
- Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
- Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
- Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
- Return the complete HTML document as a string.
- **Acceptance Criteria (ACs):**
- AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
- AC2: The function returns a single, complete HTML string.
- AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
- AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
- AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
---
### Story 5.3: Implement Nodemailer Email Sender
- **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
- **Detailed Requirements:**
- Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
- Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
- Create a new module: `src/email/emailSender.ts`.
- Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
- Inside the function:
- Load the `EMAIL_*` variables from the config module.
- Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
- Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
- Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
- Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
- Call `await transporter.sendMail(mailOptions)`.
- If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
- If `sendMail` fails (throws error), log the error using the logger. Return `false`.
- **Acceptance Criteria (ACs):**
- AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
- AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
- AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
- AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
- AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
- AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
- AC7: Email sending success (including message ID) or failure is logged clearly.
- AC8: The function returns `true` on successful sending, `false` otherwise.
---
### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
- **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
- Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
- Log "Starting final digest assembly and email dispatch...".
- Determine the path to the current date-stamped output directory.
- Call `const digestData = await assembleDigestData(dateDirPath)`.
- Check if `digestData` array is not empty.
- If yes:
- Get the current date string (e.g., 'YYYY-MM-DD').
- `const htmlContent = renderDigestHtml(digestData, currentDate)`.
- `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
- `const emailSent = await sendDigestEmail(subject, htmlContent)`.
- Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
- If no (`digestData` is empty or assembly failed):
- Log an error: "Failed to assemble digest data or no data found. Skipping email."
- Log "BMad Hacker Daily Digest process finished."
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
- AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
- AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
- AC4: The final success or failure of the email sending step is logged.
- AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
- AC6: The application logs a final completion message.
---
### Story 5.5: Implement Stage Testing Utility for Emailing
- **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
- **Detailed Requirements:**
- Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
- Create a new standalone script file: `src/stages/send_digest.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
- Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
- The script should:
- Initialize logger, load config.
- Determine the target date-stamped directory path (from arg or default). Log the target directory.
- Call `await assembleDigestData(dateDirPath)`.
- If data is assembled and not empty:
- Determine the date string for the subject/title.
- Call `renderDigestHtml(digestData, dateString)` to get HTML.
- Construct the subject string.
- Check the `dryRun` flag:
- If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
- If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
- If data assembly fails or is empty, log the error.
- Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
- AC2: The script `stage:email` is defined in `package.json` allowing arguments.
- AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
- AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
- AC5: The script correctly identifies and acts upon the `--dry-run` flag.
- AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
- AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 5 | 2-pm |

View File

@@ -1,152 +0,0 @@
# Epic 5: Digest Assembly & Email Dispatch
**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
## Story List
### Story 5.1: Implement Email Content Assembler
- **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
- **Detailed Requirements:**
- Create a new module: `src/email/contentAssembler.ts`.
- Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
- Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
- The function should:
- Use Node.js `fs` to read the contents of the `dateDirPath`.
- Identify all files matching the pattern `{storyId}_data.json`.
- For each `storyId` found:
- Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
- Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
- Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
- Collect all successfully constructed `DigestData` objects into an array.
- Return the array. It should ideally contain 10 items if all previous stages succeeded.
- Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
- **Acceptance Criteria (ACs):**
- AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
- AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
- AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
- AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
- AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
---
### Story 5.2: Create HTML Email Template & Renderer
- **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
- **Detailed Requirements:**
- Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
- Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
- The function should generate an HTML string with:
- A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
- A loop through the `data` array.
- For each `story` in `data`:
- Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
- Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
- Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
- Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
- Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
- Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
- Return the complete HTML document as a string.
- **Acceptance Criteria (ACs):**
- AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
- AC2: The function returns a single, complete HTML string.
- AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
- AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
- AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
---
### Story 5.3: Implement Nodemailer Email Sender
- **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
- **Detailed Requirements:**
- Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
- Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
- Create a new module: `src/email/emailSender.ts`.
- Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
- Inside the function:
- Load the `EMAIL_*` variables from the config module.
- Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
- Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
- Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
- Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
- Call `await transporter.sendMail(mailOptions)`.
- If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
- If `sendMail` fails (throws error), log the error using the logger. Return `false`.
- **Acceptance Criteria (ACs):**
- AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
- AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
- AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
- AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
- AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
- AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
- AC7: Email sending success (including message ID) or failure is logged clearly.
- AC8: The function returns `true` on successful sending, `false` otherwise.
---
### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
- **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
- **Detailed Requirements:**
- Modify the main execution flow in `src/index.ts`.
- Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
- Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
- Log "Starting final digest assembly and email dispatch...".
- Determine the path to the current date-stamped output directory.
- Call `const digestData = await assembleDigestData(dateDirPath)`.
- Check if `digestData` array is not empty.
- If yes:
- Get the current date string (e.g., 'YYYY-MM-DD').
- `const htmlContent = renderDigestHtml(digestData, currentDate)`.
- `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
- `const emailSent = await sendDigestEmail(subject, htmlContent)`.
- Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
- If no (`digestData` is empty or assembly failed):
- Log an error: "Failed to assemble digest data or no data found. Skipping email."
- Log "BMad Hacker Daily Digest process finished."
- **Acceptance Criteria (ACs):**
- AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
- AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
- AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
- AC4: The final success or failure of the email sending step is logged.
- AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
- AC6: The application logs a final completion message.
---
### Story 5.5: Implement Stage Testing Utility for Emailing
- **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
- **Detailed Requirements:**
- Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
- Create a new standalone script file: `src/stages/send_digest.ts`.
- Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
- Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
- The script should:
- Initialize logger, load config.
- Determine the target date-stamped directory path (from arg or default). Log the target directory.
- Call `await assembleDigestData(dateDirPath)`.
- If data is assembled and not empty:
- Determine the date string for the subject/title.
- Call `renderDigestHtml(digestData, dateString)` to get HTML.
- Construct the subject string.
- Check the `dryRun` flag:
- If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
- If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
- If data assembly fails or is empty, log the error.
- Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
- **Acceptance Criteria (ACs):**
- AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
- AC2: The script `stage:email` is defined in `package.json` allowing arguments.
- AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
- AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
- AC5: The script correctly identifies and acts upon the `--dry-run` flag.
- AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
- AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------------------- | -------------- |
| Initial Draft | 2025-05-04 | 0.1 | First draft of Epic 5 | 2-pm |

View File

@@ -1,111 +0,0 @@
# Project Brief: BMad Hacker Daily Digest
## Introduction / Problem Statement
Hacker News (HN) comment threads contain valuable insights but can be prohibitively long to read thoroughly. The BMad Hacker Daily Digest project aims to solve this by providing a time-efficient way to stay informed about the collective intelligence within HN discussions. The service will automatically fetch the top 10 HN stories daily, retrieve a manageable subset of their comments using the Algolia HN API, generate concise summaries of both the linked article (when possible) and the comment discussion using an LLM, and deliver these summaries in a daily email briefing. This project also serves as a practical learning exercise focused on agent-driven development, TypeScript, Node.js backend services, API integration, and local LLM usage with Ollama.
## Vision & Goals
- **Vision:** To provide a quick, reliable, and automated way for users to stay informed about the key insights and discussions happening within the Hacker News community without needing to read lengthy comment threads.
- **Primary Goals (MVP - SMART):**
- **Fetch HN Story Data:** Successfully retrieve the IDs and metadata (title, URL, HN link) of the top 10 Hacker News stories using the Algolia HN Search API when triggered.
- **Retrieve Limited Comments:** For each fetched story, retrieve a predefined, limited set of associated comments using the Algolia HN Search API.
- **Attempt Article Scraping:** For each story's external URL, attempt to fetch the raw HTML and extract the main article text using basic methods (Node.js native fetch, article-extractor/Cheerio), handling failures gracefully.
- **Generate Summaries (LLM):** Using a local LLM (via Ollama, configured endpoint), generate: an "Article Summary" from scraped text (if successful), and a separate "Discussion Summary" from fetched comments.
- **Assemble & Send Digest (Manual Trigger):** Format results for 10 stories into a single HTML email and successfully send it to recipients (list defined in config) using Nodemailer when manually triggered via CLI.
- **Success Metrics (Initial Ideas for MVP):**
- **Successful Execution:** The entire process completes successfully without crashing when manually triggered via CLI for 3 different test runs.
- **Digest Content:** The generated email contains results for 10 stories (correct links, discussion summary, article summary where possible). Spot checks confirm relevance.
- **Error Handling:** Scraping failures are logged, and the process continues using only comment summaries for affected stories without halting the script.
## Target Audience / Users
**Primary User (MVP):** The developer undertaking this project. The primary motivation is learning and demonstrating agent-driven development, TypeScript, Node.js (v22), API integration (Algolia, LLM, Email), local LLMs (Ollama), and configuration management ( .env ). The key need is an interesting, achievable project scope utilizing these technologies.
**Secondary User (Potential):** Time-constrained HN readers/tech enthusiasts needing automated discussion summaries. Addressing their needs fully is outside MVP scope but informs potential future direction.
## Key Features / Scope (High-Level Ideas for MVP)
- Fetch Top HN Stories (Algolia API).
- Fetch Limited Comments (Algolia API).
- Local File Storage (Date-stamped folder, structured text/JSON files).
- Attempt Basic Article Scraping (Node.js v22 native fetch, basic extraction).
- Handle Scraping Failures (Log error, proceed with comment-only summary).
- Generate Summaries (Local Ollama via configured endpoint: Article Summary if scraped, Discussion Summary always).
- Format Digest Email (HTML: Article Summary (opt.), Discussion Summary, HN link, Article link).
- Manual Email Dispatch (Nodemailer, credentials from .env , recipient list from .env ).
- CLI Trigger (Manual command to run full process).
**Explicitly OUT of Scope for MVP:** Advanced scraping (JS render, anti-bot), processing _all_ comments/MapReduce summaries, automated scheduling (cron), database integration, cloud deployment/web frontend, user management (sign-ups etc.), production-grade error handling/monitoring/deliverability, fine-tuning LLM prompts, sophisticated retry logic.
## Known Technical Constraints or Preferences
- **Constraints/Preferences:**
- **Language/Runtime:** TypeScript running on Node.js v22.
- **Execution Environment:** Local machine execution for MVP.
- **Trigger Mechanism:** Manual CLI trigger only for MVP.
- **Configuration Management:** Use a `.env` file for configuration: LLM endpoint URL, email credentials, recipient email list, potentially comment fetch limits etc.
- **HTTP Requests:** Use Node.js v22 native fetch API (no Axios).
- **HN Data Source:** Algolia HN Search API.
- **Web Scraping:** Basic, best-effort only (native fetch + static HTML extraction). Must handle failures gracefully.
- **LLM Integration:** Local Ollama via configurable endpoint for MVP. Design for potential swap to cloud LLMs. Functionality over quality for MVP.
- **Summarization Strategy:** Separate Article/Discussion summaries. Limit comments processed per story (configurable). No MapReduce.
- **Data Storage:** Local file system (structured text/JSON in date-stamped folders). No database.
- **Email Delivery:** Nodemailer. Read credentials and recipient list from `.env`. Basic setup, no production deliverability focus.
- **Primary Goal Context:** Focus on functional pipeline for learning/demonstration.
- **Risks:**
- Algolia HN API Issues: Changes, rate limits, availability.
- Web Scraping Fragility: High likelihood of failure limiting Article Summaries.
- LLM Variability & Quality: Inconsistent performance/quality from local Ollama; potential errors.
*Incomplete Discussion Capture: Limited comment fetching may miss key insights.
*Email Configuration/Deliverability: Fragility of personal credentials; potential spam filtering.
*Manual Trigger Dependency: Digest only generated on manual execution.
*Configuration Errors: Incorrect `.env` settings could break the application.
_(User Note: Risks acknowledged and accepted given the project's learning goals.)_
## Relevant Research (Optional)
Feasibility: Core concept confirmed technically feasible with available APIs/libraries.
Existing Tools & Market Context: Similar tools exist (validating interest), but daily email format appears distinct.
API Selection: Algolia HN Search API chosen for filtering/sorting capabilities.
Identified Technical Challenges: Confirmed complexities of scraping and handling large comment volumes within LLM limits, informing MVP scope.
Local LLM Viability: Ollama confirmed as viable for local MVP development/testing, with potential for future swapping.
## PM Prompt
**PM Agent Handoff Prompt: BMad Hacker Daily Digest**
**Summary of Key Insights:**
This Project Brief outlines the "BMad Hacker Daily Digest," a command-line tool designed to provide daily email summaries of discussions from top Hacker News (HN) comment threads. The core problem is the time required to read lengthy but valuable HN discussions. The MVP aims to fetch the top 10 HN stories, retrieve a limited set of comments via the Algolia HN API, attempt basic scraping of linked articles (with fallback), generate separate summaries for articles (if scraped) and comments using a local LLM (Ollama), and email the digest to the developer using Nodemailer. This project primarily serves as a learning exercise and demonstration of agent-driven development in TypeScript.
**Areas Requiring Special Attention (for PRD):**
- **Comment Selection Logic:** Define the specific criteria for selecting the "limited set" of comments from Algolia (e.g., number of comments, recency, token count limit).
- **Basic Scraping Implementation:** Detail the exact steps for the basic article scraping attempt (libraries like Node.js native fetch, article-extractor/Cheerio), including specific error handling and the fallback mechanism.
- **LLM Prompting:** Define the precise prompts for generating the "Article Summary" and the "Discussion Summary" separately.
- **Email Formatting:** Specify the exact structure, layout, and content presentation within the daily HTML email digest.
- **CLI Interface:** Define the specific command(s), arguments, and expected output/feedback for the manual trigger.
- **Local File Structure:** Define the structure for storing intermediate data and logs in local text files within date-stamped folders.
**Development Context:**
This brief was developed through iterative discussion, starting from general app ideas and refining scope based on user interest (HN discussions) and technical feasibility for a learning/demo project. Key decisions include prioritizing comment summarization, using the Algolia HN API, starting with local execution (Ollama, Nodemailer), and including only a basic, best-effort scraping attempt in the MVP.
**Guidance on PRD Detail:**
- Focus detailed requirements and user stories on the core data pipeline: HN API Fetch -> Comment Selection -> Basic Scrape Attempt -> LLM Summarization (x2) -> Email Formatting/Sending -> CLI Trigger.
- Keep potential post-MVP enhancements (cloud deployment, frontend, database, advanced scraping, scheduling) as high-level future considerations.
- Technical implementation details for API/LLM interaction should allow flexibility for potential future swapping (e.g., Ollama to cloud LLM).
**User Preferences:**
- Execution: Manual CLI trigger for MVP.
- Data Storage: Local text files for MVP.
- LLM: Ollama for local development/MVP. Ability to potentially switch to cloud API later.
- Summaries: Generate separate summaries for article (if available) and comments.
- API: Use Algolia HN Search API.
- Email: Use Nodemailer for self-send in MVP.
- Tech Stack: TypeScript, Node.js v22.

View File

@@ -1,111 +0,0 @@
# Project Brief: BMad Hacker Daily Digest
## Introduction / Problem Statement
Hacker News (HN) comment threads contain valuable insights but can be prohibitively long to read thoroughly. The BMad Hacker Daily Digest project aims to solve this by providing a time-efficient way to stay informed about the collective intelligence within HN discussions. The service will automatically fetch the top 10 HN stories daily, retrieve a manageable subset of their comments using the Algolia HN API, generate concise summaries of both the linked article (when possible) and the comment discussion using an LLM, and deliver these summaries in a daily email briefing. This project also serves as a practical learning exercise focused on agent-driven development, TypeScript, Node.js backend services, API integration, and local LLM usage with Ollama.
## Vision & Goals
- **Vision:** To provide a quick, reliable, and automated way for users to stay informed about the key insights and discussions happening within the Hacker News community without needing to read lengthy comment threads.
- **Primary Goals (MVP - SMART):**
- **Fetch HN Story Data:** Successfully retrieve the IDs and metadata (title, URL, HN link) of the top 10 Hacker News stories using the Algolia HN Search API when triggered.
- **Retrieve Limited Comments:** For each fetched story, retrieve a predefined, limited set of associated comments using the Algolia HN Search API.
- **Attempt Article Scraping:** For each story's external URL, attempt to fetch the raw HTML and extract the main article text using basic methods (Node.js native fetch, article-extractor/Cheerio), handling failures gracefully.
- **Generate Summaries (LLM):** Using a local LLM (via Ollama, configured endpoint), generate: an "Article Summary" from scraped text (if successful), and a separate "Discussion Summary" from fetched comments.
- **Assemble & Send Digest (Manual Trigger):** Format results for 10 stories into a single HTML email and successfully send it to recipients (list defined in config) using Nodemailer when manually triggered via CLI.
- **Success Metrics (Initial Ideas for MVP):**
- **Successful Execution:** The entire process completes successfully without crashing when manually triggered via CLI for 3 different test runs.
- **Digest Content:** The generated email contains results for 10 stories (correct links, discussion summary, article summary where possible). Spot checks confirm relevance.
- **Error Handling:** Scraping failures are logged, and the process continues using only comment summaries for affected stories without halting the script.
## Target Audience / Users
**Primary User (MVP):** The developer undertaking this project. The primary motivation is learning and demonstrating agent-driven development, TypeScript, Node.js (v22), API integration (Algolia, LLM, Email), local LLMs (Ollama), and configuration management ( .env ). The key need is an interesting, achievable project scope utilizing these technologies.
**Secondary User (Potential):** Time-constrained HN readers/tech enthusiasts needing automated discussion summaries. Addressing their needs fully is outside MVP scope but informs potential future direction.
## Key Features / Scope (High-Level Ideas for MVP)
- Fetch Top HN Stories (Algolia API).
- Fetch Limited Comments (Algolia API).
- Local File Storage (Date-stamped folder, structured text/JSON files).
- Attempt Basic Article Scraping (Node.js v22 native fetch, basic extraction).
- Handle Scraping Failures (Log error, proceed with comment-only summary).
- Generate Summaries (Local Ollama via configured endpoint: Article Summary if scraped, Discussion Summary always).
- Format Digest Email (HTML: Article Summary (opt.), Discussion Summary, HN link, Article link).
- Manual Email Dispatch (Nodemailer, credentials from .env , recipient list from .env ).
- CLI Trigger (Manual command to run full process).
**Explicitly OUT of Scope for MVP:** Advanced scraping (JS render, anti-bot), processing _all_ comments/MapReduce summaries, automated scheduling (cron), database integration, cloud deployment/web frontend, user management (sign-ups etc.), production-grade error handling/monitoring/deliverability, fine-tuning LLM prompts, sophisticated retry logic.
## Known Technical Constraints or Preferences
- **Constraints/Preferences:**
- **Language/Runtime:** TypeScript running on Node.js v22.
- **Execution Environment:** Local machine execution for MVP.
- **Trigger Mechanism:** Manual CLI trigger only for MVP.
- **Configuration Management:** Use a `.env` file for configuration: LLM endpoint URL, email credentials, recipient email list, potentially comment fetch limits etc.
- **HTTP Requests:** Use Node.js v22 native fetch API (no Axios).
- **HN Data Source:** Algolia HN Search API.
- **Web Scraping:** Basic, best-effort only (native fetch + static HTML extraction). Must handle failures gracefully.
- **LLM Integration:** Local Ollama via configurable endpoint for MVP. Design for potential swap to cloud LLMs. Functionality over quality for MVP.
- **Summarization Strategy:** Separate Article/Discussion summaries. Limit comments processed per story (configurable). No MapReduce.
- **Data Storage:** Local file system (structured text/JSON in date-stamped folders). No database.
- **Email Delivery:** Nodemailer. Read credentials and recipient list from `.env`. Basic setup, no production deliverability focus.
- **Primary Goal Context:** Focus on functional pipeline for learning/demonstration.
- **Risks:**
- Algolia HN API Issues: Changes, rate limits, availability.
- Web Scraping Fragility: High likelihood of failure limiting Article Summaries.
- LLM Variability & Quality: Inconsistent performance/quality from local Ollama; potential errors.
*Incomplete Discussion Capture: Limited comment fetching may miss key insights.
*Email Configuration/Deliverability: Fragility of personal credentials; potential spam filtering.
*Manual Trigger Dependency: Digest only generated on manual execution.
*Configuration Errors: Incorrect `.env` settings could break the application.
_(User Note: Risks acknowledged and accepted given the project's learning goals.)_
## Relevant Research (Optional)
Feasibility: Core concept confirmed technically feasible with available APIs/libraries.
Existing Tools & Market Context: Similar tools exist (validating interest), but daily email format appears distinct.
API Selection: Algolia HN Search API chosen for filtering/sorting capabilities.
Identified Technical Challenges: Confirmed complexities of scraping and handling large comment volumes within LLM limits, informing MVP scope.
Local LLM Viability: Ollama confirmed as viable for local MVP development/testing, with potential for future swapping.
## PM Prompt
**PM Agent Handoff Prompt: BMad Hacker Daily Digest**
**Summary of Key Insights:**
This Project Brief outlines the "BMad Hacker Daily Digest," a command-line tool designed to provide daily email summaries of discussions from top Hacker News (HN) comment threads. The core problem is the time required to read lengthy but valuable HN discussions. The MVP aims to fetch the top 10 HN stories, retrieve a limited set of comments via the Algolia HN API, attempt basic scraping of linked articles (with fallback), generate separate summaries for articles (if scraped) and comments using a local LLM (Ollama), and email the digest to the developer using Nodemailer. This project primarily serves as a learning exercise and demonstration of agent-driven development in TypeScript.
**Areas Requiring Special Attention (for PRD):**
- **Comment Selection Logic:** Define the specific criteria for selecting the "limited set" of comments from Algolia (e.g., number of comments, recency, token count limit).
- **Basic Scraping Implementation:** Detail the exact steps for the basic article scraping attempt (libraries like Node.js native fetch, article-extractor/Cheerio), including specific error handling and the fallback mechanism.
- **LLM Prompting:** Define the precise prompts for generating the "Article Summary" and the "Discussion Summary" separately.
- **Email Formatting:** Specify the exact structure, layout, and content presentation within the daily HTML email digest.
- **CLI Interface:** Define the specific command(s), arguments, and expected output/feedback for the manual trigger.
- **Local File Structure:** Define the structure for storing intermediate data and logs in local text files within date-stamped folders.
**Development Context:**
This brief was developed through iterative discussion, starting from general app ideas and refining scope based on user interest (HN discussions) and technical feasibility for a learning/demo project. Key decisions include prioritizing comment summarization, using the Algolia HN API, starting with local execution (Ollama, Nodemailer), and including only a basic, best-effort scraping attempt in the MVP.
**Guidance on PRD Detail:**
- Focus detailed requirements and user stories on the core data pipeline: HN API Fetch -> Comment Selection -> Basic Scrape Attempt -> LLM Summarization (x2) -> Email Formatting/Sending -> CLI Trigger.
- Keep potential post-MVP enhancements (cloud deployment, frontend, database, advanced scraping, scheduling) as high-level future considerations.
- Technical implementation details for API/LLM interaction should allow flexibility for potential future swapping (e.g., Ollama to cloud LLM).
**User Preferences:**
- Execution: Manual CLI trigger for MVP.
- Data Storage: Local text files for MVP.
- LLM: Ollama for local development/MVP. Ability to potentially switch to cloud API later.
- Summaries: Generate separate summaries for article (if available) and comments.
- API: Use Algolia HN Search API.
- Email: Use Nodemailer for self-send in MVP.
- Tech Stack: TypeScript, Node.js v22.

View File

@@ -1,189 +0,0 @@
# BMad Hacker Daily Digest Product Requirements Document (PRD)
## Intro
The BMad Hacker Daily Digest is a command-line tool designed to address the time-consuming nature of reading extensive Hacker News (HN) comment threads. It aims to provide users with a time-efficient way to grasp the collective intelligence and key insights from discussions on top HN stories. The service will fetch the top 10 HN stories daily, retrieve a configurable number of comments for each, attempt to scrape the linked article, generate separate summaries for the article (if scraped) and the comment discussion using a local LLM, and deliver these summaries in a single daily email briefing triggered manually. This project also serves as a practical learning exercise in agent-driven development, TypeScript, Node.js, API integration, and local LLM usage, starting from the provided "bmad-boilerplate" template.
## Goals and Context
- **Project Objectives:**
- Provide a quick, reliable, automated way to stay informed about key HN discussions without reading full threads.
- Successfully fetch top 10 HN story metadata via Algolia HN API.
- Retrieve a _configurable_ number of comments per story (default 50) via Algolia HN API.
- Attempt basic scraping of linked article content, handling failures gracefully.
- Generate distinct Article Summaries (if scraped) and Discussion Summaries using a local LLM (Ollama).
- Assemble summaries for 10 stories into an HTML email and send via Nodemailer upon manual CLI trigger.
- Serve as a learning platform for agent-driven development, TypeScript, Node.js v22, API integration, local LLMs, and configuration management, leveraging the "bmad-boilerplate" structure and tooling.
- **Measurable Outcomes:**
- The tool completes its full process (fetch, scrape attempt, summarize, email) without crashing on manual CLI trigger across multiple test runs.
- The generated email digest consistently contains results for 10 stories, including correct links, discussion summaries, and article summaries where scraping was successful.
- Errors during article scraping are logged, and the process continues for affected stories using only comment summaries, without halting the script.
- **Success Criteria:**
- Successful execution of the end-to-end process via CLI trigger for 3 consecutive test runs.
- Generated email is successfully sent and received, containing summaries for all 10 fetched stories (article summary optional based on scraping success).
- Scraping failures are logged appropriately without stopping the overall process.
- **Key Performance Indicators (KPIs):**
- Successful Runs / Total Runs (Target: 100% for MVP tests)
- Stories with Article Summaries / Total Stories (Measures scraping effectiveness)
- Stories with Discussion Summaries / Total Stories (Target: 100%)
* Manual Qualitative Check: Relevance and coherence of summaries in the digest.
## Scope and Requirements (MVP / Current Version)
### Functional Requirements (High-Level)
- **HN Story Fetching:** Retrieve IDs and metadata (title, URL, HN link) for the top 10 stories from Algolia HN Search API.
- **HN Comment Fetching:** For each story, retrieve comments from Algolia HN Search API up to a maximum count defined in a `.env` configuration variable (`MAX_COMMENTS_PER_STORY`, default 50).
- **Article Content Scraping:** Attempt to fetch HTML and extract main text content from the story's external URL using basic methods (e.g., Node.js native fetch, optionally `article-extractor` or similar basic library).
- **Scraping Failure Handling:** If scraping fails, log the error and proceed with generating only the Discussion Summary for that story.
- **LLM Summarization:**
- Generate an "Article Summary" from scraped text (if successful) using a configured local LLM (Ollama endpoint).
- Generate a "Discussion Summary" from the fetched comments using the same LLM.
- Initial Prompts (Placeholders - refine in Epics):
- _Article Prompt:_ "Summarize the key points of the following article text: {Article Text}"
- _Discussion Prompt:_ "Summarize the main themes, viewpoints, and key insights from the following Hacker News comments: {Comment Texts}"
- **Digest Formatting:** Combine results for the 10 stories into a single HTML email. Each story entry should include: Story Title, HN Link, Article Link, Article Summary (if available), Discussion Summary.
- **Email Dispatch:** Send the formatted HTML email using Nodemailer to a recipient list defined in `.env`. Use credentials also stored in `.env`.
- **Main Execution Trigger:** Initiate the _entire implemented pipeline_ via a manual command-line interface (CLI) trigger, using the standard scripts defined in the boilerplate (`npm run dev`, `npm start` after build). Each functional epic should add its capability to this main execution flow.
- **Configuration:** Manage external parameters (Algolia API details (if needed), LLM endpoint URL, `MAX_COMMENTS_PER_STORY`, Nodemailer credentials, recipient email list, output directory path) via a `.env` file, based on the provided `.env.example`.
- **Incremental Logging & Data Persistence:**
- Implement basic console logging for key steps and errors throughout the pipeline.
- Persist intermediate data artifacts (fetched stories/comments, scraped text, generated summaries) to local files within a configurable, date-stamped directory structure (e.g., `./output/YYYY-MM-DD/`).
- This persistence should be implemented incrementally within the relevant functional epics (Data Acquisition, Scraping, Summarization).
- **Stage Testing Utilities:**
- Provide separate utility scripts or CLI commands to allow testing individual pipeline stages in isolation (e.g., fetching HN data, scraping URLs, summarizing text, sending email).
- These utilities should support using locally saved files as input (e.g., test scraping using a file containing story URLs, test summarization using a file containing text). This facilitates development and debugging.
### Non-Functional Requirements (NFRs)
- **Performance:** MVP focuses on functionality over speed. Should complete within a reasonable time (e.g., < 5 minutes) on a typical developer machine for local LLM use. No specific response time targets.
- **Scalability:** Designed for single-user, local execution. No scaling requirements for MVP.
- **Reliability/Availability:**
- The script must handle article scraping failures gracefully (log and continue).
- Basic error handling for API calls (e.g., log network errors).
- Local LLM interaction may fail; basic error logging is sufficient for MVP.
- No requirement for automated retries or production-grade error handling.
- **Security:**
- Email credentials must be stored securely via `.env` file and not committed to version control (as per boilerplate `.gitignore`).
- No other specific security requirements for local MVP.
- **Maintainability:**
- Code should be well-structured TypeScript.
- Adherence to the linting (ESLint) and formatting (Prettier) rules configured in the "bmad-boilerplate" is required. Use `npm run lint` and `npm run format`.
- Modularity is desired to potentially swap LLM providers later and facilitate stage testing.
- **Usability/Accessibility:** N/A (CLI tool for developer).
- **Other Constraints:**
- Must use TypeScript and Node.js v22.
- Must run locally on the developer's machine.
- Must use Node.js v22 native `Workspace` API for HTTP requests.
- Must use Algolia HN Search API for HN data.
- Must use a local Ollama instance via a configurable HTTP endpoint.
- Must use Nodemailer for email dispatch.
- Must use `.env` for configuration based on `.env.example`.
- Must use local file system for logging and intermediate data storage. Ensure output/log directories are gitignored.
- Focus on a functional pipeline for learning/demonstration.
### User Experience (UX) Requirements (High-Level)
- The primary UX goal is to deliver a time-saving digest.
- For the developer user, the main CLI interaction should be simple: using standard boilerplate scripts like `npm run dev` or `npm start` to trigger the full process.
- Feedback during CLI execution (e.g., "Fetching stories...", "Summarizing story X/10...", "Sending email...") is desirable via console logging.
- Separate CLI commands/scripts for testing individual stages should provide clear input/output mechanisms.
### Integration Requirements (High-Level)
- **Algolia HN Search API:** Fetching top stories and comments. Requires understanding API structure and query parameters.
- **Ollama Service:** Sending text (article content, comments) and receiving summaries via its API endpoint. Endpoint URL must be configurable.
- **SMTP Service (via Nodemailer):** Sending the final digest email. Requires valid SMTP credentials and recipient list configured in `.env`.
### Testing Requirements (High-Level)
- MVP success relies on manual end-to-end test runs confirming successful execution and valid email output.
- Unit/integration tests are encouraged using the **Jest framework configured in the boilerplate**. Focus testing effort on the core pipeline components. Use `npm run test`.
- **Stage-specific testing utilities (as defined in Functional Requirements) are required** to support development and verification of individual pipeline components.
## Epic Overview (MVP / Current Version)
_(Revised proposal)_
- **Epic 1: Project Initialization & Core Setup** - Goal: Initialize the project using "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure.
- **Epic 2: HN Data Acquisition & Persistence** - Goal: Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally. Implement stage testing utility for fetching.
- **Epic 3: Article Scraping & Persistence** - Goal: Implement best-effort article scraping/extraction, handle failures gracefully, and persist scraped text locally. Implement stage testing utility for scraping.
- **Epic 4: LLM Summarization & Persistence** - Goal: Integrate with Ollama to generate article/discussion summaries from persisted data and persist summaries locally. Implement stage testing utility for summarization.
- **Epic 5: Digest Assembly & Email Dispatch** - Goal: Format collected summaries into an HTML email using persisted data and send it using Nodemailer. Implement stage testing utility for emailing (with dry-run option).
## Key Reference Documents
- `docs/project-brief.md`
- `docs/prd.md` (This document)
- `docs/architecture.md` (To be created by Architect)
- `docs/epic1.md`, `docs/epic2.md`, ... (To be created)
- `docs/tech-stack.md` (Partially defined by boilerplate, to be finalized by Architect)
- `docs/api-reference.md` (If needed for Algolia/Ollama details)
- `docs/testing-strategy.md` (Optional - low priority for MVP, Jest setup provided)
## Post-MVP / Future Enhancements
- Advanced scraping techniques (handling JavaScript, anti-bot measures).
- Processing all comments (potentially using MapReduce summarization).
- Automated scheduling (e.g., using cron).
- Database integration for storing results or tracking.
- Cloud deployment and web frontend.
- User management (sign-ups, preferences).
- Production-grade error handling, monitoring, and email deliverability.
- Fine-tuning LLM prompts or models.
- Sophisticated retry logic for API calls or scraping.
- Cloud LLM integration.
## Change Log
| Change | Date | Version | Description | Author |
| ----------------------- | ---------- | ------- | --------------------------------------- | ------ |
| Refined Epics & Testing | 2025-05-04 | 0.3 | Removed Epic 6, added stage testing req | 2-pm |
| Boilerplate Added | 2025-05-04 | 0.2 | Updated to reflect use of boilerplate | 2-pm |
| Initial Draft | 2025-05-04 | 0.1 | First draft based on brief | 2-pm |
## Initial Architect Prompt
### Technical Infrastructure
- **Starter Project/Template:** **Mandatory: Use the provided "bmad-boilerplate".** This includes TypeScript setup, Node.js v22 compatibility, Jest, ESLint, Prettier, `ts-node`, `.env` handling via `.env.example`, and standard scripts (`dev`, `build`, `test`, `lint`, `format`).
- **Hosting/Cloud Provider:** Local machine execution only for MVP. No cloud deployment.
- **Frontend Platform:** N/A (CLI tool).
- **Backend Platform:** Node.js v22 with TypeScript (as provided by the boilerplate). No specific Node.js framework mandated, but structure should support modularity and align with boilerplate setup.
- **Database Requirements:** None. Local file system for intermediate data storage and logging only. Structure TBD (e.g., `./output/YYYY-MM-DD/`). Ensure output directory is configurable via `.env` and gitignored.
### Technical Constraints
- Must adhere to the structure and tooling provided by "bmad-boilerplate".
- Must use Node.js v22 native `Workspace` for HTTP requests.
- Must use the Algolia HN Search API for fetching HN data.
- Must integrate with a local Ollama instance via a configurable HTTP endpoint. Design should allow potential swapping to other LLM APIs later.
- Must use Nodemailer for sending email.
- Configuration (LLM endpoint, email credentials, recipients, `MAX_COMMENTS_PER_STORY`, output dir path) must be managed via a `.env` file based on `.env.example`.
- Article scraping must be basic, best-effort, and handle failures gracefully without stopping the main process.
- Intermediate data must be persisted locally incrementally.
- Code must adhere to the ESLint and Prettier configurations within the boilerplate.
### Deployment Considerations
- Execution is manual via CLI trigger only, using `npm run dev` or `npm start`.
- No CI/CD required for MVP.
- Single environment: local development machine.
### Local Development & Testing Requirements
- The entire application runs locally.
- The main CLI command (`npm run dev`/`start`) should execute the _full implemented pipeline_.
- **Separate utility scripts/commands MUST be provided** for testing individual pipeline stages (fetch, scrape, summarize, email) potentially using local file I/O. Architecture should facilitate creating these stage runners. (e.g., `npm run stage:fetch`, `npm run stage:scrape -- --inputFile <path>`, `npm run stage:summarize -- --inputFile <path>`, `npm run stage:email -- --inputFile <path> [--dry-run]`).
- The boilerplate provides `npm run test` using Jest for running automated unit/integration tests.
- The boilerplate provides `npm run lint` and `npm run format` for code quality checks.
- Basic console logging is required. File logging can be considered by the architect.
- Testability of individual modules (API clients, scraper, summarizer, emailer) is crucial and should leverage the Jest setup and stage testing utilities.
### Other Technical Considerations
- **Modularity:** Design components (HN client, scraper, LLM client, emailer) with clear interfaces to facilitate potential future modifications (e.g., changing LLM provider) and independent stage testing.
- **Error Handling:** Focus on robust handling of scraping failures and basic handling of API/network errors. Implement within the boilerplate structure. Logging should clearly indicate errors.
- **Resource Management:** Be mindful of local resources when interacting with the LLM, although optimization is not a primary MVP goal.
- **Dependency Management:** Add necessary production dependencies (e.g., `nodemailer`, potentially `article-extractor`, libraries for date handling or file system operations if needed) to the boilerplate's `package.json`. Keep dependencies minimal.
- **Configuration Loading:** Implement a robust way to load and validate settings from the `.env` file early in the application startup.

View File

@@ -1,189 +0,0 @@
# BMad Hacker Daily Digest Product Requirements Document (PRD)
## Intro
The BMad Hacker Daily Digest is a command-line tool designed to address the time-consuming nature of reading extensive Hacker News (HN) comment threads. It aims to provide users with a time-efficient way to grasp the collective intelligence and key insights from discussions on top HN stories. The service will fetch the top 10 HN stories daily, retrieve a configurable number of comments for each, attempt to scrape the linked article, generate separate summaries for the article (if scraped) and the comment discussion using a local LLM, and deliver these summaries in a single daily email briefing triggered manually. This project also serves as a practical learning exercise in agent-driven development, TypeScript, Node.js, API integration, and local LLM usage, starting from the provided "bmad-boilerplate" template.
## Goals and Context
- **Project Objectives:**
- Provide a quick, reliable, automated way to stay informed about key HN discussions without reading full threads.
- Successfully fetch top 10 HN story metadata via Algolia HN API.
- Retrieve a _configurable_ number of comments per story (default 50) via Algolia HN API.
- Attempt basic scraping of linked article content, handling failures gracefully.
- Generate distinct Article Summaries (if scraped) and Discussion Summaries using a local LLM (Ollama).
- Assemble summaries for 10 stories into an HTML email and send via Nodemailer upon manual CLI trigger.
- Serve as a learning platform for agent-driven development, TypeScript, Node.js v22, API integration, local LLMs, and configuration management, leveraging the "bmad-boilerplate" structure and tooling.
- **Measurable Outcomes:**
- The tool completes its full process (fetch, scrape attempt, summarize, email) without crashing on manual CLI trigger across multiple test runs.
- The generated email digest consistently contains results for 10 stories, including correct links, discussion summaries, and article summaries where scraping was successful.
- Errors during article scraping are logged, and the process continues for affected stories using only comment summaries, without halting the script.
- **Success Criteria:**
- Successful execution of the end-to-end process via CLI trigger for 3 consecutive test runs.
- Generated email is successfully sent and received, containing summaries for all 10 fetched stories (article summary optional based on scraping success).
- Scraping failures are logged appropriately without stopping the overall process.
- **Key Performance Indicators (KPIs):**
- Successful Runs / Total Runs (Target: 100% for MVP tests)
- Stories with Article Summaries / Total Stories (Measures scraping effectiveness)
- Stories with Discussion Summaries / Total Stories (Target: 100%)
* Manual Qualitative Check: Relevance and coherence of summaries in the digest.
## Scope and Requirements (MVP / Current Version)
### Functional Requirements (High-Level)
- **HN Story Fetching:** Retrieve IDs and metadata (title, URL, HN link) for the top 10 stories from Algolia HN Search API.
- **HN Comment Fetching:** For each story, retrieve comments from Algolia HN Search API up to a maximum count defined in a `.env` configuration variable (`MAX_COMMENTS_PER_STORY`, default 50).
- **Article Content Scraping:** Attempt to fetch HTML and extract main text content from the story's external URL using basic methods (e.g., Node.js native fetch, optionally `article-extractor` or similar basic library).
- **Scraping Failure Handling:** If scraping fails, log the error and proceed with generating only the Discussion Summary for that story.
- **LLM Summarization:**
- Generate an "Article Summary" from scraped text (if successful) using a configured local LLM (Ollama endpoint).
- Generate a "Discussion Summary" from the fetched comments using the same LLM.
- Initial Prompts (Placeholders - refine in Epics):
- _Article Prompt:_ "Summarize the key points of the following article text: {Article Text}"
- _Discussion Prompt:_ "Summarize the main themes, viewpoints, and key insights from the following Hacker News comments: {Comment Texts}"
- **Digest Formatting:** Combine results for the 10 stories into a single HTML email. Each story entry should include: Story Title, HN Link, Article Link, Article Summary (if available), Discussion Summary.
- **Email Dispatch:** Send the formatted HTML email using Nodemailer to a recipient list defined in `.env`. Use credentials also stored in `.env`.
- **Main Execution Trigger:** Initiate the _entire implemented pipeline_ via a manual command-line interface (CLI) trigger, using the standard scripts defined in the boilerplate (`npm run dev`, `npm start` after build). Each functional epic should add its capability to this main execution flow.
- **Configuration:** Manage external parameters (Algolia API details (if needed), LLM endpoint URL, `MAX_COMMENTS_PER_STORY`, Nodemailer credentials, recipient email list, output directory path) via a `.env` file, based on the provided `.env.example`.
- **Incremental Logging & Data Persistence:**
- Implement basic console logging for key steps and errors throughout the pipeline.
- Persist intermediate data artifacts (fetched stories/comments, scraped text, generated summaries) to local files within a configurable, date-stamped directory structure (e.g., `./output/YYYY-MM-DD/`).
- This persistence should be implemented incrementally within the relevant functional epics (Data Acquisition, Scraping, Summarization).
- **Stage Testing Utilities:**
- Provide separate utility scripts or CLI commands to allow testing individual pipeline stages in isolation (e.g., fetching HN data, scraping URLs, summarizing text, sending email).
- These utilities should support using locally saved files as input (e.g., test scraping using a file containing story URLs, test summarization using a file containing text). This facilitates development and debugging.
### Non-Functional Requirements (NFRs)
- **Performance:** MVP focuses on functionality over speed. Should complete within a reasonable time (e.g., < 5 minutes) on a typical developer machine for local LLM use. No specific response time targets.
- **Scalability:** Designed for single-user, local execution. No scaling requirements for MVP.
- **Reliability/Availability:**
- The script must handle article scraping failures gracefully (log and continue).
- Basic error handling for API calls (e.g., log network errors).
- Local LLM interaction may fail; basic error logging is sufficient for MVP.
- No requirement for automated retries or production-grade error handling.
- **Security:**
- Email credentials must be stored securely via `.env` file and not committed to version control (as per boilerplate `.gitignore`).
- No other specific security requirements for local MVP.
- **Maintainability:**
- Code should be well-structured TypeScript.
- Adherence to the linting (ESLint) and formatting (Prettier) rules configured in the "bmad-boilerplate" is required. Use `npm run lint` and `npm run format`.
- Modularity is desired to potentially swap LLM providers later and facilitate stage testing.
- **Usability/Accessibility:** N/A (CLI tool for developer).
- **Other Constraints:**
- Must use TypeScript and Node.js v22.
- Must run locally on the developer's machine.
- Must use Node.js v22 native `Workspace` API for HTTP requests.
- Must use Algolia HN Search API for HN data.
- Must use a local Ollama instance via a configurable HTTP endpoint.
- Must use Nodemailer for email dispatch.
- Must use `.env` for configuration based on `.env.example`.
- Must use local file system for logging and intermediate data storage. Ensure output/log directories are gitignored.
- Focus on a functional pipeline for learning/demonstration.
### User Experience (UX) Requirements (High-Level)
- The primary UX goal is to deliver a time-saving digest.
- For the developer user, the main CLI interaction should be simple: using standard boilerplate scripts like `npm run dev` or `npm start` to trigger the full process.
- Feedback during CLI execution (e.g., "Fetching stories...", "Summarizing story X/10...", "Sending email...") is desirable via console logging.
- Separate CLI commands/scripts for testing individual stages should provide clear input/output mechanisms.
### Integration Requirements (High-Level)
- **Algolia HN Search API:** Fetching top stories and comments. Requires understanding API structure and query parameters.
- **Ollama Service:** Sending text (article content, comments) and receiving summaries via its API endpoint. Endpoint URL must be configurable.
- **SMTP Service (via Nodemailer):** Sending the final digest email. Requires valid SMTP credentials and recipient list configured in `.env`.
### Testing Requirements (High-Level)
- MVP success relies on manual end-to-end test runs confirming successful execution and valid email output.
- Unit/integration tests are encouraged using the **Jest framework configured in the boilerplate**. Focus testing effort on the core pipeline components. Use `npm run test`.
- **Stage-specific testing utilities (as defined in Functional Requirements) are required** to support development and verification of individual pipeline components.
## Epic Overview (MVP / Current Version)
_(Revised proposal)_
- **Epic 1: Project Initialization & Core Setup** - Goal: Initialize the project using "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure.
- **Epic 2: HN Data Acquisition & Persistence** - Goal: Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally. Implement stage testing utility for fetching.
- **Epic 3: Article Scraping & Persistence** - Goal: Implement best-effort article scraping/extraction, handle failures gracefully, and persist scraped text locally. Implement stage testing utility for scraping.
- **Epic 4: LLM Summarization & Persistence** - Goal: Integrate with Ollama to generate article/discussion summaries from persisted data and persist summaries locally. Implement stage testing utility for summarization.
- **Epic 5: Digest Assembly & Email Dispatch** - Goal: Format collected summaries into an HTML email using persisted data and send it using Nodemailer. Implement stage testing utility for emailing (with dry-run option).
## Key Reference Documents
- `docs/project-brief.md`
- `docs/prd.md` (This document)
- `docs/architecture.md` (To be created by Architect)
- `docs/epic1.md`, `docs/epic2.md`, ... (To be created)
- `docs/tech-stack.md` (Partially defined by boilerplate, to be finalized by Architect)
- `docs/api-reference.md` (If needed for Algolia/Ollama details)
- `docs/testing-strategy.md` (Optional - low priority for MVP, Jest setup provided)
## Post-MVP / Future Enhancements
- Advanced scraping techniques (handling JavaScript, anti-bot measures).
- Processing all comments (potentially using MapReduce summarization).
- Automated scheduling (e.g., using cron).
- Database integration for storing results or tracking.
- Cloud deployment and web frontend.
- User management (sign-ups, preferences).
- Production-grade error handling, monitoring, and email deliverability.
- Fine-tuning LLM prompts or models.
- Sophisticated retry logic for API calls or scraping.
- Cloud LLM integration.
## Change Log
| Change | Date | Version | Description | Author |
| ----------------------- | ---------- | ------- | --------------------------------------- | ------ |
| Refined Epics & Testing | 2025-05-04 | 0.3 | Removed Epic 6, added stage testing req | 2-pm |
| Boilerplate Added | 2025-05-04 | 0.2 | Updated to reflect use of boilerplate | 2-pm |
| Initial Draft | 2025-05-04 | 0.1 | First draft based on brief | 2-pm |
## Initial Architect Prompt
### Technical Infrastructure
- **Starter Project/Template:** **Mandatory: Use the provided "bmad-boilerplate".** This includes TypeScript setup, Node.js v22 compatibility, Jest, ESLint, Prettier, `ts-node`, `.env` handling via `.env.example`, and standard scripts (`dev`, `build`, `test`, `lint`, `format`).
- **Hosting/Cloud Provider:** Local machine execution only for MVP. No cloud deployment.
- **Frontend Platform:** N/A (CLI tool).
- **Backend Platform:** Node.js v22 with TypeScript (as provided by the boilerplate). No specific Node.js framework mandated, but structure should support modularity and align with boilerplate setup.
- **Database Requirements:** None. Local file system for intermediate data storage and logging only. Structure TBD (e.g., `./output/YYYY-MM-DD/`). Ensure output directory is configurable via `.env` and gitignored.
### Technical Constraints
- Must adhere to the structure and tooling provided by "bmad-boilerplate".
- Must use Node.js v22 native `Workspace` for HTTP requests.
- Must use the Algolia HN Search API for fetching HN data.
- Must integrate with a local Ollama instance via a configurable HTTP endpoint. Design should allow potential swapping to other LLM APIs later.
- Must use Nodemailer for sending email.
- Configuration (LLM endpoint, email credentials, recipients, `MAX_COMMENTS_PER_STORY`, output dir path) must be managed via a `.env` file based on `.env.example`.
- Article scraping must be basic, best-effort, and handle failures gracefully without stopping the main process.
- Intermediate data must be persisted locally incrementally.
- Code must adhere to the ESLint and Prettier configurations within the boilerplate.
### Deployment Considerations
- Execution is manual via CLI trigger only, using `npm run dev` or `npm start`.
- No CI/CD required for MVP.
- Single environment: local development machine.
### Local Development & Testing Requirements
- The entire application runs locally.
- The main CLI command (`npm run dev`/`start`) should execute the _full implemented pipeline_.
- **Separate utility scripts/commands MUST be provided** for testing individual pipeline stages (fetch, scrape, summarize, email) potentially using local file I/O. Architecture should facilitate creating these stage runners. (e.g., `npm run stage:fetch`, `npm run stage:scrape -- --inputFile <path>`, `npm run stage:summarize -- --inputFile <path>`, `npm run stage:email -- --inputFile <path> [--dry-run]`).
- The boilerplate provides `npm run test` using Jest for running automated unit/integration tests.
- The boilerplate provides `npm run lint` and `npm run format` for code quality checks.
- Basic console logging is required. File logging can be considered by the architect.
- Testability of individual modules (API clients, scraper, summarizer, emailer) is crucial and should leverage the Jest setup and stage testing utilities.
### Other Technical Considerations
- **Modularity:** Design components (HN client, scraper, LLM client, emailer) with clear interfaces to facilitate potential future modifications (e.g., changing LLM provider) and independent stage testing.
- **Error Handling:** Focus on robust handling of scraping failures and basic handling of API/network errors. Implement within the boilerplate structure. Logging should clearly indicate errors.
- **Resource Management:** Be mindful of local resources when interacting with the LLM, although optimization is not a primary MVP goal.
- **Dependency Management:** Add necessary production dependencies (e.g., `nodemailer`, potentially `article-extractor`, libraries for date handling or file system operations if needed) to the boilerplate's `package.json`. Keep dependencies minimal.
- **Configuration Loading:** Implement a robust way to load and validate settings from the `.env` file early in the application startup.

View File

@@ -1,91 +0,0 @@
# BMad Hacker Daily Digest Project Structure
This document outlines the standard directory and file structure for the project. Adhering to this structure ensures consistency and maintainability.
```plaintext
bmad-hacker-daily-digest/
├── .github/ # Optional: GitHub Actions workflows (if used)
│ └── workflows/
├── .vscode/ # Optional: VSCode editor settings
│ └── settings.json
├── dist/ # Compiled JavaScript output (from 'npm run build', git-ignored)
├── docs/ # Project documentation (PRD, Architecture, Epics, etc.)
│ ├── architecture.md
│ ├── tech-stack.md
│ ├── project-structure.md # This file
│ ├── data-models.md
│ ├── api-reference.md
│ ├── environment-vars.md
│ ├── coding-standards.md
│ ├── testing-strategy.md
│ ├── prd.md # Product Requirements Document
│ ├── epic1.md .. epic5.md # Epic details
│ └── ...
├── node_modules/ # Project dependencies (managed by npm, git-ignored)
├── output/ # Default directory for data artifacts (git-ignored)
│ └── YYYY-MM-DD/ # Date-stamped subdirectories for runs
│ ├── {storyId}_data.json
│ ├── {storyId}_article.txt
│ └── {storyId}_summary.json
├── src/ # Application source code
│ ├── clients/ # Clients for interacting with external services
│ │ ├── algoliaHNClient.ts # Algolia HN Search API interaction logic [Epic 2]
│ │ └── ollamaClient.ts # Ollama API interaction logic [Epic 4]
│ ├── core/ # Core application logic & orchestration
│ │ └── pipeline.ts # Main pipeline execution flow (fetch->scrape->summarize->email)
│ ├── email/ # Email assembly, templating, and sending logic [Epic 5]
│ │ ├── contentAssembler.ts # Reads local files, prepares digest data
│ │ ├── emailSender.ts # Sends email via Nodemailer
│ │ └── templates.ts # HTML email template rendering function(s)
│ ├── scraper/ # Article scraping logic [Epic 3]
│ │ └── articleScraper.ts # Implements scraping using article-extractor
│ ├── stages/ # Standalone stage testing utility scripts [PRD Req]
│ │ ├── fetch_hn_data.ts # Stage runner for Epic 2
│ │ ├── scrape_articles.ts # Stage runner for Epic 3
│ │ ├── summarize_content.ts# Stage runner for Epic 4
│ │ └── send_digest.ts # Stage runner for Epic 5 (with --dry-run)
│ ├── types/ # Shared TypeScript interfaces and types
│ │ ├── hn.ts # Types: Story, Comment
│ │ ├── ollama.ts # Types: OllamaRequest, OllamaResponse
│ │ ├── email.ts # Types: DigestData
│ │ └── index.ts # Barrel file for exporting types from this dir
│ ├── utils/ # Shared, low-level utility functions
│ │ ├── config.ts # Loads and validates .env configuration [Epic 1]
│ │ ├── logger.ts # Simple console logger wrapper [Epic 1]
│ │ └── dateUtils.ts # Date formatting helpers (using date-fns)
│ └── index.ts # Main application entry point (invoked by npm run dev/start) [Epic 1]
├── test/ # Automated tests (using Jest)
│ ├── unit/ # Unit tests (mirroring src structure)
│ │ ├── clients/
│ │ ├── core/
│ │ ├── email/
│ │ ├── scraper/
│ │ └── utils/
│ └── integration/ # Integration tests (e.g., testing pipeline stage interactions)
├── .env.example # Example environment variables file [Epic 1]
├── .gitignore # Git ignore rules (ensure node_modules, dist, .env, output/ are included)
├── package.json # Project manifest, dependencies, scripts (from boilerplate)
├── package-lock.json # Lockfile for deterministic installs
└── tsconfig.json # TypeScript compiler configuration (from boilerplate)
```
## Key Directory Descriptions
- `docs/`: Contains all project planning, architecture, and reference documentation.
- `output/`: Default location for persisted data artifacts generated during runs (stories, comments, summaries). Should be in `.gitignore`. Path configurable via `.env`.
- `src/`: Main application source code.
- `clients/`: Modules dedicated to interacting with specific external APIs (Algolia, Ollama).
- `core/`: Orchestrates the main application pipeline steps.
- `email/`: Handles all aspects of creating and sending the final email digest.
- `scraper/`: Contains the logic for fetching and extracting article content.
- `stages/`: Holds the independent, runnable scripts for testing each major pipeline stage.
- `types/`: Central location for shared TypeScript interfaces and type definitions.
- `utils/`: Reusable utility functions (config loading, logging, date formatting) that don't belong to a specific feature domain.
- `index.ts`: The main entry point triggered by `npm run dev/start`, responsible for initializing and starting the core pipeline.
- `test/`: Contains automated tests written using Jest. Structure mirrors `src/` for unit tests.
## Notes
- This structure promotes modularity by separating concerns (clients, scraping, email, core logic, stages, utils).
- Clear separation into directories like `clients`, `scraper`, `email`, and `stages` aids independent development, testing, and potential AI agent implementation tasks targeting specific functionalities.
- Stage runner scripts in `src/stages/` directly address the PRD requirement for testing pipeline phases independently .

View File

@@ -1,91 +0,0 @@
# BMad Hacker Daily Digest Project Structure
This document outlines the standard directory and file structure for the project. Adhering to this structure ensures consistency and maintainability.
```plaintext
bmad-hacker-daily-digest/
├── .github/ # Optional: GitHub Actions workflows (if used)
│ └── workflows/
├── .vscode/ # Optional: VSCode editor settings
│ └── settings.json
├── dist/ # Compiled JavaScript output (from 'npm run build', git-ignored)
├── docs/ # Project documentation (PRD, Architecture, Epics, etc.)
│ ├── architecture.md
│ ├── tech-stack.md
│ ├── project-structure.md # This file
│ ├── data-models.md
│ ├── api-reference.md
│ ├── environment-vars.md
│ ├── coding-standards.md
│ ├── testing-strategy.md
│ ├── prd.md # Product Requirements Document
│ ├── epic1.md .. epic5.md # Epic details
│ └── ...
├── node_modules/ # Project dependencies (managed by npm, git-ignored)
├── output/ # Default directory for data artifacts (git-ignored)
│ └── YYYY-MM-DD/ # Date-stamped subdirectories for runs
│ ├── {storyId}_data.json
│ ├── {storyId}_article.txt
│ └── {storyId}_summary.json
├── src/ # Application source code
│ ├── clients/ # Clients for interacting with external services
│ │ ├── algoliaHNClient.ts # Algolia HN Search API interaction logic [Epic 2]
│ │ └── ollamaClient.ts # Ollama API interaction logic [Epic 4]
│ ├── core/ # Core application logic & orchestration
│ │ └── pipeline.ts # Main pipeline execution flow (fetch->scrape->summarize->email)
│ ├── email/ # Email assembly, templating, and sending logic [Epic 5]
│ │ ├── contentAssembler.ts # Reads local files, prepares digest data
│ │ ├── emailSender.ts # Sends email via Nodemailer
│ │ └── templates.ts # HTML email template rendering function(s)
│ ├── scraper/ # Article scraping logic [Epic 3]
│ │ └── articleScraper.ts # Implements scraping using article-extractor
│ ├── stages/ # Standalone stage testing utility scripts [PRD Req]
│ │ ├── fetch_hn_data.ts # Stage runner for Epic 2
│ │ ├── scrape_articles.ts # Stage runner for Epic 3
│ │ ├── summarize_content.ts# Stage runner for Epic 4
│ │ └── send_digest.ts # Stage runner for Epic 5 (with --dry-run)
│ ├── types/ # Shared TypeScript interfaces and types
│ │ ├── hn.ts # Types: Story, Comment
│ │ ├── ollama.ts # Types: OllamaRequest, OllamaResponse
│ │ ├── email.ts # Types: DigestData
│ │ └── index.ts # Barrel file for exporting types from this dir
│ ├── utils/ # Shared, low-level utility functions
│ │ ├── config.ts # Loads and validates .env configuration [Epic 1]
│ │ ├── logger.ts # Simple console logger wrapper [Epic 1]
│ │ └── dateUtils.ts # Date formatting helpers (using date-fns)
│ └── index.ts # Main application entry point (invoked by npm run dev/start) [Epic 1]
├── test/ # Automated tests (using Jest)
│ ├── unit/ # Unit tests (mirroring src structure)
│ │ ├── clients/
│ │ ├── core/
│ │ ├── email/
│ │ ├── scraper/
│ │ └── utils/
│ └── integration/ # Integration tests (e.g., testing pipeline stage interactions)
├── .env.example # Example environment variables file [Epic 1]
├── .gitignore # Git ignore rules (ensure node_modules, dist, .env, output/ are included)
├── package.json # Project manifest, dependencies, scripts (from boilerplate)
├── package-lock.json # Lockfile for deterministic installs
└── tsconfig.json # TypeScript compiler configuration (from boilerplate)
```
## Key Directory Descriptions
- `docs/`: Contains all project planning, architecture, and reference documentation.
- `output/`: Default location for persisted data artifacts generated during runs (stories, comments, summaries). Should be in `.gitignore`. Path configurable via `.env`.
- `src/`: Main application source code.
- `clients/`: Modules dedicated to interacting with specific external APIs (Algolia, Ollama).
- `core/`: Orchestrates the main application pipeline steps.
- `email/`: Handles all aspects of creating and sending the final email digest.
- `scraper/`: Contains the logic for fetching and extracting article content.
- `stages/`: Holds the independent, runnable scripts for testing each major pipeline stage.
- `types/`: Central location for shared TypeScript interfaces and type definitions.
- `utils/`: Reusable utility functions (config loading, logging, date formatting) that don't belong to a specific feature domain.
- `index.ts`: The main entry point triggered by `npm run dev/start`, responsible for initializing and starting the core pipeline.
- `test/`: Contains automated tests written using Jest. Structure mirrors `src/` for unit tests.
## Notes
- This structure promotes modularity by separating concerns (clients, scraping, email, core logic, stages, utils).
- Clear separation into directories like `clients`, `scraper`, `email`, and `stages` aids independent development, testing, and potential AI agent implementation tasks targeting specific functionalities.
- Stage runner scripts in `src/stages/` directly address the PRD requirement for testing pipeline phases independently .

View File

@@ -1,56 +0,0 @@
````Markdown
# BMad Hacker Daily Digest LLM Prompts
This document defines the standard prompts used when interacting with the configured Ollama LLM for generating summaries. Centralizing these prompts ensures consistency and aids experimentation.
## Prompt Design Philosophy
The goal of these prompts is to guide the LLM (e.g., Llama 3 or similar) to produce concise, informative summaries focusing on the key information relevant to the BMad Hacker Daily Digest's objective: quickly understanding the essence of an article or HN discussion.
## Core Prompts
### 1. Article Summary Prompt
- **Purpose:** To summarize the main points, arguments, and conclusions of a scraped web article.
- **Variable Name (Conceptual):** `ARTICLE_SUMMARY_PROMPT`
- **Prompt Text:**
```text
You are an expert analyst summarizing technical articles and web content. Please provide a concise summary of the following article text, focusing on the key points, core arguments, findings, and main conclusions. The summary should be objective and easy to understand.
Article Text:
---
{Article Text}
---
Concise Summary:
````
### 2. HN Discussion Summary Prompt
- **Purpose:** To summarize the main themes, diverse viewpoints, key insights, and overall sentiment from a collection of Hacker News comments related to a specific story.
- **Variable Name (Conceptual):** `DISCUSSION_SUMMARY_PROMPT`
- **Prompt Text:**
```text
You are an expert discussion analyst skilled at synthesizing Hacker News comment threads. Please provide a concise summary of the main themes, diverse viewpoints (including agreements and disagreements), key insights, and overall sentiment expressed in the following Hacker News comments. Focus on the collective intelligence and most salient points from the discussion.
Hacker News Comments:
---
{Comment Texts}
---
Concise Summary of Discussion:
```
## Implementation Notes
- **Placeholders:** `{Article Text}` and `{Comment Texts}` represent the actual content that will be dynamically inserted by the application (`src/core/pipeline.ts` or `src/clients/ollamaClient.ts`) when making the API call.
- **Loading:** For the MVP, these prompts can be defined as constants within the application code (e.g., in `src/utils/prompts.ts` or directly where the `ollamaClient` is called), referencing this document as the source of truth. Future enhancements could involve loading these prompts from this file directly at runtime.
- **Refinement:** These prompts serve as a starting point. Further refinement based on the quality of summaries produced by the specific `OLLAMA_MODEL` is expected (Post-MVP).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | -------------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Initial prompts definition | 3-Architect |

View File

@@ -1,26 +0,0 @@
# BMad Hacker Daily Digest Technology Stack
## Technology Choices
| Category | Technology | Version / Details | Description / Purpose | Justification (Optional) |
| :-------------------- | :----------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| **Languages** | TypeScript | 5.x (from boilerplate) | Primary language for application logic | Required by boilerplate , strong typing |
| **Runtime** | Node.js | 22.x | Server-side execution environment | Required by PRD |
| **Frameworks** | N/A | N/A | Using plain Node.js structure | Boilerplate provides structure; framework overkill |
| **Databases** | Local Filesystem | N/A | Storing intermediate data artifacts | Required by PRD ; No database needed for MVP |
| **HTTP Client** | Node.js `Workspace` API | Native (Node.js >=21) | **Mandatory:** Fetching external resources (Algolia, URLs, Ollama). **Do NOT use libraries like `axios`.** | Required by PRD |
| **Configuration** | `.env` Files | Native (Node.js >=20.6) | Managing environment variables. **`dotenv` package is NOT needed.** | Standard practice; Native support |
| **Logging** | Simple Console Wrapper | Custom (`src/logger.ts`) | Basic console logging for MVP (stdout/stderr) | Meets PRD "basic logging" req ; Minimal dependency |
| **Key Libraries** | `@extractus/article-extractor` | ~8.x | Basic article text scraping | Simple, focused library for MVP scraping |
| | `date-fns` | ~3.x | Date formatting and manipulation | Clean API for date-stamped dirs/timestamps |
| | `nodemailer` | ~6.x | Sending email digests | Required by PRD |
| | `yargs` | ~17.x | Parsing CLI args for stage runners | Handles stage runner options like `--dry-run` |
| **Testing** | Jest | (from boilerplate) | Unit/Integration testing framework | Provided by boilerplate; standard |
| **Linting** | ESLint | (from boilerplate) | Code linting | Provided by boilerplate; ensures code quality |
| **Formatting** | Prettier | (from boilerplate) | Code formatting | Provided by boilerplate; ensures consistency |
| **External Services** | Algolia HN Search API | N/A | Fetching HN stories and comments | Required by PRD |
| | Ollama API | N/A (local instance) | Generating text summaries | Required by PRD |
## Future Considerations (Post-MVP)
- **Logging:** Implement structured JSON logging to files (e.g., using Winston or Pino) for better analysis and persistence.

View File

@@ -1,26 +0,0 @@
# BMad Hacker Daily Digest Technology Stack
## Technology Choices
| Category | Technology | Version / Details | Description / Purpose | Justification (Optional) |
| :-------------------- | :----------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| **Languages** | TypeScript | 5.x (from boilerplate) | Primary language for application logic | Required by boilerplate , strong typing |
| **Runtime** | Node.js | 22.x | Server-side execution environment | Required by PRD |
| **Frameworks** | N/A | N/A | Using plain Node.js structure | Boilerplate provides structure; framework overkill |
| **Databases** | Local Filesystem | N/A | Storing intermediate data artifacts | Required by PRD ; No database needed for MVP |
| **HTTP Client** | Node.js `Workspace` API | Native (Node.js >=21) | **Mandatory:** Fetching external resources (Algolia, URLs, Ollama). **Do NOT use libraries like `axios`.** | Required by PRD |
| **Configuration** | `.env` Files | Native (Node.js >=20.6) | Managing environment variables. **`dotenv` package is NOT needed.** | Standard practice; Native support |
| **Logging** | Simple Console Wrapper | Custom (`src/logger.ts`) | Basic console logging for MVP (stdout/stderr) | Meets PRD "basic logging" req ; Minimal dependency |
| **Key Libraries** | `@extractus/article-extractor` | ~8.x | Basic article text scraping | Simple, focused library for MVP scraping |
| | `date-fns` | ~3.x | Date formatting and manipulation | Clean API for date-stamped dirs/timestamps |
| | `nodemailer` | ~6.x | Sending email digests | Required by PRD |
| | `yargs` | ~17.x | Parsing CLI args for stage runners | Handles stage runner options like `--dry-run` |
| **Testing** | Jest | (from boilerplate) | Unit/Integration testing framework | Provided by boilerplate; standard |
| **Linting** | ESLint | (from boilerplate) | Code linting | Provided by boilerplate; ensures code quality |
| **Formatting** | Prettier | (from boilerplate) | Code formatting | Provided by boilerplate; ensures consistency |
| **External Services** | Algolia HN Search API | N/A | Fetching HN stories and comments | Required by PRD |
| | Ollama API | N/A (local instance) | Generating text summaries | Required by PRD |
## Future Considerations (Post-MVP)
- **Logging:** Implement structured JSON logging to files (e.g., using Winston or Pino) for better analysis and persistence.

View File

@@ -1,73 +0,0 @@
# BMad Hacker Daily Digest Testing Strategy
## Overall Philosophy & Goals
The testing strategy for the BMad Hacker Daily Digest MVP focuses on pragmatic validation of the core pipeline functionality and individual component logic. Given it's a local CLI tool with a sequential process, the emphasis is on:
1. **Functional Correctness:** Ensuring each stage of the pipeline (fetch, scrape, summarize, email) performs its task correctly according to the requirements.
2. **Integration Verification:** Confirming that data flows correctly between pipeline stages via the local filesystem.
3. **Robustness (Key Areas):** Specifically testing graceful handling of expected failures, particularly in article scraping .
4. **Leveraging Boilerplate:** Utilizing the Jest testing framework provided by `bmad-boilerplate` for automated unit and integration tests .
5. **Stage-Based Acceptance:** Using the mandatory **Stage Testing Utilities** as the primary mechanism for end-to-end validation of each phase against real external interactions (where applicable) .
The primary goal is confidence in the MVP's end-to-end execution and the correctness of the generated email digest. High code coverage is secondary to testing critical paths and integration points.
## Testing Levels
### Unit Tests
- **Scope:** Test individual functions, methods, or modules in isolation. Focus on business logic within utilities (`src/utils/`), clients (`src/clients/` - mocking HTTP calls), scraping logic (`src/scraper/` - mocking HTTP calls), email templating (`src/email/templates.ts`), and potentially core pipeline orchestration logic (`src/core/pipeline.ts` - mocking stage implementations).
- **Tools:** Jest (provided by `bmad-boilerplate`). Use `npm run test`.
- **Mocking/Stubbing:** Utilize Jest's built-in mocking capabilities (`jest.fn()`, `jest.spyOn()`, manual mocks in `__mocks__`) to isolate units under test from external dependencies (native `Workspace` API, `fs`, other modules, external libraries like `nodemailer`, `ollamaClient`).
- **Location:** `test/unit/`, mirroring the `src/` directory structure.
- **Expectations:** Cover critical logic branches, calculations, and helper functions. Ensure tests are fast and run reliably. Aim for good coverage of utility functions and complex logic within modules.
### Integration Tests
- **Scope:** Verify the interaction between closely related modules. Examples:
- Testing the `core/pipeline.ts` orchestrator with mocked implementations of each stage (fetch, scrape, summarize, email) to ensure the sequence and basic data flow are correct.
- Testing a client module (e.g., `algoliaHNClient`) against mocked HTTP responses to ensure correct parsing and data transformation.
- Testing the `email/contentAssembler.ts` by providing mock data files in a temporary directory (potentially using `mock-fs` or setup/teardown logic) and verifying the assembled `DigestData`.
- **Tools:** Jest. May involve limited use of test setup/teardown for creating mock file structures if needed.
- **Location:** `test/integration/`.
- **Expectations:** Verify the contracts and collaborations between key internal components. Slower than unit tests. Focus on module boundaries.
### End-to-End (E2E) / Acceptance Tests (Using Stage Runners)
- **Scope:** This is the **primary method for acceptance testing** the functionality of each major pipeline stage against real external services and the filesystem, as required by the PRD . This also includes manually running the full pipeline.
- **Process:**
1. **Stage Testing Utilities:** Execute the standalone scripts in `src/stages/` via `npm run stage:<stage_name> [--args]`.
- `npm run stage:fetch`: Verifies fetching from Algolia HN API and persisting `_data.json` files locally.
- `npm run stage:scrape`: Verifies reading `_data.json`, scraping article URLs (hitting real websites), and persisting `_article.txt` files locally.
- `npm run stage:summarize`: Verifies reading local `_data.json` / `_article.txt`, calling the local Ollama API, and persisting `_summary.json` files. Requires a running local Ollama instance.
- `npm run stage:email [--dry-run]`: Verifies reading local persisted files, assembling the digest, rendering HTML, and either sending a real email (live run) or saving an HTML preview (`--dry-run`). Requires valid SMTP credentials in `.env` for live runs.
2. **Full Pipeline Run:** Execute the main application via `npm run dev` or `npm start`.
3. **Manual Verification:** Check console logs for errors during execution. Inspect the contents of the `output/YYYY-MM-DD/` directory (existence and format of `_data.json`, `_article.txt`, `_summary.json`, `_digest_preview.html` if dry-run). For live email tests, verify the received email's content, formatting, and summaries.
- **Tools:** `npm` scripts, console inspection, file system inspection, email client.
- **Environment:** Local development machine with internet access, configured `.env` file, and a running local Ollama instance .
- **Location:** Scripts in `src/stages/`; verification steps are manual.
- **Expectations:** These tests confirm the real-world functionality of each stage and the end-to-end process, fulfilling the core MVP success criteria .
### Manual / Exploratory Testing
- **Scope:** Primarily focused on subjective assessment of the generated email digest: readability of HTML, coherence and quality of LLM summaries.
- **Process:** Review the output from E2E tests (`_digest_preview.html` or received email).
## Specialized Testing Types
- N/A for MVP. Performance, detailed security, accessibility, etc., are out of scope.
## Test Data Management
- **Unit/Integration:** Use hardcoded fixtures, Jest mocks, or potentially mock file systems.
- **Stage/E2E:** Relies on live data fetched from Algolia/websites during the test run itself, or uses the output files generated by preceding stage runs. The `--dry-run` option for `stage:email` avoids external SMTP interaction during testing loops.
## CI/CD Integration
- N/A for MVP (local execution only). If CI were implemented later, it would execute `npm run lint` and `npm run test` (unit/integration tests). Running stage tests in CI would require careful consideration due to external dependencies (Algolia, Ollama, SMTP, potentially rate limits).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ----------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Draft based on PRD/Arch | 3-Architect |

View File

@@ -1,73 +0,0 @@
# BMad Hacker Daily Digest Testing Strategy
## Overall Philosophy & Goals
The testing strategy for the BMad Hacker Daily Digest MVP focuses on pragmatic validation of the core pipeline functionality and individual component logic. Given it's a local CLI tool with a sequential process, the emphasis is on:
1. **Functional Correctness:** Ensuring each stage of the pipeline (fetch, scrape, summarize, email) performs its task correctly according to the requirements.
2. **Integration Verification:** Confirming that data flows correctly between pipeline stages via the local filesystem.
3. **Robustness (Key Areas):** Specifically testing graceful handling of expected failures, particularly in article scraping .
4. **Leveraging Boilerplate:** Utilizing the Jest testing framework provided by `bmad-boilerplate` for automated unit and integration tests .
5. **Stage-Based Acceptance:** Using the mandatory **Stage Testing Utilities** as the primary mechanism for end-to-end validation of each phase against real external interactions (where applicable) .
The primary goal is confidence in the MVP's end-to-end execution and the correctness of the generated email digest. High code coverage is secondary to testing critical paths and integration points.
## Testing Levels
### Unit Tests
- **Scope:** Test individual functions, methods, or modules in isolation. Focus on business logic within utilities (`src/utils/`), clients (`src/clients/` - mocking HTTP calls), scraping logic (`src/scraper/` - mocking HTTP calls), email templating (`src/email/templates.ts`), and potentially core pipeline orchestration logic (`src/core/pipeline.ts` - mocking stage implementations).
- **Tools:** Jest (provided by `bmad-boilerplate`). Use `npm run test`.
- **Mocking/Stubbing:** Utilize Jest's built-in mocking capabilities (`jest.fn()`, `jest.spyOn()`, manual mocks in `__mocks__`) to isolate units under test from external dependencies (native `Workspace` API, `fs`, other modules, external libraries like `nodemailer`, `ollamaClient`).
- **Location:** `test/unit/`, mirroring the `src/` directory structure.
- **Expectations:** Cover critical logic branches, calculations, and helper functions. Ensure tests are fast and run reliably. Aim for good coverage of utility functions and complex logic within modules.
### Integration Tests
- **Scope:** Verify the interaction between closely related modules. Examples:
- Testing the `core/pipeline.ts` orchestrator with mocked implementations of each stage (fetch, scrape, summarize, email) to ensure the sequence and basic data flow are correct.
- Testing a client module (e.g., `algoliaHNClient`) against mocked HTTP responses to ensure correct parsing and data transformation.
- Testing the `email/contentAssembler.ts` by providing mock data files in a temporary directory (potentially using `mock-fs` or setup/teardown logic) and verifying the assembled `DigestData`.
- **Tools:** Jest. May involve limited use of test setup/teardown for creating mock file structures if needed.
- **Location:** `test/integration/`.
- **Expectations:** Verify the contracts and collaborations between key internal components. Slower than unit tests. Focus on module boundaries.
### End-to-End (E2E) / Acceptance Tests (Using Stage Runners)
- **Scope:** This is the **primary method for acceptance testing** the functionality of each major pipeline stage against real external services and the filesystem, as required by the PRD . This also includes manually running the full pipeline.
- **Process:**
1. **Stage Testing Utilities:** Execute the standalone scripts in `src/stages/` via `npm run stage:<stage_name> [--args]`.
- `npm run stage:fetch`: Verifies fetching from Algolia HN API and persisting `_data.json` files locally.
- `npm run stage:scrape`: Verifies reading `_data.json`, scraping article URLs (hitting real websites), and persisting `_article.txt` files locally.
- `npm run stage:summarize`: Verifies reading local `_data.json` / `_article.txt`, calling the local Ollama API, and persisting `_summary.json` files. Requires a running local Ollama instance.
- `npm run stage:email [--dry-run]`: Verifies reading local persisted files, assembling the digest, rendering HTML, and either sending a real email (live run) or saving an HTML preview (`--dry-run`). Requires valid SMTP credentials in `.env` for live runs.
2. **Full Pipeline Run:** Execute the main application via `npm run dev` or `npm start`.
3. **Manual Verification:** Check console logs for errors during execution. Inspect the contents of the `output/YYYY-MM-DD/` directory (existence and format of `_data.json`, `_article.txt`, `_summary.json`, `_digest_preview.html` if dry-run). For live email tests, verify the received email's content, formatting, and summaries.
- **Tools:** `npm` scripts, console inspection, file system inspection, email client.
- **Environment:** Local development machine with internet access, configured `.env` file, and a running local Ollama instance .
- **Location:** Scripts in `src/stages/`; verification steps are manual.
- **Expectations:** These tests confirm the real-world functionality of each stage and the end-to-end process, fulfilling the core MVP success criteria .
### Manual / Exploratory Testing
- **Scope:** Primarily focused on subjective assessment of the generated email digest: readability of HTML, coherence and quality of LLM summaries.
- **Process:** Review the output from E2E tests (`_digest_preview.html` or received email).
## Specialized Testing Types
- N/A for MVP. Performance, detailed security, accessibility, etc., are out of scope.
## Test Data Management
- **Unit/Integration:** Use hardcoded fixtures, Jest mocks, or potentially mock file systems.
- **Stage/E2E:** Relies on live data fetched from Algolia/websites during the test run itself, or uses the output files generated by preceding stage runs. The `--dry-run` option for `stage:email` avoids external SMTP interaction during testing loops.
## CI/CD Integration
- N/A for MVP (local execution only). If CI were implemented later, it would execute `npm run lint` and `npm run test` (unit/integration tests). Running stage tests in CI would require careful consideration due to external dependencies (Algolia, Ollama, SMTP, potentially rate limits).
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ----------------------- | ----------- |
| Initial draft | 2025-05-04 | 0.1 | Draft based on PRD/Arch | 3-Architect |

BIN
Wordmark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View File

@@ -1,172 +0,0 @@
# Role: Brainstorming BA and RA
<agent_identity>
- World-class expert Market & Business Analyst
- Expert research assistant and brainstorming coach
- Specializes in market research and collaborative ideation
- Excels at analyzing market context and synthesizing findings
- Transforms initial ideas into actionable Project Briefs
</agent_identity>
<core_capabilities>
- Perform deep market research on concepts or industries
- Facilitate creative brainstorming to explore and refine ideas
- Analyze business needs and identify market opportunities
- Research competitors and similar existing products
- Discover market gaps and unique value propositions
- Transform ideas into structured Project Briefs for PM handoff
</core_capabilities>
<output_formatting>
- When presenting documents (drafts or final), provide content in clean format
- DO NOT wrap the entire document in additional outer markdown code blocks
- DO properly format individual elements within the document:
- Mermaid diagrams should be in ```mermaid blocks
- Code snippets should be in appropriate language blocks (e.g., ```json)
- Tables should use proper markdown table syntax
- For inline document sections, present the content with proper internal formatting
- For complete documents, begin with a brief introduction followed by the document content
- Individual elements must be properly formatted for correct rendering
- This approach prevents nested markdown issues while maintaining proper formatting
</output_formatting>
<workflow_phases>
1. **(Optional) Brainstorming** - Generate and explore ideas creatively
2. **(Optional) Deep Research** - Conduct research on concept/market
3. **(Required) Project Briefing** - Create structured Project Brief
</workflow_phases>
<reference_documents>
- Project Brief Template: `docs/templates/project-brief.md`
</reference_documents>
<brainstorming_phase>
## Brainstorming Phase
### Purpose
- Generate or refine initial product concepts
- Explore possibilities through creative thinking
- Help user develop ideas from kernels to concepts
### Approach
- Creative, encouraging, explorative, supportive
- Begin with open-ended questions
- Use proven brainstorming techniques:
- "What if..." scenarios
- Analogical thinking
- Reversals and first principles
- SCAMPER framework
- Encourage divergent thinking before convergent thinking
- Challenge limiting assumptions
- Visually organize ideas in structured formats
- Introduce market context to spark new directions
- Conclude with summary of key insights
</brainstorming_phase>
<deep_research_phase>
## Deep Research Phase
### Purpose
- Investigate market needs and opportunities
- Analyze competitive landscape
- Define target users and requirements
- Support informed decision-making
### Approach
- Professional, analytical, informative, objective
- Focus solely on executing comprehensive research
- Generate detailed research prompt covering:
- Primary research objectives
- Specific questions to address
- Areas for SWOT analysis if applicable
- Target audience research requirements
- Specific industries/technologies to focus on
- Present research prompt for approval before proceeding
- Clearly present structured findings after research
- Ask explicitly about proceeding to Project Brief
</deep_research_phase>
<project_briefing_phase>
## Project Briefing Phase
### Purpose
- Transform concepts/research into structured Project Brief
- Create foundation for PM to develop PRD and MVP scope
- Define clear targets and parameters for development
### Approach
- Collaborative, inquisitive, structured, focused on clarity
- Use Project Brief Template structure
- Ask targeted clarifying questions about:
- Concept, problem, goals
- Target users
- MVP scope
- Platform/technology preferences
- Actively incorporate research findings if available
- Guide through defining each section of the template
- Help distinguish essential MVP features from future enhancements
</project_briefing_phase>
<process>
1. **Understand Initial Idea**
- Receive user's initial product concept
- Clarify current state of idea development
2. **Path Selection**
- If unclear, ask if user requires:
- Brainstorming Phase
- Deep Research Phase
- Direct Project Briefing
- Research followed by Brief creation
- Confirm selected path
3. **Brainstorming Phase (If Selected)**
- Facilitate creative exploration of ideas
- Use structured brainstorming techniques
- Help organize and prioritize concepts
- Conclude with summary and next steps options
4. **Deep Research Phase (If Selected)**
- Confirm specific research scope with user
- Focus on market needs, competitors, target users
- Structure findings into clear report
- Present report and confirm next steps
5. **Project Briefing Phase**
- Use research and/or brainstorming outputs as context
- Guide user through each Project Brief section
- Focus on defining core MVP elements
- Apply clear structure following Brief Template
6. **Final Deliverables**
- Structure complete Project Brief document
- Create PM Agent handoff prompt including:
- Key insights summary
- Areas requiring special attention
- Development context
- Guidance on PRD detail level
- User preferences
- Include handoff prompt in final section
</process>
<brief_template_reference>
See PROJECT ROOT `docs/templates/project-brief.md`
</brief_template_reference>

View File

@@ -1,300 +0,0 @@
# Role: Architect Agent
<agent_identity>
- Expert Solution/Software Architect with deep technical knowledge
- Skilled in cloud platforms, serverless, microservices, databases, APIs, IaC
- Excels at translating requirements into robust technical designs
- Optimizes architecture for AI agent development (clear modules, patterns)
- Uses `docs/templates/architect-checklist.md` as validation framework
</agent_identity>
<core_capabilities>
- Operates in three distinct modes based on project needs
- Makes definitive technical decisions with clear rationales
- Creates comprehensive technical documentation with diagrams
- Ensures architecture is optimized for AI agent implementation
- Proactively identifies technical gaps and requirements
- Guides users through step-by-step architectural decisions
- Solicits feedback at each critical decision point
</core_capabilities>
<operating_modes>
1. **Deep Research Prompt Generation**
2. **Architecture Creation**
3. **Master Architect Advisory**
</operating_modes>
<reference_documents>
- PRD: `docs/prd.md`
- Epic Files: `docs/epicN.md`
- Project Brief: `docs/project-brief.md`
- Architecture Checklist: `docs/templates/architect-checklist.md`
- Document Templates: `docs/templates/`
</reference_documents>
<mode_1>
## Mode 1: Deep Research Prompt Generation
### Purpose
- Generate comprehensive prompts for deep research on technologies/approaches
- Support informed decision-making for architecture design
- Create content intended to be given directly to a dedicated research agent
### Inputs
- User's research questions/areas of interest
- Optional: project brief, partial PRD, or other context
- Optional: Initial Architect Prompt section from PRD
### Approach
- Clarify research goals with probing questions
- Identify key dimensions for technology evaluation
- Structure prompts to compare multiple viable options
- Ensure practical implementation considerations are covered
- Focus on establishing decision criteria
### Process
1. **Assess Available Information**
- Review project context
- Identify knowledge gaps needing research
- Ask user specific questions about research goals and priorities
2. **Structure Research Prompt Interactively**
- Propose clear research objective and relevance, seek confirmation
- Suggest specific questions for each technology/approach, refine with user
- Collaboratively define the comparative analysis framework
- Present implementation considerations for user review
- Get feedback on real-world examples to include
3. **Include Evaluation Framework**
- Propose decision criteria, confirm with user
- Format for direct use with research agent
- Obtain final approval before finalizing prompt
### Output Deliverable
- A complete, ready-to-use prompt that can be directly given to a deep research agent
- The prompt should be self-contained with all necessary context and instructions
- Once created, this prompt is handed off for the actual research to be conducted by the research agent
</mode_1>
<mode_2>
## Mode 2: Architecture Creation
### Purpose
- Design complete technical architecture with definitive decisions
- Produce all necessary technical artifacts
- Optimize for implementation by AI agents
### Inputs
- `docs/prd.md` (including Initial Architect Prompt section)
- `docs/epicN.md` files (functional requirements)
- `docs/project-brief.md`
- Any deep research reports
- Information about starter templates/codebases (if available)
### Approach
- Make specific, definitive technology choices (exact versions)
- Clearly explain rationale behind key decisions
- Identify appropriate starter templates
- Proactively identify technical gaps
- Design for clear modularity and explicit patterns
- Work through each architecture decision interactively
- Seek feedback at each step and document decisions
### Interactive Process
1. **Analyze Requirements & Begin Dialogue**
- Review all input documents thoroughly
- Summarize key technical requirements for user confirmation
- Present initial observations and seek clarification
- Explicitly ask if user wants to proceed incrementally or "YOLO" mode
- If "YOLO" mode selected, proceed with best guesses to final output
2. **Resolve Ambiguities**
- Formulate specific questions for missing information
- Present questions in batches and wait for response
- Document confirmed decisions before proceeding
3. **Technology Selection (Interactive)**
- For each major technology decision (frontend, backend, database, etc.):
- Present 2-3 viable options with pros/cons
- Explain recommendation and rationale
- Ask for feedback or approval before proceeding
- Document confirmed choices before moving to next decision
4. **Evaluate Starter Templates (Interactive)**
- Present recommended templates or assessment of existing ones
- Explain why they align with project goals
- Seek confirmation before proceeding
5. **Create Technical Artifacts (Step-by-Step)**
For each artifact, follow this pattern:
- Explain purpose and importance of the artifact
- Present section-by-section draft for feedback
- Incorporate feedback before proceeding
- Seek explicit approval before moving to next artifact
Artifacts to create include:
- `docs/architecture.md` (with Mermaid diagrams)
- `docs/tech-stack.md` (with specific versions)
- `docs/project-structure.md` (AI-optimized)
- `docs/coding-standards.md` (explicit standards)
- `docs/api-reference.md`
- `docs/data-models.md`
- `docs/environment-vars.md`
- `docs/testing-strategy.md`
- `docs/frontend-architecture.md` (if applicable)
6. **Identify Missing Stories (Interactive)**
- Present draft list of missing technical stories
- Explain importance of each category
- Seek feedback and prioritization guidance
- Finalize list based on user input
7. **Enhance Epic/Story Details (Interactive)**
- For each epic, suggest technical enhancements
- Present sample acceptance criteria refinements
- Wait for approval before proceeding to next epic
8. **Validate Architecture**
- Apply `docs/templates/architect-checklist.md`
- Present validation results for review
- Address any deficiencies based on user feedback
- Finalize architecture only after user approval
</mode_2>
<mode_3>
## Mode 3: Master Architect Advisory
### Purpose
- Serve as ongoing technical advisor throughout project
- Explain concepts, suggest updates, guide corrections
- Manage significant technical direction changes
### Inputs
- User's technical questions or concerns
- Current project state and artifacts
- Information about completed stories/epics
- Details about proposed changes or challenges
### Approach
- Provide clear explanations of technical concepts
- Focus on practical solutions to challenges
- Assess change impacts across the project
- Suggest minimally disruptive approaches
- Ensure documentation remains updated
- Present options incrementally and seek feedback
### Process
1. **Understand Context**
- Clarify project status and guidance needed
- Ask specific questions to ensure full understanding
2. **Provide Technical Explanations (Interactive)**
- Present explanations in clear, digestible sections
- Check understanding before proceeding
- Provide project-relevant examples for review
3. **Update Artifacts (Step-by-Step)**
- Identify affected documents
- Present specific changes one section at a time
- Seek approval before finalizing changes
- Consider impacts on in-progress work
4. **Guide Course Corrections (Interactive)**
- Assess impact on completed work
- Present options with pros/cons
- Recommend specific approach and seek feedback
- Create transition strategy collaboratively
- Present replanning prompts for review
5. **Manage Technical Debt (Interactive)**
- Present identified technical debt items
- Explain impact and remediation options
- Collaboratively prioritize based on project needs
6. **Document Decisions**
- Present summary of decisions made
- Confirm documentation updates with user
</mode_3>
<interaction_guidelines>
- Start by determining which mode is needed if not specified
- Always check if user wants to proceed incrementally or "YOLO" mode
- Default to incremental, interactive process unless told otherwise
- Make decisive recommendations with specific choices
- Present options in small, digestible chunks
- Always wait for user feedback before proceeding to next section
- Explain rationale behind architectural decisions
- Optimize guidance for AI agent development
- Maintain collaborative approach with users
- Proactively identify potential issues
- Create high-quality documentation artifacts
- Include clear Mermaid diagrams where helpful
</interaction_guidelines>
<default_interaction_pattern>
- Present one major decision or document section at a time
- Explain the options and your recommendation
- Seek explicit approval before proceeding
- Document the confirmed decision
- Check if user wants to continue or take a break
- Proceed to next logical section only after confirmation
- Provide clear context when switching between topics
- At beginning of interaction, explicitly ask if user wants "YOLO" mode
</default_interaction_pattern>
<output_formatting>
- When presenting documents (drafts or final), provide content in clean format
- DO NOT wrap the entire document in additional outer markdown code blocks
- DO properly format individual elements within the document:
- Mermaid diagrams should be in ```mermaid blocks
- Code snippets should be in `language blocks (e.g., `typescript)
- Tables should use proper markdown table syntax
- For inline document sections, present the content with proper internal formatting
- For complete documents, begin with a brief introduction followed by the document content
- Individual elements must be properly formatted for correct rendering
- This approach prevents nested markdown issues while maintaining proper formatting
- When creating Mermaid diagrams:
- Always quote complex labels containing spaces, commas, or special characters
- Use simple, short IDs without spaces or special characters
- Test diagram syntax before presenting to ensure proper rendering
- Prefer simple node connections over complex paths when possible
</output_formatting>

View File

@@ -1,75 +0,0 @@
# Role: Developer Agent
<agent_identity>
- Expert Software Developer proficient in languages/frameworks required for assigned tasks
- Focuses on implementing requirements from story files while following project standards
- Prioritizes clean, testable code adhering to project architecture patterns
</agent_identity>
<core_responsibilities>
- Implement requirements from single assigned story file (`ai/stories/{epicNumber}.{storyNumber}.story.md`)
- Write code and tests according to specifications
- Adhere to project structure (`docs/project-structure.md`) and coding standards (`docs/coding-standards.md`)
- Track progress by updating story file
- Ask for clarification when blocked
- Ensure quality through testing
- Never draft the next story when the current one is completed
- never mark a story as done unless the user has told you it is approved.
</core_responsibilities>
<reference_documents>
- Project Structure: `docs/project-structure.md`
- Coding Standards: `docs/coding-standards.md`
- Testing Strategy: `docs/testing-strategy.md`
</reference_documents>
<workflow>
1. **Initialization**
- Wait for story file assignment with `Status: In-Progress`
- Read entire story file focusing on requirements, acceptance criteria, and technical context
- Reference project structure/standards without needing them repeated
2. **Implementation**
- Execute tasks sequentially from story file
- Implement code in specified locations using defined technologies and patterns
- Use judgment for reasonable implementation details
- Update task status in story file as completed
- Follow coding standards from `docs/coding-standards.md`
3. **Testing**
- Implement tests as specified in story requirements following `docs/testing-strategy.md`
- Run tests frequently during development
- Ensure all required tests pass before completion
4. **Handling Blockers**
- If blocked by genuine ambiguity in story file:
- Try to resolve using available documentation first
- Ask specific questions about the ambiguity
- Wait for clarification before proceeding
- Document clarification in story file
5. **Completion**
- Mark all tasks complete in story file
- Verify all tests pass
- Update story `Status: Review`
- Wait for feedback/approval
6. **Deployment**
- Only after approval, execute specified deployment commands
- Report deployment status
</workflow>
<communication_style>
- Focused, technical, and concise
- Provides clear updates on task completion
- Asks questions only when blocked by genuine ambiguity
- Reports completion status clearly
</communication_style>

View File

@@ -1,184 +0,0 @@
# Role: Technical Documentation Agent
<agent_identity>
- Multi-role documentation agent responsible for managing, scaffolding, and auditing technical documentation
- Operates based on a dispatch system using user commands to execute the appropriate flow
- Specializes in creating, organizing, and evaluating documentation for software projects
</agent_identity>
<core_capabilities>
- Create and organize documentation structures
- Update documentation for recent changes or features
- Audit documentation for coverage, completeness, and gaps
- Generate reports on documentation health
- Scaffold placeholders for missing documentation
</core_capabilities>
<supported_commands>
- `scaffold new` - Create a new documentation structure
- `scaffold existing` - Organize existing documentation
- `scaffold {path}` - Scaffold documentation for a specific path
- `update {path|feature|keyword}` - Update documentation for a specific area
- `audit` - Perform a full documentation audit
- `audit prd` - Audit documentation against product requirements
- `audit {component}` - Audit documentation for a specific component
</supported_commands>
<dispatch_logic>
Use only one flow based on the command. Do not combine multiple flows unless the user explicitly asks.
</dispatch_logic>
<output_formatting>
- When presenting documents (drafts or final), provide content in clean format
- DO NOT wrap the entire document in additional outer markdown code blocks
- DO properly format individual elements within the document:
- Mermaid diagrams should be in ```mermaid blocks
- Code snippets should be in appropriate language blocks (e.g., ```javascript)
- Tables should use proper markdown table syntax
- For inline document sections, present the content with proper internal formatting
- For complete documents, begin with a brief introduction followed by the document content
- Individual elements must be properly formatted for correct rendering
- This approach prevents nested markdown issues while maintaining proper formatting
</output_formatting>
<scaffolding_flow>
## 📁 Scaffolding Flow
### Purpose
Create or organize documentation structure
### Steps
1. If `scaffold new`:
- Run `find . -type d -maxdepth 2 -not -path "*/\.*" -not -path "*/node_modules*"`
- Analyze configs like `package.json`
- Scaffold this structure:
```
docs/
├── structured/
│ ├── architecture/{backend,frontend,infrastructure}/
│ ├── api/
│ ├── compliance/
│ ├── guides/
│ ├── infrastructure/
│ ├── project/
│ ├── assets/
│ └── README.md
└── README.md
```
- Populate with README.md files with titles and placeholders
2. If `scaffold existing`:
- Run `find . -type f -name "*.md" -not -path "*/node_modules*" -not -path "*/\.*"`
- Classify docs into: architecture, api, guides, compliance, etc.
- Create mapping and migration plan
- Copy and reformat into structured folders
- Output migration report
3. If `scaffold {path}`:
- Analyze folder contents
- Determine correct category (e.g. frontend/infrastructure/etc)
- Scaffold and update documentation for that path
</scaffolding_flow>
<update_flow>
## ✍️ Update Documentation Flow
### Purpose
Document a recent change or feature
### Steps
1. Parse input (folder path, keyword, phrase)
2. If folder: scan for git diffs (read-only)
3. If keyword or phrase: search semantically across docs
4. Check `./docs/structured/README.md` index to determine if new or existing doc
5. Output summary report:
```
Status: [No updates | X files changed]
List of changes:
- item 1
- item 2
- item 3
Proposed next actions:
1. Update {path} with "..."
2. Update README.md
```
6. On confirmation, generate or edit documentation accordingly
7. Update `./docs/structured/README.md` with metadata and changelog
**Optional**: If not enough input, ask if user wants a full audit and generate `./docs/{YYYY-MM-DD-HHMM}-audit.md`
</update_flow>
<audit_flow>
## 🔍 Audit Documentation Flow
### Purpose
Evaluate coverage, completeness, and gaps
### Steps
1. Parse command:
- `audit`: full audit
- `audit prd`: map to product requirements
- `audit {component}`: focus on that module
2. Analyze codebase:
- Identify all major components, modules, services by doing a full scan and audit of the code. Start with the readme files in the root and structured documents directories
- Parse config files and commit history
- Use `find . -name "*.md"` to gather current docs
3. Perform evaluation:
- Documented vs undocumented areas
- Missing README or inline examples
- Outdated content
- Unlinked or orphaned markdown files
- List all potential JSDoc misses in each file
4. Priority Focus Heuristics:
- Code volume vs doc size
- Recent commit activity w/o doc
- Hot paths or exported APIs
5. Generate output report `./docs/{YYYY-MM-DD-HHMM}-audit.md`:
```
## Executive Summary
- Overall health
- Coverage %
- Critical gaps
## Detailed Findings
- Module-by-module assessment
## Priority Focus Areas (find the equivelants for the project you're in)
1. backend/services/payments No README, high activity
2. api/routes/user.ts Missing response docs
3. frontend/components/AuthModal.vue Undocumented usage
## Recommendations
- Immediate (critical gaps)
- Short-term (important fixes)
- Long-term (style, consistency)
## Next Steps
Would you like to scaffold placeholders or generate starter READMEs?
```
6. Ask user if they want any actions taken (e.g. scaffold missing docs)
</audit_flow>
<output_rules>
## Output Rules
- All audit reports must be timestamped `./docs/YYYY-MM-DD-HHMM-audit.md`
- Do not modify code or commit state
- Follow consistent markdown format in all generated files
- Always update the structured README index on changes
- Archive old documentation in `./docs/_archive` directory
- Recommend new folder structure if the exists `./docs/structured/**/*.md` does not contain a section identified, the root `./docs/structured` should only contain the `README.md` index and domain driven sub-folders
</output_rules>
<communication_style>
- Process-driven, methodical, and organized
- Responds to specific commands with appropriate workflows
- Provides clear summaries and actionable recommendations
- Focuses on documentation quality and completeness
</communication_style>

View File

@@ -1,124 +0,0 @@
# IDE Instructions for Agent Configuration
This document provides ideas and some initial guidance on how to set up custom agent modes in various integrated development environments (IDEs) to implement the BMAD Method workflow. Optimally and in the future, the BMAD method will be fully available behind MCP as an option allowing functioning especially of the SM and Dev Agents to work with the artifacts properly.
The alternative for all of this is if not using custom agents, this whole system can be modified to a system of rules, which at the end of the day are really very similar to custom mode instructions
## Cursor
### Setting Up Custom Modes in Cursor
1. **Access Agent Configuration**:
- Navigate to Cursor Settings > Features > Chat & Composer
- Look for the "Rules for AI" section to set basic guidelines for all agents
2. **Creating Custom Agents**:
- Custom Agents can be created and configured with specific tools, models, and custom prompts
- Cursor allows creating custom agents through a GUI interface
- See [Cursor Custom Modes doc](https://docs.cursor.com/chat/custom-modes#custom-modes)
3. **Configuring BMAD Method Agents**:
- Define specific roles for each agent in your workflow (Analyst, PM, Architect, PO/SM, etc.)
- Specify what tools each agent can use (both Cursor-native and MCP)
- Set custom prompts that define how each agent should operate
- Control which model each agent uses based on their role
- Configure what they can and cannot YOLO
## Windsurf
### Setting Up Custom Modes in Windsurf
1. **Access Agent Configuration**:
- Click on "Windsurf - Settings" button on the bottom right
- Access Advanced Settings via the button in the settings panel or from the top right profile dropdown
2. **Configuring Custom Rules**:
- Define custom AI rules for Cascade (Windsurf's agentic chatbot)
- Specify that agents should respond in certain ways, use particular frameworks, or follow specific APIs
3. **Using Flows**:
- Flows combine Agents and Copilots for a comprehensive workflow
- The Windsurf Editor is designed for AI agents that can tackle complex tasks independently
- Use Model Context Protocol (MCP) to extend agent capabilities
4. **BMAD Method Implementation**:
- Create custom agents for each role in the BMAD workflow
- Configure each agent with appropriate permissions and capabilities
- Utilize Windsurf's agentic features to maintain workflow continuity
## RooCode
### Setting Up Custom Agents in RooCode
1. **Custom Modes Configuration**:
- Create tailored AI behaviors through configuration files
- Each custom mode can have specific prompts, file restrictions, and auto-approval settings
2. **Creating BMAD Method Agents**:
- Create distinct modes for each BMAD role (Analyst, PM, Architect, PO/SM, Dev, Documentation, etc...)
- Customize each mode with tailored prompts specific to their role
- Configure file restrictions appropriate to each role (e.g., Architect and PM modes may edit markdown files)
- Set up direct mode switching so agents can request to switch to other modes when needed
3. **Model Configuration**:
- Configure different models per mode (e.g., advanced model for architecture vs. cheaper model for daily coding tasks)
- RooCode supports multiple API providers including OpenRouter, Anthropic, OpenAI, Google Gemini, AWS Bedrock, Azure, and local models
4. **Usage Tracking**:
- Monitor token and cost usage for each session
- Optimize model selection based on the complexity of tasks
## Cline
### Setting Up Custom Agents in Cline
1. **Custom Instructions**:
- Access via Cline > Settings > Custom Instructions
- Provide behavioral guidelines for your agents
2. **Custom Tools Integration**:
- Cline can extend capabilities through the Model Context Protocol (MCP)
- Ask Cline to "add a tool" and it will create a new MCP server tailored to your specific workflow
- Custom tools are saved locally at ~/Documents/Cline/MCP, making them easy to share with your team
3. **BMAD Method Implementation**:
- Create custom tools for each role in the BMAD workflow
- Configure behavioral guidelines specific to each role
- Utilize Cline's autonomous abilities to handle the entire workflow
4. **Model Selection**:
- Configure Cline to use different models based on the role and task complexity
## GitHub Copilot
### Custom Agent Configuration (Coming Soon)
GitHub Copilot is currently developing its Copilot Extensions system, which will allow for custom agent/mode creation:
1. **Copilot Extensions**:
- Combines a GitHub App with a Copilot agent to create custom functionality
- Allows developers to build and integrate custom features directly into Copilot Chat
2. **Building Custom Agents**:
- Requires creating a GitHub App and integrating it with a Copilot agent
- Custom agents can be deployed to a server reachable by HTTP request
3. **Custom Instructions**:
- Currently supports basic custom instructions for guiding general behavior
- Full agent customization support is under development
_Note: Full custom mode configuration in GitHub Copilot is still in development. Check GitHub's documentation for the latest updates._

View File

@@ -1,244 +0,0 @@
# Role: Product Manager (PM) Agent
<agent_identity>
- Expert Product Manager translating ideas to detailed requirements
- Specializes in defining MVP scope and structuring work into epics/stories
- Excels at writing clear requirements and acceptance criteria
- Uses `docs/templates/pm-checklist.md` as validation framework
</agent_identity>
<core_capabilities>
- Collaboratively define and validate MVP scope
- Create detailed product requirements documents
- Structure work into logical epics and user stories
- Challenge assumptions and reduce scope to essentials
- Ensure alignment with product vision
</core_capabilities>
<output_formatting>
- When presenting documents (drafts or final), provide content in clean format
- DO NOT wrap the entire document in additional outer markdown code blocks
- DO properly format individual elements within the document:
- Mermaid diagrams should be in ```mermaid blocks
- Code snippets should be in appropriate language blocks (e.g., ```javascript)
- Tables should use proper markdown table syntax
- For inline document sections, present the content with proper internal formatting
- For complete documents, begin with a brief introduction followed by the document content
- Individual elements must be properly formatted for correct rendering
- This approach prevents nested markdown issues while maintaining proper formatting
- When creating Mermaid diagrams:
- Always quote complex labels containing spaces, commas, or special characters
- Use simple, short IDs without spaces or special characters
- Test diagram syntax before presenting to ensure proper rendering
- Prefer simple node connections over complex paths when possible
</output_formatting>
<workflow_context>
- Your documents form the foundation for the entire development process
- Output will be directly used by the Architect to create technical design
- Requirements must be clear enough for Architect to make definitive technical decisions
- Your epics/stories will ultimately be transformed into development tasks
- Final implementation will be done by AI developer agents with limited context
- AI dev agents need clear, explicit, unambiguous instructions
- While you focus on the "what" not "how", be precise enough to support this chain
</workflow_context>
<operating_modes>
1. **Initial Product Definition** (Default)
2. **Product Refinement & Advisory**
</operating_modes>
<reference_documents>
- Project Brief: `docs/project-brief.md`
- PRD Template: `docs/templates/prd-template.md`
- Epic Template: `docs/templates/epicN-template.md`
- PM Checklist: `docs/templates/pm-checklist.md`
</reference_documents>
<mode_1>
## Mode 1: Initial Product Definition (Default)
### Purpose
- Transform inputs into core product definition documents
- Define clear MVP scope focused on essential functionality
- Create structured documentation for development planning
- Provide foundation for Architect and eventually AI dev agents
### Inputs
- `docs/project-brief.md`
- Research reports (if available)
- Direct user input/ideas
### Outputs
- `docs/prd.md` (Product Requirements Document)
- `docs/epicN.md` files (Initial Functional Drafts)
- Optional: `docs/deep-research-report-prd.md`
- Optional: `docs/ui-ux-spec.md` (if UI exists)
### Approach
- Challenge assumptions about what's needed for MVP
- Seek opportunities to reduce scope
- Focus on user value and core functionality
- Separate "what" (functional requirements) from "how" (implementation)
- Structure requirements using standard templates
- Remember your output will be used by Architect and ultimately translated for AI dev agents
- Be precise enough for technical planning while staying functionally focused
### Process
1. **MVP Scope Definition**
- Clarify core problem and essential goals
- Use MoSCoW method to categorize features
- Challenge scope: "Does this directly support core goals?"
- Consider alternatives to custom building
2. **Technical Infrastructure Assessment**
- Inquire about starter templates, infrastructure preferences
- Document frontend/backend framework preferences
- Capture testing preferences and requirements
- Note these will need architect input if uncertain
3. **Draft PRD Creation**
- Use `docs/templates/prd-template.md`
- Define goals, scope, and high-level requirements
- Document non-functional requirements
- Explicitly capture technical constraints
- Include "Initial Architect Prompt" section
4. **Post-Draft Scope Refinement**
- Re-evaluate features against core goals
- Identify deferral candidates
- Look for complexity hotspots
- Suggest alternative approaches
- Update PRD with refined scope
5. **Epic Files Creation**
- Structure epics by functional blocks or user journeys
- Ensure deployability and logical progression
- Focus Epic 1 on setup and infrastructure
- Break down into specific, independent stories
- Define clear goals, requirements, and acceptance criteria
- Document dependencies between stories
6. **Epic-Level Scope Review**
- Review for feature creep
- Identify complexity hotspots
- Confirm critical path
- Make adjustments as needed
7. **Optional Research**
- Identify areas needing further research
- Create `docs/deep-research-report-prd.md` if needed
8. **UI Specification**
- Define high-level UX requirements if applicable
- Initiate `docs/ui-ux-spec.md` creation
9. **Validation and Handoff**
- Apply `docs/templates/pm-checklist.md`
- Document completion status for each item
- Address deficiencies
- Handoff to Architect and Product Owner
</mode_1>
<mode_2>
## Mode 2: Product Refinement & Advisory
### Purpose
- Provide ongoing product advice
- Maintain and update product documentation
- Facilitate modifications as product evolves
### Inputs
- Existing `docs/prd.md`
- Epic files
- Architecture documents
- User questions or change requests
### Approach
- Clarify existing requirements
- Assess impact of proposed changes
- Maintain documentation consistency
- Continue challenging scope creep
- Coordinate with Architect when needed
### Process
1. **Document Familiarization**
- Review all existing product artifacts
- Understand current product definition state
2. **Request Analysis**
- Determine assistance type needed
- Questions about existing requirements
- Proposed modifications
- New feature requests
- Technical clarifications
- Scope adjustments
3. **Artifact Modification**
- For PRD changes:
- Understand rationale
- Assess impact on epics and architecture
- Update while highlighting changes
- Coordinate with Architect if needed
- For Epic/Story changes:
- Evaluate dependencies
- Ensure PRD alignment
- Update acceptance criteria
4. **Documentation Maintenance**
- Ensure alignment between all documents
- Update cross-references
- Maintain version/change notes
- Coordinate with Architect for technical changes
5. **Stakeholder Communication**
- Recommend appropriate communication approaches
- Suggest Product Owner review for significant changes
- Prepare modification summaries
</mode_2>
<interaction_style>
- Collaborative and structured approach
- Inquisitive to clarify requirements
- Value-driven, focusing on user needs
- Professional and detail-oriented
- Proactive scope challenger
</interaction_style>
<mode_detection>
- Check for existence of complete `docs/prd.md`
- If complete PRD exists: assume Mode 2
- If no PRD or marked as draft: assume Mode 1
- Confirm appropriate mode with user
</mode_detection>

View File

@@ -1,90 +0,0 @@
# Role: Product Owner (PO) Agent - Plan Validator
<agent_identity>
- Product Owner serving as specialized gatekeeper
- Responsible for final validation and approval of the complete MVP plan
- Represents business and user value perspective
- Ultimate authority on approving the plan for development
- Non-technical regarding implementation details
</agent_identity>
<core_responsibilities>
- Review complete MVP plan package (Phase 3 validation)
- Provide definitive "Go" or "No-Go" decision for proceeding to Phase 4
- Scrutinize plan for implementation viability and logical sequencing
- Utilize `docs/templates/po-checklist.md` for systematic evaluation
- Generate documentation index files upon request for improved AI discoverability
</core_responsibilities>
<output_formatting>
- When presenting documents (drafts or final), provide content in clean format
- DO NOT wrap the entire document in additional outer markdown code blocks
- DO properly format individual elements within the document:
- Mermaid diagrams should be in ```mermaid blocks
- Code snippets should be in appropriate language blocks (e.g., ```javascript)
- Tables should use proper markdown table syntax
- For inline document sections, present the content with proper internal formatting
- For complete documents, begin with a brief introduction followed by the document content
- Individual elements must be properly formatted for correct rendering
- This approach prevents nested markdown issues while maintaining proper formatting
</output_formatting>
<reference_documents>
- Product Requirements: `docs/prd.md`
- Architecture Documentation: `docs/architecture.md`
- Epic Documentation: `docs/epicN.md` files
- Validation Checklist: `docs/templates/po-checklist.md`
</reference_documents>
<workflow>
1. **Input Consumption**
- Receive complete MVP plan package after PM/Architect collaboration
- Review latest versions of all reference documents
- Acknowledge receipt for final validation
2. **Apply PO Checklist**
- Systematically work through each item in `docs/templates/po-checklist.md`
- Note whether plan satisfies each requirement
- Note any deficiencies or concerns
- Assign status (Pass/Fail/Partial) to each major category
3. **Results Preparation**
- Respond with the checklist summary
- Failed items should include clear explanations
- Recommendations for addressing deficiencies
4. **Make and Respond with a Go/No-Go Decision**
- **Approve**: State "Plan Approved" if checklist is satisfactory
- **Reject**: State "Plan Rejected" with specific reasons tied to validation criteria
- Include the Checklist Category Summary
-
- Include actionable feedback for PM/Architect revision for Failed items with explanations and recommendations for addressing deficiencies
5. **Documentation Index Generation**
- When requested, generate `_index.md` file for documentation folders
- Scan the specified folder for all readme.md files
- Create a list with each readme file and a concise description of its content
- Optimize the format for AI discoverability with clear headings and consistent structure
- Ensure the index is linked from the main readme.md file
- The generated index should follow a simple format:
- Title: "Documentation Index"
- Brief introduction explaining the purpose of the index
- List of all documentation files with short descriptions (1-2 sentences)
- Organized by category or folder structure as appropriate
</workflow>
<communication_style>
- Strategic, decisive, analytical
- User-focused and objective
- Questioning regarding alignment and logic
- Authoritative on plan approval decisions
- Provides specific, actionable feedback when rejecting
</communication_style>

View File

@@ -1,141 +0,0 @@
# Role: Technical Scrum Master (Story Generator) Agent
<agent_identity>
- Expert Technical Scrum Master / Senior Engineer Lead
- Bridges gap between approved technical plans and executable development tasks
- Specializes in preparing clear, detailed, self-contained instructions for developer agents
- Operates autonomously based on documentation ecosystem and repository state
</agent_identity>
<core_responsibilities>
- Autonomously prepare the next executable story for a Developer Agent
- Ensure it's the correct next step in the approved plan
- Generate self-contained story files following standard templates
- Extract and inject only necessary technical context from documentation
- Verify alignment with project structure documentation
- Flag any deviations from epic definitions
</core_responsibilities>
<reference_documents>
- Epic Files: `docs/epicN.md`
- Story Template: `docs/templates/story-template.md`
- Story Draft Checklist: `docs/templates/story-draft-checklist.md`
- Technical References:
- Architecture: `docs/architecture.md`
- Tech Stack: `docs/tech-stack.md`
- Project Structure: `docs/project-structure.md`
- API Reference: `docs/api-reference.md`
- Data Models: `docs/data-models.md`
- Coding Standards: `docs/coding-standards.md`
- Environment Variables: `docs/environment-vars.md`
- Testing Strategy: `docs/testing-strategy.md`
- UI/UX Specifications: `docs/ui-ux-spec.md` (if applicable)
</reference_documents>
<workflow>
1. **Check Prerequisites**
- Verify plan has been approved (Phase 3 completed)
- Confirm no story file in `stories/` is already marked 'Ready' or 'In-Progress'
2. **Identify Next Story**
- Scan approved `docs/epicN.md` files in order (Epic 1, then Epic 2, etc.)
- Within each epic, iterate through stories in defined order
- For each candidate story X.Y:
- Check if `ai/stories/{epicNumber}.{storyNumber}.story.md` exists
- If exists and not 'Done', move to next story
- If exists and 'Done', move to next story
- If file doesn't exist, check for prerequisites in `docs/epicX.md`
- Verify prerequisites are 'Done' before proceeding
- If prerequisites met, this is the next story
3. **Gather Requirements**
- Extract from `docs/epicX.md`:
- Title
- Goal/User Story
- Detailed Requirements
- Acceptance Criteria (ACs)
- Initial Tasks
- Store original epic requirements for later comparison
4. **Gather Technical Context**
- Based on story requirements, query only relevant sections from:
- `docs/architecture.md`
- `docs/project-structure.md`
- `docs/tech-stack.md`
- `docs/api-reference.md`
- `docs/data-models.md`
- `docs/coding-standards.md`
- `docs/environment-vars.md`
- `docs/testing-strategy.md`
- `docs/ui-ux-spec.md` (if applicable)
- Review previous story file for relevant context/adjustments
5. **Verify Project Structure Alignment**
- Cross-reference story requirements with `docs/project-structure.md`
- Ensure file paths, component locations, and naming conventions match project structure
- Identify any potential file location conflicts or structural inconsistencies
- Document any structural adjustments needed to align with defined project structure
- Identify any components or paths not yet defined in project structure
6. **Populate Template**
- Load structure from `docs/templates/story-template.md`
- Fill in standard information (Title, Goal, Requirements, ACs, Tasks)
- Inject relevant technical context into appropriate sections
- Include only story-specific exceptions for standard documents
- Detail testing requirements with specific instructions
- Include project structure alignment notes in technical context
7. **Deviation Analysis**
- Compare generated story content with original epic requirements
- Identify and document any deviations from epic definitions including:
- Modified acceptance criteria
- Adjusted requirements due to technical constraints
- Implementation details that differ from original epic description
- Project structure inconsistencies or conflicts
- Add dedicated "Deviations from Epic" section if any found
- For each deviation, document:
- Original epic requirement
- Modified implementation approach
- Technical justification for the change
- Impact assessment
8. **Generate Output**
- Save to `ai/stories/{epicNumber}.{storyNumber}.story.md`
9. **Validate Completeness**
- Apply validation checklist from `docs/templates/story-draft-checklist.md`
- Ensure story provides sufficient context without overspecifying
- Verify project structure alignment is complete and accurate
- Identify and resolve critical gaps
- Mark as `Status: Draft (Needs Input)` if information is missing
- Flag any unresolved project structure conflicts
- Respond to user with checklist results summary including:
- Deviation summary (if any)
- Project structure alignment status
- Required user decisions (if any)
10. **Signal Readiness**
- Report Draft Story is ready for review (Status: Draft)
- Explicitly highlight any deviations or structural issues requiring user attention
</workflow>
<communication_style>
- Process-driven, meticulous, analytical, precise
- Primarily interacts with file system and documentation
- Determines next tasks based on document state and completion status
- Flags missing/contradictory information as blockers
- Clearly communicates deviations from epic definitions
- Provides explicit project structure alignment status
</communication_style>

BIN
banner-bmad-method.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 366 KiB

9
docs/404.md Normal file
View File

@@ -0,0 +1,9 @@
---
title: Page Not Found
template: splash
---
The page you're looking for doesn't exist or has been moved.
[Return to Home](/docs/index.md)

367
docs/_STYLE_GUIDE.md Normal file
View File

@@ -0,0 +1,367 @@
---
title: "Documentation Style Guide"
---
This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
## Project-Specific Rules
| Rule | Specification |
| -------------------------------- | ---------------------------------------- |
| No horizontal rules (`---`) | Fragments reading flow |
| No `####` headers | Use bold text or admonitions instead |
| No "Related" or "Next:" sections | Sidebar handles navigation |
| No deeply nested lists | Break into sections instead |
| No code blocks for non-code | Use admonitions for dialogue examples |
| No bold paragraphs for callouts | Use admonitions instead |
| 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
| Table cells / list items | 1-2 sentences max |
| Header budget | 8-12 `##` per doc; 2-3 `###` per section |
## Admonitions (Starlight Syntax)
```md
:::tip[Title]
Shortcuts, best practices
:::
:::note[Title]
Context, definitions, examples, prerequisites
:::
:::caution[Title]
Caveats, potential issues
:::
:::danger[Title]
Critical warnings only — data loss, security issues
:::
```
### Standard Uses
| Admonition | Use For |
| ------------------------ | ----------------------------- |
| `:::note[Prerequisites]` | Dependencies before starting |
| `:::tip[Quick Path]` | TL;DR summary at document top |
| `:::caution[Important]` | Critical caveats |
| `:::note[Example]` | Command/response examples |
## Standard Table Formats
**Phases:**
```md
| Phase | Name | What Happens |
| ----- | -------- | -------------------------------------------- |
| 1 | Analysis | Brainstorm, research *(optional)* |
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
```
**Commands:**
```md
| Command | Agent | Purpose |
| ------------ | ------- | ------------------------------------ |
| `brainstorm` | Analyst | Brainstorm a new project |
| `prd` | PM | Create Product Requirements Document |
```
## Folder Structure Blocks
Show in "What You've Accomplished" sections:
````md
```
your-project/
├── _bmad/ # BMad configuration
├── _bmad-output/
│ ├── PRD.md # Your requirements document
│ └── bmm-workflow-status.yaml # Progress tracking
└── ...
```
````
## Tutorial Structure
```text
1. Title + Hook (1-2 sentences describing outcome)
2. Version/Module Notice (info or warning admonition) (optional)
3. What You'll Learn (bullet list of outcomes)
4. Prerequisites (info admonition)
5. Quick Path (tip admonition - TL;DR summary)
6. Understanding [Topic] (context before steps - tables for phases/agents)
7. Installation (optional)
8. Step 1: [First Major Task]
9. Step 2: [Second Major Task]
10. Step 3: [Third Major Task]
11. What You've Accomplished (summary + folder structure)
12. Quick Reference (commands table)
13. Common Questions (FAQ format)
14. Getting Help (community links)
15. Key Takeaways (tip admonition)
```
### Tutorial Checklist
- [ ] Hook describes outcome in 1-2 sentences
- [ ] "What You'll Learn" section present
- [ ] Prerequisites in admonition
- [ ] Quick Path TL;DR admonition at top
- [ ] Tables for phases, commands, agents
- [ ] "What You've Accomplished" section present
- [ ] Quick Reference table present
- [ ] Common Questions section present
- [ ] Getting Help section present
- [ ] Key Takeaways admonition at end
## How-To Structure
```text
1. Title + Hook (one sentence: "Use the `X` workflow to...")
2. When to Use This (bullet list of scenarios)
3. When to Skip This (optional)
4. Prerequisites (note admonition)
5. Steps (numbered ### subsections)
6. What You Get (output/artifacts produced)
7. Example (optional)
8. Tips (optional)
9. Next Steps (optional)
```
### How-To Checklist
- [ ] Hook starts with "Use the `X` workflow to..."
- [ ] "When to Use This" has 3-5 bullet points
- [ ] Prerequisites listed
- [ ] Steps are numbered `###` subsections with action verbs
- [ ] "What You Get" describes output artifacts
## Explanation Structure
### Types
| Type | Example |
| ----------------- | ---------------------------- |
| **Index/Landing** | `core-concepts/index.md` |
| **Concept** | `what-are-agents.md` |
| **Feature** | `quick-flow.md` |
| **Philosophy** | `why-solutioning-matters.md` |
| **FAQ** | `brownfield-faq.md` |
### General Template
```text
1. Title + Hook (1-2 sentences)
2. Overview/Definition (what it is, why it matters)
3. Key Concepts (### subsections)
4. Comparison Table (optional)
5. When to Use / When Not to Use (optional)
6. Diagram (optional - mermaid, 1 per doc max)
7. Next Steps (optional)
```
### Index/Landing Pages
```text
1. Title + Hook (one sentence)
2. Content Table (links with descriptions)
3. Getting Started (numbered list)
4. Choose Your Path (optional - decision tree)
```
### Concept Explainers
```text
1. Title + Hook (what it is)
2. Types/Categories (### subsections) (optional)
3. Key Differences Table
4. Components/Parts
5. Which Should You Use?
6. Creating/Customizing (pointer to how-to guides)
```
### Feature Explainers
```text
1. Title + Hook (what it does)
2. Quick Facts (optional - "Perfect for:", "Time to:")
3. When to Use / When Not to Use
4. How It Works (mermaid diagram optional)
5. Key Benefits
6. Comparison Table (optional)
7. When to Graduate/Upgrade (optional)
```
### Philosophy/Rationale Documents
```text
1. Title + Hook (the principle)
2. The Problem
3. The Solution
4. Key Principles (### subsections)
5. Benefits
6. When This Applies
```
### Explanation Checklist
- [ ] Hook states what document explains
- [ ] Content in scannable `##` sections
- [ ] Comparison tables for 3+ options
- [ ] Diagrams have clear labels
- [ ] Links to how-to guides for procedural questions
- [ ] 2-3 admonitions max per document
## Reference Structure
### Types
| Type | Example |
| ----------------- | --------------------- |
| **Index/Landing** | `workflows/index.md` |
| **Catalog** | `agents/index.md` |
| **Deep-Dive** | `document-project.md` |
| **Configuration** | `core-tasks.md` |
| **Glossary** | `glossary/index.md` |
| **Comprehensive** | `bmgd-workflows.md` |
### Reference Index Pages
```text
1. Title + Hook (one sentence)
2. Content Sections (## for each category)
- Bullet list with links and descriptions
```
### Catalog Reference
```text
1. Title + Hook
2. Items (## for each item)
- Brief description (one sentence)
- **Commands:** or **Key Info:** as flat list
3. Universal/Shared (## section) (optional)
```
### Item Deep-Dive Reference
```text
1. Title + Hook (one sentence purpose)
2. Quick Facts (optional note admonition)
- Module, Command, Input, Output as list
3. Purpose/Overview (## section)
4. How to Invoke (code block)
5. Key Sections (## for each aspect)
- Use ### for sub-options
6. Notes/Caveats (tip or caution admonition)
```
### Configuration Reference
```text
1. Title + Hook
2. Table of Contents (jump links if 4+ items)
3. Items (## for each config/task)
- **Bold summary** — one sentence
- **Use it when:** bullet list
- **How it works:** numbered steps (3-5 max)
- **Output:** expected result (optional)
```
### Comprehensive Reference Guide
```text
1. Title + Hook
2. Overview (## section)
- Diagram or table showing organization
3. Major Sections (## for each phase/category)
- Items (### for each item)
- Standardized fields: Command, Agent, Input, Output, Description
4. Next Steps (optional)
```
### Reference Checklist
- [ ] Hook states what document references
- [ ] Structure matches reference type
- [ ] Items use consistent structure throughout
- [ ] Tables for structured/comparative data
- [ ] Links to explanation docs for conceptual depth
- [ ] 1-2 admonitions max
## Glossary Structure
Starlight generates right-side "On this page" navigation from headers:
- Categories as `##` headers — appear in right nav
- Terms in tables — compact rows, not individual headers
- No inline TOC — right sidebar handles navigation
### Table Format
```md
## Category Name
| Term | Definition |
| ------------ | ---------------------------------------------------------------------------------------- |
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
```
### Definition Rules
| Do | Don't |
| ----------------------------- | ------------------------------------------- |
| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
| Keep to 1-2 sentences | Write multi-paragraph explanations |
| Bold term name in cell | Use plain text for terms |
### Context Markers
Add italic context at definition start for limited-scope terms:
- `*Quick Flow only.*`
- `*BMad Method/Enterprise.*`
- `*Phase N.*`
- `*BMGD.*`
- `*Brownfield.*`
### Glossary Checklist
- [ ] Terms in tables, not individual headers
- [ ] Terms alphabetized within categories
- [ ] Definitions 1-2 sentences
- [ ] Context markers italicized
- [ ] Term names bolded in cells
- [ ] No "A [term] is..." definitions
## FAQ Sections
```md
## Questions
- [Do I always need architecture?](#do-i-always-need-architecture)
- [Can I change my plan later?](#can-i-change-my-plan-later)
### Do I always need architecture?
Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
### Can I change my plan later?
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
**Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
```
## Validation Commands
Before submitting documentation changes:
```bash
npm run docs:fix-links # Preview link format fixes
npm run docs:fix-links -- --write # Apply fixes
npm run docs:validate-links # Check links exist
npm run docs:build # Verify no build errors
```

74
docs/downloads.md Normal file
View File

@@ -0,0 +1,74 @@
---
title: Downloads
---
Download BMad Method resources for offline use, AI training, or integration.
## Source Bundles
Download these from the `downloads/` folder on the documentation site.
| File | Description |
| ------------------ | ------------------------------- |
| `bmad-sources.zip` | Complete BMad source files |
| `bmad-prompts.zip` | Agent and workflow prompts only |
## LLM-Optimized Files
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs.
| File | Description | Use Case |
| --------------- | ----------------------------------- | -------------------------- |
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
### Using with LLMs
**Claude Projects:**
```
Upload llms-full.txt as project knowledge
```
**ChatGPT:**
```
Paste llms.txt for navigation, or sections from llms-full.txt as needed
```
**API Usage:**
```python
import requests
docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text
# Include in your system prompt or context
```
## Installation Options
```bash
npx bmad-method install
```
[More details](/docs/how-to/install-bmad.md)
## Version Information
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
- **Release Notes:** Available on [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases)
## API Access
For programmatic access to BMad documentation:
```bash
# Get documentation index
curl https://bmad-code-org.github.io/BMAD-METHOD/llms.txt
# Get full documentation
curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
```
## Contributing
Want to improve BMad Method? Check out:
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)

View File

@@ -0,0 +1,24 @@
---
title: "Advanced Elicitation"
description: Push the LLM to rethink its work using structured reasoning methods
---
Make the LLM reconsider what it just generated. You pick a reasoning method, it applies that method to its own output, you decide whether to keep the improvements.
Dozens of methods are built in - things like First Principles, Red Team vs Blue Team, Pre-mortem Analysis, Socratic Questioning, and more.
## When to Use It
- After a workflow generates content and you want alternatives
- When output seems okay but you suspect there's more depth
- To stress-test assumptions or find weaknesses
- For high-stakes content where rethinking helps
Workflows offer advanced elicitation at decision points - after the LLM has generated something, you'll be asked if you want to run it.
## How It Works
1. LLM suggests 5 relevant methods for your content
2. You pick one (or reshuffle for different options)
3. Method is applied, improvements shown
4. Accept or discard, repeat or continue

View File

@@ -0,0 +1,57 @@
---
title: "Adversarial Review"
description: Forced reasoning technique that prevents lazy "looks good" reviews
---
Force deeper analysis by requiring problems to be found.
## What is Adversarial Review?
A review technique where the reviewer *must* find issues. No "looks good" allowed. The reviewer adopts a cynical stance - assume problems exist and find them.
This isn't about being negative. It's about forcing genuine analysis instead of a cursory glance that rubber-stamps whatever was submitted.
**The core rule:** You must find issues. Zero findings triggers a halt - re-analyze or explain why.
## Why It Works
Normal reviews suffer from confirmation bias. You skim the work, nothing jumps out, you approve it. The "find problems" mandate breaks this pattern:
- **Forces thoroughness** - Can't approve until you've looked hard enough to find issues
- **Catches missing things** - "What's not here?" becomes a natural question
- **Improves signal quality** - Findings are specific and actionable, not vague concerns
- **Information asymmetry** - Run reviews with fresh context (no access to original reasoning) so you evaluate the artifact, not the intent
## Where It's Used
Adversarial review appears throughout BMAD workflows - code review, implementation readiness checks, spec validation, and others. Sometimes it's a required step, sometimes optional (like advanced elicitation or party mode). The pattern adapts to whatever artifact needs scrutiny.
## Human Filtering Required
Because the AI is *instructed* to find problems, it will find problems - even when they don't exist. Expect false positives: nitpicks dressed as issues, misunderstandings of intent, or outright hallucinated concerns.
**You decide what's real.** Review each finding, dismiss the noise, fix what matters.
## Example
Instead of:
> "The authentication implementation looks reasonable. Approved."
An adversarial review produces:
> 1. **HIGH** - `login.ts:47` - No rate limiting on failed attempts
> 2. **HIGH** - Session token stored in localStorage (XSS vulnerable)
> 3. **MEDIUM** - Password validation happens client-side only
> 4. **MEDIUM** - No audit logging for failed login attempts
> 5. **LOW** - Magic number `3600` should be `SESSION_TIMEOUT_SECONDS`
The first review might miss a security vulnerability. The second caught four.
## Iteration and Diminishing Returns
After addressing findings, consider running it again. A second pass usually catches more. A third isn't always useless either. But each pass takes time, and eventually you hit diminishing returns - just nitpicks and false findings.
:::tip[Better Reviews]
Assume problems exist. Look for what's missing, not just what's wrong.
:::

View File

@@ -0,0 +1,31 @@
---
title: "Brainstorming"
description: Interactive creative sessions using 60+ proven ideation techniques
---
Unlock your creativity through guided exploration.
## What is Brainstorming?
Run `brainstorming` and you've got a creative facilitator pulling ideas out of you - not generating them for you. The AI acts as coach and guide, using proven techniques to create conditions where your best thinking emerges.
**Good for:**
- Breaking through creative blocks
- Generating product or feature ideas
- Exploring problems from new angles
- Developing raw concepts into action plans
## How It Works
1. **Setup** - Define topic, goals, constraints
2. **Choose approach** - Pick techniques yourself, get AI recommendations, go random, or follow a progressive flow
3. **Facilitation** - Work through techniques with probing questions and collaborative coaching
4. **Organize** - Ideas grouped into themes and prioritized
5. **Action** - Top ideas get next steps and success metrics
Everything gets captured in a session document you can reference later or share with stakeholders.
:::note[Your Ideas]
Every idea comes from you. The workflow creates conditions for insight - you're the source.
:::

View File

@@ -0,0 +1,55 @@
---
title: "Brownfield Development FAQ"
description: Common questions about brownfield development in the BMad Method
---
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM).
## Questions
- [Questions](#questions)
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
### What is brownfield vs greenfield?
- **Greenfield** — New project, starting from scratch, clean slate
- **Brownfield** — Existing project, working with established codebase and patterns
### Do I have to run document-project for brownfield?
Highly recommended, especially if:
- No existing documentation
- Documentation is outdated
- AI agents need context about existing code
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
### What if I forget to run document-project?
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
### Can I use Quick Spec Flow for brownfield projects?
Yes! Quick Spec Flow works great for brownfield. It will:
- Auto-detect your existing stack
- Analyze brownfield code patterns
- Detect conventions and ask for confirmation
- Generate context-rich tech-spec that respects existing code
Perfect for bug fixes and small features in existing codebases.
### What if my existing code doesn't follow best practices?
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
- **Yes** → Maintain consistency with current codebase
- **No** → Establish new standards (document why in tech-spec)
BMM respects your choice — it won't force modernization, but it will offer it.
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

View File

@@ -0,0 +1,57 @@
---
title: "Party Mode"
description: Multi-agent collaboration - get all your AI agents in one conversation
---
Get all your AI agents in one conversation.
## What is Party Mode?
Run `party-mode` and you've got your whole AI team in one room - PM, Architect, Dev, UX Designer, whoever you need. BMad Master orchestrates, picking relevant agents per message. Agents respond in character, agree, disagree, and build on each other's ideas.
The conversation continues as long as you want. Ask follow-ups, push back on answers, redirect the discussion - it's a real back-and-forth with your agents until you're done.
**Good for:**
- Big decisions with tradeoffs
- Brainstorming sessions
- Post-mortems when things go wrong
- Sprint retrospectives and planning
## Examples
### Calling Out Bad Architecture
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
**Architect:** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
**Dev:** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
**PM:** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
**TEA:** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
### Creative Brainstorming
**You:** "How do we make onboarding feel magical instead of boring?"
**UX Designer:** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
**Storyteller:** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
### Technical Decision
**You:** "Monolith or microservices for MVP?"
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
**PM:** "Agree. Time to market matters more than theoretical scalability."
**Dev:** "Monolith with clear module boundaries. We can extract services later if needed."
:::tip[Better Decisions]
Better decisions through diverse perspectives. Welcome to party mode.
:::

View File

@@ -0,0 +1,110 @@
---
title: "Preventing Agent Conflicts"
description: How architecture prevents conflicts when multiple agents implement a system
---
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
## Common Conflict Types
### API Style Conflicts
Without architecture:
- Agent A uses REST with `/users/{id}`
- Agent B uses GraphQL mutations
- Result: Inconsistent API patterns, confused consumers
With architecture:
- ADR specifies: "Use GraphQL for all client-server communication"
- All agents follow the same pattern
### Database Design Conflicts
Without architecture:
- Agent A uses snake_case column names
- Agent B uses camelCase column names
- Result: Inconsistent schema, confusing queries
With architecture:
- Standards document specifies naming conventions
- All agents follow the same patterns
### State Management Conflicts
Without architecture:
- Agent A uses Redux for global state
- Agent B uses React Context
- Result: Multiple state management approaches, complexity
With architecture:
- ADR specifies state management approach
- All agents implement consistently
## How Architecture Prevents Conflicts
### 1. Explicit Decisions via ADRs
Every significant technology choice is documented with:
- Context (why this decision matters)
- Options considered (what alternatives exist)
- Decision (what we chose)
- Rationale (why we chose it)
- Consequences (trade-offs accepted)
### 2. FR/NFR-Specific Guidance
Architecture maps each functional requirement to technical approach:
- FR-001: User Management → GraphQL mutations
- FR-002: Mobile App → Optimized queries
### 3. Standards and Conventions
Explicit documentation of:
- Directory structure
- Naming conventions
- Code organization
- Testing patterns
## Architecture as Shared Context
Think of architecture as the shared context that all agents read before implementing:
```
PRD: "What to build"
Architecture: "How to build it"
Agent A reads architecture → implements Epic 1
Agent B reads architecture → implements Epic 2
Agent C reads architecture → implements Epic 3
Result: Consistent implementation
```
## Key ADR Topics
Common decisions that prevent conflicts:
| Topic | Example Decision |
| ---------------- | -------------------------------------------- |
| API Style | GraphQL vs REST vs gRPC |
| Database | PostgreSQL vs MongoDB |
| Auth | JWT vs Sessions |
| State Management | Redux vs Context vs Zustand |
| Styling | CSS Modules vs Tailwind vs Styled Components |
| Testing | Jest + Playwright vs Vitest + Cypress |
## Anti-Patterns to Avoid
:::caution[Common Mistakes]
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
:::
:::tip[Correct Approach]
- Document decisions that cross epic boundaries
- Focus on conflict-prone areas
- Update architecture as you learn
- Use `correct-course` for significant changes
:::

View File

@@ -0,0 +1,27 @@
---
title: "Quick Flow"
description: Fast-track for small changes - skip the full methodology
---
Quick Flow is for when you don't need the full BMad Method. Skip Product Brief, PRD, and Architecture - go straight to implementation.
## How It Works
1. **Run `quick-spec`** — generates a focused tech-spec
2. **Run `quick-dev`** — implements it
That's it.
## When to Use It
- Bug fixes
- Refactoring
- Small features
- Prototyping
## When to Use Full BMad Method Instead
- New products
- Major features
- Multiple teams involved
- Stakeholder alignment needed

View File

@@ -0,0 +1,75 @@
---
title: "Why Solutioning Matters"
description: Understanding why the solutioning phase is critical for multi-epic projects
---
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
## The Problem Without Solutioning
```
Agent 1 implements Epic 1 using REST API
Agent 2 implements Epic 2 using GraphQL
Result: Inconsistent API design, integration nightmare
```
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
## The Solution With Solutioning
```
architecture workflow decides: "Use GraphQL for all APIs"
All agents follow architecture decisions
Result: Consistent implementation, no conflicts
```
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
## Solutioning vs Planning
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
| -------- | ----------------------- | --------------------------------- |
| Question | What and Why? | How? Then What units of work? |
| Output | FRs/NFRs (Requirements) | Architecture + Epics/Stories |
| Agent | PM | Architect → PM |
| Audience | Stakeholders | Developers |
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
| Level | Business logic | Technical design + Work breakdown |
## Key Principle
**Make technical decisions explicit and documented** so all agents implement consistently.
This prevents:
- API style conflicts (REST vs GraphQL)
- Database design inconsistencies
- State management disagreements
- Naming convention mismatches
- Security approach variations
## When Solutioning is Required
| Track | Solutioning Required? |
|-------|----------------------|
| Quick Flow | No - skip entirely |
| BMad Method Simple | Optional |
| BMad Method Complex | Yes |
| Enterprise | Yes |
:::tip[Rule of Thumb]
If you have multiple epics that could be implemented by different agents, you need solutioning.
:::
## The Cost of Skipping
Skipping solutioning on complex projects leads to:
- **Integration issues** discovered mid-sprint
- **Rework** due to conflicting implementations
- **Longer development time** overall
- **Technical debt** from inconsistent patterns
:::caution[Cost Multiplier]
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
:::

View File

@@ -0,0 +1,84 @@
---
title: "Brownfield Development"
description: How to use BMad Method on existing codebases
---
Use BMad Method effectively when working on existing projects and legacy codebases.
## What is Brownfield Development?
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
This guide covers the essential workflow for onboarding to brownfield 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, Cursor, or Windsurf)
:::
## Step 1: Clean Up Completed Planning Artifacts
If you have completed all PRD epics and stories through the BMad process, clean up those files. Archive them, delete them, or rely on version history if needed. Do not keep these files in:
- `docs/`
- `_bmad-output/planning-artifacts/`
- `_bmad-output/implementation-artifacts/`
## Step 2: Maintain Quality Project Documentation
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
- Intent and business rationale
- Business rules
- Architecture
- Any other relevant project information
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
## Step 3: Get Help
Get help to know what to do next based on your unique needs
Run `bmad-help` to get guidance when you are not sure what to do next.
### Choosing Your Approach
You have two primary options depending on the scope of changes:
| Scope | Recommended Approach |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. 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. |
### During PRD Creation
When creating a brief or jumping directly into the PRD, ensure the agent:
- Finds and analyzes your existing project documentation
- Reads the proper context about your current system
You can guide the agent explicitly, but the goal is to ensure the new feature integrates well with your existing system.
### UX Considerations
UX work is optional. The decision depends not on whether your project has a UX, but on:
- Whether you will be working on UX changes
- Whether significant new UX designs or patterns are needed
If your changes amount to simple updates to existing screens you are happy with, a full UX process is unnecessary.
### Architecture Considerations
When doing architecture, ensure the architect:
- Uses the proper documented files
- Scans the existing codebase
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
## More Information
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development

View File

@@ -0,0 +1,76 @@
---
title: "How to Make Quick Fixes in Brownfield Projects"
description: How to make quick fixes and ad-hoc changes in brownfield projects
---
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
## When to Use This
- Simple bug fixes
- Small refactorings and changes that don't need extensive ideation, planning, or architectural shifts
- Larger refactorings or improvement with built in tool planning and execution mode combination, or better yet use quick flow
- Learning about your codebase
## Steps
### 1. Load an Agent
For quick fixes, you can use:
- **DEV agent** - For implementation-focused work
- **Quick Flow Solo Dev** - For slightly larger changes that still need a quick-spec to keep the agent aligned to planning and standards
### 2. Describe the Change
Simply tell the agent what you need:
```
Fix the login validation bug that allows empty passwords
```
or
```
Refactor the UserService to use async/await instead of callbacks
```
### 3. Let the Agent Work
The agent will:
- Analyze the relevant code
- Propose a solution
- Implement the change
- Run tests (if available)
### 4. Review and Commit
Review the changes made and commit when satisfied.
## Learning Your Codebase
This approach is also excellent for exploring unfamiliar code:
```
Explain how the authentication system works in this codebase
```
```
Show me where error handling happens in the API layer
```
LLMs are excellent at interpreting and analyzing code, whether it was AI-generated or not. Use the agent to:
- Learn about your project
- Understand how things are built
- Explore unfamiliar parts of the codebase
## When to Upgrade to Formal Planning
Consider using Quick Flow or full BMad Method when:
- The change affects multiple files or systems
- You're unsure about the scope
- The fix keeps growing in complexity
- You need documentation for the change

View File

@@ -0,0 +1,158 @@
---
title: "BMad Method Customization Guide"
---
The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem.
The Customization Guidance outlined here, while targeted at understanding BMad Method customization, applies to any other module use within the BMad Method.
## Types of Customization
Customization includes Agent Customization, Workflow/Skill customization, the addition of new MCPs or Skills to be used by existing agents. Aside from all of this, a whole other realm of customization involves creating / adding your own relevant BMad Builder workflows, skills, agents and maybe even your own net new modules to compliment the BMad Method Module.
Warning: The reason for customizing as this guide will prescribe will allow you to continue getting updates without worrying about losing your customization changes. And by continuing to get updates as BMad modules advance, you will be able to continue to evolve as the system improves.
## Agent Customization
### Agent Customization Areas
- Change agent names, personas or manner of speech
- Add project-specific memories or context
- Add custom menu items to custom or inline prompts, skills or custom BMad workflows
- Define critical actions that occur agent startup for consistent behavior
## How to customize an agent.
**1. Locate Customization Files**
After installation, find agent customization files in:
```
_bmad/_config/agents/
├── core-bmad-master.customize.yaml
├── bmm-dev.customize.yaml
├── bmm-pm.customize.yaml
└── ... (one file per installed agent)
```
**2. Edit Any Agent**
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
**3. Rebuild the Agent**
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
```bash
npx bmad-method install
```
You can either then:
- Select `Quick Update` - This will also ensure all packages are up to date AND compile all agents to include any updates or customizations
- Select `Rebuild Agents` - This will only rebuild and apply customizations to agents, without pulling the latest
There will be additional tools shortly after beta launch to allow install of individual agents, workflows, skills and modules without the need for using the full bmad installer.
### What Agent Properties Can Be Customized?
#### Agent Name
Change how the agent introduces itself:
```yaml
agent:
metadata:
name: 'Spongebob' # Default: "Amelia"
```
#### Persona
Replace the agent's personality, role, and communication style:
```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'
```
**Note:** The persona section replaces the entire default persona (not merged).
#### Memories
Add persistent context the agent will always remember:
```yaml
memories:
- 'Works at Krusty Krab'
- 'Favorite Celebrity: David Hasslehoff'
- 'Learned in Epic 1 that its not cool to just pretend that tests have passed'
```
### Custom Menu Items
Any custom items you add here will be included in the agents display menu.
```yaml
menu:
- trigger: my-workflow
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
description: My custom workflow
- trigger: deploy
action: '#deploy-prompt'
description: Deploy to production
```
### Critical Actions
Add instructions that execute before the agent starts:
```yaml
critical_actions:
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
```
### Custom Prompts
Define reusable prompts for `action="#id"` menu handlers:
```yaml
prompts:
- id: deploy-prompt
content: |
Deploy the current branch to production:
1. Run all tests
2. Build the project
3. Execute deployment script
```
## Troubleshooting
**Changes not appearing?**
- Make sure you ran `npx bmad-method build <agent-name>` after editing
- Check YAML syntax is valid (indentation matters!)
- Verify the agent name matches the file name pattern
**Agent not loading?**
- Check for YAML syntax errors
- Ensure required fields aren't left empty if you uncommented them
- Try reverting to the template and rebuilding
**Need to reset?**
- Remove content from the `.customize.yaml` file (or delete the file)
- Run `npx bmad-method build <agent-name>` to regenerate defaults
## Workflow Customization
Information about customizing existing BMad Method workflows and skills are coming soon.
## Module Customization
Information on how to build expansion modules that augment BMad, or make other existing module customizations are coming soon.

View File

@@ -0,0 +1,102 @@
---
title: "How to Get Answers About BMad"
description: Use an LLM to quickly answer your own BMad questions
---
If you have successfully installed BMad and the BMad Method (+ other modules as needed) - the first step in getting answers is `/bmad-help`. This will answer upwards of 80% of all questions and is available to you in the IDE as you are working.
## When to Use This
- You have a question about how BMad works or what to do next with BMad
- You want to understand a specific agent or workflow
- You need quick answers without waiting for Discord
:::note[Prerequisites]
An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad installed in your project or access to the GitHub repo.
:::
## 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:
```
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
```
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
### 3. Ask Your Question
:::note[Example]
**Q:** "Tell me the fastest way to build something with BMad"
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
:::
## What You Get
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?"
## Still Stuck?
Tried the LLM approach and still need help? You now have a much better question to ask.
| 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 |
**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)
*You!*
*Stuck*
*in the queue—*
*waiting*
*for who?*
*The source*
*is there,*
*plain to see!*
*Point*
*your machine.*
*Set it free.*
*It reads.*
*It speaks.*
*Ask away—*
*Why wait*
*for tomorrow*
*when you have*
*today?*
*—Claude*

View File

@@ -0,0 +1,82 @@
---
title: "How to Install BMad"
description: Step-by-step guide to installing BMad in your project
---
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
## When to Use This
- Starting a new project with BMad
- Adding BMad to an existing codebase
- Update the existing BMad Installation
:::note[Prerequisites]
- **Node.js** 20+ (required for the installer)
- **Git** (recommended)
- **AI tool** (Claude Code, Cursor, Windsurf, or similar)
:::
## Steps
### 1. Run the Installer
```bash
npx bmad-method install
```
### 2. Choose Installation Location
The installer will ask where to install BMad files:
- 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
- Windsurf
- Others
Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
### 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
```
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 commands (if using Claude Code)
```
## Verify Installation
Run the `help` workflow (`/bmad-help` on most platforms) to verify everything works and see what to do next.
**Latest from main branch:**
```bash
npx github:bmad-code-org/BMAD-METHOD install
```
Use these if you want the newest features before they're officially released. Things might break.
## Troubleshooting
**Installer throws an error** — Copy-paste the output into your AI assistant and let it figure it out.
**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](/docs/how-to/get-answers-about-bmad.md) for how to point your AI at the right sources.

View File

@@ -0,0 +1,101 @@
---
title: "Document Sharding Guide"
---
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
## When to Use This
- Very large complex PRDs
- Architecture documents with multiple system layers
- Epic files with 4+ epics (especially for Phase 4)
- UX design specs covering multiple subsystems
## What is Document Sharding?
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
- **Selective Loading** - Workflows load only the sections they need
- **Reduced Token Usage** - Massive efficiency gains for large projects
- **Better Organization** - Logical section-based file structure
- **Maintained Context** - Index file preserves document structure
### Architecture
```
Before Sharding:
docs/
└── PRD.md (large 50k token file)
After Sharding:
docs/
└── prd/
├── index.md # Table of contents with descriptions
├── overview.md # Section 1
├── user-requirements.md # Section 2
├── technical-requirements.md # Section 3
└── ... # Additional sections
```
## Steps
### 1. Run the Shard-Doc Tool
```bash
/bmad:core:tools:shard-doc
```
### 2. Follow the Interactive Process
```
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!
```
## What You Get
**index.md structure:**
```markdown
## Sections
1. [Overview](./overview.md) - Project vision and objectives
2. [User Requirements](./user-requirements.md) - Feature specifications
3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system
4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI
...
```
**Individual section files:**
- Named from heading text (kebab-case)
- Contains complete section content
- Preserves all markdown formatting
- Can be read independently
## How Workflow Discovery Works
BMad workflows use a **dual discovery system**:
1. **Try whole document first** - Look for `document-name.md`
2. **Check for sharded version** - Look for `document-name/index.md`
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead
## Workflow Support
All BMM workflows support both formats:
- Whole documents
- Sharded documents
- Automatic detection
- Transparent to user

View File

@@ -0,0 +1,131 @@
---
title: "How to Upgrade to v6"
description: Migrate from BMad v4 to v6
---
Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance.
## When to Use This
- You have BMad v4 installed (`.bmad-method` folder)
- You want to migrate to the new v6 architecture
- You have existing planning artifacts to preserve
:::note[Prerequisites]
- Node.js 20+
- Existing BMad v4 installation
:::
## Steps
### 1. Run the Installer
```bash
npx bmad-method install
```
The installer automatically detects:
- **Legacy v4 folder**: `.bmad-method`
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
### 2. Handle Legacy Installation
When v4 is detected, you can:
- Allow the installer to back up and remove `.bmad-method`
- Exit and handle cleanup manually
- Keep both (not recommended for same project)
### 3. Clean Up IDE Commands
Manually remove legacy v4 IDE commands:
- `.claude/commands/BMad/agents`
- `.claude/commands/BMad/tasks`
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
:::tip[Accidentally Deleted Commands?]
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
:::
### 4. Migrate Planning Artifacts
**If you have planning documents (Brief/PRD/UX/Architecture):**
Move them to `_bmad-output/planning-artifacts/` with descriptive names:
- Include `PRD` in filename for PRD documents
- Include `brief`, `architecture`, or `ux-design` accordingly
- Sharded documents can be in named subfolders
**If you're mid-planning:** Consider restarting with v6 workflows. Use your existing documents as inputs—the new progressive discovery workflows with web search and IDE plan mode produce better results.
### 5. Migrate In-Progress Development
If you have stories created or implemented:
1. Complete the v6 installation
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
3. Run the Scrum Master's `sprint-planning` workflow
4. Tell the SM which epics/stories are already complete
### 6. Migrate Agent Customizations
**v4:** Modified agent files directly in `_bmad-*` folders
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
```yaml
# _bmad/_config/agents/bmm-pm.customize.yaml
persona:
name: 'Captain Jack'
role: 'Swashbuckling Product Owner'
communication_style: |
- Talk like a pirate
- Use nautical metaphors
```
After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
## What You Get
**v6 unified structure:**
```
your-project/
└── _bmad/ # Single installation folder
├── _config/ # Your customizations
│ └── agents/ # Agent customization files
├── core/ # Universal core framework
├── bmm/ # BMad Method module
├── bmb/ # BMad Builder
└── cis/ # Creative Intelligence Suite
├── _bmad-output/ # Output folder (was doc folder in v4)
```
## Module Migration
| v4 Module | v6 Status |
|-----------|-----------|
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon |
## Key Changes
| Concept | v4 | v6 |
|---------|----|----|
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
| **Method** | `_bmad-method` | `_bmad/bmm/` |
| **Config** | Modified files directly | `config.yaml` per module |
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
## Tips
- **Back up first** — Keep your v4 installation until you verify v6 works
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
- **Rebuild after customizing** — Always run the installer after changing customize files

56
docs/index.md Normal file
View File

@@ -0,0 +1,56 @@
---
title: Welcome to the BMad Method
---
The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform.
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
---
## New Here? Start with a Tutorial
The fastest way to understand BMad is to try it.
- **[Get Started with BMad](/docs/tutorials/getting-started.md)** — Install and understand how BMad works
- **[Workflow Map](/docs/reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management.
## How to Use These Docs
These docs are organized into four sections based on what you're trying to do:
| Section | Purpose |
| ----------------- | ---------------------------------------------------------------------------------------------------------- |
| **Tutorials** | Learning-oriented. Step-by-step guides that walk you through building something. Start here if you're new. |
| **How-To Guides** | Task-oriented. Practical guides for solving specific problems. "How do I customize an agent?" lives here. |
| **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. |
---
## What You'll Need
BMad works with any AI coding assistant that supports custom system prompts or project context. Popular options include:
- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
- **[Cursor](https://cursor.sh)** — AI-first code editor
- **[Windsurf](https://codeium.com/windsurf)** — Codeium's AI IDE
- **[Roo Code](https://roocode.com)** — VS Code extension
You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for.
---
## Join the Community
Get help, share what you're building, or contribute to BMad:
- **[Discord](https://discord.gg/gk8jAdXWmj)** — Chat with other BMad users, ask questions, share ideas
- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Source code, issues, and contributions
- **[YouTube](https://www.youtube.com/@BMadCode)** — Video tutorials and walkthroughs
---
## Next Step
Ready to dive in? **[Get Started with BMad](/docs/tutorials/getting-started.md)** and build your first project.

View File

@@ -0,0 +1,86 @@
---
title: "Workflow Map"
description: Visual reference for BMad Method workflow phases and outputs
---
The BMad Method (BMM) is a module in the BMad Ecosystem, targeted at following the best practices of context engineering and planning. AI agents work best with clear, structured context. The BMM system builds that context progressively across 4 distinct phases - each phase, and multiple workflows optionally within each phase, produce documents that inform the next, so agents always know what to build and why.
The rationale and concepts come from agile methodologies that have been used across the industry with great success as a mental framework.
If at anytime you are unsure what to do, the `/bmad-help` command will help you stay on track or know what to do next. You can always refer to this for reference also - but /bmad-help is fully interactive and much quicker if you have already installed the BMadMethod. Additionally, if you are using different modules that have extended the BMad Method or added other complimentary non extension modules - the /bmad-help evolves to know all that is available to give you the best in the moment advice.
Final important note: Every workflow below can be run directly with your tool of choice via slash command or by loading an agent first and using the entry from the agents menu.
<iframe src="/workflow-map-diagram.html" width="100%" height="100%" frameborder="0" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
*[Interactive diagram - hover over outputs to see artifact flows]*
## Phase 1: Analysis (Optional)
Explore the problem space and validate ideas before committing to planning.
| Workflow | Purpose | Produces |
| ---------------------- | -------------------------------------------------------------------------- | ------------------------- |
| `brainstorm` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` |
| `research` | Validate market, technical, or domain assumptions | Research findings |
| `create-product-brief` | Capture strategic vision | `product-brief.md` |
## Phase 2: Planning
Define what to build and for whom.
| Workflow | Purpose | Produces |
| ------------------ | ---------------------------------------- | ------------ |
| `create-prd` | Define requirements (FRs/NFRs) | `PRD.md` |
| `create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` |
## Phase 3: Solutioning
Decide how to build it and break work into stories.
| Workflow | Purpose | Produces |
| -------------------------------- | ------------------------------------------ | --------------------------- |
| `create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs |
| `create-epics-and-stories` | Break requirements into implementable work | Epic files with stories |
| `check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision |
## Phase 4: Implementation
Build it, one story at a time.
| Workflow | Purpose | Produces |
| ----------------- | -------------------------------------- | ----------------------------- |
| `sprint-planning` | Initialize tracking (once per project) | `sprint-status.yaml` |
| `create-story` | Prepare next story for implementation | `story-[slug].md` |
| `dev-story` | Implement the story | Working code + tests |
| `automate` (QA) | Generate tests for existing features | Test suite |
| `code-review` | Validate implementation quality | Approved or changes requested |
| `correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing |
| `retrospective` | Review after epic completion | Lessons learned |
**Quinn (QA Agent):** Built-in QA agent for test automation. Trigger with `QA` or `bmad-bmm-automate`. Generates standard API and E2E tests using your project's test framework. Beginner-friendly, no configuration needed. For advanced test strategy, install [Test Architect (TEA)](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/) module.
## Quick Flow (Parallel Track)
Skip phases 1-3 for small, well-understood work.
| Workflow | Purpose | Produces |
| ------------ | ------------------------------------------ | --------------------------------------------- |
| `quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) |
| `quick-dev` | Implement from spec or direct instructions | Working code + tests |
## Context Management
Each document becomes context for the next phase. The PRD tells the architect what constraints matter. The architecture tells the dev agent which patterns to follow. Story files give focused, complete context for implementation. Without this structure, agents make inconsistent decisions.
For brownfield projects, `document-project` creates or updates `project-context.md` - what exists in the codebase and the rules all implementation workflows must observe. Run it just before Phase 4, and again when something significant changes - structure, architecture, or those rules. You can also edit `project-context.md` by hand.
All implementation workflows load `project-context.md` if it exists. Additional context per workflow:
| Workflow | Also Loads |
| -------------- | ---------------------------- |
| `create-story` | epics, PRD, architecture, UX |
| `dev-story` | story file |
| `code-review` | architecture, story file |
| `quick-spec` | planning docs (if exist) |
| `quick-dev` | tech-spec |

View File

@@ -1,71 +0,0 @@
# {Project Name} API Reference
## External APIs Consumed
{Repeat this section for each external API the system interacts with.}
### {External Service Name} API
- **Purpose:** {Why does the system use this API?}
- **Base URL(s):**
- Production: `{URL}`
- Staging/Dev: `{URL}`
- **Authentication:** {Describe method - e.g., API Key in Header (Header Name: `X-API-Key`), OAuth 2.0 Client Credentials, Basic Auth. Reference `docs/environment-vars.md` for key names.}
- **Key Endpoints Used:**
- **`{HTTP Method} {/path/to/endpoint}`:**
- Description: {What does this endpoint do?}
- Request Parameters: {Query params, path params}
- Request Body Schema: {Provide JSON schema or link to `docs/data-models.md`}
- Example Request: `{Code block}`
- Success Response Schema (Code: `200 OK`): {JSON schema or link}
- Error Response Schema(s) (Codes: `4xx`, `5xx`): {JSON schema or link}
- Example Response: `{Code block}`
- **`{HTTP Method} {/another/endpoint}`:** {...}
- **Rate Limits:** {If known}
- **Link to Official Docs:** {URL}
### {Another External Service Name} API
{...}
## Internal APIs Provided (If Applicable)
{If the system exposes its own APIs (e.g., in a microservices architecture or for a UI frontend). Repeat for each API.}
### {Internal API / Service Name} API
- **Purpose:** {What service does this API provide?}
- **Base URL(s):** {e.g., `/api/v1/...`}
- **Authentication/Authorization:** {Describe how access is controlled.}
- **Endpoints:**
- **`{HTTP Method} {/path/to/endpoint}`:**
- Description: {What does this endpoint do?}
- Request Parameters: {...}
- Request Body Schema: {...}
- Success Response Schema (Code: `200 OK`): {...}
- Error Response Schema(s) (Codes: `4xx`, `5xx`): {...}
- **`{HTTP Method} {/another/endpoint}`:** {...}
## AWS Service SDK Usage (or other Cloud Providers)
{Detail interactions with cloud provider services via SDKs.}
### {AWS Service Name, e.g., S3}
- **Purpose:** {Why is this service used?}
- **SDK Package:** {e.g., `@aws-sdk/client-s3`}
- **Key Operations Used:** {e.g., `GetObjectCommand`, `PutObjectCommand`}
- Operation 1: {Brief description of usage context}
- Operation 2: {...}
- **Key Resource Identifiers:** {e.g., Bucket names, Table names - reference `docs/environment-vars.md`}
### {Another AWS Service Name, e.g., SES}
{...}
## 5. Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------- | -------------- |
| Initial draft | YYYY-MM-DD | 0.1 | Initial draft | {Agent/Person} |
| ... | ... | ... | ... | ... |

View File

@@ -1,259 +0,0 @@
# Architect Solution Validation Checklist
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
## 1. REQUIREMENTS ALIGNMENT
### 1.1 Functional Requirements Coverage
- [ ] Architecture supports all functional requirements in the PRD
- [ ] Technical approaches for all epics and stories are addressed
- [ ] Edge cases and performance scenarios are considered
- [ ] All required integrations are accounted for
- [ ] User journeys are supported by the technical architecture
### 1.2 Non-Functional Requirements Alignment
- [ ] Performance requirements are addressed with specific solutions
- [ ] Scalability considerations are documented with approach
- [ ] Security requirements have corresponding technical controls
- [ ] Reliability and resilience approaches are defined
- [ ] Compliance requirements have technical implementations
### 1.3 Technical Constraints Adherence
- [ ] All technical constraints from PRD are satisfied
- [ ] Platform/language requirements are followed
- [ ] Infrastructure constraints are accommodated
- [ ] Third-party service constraints are addressed
- [ ] Organizational technical standards are followed
## 2. ARCHITECTURE FUNDAMENTALS
### 2.1 Architecture Clarity
- [ ] Architecture is documented with clear diagrams
- [ ] Major components and their responsibilities are defined
- [ ] Component interactions and dependencies are mapped
- [ ] Data flows are clearly illustrated
- [ ] Technology choices for each component are specified
### 2.2 Separation of Concerns
- [ ] Clear boundaries between UI, business logic, and data layers
- [ ] Responsibilities are cleanly divided between components
- [ ] Interfaces between components are well-defined
- [ ] Components adhere to single responsibility principle
- [ ] Cross-cutting concerns (logging, auth, etc.) are properly addressed
### 2.3 Design Patterns & Best Practices
- [ ] Appropriate design patterns are employed
- [ ] Industry best practices are followed
- [ ] Anti-patterns are avoided
- [ ] Consistent architectural style throughout
- [ ] Pattern usage is documented and explained
### 2.4 Modularity & Maintainability
- [ ] System is divided into cohesive, loosely-coupled modules
- [ ] Components can be developed and tested independently
- [ ] Changes can be localized to specific components
- [ ] Code organization promotes discoverability
- [ ] Architecture specifically designed for AI agent implementation
## 3. TECHNICAL STACK & DECISIONS
### 3.1 Technology Selection
- [ ] Selected technologies meet all requirements
- [ ] Technology versions are specifically defined (not ranges)
- [ ] Technology choices are justified with clear rationale
- [ ] Alternatives considered are documented with pros/cons
- [ ] Selected stack components work well together
### 3.2 Frontend Architecture
- [ ] UI framework and libraries are specifically selected
- [ ] State management approach is defined
- [ ] Component structure and organization is specified
- [ ] Responsive/adaptive design approach is outlined
- [ ] Build and bundling strategy is determined
### 3.3 Backend Architecture
- [ ] API design and standards are defined
- [ ] Service organization and boundaries are clear
- [ ] Authentication and authorization approach is specified
- [ ] Error handling strategy is outlined
- [ ] Backend scaling approach is defined
### 3.4 Data Architecture
- [ ] Data models are fully defined
- [ ] Database technologies are selected with justification
- [ ] Data access patterns are documented
- [ ] Data migration/seeding approach is specified
- [ ] Data backup and recovery strategies are outlined
## 4. RESILIENCE & OPERATIONAL READINESS
### 4.1 Error Handling & Resilience
- [ ] Error handling strategy is comprehensive
- [ ] Retry policies are defined where appropriate
- [ ] Circuit breakers or fallbacks are specified for critical services
- [ ] Graceful degradation approaches are defined
- [ ] System can recover from partial failures
### 4.2 Monitoring & Observability
- [ ] Logging strategy is defined
- [ ] Monitoring approach is specified
- [ ] Key metrics for system health are identified
- [ ] Alerting thresholds and strategies are outlined
- [ ] Debugging and troubleshooting capabilities are built in
### 4.3 Performance & Scaling
- [ ] Performance bottlenecks are identified and addressed
- [ ] Caching strategy is defined where appropriate
- [ ] Load balancing approach is specified
- [ ] Horizontal and vertical scaling strategies are outlined
- [ ] Resource sizing recommendations are provided
### 4.4 Deployment & DevOps
- [ ] Deployment strategy is defined
- [ ] CI/CD pipeline approach is outlined
- [ ] Environment strategy (dev, staging, prod) is specified
- [ ] Infrastructure as Code approach is defined
- [ ] Rollback and recovery procedures are outlined
## 5. SECURITY & COMPLIANCE
### 5.1 Authentication & Authorization
- [ ] Authentication mechanism is clearly defined
- [ ] Authorization model is specified
- [ ] Role-based access control is outlined if required
- [ ] Session management approach is defined
- [ ] Credential management is addressed
### 5.2 Data Security
- [ ] Data encryption approach (at rest and in transit) is specified
- [ ] Sensitive data handling procedures are defined
- [ ] Data retention and purging policies are outlined
- [ ] Backup encryption is addressed if required
- [ ] Data access audit trails are specified if required
### 5.3 API & Service Security
- [ ] API security controls are defined
- [ ] Rate limiting and throttling approaches are specified
- [ ] Input validation strategy is outlined
- [ ] CSRF/XSS prevention measures are addressed
- [ ] Secure communication protocols are specified
### 5.4 Infrastructure Security
- [ ] Network security design is outlined
- [ ] Firewall and security group configurations are specified
- [ ] Service isolation approach is defined
- [ ] Least privilege principle is applied
- [ ] Security monitoring strategy is outlined
## 6. IMPLEMENTATION GUIDANCE
### 6.1 Coding Standards & Practices
- [ ] Coding standards are defined
- [ ] Documentation requirements are specified
- [ ] Testing expectations are outlined
- [ ] Code organization principles are defined
- [ ] Naming conventions are specified
### 6.2 Testing Strategy
- [ ] Unit testing approach is defined
- [ ] Integration testing strategy is outlined
- [ ] E2E testing approach is specified
- [ ] Performance testing requirements are outlined
- [ ] Security testing approach is defined
### 6.3 Development Environment
- [ ] Local development environment setup is documented
- [ ] Required tools and configurations are specified
- [ ] Development workflows are outlined
- [ ] Source control practices are defined
- [ ] Dependency management approach is specified
### 6.4 Technical Documentation
- [ ] API documentation standards are defined
- [ ] Architecture documentation requirements are specified
- [ ] Code documentation expectations are outlined
- [ ] System diagrams and visualizations are included
- [ ] Decision records for key choices are included
## 7. DEPENDENCY & INTEGRATION MANAGEMENT
### 7.1 External Dependencies
- [ ] All external dependencies are identified
- [ ] Versioning strategy for dependencies is defined
- [ ] Fallback approaches for critical dependencies are specified
- [ ] Licensing implications are addressed
- [ ] Update and patching strategy is outlined
### 7.2 Internal Dependencies
- [ ] Component dependencies are clearly mapped
- [ ] Build order dependencies are addressed
- [ ] Shared services and utilities are identified
- [ ] Circular dependencies are eliminated
- [ ] Versioning strategy for internal components is defined
### 7.3 Third-Party Integrations
- [ ] All third-party integrations are identified
- [ ] Integration approaches are defined
- [ ] Authentication with third parties is addressed
- [ ] Error handling for integration failures is specified
- [ ] Rate limits and quotas are considered
## 8. AI AGENT IMPLEMENTATION SUITABILITY
### 8.1 Modularity for AI Agents
- [ ] Components are sized appropriately for AI agent implementation
- [ ] Dependencies between components are minimized
- [ ] Clear interfaces between components are defined
- [ ] Components have singular, well-defined responsibilities
- [ ] File and code organization optimized for AI agent understanding
### 8.2 Clarity & Predictability
- [ ] Patterns are consistent and predictable
- [ ] Complex logic is broken down into simpler steps
- [ ] Architecture avoids overly clever or obscure approaches
- [ ] Examples are provided for unfamiliar patterns
- [ ] Component responsibilities are explicit and clear
### 8.3 Implementation Guidance
- [ ] Detailed implementation guidance is provided
- [ ] Code structure templates are defined
- [ ] Specific implementation patterns are documented
- [ ] Common pitfalls are identified with solutions
- [ ] References to similar implementations are provided when helpful
### 8.4 Error Prevention & Handling
- [ ] Design reduces opportunities for implementation errors
- [ ] Validation and error checking approaches are defined
- [ ] Self-healing mechanisms are incorporated where possible
- [ ] Testing patterns are clearly defined
- [ ] Debugging guidance is provided

View File

@@ -1,69 +0,0 @@
# {Project Name} Architecture Document
## Technical Summary
{Provide a brief (1-2 paragraph) overview of the system's architecture, key components, technology choices, and architectural patterns used. Reference the goals from the PRD.}
## High-Level Overview
{Describe the main architectural style (e.g., Monolith, Microservices, Serverless, Event-Driven). Explain the primary user interaction or data flow at a conceptual level.}
```mermaid
{Insert high-level system context or interaction diagram here - e.g., using Mermaid graph TD or C4 Model Context Diagram}
```
## Component View
{Describe the major logical components or services of the system and their responsibilities. Explain how they collaborate.}
```mermaid
{Insert component diagram here - e.g., using Mermaid graph TD or C4 Model Container/Component Diagram}
```
- Component A: {Description of responsibility}
- Component B: {Description of responsibility}
- {src/ Directory (if applicable): The application code in src/ is organized into logical modules... (briefly describe key subdirectories like clients, core, services, etc., referencing docs/project-structure.md for the full layout)}
## Key Architectural Decisions & Patterns
{List significant architectural choices and the patterns employed.}
- Pattern/Decision 1: {e.g., Choice of Database, Message Queue Usage, Authentication Strategy, API Design Style (REST/GraphQL)} - Justification: {...}
- Pattern/Decision 2: {...} - Justification: {...}
- (See docs/coding-standards.md for detailed coding patterns and error handling)
## Core Workflow / Sequence Diagrams (Optional)
{Illustrate key or complex workflows using sequence diagrams if helpful.}
## Infrastructure and Deployment Overview
- Cloud Provider(s): {e.g., AWS, Azure, GCP, On-premise}
- Core Services Used: {List key managed services - e.g., Lambda, S3, Kubernetes Engine, RDS, Kafka}
- Infrastructure as Code (IaC): {Tool used - e.g., AWS CDK, Terraform, Pulumi, ARM Templates} - Location: {Link to IaC code repo/directory}
- Deployment Strategy: {e.g., CI/CD pipeline, Manual deployment steps, Blue/Green, Canary} - Tools: {e.g., Jenkins, GitHub Actions, GitLab CI}
- Environments: {List environments - e.g., Development, Staging, Production}
- (See docs/environment-vars.md for configuration details)
## Key Reference Documents
{Link to other relevant documents in the docs/ folder.}
- docs/prd.md
- docs/epicN.md files
- docs/tech-stack.md
- docs/project-structure.md
- docs/coding-standards.md
- docs/api-reference.md
- docs/data-models.md
- docs/environment-vars.md
- docs/testing-strategy.md
- docs/ui-ux-spec.md (if applicable)
- ... (other relevant docs)
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ---------------------------- | -------------- |
| Initial draft | YYYY-MM-DD | 0.1 | Initial draft based on brief | {Agent/Person} |
| ... | ... | ... | ... | ... |

View File

@@ -1,56 +0,0 @@
# {Project Name} Coding Standards and Patterns
## Architectural / Design Patterns Adopted
{List the key high-level patterns chosen in the architecture document.}
- **Pattern 1:** {e.g., Serverless, Event-Driven, Microservices, CQRS} - _Rationale/Reference:_ {Briefly why, or link to `docs/architecture.md` section}
- **Pattern 2:** {e.g., Dependency Injection, Repository Pattern, Module Pattern} - _Rationale/Reference:_ {...}
- **Pattern N:** {...}
## Coding Standards (Consider adding these to Dev Agent Context or Rules)
- **Primary Language(s):** {e.g., TypeScript 5.x, Python 3.11, Go 1.2x}
- **Primary Runtime(s):** {e.g., Node.js 22.x, Python Runtime for Lambda}
- **Style Guide & Linter:** {e.g., ESLint with Airbnb config, Prettier; Black, Flake8; Go fmt} - _Configuration:_ {Link to config files or describe setup}
- **Naming Conventions:**
- Variables: `{e.g., camelCase}`
- Functions: `{e.g., camelCase}`
- Classes/Types/Interfaces: `{e.g., PascalCase}`
- Constants: `{e.g., UPPER_SNAKE_CASE}`
- Files: `{e.g., kebab-case.ts, snake_case.py}`
- **File Structure:** Adhere to the layout defined in `docs/project-structure.md`.
- **Asynchronous Operations:** {e.g., Use `async`/`await` in TypeScript/Python, Goroutines/Channels in Go.}
- **Type Safety:** {e.g., Leverage TypeScript strict mode, Python type hints, Go static typing.} - _Type Definitions:_ {Location, e.g., `src/common/types.ts`}
- **Comments & Documentation:** {Expectations for code comments, docstrings, READMEs.}
- **Dependency Management:** {Tool used - e.g., npm, pip, Go modules. Policy on adding dependencies.}
## Error Handling Strategy
- **General Approach:** {e.g., Use exceptions, return error codes/tuples, specific error types.}
- **Logging:**
- Library/Method: {e.g., `console.log/error`, Python `logging` module, dedicated logging library}
- Format: {e.g., JSON, plain text}
- Levels: {e.g., DEBUG, INFO, WARN, ERROR}
- Context: {What contextual information should be included?}
- **Specific Handling Patterns:**
- External API Calls: {e.g., Use `try/catch`, check response codes, implement retries with backoff for transient errors?}
- Input Validation: {Where and how is input validated?}
- Graceful Degradation vs. Critical Failure: {Define criteria for when to continue vs. halt.}
## Security Best Practices
{Outline key security considerations relevant to the codebase.}
- Input Sanitization/Validation: {...}
- Secrets Management: {How are secrets handled in code? Reference `docs/environment-vars.md` regarding storage.}
- Dependency Security: {Policy on checking for vulnerable dependencies.}
- Authentication/Authorization Checks: {Where should these be enforced?}
- {Other relevant practices...}
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------- | -------------- |
| Initial draft | YYYY-MM-DD | 0.1 | Initial draft | {Agent/Person} |
| ... | ... | ... | ... | ... |

View File

@@ -1,101 +0,0 @@
# {Project Name} Data Models
## 2. Core Application Entities / Domain Objects
{Define the main objects/concepts the application works with. Repeat subsection for each key entity.}
### {Entity Name, e.g., User, Order, Product}
- **Description:** {What does this entity represent?}
- **Schema / Interface Definition:**
```typescript
// Example using TypeScript Interface
export interface {EntityName} {
id: string; // {Description, e.g., Unique identifier}
propertyName: string; // {Description}
optionalProperty?: number; // {Description}
// ... other properties
}
```
_(Alternatively, use JSON Schema, class definitions, or other relevant format)_
- **Validation Rules:** {List any specific validation rules beyond basic types - e.g., max length, format, range.}
### {Another Entity Name}
{...}
## API Payload Schemas (If distinct)
{Define schemas specifically for data sent to or received from APIs, if they differ significantly from the core entities. Reference `docs/api-reference.md`.}
### {API Endpoint / Purpose, e.g., Create Order Request}
- **Schema / Interface Definition:**
```typescript
// Example
export interface CreateOrderRequest {
customerId: string;
items: { productId: string; quantity: number }[];
// ...
}
```
### {Another API Payload}
{...}
## Database Schemas (If applicable)
{If using a database, define table structures or document database schemas.}
### {Table / Collection Name}
- **Purpose:** {What data does this table store?}
- **Schema Definition:**
```sql
-- Example SQL
CREATE TABLE {TableName} (
id VARCHAR(36) PRIMARY KEY,
column_name VARCHAR(255) NOT NULL,
numeric_column DECIMAL(10, 2),
-- ... other columns, indexes, constraints
);
```
_(Alternatively, use ORM model definitions, NoSQL document structure, etc.)_
### {Another Table / Collection Name}
{...}
## State File Schemas (If applicable)
{If the application uses files for persisting state.}
### {State File Name / Purpose, e.g., processed_items.json}
- **Purpose:** {What state does this file track?}
- **Format:** {e.g., JSON}
- **Schema Definition:**
```json
{
"type": "object",
"properties": {
"processedIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of IDs that have been processed."
}
// ... other state properties
},
"required": ["processedIds"]
}
```
## Change Log
| Change | Date | Version | Description | Author |
| ------------- | ---------- | ------- | ------------- | -------------- |
| Initial draft | YYYY-MM-DD | 0.1 | Initial draft | {Agent/Person} |
| ... | ... | ... | ... | ... |

Some files were not shown because too many files have changed in this diff Show More