BMAD-METHOD/tools/cli
sidharth arora e2c0f865aa feat: add configurable interaction_style with platform-specific structured question directives
Add a new `interaction_style` config setting (open/structured) to module.yaml
that controls how agents ask questions. When set to "structured", agents use
numbered option lists; when "open" (default), they use natural conversation.

Platform-specific templates for Claude Code use `AskUserQuestion` tool,
Gemini uses `ask_user`, OpenCode uses `question` tool, and default/kiro/
other platforms use generic structured options.

Changes:
- Add interaction_style to src/core/module.yaml (between output_folder and
  tool_supports_subagents)
- Add RULE directive to all 27+ IDE templates across 7 platforms
- Add interaction_style to activation-rules, activation-steps, handlers,
  workflow.xml, and agent-command-header
- Create dedicated Claude Code templates (claude-agent, claude-task,
  claude-tool, claude-workflow, claude-workflow-yaml) replacing symlinks
- Add claude template_type to platform-codes.yaml
- Update codex.js installer for claude support
- Document interaction_style in install-bmad.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-02 00:38:15 +01:00
..
commands feat(cli): add uninstall command with selective component removal (#1650) 2026-02-15 08:13:03 -06:00
installers feat: add configurable interaction_style with platform-specific structured question directives 2026-03-02 00:38:15 +01:00
lib fix(config): remove Windsurf from recommended/preferred IDEs (#1727) 2026-02-20 20:16:43 -06:00
README.md modify post install notes example 2026-02-14 21:25:58 -06:00
bmad-cli.js fix(cli): use semantic versioning for update check (#1671) 2026-02-16 09:39:03 -06:00
external-official-modules.yaml refactor: replace module installer scripts with declarative directories config 2026-02-08 19:21:48 -06:00

README.md

BMad CLI Tool

Installing external repo BMad official modules

For external official modules to be discoverable during install, ensure an entry for the external repo is added to external-official-modules.yaml.

For community modules - this will be handled in a different way. This file is only for registration of modules under the bmad-code-org.

Post-Install Notes

Modules can display setup guidance to users after configuration is collected during npx bmad-method install. Notes are defined in the module's own module.yaml — no changes to the installer are needed.

Simple Format

Always displayed after the module is configured:

post-install-notes: |
  Thank you for choosing the XYZ Cool Module
  For Support about this Module call 555-1212  

Conditional Format

Display different messages based on a config question's answer:

post-install-notes:
  config_key_name:
    value1: |
      Instructions for value1...      
    value2: |
      Instructions for value2...      

Values without an entry (e.g., none) display nothing. Multiple config keys can each have their own conditional notes.

Example: TEA Module

The TEA module uses the conditional format keyed on tea_browser_automation:

post-install-notes:
  tea_browser_automation:
    cli: |
      Playwright CLI Setup:
        npm install -g @playwright/cli@latest
        playwright-cli install --skills      
    mcp: |
      Playwright MCP Setup (two servers):
        1. playwright    — npx @playwright/mcp@latest
        2. playwright-test — npx playwright run-test-mcp-server      
    auto: |
      Playwright CLI Setup:
        ...
      Playwright MCP Setup (two servers):
        ...      

When a user selects auto, they see both CLI and MCP instructions. When they select none, nothing is shown.