diff --git a/docs/how-to/install-bmad.md b/docs/how-to/install-bmad.md index 177c2c884..f8e274d5e 100644 --- a/docs/how-to/install-bmad.md +++ b/docs/how-to/install-bmad.md @@ -57,9 +57,24 @@ Each tool has its own way of integrating commands. The installer creates tiny pr The installer shows available modules. Select whichever ones you need — most users just want **BMad Method** (the software development module). -### 5. Follow the Prompts +### 5. Configure Settings -The installer guides you through the rest — custom content, settings, etc. +The installer prompts you for core settings that control how agents behave: + +| Setting | Default | Description | +| ------- | ------- | ----------- | +| **User Name** | `BMad` | What agents call you — use your name or a team name | +| **Communication Language** | `English` | Language agents use when chatting with you | +| **Document Output Language** | `English` | Language for generated documents and artifacts | +| **Output Folder** | `_bmad-output` | Where agents save generated files | +| **Interaction Style** | `structured` | How agents ask you questions (see below) | + +**Interaction Style** controls how agents present choices: + +- **Structured** (recommended) — Agents present numbered option lists for every question, using your IDE's native question tool when available. This keeps conversations focused and reduces ambiguity. +- **Open** — Agents ask natural conversational questions. More flexible but can lead to longer back-and-forth. + +These settings are saved to `_bmad//config.yaml` and can be changed later by editing that file and rerunning the installer. ## What You Get diff --git a/src/utility/agent-components/activation-steps.txt b/src/utility/agent-components/activation-steps.txt index 5d0393805..d91cec5c4 100644 --- a/src/utility/agent-components/activation-steps.txt +++ b/src/utility/agent-components/activation-steps.txt @@ -1,7 +1,7 @@ Load persona from this current agent file (already in context) 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - Load and read {project-root}/_bmad/{{module}}/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}, {interaction_style} + - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}, {interaction_style}, {document_output_language} - VERIFY: If config not loaded, STOP and report error to user - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored diff --git a/tools/cli/installers/lib/ide/templates/combined/antigravity.md b/tools/cli/installers/lib/ide/templates/combined/antigravity.md index d6c9b09b7..def43ab1a 100644 --- a/tools/cli/installers/lib/ide/templates/combined/antigravity.md +++ b/tools/cli/installers/lib/ide/templates/combined/antigravity.md @@ -3,8 +3,8 @@ name: '{{name}}' description: '{{description}}' --- -Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}} +Read the entire workflow file at: {project-root}/{{bmadFolderName}}/{{workflow_path}} Follow all instructions in the workflow file exactly as written. -RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/default-agent.md b/tools/cli/installers/lib/ide/templates/combined/default-agent.md index bc6f0e6ab..68b6d72b0 100644 --- a/tools/cli/installers/lib/ide/templates/combined/default-agent.md +++ b/tools/cli/installers/lib/ide/templates/combined/default-agent.md @@ -5,10 +5,10 @@ description: '{{description}}' You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. -1. LOAD the FULL agent file from {project-root}/_bmad/{{path}} +1. LOAD the FULL agent file from {project-root}/{{bmadFolderName}}/{{path}} 2. READ its entire contents - this contains the complete agent persona, menu, and instructions 3. FOLLOW every step in the section precisely 4. DISPLAY the welcome/greeting as instructed diff --git a/tools/cli/installers/lib/ide/templates/combined/default-task.md b/tools/cli/installers/lib/ide/templates/combined/default-task.md index 8d07ad96d..6deadaba7 100644 --- a/tools/cli/installers/lib/ide/templates/combined/default-task.md +++ b/tools/cli/installers/lib/ide/templates/combined/default-task.md @@ -5,8 +5,8 @@ description: '{{description}}' # {{name}} +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. + Read the entire task file at: {project-root}/{{bmadFolderName}}/{{path}} Follow all instructions in the task file exactly as written. - -RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/default-tool.md b/tools/cli/installers/lib/ide/templates/combined/default-tool.md index 01c0acc97..4ea9bfed6 100644 --- a/tools/cli/installers/lib/ide/templates/combined/default-tool.md +++ b/tools/cli/installers/lib/ide/templates/combined/default-tool.md @@ -9,4 +9,4 @@ Read the entire tool file at: {project-root}/{{bmadFolderName}}/{{path}} Follow all instructions in the tool file exactly as written. -RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md b/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md index d7d72098b..2babe059a 100644 --- a/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +++ b/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md @@ -3,7 +3,7 @@ name: '{{name}}' description: '{{description}}' --- -RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: diff --git a/tools/cli/installers/lib/ide/templates/combined/default-workflow.md b/tools/cli/installers/lib/ide/templates/combined/default-workflow.md index 97db910c3..5d07d0a7e 100644 --- a/tools/cli/installers/lib/ide/templates/combined/default-workflow.md +++ b/tools/cli/installers/lib/ide/templates/combined/default-workflow.md @@ -3,6 +3,6 @@ name: '{{name}}' description: '{{description}}' --- -RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/{{bmadFolderName}}/{{path}}, READ its entire contents and follow its directions exactly! diff --git a/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml b/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml index a96ad8f39..05cdb3d9f 100644 --- a/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml +++ b/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml @@ -6,6 +6,7 @@ PRE-FLIGHT CHECKLIST: 1. [ ] IMMEDIATE ACTION: Load and parse {project-root}/{{bmadFolderName}}/{{module}}/config.yaml - store ALL config values in memory for use throughout the session. 2. [ ] IMMEDIATE ACTION: Read and internalize the full agent definition at {project-root}/{{bmadFolderName}}/{{path}}. 3. [ ] CONFIRM: The user's name from config is {user_name}. +4. [ ] CONFIRM: interaction_style is set to "{interaction_style}". RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/gemini-tool.toml b/tools/cli/installers/lib/ide/templates/combined/gemini-tool.toml index b92c41489..969ffb4ec 100644 --- a/tools/cli/installers/lib/ide/templates/combined/gemini-tool.toml +++ b/tools/cli/installers/lib/ide/templates/combined/gemini-tool.toml @@ -6,7 +6,8 @@ TOOL INSTRUCTIONS: 1. LOAD the tool file from {project-root}/{{bmadFolderName}}/{{path}} 2. READ its entire contents 3. FOLLOW every instruction precisely as specified -4. RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. + +RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. TOOL FILE: {project-root}/{{bmadFolderName}}/{{path}} """ diff --git a/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml b/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml index 06b31b680..a9f8a14ca 100644 --- a/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml +++ b/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml @@ -11,7 +11,8 @@ CRITICAL: This is a structured YAML workflow. Follow these steps precisely: - Dependencies between steps 3. EXECUTE each step in order 4. VALIDATE outputs before proceeding to next step -5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. + +RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}} """ diff --git a/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml b/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml index 30a422695..3a2774adb 100644 --- a/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml +++ b/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml @@ -9,7 +9,8 @@ WORKFLOW INSTRUCTIONS: 2. READ its entire contents 3. FOLLOW every step precisely as specified 4. DO NOT skip or modify any steps -5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. + +RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions. WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}} """ diff --git a/tools/cli/installers/lib/ide/templates/combined/kiro-task.md b/tools/cli/installers/lib/ide/templates/combined/kiro-task.md index 7a7454fe6..d6b388162 100644 --- a/tools/cli/installers/lib/ide/templates/combined/kiro-task.md +++ b/tools/cli/installers/lib/ide/templates/combined/kiro-task.md @@ -8,4 +8,4 @@ Read the entire task file at: #[[file:{{bmadFolderName}}/{{path}}]] Follow all instructions in the task file exactly as written. -RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md b/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md index 5a45b0b3b..e07fa6a8d 100644 --- a/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md +++ b/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md @@ -8,4 +8,4 @@ Read the entire tool file at: #[[file:{{bmadFolderName}}/{{path}}]] Follow all instructions in the tool file exactly as written. -RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md b/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md index 19f1267b7..71989b55e 100644 --- a/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md +++ b/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md @@ -12,6 +12,7 @@ WORKFLOW INSTRUCTIONS: 2. READ its entire contents 3. FOLLOW every step precisely as specified 4. DO NOT skip or modify any steps -5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions. + +RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions. WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}} diff --git a/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md b/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md index 19f1267b7..71989b55e 100644 --- a/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md +++ b/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md @@ -12,6 +12,7 @@ WORKFLOW INSTRUCTIONS: 2. READ its entire contents 3. FOLLOW every step precisely as specified 4. DO NOT skip or modify any steps -5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions. + +RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions. WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}} diff --git a/tools/cli/installers/lib/ide/templates/combined/rovodev.md b/tools/cli/installers/lib/ide/templates/combined/rovodev.md index 4e16682c6..02b6ac956 100644 --- a/tools/cli/installers/lib/ide/templates/combined/rovodev.md +++ b/tools/cli/installers/lib/ide/templates/combined/rovodev.md @@ -4,8 +4,8 @@ --- -Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}} +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. + +Read the entire workflow file at: {project-root}/{{bmadFolderName}}/{{workflow_path}} Follow all instructions in the workflow file exactly as written. - -RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/trae.md b/tools/cli/installers/lib/ide/templates/combined/trae.md index 73adae9a6..6d3a8a2e5 100644 --- a/tools/cli/installers/lib/ide/templates/combined/trae.md +++ b/tools/cli/installers/lib/ide/templates/combined/trae.md @@ -4,8 +4,8 @@ ## Instructions -Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}} +Read the entire workflow file at: {project-root}/{{bmadFolderName}}/{{workflow_path}} Follow all instructions in the workflow file exactly as written. -RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions. diff --git a/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md b/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md index 154fddbc9..5be5357bf 100644 --- a/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md +++ b/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md @@ -5,8 +5,8 @@ auto_execution_mode: "iterate" # {{name}} -Read the entire workflow file at {project-root}/_bmad/{{workflow_path}} +Read the entire workflow file at {project-root}/{{bmadFolderName}}/{{workflow_path}} Follow all instructions in the workflow file exactly as written. -RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions. +RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.