Compare commits

...

4 Commits

Author SHA1 Message Date
Brian Madison be122d6cec 4.44.2 2025-10-29 09:50:46 -05:00
Brian Madison 93ddbcb43a 4.44.1 2025-10-29 09:50:18 -05:00
Brian Madison e917156e70 feat: add v6 alpha notice to v4 README and installer 2025-10-29 09:50:04 -05:00
Brian Madison 13cb8b368b readme update for locked branch 2025-10-24 11:00:09 -05:00
4 changed files with 48 additions and 76 deletions

111
README.md
View File

@ -1,41 +1,33 @@
# BMAD-METHOD™: Universal AI Agent Framework # BMAD-METHOD™: Universal AI Agent Framework (v4 - Stable)
> ## 🚨 **IMPORTANT VERSION ANNOUNCEMENT** 🚨
>
> ### Current Stable: v4.x | Next Major: v6 Alpha
>
> - **v4.x** - The current stable release version available via npm
> - **v5** - Skipped (replaced by v6)
> - **[v6-alpha](https://github.com/bmad-code-org/BMAD-METHOD/tree/v6-alpha)** - **NOW AVAILABLE FOR EARLY TESTING!**
>
> ### 🧪 Try v6 Alpha (Early Adopters Only)
>
> The next major version of BMAD-METHOD is now available for early experimentation and testing. This is a complete rewrite with significant architectural changes.
>
> **⚠️ WARNING: v6-alpha is for early adopters who are comfortable with:**
>
> - Potential breaking changes
> - Daily updates and instability
> - Incomplete features
> - Experimental functionality
>
> **📅 Timeline:** Official beta version will be merged mid-October 2025
>
> **To try v6-alpha:**
>
> ```bash
> git clone https://github.com/bmad-code-org/BMAD-METHOD.git
> cd BMAD-METHOD
> git checkout v6-alpha
> ```
>
> ---
[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method) [![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
> ## 🚨 **v4 STABLE - NO NEW FEATURES** 🚨
>
> This is the **stable, production-ready v4 version** of BMad Method. It will receive **critical patches only** - no new features will be added.
>
> **Install v4 Stable:** `npx bmad-method install`
---
## 🆕 Want to Try v6 Alpha?
**BMad v6** is under active development with major improvements:
- Scale-adaptive workflows (Levels 0-4)
- Project-adaptive architecture
- Enhanced module system (BMM, BMB, CIS)
- Update-safe customization
**[View v6 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/main)** | **Install:** `npx bmad-method@alpha install`
> **Note:** v6 is in alpha - stable enough for testing but not production-ready yet.
---
Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, yet so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few. Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, yet so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)** **[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
@ -78,43 +70,37 @@ This two-phase approach eliminates both **planning inconsistency** and **context
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive - **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
- **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas - **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas
## Important: Keep Your BMad Installation Updated ## Important: Keep Your v4 Installation Updated
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD™ installed in your project, simply run: **Stay up-to-date with v4 patches!** If you already have BMAD-METHOD™ v4 installed in your project, run:
```bash ```bash
npx bmad-method install npx bmad-method install
# OR
git pull
npm run install:bmad
``` ```
This will: This will:
- ✅ Automatically detect your existing v4 installation - ✅ Automatically detect your existing v4 installation
- ✅ Update only the files that have changed and add new files - ✅ Update only the files that have changed (critical patches only)
- ✅ Create `.bak` backup files for any custom modifications you've made - ✅ Create `.bak` backup files for any custom modifications you've made
- ✅ Preserve your project-specific configurations - ✅ Preserve your project-specific configurations
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations! > **Remember:** v4 receives critical patches only. For new features, try [v6 alpha](#-want-to-try-v6-alpha).
## Quick Start ## Quick Start (v4 Stable)
### One Command for Everything (IDE Installation) ### One Command Installation
**Just run one of these commands:** **Install v4 stable version:**
```bash ```bash
npx bmad-method install npx bmad-method install
# OR if you already have BMad installed:
git pull
npm run install:bmad
``` ```
This single command handles: This command handles:
- **New installations** - Sets up BMad in your project - **New installations** - Sets up BMad v4 in your project
- **Upgrades** - Updates existing installations automatically - **Upgrades** - Updates existing v4 installations with patches
- **Expansion packs** - Installs any expansion packs you've added to package.json - **Expansion packs** - Installs any expansion packs you've added to package.json
> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything. > **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
@ -130,10 +116,11 @@ This single command handles:
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works! 5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
6. **When to move to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details 6. **When to move to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details
### Alternative: Clone and Build ### Alternative: Clone v4 Branch
```bash ```bash
git clone https://github.com/bmadcode/bmad-method.git git clone -b V4 https://github.com/bmad-code-org/BMAD-METHOD.git
cd BMAD-METHOD
npm run install:bmad # build and install all to a destination folder npm run install:bmad # build and install all to a destination folder
``` ```
@ -157,29 +144,7 @@ BMAD™'s natural language framework works in ANY domain. Expansion packs provid
## Contributing ## Contributing
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉 **v4 is frozen** - only critical patches accepted. For new features and contributions, please work on **[v6 (main branch)](https://github.com/bmad-code-org/BMAD-METHOD/tree/main)**.
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
### Working with Forks
When you fork this repository, CI/CD workflows are **disabled by default** to save resources. This is intentional and helps keep your fork clean.
#### Need CI/CD in Your Fork?
See our [Fork CI/CD Guide](.github/FORK_GUIDE.md) for instructions on enabling workflows in your fork.
#### Contributing Workflow
1. **Fork the repository** - Click the Fork button on GitHub
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/BMAD-METHOD.git`
3. **Create a feature branch** - `git checkout -b feature/amazing-feature`
4. **Make your changes** - Test locally with `npm test`
5. **Commit your changes** - `git commit -m 'feat: add amazing feature'`
6. **Push to your fork** - `git push origin feature/amazing-feature`
7. **Open a Pull Request** - CI/CD will run automatically on the PR
Your contributions are tested when you submit a PR - no need to enable CI in your fork!
## License ## License

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "bmad-method", "name": "bmad-method",
"version": "4.43.0", "version": "4.44.2",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "bmad-method", "name": "bmad-method",
"version": "4.43.0", "version": "4.44.2",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@kayvan/markdown-tree-parser": "^1.6.1", "@kayvan/markdown-tree-parser": "^1.6.1",

View File

@ -1,7 +1,7 @@
{ {
"$schema": "https://json.schemastore.org/package.json", "$schema": "https://json.schemastore.org/package.json",
"name": "bmad-method", "name": "bmad-method",
"version": "4.44.0", "version": "4.44.2",
"description": "Breakthrough Method of Agile AI-driven Development", "description": "Breakthrough Method of Agile AI-driven Development",
"keywords": [ "keywords": [
"agile", "agile",

View File

@ -208,6 +208,13 @@ async function promptInstallation() {
console.log(chalk.bold.magenta('🚀 Universal AI Agent Framework for Any Domain')); console.log(chalk.bold.magenta('🚀 Universal AI Agent Framework for Any Domain'));
console.log(chalk.bold.blue(`✨ Installer v${version}\n`)); console.log(chalk.bold.blue(`✨ Installer v${version}\n`));
// Deprecation notice for v4
console.log(chalk.yellow.bold('⚠️ You are installing BMad v4 (stable but frozen)'));
console.log(chalk.yellow(' v4 receives critical patches only - no new features\n'));
console.log(chalk.cyan('💡 Want the latest features? Try BMad v6 Alpha:'));
console.log(chalk.white(' npx bmad-method@alpha install'));
console.log(chalk.dim(' (Alpha is stable enough for testing)\n'));
const answers = {}; const answers = {};
// Ask for installation directory first // Ask for installation directory first