docs: fix incorrect npm package references
- Fix npx bmad → npx bmad-method in documentation - Only bmad-method is registered in npm registry, not bmad - Clarify that bmad command works locally when BMAD is installed - Update installation guides to use correct package name Ensures users don't get 'package not found' errors when trying npx bmad
This commit is contained in:
parent
90af352247
commit
905f9ca346
|
|
@ -6,7 +6,7 @@ Install and personalize BMAD agents in your project.
|
|||
|
||||
```bash
|
||||
# From your project directory with BMAD installed
|
||||
npx bmad agent-install
|
||||
npx bmad-method agent-install
|
||||
```
|
||||
|
||||
Or if you have bmad-cli installed globally:
|
||||
|
|
@ -30,11 +30,35 @@ bmad agent-install
|
|||
bmad agent-install [options]
|
||||
|
||||
Options:
|
||||
-p, --path <path> Direct path to specific agent YAML file or folder
|
||||
-d, --defaults Use default values without prompting
|
||||
-t, --target <path> Target installation directory
|
||||
-p, --path <path> #Direct path to specific agent YAML file or folder
|
||||
-d, --defaults #Use default values without prompting
|
||||
-t, --target <path> #Target installation directory
|
||||
```
|
||||
|
||||
## Installing from Custom Locations
|
||||
|
||||
Use the `-p` / `--path` option to install agents from any location:
|
||||
|
||||
```bash
|
||||
# Install agent from a custom folder (expert agent with sidecar)
|
||||
bmad agent-install -p path/to/my-agent
|
||||
|
||||
# Install a specific .agent.yaml file (simple agent)
|
||||
bmad agent-install -p path/to/my-agent.agent.yaml
|
||||
|
||||
# Install with defaults (skip all prompts)
|
||||
bmad agent-install -p path/to/my-agent -d
|
||||
|
||||
# Install to a specific target project
|
||||
bmad agent-install -p path/to/my-agent -t /path/to/target/project
|
||||
```
|
||||
|
||||
This is useful when:
|
||||
|
||||
- Your agent is in a non-standard location (not in `.bmad/custom/agents/`)
|
||||
- You're developing an agent outside the project structure
|
||||
- You want to install from an absolute path
|
||||
|
||||
## Example Session
|
||||
|
||||
```
|
||||
|
|
@ -121,8 +145,8 @@ cp -r node_modules/bmad-method/src/modules/bmb/reference/agents/agent-with-memor
|
|||
### Step 2: Install and Personalize
|
||||
|
||||
```bash
|
||||
npx bmad agent-install
|
||||
# or: bmad agent-install
|
||||
npx bmad-method agent-install
|
||||
# or: bmad agent-install (if BMAD installed locally)
|
||||
```
|
||||
|
||||
The installer will:
|
||||
|
|
@ -156,14 +180,4 @@ src/modules/bmb/reference/agents/
|
|||
|
||||
## Creating Your Own
|
||||
|
||||
Place your `.agent.yaml` files in `.bmad/custom/agents/`. Use the reference agents as templates.
|
||||
|
||||
Key sections in an agent YAML:
|
||||
|
||||
- `metadata`: name, title, icon, type
|
||||
- `persona`: role, identity, communication_style, principles
|
||||
- `prompts`: reusable prompt templates
|
||||
- `menu`: numbered menu items
|
||||
- `install_config`: personalization questions (optional, at end of file)
|
||||
|
||||
See the reference agents for complete examples with install_config templates and XML-style semantic tags.
|
||||
Use the BMB agent builder to craft your agents. Once ready to use yourself, place your `.agent.yaml` files or folder in `.bmad/custom/agents/`.
|
||||
|
|
|
|||
|
|
@ -219,7 +219,7 @@ cp /path/to/commit-poet.agent.yaml .bmad/custom/agents/
|
|||
|
||||
# Install with personalization
|
||||
bmad agent-install
|
||||
# or: npx bmad agent-install
|
||||
# or: npx bmad-method agent-install
|
||||
```
|
||||
|
||||
The installer:
|
||||
|
|
|
|||
Loading…
Reference in New Issue