Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"name": "bmad-builder",
"source": "./",
"description": "Build AI agents and workflows from a conversation. Three skills — Agent Builder, Workflow Builder, and Setup — guide you from idea to production-ready skill structure with built-in quality optimization. Part of the BMad Method ecosystem.",
"version": "1.1.0",
"version": "1.2.0",
"author": {
"name": "Brian (BMad) Madison"
},
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ assignees: ''
A clear and concise description of what the bug is.

**Steps to reproduce**

1. What were you doing when the bug occurred?
2. What steps can recreate the issue?

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment (if relevant)**

- Model(s) used:
- Agentic IDE used:
- BMad version:
Expand Down
14 changes: 13 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@
## Key Commands

### Development

```bash
npm run docs:dev # Start Astro dev server (http://localhost:4321)
npm run docs:build # Build documentation site
npm run docs:preview # Preview built site
```

### Testing & Validation

```bash
npm test # Run full test suite (schemas, refs, lint, format, md)
npm run test:schemas # Validate agent YAML schemas
Expand All @@ -23,6 +25,7 @@ npm run validate:refs # Check file references (alias for above)
```

### Code Quality

```bash
npm run lint # ESLint check
npm run lint:fix # ESLint auto-fix
Expand All @@ -32,6 +35,7 @@ npm run format:fix # Prettier format
```

### Release

```bash
npm run release # Bump patch version and push tag
npm run release:minor # Bump minor version
Expand All @@ -41,13 +45,15 @@ npm run release:major # Bump major version
## Architecture

### Source Structure (`src/`)

- **`agents/`** — Agent definitions (`*.agent.yaml`) with persona, menu, and metadata
- **`workflows/`** — Multi-step guided processes organized by type (agent, workflow, module)
- Each workflow has `steps-c/` (create), `steps-e/` (edit), `steps-v/` (validate)
- Step-file architecture: JIT loading, sequential execution, state tracking
- `data/` contains CSV knowledge bases for agents

### Module Structure

```
your-module/
├── src/
Expand All @@ -59,15 +65,18 @@ your-module/
```

### Build Tools (`tools/`)

- **`build-docs.mjs`** — Consolidates docs, generates LLM-friendly files (`llms.txt`), builds Astro site
- **`validate-file-refs.mjs`** — Validates cross-file references in agents/workflows

### Documentation (`docs/`)

- Diataxis structure: tutorials, how-to, explanation, reference
- Starlight-based site in `website/`
- `_STYLE_GUIDE.md` — Project-specific writing conventions (Google style + Diataxis)

### Skills (`.claude/skills/`)

- BMad OS (Open Source) skills for maintainer workflows
- `bmad-os-add-doc` — Diataxis documentation authoring
- `bmad-os-release-module` — Module release process
Expand All @@ -76,19 +85,22 @@ your-module/
## Important Concepts

### Agent YAML Structure

- `agent.metadata` — id, name, title, icon, module
- `agent.persona` — role, identity, communication_style, principles
- `agent.menu` — trigger commands that execute workflows
- `conversational_knowledge` — CSV files loaded at runtime

### Workflow Step Architecture

- Micro-file design: each step is self-contained
- Just-in-time loading: only current step in memory
- Sequential enforcement with state tracking
- Menus halt execution waiting for user input
- Frontmatter defines: name, description, web_bundle, createWorkflow

### Path Variables

- `{project-root}/_bmad/bmb/` — Installation path (in repo, maps to `src/`)
- `{bmad_builder_output_folder}` — User's custom content output
- Runtime variables: `{output_folder}`, `{project-root}` from Core config
Expand All @@ -104,4 +116,4 @@ your-module/

## Publishing

BMad modules are published as npm packages. The module code (`src/`) is what gets installed into user projects via `npx bmad-method install`. The astro website is deployed separately (GitHub Pages via CNAME).
BMad modules are published as npm packages. The module code (`src/`) is what gets installed into user projects via `npx bmad-method install`. The astro website is deployed separately (GitHub Pages via CNAME).
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@

First official v1 release of BMad Builder — a standard skill-compliant factory for creating BMad Agents, Workflows, and Modules.
The module specific skill is coming soon pending alignment on final format with skill transition.

8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ Thank you for considering contributing! We believe in **Human Amplification, Not
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**

**✅ What we welcome:**

- Enhanced collaboration patterns and workflows
- Improved agent personas and prompts
- Domain-specific modules leveraging BMad Core
- Better planning and context continuity

**❌ What doesn't fit:**

- Purely automated solutions that sideline humans
- Complexity that creates barriers to adoption
- Features that fragment BMad Core's foundation
Expand Down Expand Up @@ -97,17 +99,21 @@ If your change exceeds 800 lines, break it into smaller PRs that can be reviewed

```markdown
## What

[1-2 sentences describing WHAT changed]

## Why

[1-2 sentences explaining WHY this change is needed]
Fixes #[issue number]

## How

- [2-3 bullets listing HOW you implemented it]
-

## Testing

[1-2 sentences on how you tested this]
```

Expand All @@ -130,7 +136,7 @@ Keep messages under 72 characters. Each commit = one logical change.

## What Makes a Good PR?

| ✅ Do | ❌ Don't |
| ✅ Do | ❌ Don't |
| --------------------------- | ---------------------------- |
| Change one thing per PR | Mix unrelated changes |
| Clear title and description | Vague or missing explanation |
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ BMad Builder lets you create:

## What Makes It Different

| Feature | Why It Matters |
|---------|----------------|
| **Persistent Memory** | Agents remember across sessions — they learn and grow |
| **Composable** | Your creations work alongside the entire BMad ecosystem |
| **Skill-Compliant** | Built on open standards that work with any AI tool |
| **Shareable** | Package your modules for the BMad Marketplace (coming soon) |
| Feature | Why It Matters |
| --------------------- | ----------------------------------------------------------- |
| **Persistent Memory** | Agents remember across sessions — they learn and grow |
| **Composable** | Your creations work alongside the entire BMad ecosystem |
| **Skill-Compliant** | Built on open standards that work with any AI tool |
| **Shareable** | Package your modules for the BMad Marketplace (coming soon) |

## What You Can Build

| Domain | Example |
|--------|---------|
| **Personal** | Journal companion, habit coach, learning tutor |
| Domain | Example |
| ---------------- | ----------------------------------------------------------- |
| **Personal** | Journal companion, habit coach, learning tutor |
| **Professional** | Code reviewer, documentation specialist, workflow automator |
| **Creative** | Story architect, character developer, campaign designer |
| **Any Domain** | If you can describe it, you can build it |
| **Creative** | Story architect, character developer, campaign designer |
| **Any Domain** | If you can describe it, you can build it |

## Learn More

Expand Down
8 changes: 4 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

We release security patches for the following versions:

| Version | Supported |
| ------- | ------------------ |
| Latest | :white_check_mark: |
| < Latest | :x: |
| Version | Supported |
| -------- | ------------------ |
| Latest | :white_check_mark: |
| < Latest | :x: |

We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.

Expand Down
1 change: 0 additions & 1 deletion docs/404.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Page Not Found
template: splash
---


The page you're looking for doesn't exist or has been moved.

[Return to Home](/index.md)
6 changes: 3 additions & 3 deletions docs/_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Documentation Style Guide"
title: 'Documentation Style Guide'
description: Project-specific documentation conventions based on Google style and Diataxis structure
---

Expand Down Expand Up @@ -55,8 +55,8 @@ Critical warnings only — data loss, security issues
```md
| Phase | Name | What Happens |
| ----- | -------- | -------------------------------------------- |
| 1 | Analysis | Brainstorm, research *(optional)* |
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
| 1 | Analysis | Brainstorm, research _(optional)_ |
| 2 | Planning | Requirements — PRD or tech-spec _(required)_ |
```

**Commands:**
Expand Down
31 changes: 16 additions & 15 deletions docs/explanation/index.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
---
title: "BMad Builder (BMB)"
title: 'BMad Builder (BMB)'
description: Create custom agents, workflows, and skills with BMad
---

Create world-class AI agents and workflows with the BMad Builder.

## Core Concepts

| Topic | Description |
|-------|-------------|
| **[What Are Skills](/explanation/what-are-skills.md)** | The universal building block for everything BMad produces |
| **[What Are Agents](/explanation/what-are-bmad-agents.md)** | AI personas with specialized capabilities and memory |
| **[What Are Workflows](/explanation/what-are-workflows.md)** | Structured step-by-step processes and utilities |
| Topic | Description |
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| **[What Are Skills](/explanation/what-are-skills.md)** | The universal building block for everything BMad produces |
| **[What Are Agents](/explanation/what-are-bmad-agents.md)** | AI personas with specialized capabilities and memory |
| **[What Are Workflows](/explanation/what-are-workflows.md)** | Structured step-by-step processes and utilities |
| **[What Are Modules](/explanation/what-are-modules.md)** | How agents and workflows combine into installable, configurable modules |
| **[Module Configuration](/explanation/module-configuration.md)** | How modules handle user configuration and help registration through a setup skill |

## Design Patterns

| Topic | Description |
|-------|-------------|
| **[Progressive Disclosure](/explanation/progressive-disclosure.md)** | Four layers of context loading — from frontmatter through step files |
| **[Subagent Patterns](/explanation/subagent-patterns.md)** | Six orchestration patterns for parallel and hierarchical work |
| **[Skill Authoring Best Practices](/explanation/skill-authoring-best-practices.md)** | Core principles, common patterns, quality dimensions, and anti-patterns |
| **[Scripts in Skills](/explanation/scripts-in-skills.md)** | Why deterministic scripts make skills faster, cheaper, and more reliable |
| Topic | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| **[Progressive Disclosure](/explanation/progressive-disclosure.md)** | Four layers of context loading — from frontmatter through step files |
| **[Subagent Patterns](/explanation/subagent-patterns.md)** | Six orchestration patterns for parallel and hierarchical work |
| **[Skill Authoring Best Practices](/explanation/skill-authoring-best-practices.md)** | Core principles, common patterns, quality dimensions, and anti-patterns |
| **[Scripts in Skills](/explanation/scripts-in-skills.md)** | Why deterministic scripts make skills faster, cheaper, and more reliable |

## Reference

| Resource | Description |
|----------|-------------|
| **[Builder Commands](/reference/builder-commands.md)** | All capabilities, modes, and phases for both builders |
| Resource | Description |
| -------------------------------------------------------- | ----------------------------------------------------- |
| **[Builder Commands](/reference/builder-commands.md)** | All capabilities, modes, and phases for both builders |
| **[Workflow Patterns](/reference/workflow-patterns.md)** | Skill types, structure patterns, and execution models |
Loading
Loading