docs: remove fluff from installation guide

- Remove verbose explanations and marketing language
- Keep only essential commands and process steps
- Reduce from verbose guide to concise reference
- Focus on what users need to know, not explanations
This commit is contained in:
Brian Madison 2025-11-22 16:27:16 -06:00
parent c57ada4d9c
commit b20773e7f7
1 changed files with 19 additions and 75 deletions

View File

@ -1,92 +1,36 @@
# Installing Your Custom Agent
# Custom Agent Installation
Your agent YAML file is a template that gets compiled to a runnable Markdown (.md) file with XML.
**Good news**: You can install agents without cloning the BMAD repository using `npx bmad-method`!
## Installation Options
### Option 1: Interactive Install (Recommended)
## Quick Install
```bash
# From your BMAD project directory
# Option A: If you have BMAD installed locally
bmad agent-install
# Option B: If you don't have BMAD cloned (works anywhere!)
# Interactive
npx bmad-method agent-install
# Follow the prompts to select and install your agent
# Non-interactive
npx bmad-method agent-install --defaults
```
**Best for**: Installing individual agents with custom naming and target selection
### Option 2: Batch Install
1. **Copy** your agent YAML to `{project}/.bmad/custom/src/agents/`
2. **Run** the installer and select "Compile Agents (Quick rebuild of all agent .md files)"
**Best for**: Installing multiple agents at once or rebuilding all custom agents
## What Happens During Installation
1. **Source**: Your agent YAML (from `custom/src/agents/`)
2. **Compile**: Gets converted to executable .md format
3. **Install**: Copied to `custom/agents/{agent-name}/`
4. **Register**: Added to agent manifest and IDE commands
5. **Backup**: Source saved to `_cfg/custom/agents/` for updates
## Automatic Updates
**For individual agents**:
## Install Specific Agent
```bash
bmad agent-install # If BMAD installed locally
npx bmad-method agent-install # Works anywhere without cloning
```
**For all agents (including custom ones)**:
- `bmad install` → "Compile Agents" (rebuild all agents)
- `bmad install` → "Quick Update" (during upgrades)
**Advanced Parameters**:
```bash
# Install specific agent file
# From specific source file
npx bmad-method agent-install --source ./my-agent.agent.yaml
# Use default configuration (non-interactive, no prompts)
npx bmad-method agent-install --defaults
# With default config (no prompts)
npx bmad-method agent-install --source ./my-agent.agent.yaml --defaults
# Install to specific destination
npx bmad-method agent-install --destination ./my-project
# Combine parameters
npx bmad-method agent-install --source ./my-agent.agent.yaml --defaults --destination ./my-project
# To specific destination
npx bmad-method agent-install --source ./my-agent.agent.yaml --destination ./my-project
```
**When to use which**:
## Batch Install
- **Option 1**: Best for new agents or when you want custom persona names
- **Option 2**: Best for bulk updates or when you've modified YAML files directly
1. Copy agent YAML to `.bmad/custom/src/agents/`
2. Run installer and select "Compile Agents"
## File Structure
## What Happens
```
custom/
├── src/agents/ # Your source YAMLs (BMB builder output)
└── agents/ # Installed compiled agents
└── my-agent/
└── my-agent.md # Runnable agent
_cfg/custom/agents/ # Backup copies for updates
```
## Target Projects
You can install agents to:
- Current project (default)
- Any other BMAD project on your system
- Custom directory (for sharing agents)
1. Source YAML compiled to .md
2. Installed to `custom/agents/{agent-name}/`
3. Added to agent manifest
4. Backup saved to `_cfg/custom/agents/`