Commit Graph

61 Commits

Author SHA1 Message Date
manjaroblack 19c8458d6a
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.
2025-07-25 01:42:30 -05:00
manjaroblack 7a34ca8eca 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
2025-07-19 23:26:58 -05:00
manjaroblack 125b464b2f 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.
2025-07-19 22:09:39 -05: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
Brian Madison 8619006c16 fix: docs 2025-07-19 00:36:13 -05:00
Zach d1bed26e5d
Fix `team-fullstack.txt` path in bmad-workflow-guide.md (#327) 2025-07-17 20:02:39 -05:00
Brian Madison d0a8c581af fixed roomodes double bmad 2025-07-16 23:36:24 -05:00
Brian Madison f62c05ab0f fix: brianstorming facilitation output 2025-07-13 11:33:06 -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
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
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
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 094f9f3eab fix: yaml standardization in files and installer actions 2025-07-04 11:53:57 -05: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 f440d14565 doc and text cleanup 2025-07-04 07:47:57 -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
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
David Elisma 1a4ca4ffa6
feat: VS Code Copilot integration (#284) 2025-07-01 07:54:13 -05:00
Brian Madison ab70b8dc73 contribution updates 2025-06-29 11:30:15 -05: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 6cdecec61f fix minor lint issue 2025-06-27 20:33:07 -05: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
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
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 ff6112d6c2 feat: Core Config and doc sharding is now optional in v4 2025-06-19 18:57:19 -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
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 e663a1146b feat: extensive bmad-kb for web orchestrator to be much more helpful 2025-06-19 09:17:48 -05:00
Brian Madison bc7cc0439a removed bad template updates from previous autoformatter 2025-06-17 21:40:59 -05:00
Brian Madison a954c7e242 fix: docs had some ide specific errors 2025-06-17 19:41:38 -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 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 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 e08add957d simple prd workflow 2025-06-15 11:05:06 -05:00
Brian Madison 48ef875f5e fix: add docs 2025-06-15 01:18:55 -05:00
Brian Madison 166ed04767 fix: auto semantic versioning fix 2025-06-14 20:09:20 -05:00
Brian Madison bc3f60df91 versioning doc 2025-06-14 18:27:08 -05:00
Brian Madison e4d64c8f05 docs update 2025-06-13 07:27:22 -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 8ad54024d5 build cleanup 2025-06-08 20:46:44 -05:00
Brian Madison f1fa6256f0 agent team workflows 2025-06-08 17:34:38 -05:00
Brian Madison aa3d8eba67 doc updates, build folder renamed to tools, readme clarity for v4 2025-06-08 10:36:23 -05:00
Brian Madison b22255762d docs updated 2025-06-08 02:30:28 -05:00