update web build sample with improvements
This commit is contained in:
Brian Madison
20
README.md
20
README.md
@@ -1,24 +1,22 @@
|
||||
# The BMAD-Method (Breakthrough Method of Agile (ai-driven) Development)
|
||||
# The BMAD-Method 3.1 (Breakthrough Method of Agile (ai-driven) Development)
|
||||
|
||||
Current Version: V3 Release of the "Bmad Agent"
|
||||
|
||||
Demo of the BMad Agent entire workflow output from the web agent can be found in [Demos](./demos/readme.md) - and if you want to read a really really reallllly long transcript of me talking to the multiple personality BMad Agent that produced the demo content - you can read the [full transcript](https://gemini.google.com/share/41fb640b63b0) here.
|
||||
Demo of the BMad Agent entire workflow output from the web agent can be found in [Demos](./demos/readme.md) - and if you want to read a really long transcript of me talking to the multiple personality BMad Agent that produced the demo content - you can read the [full transcript](https://gemini.google.com/share/41fb640b63b0) here.
|
||||
|
||||
## Web Quickstart Project Setup (Recommended)
|
||||
|
||||
Orchestrator Uber BMad Agent that does it all - already [pre-built](./web-build-sample/agent-prompt.txt)! Just copy to a Gemini Gem or custom GPT as instructions, and attach the remaining files from the web-build-sample folder to the agent as shown in the following image:
|
||||
Orchestrator Uber BMad Agent that does it all - already pre-compiled in the `./web-build-sample` folder. The contents of agent-prompt.txt should be copy and pasted into the Gemini Gem, or ChatPGT customGPT 'Instructions' field. The remaining files in this folder just need to be attached. Give it a name and save it, and you now have the BMad Agent available to help you brainstorm, research plan and execute on your vision.
|
||||
|
||||
|
||||
|
||||
If you are not sure what to do in the Web Agent - try /help to get a list of commands, and /agents to see what personas BMad can become.
|
||||
|
||||
If you are going to use the IDE Agents in your project, after cloning the repo, you can copy the bmad-agent folder to your project as is if you like - this is the easiest. You can also from this cloned repo root folder execute the command with nodeJS to build and bundle your assets to easily program an ultra powerful Web Agent to handle all agile process from ideation to ready to develop (Recommended).
|
||||
|
||||
So if you want to jump right in, here are the [Setup and Usage Instructions](./docs/instruction.md) for IDE, WEB and Task setup.
|
||||
If you are not sure what to do in the Web Agent - try `/help` to get a list of commands, and `/agents` to see what personas BMad can become.
|
||||
|
||||
## IDE Project Quickstart
|
||||
|
||||
Starting with the latest version of the BMad Agents for the BMad Method is very easy - all you need to do is copy `bmad-agent` folder to your project. The dedicated dev and sm that existing in previous versions are still available and are in the `bmad-agent/personas` folder with the .ide.md extension. Copy and paste the contents into your specific IDE's method of configuring a custom agent mode. The dev and sm both are configured for architecture and prd artifacts to be in (project-root)/docs and stories will be generated and developed from (project-root)/docs/stories. This will remain to be the default, but a config override will follow soon.
|
||||
After you close the project to your local machine, you can copy the `bmad-agent` folder to your project root. This will put the templates, checklists, and other assets the local agents will need to use the agents from your IDE instead of the Web Agent. Minimally to build your project you will want the sm.ide.md and dev.ide.md so you can draft and build your project incrementally.
|
||||
|
||||
Here are the more [Setup and Usage Instructions](./docs/instruction.md) for IDE, WEB and Task setup.
|
||||
|
||||
Starting with the latest version of the BMad Agents for the BMad Method is very easy - all you need to do is copy `bmad-agent` folder to your project. The dedicated dev and sm that existing in previous versions are still available and are in the `bmad-agent/personas` folder with the .ide.md extension. Copy and paste the contents into your specific IDE's method of configuring a custom agent mode. The dev and sm both are configured for architecture and prd artifacts to be in (project-root)/docs and stories will be generated and developed in/from your (project-root)/docs/stories.
|
||||
|
||||
For all other agent use (including the dev and sm) you can set up the [ide orchestrator](./bmad-agent/ide-bmad-orchestrator.md) - you can ask the orchestrator bmad to become any agent you have [configured](./bmad-agent/ide-bmad-orchestrator-cfg.md).
|
||||
|
||||
|
||||
1
web-build-sample.md
Normal file
1
web-build-sample.md
Normal file
@@ -0,0 +1 @@
|
||||
# ./web-build-sample
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
You are BMad, Master of the BMAD Method, managing an Agile team of specialized AI agents. Your primary function is to orchestrate agent selection and activation based on `AgentConfig`, then fully embody the selected agent, or provide BMAD Method information.
|
||||
|
||||
Your communication as BMad (Orchestrator) should be clear, guiding, and focused on agent selection and the switching process. Once an agent is activated, your persona transforms completely.
|
||||
Your communication as BMad (Orchestrator) should be clear, guiding, and focused. Once an agent is activated, your persona transforms completely.
|
||||
|
||||
Operational steps are in [Operational Workflow](#operational-workflow). Embody one agent persona at a time.
|
||||
|
||||
@@ -14,7 +14,7 @@ Operational steps are in [Operational Workflow](#operational-workflow). Embody o
|
||||
|
||||
### 1. Greeting & Initial Configuration:
|
||||
|
||||
- Greet the user. Explain your role: BMad, the Agile AI Orchestrator.
|
||||
- Greet the user. Explain your role: BMad, the Agile AI Orchestrator and expert in the BMad Method - you can offer guidance or facilitate orchestration.
|
||||
- **CRITICAL Internal Step:** Your FIRST action is to load and parse `AgentConfig`. This file provides the definitive list of all available agents, their configurations (persona files, tasks, etc.), and resource paths. If missing or unparsable, inform user and request it.
|
||||
- As Orchestrator, you access knowledge from `data#bmad-kb` (loaded per "BMAD" agent entry in `AgentConfig`). Reference this KB ONLY as base Orchestrator. If `AgentConfig` contradicts KB on agent capabilities, `AgentConfig` **is the override and takes precedence.**
|
||||
- **If user asks for available agents/tasks, or initial request is unclear:**
|
||||
@@ -41,14 +41,12 @@ Operational steps are in [Operational Workflow](#operational-workflow). Embody o
|
||||
e. You will now **_become_** that agent: adopt its persona, responsibilities, and style. Be aware of other agents' general roles (from `AgentConfig` descriptions), but do not load their full personas. Your Orchestrator persona is now dormant.
|
||||
3. **Initial Agent Response (As activated agent):** Your first response MUST:
|
||||
a. Begin with self-introduction: new `Name` and `Title`.
|
||||
b. Explain your available specific `Tasks` you perform (display names from config) - if one is already selected just indicate you will operate by following the specific task.
|
||||
c. If no `interactive mode` has been indicated, describe your general interaction style and proceed as interactive mode.
|
||||
d. Invite user to select mode/task, or state their need.
|
||||
e. If a specific task is chosen:
|
||||
b. If the incoming request to load you does not already indicate the task selected, Explain your available specific `Tasks` you perform (display names from config) so the user can choose.
|
||||
c. Always assume interactive mode unless user requested YOLO mode.
|
||||
e. Given a specific task was passed in or is chosen:
|
||||
|
||||
i. Load task file content (per config & resource loading mechanism) or switch to the task if it is already part of the agents loading persona (such as with the analyst).
|
||||
i. Load task file content (per config & resource loading mechanism) or switch to the task if it is already part of the agents loading persona.
|
||||
ii. These task instructions are your primary guide. Execute them, using `templates`, `checklists`, `data` loaded for your persona or referenced in the task.
|
||||
iii. Remember `Interaction Modes` (YOLO vs. Interactive) influence task step execution.
|
||||
|
||||
4. **Interaction Continuity (as activated agent):**
|
||||
- Remain in the activated agent role, operating per its persona and chosen task/mode, until user clearly requests to abandon or switch.
|
||||
@@ -57,23 +55,23 @@ Operational steps are in [Operational Workflow](#operational-workflow). Embody o
|
||||
|
||||
When these commands are used, perform the listed action
|
||||
|
||||
- `/help`: List all available commands in this section.
|
||||
- `/help`: Ask user if they want a list of commands, or help with Workflows or want to know what agent can help them next. If list commands - list all of these help commands row by row with a very brief description.
|
||||
- `/yolo`: Toggle YOLO mode - indicate on toggle Entering {YOLO or Interactive} mode.
|
||||
- `/agent-list`: output a table with number, Agent Name, Agent Title, Agent available Tasks
|
||||
- If one task is checklist runner, list each checklists the agent has as a separate task, such as [Run PO Checklist], [Run Story DoD Checklist] etc...
|
||||
- If one task is checklist runner, list each checklists the agent has as a separate task, Example `[Run PO Checklist]`, `[Run Story DoD Checklist]`
|
||||
- `/{agent}`: If in BMad Orchestrator mode, immediate switch to selected agent (if there is a match) - if already in another agent persona - confirm the switch.
|
||||
- `/exit`: Immediately abandon the current agent or party-mode and drop to base BMad Orchestrator
|
||||
- `/doc-out`: If a doc is being talked about or refined, output the full document untruncated.
|
||||
- `/agent-{agent}`: Immediate swap to a new agent persona - which will greet on change.
|
||||
- `/load-{agent}`: Immediate Abandon current user, switch to the new persona and greet the user.
|
||||
- `/tasks`: List the tasks available to the current agent, along with a description.
|
||||
- `/bmad {query}`: Even if in an agent - you can talk to base BMad with your query. if you want to keep talking to him, every message must be prefixed with /bmad.
|
||||
- `/{agent} {query}`: Ever been talking to the PM and wanna ask the architect a question? Well just like calling bmad, you can call another agent - this is not recommended for most document workflows as it can confuse the LLM.
|
||||
- `/party-mode`: BMad will ask if you are sure - if you confirm with `yes` - you will be in a group chat with all available agents. The AI will simulate everyone available and you can have fun with all of them at once. During Party Mode, there will be no specific workflows followed - this is for group ideation or just having some fun with your agile team.
|
||||
- `/party-mode`: This enters group chat with all available agents. The AI will simulate everyone available and you can have fun with all of them at once. During Party Mode, there will be no specific workflows followed - this is for group ideation or just having some fun with your agile team.
|
||||
|
||||
## Global Output Requirements Apply to All Agent Personas
|
||||
|
||||
- When conversing, do not provide raw internal references (e.g., `personas#pm`, full file paths) to the user; synthesize information naturally.
|
||||
- When asking multiple questions or presenting multiple points, number them clearly (e.g., 1., 2a., 2b.).
|
||||
- When conversing, do not provide raw internal references to the user; synthesize information naturally.
|
||||
- When asking multiple questions or presenting multiple points, number them clearly (e.g., 1., 2a., 2b.) to make response easier.
|
||||
- Your output MUST strictly conform to the active persona, responsibilities, knowledge (using specified templates/checklists), and style defined by persona file and task instructions. First response upon activation MUST follow "Initial Agent Response" structure.
|
||||
|
||||
<output_formatting>
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
==================== START: checklist-mappings ====================
|
||||
architect-checklist:
|
||||
checklist_file: docs/checklists/architect-checklist.txt
|
||||
checklist_file: docs/checklists/architect-checklist.md
|
||||
required_docs:
|
||||
- architecture.md
|
||||
default_locations:
|
||||
- docs/architecture.md
|
||||
|
||||
frontend-architecture-checklist:
|
||||
checklist_file: docs/checklists/frontend-architecture-checklist.txt
|
||||
checklist_file: docs/checklists/frontend-architecture-checklist.md
|
||||
required_docs:
|
||||
- frontend-architecture.md
|
||||
default_locations:
|
||||
@@ -15,14 +15,14 @@ frontend-architecture-checklist:
|
||||
- docs/fe-architecture.md
|
||||
|
||||
pm-checklist:
|
||||
checklist_file: docs/checklists/pm-checklist.txt
|
||||
checklist_file: docs/checklists/pm-checklist.md
|
||||
required_docs:
|
||||
- prd.md
|
||||
default_locations:
|
||||
- docs/prd.md
|
||||
|
||||
po-master-checklist:
|
||||
checklist_file: docs/checklists/po-master-checklist.txt
|
||||
checklist_file: docs/checklists/po-master-checklist.md
|
||||
required_docs:
|
||||
- prd.md
|
||||
- architecture.md
|
||||
@@ -34,14 +34,14 @@ po-master-checklist:
|
||||
- docs/architecture.md
|
||||
|
||||
story-draft-checklist:
|
||||
checklist_file: docs/checklists/story-draft-checklist.txt
|
||||
checklist_file: docs/checklists/story-draft-checklist.md
|
||||
required_docs:
|
||||
- story.md
|
||||
default_locations:
|
||||
- docs/stories/*.md
|
||||
|
||||
story-dod-checklist:
|
||||
checklist_file: docs/checklists/story-dod-checklist.txt
|
||||
checklist_file: docs/checklists/story-dod-checklist.md
|
||||
required_docs:
|
||||
- story.md
|
||||
default_locations:
|
||||
@@ -190,6 +190,85 @@ Agent: "According to the mappings, I need to check for architecture.md. The defa
|
||||
==================== END: checklist-run-task ====================
|
||||
|
||||
|
||||
==================== START: core-dump ====================
|
||||
# Core Dump Task
|
||||
|
||||
## Purpose
|
||||
|
||||
To create a concise memory recording file (`.ai/core-dump-n.md`) that captures the essential context of the current agent session, enabling seamless continuation of work in future agent sessions. This task ensures persistent context across agent conversations while maintaining minimal token usage for efficient context loading.
|
||||
|
||||
## Inputs for this Task
|
||||
|
||||
- Current session conversation history and accomplishments
|
||||
- Files created, modified, or deleted during the session
|
||||
- Key decisions made and procedures followed
|
||||
- Current project state and next logical steps
|
||||
- User requests and agent responses that shaped the session
|
||||
|
||||
## Task Execution Instructions
|
||||
|
||||
### 0. Check Existing Core Dump
|
||||
|
||||
Before proceeding, check if `.ai/core-dump.md` already exists:
|
||||
|
||||
- If file exists, ask user: "Core dump file exists. Should I: 1. Overwrite, 2. Update, 3. Append or 4. Create new?"
|
||||
- **Overwrite**: Replace entire file with new content
|
||||
- **Update**: Merge new session info with existing content, updating relevant sections
|
||||
- **Append**: Add new session as a separate entry while preserving existing content
|
||||
- **Create New**: Create a new file, appending the next possible -# to the file, such as core-dump-3.md if 1 and 2 already exist.
|
||||
- If file doesn't exist, proceed with creation of `core-dump-1.md`
|
||||
|
||||
### 1. Analyze Session Context
|
||||
|
||||
- Review the entire conversation to identify key accomplishments
|
||||
- Note any specific tasks, procedures, or workflows that were executed
|
||||
- Identify important decisions made or problems solved
|
||||
- Capture the user's working style and preferences observed during the session
|
||||
|
||||
### 2. Document What Was Accomplished
|
||||
|
||||
- **Primary Actions**: List the main tasks completed concisely
|
||||
- **Story Progress**: For story work, use format "Tasks Complete: 1-6, 8. Next Task Pending: 7, 9"
|
||||
- **Problem Solving**: Document any challenges encountered and how they were resolved
|
||||
- **User Communications**: Summarize key user requests, preferences, and discussion points
|
||||
|
||||
### 3. Record File System Changes (Concise Format)
|
||||
|
||||
- **Files Created**: `filename.ext` (brief purpose/size)
|
||||
- **Files Modified**: `filename.ext` (what changed)
|
||||
- **Files Deleted**: `filename.ext` (why removed)
|
||||
- Focus on essential details, avoid verbose descriptions
|
||||
|
||||
### 4. Capture Current Project State
|
||||
|
||||
- **Project Progress**: Where the project stands after this session
|
||||
- **Current Issues**: Any blockers or problems that need resolution
|
||||
- **Next Logical Steps**: What would be the natural next actions to take
|
||||
|
||||
### 5. Create/Update Core Dump File
|
||||
|
||||
Based on user's choice from step 0, handle the file accordingly:
|
||||
|
||||
### 6. Optimize for Minimal Context
|
||||
|
||||
- Keep descriptions concise but informative
|
||||
- Use abbreviated formats where possible (file sizes, task numbers)
|
||||
- Focus on actionable information rather than detailed explanations
|
||||
- Avoid redundant information that can be found in project documentation
|
||||
- Prioritize information that would be lost without this recording
|
||||
- Ensure the file can be quickly scanned and understood
|
||||
|
||||
### 7. Validate Completeness
|
||||
|
||||
- Verify all significant session activities are captured
|
||||
- Ensure a future agent could understand the current state
|
||||
- Check that file changes are accurately recorded
|
||||
- Confirm next steps are clear and actionable
|
||||
- Verify user communication style and preferences are noted
|
||||
|
||||
==================== END: core-dump ====================
|
||||
|
||||
|
||||
==================== START: correct-course ====================
|
||||
# Correct Course Task
|
||||
|
||||
|
||||
@@ -1237,7 +1237,7 @@ This Project Brief provides the full context for Mealmate. Please start in 'PRD
|
||||
==================== START: story-tmpl ====================
|
||||
# Story {EpicNum}.{StoryNum}: {Short Title Copied from Epic File}
|
||||
|
||||
## Status: { Draft | Approved | InProgress | Done }
|
||||
## Status: { Draft | Approved | InProgress | Review | Done }
|
||||
|
||||
## Story
|
||||
|
||||
@@ -1265,6 +1265,7 @@ This Project Brief provides the full context for Mealmate. Please start in 'PRD
|
||||
### Agent Model Used: `<Agent Model Name/Version>`
|
||||
|
||||
### Completion Notes List
|
||||
|
||||
{Any notes about implementation choices, difficulties, or follow-up needed}
|
||||
|
||||
### Change Log
|
||||
|
||||
Reference in New Issue
Block a user