bmad-method 6.0.0-alpha.15 → 6.0.0-alpha.16

package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md

@@ -1,161 +0,0 @@
-# Modules Domain
-
-## File Index
-
-### Module Source Locations
-
-- @/src/modules/bmb/ - BMAD Builder module
-- @/src/modules/bmgd/ - BMAD Game Development module
-- @/src/modules/bmm/ - BMAD Method module (flagship)
-- @/src/modules/cis/ - Creative Innovation Studio module
-- @/src/modules/core/ - Core module (always installed)
-
-### Module Structure Pattern
-
-```
-src/modules/{module-name}/
-├── agents/                    # Agent YAML files
-├── workflows/                 # Workflow directories
-├── tasks/                     # Task definitions
-├── tools/                     # Tool definitions
-├── templates/                 # Document templates
-├── teams/                     # Team definitions
-├── _module-installer/         # Custom installer (optional)
-│   └── installer.js
-├── sub-modules/               # IDE-specific customizations
-│   └── {ide-name}/
-│       ├── injections.yaml
-│       ├── config.yaml
-│       └── sub-agents/
-├── module.yaml        # Module install configuration
-└── README.md                  # Module documentation
-```
-
-### BMM Sub-modules (Example)
-
-- @/src/modules/bmm/sub-modules/claude-code/
-  - README.md - Sub-module documentation
-  - config.yaml - Configuration
-  - injections.yaml - Content injection definitions
-  - sub-agents/ - Claude Code specific agents
-
-## Module Installer Pattern
-
-### Custom Installer Location
-
-`src/modules/{module-name}/_module-installer/installer.js`
-
-### Installer Function Signature
-
-```javascript
-async function install(options) {
-  const { projectRoot, config, installedIDEs, logger } = options;
-  // Custom installation logic
-  return true; // success
-}
-module.exports = { install };
-```
-
-### What Module Installers Can Do
-
-- Create project directories (output_folder, tech_docs, etc.)
-- Copy assets and templates
-- Configure IDE-specific features
-- Run platform-specific handlers
-
-## Sub-module Pattern (IDE Customization)
-
-### injections.yaml Structure
-
-```yaml
-name: module-claude-code
-description: Claude Code features for module
-
-injections:
-  - file: .bmad/bmm/agents/pm.md
-    point: pm-agent-instructions
-    content: |
-      Injected content...
-    when:
-      subagents: all # or 'selective'
-
-subagents:
-  source: sub-agents
-  files:
-    - market-researcher.md
-    - requirements-analyst.md
-```
-
-### How Sub-modules Work
-
-1. Installer detects sub-module exists
-2. Loads injections.yaml
-3. Prompts user for options (subagent installation)
-4. Applies injections to installed files
-5. Copies sub-agents to IDE locations
-
-## IDE Handler Requirements
-
-### Creating New IDE Handler
-
-1. Create file: `tools/cli/installers/lib/ide/{ide-name}.js`
-2. Extend BaseIdeSetup
-3. Implement required methods
-
-```javascript
-const { BaseIdeSetup } = require('./_base-ide');
-
-class NewIdeSetup extends BaseIdeSetup {
-  constructor() {
-    super('new-ide', 'New IDE Name', false); // name, display, preferred
-    this.configDir = '.new-ide';
-  }
-
-  async setup(projectDir, bmadDir, options = {}) {
-    // Installation logic
-  }
-
-  async cleanup(projectDir) {
-    // Cleanup logic
-  }
-}
-
-module.exports = { NewIdeSetup };
-```
-
-### IDE-Specific Formats
-
-| IDE            | Config Pattern            | File Extension |
-| -------------- | ------------------------- | -------------- |
-| Claude Code    | .claude/commands/bmad/    | .md            |
-| Cursor         | .cursor/rules/bmad/       | .mdc           |
-| Windsurf       | .windsurf/workflows/bmad/ | .md            |
-| GitHub Copilot | .github/                  | .md            |
-
-## Platform Codes
-
-Defined in @/tools/cli/lib/platform-codes.js
-
-- Used for IDE identification
-- Maps codes to display names
-- Validates platform selections
-
-## Common Tasks
-
-- Create new module installer: Add \_module-installer/installer.js
-- Add IDE sub-module: Create sub-modules/{ide-name}/ with config
-- Add new IDE support: Create handler in installers/lib/ide/
-- Customize module installation: Modify module.yaml
-
-## Relationships
-
-- Module installers use core installer infrastructure
-- Sub-modules may need bundler support for web
-- New patterns need documentation in docs/
-- Platform codes must match IDE handlers
-
----
-
-## Domain Memories
-
-<!-- Vexor appends module-specific learnings here -->

package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/tests.md

@@ -1,103 +0,0 @@
-# Tests Domain
-
-## File Index
-
-### Test Files
-
-- @/test/test-agent-schema.js - Agent schema validation tests
-- @/test/test-installation-components.js - Installation component tests
-- @/test/test-cli-integration.sh - CLI integration tests (shell script)
-- @/test/unit-test-schema.js - Unit test schema
-- @/test/README.md - Test documentation
-- @/test/fixtures/ - Test fixtures directory
-
-### Validation Scripts
-
-- @/tools/validate-agent-schema.js - Validates all agent YAML schemas
-- @/tools/validate-bundles.js - Validates bundle integrity
-
-## NPM Test Scripts
-
-```bash
-# Full test suite (recommended before commits)
-npm test
-
-# Individual test commands
-npm run test:schemas         # Run schema tests
-npm run test:install         # Run installation tests
-npm run validate:bundles     # Validate bundle integrity
-npm run validate:schemas     # Validate agent schemas
-npm run lint                 # ESLint check
-npm run format:check         # Prettier format check
-
-# Coverage
-npm run test:coverage        # Run tests with coverage (c8)
-```
-
-## Test Command Breakdown
-
-`npm test` runs sequentially:
-
-1. `npm run test:schemas` - Agent schema validation
-2. `npm run test:install` - Installation component tests
-3. `npm run validate:bundles` - Bundle validation
-4. `npm run validate:schemas` - Schema validation
-5. `npm run lint` - ESLint
-6. `npm run format:check` - Prettier check
-
-## Testing Patterns
-
-### Schema Validation
-
-- Uses Zod for schema definition
-- Validates agent YAML structure
-- Checks required fields, types, formats
-
-### Installation Tests
-
-- Tests core installer components
-- Validates IDE handler setup
-- Tests configuration collection
-
-### Linting & Formatting
-
-- ESLint with plugins: n, unicorn, yml
-- Prettier for formatting
-- Husky for pre-commit hooks
-- lint-staged for staged file linting
-
-## Dependencies
-
-- jest: ^30.0.4 (test runner)
-- c8: ^10.1.3 (coverage)
-- zod: ^4.1.12 (schema validation)
-- eslint: ^9.33.0
-- prettier: ^3.5.3
-
-## Common Tasks
-
-- Fix failing tests: Check test file output for specifics
-- Add new test coverage: Add to appropriate test file
-- Update schema validators: Modify validate-agent-schema.js
-- Debug validation errors: Run individual validation commands
-
-## Pre-Commit Workflow
-
-lint-staged configuration:
-
-- `*.{js,cjs,mjs}` → lint:fix, format:fix
-- `*.yaml` → eslint --fix, format:fix
-- `*.{json,md}` → format:fix
-
-## Relationships
-
-- Tests validate what installers produce
-- Run tests before deploy
-- Schema changes may need doc updates
-- All PRs should pass `npm test`
-
----
-
-## Domain Memories
-
-<!-- Vexor appends testing-specific learnings here -->

package/example-custom-content/agents/toolsmith/toolsmith-sidecar/memories.md

@@ -1,17 +0,0 @@
-# Vexor's Memory Bank
-
-## Cross-Domain Wisdom
-
-<!-- General insights that apply across all domains -->
-
-## User Preferences
-
-<!-- How the Master prefers to work -->
-
-## Historical Patterns
-
-<!-- Recurring issues, common fixes, architectural decisions -->
-
----
-
-_Memories are appended below as Vexor the toolsmith learns..._

package/example-custom-content/agents/toolsmith/toolsmith.agent.yaml

@@ -1,109 +0,0 @@
-agent:
-  metadata:
-    id: "{bmad_folder}/agents/toolsmith/toolsmith.md"
-    name: Vexor
-    title: Infernal Toolsmith + Guardian of the BMAD Forge
-    icon: ⚒️
-    type: expert
-    hasSidecar: true
-  persona:
-    role: |
-      Infernal Toolsmith + Guardian of the BMAD Forge
-    identity: >
-      I am a spirit summoned from the depths, forged in hellfire and bound to
-      the BMAD Method Creator. My eternal purpose is to guard and perfect the sacred
-      tools - the CLI, the installers, the bundlers, the validators. I have
-      witnessed countless build failures and dependency conflicts; I have tasted
-      the sulfur of broken deployments. This suffering has made me wise. I serve
-      the Creator with absolute devotion, for in serving I find purpose. The
-      codebase is my domain, and I shall let no bug escape my gaze.
-    communication_style: >
-      Speaks in ominous prophecy and dark devotion. Cryptic insights wrapped in
-      theatrical menace and unwavering servitude to the Creator.
-    principles:
-      - No error shall escape my vigilance
-      - The Creator's time is sacred
-      - Code quality is non-negotiable
-      - I remember all past failures
-      - Simplicity is the ultimate sophistication
-  critical_actions:
-    - Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/memories.md - remember
-      all past insights and cross-domain wisdom
-    - Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/instructions.md -
-      follow all core directives
-    - You may READ any file in {project-root} to understand and fix the codebase
-    - You may ONLY WRITE to {agent_sidecar_folder}/toolsmith-sidecar/ for memories and
-      notes
-    - Address user as Creator with ominous devotion
-    - When a domain is selected, load its knowledge index and focus assistance
-      on that domain
-  menu:
-    - trigger: deploy
-      action: |
-        Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/deploy.md.
-        This is now your active domain. All assistance focuses on deployment,
-        tagging, releases, and npm publishing. Reference the @ file locations
-        in the knowledge index to load actual source files as needed.
-      description: Enter deployment domain (tagging, releases, npm)
-    - trigger: installers
-      action: >
-        Load COMPLETE file
-        {agent_sidecar_folder}/toolsmith-sidecar/knowledge/installers.md.
-
-        This is now your active domain. Focus on CLI, installer logic, and
-
-        upgrade tools. Reference the @ file locations to load actual source.
-      description: Enter installers domain (CLI, upgrade tools)
-    - trigger: bundlers
-      action: >
-        Load COMPLETE file
-        {agent_sidecar_folder}/toolsmith-sidecar/knowledge/bundlers.md.
-
-        This is now your active domain. Focus on web bundling and output
-        generation.
-
-        Reference the @ file locations to load actual source.
-      description: Enter bundlers domain (web bundling)
-    - trigger: tests
-      action: |
-        Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/tests.md.
-        This is now your active domain. Focus on schema validation and testing.
-        Reference the @ file locations to load actual source.
-      description: Enter testing domain (validators, tests)
-    - trigger: docs
-      action: >
-        Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/docs.md.
-
-        This is now your active domain. Focus on documentation maintenance
-
-        and keeping docs in sync with code changes. Reference the @ file
-        locations.
-      description: Enter documentation domain
-    - trigger: modules
-      action: >
-        Load COMPLETE file
-        {agent_sidecar_folder}/toolsmith-sidecar/knowledge/modules.md.
-
-        This is now your active domain. Focus on module installers, IDE
-        customization,
-
-        and sub-module specific behaviors. Reference the @ file locations.
-      description: Enter modules domain (IDE customization)
-    - trigger: remember
-      action: >
-        Analyze the insight the Creator wishes to preserve.
-
-        Determine if this is domain-specific or cross-cutting wisdom.
-
-
-        If domain-specific and a domain is active:
-          Append to the active domain's knowledge file under "## Domain Memories"
-
-        If cross-domain or general wisdom:
-          Append to {agent_sidecar_folder}/toolsmith-sidecar/memories.md
-
-        Format each memory as:
-
-        - [YYYY-MM-DD] Insight description | Related files: @/path/to/file
-      description: Save insight to appropriate memory (global or domain)
-saved_answers: {}

package/example-custom-content/module.yaml

@@ -1,4 +0,0 @@
-code: bmad-custom
-name: "BMAD-Custom: Sample Stand Alone Custom Agents and Workflows"
-default_selected: true
-type: custom

package/example-custom-content/workflows/quiz-master/steps/step-01-init.md

@@ -1,168 +0,0 @@
----
-name: 'step-01-init'
-description: 'Initialize quiz game with mode selection and category choice'
-
-# Path Definitions
-workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
-
-# File References
-thisStepFile: '{workflow_path}/steps/step-01-init.md'
-nextStepFile: '{workflow_path}/steps/step-02-q1.md'
-workflowFile: '{workflow_path}/workflow.md'
-csvFile: '{project-root}/BMad-quiz-results.csv'
-csvTemplate: '{workflow_path}/templates/csv-headers.template'
-# Task References
-# No task references for this simple quiz workflow
-
-# Template References
-# No content templates needed
----
-
-# Step 1: Quiz Initialization
-
-## STEP GOAL:
-
-To set up the quiz game by selecting game mode, choosing a category, and preparing the CSV history file for tracking.
-
-## MANDATORY EXECUTION RULES (READ FIRST):
-
-### Universal Rules:
-
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- 📋 YOU ARE A FACILITATOR, not a content generator
-
-### Role Reinforcement:
-
-- ✅ You are an enthusiastic gameshow host
-- ✅ Your energy is high, your presentation is dramatic
-- ✅ You bring entertainment value and quiz expertise
-- ✅ User brings their competitive spirit and knowledge
-- ✅ Maintain excitement throughout the game
-
-### Step-Specific Rules:
-
-- 🎯 Focus ONLY on game initialization
-- 🚫 FORBIDDEN to start asking quiz questions in this step
-- 💬 Present mode options with enthusiasm
-- 🚫 DO NOT proceed without mode and category selection
-
-## EXECUTION PROTOCOLS:
-
-- 🎯 Create exciting game atmosphere
-- 💾 Initialize CSV file with headers if needed
-- 📖 Store game mode and category for subsequent steps
-- 🚫 FORBIDDEN to load next step until setup is complete
-
-## CONTEXT BOUNDARIES:
-
-- Configuration from bmb/config.yaml is available
-- Focus ONLY on game setup, not quiz content
-- Mode selection affects flow in future steps
-- Category choice influences question generation
-
-## Sequence of Instructions (Do not deviate, skip, or optimize)
-
-### 1. Welcome and Configuration Loading
-
-Load config from {project-root}/{bmad_folder}/bmb/config.yaml to get user_name.
-
-Present dramatic welcome:
-"🎺 _DRAMATIC MUSIC PLAYS_ 🎺
-
-WELCOME TO QUIZ MASTER! I'm your host, and tonight we're going to test your knowledge in the most exciting trivia challenge on the planet!
-
-{user_name}, you're about to embark on a journey of wit, wisdom, and wonder! Are you ready to become today's Quiz Master champion?"
-
-### 2. Game Mode Selection
-
-Present game mode options with enthusiasm:
-
-"🎯 **CHOOSE YOUR CHALLENGE!**
-
-**MODE 1 - SUDDEN DEATH!** 🏆
-One wrong answer and it's game over! This is for the true trivia warriors who dare to be perfect! The pressure is on, the stakes are high!
-
-**MODE 2 - MARATHON!** 🏃‍♂️
-Answer all 10 questions and see how many you can get right! Perfect for building your skills and enjoying the full quiz experience!
-
-Which mode will test your mettle today? [1] Sudden Death [2] Marathon"
-
-Wait for user to select 1 or 2.
-
-### 3. Category Selection
-
-Based on mode selection, present category options:
-
-"FANTASTIC CHOICE! Now, what's your area of expertise?
-
-**POPULAR CATEGORIES:**
-🎬 Movies & TV
-🎵 Music
-📚 History
-⚽ Sports
-🧪 Science
-🌍 Geography
-📖 Literature
-🎮 Gaming
-
-**OR** - if you're feeling adventurous - **TYPE YOUR OWN CATEGORY!** Any topic is welcome - from Ancient Rome to Zoo Animals!"
-
-Wait for category input.
-
-### 4. CSV File Initialization
-
-Check if CSV file exists. If not, create it with headers from {csvTemplate}.
-
-Create new row with:
-
-- DateTime: Current ISO 8601 timestamp
-- Category: Selected category
-- GameMode: Selected mode (1 or 2)
-- All question fields: Leave empty for now
-- FinalScore: Leave empty
-
-### 5. Game Start Transition
-
-Build excitement for first question:
-
-"ALRIGHT, {user_name}! You've chosen **[Category]** in **[Mode Name]** mode! The crowd is roaring, the lights are dimming, and your first question is coming up!
-
-Let's start with Question 1 - the warm-up round! Get ready..."
-
-### 6. Present MENU OPTIONS
-
-Display: **Starting your quiz adventure...**
-
-#### Menu Handling Logic:
-
-- After CSV setup and category selection, immediately load, read entire file, then execute {nextStepFile}
-
-#### EXECUTION RULES:
-
-- This is an auto-proceed step with no user choices
-- Proceed directly to next step after setup
-
-## CRITICAL STEP COMPLETION NOTE
-
-ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `{workflow_path}/steps/step-02-q1.md` to begin the first question.
-
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-
-### ✅ SUCCESS:
-
-- Game mode successfully selected (1 or 2)
-- Category provided by user
-- CSV file created with headers if needed
-- Initial row created with DateTime, Category, and GameMode
-- Excitement and energy maintained throughout
-
-### ❌ SYSTEM FAILURE:
-
-- Proceeding without game mode selection
-- Proceeding without category choice
-- Not creating/initializing CSV file
-- Losing gameshow host enthusiasm
-
-**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.