- Fix install-bmad.sh line ending issues preventing execution on Git Bash/WSL - Add comprehensive error handling and Windows path normalization - Create install-bmad.bat for native Windows Command Prompt support - Update .gitignore to exclude generated .bmad/ and exam/ directories - Add detailed installation troubleshooting guide to README - Improve installation verification with better error messages and fallback options Resolves installation failures across different platforms and environments. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .idea | ||
| .vscode | ||
| bmad-agent | ||
| bmad-system | ||
| docs | ||
| web-build-sample | ||
| .gitignore | ||
| README.md | ||
| build-web-agent.cfg.js | ||
| build-web-agent.js | ||
| install-bmad.bat | ||
| install-bmad.sh | ||
README.md
The BMAD-Method 3.1 (Breakthrough Method of Agile (ai-driven) Development)
🚀 Enhanced BMAD System Available!
NEW: The Enhanced BMAD System provides enterprise-grade, autonomous development capabilities with Claude Code integration!
Quick Start with Enhanced BMAD System (Recommended for Claude Code Users)
Local Installation from Downloaded Repository
Option 1: Automatic Installation (Recommended)
# Download or clone this repository first
git clone https://github.com/your-repo/BMAD-METHOD.git
cd BMAD-METHOD
# Copy install script to your project directory
cp install-bmad.sh /path/to/your-project/
cd /path/to/your-project/
# Run the installation script
chmod +x install-bmad.sh
./install-bmad.sh
Option 2: Windows Users
# Download or clone this repository first
git clone https://github.com/your-repo/BMAD-METHOD.git
cd BMAD-METHOD
# Copy install script to your project directory
copy install-bmad.bat C:\path\to\your-project\
cd C:\path\to\your-project\
# Run the Windows installation script
install-bmad.bat
Option 3: Manual Installation (If scripts fail)
# From the BMAD-METHOD directory
mkdir /path/to/your-project/.bmad
cp -r bmad-agent /path/to/your-project/.bmad/
cp -r bmad-system/* /path/to/your-project/.bmad/ 2>/dev/null || true
Use with Claude Code
After installation, start Claude Code in your project:
Please read CLAUDE.md for the BMAD system setup guide and use the recommended startup prompt.
Or directly:
I have the Enhanced BMAD System installed in my .bmad/ directory.
Please read the documentation and help me build my project using BMAD intelligence.
Enhanced System Features: 4 autonomy levels, universal LLM integration, enterprise features, self-optimization, 27 comprehensive modules.
Installation Troubleshooting
Common Issues:
-
"bmad-agent directory not found" error:
# Make sure you're running from BMAD-METHOD root directory ls -la # Should show bmad-agent/ directory -
Permission denied errors:
# Make script executable (Linux/Mac) chmod +x install-bmad.sh # Or use manual installation mkdir -p .bmad cp -r /path/to/BMAD-METHOD/bmad-agent .bmad/ -
Windows line ending issues:
# Convert line endings if needed dos2unix install-bmad.sh # Or use the Windows batch file instead install-bmad.bat -
Git Bash/WSL path issues:
# Use full paths if relative paths fail /c/path/to/BMAD-METHOD/install-bmad.sh
📚 Full Documentation: See /bmad-system/ directory for complete guides.
Original BMAD Method
Old Versions: Prior Version 1 Prior Version 2
Web Quickstart Project Setup (Original Method)
Orchestrator Uber BMad Agent that does it all - already pre-compiled in the web-build-sample folder.
- The contents of Agent Prompt Sample text get pasted into the Gemini Gem, or ChatPGT customGPT 'Instructions' field.
- The remaining files in that same folder folder just need to be attached as shown in the screenshot below. Give it a name (such as BMad Agent) and save it, and you now have the BMad Agent available to help you brainstorm, research, plan, execute on your vision, or understand how this all even works!
- Once its running, start with typing
/help, and then type option2when it presents 3 options to learn about the method!
More Documentation, Explanations, and IDE Specifics available here!
End Matter
Interested in improving the BMAD Method? See the contributing guidelines.
Thank you and enjoy - BMad! License
