From 47b9d9f3e87be62c8520ed6cb0048df727a9534f Mon Sep 17 00:00:00 2001 From: manjaroblack <42281273+manjaroblack@users.noreply.github.com> Date: Sat, 5 Jul 2025 21:08:26 -0500 Subject: [PATCH] fix: spelling errors in documentation. (#297) * fix: correct typos in documentation and agent files Fix multiple instances of "assest" typo to "assets" in documentation Correct "quetsions" typo to "questions" in repository structure sections Add new words to cSpell dictionary in VS Code settings * feat(trae): add support for trae ide integration - Add trae guide documentation - Update installer to support trae configuration - Include trae in ide options and documentation references - Fix typo in architect agent documentation --------- Co-authored-by: Devin Stagner --- .vscode/settings.json | 37 +++++++++++++++- README.md | 2 + bmad-core/data/bmad-kb.md | 8 ++-- dist/agents/analyst.txt | 8 ++-- dist/agents/bmad-master.txt | 8 ++-- dist/agents/bmad-orchestrator.txt | 8 ++-- dist/teams/team-all.txt | 8 ++-- dist/teams/team-fullstack.txt | 8 ++-- dist/teams/team-ide-minimal.txt | 8 ++-- dist/teams/team-no-ui.txt | 8 ++-- docs/agentic-tools/trae-guide.md | 14 ++++++ docs/bmad-workflow-guide.md | 5 ++- docs/user-guide.md | 4 +- tools/installer/bin/bmad.js | 3 +- tools/installer/config/install.config.yaml | 9 ++++ tools/installer/lib/ide-setup.js | 51 ++++++++++++++++++++++ tools/upgraders/v3-to-v4-upgrader.js | 1 + 17 files changed, 160 insertions(+), 30 deletions(-) create mode 100644 docs/agentic-tools/trae-guide.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 0958195..e3eb4b9 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -7,7 +7,42 @@ "chat.tools.autoApprove": false, "cSpell.words": [ "Agentic", + "atlasing", + "Biostatistician", + "Cordova", + "customresourcedefinitions", + "dashboarded", + "Decisioning", + "eksctl", "elicitations", - "Shardable" + "filecomplete", + "fintech", + "fluxcd", + "gamedev", + "gitops", + "implementability", + "inclusivity", + "ingressgateway", + "istioctl", + "metroidvania", + "NACLs", + "nodegroup", + "platformconfigs", + "Playfocus", + "playtesting", + "pointerdown", + "pointerup", + "replayability", + "roguelike", + "roomodes", + "Runbook", + "runbooks", + "Shardable", + "Softlock", + "speedrunner", + "tekton", + "tilemap", + "tileset", + "VNET" ] } \ No newline at end of file diff --git a/README.md b/README.md index 6f16f61..452f135 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,7 @@ The BMad Method works with any IDE, but has built-in integration for: - `cline` - Cline Rules integration - `gemini-cli` - Gemini with @agent commands - `windsurf` - Windsurf with manual rule @agent commands +- `trae` - Trae with manual rule @agent commands - `roo` - Roo Code with custom modes (see `.roomodes`) - `github-copilot` - GitHub Copilot agent mode integration @@ -287,6 +288,7 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour - 🎯 [Cursor Guide](docs/agentic-tools/cursor-guide.md) - Setup and usage for Cursor - 🤖 [Claude Code Guide](docs/agentic-tools/claude-code-guide.md) - Setup and usage for Claude Code - 🌊 [Windsurf Guide](docs/agentic-tools/windsurf-guide.md) - Setup and usage for Windsurf +- 🌊 [Trae Guide](docs/agentic-tools/trae-guide.md) - Setup and usage for Trae - 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code - 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code) - ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI diff --git a/bmad-core/data/bmad-kb.md b/bmad-core/data/bmad-kb.md index fd024c5..f70be65 100644 --- a/bmad-core/data/bmad-kb.md +++ b/bmad-core/data/bmad-kb.md @@ -78,7 +78,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -91,6 +91,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -278,11 +279,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -362,7 +364,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/agents/analyst.txt b/dist/agents/analyst.txt index 912c996..80404f6 100644 --- a/dist/agents/analyst.txt +++ b/dist/agents/analyst.txt @@ -2034,7 +2034,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -2047,6 +2047,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -2234,11 +2235,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -2318,7 +2320,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/agents/bmad-master.txt b/dist/agents/bmad-master.txt index 1e5cef6..0f2120c 100644 --- a/dist/agents/bmad-master.txt +++ b/dist/agents/bmad-master.txt @@ -8843,7 +8843,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -8856,6 +8856,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -9043,11 +9044,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -9127,7 +9129,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/agents/bmad-orchestrator.txt b/dist/agents/bmad-orchestrator.txt index 247a1ed..4734384 100644 --- a/dist/agents/bmad-orchestrator.txt +++ b/dist/agents/bmad-orchestrator.txt @@ -1063,7 +1063,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -1076,6 +1076,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -1263,11 +1264,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -1347,7 +1349,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/teams/team-all.txt b/dist/teams/team-all.txt index a08818e..03f110c 100644 --- a/dist/teams/team-all.txt +++ b/dist/teams/team-all.txt @@ -1552,7 +1552,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -1565,6 +1565,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -1752,11 +1753,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -1836,7 +1838,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/teams/team-fullstack.txt b/dist/teams/team-fullstack.txt index 5faf08a..4a68a62 100644 --- a/dist/teams/team-fullstack.txt +++ b/dist/teams/team-fullstack.txt @@ -1400,7 +1400,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -1413,6 +1413,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -1600,11 +1601,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -1684,7 +1686,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/teams/team-ide-minimal.txt b/dist/teams/team-ide-minimal.txt index ff9801e..ae278f3 100644 --- a/dist/teams/team-ide-minimal.txt +++ b/dist/teams/team-ide-minimal.txt @@ -1298,7 +1298,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -1311,6 +1311,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -1498,11 +1499,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -1582,7 +1584,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/dist/teams/team-no-ui.txt b/dist/teams/team-no-ui.txt index adf47e9..a52811c 100644 --- a/dist/teams/team-no-ui.txt +++ b/dist/teams/team-no-ui.txt @@ -1338,7 +1338,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users ```bash # Interactive installation (recommended) @@ -1351,6 +1351,7 @@ npx bmad-method install - **Cursor**: Native AI integration - **Claude Code**: Anthropic's official IDE - **Windsurf**: Built-in AI capabilities + - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - **Github Copilot**: AI-powered coding assistant @@ -1538,11 +1539,12 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation **Common Task Commands**: @@ -1622,7 +1624,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor #### Web UI Environment -- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent +- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent - Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team - Created by the web-builder tool for upload to web interfaces - Provides complete context in one package diff --git a/docs/agentic-tools/trae-guide.md b/docs/agentic-tools/trae-guide.md new file mode 100644 index 0000000..700806e --- /dev/null +++ b/docs/agentic-tools/trae-guide.md @@ -0,0 +1,14 @@ +# BMad Method Guide for Trae + +For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md). + +## Installation + +When running `npx bmad-method install`, select **Trae** as your IDE. This creates: + +- `.bmad-core/` folder with all agents +- `.trae/rules/` folder with agent rule files (`.md`) + +## Using BMad Agents in Trae + +Type `@agent-name` in chat to activate an agent. diff --git a/docs/bmad-workflow-guide.md b/docs/bmad-workflow-guide.md index 903e3a7..61bf42b 100644 --- a/docs/bmad-workflow-guide.md +++ b/docs/bmad-workflow-guide.md @@ -22,7 +22,7 @@ The BMad Method follows a structured approach to AI-assisted software developmen ``` - Choose "Complete installation" - - Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or Github Copilot) + - Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or Github Copilot) 2. **Verify installation**: - `.bmad-core/` folder created with all agents @@ -112,12 +112,13 @@ Follow the SM → Dev cycle for systematic story development: - **Claude Code**: `/agent-name` (e.g., `/bmad-master`) - **Cursor**: `@agent-name` (e.g., `@bmad-master`) - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) +- **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. ### Chat Management: -- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents +- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents - **Roo Code**: Switch modes within the same conversation ## Available Agents diff --git a/docs/user-guide.md b/docs/user-guide.md index a6e3690..4c414ee 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -120,7 +120,7 @@ dependencies: **In IDE:** ```bash -# Cursor or Windsurf (manual rules - loaded with @) +# Cursor, Windsurf, or Trae (manual rules - loaded with @) @pm Create a PRD for a task management app @architect Design the system architecture @dev Implement the user authentication @@ -275,7 +275,7 @@ graph TD **Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow: 1. **Copy Documents to Project**: Ensure `docs/prd.md` and `docs/architecture.md` are in your project -2. **Switch to IDE**: Open your project in your preferred IDE (Cursor, Claude Code, Windsurf) +2. **Switch to IDE**: Open your project in your preferred IDE (Cursor, Claude Code, Windsurf, Trae) 3. **Document Sharding**: Use PO agent to shard large documents into manageable pieces 4. **Begin Development**: Start the SM/Dev cycle for implementation diff --git a/tools/installer/bin/bmad.js b/tools/installer/bin/bmad.js index bffec0e..3fcd856 100755 --- a/tools/installer/bin/bmad.js +++ b/tools/installer/bin/bmad.js @@ -50,7 +50,7 @@ program .option('-f, --full', 'Install complete BMad Method') .option('-x, --expansion-only', 'Install only expansion packs (no bmad-core)') .option('-d, --directory ', 'Installation directory') - .option('-i, --ide ', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, roo, cline, gemini, github-copilot, other)') + .option('-i, --ide ', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, trae, roo, cline, gemini, github-copilot, other)') .option('-e, --expansion-packs ', 'Install specific expansion packs (can specify multiple)') .action(async (options) => { try { @@ -234,6 +234,7 @@ async function promptInstallation() { { name: 'Cursor', value: 'cursor' }, { name: 'Claude Code', value: 'claude-code' }, { name: 'Windsurf', value: 'windsurf' }, + { name: 'Trae', value: 'trae' }, // { name: 'Trae', value: 'trae'} { name: 'Roo Code', value: 'roo' }, { name: 'Cline', value: 'cline' }, { name: 'Gemini CLI', value: 'gemini' }, diff --git a/tools/installer/config/install.config.yaml b/tools/installer/config/install.config.yaml index d2cee6a..f4302bc 100644 --- a/tools/installer/config/install.config.yaml +++ b/tools/installer/config/install.config.yaml @@ -37,6 +37,15 @@ ide-configurations: # To use BMad agents in Windsurf: # 1. Type @agent-name (e.g., "@dev", "@pm") # 2. Windsurf will adopt that agent's persona + trae: + name: Trae + rule-dir: .trae/rules/ + format: multi-file + command-suffix: .md + instructions: | + # To use BMad agents in Trae: + # 1. Type @agent-name (e.g., "@dev", "@pm", "@architect") + # 2. Trae will adopt that agent's persona roo: name: Roo Code format: custom-modes diff --git a/tools/installer/lib/ide-setup.js b/tools/installer/lib/ide-setup.js index 66795b8..c41efaa 100644 --- a/tools/installer/lib/ide-setup.js +++ b/tools/installer/lib/ide-setup.js @@ -57,6 +57,8 @@ class IdeSetup { return this.setupClaudeCode(installDir, selectedAgent); case "windsurf": return this.setupWindsurf(installDir, selectedAgent); + case "trae": + return this.setupTrae(installDir, selectedAgent); case "roo": return this.setupRoo(installDir, selectedAgent); case "cline": @@ -210,6 +212,55 @@ class IdeSetup { return true; } + async setupTrae(installDir, selectedAgent) { + const traeRulesDir = path.join(installDir, ".trae", "rules"); + const agents = selectedAgent? [selectedAgent] : await this.getAllAgentIds(installDir); + + await fileManager.ensureDirectory(traeRulesDir); + + for (const agentId of agents) { + // Find the agent file + const agentPath = await this.findAgentPath(agentId, installDir); + + if (agentPath) { + const agentContent = await fileManager.readFile(agentPath); + const mdPath = path.join(traeRulesDir, `${agentId}.md`); + + // Create MD content (similar to Cursor but without frontmatter) + let mdContent = `# ${agentId.toUpperCase()} Agent Rule\n\n`; + mdContent += `This rule is triggered when the user types \`@${agentId}\` and activates the ${await this.getAgentTitle( + agentId, + installDir + )} agent persona.\n\n`; + mdContent += "## Agent Activation\n\n"; + mdContent += + "CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:\n\n"; + mdContent += "```yaml\n"; + // Extract just the YAML content from the agent file + const yamlContent = extractYamlFromAgent(agentContent); + if (yamlContent) { + mdContent += yamlContent; + } + else { + // If no YAML found, include the whole content minus the header + mdContent += agentContent.replace(/^#.*$/m, "").trim(); + } + mdContent += "\n```\n\n"; + mdContent += "## File Reference\n\n"; + const relativePath = path.relative(installDir, agentPath).replace(/\\/g, '/'); + mdContent += `The complete agent definition is available in [${relativePath}](${relativePath}).\n\n`; + mdContent += "## Usage\n\n"; + mdContent += `When the user types \`@${agentId}\`, activate this ${await this.getAgentTitle( + agentId, + installDir + )} persona and follow all instructions defined in the YAML configuration above.\n`; + + await fileManager.writeFile(mdPath, mdContent); + console.log(chalk.green(`✓ Created rule: ${agentId}.md`)); + } + } + } + async findAgentPath(agentId, installDir) { // Try to find the agent file in various locations const possiblePaths = [ diff --git a/tools/upgraders/v3-to-v4-upgrader.js b/tools/upgraders/v3-to-v4-upgrader.js index 5a31b2a..3182ba9 100644 --- a/tools/upgraders/v3-to-v4-upgrader.js +++ b/tools/upgraders/v3-to-v4-upgrader.js @@ -560,6 +560,7 @@ class V3ToV4Upgrader { cursor: "Rules created in .cursor/rules/", "claude-code": "Commands created in .claude/commands/", windsurf: "Rules created in .windsurf/rules/", + trae: "Rules created in.trae/rules/", roo: "Custom modes created in .roomodes", cline: "Rules created in .clinerules/", };