Skip to content

Commit 5dbfb58

Browse files
authored
refactor(installer): remove custom content installation feature (#2227)
* refactor(installer): remove custom content installation feature Remove the entire local filesystem custom content feature from the installer to make way for marketplace-based plugin installation. Deleted: custom-handler.js, custom-module-cache.js, custom-modules.js Removed: --custom-content CLI flag, interactive custom content prompts, custom module caching, manifest tracking, missing-source resolution, and related test suites. Updated docs across all translations. * fix: address review findings from Augment Fix admonition syntax (remove accidental space in :::note) across 4 translated docs files, and update stale JSDoc on listAvailable().
1 parent 9ca0316 commit 5dbfb58

21 files changed

Lines changed: 31 additions & 2091 deletions

docs/cs/how-to/non-interactive-installation.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Vyžaduje [Node.js](https://nodejs.org) v20+ a `npx` (součástí npm).
2727
| `--directory <cesta>` | Instalační adresář | `--directory ~/projects/myapp` |
2828
| `--modules <moduly>` | Čárkou oddělená ID modulů | `--modules bmm,bmb` |
2929
| `--tools <nástroje>` | Čárkou oddělená ID nástrojů/IDE (použijte `none` pro přeskočení) | `--tools claude-code,cursor` nebo `--tools none` |
30-
| `--custom-content <cesty>` | Čárkou oddělené cesty k vlastním modulům | `--custom-content ~/my-module,~/another-module` |
3130
| `--action <typ>` | Akce pro existující instalace: `install` (výchozí), `update` nebo `quick-update` | `--action quick-update` |
3231

3332
### Základní konfigurace
@@ -108,16 +107,6 @@ npx bmad-method install \
108107
--action quick-update
109108
```
110109

111-
### Instalace s vlastním obsahem
112-
113-
```bash
114-
npx bmad-method install \
115-
--directory ~/projects/myapp \
116-
--modules bmm \
117-
--custom-content ~/my-custom-module,~/another-module \
118-
--tools claude-code
119-
```
120-
121110
## Co získáte
122111

123112
- Plně nakonfigurovaný adresář `_bmad/` ve vašem projektu
@@ -159,13 +148,6 @@ Neplatné hodnoty buď:
159148
- Ověřte, že ID modulu je správné
160149
- Externí moduly musí být dostupné v registru
161150

162-
### Neplatná cesta k vlastnímu obsahu
163-
164-
Ujistěte se, že každá cesta k vlastnímu obsahu:
165-
- Ukazuje na adresář
166-
- Obsahuje soubor `module.yaml` v kořeni
167-
- Má pole `code` v `module.yaml`
168-
169151
:::note[Stále jste uvízli?]
170152
Spusťte s `--debug` pro detailní výstup, zkuste interaktivní režim pro izolaci problému, nebo nahlaste na <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
171153
:::

docs/fr/how-to/install-bmad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ L'installateur affiche les modules disponibles. Sélectionnez ceux dont vous ave
7272

7373
### 5. Suivre les instructions
7474

75-
L'installateur vous guide pour le reste — contenu personnalisé, paramètres, etc.
75+
L'installateur vous guide pour le reste — paramètres, intégrations d'outils, etc.
7676

7777
## Ce que vous obtenez
7878

docs/fr/how-to/non-interactive-installation.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Nécessite [Node.js](https://nodejs.org) v20+ et `npx` (inclus avec npm).
2727
| `--directory <chemin>` | Répertoire d'installation | `--directory ~/projects/myapp` |
2828
| `--modules <modules>` | IDs de modules séparés par des virgules | `--modules bmm,bmb` |
2929
| `--tools <outils>` | IDs d'outils/IDE séparés par des virgules (utilisez `none` pour ignorer) | `--tools claude-code,cursor` ou `--tools none` |
30-
| `--custom-content <chemins>` | Chemins vers des modules personnalisés séparés par des virgules | `--custom-content ~/my-module,~/another-module` |
3130
| `--action <type>` | Action pour les installations existantes : `install` (par défaut), `update`, ou `quick-update` | `--action quick-update` |
3231

3332
### Configuration principale
@@ -120,16 +119,6 @@ npx bmad-method install \
120119
--action quick-update
121120
```
122121

123-
### Installation avec du contenu personnalisé
124-
125-
```bash
126-
npx bmad-method install \
127-
--directory ~/projects/myapp \
128-
--modules bmm \
129-
--custom-content ~/my-custom-module,~/another-module \
130-
--tools claude-code
131-
```
132-
133122
## Ce que vous obtenez
134123

135124
- Un répertoire `_bmad/` entièrement configuré dans votre projet
@@ -143,12 +132,11 @@ BMad valide toutes les options fournis :
143132
- **Directory** — Doit être un chemin valide avec des permissions d'écriture
144133
- **Modules** — Avertit des IDs de modules invalides (mais n'échoue pas)
145134
- **Tools** — Avertit des IDs d'outils invalides (mais n'échoue pas)
146-
- **Custom Content** — Chaque chemin doit contenir un fichier `module.yaml` valide
147135
- **Action** — Doit être l'une des suivantes : `install`, `update`, `quick-update`
148136

149137
Les valeurs invalides entraîneront soit :
150138
1. L’affichage d’un message d'erreur suivi d’un exit (pour les options critiques comme le répertoire)
151-
2. Un avertissement puis la continuation de l’installation (pour les éléments optionnels comme le contenu personnalisé)
139+
2. Un avertissement puis la continuation de l’installation (pour les éléments optionnels)
152140
3. Un retour aux invites interactives (pour les valeurs requises manquantes)
153141

154142
:::tip[Bonnes pratiques]
@@ -172,13 +160,6 @@ Les valeurs invalides entraîneront soit :
172160
- Vérifiez que l'ID du module est correct
173161
- Les modules externes doivent être disponibles dans le registre
174162

175-
### Chemin de contenu personnalisé invalide
176-
177-
Assurez-vous que chaque chemin de contenu personnalisé :
178-
- Pointe vers un répertoire
179-
- Contient un fichier `module.yaml` à la racine
180-
- Possède un champ `code` dans `module.yaml`
181-
182163
:::note[Toujours bloqué ?]
183164
Exécutez avec `--debug` pour une sortie détaillée, essayez le mode interactif pour isoler le problème, ou signalez-le à <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
184165
:::

docs/how-to/install-bmad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The installer shows available modules. Select whichever ones you need — most u
7272

7373
### 5. Follow the Prompts
7474

75-
The installer guides you through the rest — custom content, settings, etc.
75+
The installer guides you through the rest — settings, tool integrations, etc.
7676

7777
## What You Get
7878

docs/how-to/non-interactive-installation.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Requires [Node.js](https://nodejs.org) v20+ and `npx` (included with npm).
2727
| `--directory <path>` | Installation directory | `--directory ~/projects/myapp` |
2828
| `--modules <modules>` | Comma-separated module IDs | `--modules bmm,bmb` |
2929
| `--tools <tools>` | Comma-separated tool/IDE IDs (use `none` to skip) | `--tools claude-code,cursor` or `--tools none` |
30-
| `--custom-content <paths>` | Comma-separated paths to custom modules | `--custom-content ~/my-module,~/another-module` |
3130
| `--action <type>` | Action for existing installations: `install` (default), `update`, or `quick-update` | `--action quick-update` |
3231

3332
### Core Configuration
@@ -120,16 +119,6 @@ npx bmad-method install \
120119
--action quick-update
121120
```
122121

123-
### Installation with Custom Content
124-
125-
```bash
126-
npx bmad-method install \
127-
--directory ~/projects/myapp \
128-
--modules bmm \
129-
--custom-content ~/my-custom-module,~/another-module \
130-
--tools claude-code
131-
```
132-
133122
## What You Get
134123

135124
- A fully configured `_bmad/` directory in your project
@@ -143,12 +132,11 @@ BMad validates all provided flags:
143132
- **Directory** — Must be a valid path with write permissions
144133
- **Modules** — Warns about invalid module IDs (but won't fail)
145134
- **Tools** — Warns about invalid tool IDs (but won't fail)
146-
- **Custom Content** — Each path must contain a valid `module.yaml` file
147135
- **Action** — Must be one of: `install`, `update`, `quick-update`
148136

149137
Invalid values will either:
150138
1. Show an error and exit (for critical options like directory)
151-
2. Show a warning and skip (for optional items like custom content)
139+
2. Show a warning and skip (for optional items)
152140
3. Fall back to interactive prompts (for missing required values)
153141

154142
:::tip[Best Practices]
@@ -172,13 +160,6 @@ Invalid values will either:
172160
- Verify the module ID is correct
173161
- External modules must be available in the registry
174162

175-
### Custom content path invalid
176-
177-
Ensure each custom content path:
178-
- Points to a directory
179-
- Contains a `module.yaml` file in the root
180-
- Has a `code` field in the `module.yaml`
181-
182163
:::note[Still stuck?]
183164
Run with `--debug` for detailed output, try interactive mode to isolate the issue, or report at <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
184165
:::

docs/vi-vn/how-to/install-bmad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Trình cài đặt sẽ hiện các module có sẵn. Chọn những module bạ
7272

7373
### 5. Làm theo các prompt
7474

75-
Trình cài đặt sẽ hướng dẫn các bước còn lại - nội dung tùy chỉnh, cài đặt, và các tùy chọn khác.
75+
Trình cài đặt sẽ hướng dẫn các bước còn lại - cài đặt, tích hợp công cụ, và các tùy chọn khác.
7676

7777
## Bạn nhận được gì
7878

docs/vi-vn/how-to/non-interactive-installation.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Yêu cầu [Node.js](https://nodejs.org) v20+ và `npx` (đi kèm với npm).
2727
| `--directory <path>` | Thư mục cài đặt | `--directory ~/projects/myapp` |
2828
| `--modules <modules>` | Danh sách ID module, cách nhau bởi dấu phẩy | `--modules bmm,bmb` |
2929
| `--tools <tools>` | Danh sách ID công cụ/IDE, cách nhau bởi dấu phẩy (dùng `none` để bỏ qua) | `--tools claude-code,cursor` hoặc `--tools none` |
30-
| `--custom-content <paths>` | Danh sách đường dẫn đến module tùy chỉnh, cách nhau bởi dấu phẩy | `--custom-content ~/my-module,~/another-module` |
3130
| `--action <type>` | Hành động cho bản cài đặt hiện có: `install` (mặc định), `update`, hoặc `quick-update` | `--action quick-update` |
3231

3332
### Cấu hình cốt lõi
@@ -120,16 +119,6 @@ npx bmad-method install \
120119
--action quick-update
121120
```
122121

123-
### Cài đặt với nội dung tùy chỉnh
124-
125-
```bash
126-
npx bmad-method install \
127-
--directory ~/projects/myapp \
128-
--modules bmm \
129-
--custom-content ~/my-custom-module,~/another-module \
130-
--tools claude-code
131-
```
132-
133122
## Bạn nhận được gì
134123

135124
- Thư mục `_bmad/` đã được cấu hình đầy đủ trong dự án của bạn
@@ -143,12 +132,11 @@ BMad sẽ kiểm tra tất cả các cờ được cung cấp:
143132
- **Directory** - Phải là đường dẫn hợp lệ và có quyền ghi
144133
- **Modules** - Cảnh báo nếu ID module không hợp lệ (nhưng không thất bại)
145134
- **Tools** - Cảnh báo nếu ID công cụ không hợp lệ (nhưng không thất bại)
146-
- **Custom Content** - Mỗi đường dẫn phải chứa tệp `module.yaml` hợp lệ
147135
- **Action** - Phải là một trong: `install`, `update`, `quick-update`
148136

149137
Giá trị không hợp lệ sẽ dẫn đến một trong các trường hợp sau:
150138
1. Hiện lỗi và thoát (với các tùy chọn quan trọng như directory)
151-
2. Hiện cảnh báo và bỏ qua (với mục tùy chọn như custom content)
139+
2. Hiện cảnh báo và bỏ qua (với mục tùy chọn)
152140
3. Quay lại hỏi interactive (với giá trị bắt buộc bị thiếu)
153141

154142
:::tip[Thực hành tốt]
@@ -172,13 +160,6 @@ Giá trị không hợp lệ sẽ dẫn đến một trong các trường hợp
172160
- Xác minh ID module có đúng không
173161
- Module bên ngoài phải có sẵn trong registry
174162

175-
### Đường dẫn custom content không hợp lệ
176-
177-
Đảm bảo mỗi đường dẫn custom content:
178-
- Trỏ tới một thư mục
179-
- Chứa tệp `module.yaml` ở cấp gốc
180-
- Có trường `code` trong tệp `module.yaml`
181-
182163
:::note[Vẫn bị mắc?]
183164
Chạy với `--debug` để xem output chi tiết, thử chế độ interactive để cô lập vấn đề, hoặc báo cáo tại <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
184165
:::

docs/zh-cn/how-to/install-bmad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ npx github:bmad-code-org/BMAD-METHOD install
7272

7373
### 5. 按照提示操作
7474

75-
安装程序会引导你完成剩余步骤——自定义内容、设置等
75+
安装程序会引导你完成剩余步骤——设置、工具集成等
7676

7777
## 你将获得
7878

docs/zh-cn/how-to/non-interactive-installation.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ sidebar:
2727
| `--directory <path>` | 安装目录 | `--directory ~/projects/myapp` |
2828
| `--modules <modules>` | 逗号分隔的模块 ID | `--modules bmm,bmb` |
2929
| `--tools <tools>` | 逗号分隔的工具/IDE ID(使用 `none` 跳过) | `--tools claude-code,cursor``--tools none` |
30-
| `--custom-content <paths>` | 逗号分隔的自定义模块路径 | `--custom-content ~/my-module,~/another-module` |
3130
| `--action <type>` | 对现有安装的操作:`install`(默认)、`update``quick-update` | `--action quick-update` |
3231

3332
### 核心配置
@@ -108,16 +107,6 @@ npx bmad-method install \
108107
--action quick-update
109108
```
110109

111-
### 使用自定义内容安装
112-
113-
```bash
114-
npx bmad-method install \
115-
--directory ~/projects/myapp \
116-
--modules bmm \
117-
--custom-content ~/my-custom-module,~/another-module \
118-
--tools claude-code
119-
```
120-
121110
## 安装结果
122111

123112
- 项目中完全配置的 `_bmad/` 目录
@@ -131,12 +120,11 @@ BMad 会验证你提供的所有参数:
131120
- **目录** — 必须是具有写入权限的有效路径
132121
- **模块** — 对无效的模块 ID 发出警告(但不会失败)
133122
- **工具** — 对无效的工具 ID 发出警告(但不会失败)
134-
- **自定义内容** — 每个路径必须包含有效的 `module.yaml` 文件
135123
- **操作** — 必须是以下之一:`install``update``quick-update`
136124

137125
无效值将:
138126
1. 显示错误并退出(对于目录等关键选项)
139-
2. 显示警告并跳过(对于自定义内容等可选项目
127+
2. 显示警告并跳过(对于可选项目
140128
3. 回退到交互式提示(对于缺失的必需值)
141129

142130
:::tip[最佳实践]
@@ -159,13 +147,6 @@ BMad 会验证你提供的所有参数:
159147
- 验证模块 ID 是否正确
160148
- 外部模块必须在注册表中可用
161149

162-
### 自定义内容路径无效
163-
164-
确保每个自定义内容路径:
165-
- 指向一个目录
166-
- 在根目录中包含 `module.yaml` 文件
167-
-`module.yaml` 中有 `code` 字段
168-
169150
:::note[仍然卡住了?]
170151
使用 `--debug` 获取详细输出,尝试交互模式定位问题,或在 <https://github.com/bmad-code-org/BMAD-METHOD/issues> 提交反馈。
171152
:::

0 commit comments

Comments
 (0)