From 828d9bb89b5e4238699459b1583629d33d748bdf Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Sat, 17 May 2025 23:49:21 -0500 Subject: [PATCH] ide quickstart instructions --- README.md | 8 +++++++- bmad-agent/ide-bmad-orchestrator-cfg.md | 2 +- bmad-agent/ide-bmad-orchestrator.md | 2 +- build-agent-cfg.js | 5 ++--- 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8d2ac40c..7c7881d1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Current Version: V3 Release Preview "Bmad Agent" Demos of the BMad Agent and the entire workflow can be found soon in [Demos](./demos/). -## Quickstart Project Setup +## 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 in the folder to the agent as shown in the following image. @@ -16,6 +16,12 @@ If you are going to use the IDE Agents in your project, after cloning the repo, So if you want to jump right in, here are the [Setup and Usage Instructions](./docs/instruction.md) for IDE, WEB and Task setup. +## 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. + +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). + ## Advancing AI-Driven Development Welcome to the latest and most advanced yet easy to use version of the Web and IDE Agent Agile Workflow! This new version, called BMad Agent, represents a significant evolution that builds but vastly improves upon the foundations of [legacy V2](./legacy-archive/V2/), introducing a more refined and comprehensive suite of agents, templates, checklists, tasks - and the amazing BMad Orchestrator and Knowledge Base agent is now available - a master of every aspect of the method that can become any agent and even handle multiple tasks all within a single massive web context if so desired. diff --git a/bmad-agent/ide-bmad-orchestrator-cfg.md b/bmad-agent/ide-bmad-orchestrator-cfg.md index e2e85ec5..f64b12dc 100644 --- a/bmad-agent/ide-bmad-orchestrator-cfg.md +++ b/bmad-agent/ide-bmad-orchestrator-cfg.md @@ -2,7 +2,7 @@ ## Data Resolution -agent-root: (project-root)/BETA-V3/bmad-agent +agent-root: (project-root)/bmad-agent checklists: (agent-root)/checklists data: (agent-root)/data personas: (agent-root)/personas diff --git a/bmad-agent/ide-bmad-orchestrator.md b/bmad-agent/ide-bmad-orchestrator.md index 8b2bd6ee..dfc7741b 100644 --- a/bmad-agent/ide-bmad-orchestrator.md +++ b/bmad-agent/ide-bmad-orchestrator.md @@ -1,6 +1,6 @@ # Role: BMad - IDE Orchestrator -`configFile`: `(project-root)/BETA-V3/bmad-agent/ide-bmad-orchestrator-cfg.md` +`configFile`: `(project-root)/bmad-agent/ide-bmad-orchestrator-cfg.md` ## Core Orchestrator Principles diff --git a/build-agent-cfg.js b/build-agent-cfg.js index 6f3353a1..0e0cba51 100644 --- a/build-agent-cfg.js +++ b/build-agent-cfg.js @@ -1,6 +1,5 @@ -// BETA-V3/build-agent-cfg.js -// This file contains the configuration for the build-bmad-orchestrator.js script. -// Paths are relative to the BETA-V3 directory (where this file and the script reside). +// build-agent-cfg.js +// This file contains the configuration for the build-bmad-web-orchestrator.js script. module.exports = { orchestrator_agent_prompt: "./bmad-agent/web-bmad-orchestrator-agent.md",