|
4 | 4 | [](LICENSE) |
5 | 5 | [](https://discord.gg/gk8jAdXWmj) |
6 | 6 |
|
7 | | -**Build More, Build better.** Create custom BMad agents, workflows, and domain-specific modules with guided assistance. |
| 7 | +**Build More, Architect Dreams... With the BMad Builder!** |
8 | 8 |
|
9 | | -## About BMad Builder |
| 9 | +BMad Builder is so much more than a skill builder. BMad Method modules support: |
10 | 10 |
|
11 | | -BMad Builder (BMB) is a meta-module for BMad Method that helps you create your own agents and workflows. Whether you're building domain-specific expertise or automating repetitive development tasks, BMB guides you through: |
| 11 | +- **Agents** that transform your AI tool into exactly who you need to talk to — with memory that persists across sessions |
| 12 | +- **Workflows** that go far beyond simple tasks into truly guided, facilitated processes that can produce near-infinite steps and turns as needed |
| 13 | +- **Modules** that are entire ecosystems, not just skill packs — like the BMad Method module for agile AI-driven development. You can create simpler or vastly more complex modules for any entertainment or work purpose. |
12 | 14 |
|
13 | | -- **Agent Builder** — Create specialized AI agents with custom expertise, communication styles, and tool access |
14 | | -- **Workflow Builder** — Design structured workflows with steps, menus, and cross-workflow communication |
15 | | -- **Module Builder** — Package agents and workflows into shareable BMad modules |
| 15 | +## The Dream |
16 | 16 |
|
17 | | -## Installation |
| 17 | +Imagine AI that truly knows you — a fitness coach that remembers every PR, a writing partner that knows your characters better than you do, a research assistant that learns your preferences. |
18 | 18 |
|
19 | | -BMad Builder is installed as a module during BMad Method setup: |
| 19 | +BMad Builder lets you create: |
20 | 20 |
|
21 | | -```bash |
22 | | -npx bmad-method@alpha install |
23 | | -``` |
| 21 | +- **Personal AI Companions** — Agents with memory that evolve with you over time |
| 22 | +- **Domain Experts** — Specialists for any field: legal, medical, creative, technical |
| 23 | +- **Workflow Automations** — Structured processes that guide you through complex tasks |
| 24 | +- **Custom Modules** — Bundle agents and workflows into shareable packages that can empower any type of business or domain |
24 | 25 |
|
25 | | -Select **BMad Builder** from the modules list. |
| 26 | +## What Makes It Different |
26 | 27 |
|
27 | | -## Quick Start |
28 | | - |
29 | | -After installing BMad Method with BMB, run from your project root: |
30 | | - |
31 | | -``` |
32 | | -/bmb-agent |
33 | | -``` |
34 | | - |
35 | | -This launches the Agent Builder workflow that guides you through creating a custom agent. |
| 28 | +| Feature | Why It Matters | |
| 29 | +|---------|----------------| |
| 30 | +| **Persistent Memory** | Agents remember across sessions — they learn and grow | |
| 31 | +| **Composable** | Your creations work alongside the entire BMad ecosystem | |
| 32 | +| **Skill-Compliant** | Built on open standards that work with any AI tool | |
| 33 | +| **Shareable** | Package your modules for the BMad Marketplace (coming soon) | |
36 | 34 |
|
37 | 35 | ## What You Can Build |
38 | 36 |
|
39 | | -| Type | Description | Workflow | |
40 | | -|------|-------------|----------| |
41 | | -| **Agents** | Domain experts with specialized knowledge and tools | `/bmb-agent` | |
42 | | -| **Workflows** | Structured processes with steps and decision points | `/bmb-workflow` | |
43 | | -| **Modules** | Packaged agents + workflows ready to share | `/bmb-module` | |
44 | | - |
45 | | -## Example: Creating a Domain Expert Agent |
46 | | - |
47 | | -``` |
48 | | -You: /bmb-agent |
49 | | -BMB: What domain should this agent specialize in? |
50 | | -You: Blockchain Development |
51 | | -BMB: Great! A blockchain expert would need to know about... |
52 | | - [Guides you through agent configuration] |
53 | | -``` |
54 | | - |
55 | | -## Module Structure |
56 | | - |
57 | | -BMad modules follow a standard structure: |
58 | | - |
59 | | -``` |
60 | | -your-module/ |
61 | | -├── src/ |
62 | | -│ ├── module.yaml # Module metadata and install config |
63 | | -│ ├── agents/ # Agent definitions (.agent.yaml) |
64 | | -│ ├── workflows/ # Workflow files |
65 | | -│ └── tools/ # Small reusable tools |
66 | | -└── package.json # NPM package info |
67 | | -``` |
68 | | - |
69 | | -## Publishing Your Module |
70 | | - |
71 | | -When your module is ready to share: |
72 | | - |
73 | | -```bash |
74 | | -# Bump version and create git tag |
75 | | -npm run release |
76 | | - |
77 | | -# Or manually: |
78 | | -git tag v1.0.0 |
79 | | -git push origin v1.0.0 |
80 | | -``` |
81 | | - |
82 | | -See [bmad-module-template](https://github.com/bmad-code-org/bmad-module-template) for a starting point. |
| 37 | +| Domain | Example | |
| 38 | +|--------|---------| |
| 39 | +| **Personal** | Journal companion, habit coach, learning tutor | |
| 40 | +| **Professional** | Code reviewer, documentation specialist, workflow automator | |
| 41 | +| **Creative** | Story architect, character developer, campaign designer | |
| 42 | +| **Any Domain** | If you can describe it, you can build it | |
83 | 43 |
|
84 | | -## Documentation |
| 44 | +## Learn More |
85 | 45 |
|
86 | | -**[BMad Builder Documentation](http://bmad-builder-docs.bmad-method.org)** — Tutorials, how-to guides, and reference |
| 46 | +**[Documentation and Quick Start](https://bmad-builder-docs.bmad-method.org)** |
87 | 47 |
|
88 | | -- [Getting Started](http://bmad-builder-docs.bmad-method.org/tutorials/) |
89 | | -- [BMad Method Docs](http://docs.bmad-method.org) — Core framework documentation |
| 48 | +Complete guides for building agents, workflows, and modules. |
90 | 49 |
|
91 | 50 | ## Community |
92 | 51 |
|
93 | | -- [Discord](https://discord.gg/gk8jAdXWmj) — Get help and share your creations |
94 | | -- [GitHub Issues](https://github.com/bmad-code-org/bmad-builder/issues) — Bug reports and feature requests |
95 | | -- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations |
| 52 | +- **[Discord](https://discord.gg/gk8jAdXWmj)** — Get help and share what you've built |
| 53 | +- **[BMad Method](https://docs.bmad-method.org)** — Core framework documentation |
96 | 54 |
|
97 | 55 | ## License |
98 | 56 |
|
99 | | -MIT License — see [LICENSE](LICENSE) for details. |
| 57 | +MIT — see [LICENSE](LICENSE) for details. |
100 | 58 |
|
101 | 59 | --- |
102 | 60 |
|
|
0 commit comments