docs updated and agent standalone builder working now from the main install flow
This commit is contained in:
@@ -105,10 +105,17 @@ create-agent/
|
||||
|
||||
### Generated Files
|
||||
|
||||
- YAML agent saved at:
|
||||
`{output_folder}/agents/{{agent_filename}}.agent.yaml` (or `src/modules/{{target_module}}/agents/{{agent_filename}}.agent.yaml` if `src_impact=true`)
|
||||
- Compiled `.md` generated by installer at:
|
||||
`{project-root}/bmad/{{module}}/agents/{{agent_filename}}.md`
|
||||
#### For Standalone Agents (not part of a module)
|
||||
|
||||
- **YAML Source**: `{output_folder}/agents/{{agent_filename}}.agent.yaml`
|
||||
- **Installation Location**: `{project-root}/bmad/agents/{{agent_filename}}.md`
|
||||
- **Compilation**: Run `npm run build:agents` or use the installer menu
|
||||
|
||||
#### For Module Agents
|
||||
|
||||
- **YAML Source**: `src/modules/{{target_module}}/agents/{{agent_filename}}.agent.yaml`
|
||||
- **Installation Location**: `{project-root}/bmad/{{module}}/agents/{{agent_filename}}.md`
|
||||
- **Compilation**: Automatic during module installation
|
||||
|
||||
### YAML Agent Structure (simplified)
|
||||
|
||||
@@ -136,6 +143,51 @@ agent:
|
||||
If created, generates at:
|
||||
`{project-root}/bmad/_cfg/agents/{{module}}-{{agent_filename}}.customize.yaml`
|
||||
|
||||
## Installation and Compilation
|
||||
|
||||
### Agent Installation Locations
|
||||
|
||||
Agents are installed to different locations based on their type:
|
||||
|
||||
1. **Standalone Agents** (not part of a module)
|
||||
- Source: Created in your project's output folder
|
||||
- Installed to: `{project-root}/bmad/agents/`
|
||||
- Compilation: Manual via `npm run build:agents`
|
||||
|
||||
2. **Module Agents** (part of BMM, BMB, or custom modules)
|
||||
- Source: Created in `src/modules/{module}/agents/`
|
||||
- Installed to: `{project-root}/bmad/{module}/agents/`
|
||||
- Compilation: Automatic during module installation
|
||||
|
||||
### Compilation Process
|
||||
|
||||
The installer compiles YAML agent definitions to Markdown:
|
||||
|
||||
```bash
|
||||
# For standalone agents
|
||||
npm run build:agents
|
||||
|
||||
# For all BMad components (includes agents)
|
||||
npm run install:bmad
|
||||
|
||||
# Using the installer menu
|
||||
npm run installer
|
||||
# Then select: Compile Agents
|
||||
```
|
||||
|
||||
### Build Commands
|
||||
|
||||
Additional build commands for agent management:
|
||||
|
||||
```bash
|
||||
# Build specific agent types
|
||||
npx bmad-method build:agents # Build standalone agents
|
||||
npx bmad-method build:modules # Build module agents (with modules)
|
||||
|
||||
# Full rebuild
|
||||
npx bmad-method build:all # Rebuild everything
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- BMAD Core v6 project structure
|
||||
@@ -192,11 +244,13 @@ Users can go from **vague idea → brainstormed concept → built agent** in one
|
||||
|
||||
### After Completion
|
||||
|
||||
1. Compile agents: `npm run install:bmad` → "Compile Agents"
|
||||
2. Test the compiled `.md` agent in your IDE
|
||||
3. Implement any "todo" workflows
|
||||
4. Refine persona based on usage or via customize file
|
||||
5. Add more commands as agent evolves
|
||||
1. **Compile the agent**:
|
||||
- For standalone agents: Run `npm run build:agents` or use the installer menu
|
||||
- For module agents: Automatic during module installation
|
||||
2. **Test the agent**: Use the compiled `.md` agent in your IDE
|
||||
3. **Implement placeholders**: Complete any "todo" workflows referenced
|
||||
4. **Refine as needed**: Use customize file for persona adjustments
|
||||
5. **Evolve over time**: Add new commands as requirements emerge
|
||||
|
||||
## Agent Types
|
||||
|
||||
|
||||
Reference in New Issue
Block a user