npm - bmad-method - Versions diffs - 6.0.0-alpha.9 → 6.0.1 - Mend

bmad-method 6.0.0-alpha.9 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (931) hide show

package/docs/agent-customization-guide.md DELETED Viewed

@@ -1,208 +0,0 @@
-# Agent Customization Guide
-Customize BMad agents without modifying core files. All customizations persist through updates.
-## Quick Start
-**1. Locate Customization Files**
-After installation, find agent customization files in:
-```
-{bmad_folder}/_cfg/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@alpha install # and then select option to compile all agents
-# OR for individual agent only
-npx bmad-method@alpha build <agent-name>
-# Examples:
-npx bmad-method@alpha build bmm-dev
-npx bmad-method@alpha build core-bmad-master
-npx bmad-method@alpha build bmm-pm
-```
-## What You Can Customize
-### 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'
-  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
-Add your own workflows to the agent's menu:
-```yaml
-menu:
-  - trigger: my-workflow
-    workflow: '{project-root}/custom/my-workflow.yaml'
-    description: My custom workflow
-  - trigger: deploy
-    action: '#deploy-prompt'
-    description: Deploy to production
-```
-**Don't include:** `*` prefix or `help`/`exit` items - these are auto-injected.
-### Critical Actions
-Add instructions that execute before the agent starts:
-```yaml
-critical_actions:
-  - 'Always check git status before making changes'
-  - 'Use conventional commit messages'
-```
-### 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
-```
-## Real-World Examples
-**Example 1: Customize Developer Agent for TDD**
-```yaml
-# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
-agent:
-  metadata:
-    name: 'TDD Developer'
-memories:
-  - 'Always write tests before implementation'
-  - 'Project uses Jest and React Testing Library'
-critical_actions:
-  - 'Review test coverage before committing'
-```
-**Example 2: Add Custom Deployment Workflow**
-```yaml
-# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
-menu:
-  - trigger: deploy-staging
-    workflow: '{project-root}/.bmad-custom/deploy-staging.yaml'
-    description: Deploy to staging environment
-  - trigger: deploy-prod
-    workflow: '{project-root}/.bmad-custom/deploy-prod.yaml'
-    description: Deploy to production (with approval)
-```
-**Example 3: Multilingual Product Manager**
-```yaml
-# {bmad_folder}/_cfg/agents/bmm-pm.customize.yaml
-persona:
-  role: 'Bilingual Product Manager'
-  identity: 'Expert in US and LATAM markets'
-  communication_style: 'Clear, strategic, with cultural awareness'
-  principles:
-    - 'Consider localization from day one'
-    - 'Balance business goals with user needs'
-memories:
-  - 'User speaks English and Spanish'
-  - 'Target markets: US and Latin America'
-```
-## Tips
-- **Start Small:** Customize one section at a time and rebuild to test
-- **Backup:** Copy customization files before major changes
-- **Update-Safe:** Your customizations in `_cfg/` survive all BMad updates
-- **Per-Project:** Customization files are per-project, not global
-- **Version Control:** Consider committing `_cfg/` to share customizations with your team
-## Module vs. Global Config
-**Module-Level (Recommended):**
-- Customize agents per-project in `{bmad_folder}/_cfg/agents/`
-- Different projects can have different agent behaviors
-**Global Config (Coming Soon):**
-- Set defaults that apply across all projects
-- Override with project-specific customizations
-## 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?**
-- Delete the `.customize.yaml` file
-- Run `npx bmad-method build <agent-name>` to regenerate defaults
-## Next Steps
-- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about all 12 BMad Method agents
-- **[BMB Create Agent Workflow](../src/modules/bmb/workflows/create-agent/README.md)** - Build completely custom agents
-- **[BMM Complete Documentation](../src/modules/bmm/docs/README.md)** - Full BMad Method reference

package/docs/document-sharding-guide.md DELETED Viewed

@@ -1,447 +0,0 @@
-# Document Sharding Guide
-Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
-## Table of Contents
-- [What is Document Sharding?](#what-is-document-sharding)
-- [When to Use Sharding](#when-to-use-sharding)
-- [How Sharding Works](#how-sharding-works)
-- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
-- [Workflow Support](#workflow-support)
-- [Best Practices](#best-practices)
-- [Examples](#examples)
-## 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
-```
-## When to Use Sharding
-### Ideal Candidates
-**Large Multi-Epic Projects:**
-- 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
-**Token Thresholds:**
-- **Consider sharding**: Documents > 20k tokens
-- **Strongly recommended**: Documents > 40k tokens
-- **Critical for efficiency**: Documents > 60k tokens
-### When NOT to Shard
-**Small Projects:**
-- Single epic projects
-- Level 0-1 projects (tech-spec only)
-- Documents under 10k tokens
-- Quick prototypes
-**Frequently Updated Docs:**
-- Active work-in-progress documents
-- Documents updated daily
-- Documents where whole-file context is essential
-## How Sharding Works
-### Sharding Process
-1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
-2. **Section Extraction**: Tool splits by level 2 headings
-3. **File Creation**: Each section becomes a separate file
-4. **Index Generation**: `index.md` created with structure and descriptions
-### Workflow Discovery
-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
-### Loading Strategies
-**Full Load (Phase 1-3 workflows):**
-```
-If sharded:
-  - Read index.md
-  - Read ALL section files
-  - Treat as single combined document
-```
-**Selective Load (Phase 4 workflows):**
-```
-If sharded epics and working on Epic 3:
-  - Read epics/index.md
-  - Load ONLY epics/epic-3.md
-  - Skip all other epic files
-  - 90%+ token savings!
-```
-## Using the Shard-Doc Tool
-### CLI Command
-```bash
-# Activate bmad-master or analyst agent, then:
-/shard-doc
-```
-### 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 Gets Created
-**index.md structure:**
-```markdown
-# PRD - Index
-## 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
-## Workflow Support
-### Universal Support
-**All BMM workflows support both formats:**
-- ✅ Whole documents
-- ✅ Sharded documents
-- ✅ Automatic detection
-- ✅ Transparent to user
-### Workflow-Specific Patterns
-#### Phase 1-3 (Full Load)
-Workflows load entire sharded documents:
-- `product-brief` - Research, brainstorming docs
-- `prd` - Product brief, research
-- `gdd` - Game brief, research
-- `create-ux-design` - PRD, brief, epics
-- `tech-spec` - Brief, research
-- `architecture` - PRD, epics, UX design
-- `solutioning-gate-check` - All planning docs
-#### Phase 4 (Selective Load)
-Workflows load only needed sections:
-**sprint-planning** (Full Load):
-- Needs ALL epics to build complete status
-**epic-tech-context, create-story, story-context, code-review** (Selective):
-```
-Working on Epic 3, Story 2:
-  ✓ Load epics/epic-3.md only
-  ✗ Skip epics/epic-1.md, epic-2.md, epic-4.md, etc.
-Result: 90%+ token reduction for 10-epic projects!
-```
-### Input File Patterns
-Workflows use standardized patterns:
-```yaml
-input_file_patterns:
-  prd:
-    whole: '{output_folder}/*prd*.md'
-    sharded: '{output_folder}/*prd*/index.md'
-  epics:
-    whole: '{output_folder}/*epic*.md'
-    sharded_index: '{output_folder}/*epic*/index.md'
-    sharded_single: '{output_folder}/*epic*/epic-{{epic_num}}.md'
-```
-## Best Practices
-### Sharding Strategy
-**Do:**
-- ✅ Shard after planning phase complete
-- ✅ Keep level 2 headings well-organized
-- ✅ Use descriptive section names
-- ✅ Shard before Phase 4 implementation
-- ✅ Keep original file as backup initially
-**Don't:**
-- ❌ Shard work-in-progress documents
-- ❌ Shard small documents (<20k tokens)
-- ❌ Mix sharded and whole versions
-- ❌ Manually edit index.md structure
-### Naming Conventions
-**Good Section Names:**
-```markdown
-## Epic 1: User Authentication
-## Technical Requirements
-## System Architecture
-## UX Design Principles
-```
-**Poor Section Names:**
-```markdown
-## Section 1
-## Part A
-## Details
-## More Info
-```
-### File Management
-**When to Re-shard:**
-- Significant structural changes to document
-- Adding/removing major sections
-- After major refactoring
-**Updating Sharded Docs:**
-1. Edit individual section files directly
-2. OR edit original, delete sharded folder, re-shard
-3. Don't manually edit index.md
-## Examples
-### Example 1: Large PRD
-**Scenario:** 15-epic project, PRD is 45k tokens
-**Before Sharding:**
-```
-Every workflow loads entire 45k token PRD
-Epic-tech-context for Epic 3: 45k tokens
-Create-story for Epic 3: 45k tokens
-```
-**After Sharding:**
-```bash
-/shard-doc
-Source: docs/PRD.md
-Destination: docs/prd/
-Created:
-  prd/index.md
-  prd/overview.md (3k tokens)
-  prd/epic-1-auth.md (3k tokens)
-  prd/epic-2-dashboard.md (3k tokens)
-  prd/epic-3-reports.md (3k tokens)
-  ...15 epic files
-```
-**Result:**
-```
-Epic-tech-context for Epic 3: 3k tokens (93% reduction!)
-Create-story for Epic 3: 3k tokens (93% reduction!)
-```
-### Example 2: Sharding Epics File
-**Scenario:** 8 epics with detailed stories, 35k tokens total
-```bash
-/shard-doc
-Source: docs/bmm-epics.md
-Destination: docs/epics/
-Created:
-  epics/index.md
-  epics/epic-1.md
-  epics/epic-2.md
-  ...
-  epics/epic-8.md
-```
-**Efficiency Gain:**
-```
-Working on Epic 5 stories:
-  Old: Load all 8 epics (35k tokens)
-  New: Load epic-5.md only (4k tokens)
-  Savings: 88% reduction
-```
-### Example 3: Architecture Document
-**Scenario:** Multi-layer system architecture, 28k tokens
-```bash
-/shard-doc
-Source: docs/architecture.md
-Destination: docs/architecture/
-Created:
-  architecture/index.md
-  architecture/system-overview.md
-  architecture/frontend-architecture.md
-  architecture/backend-services.md
-  architecture/data-layer.md
-  architecture/infrastructure.md
-  architecture/security-architecture.md
-```
-**Benefit:** Code-review workflow can reference specific architectural layers without loading entire architecture doc.
-## Custom Workflow Integration
-### For Workflow Builders
-When creating custom workflows that load large documents:
-**1. Add input_file_patterns to workflow.yaml:**
-```yaml
-input_file_patterns:
-  your_document:
-    whole: '{output_folder}/*your-doc*.md'
-    sharded: '{output_folder}/*your-doc*/index.md'
-```
-**2. Add discovery instructions to instructions.md:**
-```markdown
-## Document Discovery
-1. Search for whole document: _your-doc_.md
-2. Check for sharded version: _your-doc_/index.md
-3. If sharded: Read index + ALL sections (or specific sections if selective load)
-4. Priority: Whole document first
-```
-**3. Choose loading strategy:**
-- **Full Load**: Read all sections when sharded
-- **Selective Load**: Read only relevant sections (requires section identification logic)
-### Pattern Templates
-**Full Load Pattern:**
-```xml
-<action>Search for document: {output_folder}/*doc-name*.md</action>
-<action>If not found, check for sharded: {output_folder}/*doc-name*/index.md</action>
-<action if="sharded found">Read index.md to understand structure</action>
-<action if="sharded found">Read ALL section files listed in index</action>
-<action if="sharded found">Combine content as single document</action>
-```
-**Selective Load Pattern (with section ID):**
-```xml
-<action>Determine section needed (e.g., epic_num = 3)</action>
-<action>Check for sharded version: {output_folder}/*doc-name*/index.md</action>
-<action if="sharded found">Read ONLY the specific section file needed</action>
-<action if="sharded found">Skip all other section files</action>
-```
-## Troubleshooting
-### Common Issues
-**Both whole and sharded exist:**
-- Workflows will use whole document (priority rule)
-- Delete or archive the one you don't want
-**Index.md out of sync:**
-- Delete sharded folder
-- Re-run shard-doc on original
-**Workflow can't find document:**
-- Check file naming matches patterns (`*prd*.md`, `*epic*.md`, etc.)
-- Verify index.md exists in sharded folder
-- Check output_folder path in config
-**Sections too granular:**
-- Combine sections in original document
-- Use fewer level 2 headings
-- Re-shard
-## Related Documentation
-- [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation
-- [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Workflow overview
-- [Workflow Creation Guide](../src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md) - Custom workflow patterns
----
-**Document sharding is optional but powerful** - use it when efficiency matters for large projects!

package/docs/ide-info/auggie.md DELETED Viewed

@@ -1,31 +0,0 @@
-# BMAD Method - Auggie CLI Instructions
-## Activating Agents
-BMAD agents can be installed in multiple locations based on your setup.
-### Common Locations
-- User Home: `~/.augment/commands/`
-- Project: `.augment/commands/`
-- Custom paths you selected
-### How to Use
-1. **Type Trigger**: Use `@{agent-name}` in your prompt
-2. **Activate**: Agent persona activates
-3. **Tasks**: Use `@task-{task-name}` for tasks
-### Examples
-```
-@dev - Activate development agent
-@architect - Activate architect agent
-@task-setup - Execute setup task
-```
-### Notes
-- Agents can be in multiple locations
-- Check your installation paths
-- Activation syntax same across all locations

package/docs/ide-info/claude-code.md DELETED Viewed

@@ -1,25 +0,0 @@
-# BMAD Method - Claude Code Instructions
-## Activating Agents
-BMAD agents are installed as slash commands in `.claude/commands/bmad/`.
-### How to Use
-1. **Type Slash Command**: Start with `/` to see available commands
-2. **Select Agent**: Type `/bmad-{agent-name}` (e.g., `/bmad-dev`)
-3. **Execute**: Press Enter to activate that agent persona
-### Examples
-```
-/bmad:bmm:agents:dev - Activate development agent
-/bmad:bmm:agents:architect - Activate architect agent
-/bmad:bmm:workflows:dev-story - Execute dev-story workflow
-```
-### Notes
-- Commands are autocompleted when you type `/`
-- Agent remains active for the conversation
-- Start a new conversation to switch agents