fix(config): remove Windsurf from recommended/preferred IDEs (#1727)
Windsurf is no longer a preferred IDE. Only Claude Code and Cursor are now recommended. Windsurf remains a supported platform (installer still works, templates stay, reference tables stay). - Set preferred: false in both platform-codes.yaml files - Move windsurf entry to "Other IDEs" section in tools/platform-codes.yaml - Fix codex.js hardcoding preferred: true in constructor - Remove stale "3 preferred tools" count from ui.js JSDoc - Update docs to list only Claude Code and Cursor as recommended - Update docs/index.md popular tools to Claude Code, Cursor, Codex CLI
This commit is contained in:
parent
3dd37bc94d
commit
811d03262d
|
|
@ -32,7 +32,7 @@ npx bmad-method install
|
||||||
|
|
||||||
> If you are getting a stale beta version, use: `npx bmad-method@6.0.1 install`
|
> If you are getting a stale beta version, use: `npx bmad-method@6.0.1 install`
|
||||||
|
|
||||||
Follow the installer prompts, then open your AI IDE (Claude Code, Codex, Windsurf, etc.) in your project folder.
|
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, etc.) in your project folder.
|
||||||
|
|
||||||
**Non-Interactive Installation** (for CI/CD):
|
**Non-Interactive Installation** (for CI/CD):
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ This guide covers the essential workflow for onboarding to existing projects wit
|
||||||
:::note[Prerequisites]
|
:::note[Prerequisites]
|
||||||
- BMad Method installed (`npx bmad-method install`)
|
- BMad Method installed (`npx bmad-method install`)
|
||||||
- An existing codebase you want to work on
|
- An existing codebase you want to work on
|
||||||
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
- Access to an AI-powered IDE (Claude Code or Cursor)
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Step 1: Clean Up Completed Planning Artifacts
|
## Step 1: Clean Up Completed Planning Artifacts
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ If you want to use a non interactive installer and provide all install options o
|
||||||
:::note[Prerequisites]
|
:::note[Prerequisites]
|
||||||
- **Node.js** 20+ (required for the installer)
|
- **Node.js** 20+ (required for the installer)
|
||||||
- **Git** (recommended)
|
- **Git** (recommended)
|
||||||
- **AI tool** (Claude Code, Cursor, Windsurf, or similar)
|
- **AI tool** (Claude Code, Cursor, or similar)
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
@ -49,8 +49,6 @@ Pick which AI tools you use:
|
||||||
|
|
||||||
- Claude Code
|
- Claude Code
|
||||||
- Cursor
|
- Cursor
|
||||||
- Windsurf
|
|
||||||
- Kiro
|
|
||||||
- Others
|
- Others
|
||||||
|
|
||||||
Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
||||||
|
|
|
||||||
|
|
@ -59,7 +59,7 @@ Check the [BMad registry](https://github.com/bmad-code-org) for available extern
|
||||||
|
|
||||||
Available tool IDs for the `--tools` flag:
|
Available tool IDs for the `--tools` flag:
|
||||||
|
|
||||||
**Preferred:** `claude-code`, `cursor`, `windsurf`
|
**Preferred:** `claude-code`, `cursor`
|
||||||
|
|
||||||
Run `npx bmad-method install` interactively once to see the full current list of supported tools, or check the [platform codes configuration](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/cli/installers/lib/ide/platform-codes.yaml).
|
Run `npx bmad-method install` interactively once to see the full current list of supported tools, or check the [platform codes configuration](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/cli/installers/lib/ide/platform-codes.yaml).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ Use the **DEV agent** directly for bug fixes, refactorings, or small targeted ch
|
||||||
|
|
||||||
:::note[Prerequisites]
|
:::note[Prerequisites]
|
||||||
- BMad Method installed (`npx bmad-method install`)
|
- BMad Method installed (`npx bmad-method install`)
|
||||||
- An AI-powered IDE (Claude Code, Cursor, Windsurf, or similar)
|
- An AI-powered IDE (Claude Code, Cursor, or similar)
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Choose Your Approach
|
## Choose Your Approach
|
||||||
|
|
|
||||||
|
|
@ -39,9 +39,7 @@ BMad works with any AI coding assistant that supports custom system prompts or p
|
||||||
|
|
||||||
- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
|
- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
|
||||||
- **[Cursor](https://cursor.sh)** — AI-first code editor
|
- **[Cursor](https://cursor.sh)** — AI-first code editor
|
||||||
- **[Windsurf](https://codeium.com/windsurf)** — Codeium's AI IDE
|
- **[Codex CLI](https://github.com/openai/codex)** — OpenAI's terminal coding agent
|
||||||
- **[Kiro](https://kiro.dev)** — Amazon's AI-powered IDE
|
|
||||||
- **[Roo Code](https://roocode.com)** — VS Code extension
|
|
||||||
|
|
||||||
You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for.
|
You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ Build software faster using AI-powered workflows with specialized agents that gu
|
||||||
:::note[Prerequisites]
|
:::note[Prerequisites]
|
||||||
- **Node.js 20+** — Required for the installer
|
- **Node.js 20+** — Required for the installer
|
||||||
- **Git** — Recommended for version control
|
- **Git** — Recommended for version control
|
||||||
- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar
|
- **AI-powered IDE** — Claude Code, Cursor, or similar
|
||||||
- **A project idea** — Even a simple one works for learning
|
- **A project idea** — Even a simple one works for learning
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ const prompts = require('../../../lib/prompts');
|
||||||
*/
|
*/
|
||||||
class CodexSetup extends BaseIdeSetup {
|
class CodexSetup extends BaseIdeSetup {
|
||||||
constructor() {
|
constructor() {
|
||||||
super('codex', 'Codex', true); // preferred IDE
|
super('codex', 'Codex', false);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -168,7 +168,7 @@ platforms:
|
||||||
|
|
||||||
windsurf:
|
windsurf:
|
||||||
name: "Windsurf"
|
name: "Windsurf"
|
||||||
preferred: true
|
preferred: false
|
||||||
category: ide
|
category: ide
|
||||||
description: "AI-powered IDE with cascade flows"
|
description: "AI-powered IDE with cascade flows"
|
||||||
installer:
|
installer:
|
||||||
|
|
|
||||||
|
|
@ -582,7 +582,7 @@ class UI {
|
||||||
/**
|
/**
|
||||||
* Prompt for tool/IDE selection (called after module configuration)
|
* Prompt for tool/IDE selection (called after module configuration)
|
||||||
* Uses a split prompt approach:
|
* Uses a split prompt approach:
|
||||||
* 1. Recommended tools - standard multiselect for 3 preferred tools
|
* 1. Recommended tools - standard multiselect for preferred tools
|
||||||
* 2. Additional tools - autocompleteMultiselect with search capability
|
* 2. Additional tools - autocompleteMultiselect with search capability
|
||||||
* @param {string} projectDir - Project directory to check for existing IDEs
|
* @param {string} projectDir - Project directory to check for existing IDEs
|
||||||
* @param {Object} options - Command-line options
|
* @param {Object} options - Command-line options
|
||||||
|
|
|
||||||
|
|
@ -18,12 +18,6 @@ platforms:
|
||||||
category: cli
|
category: cli
|
||||||
description: "Anthropic's official CLI for Claude"
|
description: "Anthropic's official CLI for Claude"
|
||||||
|
|
||||||
windsurf:
|
|
||||||
name: "Windsurf"
|
|
||||||
preferred: true
|
|
||||||
category: ide
|
|
||||||
description: "AI-powered IDE with cascade flows"
|
|
||||||
|
|
||||||
cursor:
|
cursor:
|
||||||
name: "Cursor"
|
name: "Cursor"
|
||||||
preferred: true
|
preferred: true
|
||||||
|
|
@ -127,6 +121,12 @@ platforms:
|
||||||
category: ide
|
category: ide
|
||||||
description: "AI coding tool"
|
description: "AI coding tool"
|
||||||
|
|
||||||
|
windsurf:
|
||||||
|
name: "Windsurf"
|
||||||
|
preferred: false
|
||||||
|
category: ide
|
||||||
|
description: "AI-powered IDE with cascade flows"
|
||||||
|
|
||||||
# Platform categories
|
# Platform categories
|
||||||
categories:
|
categories:
|
||||||
ide:
|
ide:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue