bmad-odoo 1.0.4 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +305 -305
- package/package.json +1 -1
- package/scripts/postinstall.js +24 -8
package/README.md
CHANGED
|
@@ -1,95 +1,95 @@
|
|
|
1
|
-
# BMAD-Odoo -
|
|
1
|
+
# BMAD-Odoo - User Guide
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/bmad-odoo)
|
|
4
4
|
[](https://www.npmjs.com/package/bmad-odoo)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
|
|
7
|
-
> **BMAD Framework
|
|
7
|
+
> **BMAD Framework extension for Odoo ERP development**
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
## 📋
|
|
11
|
+
## 📋 Table of Contents
|
|
12
12
|
|
|
13
|
-
1. [
|
|
14
|
-
2. [
|
|
15
|
-
3. [
|
|
16
|
-
4. [
|
|
13
|
+
1. [Introduction](#introduction)
|
|
14
|
+
2. [Installation](#installation)
|
|
15
|
+
3. [Detailed Guide](#-detailed-guide)
|
|
16
|
+
4. [Common Commands](#-common-commands)
|
|
17
17
|
5. [Use Cases](#-use-cases)
|
|
18
|
-
6. [
|
|
19
|
-
7. [
|
|
18
|
+
6. [Configuration](#configuration)
|
|
19
|
+
7. [Agents](#agents)
|
|
20
20
|
8. [Workflows](#workflows)
|
|
21
|
-
9. [
|
|
22
|
-
10. [
|
|
21
|
+
9. [Work Process](#work-process)
|
|
22
|
+
10. [Directory Structure](#directory-structure)
|
|
23
23
|
11. [Troubleshooting](#-troubleshooting)
|
|
24
24
|
12. [FAQ](#-faq)
|
|
25
|
-
13. [
|
|
25
|
+
13. [References](#references)
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Introduction
|
|
30
30
|
|
|
31
|
-
**BMAD-Odoo**
|
|
31
|
+
**BMAD-Odoo** is an extended framework from BMAD (Brian's Method for AI Development), specifically customized for Odoo ERP development and deployment.
|
|
32
32
|
|
|
33
|
-
###
|
|
33
|
+
### Key Features
|
|
34
34
|
|
|
35
|
-
- 🤖 **10 AI Agents**
|
|
36
|
-
- 📝 **44 Workflows**
|
|
37
|
-
- 🇻🇳 **
|
|
38
|
-
- 📚 **Knowledge Base**
|
|
39
|
-
- ⚙️ **Auto-setup**
|
|
35
|
+
- 🤖 **10 AI Agents** specialized for each role in Odoo projects
|
|
36
|
+
- 📝 **44 Workflows** covering the entire development lifecycle
|
|
37
|
+
- 🇻🇳 **Full Vietnamese support**
|
|
38
|
+
- 📚 **Knowledge Base** with integrated Odoo knowledge
|
|
39
|
+
- ⚙️ **Auto-setup** automatically configures workflows on installation
|
|
40
40
|
|
|
41
41
|
---
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## Installation
|
|
44
44
|
|
|
45
|
-
###
|
|
45
|
+
### Requirements
|
|
46
46
|
|
|
47
47
|
- Node.js 18+
|
|
48
|
-
- Odoo 16.0+
|
|
49
|
-
- AI IDE
|
|
48
|
+
- Odoo 16.0+ or 17.0
|
|
49
|
+
- Supported AI IDE (Antigravity/Gemini, Cursor, VS Code, Windsurf)
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### Method 1: Install from NPM (Recommended)
|
|
52
52
|
|
|
53
53
|
```bash
|
|
54
|
-
#
|
|
54
|
+
# In your Odoo project directory
|
|
55
55
|
npm install bmad-odoo
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
**Post-install
|
|
58
|
+
**Post-install will automatically prompt you to choose IDE:**
|
|
59
59
|
```
|
|
60
|
-
|
|
61
|
-
1. VS Code - Visual Studio Code
|
|
60
|
+
Choose your IDE:
|
|
61
|
+
1. VS Code - Visual Studio Code with AI extensions
|
|
62
62
|
2. Cursor - Cursor AI IDE
|
|
63
63
|
3. Antigravity - Google Gemini Antigravity Agent
|
|
64
64
|
4. Windsurf - Windsurf AI IDE
|
|
65
|
-
5.
|
|
65
|
+
5. All - Setup for all IDEs
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Enter number (1-5) [default: 3]:
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
**Package
|
|
71
|
-
- ✅
|
|
72
|
-
- ✅
|
|
73
|
-
- ✅ Workflows
|
|
74
|
-
- ✅
|
|
70
|
+
**Package will automatically create:**
|
|
71
|
+
- ✅ `_bmad-odoo/` directory (symlink or copy from `node_modules/`)
|
|
72
|
+
- ✅ `_bmad-odoo-output/` directory with subdirectory structure for artifacts
|
|
73
|
+
- ✅ Workflows in `.agent/workflows/` (or your chosen IDE)
|
|
74
|
+
- ✅ Slash commands: `/analyst`, `/dev`, `/pm`, ...
|
|
75
75
|
|
|
76
|
-
###
|
|
76
|
+
### Re-run Setup (if needed)
|
|
77
77
|
|
|
78
78
|
```bash
|
|
79
|
-
#
|
|
79
|
+
# If you want to change IDE or re-setup
|
|
80
80
|
npx bmad-odoo-setup
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
###
|
|
83
|
+
### Method 2: Manual Installation
|
|
84
84
|
|
|
85
85
|
```bash
|
|
86
86
|
# Clone repository
|
|
87
87
|
git clone https://github.com/phamdungtk/bmad-odoo.git
|
|
88
88
|
|
|
89
|
-
# Copy
|
|
89
|
+
# Copy to node_modules
|
|
90
90
|
cp -r bmad-odoo node_modules/
|
|
91
91
|
|
|
92
|
-
#
|
|
92
|
+
# Run setup
|
|
93
93
|
cd bmad-odoo
|
|
94
94
|
npm run setup
|
|
95
95
|
```
|
|
@@ -97,118 +97,118 @@ npm run setup
|
|
|
97
97
|
---
|
|
98
98
|
|
|
99
99
|
|
|
100
|
-
##
|
|
100
|
+
## Configuration
|
|
101
101
|
|
|
102
|
-
###
|
|
102
|
+
### Main Configuration File
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
Edit the `bmm/config.yaml` file:
|
|
105
105
|
|
|
106
106
|
```yaml
|
|
107
|
-
#
|
|
108
|
-
user_name: "
|
|
109
|
-
communication_language: "
|
|
107
|
+
# User information
|
|
108
|
+
user_name: "Your Name"
|
|
109
|
+
communication_language: "Vietnamese"
|
|
110
110
|
|
|
111
|
-
#
|
|
111
|
+
# Output directory
|
|
112
112
|
output_folder: "_bmad-odoo-output"
|
|
113
113
|
planning_artifacts: "_bmad-odoo-output/planning"
|
|
114
114
|
implementation_artifacts: "_bmad-odoo-output/implementation"
|
|
115
115
|
|
|
116
|
-
#
|
|
116
|
+
# Odoo configuration
|
|
117
117
|
odoo:
|
|
118
118
|
version: "17.0"
|
|
119
|
-
edition: "community" # community
|
|
119
|
+
edition: "community" # community or enterprise
|
|
120
120
|
customModulesPath: "addons_custom"
|
|
121
121
|
oca_path: "addons_oca"
|
|
122
122
|
```
|
|
123
123
|
|
|
124
124
|
---
|
|
125
125
|
|
|
126
|
-
## 🚀
|
|
126
|
+
## 🚀 Detailed Guide
|
|
127
127
|
|
|
128
|
-
###
|
|
128
|
+
### Step 1: Install Package
|
|
129
129
|
|
|
130
130
|
```bash
|
|
131
|
-
#
|
|
131
|
+
# Navigate to your Odoo project directory
|
|
132
132
|
cd D:\MyOdooProject
|
|
133
133
|
|
|
134
|
-
#
|
|
134
|
+
# Initialize package.json if not already present
|
|
135
135
|
npm init -y
|
|
136
136
|
|
|
137
|
-
#
|
|
137
|
+
# Install bmad-odoo
|
|
138
138
|
npm install bmad-odoo
|
|
139
139
|
```
|
|
140
140
|
|
|
141
|
-
**
|
|
141
|
+
**Result:**
|
|
142
142
|
```
|
|
143
143
|
+ bmad-odoo@1.0.0
|
|
144
144
|
added 1 package
|
|
145
145
|
```
|
|
146
146
|
|
|
147
|
-
###
|
|
147
|
+
### Step 2: Interactive Setup (Automatic)
|
|
148
148
|
|
|
149
|
-
|
|
149
|
+
Right after installation, **post-install script will run automatically**:
|
|
150
150
|
|
|
151
151
|
```
|
|
152
152
|
╔════════════════════════════════════════════════════════════╗
|
|
153
153
|
║ 🚀 BMAD-Odoo Interactive Setup ║
|
|
154
154
|
╚════════════════════════════════════════════════════════════╝
|
|
155
155
|
|
|
156
|
-
|
|
156
|
+
Choose your IDE:
|
|
157
157
|
|
|
158
|
-
1. VS Code - Visual Studio Code
|
|
158
|
+
1. VS Code - Visual Studio Code with AI extensions
|
|
159
159
|
2. Cursor - Cursor AI IDE
|
|
160
160
|
3. Antigravity - Google Gemini Antigravity Agent
|
|
161
161
|
4. Windsurf - Windsurf AI IDE
|
|
162
|
-
5.
|
|
162
|
+
5. All - Setup for all IDEs
|
|
163
163
|
|
|
164
|
-
|
|
164
|
+
Enter number (1-5) [default: 3]:
|
|
165
165
|
```
|
|
166
166
|
|
|
167
|
-
**
|
|
167
|
+
**Enter number and press Enter:**
|
|
168
168
|
```bash
|
|
169
|
-
3 #
|
|
169
|
+
3 # Choose Antigravity (or your IDE)
|
|
170
170
|
```
|
|
171
171
|
|
|
172
|
-
###
|
|
172
|
+
### Step 3: Setup Process (Automatic)
|
|
173
173
|
|
|
174
|
-
Script
|
|
174
|
+
Script will automatically execute:
|
|
175
175
|
|
|
176
176
|
```
|
|
177
|
-
📌
|
|
177
|
+
📌 Selected: Antigravity (Gemini)
|
|
178
178
|
|
|
179
|
-
[1/3]
|
|
180
|
-
✅
|
|
179
|
+
[1/3] Creating _bmad-odoo directory...
|
|
180
|
+
✅ Created symlink: _bmad-odoo -> node_modules/bmad-odoo
|
|
181
181
|
|
|
182
|
-
[2/3]
|
|
183
|
-
✅
|
|
182
|
+
[2/3] Creating _bmad-odoo-output directory...
|
|
183
|
+
✅ Created: _bmad-odoo-output/
|
|
184
184
|
|
|
185
|
-
[3/3]
|
|
186
|
-
✅
|
|
185
|
+
[3/3] Creating workflow files...
|
|
186
|
+
✅ Created 10 workflows for Antigravity (Gemini)
|
|
187
187
|
|
|
188
188
|
╔════════════════════════════════════════════════════════════╗
|
|
189
|
-
║ ✅ BMAD-Odoo Setup
|
|
189
|
+
║ ✅ BMAD-Odoo Setup Complete! ║
|
|
190
190
|
╚════════════════════════════════════════════════════════════╝
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
###
|
|
193
|
+
### Step 4: Verify Created Structure
|
|
194
194
|
|
|
195
195
|
```bash
|
|
196
|
-
#
|
|
196
|
+
# Check project directory
|
|
197
197
|
ls -la
|
|
198
198
|
```
|
|
199
199
|
|
|
200
|
-
**
|
|
200
|
+
**Structure after setup:**
|
|
201
201
|
```
|
|
202
202
|
MyOdooProject/
|
|
203
203
|
├── node_modules/
|
|
204
|
-
│ └── bmad-odoo/ #
|
|
205
|
-
├── _bmad-odoo/ # ✨ Symlink/copy
|
|
206
|
-
├── _bmad-odoo-output/ # ✨
|
|
204
|
+
│ └── bmad-odoo/ # Original package from npm
|
|
205
|
+
├── _bmad-odoo/ # ✨ Symlink/copy for easy access
|
|
206
|
+
├── _bmad-odoo-output/ # ✨ Output directory for artifacts
|
|
207
207
|
│ ├── planning-artifacts/
|
|
208
208
|
│ ├── implementation-artifacts/
|
|
209
209
|
│ ├── test-artifacts/
|
|
210
210
|
│ └── documentation/
|
|
211
|
-
├── .agent/ # ✨ Workflows
|
|
211
|
+
├── .agent/ # ✨ Workflows for Antigravity
|
|
212
212
|
│ └── workflows/
|
|
213
213
|
│ ├── analyst.md
|
|
214
214
|
│ ├── architect.md
|
|
@@ -223,74 +223,74 @@ MyOdooProject/
|
|
|
223
223
|
└── package.json
|
|
224
224
|
```
|
|
225
225
|
|
|
226
|
-
###
|
|
226
|
+
### Step 5: Using Agents
|
|
227
227
|
|
|
228
|
-
|
|
228
|
+
Open your AI IDE (Antigravity/Gemini, Cursor, etc.) and type:
|
|
229
229
|
|
|
230
230
|
```bash
|
|
231
|
-
/analyst #
|
|
232
|
-
/architect #
|
|
233
|
-
/dev #
|
|
234
|
-
/pm #
|
|
235
|
-
/sm #
|
|
236
|
-
/tea #
|
|
237
|
-
/ux-designer #
|
|
238
|
-
/quick-flow-solo-dev #
|
|
239
|
-
/tech-writer #
|
|
231
|
+
/analyst # Activate Business Analyst (Sofia)
|
|
232
|
+
/architect # Activate Technical Architect (Antonio)
|
|
233
|
+
/dev # Activate Developer (Carlos)
|
|
234
|
+
/pm # Activate Product Manager (Maria)
|
|
235
|
+
/sm # Activate Scrum Master (Diego)
|
|
236
|
+
/tea # Activate Test Architect (Elena)
|
|
237
|
+
/ux-designer # Activate UX Designer (Sally)
|
|
238
|
+
/quick-flow-solo-dev # Activate Quick Flow Dev (Barry)
|
|
239
|
+
/tech-writer # Activate Tech Writer (Paige)
|
|
240
240
|
```
|
|
241
241
|
|
|
242
242
|
---
|
|
243
243
|
|
|
244
|
-
## 🔧
|
|
244
|
+
## 🔧 Common Commands
|
|
245
245
|
|
|
246
|
-
###
|
|
246
|
+
### Re-run Setup (Change IDE or Add IDE)
|
|
247
247
|
|
|
248
|
-
|
|
249
|
-
-
|
|
250
|
-
-
|
|
251
|
-
-
|
|
248
|
+
If you want to:
|
|
249
|
+
- Switch to another IDE
|
|
250
|
+
- Add workflows for new IDE
|
|
251
|
+
- Re-setup from scratch
|
|
252
252
|
|
|
253
253
|
```bash
|
|
254
|
-
#
|
|
254
|
+
# Run interactive setup
|
|
255
255
|
npx bmad-odoo-setup
|
|
256
256
|
|
|
257
|
-
#
|
|
257
|
+
# Or
|
|
258
258
|
npm run setup
|
|
259
259
|
```
|
|
260
260
|
|
|
261
|
-
**Script
|
|
261
|
+
**Script will ask for IDE again and create workflows for it.**
|
|
262
262
|
|
|
263
|
-
###
|
|
263
|
+
### View Package Information
|
|
264
264
|
|
|
265
265
|
```bash
|
|
266
|
-
#
|
|
266
|
+
# View installed version
|
|
267
267
|
npm list bmad-odoo
|
|
268
268
|
|
|
269
|
-
#
|
|
269
|
+
# View information from npm
|
|
270
270
|
npm view bmad-odoo
|
|
271
271
|
|
|
272
|
-
#
|
|
272
|
+
# View all available versions
|
|
273
273
|
npm view bmad-odoo versions
|
|
274
274
|
```
|
|
275
275
|
|
|
276
276
|
### Update Package
|
|
277
277
|
|
|
278
278
|
```bash
|
|
279
|
-
# Update
|
|
279
|
+
# Update to latest version
|
|
280
280
|
npm update bmad-odoo
|
|
281
281
|
|
|
282
|
-
#
|
|
282
|
+
# Or reinstall with specific version
|
|
283
283
|
npm install bmad-odoo@latest
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
-
###
|
|
286
|
+
### Remove and Reinstall
|
|
287
287
|
|
|
288
288
|
```bash
|
|
289
|
-
#
|
|
289
|
+
# Remove package and created directories
|
|
290
290
|
npm uninstall bmad-odoo
|
|
291
291
|
rm -rf _bmad-odoo _bmad-odoo-output .agent/workflows
|
|
292
292
|
|
|
293
|
-
#
|
|
293
|
+
# Reinstall
|
|
294
294
|
npm install bmad-odoo
|
|
295
295
|
```
|
|
296
296
|
|
|
@@ -298,226 +298,226 @@ npm install bmad-odoo
|
|
|
298
298
|
|
|
299
299
|
## 💡 Use Cases
|
|
300
300
|
|
|
301
|
-
### Case 1:
|
|
301
|
+
### Case 1: Developing New Odoo Module
|
|
302
302
|
|
|
303
303
|
```bash
|
|
304
|
-
# 1.
|
|
304
|
+
# 1. Install bmad-odoo
|
|
305
305
|
npm install bmad-odoo
|
|
306
306
|
|
|
307
|
-
# 2.
|
|
307
|
+
# 2. Activate Business Analyst to analyze requirements
|
|
308
308
|
/analyst
|
|
309
|
-
> AP #
|
|
309
|
+
> AP # Choose [AP] Analyze Process
|
|
310
310
|
|
|
311
|
-
# 3.
|
|
311
|
+
# 3. Activate Architect for design
|
|
312
312
|
/architect
|
|
313
|
-
> CO #
|
|
313
|
+
> CO # Choose [CO] Create Odoo Addon
|
|
314
314
|
|
|
315
|
-
# 4.
|
|
315
|
+
# 4. Activate Developer to code
|
|
316
316
|
/dev
|
|
317
|
-
> DS #
|
|
317
|
+
> DS # Choose [DS] Dev Story
|
|
318
318
|
```
|
|
319
319
|
|
|
320
|
-
### Case 2: Setup
|
|
320
|
+
### Case 2: Team Setup (Multi-IDE)
|
|
321
321
|
|
|
322
322
|
```bash
|
|
323
|
-
#
|
|
323
|
+
# Install package
|
|
324
324
|
npm install bmad-odoo
|
|
325
325
|
|
|
326
|
-
#
|
|
327
|
-
# Script
|
|
326
|
+
# During setup, choose option 5 (All)
|
|
327
|
+
# Script will create workflows for:
|
|
328
328
|
# - VS Code (.vscode/workflows/)
|
|
329
329
|
# - Cursor (.cursor/workflows/)
|
|
330
330
|
# - Antigravity (.agent/workflows/)
|
|
331
331
|
# - Windsurf (.windsurf/workflows/)
|
|
332
332
|
|
|
333
|
-
# Team members
|
|
333
|
+
# Team members using different IDEs can all work
|
|
334
334
|
```
|
|
335
335
|
|
|
336
336
|
### Case 3: CI/CD Integration
|
|
337
337
|
|
|
338
|
-
|
|
338
|
+
If installing in CI/CD (non-interactive):
|
|
339
339
|
|
|
340
340
|
```bash
|
|
341
|
-
# Script
|
|
341
|
+
# Script will automatically choose Antigravity (default)
|
|
342
342
|
npm install bmad-odoo
|
|
343
343
|
|
|
344
|
-
#
|
|
344
|
+
# Or set environment variable (if supported later)
|
|
345
345
|
BMAD_IDE=cursor npm install bmad-odoo
|
|
346
346
|
```
|
|
347
347
|
|
|
348
348
|
---
|
|
349
349
|
|
|
350
|
-
##
|
|
350
|
+
## Configuration
|
|
351
351
|
|
|
352
|
-
###
|
|
352
|
+
### Main Configuration File
|
|
353
353
|
|
|
354
|
-
|
|
354
|
+
Edit the `_bmad-odoo/bmm/config.yaml` file:
|
|
355
355
|
|
|
356
356
|
```yaml
|
|
357
|
-
#
|
|
358
|
-
user_name: "
|
|
359
|
-
communication_language: "
|
|
357
|
+
# User information
|
|
358
|
+
user_name: "Your Name"
|
|
359
|
+
communication_language: "Vietnamese"
|
|
360
360
|
|
|
361
|
-
#
|
|
361
|
+
# Output directory
|
|
362
362
|
output_folder: "_bmad-odoo-output"
|
|
363
363
|
planning_artifacts: "_bmad-odoo-output/planning-artifacts"
|
|
364
364
|
implementation_artifacts: "_bmad-odoo-output/implementation-artifacts"
|
|
365
365
|
|
|
366
|
-
#
|
|
366
|
+
# Odoo configuration
|
|
367
367
|
odoo:
|
|
368
368
|
version: "17.0"
|
|
369
|
-
edition: "community" # community
|
|
369
|
+
edition: "community" # community or enterprise
|
|
370
370
|
customModulesPath: "addons_custom"
|
|
371
371
|
oca_path: "addons_oca"
|
|
372
372
|
```
|
|
373
373
|
|
|
374
374
|
---
|
|
375
375
|
|
|
376
|
-
##
|
|
376
|
+
## Agents
|
|
377
377
|
|
|
378
|
-
###
|
|
378
|
+
### Agent List
|
|
379
379
|
|
|
380
|
-
| Agent |
|
|
381
|
-
|
|
382
|
-
| 💼 Sofia | Business Analyst |
|
|
383
|
-
| 🏗️ Antonio | Technical Architect |
|
|
384
|
-
| 💻 Carlos | Developer |
|
|
385
|
-
| 📊 Maria | Product Manager |
|
|
386
|
-
| 🏃 Diego | Scrum Master |
|
|
387
|
-
| 🧪 Elena | Test Architect |
|
|
388
|
-
| 🎨 Sally | UX Designer |
|
|
389
|
-
| ⚡ Barry | Quick Flow Dev |
|
|
390
|
-
| 📝 Paige | Tech Writer |
|
|
391
|
-
| 🎯 Master | BMAD-Odoo Master |
|
|
380
|
+
| Agent | Name | Role | Slash Command |
|
|
381
|
+
|-------|------|------|---------------|
|
|
382
|
+
| 💼 Sofia | Business Analyst | Process analysis, gap analysis | `/analyst` |
|
|
383
|
+
| 🏗️ Antonio | Technical Architect | Module architecture design | `/architect` |
|
|
384
|
+
| 💻 Carlos | Developer | Odoo code development | `/dev` |
|
|
385
|
+
| 📊 Maria | Product Manager | Product management, PRD creation | `/pm` |
|
|
386
|
+
| 🏃 Diego | Scrum Master | Sprint, story management | `/sm` |
|
|
387
|
+
| 🧪 Elena | Test Architect | Test case design | `/tea` |
|
|
388
|
+
| 🎨 Sally | UX Designer | UX design for Odoo views | `/ux-designer` |
|
|
389
|
+
| ⚡ Barry | Quick Flow Dev | Rapid development | `/quick-flow-solo-dev` |
|
|
390
|
+
| 📝 Paige | Tech Writer | Module documentation | `/tech-writer` |
|
|
391
|
+
| 🎯 Master | BMAD-Odoo Master | Overall coordination | (auto) |
|
|
392
392
|
|
|
393
|
-
###
|
|
393
|
+
### How to Activate Agent
|
|
394
394
|
|
|
395
395
|
```
|
|
396
|
-
/analyst #
|
|
397
|
-
/dev #
|
|
398
|
-
/pm #
|
|
396
|
+
/analyst # Activate Sofia - Business Analyst
|
|
397
|
+
/dev # Activate Carlos - Developer
|
|
398
|
+
/pm # Activate Maria - Product Manager
|
|
399
399
|
```
|
|
400
400
|
|
|
401
401
|
---
|
|
402
402
|
|
|
403
403
|
## Workflows
|
|
404
404
|
|
|
405
|
-
###
|
|
406
|
-
|
|
407
|
-
#### 1. Analysis
|
|
408
|
-
| Workflow |
|
|
409
|
-
|
|
410
|
-
| `analyze-process` |
|
|
411
|
-
| `gap-analysis` |
|
|
412
|
-
| `create-product-brief` |
|
|
413
|
-
| `create-odoo-product-brief` |
|
|
414
|
-
| `research` |
|
|
415
|
-
|
|
416
|
-
#### 2. Planning
|
|
417
|
-
| Workflow |
|
|
418
|
-
|
|
419
|
-
| `create-odoo-addon` |
|
|
420
|
-
| `create-odoo-epic` |
|
|
421
|
-
| `create-odoo-prd` |
|
|
422
|
-
| `create-odoo-ux-design` |
|
|
423
|
-
| `plan-odoo-migration` |
|
|
424
|
-
| `create-ux-design` |
|
|
425
|
-
| `prd` |
|
|
426
|
-
|
|
427
|
-
#### 3. Solutioning
|
|
428
|
-
| Workflow |
|
|
429
|
-
|
|
430
|
-
| `create-architecture` |
|
|
431
|
-
| `create-epics-and-stories` |
|
|
432
|
-
| `check-implementation-readiness` |
|
|
433
|
-
| `enhance-existing-system` |
|
|
434
|
-
| `quick-addon` |
|
|
435
|
-
|
|
436
|
-
#### 4. Implementation
|
|
437
|
-
| Workflow |
|
|
438
|
-
|
|
439
|
-
| `dev-story` |
|
|
440
|
-
| `code-review` |
|
|
441
|
-
| `create-next-story` |
|
|
442
|
-
| `rapid-brownfield` |
|
|
443
|
-
| `sprint-planning` |
|
|
444
|
-
| `sprint-status` |
|
|
445
|
-
| `correct-course` |
|
|
446
|
-
| `retrospective` |
|
|
447
|
-
|
|
448
|
-
#### 5. Testing
|
|
449
|
-
| Workflow |
|
|
450
|
-
|
|
451
|
-
| `odoo-test-design` |
|
|
452
|
-
| `test-design` |
|
|
453
|
-
| `test-review` |
|
|
454
|
-
| `automate` |
|
|
455
|
-
|
|
456
|
-
#### 6. Documentation
|
|
457
|
-
| Workflow |
|
|
458
|
-
|
|
459
|
-
| `document-odoo` |
|
|
460
|
-
| `document-project` |
|
|
461
|
-
| `generate-project-context` |
|
|
405
|
+
### Workflow Categories
|
|
406
|
+
|
|
407
|
+
#### 1. Analysis
|
|
408
|
+
| Workflow | Description |
|
|
409
|
+
|----------|-------------|
|
|
410
|
+
| `analyze-process` | Analyze Odoo business processes |
|
|
411
|
+
| `gap-analysis` | Requirements gap analysis |
|
|
412
|
+
| `create-product-brief` | Create Product Brief |
|
|
413
|
+
| `create-odoo-product-brief` | Create Product Brief for Odoo |
|
|
414
|
+
| `research` | Market/technical research |
|
|
415
|
+
|
|
416
|
+
#### 2. Planning
|
|
417
|
+
| Workflow | Description |
|
|
418
|
+
|----------|-------------|
|
|
419
|
+
| `create-odoo-addon` | Design new Odoo Addon |
|
|
420
|
+
| `create-odoo-epic` | Create development Epic |
|
|
421
|
+
| `create-odoo-prd` | Create Odoo PRD |
|
|
422
|
+
| `create-odoo-ux-design` | Design Odoo views UX |
|
|
423
|
+
| `plan-odoo-migration` | Plan migration |
|
|
424
|
+
| `create-ux-design` | Create general UX design |
|
|
425
|
+
| `prd` | Create Product Requirements Doc |
|
|
426
|
+
|
|
427
|
+
#### 3. Solutioning
|
|
428
|
+
| Workflow | Description |
|
|
429
|
+
|----------|-------------|
|
|
430
|
+
| `create-architecture` | Design architecture |
|
|
431
|
+
| `create-epics-and-stories` | Create Epics & Stories |
|
|
432
|
+
| `check-implementation-readiness` | Check implementation readiness |
|
|
433
|
+
| `enhance-existing-system` | Enhance existing system |
|
|
434
|
+
| `quick-addon` | Quick addon creation |
|
|
435
|
+
|
|
436
|
+
#### 4. Implementation
|
|
437
|
+
| Workflow | Description |
|
|
438
|
+
|----------|-------------|
|
|
439
|
+
| `dev-story` | Execute Dev Story |
|
|
440
|
+
| `code-review` | Code review |
|
|
441
|
+
| `create-next-story` | Create next Story |
|
|
442
|
+
| `rapid-brownfield` | Rapid brownfield development |
|
|
443
|
+
| `sprint-planning` | Sprint planning |
|
|
444
|
+
| `sprint-status` | Sprint status |
|
|
445
|
+
| `correct-course` | Course correction |
|
|
446
|
+
| `retrospective` | Retrospective meeting |
|
|
447
|
+
|
|
448
|
+
#### 5. Testing
|
|
449
|
+
| Workflow | Description |
|
|
450
|
+
|----------|-------------|
|
|
451
|
+
| `odoo-test-design` | Odoo test design |
|
|
452
|
+
| `test-design` | Test design |
|
|
453
|
+
| `test-review` | Test review |
|
|
454
|
+
| `automate` | Test automation |
|
|
455
|
+
|
|
456
|
+
#### 6. Documentation
|
|
457
|
+
| Workflow | Description |
|
|
458
|
+
|----------|-------------|
|
|
459
|
+
| `document-odoo` | Document Odoo module |
|
|
460
|
+
| `document-project` | Document project |
|
|
461
|
+
| `generate-project-context` | Generate project context |
|
|
462
462
|
|
|
463
463
|
---
|
|
464
464
|
|
|
465
|
-
##
|
|
465
|
+
## Work Process
|
|
466
466
|
|
|
467
|
-
###
|
|
467
|
+
### New Odoo Addon Development Process
|
|
468
468
|
|
|
469
469
|
```
|
|
470
470
|
┌─────────────────────────────────────────────────────────────┐
|
|
471
|
-
│
|
|
471
|
+
│ DEVELOPMENT PROCESS │
|
|
472
472
|
├─────────────────────────────────────────────────────────────┤
|
|
473
473
|
│ │
|
|
474
|
-
│ 1. ANALYSIS
|
|
475
|
-
│ └─▶ /analyst → [AP]
|
|
476
|
-
│ └─▶ /analyst → [GA] Gap Analysis
|
|
474
|
+
│ 1. ANALYSIS │
|
|
475
|
+
│ └─▶ /analyst → [AP] Analyze process │
|
|
476
|
+
│ └─▶ /analyst → [GA] Gap Analysis │
|
|
477
477
|
│ │
|
|
478
|
-
│ 2. PLANNING
|
|
479
|
-
│ └─▶ /pm → [OPB]
|
|
480
|
-
│ └─▶ /pm → [OPR]
|
|
481
|
-
│ └─▶ /pm → [CE]
|
|
478
|
+
│ 2. PLANNING │
|
|
479
|
+
│ └─▶ /pm → [OPB] Create Odoo Product Brief │
|
|
480
|
+
│ └─▶ /pm → [OPR] Create Odoo PRD │
|
|
481
|
+
│ └─▶ /pm → [CE] Create Epic │
|
|
482
482
|
│ │
|
|
483
|
-
│ 3. DESIGN
|
|
484
|
-
│ └─▶ /architect → [CO]
|
|
485
|
-
│ └─▶ /ux-designer → [OUX]
|
|
483
|
+
│ 3. DESIGN │
|
|
484
|
+
│ └─▶ /architect → [CO] Design Addon │
|
|
485
|
+
│ └─▶ /ux-designer → [OUX] Design UX Views │
|
|
486
486
|
│ │
|
|
487
|
-
│ 4. IMPLEMENTATION
|
|
488
|
-
│ └─▶ /sm → [CS]
|
|
489
|
-
│ └─▶ /dev → [DS] Dev Story
|
|
490
|
-
│ └─▶ /dev → [CR] Code Review
|
|
487
|
+
│ 4. IMPLEMENTATION │
|
|
488
|
+
│ └─▶ /sm → [CS] Create Story │
|
|
489
|
+
│ └─▶ /dev → [DS] Dev Story │
|
|
490
|
+
│ └─▶ /dev → [CR] Code Review │
|
|
491
491
|
│ │
|
|
492
|
-
│ 5. TESTING
|
|
493
|
-
│ └─▶ /tea → [OTD]
|
|
492
|
+
│ 5. TESTING │
|
|
493
|
+
│ └─▶ /tea → [OTD] Design Odoo Test │
|
|
494
494
|
│ │
|
|
495
|
-
│ 6. DOCUMENTATION
|
|
496
|
-
│ └─▶ /tech-writer → [OD]
|
|
495
|
+
│ 6. DOCUMENTATION │
|
|
496
|
+
│ └─▶ /tech-writer → [OD] Document Odoo Module │
|
|
497
497
|
│ │
|
|
498
498
|
└─────────────────────────────────────────────────────────────┘
|
|
499
499
|
```
|
|
500
500
|
|
|
501
|
-
###
|
|
501
|
+
### Example: Analyzing Sales Process
|
|
502
502
|
|
|
503
503
|
```bash
|
|
504
|
-
#
|
|
504
|
+
# Step 1: Activate Business Analyst
|
|
505
505
|
/analyst
|
|
506
506
|
|
|
507
|
-
#
|
|
507
|
+
# Step 2: Choose menu [AP] Analyze process
|
|
508
508
|
> AP
|
|
509
509
|
|
|
510
|
-
#
|
|
511
|
-
# -
|
|
512
|
-
# -
|
|
513
|
-
# -
|
|
514
|
-
# -
|
|
515
|
-
# -
|
|
510
|
+
# Step 3: Workflow will guide through steps:
|
|
511
|
+
# - Gather basic information
|
|
512
|
+
# - Analyze current state
|
|
513
|
+
# - Identify pain points
|
|
514
|
+
# - Map to Odoo modules
|
|
515
|
+
# - Propose solutions
|
|
516
516
|
```
|
|
517
517
|
|
|
518
518
|
---
|
|
519
519
|
|
|
520
|
-
##
|
|
520
|
+
## Directory Structure
|
|
521
521
|
|
|
522
522
|
```
|
|
523
523
|
_bmad-odoo/
|
|
@@ -566,65 +566,65 @@ _bmad-odoo/
|
|
|
566
566
|
|
|
567
567
|
## 🔧 Troubleshooting
|
|
568
568
|
|
|
569
|
-
###
|
|
569
|
+
### Error: "Cannot find module 'bmad-odoo'"
|
|
570
570
|
|
|
571
|
-
**
|
|
571
|
+
**Cause:** Package not installed or installed in wrong location
|
|
572
572
|
|
|
573
|
-
**
|
|
573
|
+
**Solution:**
|
|
574
574
|
```bash
|
|
575
|
-
#
|
|
575
|
+
# Check if bmad-odoo is in package.json
|
|
576
576
|
cat package.json | grep bmad-odoo
|
|
577
577
|
|
|
578
|
-
#
|
|
578
|
+
# Reinstall
|
|
579
579
|
npm install bmad-odoo
|
|
580
580
|
|
|
581
581
|
# Verify
|
|
582
582
|
npm list bmad-odoo
|
|
583
583
|
```
|
|
584
584
|
|
|
585
|
-
###
|
|
585
|
+
### Error: "Permission denied" when creating symlink
|
|
586
586
|
|
|
587
|
-
**
|
|
587
|
+
**Cause:** Windows requires admin rights to create symlinks
|
|
588
588
|
|
|
589
|
-
**
|
|
590
|
-
Script
|
|
589
|
+
**Solution:**
|
|
590
|
+
Script automatically falls back to copying folder. No action needed.
|
|
591
591
|
|
|
592
|
-
**
|
|
592
|
+
**Check:**
|
|
593
593
|
```bash
|
|
594
|
-
#
|
|
594
|
+
# Check if _bmad-odoo is a symlink
|
|
595
595
|
ls -la _bmad-odoo
|
|
596
596
|
|
|
597
|
-
#
|
|
598
|
-
#
|
|
597
|
+
# If symlink: lrwxrwxrwx ... _bmad-odoo -> node_modules/bmad-odoo
|
|
598
|
+
# If copy: drwxr-xr-x ... _bmad-odoo
|
|
599
599
|
```
|
|
600
600
|
|
|
601
|
-
###
|
|
601
|
+
### Error: Post-install not running
|
|
602
602
|
|
|
603
|
-
**
|
|
603
|
+
**Cause:** npm config or running with `--ignore-scripts`
|
|
604
604
|
|
|
605
|
-
**
|
|
605
|
+
**Solution:**
|
|
606
606
|
```bash
|
|
607
|
-
#
|
|
607
|
+
# Run manually
|
|
608
608
|
npx bmad-odoo-setup
|
|
609
609
|
|
|
610
|
-
#
|
|
610
|
+
# Or
|
|
611
611
|
npm run setup
|
|
612
612
|
```
|
|
613
613
|
|
|
614
|
-
###
|
|
614
|
+
### Error: Workflows not appearing in IDE
|
|
615
615
|
|
|
616
|
-
**
|
|
617
|
-
- IDE
|
|
618
|
-
- Workflows
|
|
616
|
+
**Cause:**
|
|
617
|
+
- IDE not reloaded
|
|
618
|
+
- Workflows created in wrong folder
|
|
619
619
|
|
|
620
|
-
**
|
|
620
|
+
**Solution:**
|
|
621
621
|
```bash
|
|
622
|
-
# 1.
|
|
622
|
+
# 1. Check if workflows are created
|
|
623
623
|
ls .agent/workflows # Antigravity
|
|
624
624
|
ls .cursor/workflows # Cursor
|
|
625
625
|
ls .vscode/workflows # VS Code
|
|
626
626
|
|
|
627
|
-
# 2.
|
|
627
|
+
# 2. If not present, re-run setup
|
|
628
628
|
npx bmad-odoo-setup
|
|
629
629
|
|
|
630
630
|
# 3. Reload IDE
|
|
@@ -633,92 +633,92 @@ npx bmad-odoo-setup
|
|
|
633
633
|
# - VS Code: Cmd/Ctrl + Shift + P → "Reload Window"
|
|
634
634
|
```
|
|
635
635
|
|
|
636
|
-
###
|
|
636
|
+
### Error: Output folder not created
|
|
637
637
|
|
|
638
|
-
**
|
|
638
|
+
**Solution:**
|
|
639
639
|
```bash
|
|
640
|
-
#
|
|
640
|
+
# Create manually
|
|
641
641
|
mkdir -p _bmad-odoo-output/{planning-artifacts,implementation-artifacts,test-artifacts,documentation}
|
|
642
642
|
|
|
643
|
-
#
|
|
643
|
+
# Or re-run setup
|
|
644
644
|
npx bmad-odoo-setup
|
|
645
645
|
```
|
|
646
646
|
|
|
647
|
-
###
|
|
647
|
+
### Want to change IDE after setup
|
|
648
648
|
|
|
649
|
-
**
|
|
649
|
+
**Solution:**
|
|
650
650
|
```bash
|
|
651
|
-
#
|
|
651
|
+
# Re-run setup and choose new IDE
|
|
652
652
|
npx bmad-odoo-setup
|
|
653
653
|
|
|
654
|
-
#
|
|
654
|
+
# Or choose "All" to have workflows for multiple IDEs
|
|
655
655
|
```
|
|
656
656
|
|
|
657
657
|
---
|
|
658
658
|
|
|
659
659
|
## ❓ FAQ
|
|
660
660
|
|
|
661
|
-
**Q:
|
|
661
|
+
**Q: Can I use multiple IDEs simultaneously?**
|
|
662
662
|
|
|
663
|
-
A:
|
|
663
|
+
A: Yes! Choose option 5 (All) during setup, or run `npx bmad-odoo-setup` multiple times with different IDEs.
|
|
664
664
|
|
|
665
|
-
**Q: _bmad-odoo
|
|
665
|
+
**Q: What's the difference between _bmad-odoo and node_modules/bmad-odoo?**
|
|
666
666
|
|
|
667
667
|
A:
|
|
668
|
-
- `node_modules/bmad-odoo`:
|
|
669
|
-
- `_bmad-odoo`: Symlink (
|
|
668
|
+
- `node_modules/bmad-odoo`: Original package from npm
|
|
669
|
+
- `_bmad-odoo`: Symlink (or copy) for easy access, avoiding long path typing
|
|
670
670
|
|
|
671
|
-
**Q:
|
|
671
|
+
**Q: Can I commit _bmad-odoo-output to git?**
|
|
672
672
|
|
|
673
|
-
A:
|
|
673
|
+
A: Yes! This folder contains artifacts (PRD, architecture docs, stories) created by agents. Committing them helps team track progress.
|
|
674
674
|
|
|
675
|
-
**Q:
|
|
675
|
+
**Q: How to update to new version?**
|
|
676
676
|
|
|
677
|
-
A: `npm update bmad-odoo`
|
|
677
|
+
A: `npm update bmad-odoo` or `npm install bmad-odoo@latest`
|
|
678
678
|
|
|
679
|
-
**Q:
|
|
679
|
+
**Q: Does this package work offline?**
|
|
680
680
|
|
|
681
|
-
A:
|
|
681
|
+
A: After installation, the package works offline (no internet needed). Internet only required for initial `npm install`.
|
|
682
682
|
|
|
683
|
-
**Q:
|
|
683
|
+
**Q: Can I customize the config?**
|
|
684
684
|
|
|
685
|
-
A:
|
|
685
|
+
A: Yes! Edit `_bmad-odoo/bmm/config.yaml` to change output folder, Odoo version, and other settings.
|
|
686
686
|
|
|
687
687
|
---
|
|
688
688
|
|
|
689
|
-
##
|
|
689
|
+
## References
|
|
690
690
|
|
|
691
|
-
### Files
|
|
691
|
+
### Important Files
|
|
692
692
|
|
|
693
|
-
| File |
|
|
694
|
-
|
|
695
|
-
| `_bmad-odoo/bmm/config.yaml` |
|
|
696
|
-
| `_bmad-odoo/bmm/data/odoo-knowledge-base.md` |
|
|
697
|
-
| `_bmad-odoo-output/` |
|
|
698
|
-
| `.agent/workflows/` | Workflows
|
|
693
|
+
| File | Description |
|
|
694
|
+
|------|-------------|
|
|
695
|
+
| `_bmad-odoo/bmm/config.yaml` | Main configuration |
|
|
696
|
+
| `_bmad-odoo/bmm/data/odoo-knowledge-base.md` | Odoo knowledge |
|
|
697
|
+
| `_bmad-odoo-output/` | Artifacts directory |
|
|
698
|
+
| `.agent/workflows/` | Workflows for Antigravity |
|
|
699
699
|
|
|
700
|
-
###
|
|
700
|
+
### Links
|
|
701
701
|
|
|
702
702
|
- [NPM Package](https://www.npmjs.com/package/bmad-odoo)
|
|
703
703
|
- [GitHub Repository](https://github.com/phamdungtk/bmad-odoo)
|
|
704
|
-
- [BMAD Framework (
|
|
704
|
+
- [BMAD Framework (original)](https://github.com/bmadcode/BMAD-METHOD)
|
|
705
705
|
- [Odoo Documentation](https://www.odoo.com/documentation)
|
|
706
706
|
- [OCA Guidelines](https://github.com/OCA/odoo-community.org)
|
|
707
707
|
|
|
708
708
|
---
|
|
709
709
|
|
|
710
|
-
##
|
|
710
|
+
## Support
|
|
711
711
|
|
|
712
|
-
|
|
712
|
+
If you encounter issues:
|
|
713
713
|
|
|
714
|
-
1. **
|
|
715
|
-
2. **
|
|
716
|
-
3. **
|
|
714
|
+
1. **Check installation**: `npm list bmad-odoo`
|
|
715
|
+
2. **Re-run setup**: `npx bmad-odoo-setup`
|
|
716
|
+
3. **See Troubleshooting** above
|
|
717
717
|
4. **Report issue**: [GitHub Issues](https://github.com/phamdungtk/bmad-odoo/issues)
|
|
718
718
|
|
|
719
719
|
---
|
|
720
720
|
|
|
721
|
-
**
|
|
722
|
-
**
|
|
723
|
-
**
|
|
721
|
+
**Version:** 1.0.0
|
|
722
|
+
**Updated:** 2026-01-02
|
|
723
|
+
**Language:** English
|
|
724
724
|
**License:** MIT
|
package/package.json
CHANGED
package/scripts/postinstall.js
CHANGED
|
@@ -421,27 +421,43 @@ function printSuccessMessage(selectedIde) {
|
|
|
421
421
|
|
|
422
422
|
// Main function
|
|
423
423
|
async function main() {
|
|
424
|
+
console.log('\n🚀 BMAD-Odoo postinstall script starting...\n');
|
|
425
|
+
|
|
424
426
|
const projectRoot = getProjectRoot();
|
|
425
427
|
const packageRoot = path.join(__dirname, '..');
|
|
426
428
|
|
|
429
|
+
console.log(`📂 Package root: ${packageRoot}`);
|
|
430
|
+
console.log(`📂 Project root: ${projectRoot || 'NOT FOUND'}\n`);
|
|
431
|
+
|
|
427
432
|
if (!projectRoot) {
|
|
428
433
|
logWarning('Không tìm thấy project root. Bỏ qua auto-setup.');
|
|
429
|
-
logWarning('Bạn có thể setup thủ công
|
|
430
|
-
|
|
434
|
+
logWarning('Bạn có thể setup thủ công bằng lệnh: npx bmad-odoo-setup\n');
|
|
435
|
+
process.exit(0);
|
|
431
436
|
}
|
|
432
437
|
|
|
433
438
|
// Check if running interactively (has stdin)
|
|
434
439
|
const isInteractive = process.stdin.isTTY;
|
|
435
440
|
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
441
|
+
console.log(`🔧 Interactive mode: ${isInteractive ? 'YES' : 'NO (using auto-setup)'}\n`);
|
|
442
|
+
|
|
443
|
+
try {
|
|
444
|
+
if (isInteractive) {
|
|
445
|
+
await interactiveSetup(projectRoot, packageRoot);
|
|
446
|
+
} else {
|
|
447
|
+
autoSetup(projectRoot, packageRoot);
|
|
448
|
+
}
|
|
449
|
+
} catch (error) {
|
|
450
|
+
logError(`Lỗi trong quá trình setup: ${error.message}`);
|
|
451
|
+
console.error(error.stack);
|
|
452
|
+
logWarning('Bạn có thể setup thủ công bằng lệnh: npx bmad-odoo-setup\n');
|
|
453
|
+
process.exit(0); // Don't fail npm install
|
|
440
454
|
}
|
|
441
455
|
}
|
|
442
456
|
|
|
443
457
|
// Run the script
|
|
444
458
|
main().catch((error) => {
|
|
445
|
-
logError(`Lỗi
|
|
446
|
-
|
|
459
|
+
logError(`Lỗi fatal: ${error.message}`);
|
|
460
|
+
console.error(error.stack);
|
|
461
|
+
logWarning('Bạn có thể setup thủ công bằng lệnh: npx bmad-odoo-setup\n');
|
|
462
|
+
process.exit(0); // Don't fail npm install
|
|
447
463
|
});
|