mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
12d3492e0c
* feat: add link auditor tools and fix broken docs links - Add audit-doc-links.js to scan docs for broken links with auto-resolution - Add fix-doc-links.js to apply suggested fixes (dry-run by default) - Remove stale "Back to Core Concepts" breadcrumb links - Update BMad acronym to "Breakthrough Method of Agile AI Driven Development" - Update README links to docs.bmad-method.org - Simplify upgrade callout in getting-started tutorial Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: reorganize docs structure and archive v4 tutorial - Remove unused section index files (tutorials, how-to, explanation, reference) - Move getting-started-bmadv4.md to _archive - Update quick-start-bmgd.md to remove archived file reference - Update upgrade-to-v6.md - Update astro.config.mjs for new structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: ignore underscore directories in link checker Update check-doc-links.js to skip _archive, _planning, and other underscore-prefixed directories when validating links. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add v4 users section to README Add links to v4 documentation archive and upgrade guide for users migrating from previous versions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: convert docs to site-relative links and add validation tools - Convert all relative links (./ ../) to site-relative paths (/path/) - Strip .md extensions and use trailing slashes for Astro/Starlight - Add fix-doc-links.js to convert relative links to site-relative - Add validate-doc-links.js to check links point to existing files - Remove old audit-doc-links.js and check-doc-links.js - Update build-docs.js to use new validation script - Add npm scripts: docs:fix-links, docs:validate-links - Update style guide with validation steps Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize acronym to BMad across documentation Replace incorrect "BMAD" with correct "BMad" in text and frontmatter while preserving "BMAD-METHOD" in GitHub URLs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: fix BMad acronym and remove draft README - Correct acronym to "Breakthrough Method of Agile AI Driven Development" - Remove unused README-draft.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize BMad acronym in README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize FAQ format across all FAQ pages - Add TOC with jump links under "## Questions" - Use ### headers for questions (no Q: prefix) - Direct answers without **A:** prefix - Remove horizontal rules and "Related Documentation" sections - End each FAQ with issue/Discord CTA - Update style guide with new FAQ guidelines - Delete redundant faq/index.md (sidebar handles navigation) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use repo-relative links with .md for GitHub compatibility Convert all documentation links to repo-relative format (/docs/path/file.md) so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix and converts .md to trailing slash at build time for Astro/Starlight. - Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths - Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension - Convert 217 links across 64 files to new format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: handle /docs/ prefix in link validator Update resolveLink to strip /docs/ prefix from repo-relative links before checking if files exist. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: restore FAQ index page Re-add the FAQ index page that was accidentally deleted, with updated repo-relative link format. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
139 lines
2.7 KiB
Markdown
139 lines
2.7 KiB
Markdown
---
|
|
title: "How to Install BMad"
|
|
description: Step-by-step guide to installing BMad in your project
|
|
---
|
|
|
|
|
|
Complete guide to installing BMad in your project.
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- **Node.js** 20+ (required for the installer)
|
|
- **Git** (recommended)
|
|
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
|
|
|
|
---
|
|
|
|
## Steps
|
|
|
|
### 1. Run the Installer
|
|
|
|
```bash
|
|
npx bmad-method install
|
|
```
|
|
|
|
### 2. Choose Installation Location
|
|
|
|
The installer will ask where to install BMad files. Options:
|
|
- Current directory (recommended for new projects)
|
|
- Subdirectory
|
|
- Custom path
|
|
|
|
### 3. Select Your AI Tools
|
|
|
|
Choose which AI tools you'll be using:
|
|
- Claude Code
|
|
- Cursor
|
|
- Windsurf
|
|
- Other
|
|
|
|
The installer configures BMad for your selected tools.
|
|
|
|
### 4. Choose Modules
|
|
|
|
Select which modules to install:
|
|
|
|
| Module | Purpose |
|
|
|--------|---------|
|
|
| **BMM** | Core methodology for software development |
|
|
| **BMGD** | Game development workflows |
|
|
| **CIS** | Creative intelligence and facilitation |
|
|
| **BMB** | Building custom agents and workflows |
|
|
|
|
### 5. Add Custom Content (Optional)
|
|
|
|
If you have custom agents, workflows, or modules:
|
|
- Point to their location
|
|
- The installer will integrate them
|
|
|
|
### 6. Configure Settings
|
|
|
|
For each module, either:
|
|
- Accept recommended defaults (faster)
|
|
- Customize settings (more control)
|
|
|
|
---
|
|
|
|
## Verify Installation
|
|
|
|
After installation, verify by:
|
|
|
|
1. Checking the `_bmad/` directory exists
|
|
2. Loading an agent in your AI tool
|
|
3. Running `*menu` to see available commands
|
|
|
|
---
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
your-project/
|
|
├── _bmad/
|
|
│ ├── bmm/ # Method module
|
|
│ │ ├── agents/ # Agent files
|
|
│ │ ├── workflows/ # Workflow files
|
|
│ │ └── config.yaml # Module config
|
|
│ ├── core/ # Core utilities
|
|
│ └── ...
|
|
├── _bmad-output/ # Generated artifacts
|
|
└── .claude/ # IDE configuration
|
|
```
|
|
|
|
---
|
|
|
|
## Configuration
|
|
|
|
Edit `_bmad/[module]/config.yaml` to customize:
|
|
|
|
```yaml
|
|
output_folder: ./_bmad-output
|
|
user_name: Your Name
|
|
communication_language: english
|
|
```
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### "Command not found: npx"
|
|
|
|
Install Node.js 20+:
|
|
```bash
|
|
brew install node
|
|
|
|
```
|
|
|
|
### "Permission denied"
|
|
|
|
Check npm permissions:
|
|
```bash
|
|
npm config set prefix ~/.npm-global
|
|
```
|
|
|
|
### Installer hangs
|
|
|
|
Try running with verbose output:
|
|
```bash
|
|
npx bmad-method install --verbose
|
|
```
|
|
|
|
---
|
|
|
|
## Related
|
|
|
|
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
- [Upgrade to V6](/docs/how-to/installation/upgrade-to-v6.md) - Upgrading from previous versions
|
|
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) - Adding custom content
|