sdd-toolkit 1.8.0 → 1.9.1

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 CHANGED
@@ -1,339 +1,393 @@
1
- # sdd-toolkit (Universal Spec CLI)
2
-
3
- ![npm version](https://img.shields.io/npm/v/sdd-toolkit)
4
- ![License: MIT](https://img.shields.io/npm/l/sdd-toolkit)
5
- ![Downloads](https://img.shields.io/npm/dm/sdd-toolkit)
6
-
7
- CLI tool to automatically set up the development environment and install AI agents (Auditor, Coder, etc.) for various modern AI tools.
8
-
9
- ## Overview
10
-
11
- **sdd-toolkit** is an "AI Agent Package Manager". It defines a standard squad of AI Developers and installs them directly into the context of your favorite AI Coding Assistant (such as Gemini, Roo Code, Kilo Code, OpenCode).
12
-
13
- The main idea is to stop creating prompts from scratch and install a proven, structured workflow.
14
-
15
- ## 📑 Table of Contents
16
-
17
- - [Overview](#overview)
18
- - [Key Features](#-key-features)
19
- - [The Squad](#-the-squad-agent-roles)
20
- - [Installation and Usage](#installation-and-usage)
21
- - [How it Works](#how-it-works)
22
- - [Development Workflow](#development-workflow)
23
- - [AI Tool Commands](#ai-tool-commands)
24
- - [Generated Files Structure](#generated-files-structure)
25
- - [Usage Examples](#usage-examples)
26
- - [Troubleshooting](#troubleshooting)
27
- - [FAQ](#-frequently-asked-questions)
28
- - [Project Structure](#project-structure)
29
- - [License](#license)
30
-
31
- ## 🚀 Key Features
32
-
33
- ### 1. Smart & Agile Workflow
34
- - **Hybrid Flow:** Supports both "Waterfall" planning (for new projects) and "Agile" execution (for hotfixes/features).
35
- - **Smart Context:** Agents automatically scan your `package.json`, `go.mod`, or `requirements.txt` to understand your stack. No more explaining "I use React" every time.
36
- - **Unified Memory:** All context is stored in a hidden `.sdd-toolkit/` folder, keeping your root directory clean.
37
-
38
- ### 2. Multi-Language Support
39
- The toolkit supports English, Portuguese (Brazil), and Spanish. Agents automatically adapt their responses to your preferred language.
40
-
41
- ### 3. AI Agent Installation
42
- Reads agnostic definitions (YAML) and converts them to specific formats:
43
- - **Gemini CLI:** Generates `.toml` configuration files.
44
- - **Roo Code:** Generates agents in `.roo/commands/*.md`.
45
- - **Cline:** Generates custom modes (`_custom_modes.json`) and context rules in `.cline/`.
46
- - **GitHub Copilot:** Generates instructions in `.github/prompts.md` and agents in `.github/prompts/*.md`.
47
- - **Cursor:** Generates rules in `.cursor/commands/*.mdc`.
48
- - **Windsurf:** Generates workflows in `.windsurf/workflows/*.md`.
49
- - **Trae:** Generates instructions in `.trae/instructions.md`.
50
- - **OpenCode:** Generates agents in `.opencode/commands/*.md`.
51
- - **Kilo Code:** Generates Markdown prompts (`.kilocode/workflows/*.md`).
52
-
53
- ## 👥 The Squad (Agent Roles)
54
-
55
- The system installs a team of specialized agents:
56
-
57
- ### 🏗️ Strategic Agents
58
- - **@Project Architect:** Defines the scope and principles.
59
- - **@Requirements Engineer:** Defines the tech stack (Auto-detected).
60
-
61
- ### Execution Agents
62
- - **@Feature Manager:** Manages features, milestones, and tasks.
63
- - **@Coder:** The senior developer. Implements code following SOLID principles.
64
-
65
- ### 🛡️ Quality Agents
66
- - **@QA Engineer:** Reviews code against the spec.
67
- - **@Release Manager:** Consolidates logs and manages the changelog.
68
- - **@SDD Helper:** Provides access to all agents and help.
69
-
70
- ## Installation and Usage
71
-
72
- ### Initial Setup
73
- Run the tool directly via `npx` without prior installation:
74
-
75
- ```bash
76
- npx sdd-toolkit
77
- ```
78
-
79
- ### View Project Dashboard
80
- Check your current project status:
81
-
82
- ```bash
83
- sdd-toolkit view
84
- ```
85
-
86
- ### Upgrade Existing Installation
87
- Update installed agents without reconfiguration:
88
-
89
- ```bash
90
- sdd-toolkit upgrade
91
- ```
92
-
93
- ### Global Installation
94
- Or install globally:
95
-
96
- ```bash
97
- npm install -g sdd-toolkit
98
- sdd-toolkit
99
- ```
100
-
101
- ## How it Works
102
-
103
- 1. **Initialization:** The wizard detects your tools and sets up the hidden `.sdd-toolkit/` context folder.
104
- 2. **Agent Building:** Reads the agent definitions (YAML) and compiles them into your AI tool's native format.
105
- 3. **Execution:** Interact with agents using simplified commands (e.g., `/project`, `/coder`, `/feature`).
106
-
107
- ## Development Workflow
108
-
109
- The sdd-toolkit provides a structured workflow with specialized agents:
110
-
111
- ### 1. Define Project
112
- - Command: `/project`
113
- - Creates `.sdd-toolkit/project.md` with project scope and principles.
114
-
115
- ### 2. Define Requirements
116
- - Command: `/requirements`
117
- - Analyzes your stack and creates `.sdd-toolkit/requirements.md`.
118
-
119
- ### 3. Plan Features
120
- - Command: `/feature`
121
- - Creates `.sdd-toolkit/features/[name].md` with milestones and tasks.
122
-
123
- ### 4. Implement Code
124
- - Command: `/coder [task-id]`
125
- - Implements tasks from feature plan and logs work.
126
-
127
- ### 5. Review Code
128
- - Command: `/review [task-id]`
129
- - QA Engineer reviews implementation against requirements.
130
-
131
- ### 6. Release
132
- - Command: `/log` or `/dev:release`
133
- - Consolidates logs into changelog and archives completed work.
134
-
135
- ## AI Tool Commands
136
-
137
- Once agents are installed, use these commands in your AI coding assistant:
138
-
139
- ### Access Agents
140
- - **`/sdd`** - Display available agents and help
141
- - **`/sdd.project`** - Activate Project Architect
142
- - **`/sdd.requirements`** - Activate Requirements Engineer
143
- - **`/sdd.feature`** - Activate Feature Manager
144
- - **`/sdd.coder`** - Activate Coder
145
- - **`/sdd.review`** - Activate QA Engineer
146
- - **`/sdd.log`** - Activate Release Manager
147
-
148
- ### Special Commands
149
- - **`/dev:review [Task_ID]`** - Trigger code review for a specific task
150
- - **`/dev:release`** - Consolidate logs and create changelog
151
-
152
- ## Generated Files Structure
153
-
154
- After running `sdd-toolkit`, the following structure is created in your project:
155
-
156
- ```
157
- .sdd-toolkit/
158
- ├── project.md # Project scope and principles
159
- ├── requirements.md # Technical requirements and stack
160
- ├── guidelines.md # Project development guidelines
161
- ├── milestones.md # Development roadmap
162
- ├── task.md # Task execution backlog
163
- ├── features/ # Individual feature specifications
164
- │ └── [feature-name].md
165
- ├── logs/
166
- │ ├── executions/ # Task execution logs
167
- │ ├── reviews/ # Code review reports
168
- │ └── archive/ # Archived completed work
169
- └── agents/ # Custom agent definitions (optional overrides)
170
- ```
171
-
172
- ## Project Structure
173
-
174
- - `definitions/`: YAML agent definitions
175
- - `templates/`: Documentation templates
176
- - `src/`: CLI source code
177
-
178
- ## Usage Examples
179
-
180
- ### Complete Workflow: New Feature
181
-
182
- 1. **Define project:**
183
- ```
184
- /sdd.project
185
- ```
186
- Creates `.sdd-toolkit/project.md` with scope and principles.
187
-
188
- 2. **Define technical requirements:**
189
- ```
190
- /sdd.requirements
191
- ```
192
- Analyzes your `package.json`/`go.mod` and creates `.sdd-toolkit/requirements.md`.
193
-
194
- 3. **Plan a new feature:**
195
- ```
196
- /sdd.feature
197
- ```
198
- Specify your feature (e.g., "Add user authentication"). Creates `.sdd-toolkit/features/auth.md`.
199
-
200
- 4. **Implement tasks:**
201
- ```
202
- /sdd.coder MT01-task-1
203
- ```
204
- Coder implements task following SOLID principles and logs work.
205
-
206
- 5. **Review implementation:**
207
- ```
208
- /sdd.review MT01-task-1
209
- ```
210
- QA Engineer validates implementation against requirements.
211
-
212
- 6. **Release changes:**
213
- ```
214
- /sdd.log
215
- ```
216
- Consolidates logs into changelog and archives completed work.
217
-
218
- ### Quick Bug Fix
219
-
220
- 1. **Use Coder directly:**
221
- ```
222
- /sdd.coder fix-login-bug
223
- ```
224
- Coder analyzes, fixes, and documents change.
225
-
226
- 2. **Review fix:**
227
- ```
228
- /sdd.review fix-login-bug
229
- ```
230
- Validates that fix meets requirements.
231
-
232
- ## License
233
-
234
- MIT
235
-
236
- ---
237
-
238
- **Nota:** Uma versão em português deste README está disponível em [README.pt.md](README.pt.md).
239
-
240
- ## Troubleshooting
241
-
242
- ### Agents not appearing in your AI tool
243
-
244
- **Problem:** After running `sdd-toolkit`, agents don't appear in your AI coding assistant.
245
-
246
- **Solutions:**
247
- - **Roo Code/Cline:** Check if you've configured Custom Modes in your settings. See the warning message after installation.
248
- - **Cursor:** Restart the IDE after installation.
249
- - **OpenCode:** Refresh the command palette.
250
- - **Gemini CLI:** Verify `.gemini/commands/dev/` folder exists with `.toml` files.
251
-
252
- ### Permission denied when running sdd-toolkit
253
-
254
- **Problem:** Getting "Permission denied" or EACCES error when running `npx sdd-toolkit`.
255
-
256
- **Solutions:**
257
- - **Option 1:** Run with elevated permissions (not recommended):
258
- ```bash
259
- sudo npx sdd-toolkit
260
- ```
261
- - **Option 2:** Fix npm permissions:
262
- ```bash
263
- npm config set prefix ~/.npm-global
264
- export PATH=~/.npm-global/bin:$PATH
265
- ```
266
- - **Option 3:** Install globally with sudo:
267
- ```bash
268
- sudo npm install -g sdd-toolkit
269
- ```
270
-
271
- ### Agents responding in wrong language
272
-
273
- **Problem:** Agents are not responding in your preferred language.
274
-
275
- **Solution:**
276
- - Re-run `sdd-toolkit` and ensure you select the correct language during setup (English, Portuguese, or Spanish).
277
- - Or manually edit the `LANGUAGE_RULES` in your agent files.
278
-
279
- ### Stack profile not applying rules
280
-
281
- **Problem:** Selected stack profile rules are not being used by agents.
282
-
283
- **Solution:**
284
- - The stack profile is only applied during initial installation or upgrade. Run:
285
- ```bash
286
- sdd-toolkit upgrade
287
- ```
288
- Ensure you select the same stack profile again.
289
-
290
- ### `.sdd-toolkit/` folder not created
291
-
292
- **Problem:** The hidden folder structure is not created after installation.
293
-
294
- **Solutions:**
295
- - Check that you're running the command from your project's root directory (where `package.json` is located).
296
- - Verify write permissions in the directory.
297
- - Check for error messages during installation.
298
-
299
- ## Frequently Asked Questions
300
-
301
- **Q: Can I use multiple AI assistants simultaneously?**
302
-
303
- A: Yes! You can install agents for multiple AI tools in the same project. Each tool has its own folder structure (`.roo/`, `.cline/`, `.cursor/`, etc.) and they can coexist without conflicts.
304
-
305
- **Q: How do I update agents after initial setup?**
306
-
307
- A: Run `sdd-toolkit upgrade`. This will update all installed agents without requiring you to reconfigure your stack profile or global rules.
308
-
309
- **Q: Can I customize agent definitions?**
310
-
311
- A: Yes! Create custom YAML files in `.sdd-toolkit/agents/` folder. The toolkit will use your custom versions instead of the default ones. You can copy and modify the default definitions from the `definitions/` folder in the toolkit.
312
-
313
- **Q: What happens if I run `sdd-toolkit` multiple times?**
314
-
315
- A: The tool is idempotent - running it again will only update or regenerate missing files without duplicating existing configurations. Your existing project docs in `.sdd-toolkit/` will be preserved.
316
-
317
- **Q: Can I use this with projects that already have existing code?**
318
-
319
- A: Yes! The "Requirements Engineer" agent can analyze your existing `package.json`, `go.mod`, or `requirements.txt` to auto-detect your stack. The "Project Architect" can also formalize existing projects in "hybrid" mode.
320
-
321
- **Q: Do I need to commit `.sdd-toolkit/` to my repository?**
322
-
323
- A: Yes, it's recommended. The `.sdd-toolkit/` folder contains your project documentation, specifications, and agent configurations. Committing them ensures consistency across your team and preserves context for future sessions.
324
-
325
- **Q: How do I remove sdd-toolkit from my project?**
326
-
327
- A: Simply delete the `.sdd-toolkit/` folder and any tool-specific folders (`.roo/`, `.cline/`, `.cursor/`, etc.). These are all generated files and won't affect your source code.
328
-
329
- **Q: Are my code changes tracked by sdd-toolkit?**
330
-
331
- A: No, sdd-toolkit only manages documentation and AI agent configurations. It does not track code changes, read your source files, or interfere with version control.
332
-
333
- **Q: Can I add my own stack profiles?**
334
-
335
- A: Currently, stack profiles are hardcoded in the toolkit. To add a custom profile, you can use the "Global Rules" feature during setup to inject your own conventions, or you can fork the repository and add your profile to `src/lib/profiles.js`.
336
-
337
- **Q: Is this suitable for enterprise projects?**
338
-
339
- A: Yes, sdd-toolkit is designed to scale. The `.sdd-toolkit/` folder can be committed to your repository, ensuring all team members use the same agent configurations and follow the same development principles defined in `guidelines.md`.
1
+ # sdd-toolkit (Universal Spec CLI)
2
+
3
+ ![npm version](https://img.shields.io/npm/v/sdd-toolkit)
4
+ ![License: MIT](https://img.shields.io/npm/l/sdd-toolkit)
5
+ ![Downloads](https://img.shields.io/npm/dm/sdd-toolkit)
6
+
7
+ CLI tool to automatically set up the development environment and install AI agents (Auditor, Coder, etc.) for various modern AI tools.
8
+
9
+ ## Overview
10
+
11
+ **sdd-toolkit** is an "AI Agent Package Manager". It defines a standard squad of AI Developers and installs them directly into the context of your favorite AI Coding Assistant (such as Gemini, Roo Code, Kilo Code, OpenCode).
12
+
13
+ The main idea is to stop creating prompts from scratch and install a proven, structured workflow.
14
+
15
+ ## 📑 Table of Contents
16
+
17
+ - [Overview](#overview)
18
+ - [Key Features](#-key-features)
19
+ - [The Squad](#-the-squad-agent-roles)
20
+ - [Installation and Usage](#installation-and-usage)
21
+ - [How it Works](#how-it-works)
22
+ - [Development Workflow](#development-workflow)
23
+ - [AI Tool Commands](#ai-tool-commands)
24
+ - [Generated Files Structure](#generated-files-structure)
25
+ - [Usage Examples](#usage-examples)
26
+ - [Troubleshooting](#troubleshooting)
27
+ - [FAQ](#-frequently-asked-questions)
28
+ - [Project Structure](#project-structure)
29
+ - [License](#license)
30
+
31
+ ## 🚀 Key Features
32
+
33
+ ### 1. Smart & Agile Workflow
34
+
35
+ - **Hybrid Flow:** Supports both "Waterfall" planning (for new projects) and "Agile" execution (for hotfixes/features).
36
+ - **Smart Context:** Agents automatically scan your `package.json`, `go.mod`, or `requirements.txt` to understand your stack. No more explaining "I use React" every time.
37
+ - **Unified Memory:** All context is stored in a hidden `.sdd-toolkit/` folder, keeping your root directory clean.
38
+
39
+ ### 2. Multi-Language Support
40
+
41
+ The toolkit supports English, Portuguese (Brazil), and Spanish. Agents automatically adapt their responses to your preferred language.
42
+
43
+ ### 3. AI Agent Installation
44
+
45
+ Reads agnostic definitions (YAML) and converts them to specific formats:
46
+
47
+ - **Gemini CLI:** Generates `.toml` configuration files.
48
+ - **Roo Code:** Generates agents in `.roo/commands/*.md`.
49
+ - **Cline:** Generates custom modes (`_custom_modes.json`) and context rules in `.cline/`.
50
+ - **GitHub Copilot:** Generates instructions in `.github/prompts.md` and agents in `.github/prompts/*.md`.
51
+ - **Cursor:** Generates rules in `.cursor/commands/*.mdc`.
52
+ - **Windsurf:** Generates workflows in `.windsurf/workflows/*.md`.
53
+ - **Trae:** Generates instructions in `.trae/instructions.md`.
54
+ - **OpenCode:** Generates agents in `.opencode/commands/*.md`.
55
+ - **Kilo Code:** Generates Markdown prompts (`.kilocode/workflows/*.md`).
56
+
57
+ ## 👥 The Squad (Agent Roles)
58
+
59
+ The system installs a team of specialized agents:
60
+
61
+ ### 🏗️ Strategic Agents
62
+
63
+ - **@Project Architect:** Defines the scope and principles.
64
+ - **@Requirements Engineer:** Defines the tech stack (Auto-detected).
65
+
66
+ ### Execution Agents
67
+
68
+ - **@Feature Manager:** Manages features, milestones, and tasks.
69
+ - **@Coder:** The senior developer. Implements code following SOLID principles.
70
+
71
+ ### 🛡️ Quality Agents
72
+
73
+ - **@QA Engineer:** Reviews code against the spec.
74
+ - **@Release Manager:** Consolidates logs and manages the changelog.
75
+ - **@SDD Helper:** Provides access to all agents and help.
76
+
77
+ ## Installation and Usage
78
+
79
+ ### Initial Setup
80
+
81
+ Run the tool directly via `npx` without prior installation:
82
+
83
+ ```bash
84
+ npx sdd-toolkit
85
+ ```
86
+
87
+ ### View Project Dashboard
88
+
89
+ Check your current project status:
90
+
91
+ ```bash
92
+ sdd-toolkit view
93
+ ```
94
+
95
+ ### Upgrade Existing Installation
96
+
97
+ Update installed agents without reconfiguration:
98
+
99
+ ```bash
100
+ sdd-toolkit upgrade
101
+ ```
102
+
103
+ ### Global Installation
104
+
105
+ ### View Project Dashboard
106
+
107
+ Check your current project status:
108
+
109
+ ```bash
110
+ sdd-toolkit view
111
+ ```
112
+
113
+ ### Upgrade Existing Installation
114
+
115
+ Update installed agents without reconfiguration:
116
+
117
+ ```bash
118
+ sdd-toolkit upgrade
119
+ ```
120
+
121
+ ### Global Installation
122
+
123
+ Or install globally:
124
+
125
+ ```bash
126
+ npm install -g sdd-toolkit
127
+ sdd-toolkit
128
+ ```
129
+
130
+ ## How it Works
131
+
132
+ 1. **Initialization:** The wizard detects your tools and sets up the hidden `.sdd-toolkit/` context folder.
133
+ 2. **Agent Building:** Reads the agent definitions (YAML) and compiles them into your AI tool's native format.
134
+ 3. **Execution:** Interact with agents using simplified commands (e.g., `/project`, `/coder`, `/feature`).
135
+
136
+ ## Development Workflow
137
+
138
+ The sdd-toolkit provides a structured workflow with specialized agents:
139
+
140
+ ### 1. Define Project
141
+
142
+ - Command: `/project`
143
+ - Creates `.sdd-toolkit/project.md` with project scope and principles.
144
+
145
+ ### 2. Define Requirements
146
+
147
+ - Command: `/requirements`
148
+ - Analyzes your stack and creates `.sdd-toolkit/requirements.md`.
149
+
150
+ ### 3. Plan Features
151
+
152
+ - Command: `/feature`
153
+ - Creates `.sdd-toolkit/features/[name].md` with milestones and tasks.
154
+
155
+ ### 4. Implement Code
156
+
157
+ - Command: `/coder [task-id]`
158
+ - Implements tasks from feature plan and logs work.
159
+
160
+ ### 5. Review Code
161
+
162
+ - Command: `/review [task-id]`
163
+ - QA Engineer reviews implementation against requirements.
164
+
165
+ ### 6. Release
166
+
167
+ - Command: `/log` or `/dev:release`
168
+ - Consolidates logs into changelog and archives completed work.
169
+
170
+ ## AI Tool Commands
171
+
172
+ Once agents are installed, use these commands in your AI coding assistant:
173
+
174
+ ### Access Agents
175
+
176
+ - **`/sdd`** - Display available agents and help
177
+ - **`/sdd.project`** - Activate Project Architect
178
+ - **`/sdd.requirements`** - Activate Requirements Engineer
179
+ - **`/sdd.feature`** - Activate Feature Manager
180
+ - **`/sdd.coder`** - Activate Coder
181
+ - **`/sdd.review`** - Activate QA Engineer
182
+ - **`/sdd.log`** - Activate Release Manager
183
+
184
+ ### Special Commands
185
+
186
+ - **`/dev:review [Task_ID]`** - Trigger code review for a specific task
187
+ - **`/dev:release`** - Consolidate logs and create changelog
188
+
189
+ ## Generated Files Structure
190
+
191
+ After running `sdd-toolkit`, the following structure is created in your project:
192
+
193
+ ```
194
+ .sdd-toolkit/
195
+ ├── project.md # Project scope and principles
196
+ ├── requirements.md # Technical requirements and stack
197
+ ├── guidelines.md # Project development guidelines
198
+ ├── milestones.md # Development roadmap
199
+ ├── task.md # Task execution backlog
200
+ ├── features/ # Individual feature specifications
201
+ └── [feature-name].md
202
+ ├── logs/
203
+ ├── executions/ # Task execution logs
204
+ ├── reviews/ # Code review reports
205
+ │ └── archive/ # Archived completed work
206
+ └── agents/ # Custom agent definitions (optional overrides)
207
+ ```
208
+
209
+ ## Project Structure
210
+
211
+ - `definitions/`: YAML agent definitions
212
+ - `templates/`: Documentation templates
213
+ - `src/`: CLI source code
214
+
215
+ ## Usage Examples
216
+
217
+ ### Complete Workflow: New Feature
218
+
219
+ 1. **Define project:**
220
+
221
+ ```
222
+ /sdd.project
223
+ ```
224
+
225
+ Creates `.sdd-toolkit/project.md` with scope and principles.
226
+
227
+ 2. **Define technical requirements:**
228
+
229
+ ```
230
+ /sdd.requirements
231
+ ```
232
+
233
+ Analyzes your `package.json`/`go.mod` and creates `.sdd-toolkit/requirements.md`.
234
+
235
+ 3. **Plan a new feature:**
236
+
237
+ ```
238
+ /sdd.feature
239
+ ```
240
+
241
+ Specify your feature (e.g., "Add user authentication"). Creates `.sdd-toolkit/features/auth.md`.
242
+
243
+ 4. **Implement tasks:**
244
+
245
+ ```
246
+ /sdd.coder MT01-task-1
247
+ ```
248
+
249
+ Coder implements task following SOLID principles and logs work.
250
+
251
+ 5. **Review implementation:**
252
+
253
+ ```
254
+ /sdd.review MT01-task-1
255
+ ```
256
+
257
+ QA Engineer validates implementation against requirements.
258
+
259
+ 6. **Release changes:**
260
+ ```
261
+ /sdd.log
262
+ ```
263
+ Consolidates logs into changelog and archives completed work.
264
+
265
+ ### Quick Bug Fix
266
+
267
+ 1. **Use Coder directly:**
268
+
269
+ ```
270
+ /sdd.coder fix-login-bug
271
+ ```
272
+
273
+ Coder analyzes, fixes, and documents change.
274
+
275
+ 2. **Review fix:**
276
+ ```
277
+ /sdd.review fix-login-bug
278
+ ```
279
+ Validates that fix meets requirements.
280
+
281
+ ## License
282
+
283
+ MIT
284
+
285
+ ---
286
+
287
+ **Nota:** Uma versão em português deste README está disponível em [README.pt.md](README.pt.md).
288
+
289
+ ## Troubleshooting
290
+
291
+ ### Agents not appearing in your AI tool
292
+
293
+ **Problem:** After running `sdd-toolkit`, agents don't appear in your AI coding assistant.
294
+
295
+ **Solutions:**
296
+
297
+ - **Roo Code/Cline:** Check if you've configured Custom Modes in your settings. See the warning message after installation.
298
+ - **Cursor:** Restart the IDE after installation.
299
+ - **OpenCode:** Refresh the command palette.
300
+ - **Gemini CLI:** Verify `.gemini/commands/dev/` folder exists with `.toml` files.
301
+
302
+ ### Permission denied when running sdd-toolkit
303
+
304
+ **Problem:** Getting "Permission denied" or EACCES error when running `npx sdd-toolkit`.
305
+
306
+ **Solutions:**
307
+
308
+ - **Option 1:** Run with elevated permissions (not recommended):
309
+ ```bash
310
+ sudo npx sdd-toolkit
311
+ ```
312
+ - **Option 2:** Fix npm permissions:
313
+ ```bash
314
+ npm config set prefix ~/.npm-global
315
+ export PATH=~/.npm-global/bin:$PATH
316
+ ```
317
+ - **Option 3:** Install globally with sudo:
318
+ ```bash
319
+ sudo npm install -g sdd-toolkit
320
+ ```
321
+
322
+ ### Agents responding in wrong language
323
+
324
+ **Problem:** Agents are not responding in your preferred language.
325
+
326
+ **Solution:**
327
+
328
+ - Re-run `sdd-toolkit` and ensure you select the correct language during setup (English, Portuguese, or Spanish).
329
+ - Or manually edit the `LANGUAGE_RULES` in your agent files.
330
+
331
+ ### Stack profile not applying rules
332
+
333
+ **Problem:** Selected stack profile rules are not being used by agents.
334
+
335
+ **Solution:**
336
+
337
+ - The stack profile is only applied during initial installation or upgrade. Run:
338
+ ```bash
339
+ sdd-toolkit upgrade
340
+ ```
341
+ Ensure you select the same stack profile again.
342
+
343
+ ### `.sdd-toolkit/` folder not created
344
+
345
+ **Problem:** The hidden folder structure is not created after installation.
346
+
347
+ **Solutions:**
348
+
349
+ - Check that you're running the command from your project's root directory (where `package.json` is located).
350
+ - Verify write permissions in the directory.
351
+ - Check for error messages during installation.
352
+
353
+ ## ❓ Frequently Asked Questions
354
+
355
+ **Q: Can I use multiple AI assistants simultaneously?**
356
+
357
+ A: Yes! You can install agents for multiple AI tools in the same project. Each tool has its own folder structure (`.roo/`, `.cline/`, `.cursor/`, etc.) and they can coexist without conflicts.
358
+
359
+ **Q: How do I update agents after initial setup?**
360
+
361
+ A: Run `sdd-toolkit upgrade`. This will update all installed agents without requiring you to reconfigure your stack profile or global rules.
362
+
363
+ **Q: Can I customize agent definitions?**
364
+
365
+ A: Yes! Create custom YAML files in `.sdd-toolkit/agents/` folder. The toolkit will use your custom versions instead of the default ones. You can copy and modify the default definitions from the `definitions/` folder in the toolkit.
366
+
367
+ **Q: What happens if I run `sdd-toolkit` multiple times?**
368
+
369
+ A: The tool is idempotent - running it again will only update or regenerate missing files without duplicating existing configurations. Your existing project docs in `.sdd-toolkit/` will be preserved.
370
+
371
+ **Q: Can I use this with projects that already have existing code?**
372
+
373
+ A: Yes! The "Requirements Engineer" agent can analyze your existing `package.json`, `go.mod`, or `requirements.txt` to auto-detect your stack. The "Project Architect" can also formalize existing projects in "hybrid" mode.
374
+
375
+ **Q: Do I need to commit `.sdd-toolkit/` to my repository?**
376
+
377
+ A: Yes, it's recommended. The `.sdd-toolkit/` folder contains your project documentation, specifications, and agent configurations. Committing them ensures consistency across your team and preserves context for future sessions.
378
+
379
+ **Q: How do I remove sdd-toolkit from my project?**
380
+
381
+ A: Simply delete the `.sdd-toolkit/` folder and any tool-specific folders (`.roo/`, `.cline/`, `.cursor/`, etc.). These are all generated files and won't affect your source code.
382
+
383
+ **Q: Are my code changes tracked by sdd-toolkit?**
384
+
385
+ A: No, sdd-toolkit only manages documentation and AI agent configurations. It does not track code changes, read your source files, or interfere with version control.
386
+
387
+ **Q: Can I add my own stack profiles?**
388
+
389
+ A: Currently, stack profiles are hardcoded in the toolkit. To add a custom profile, you can use the "Global Rules" feature during setup to inject your own conventions, or you can fork the repository and add your profile to `src/lib/profiles.js`.
390
+
391
+ **Q: Is this suitable for enterprise projects?**
392
+
393
+ A: Yes, sdd-toolkit is designed to scale. The `.sdd-toolkit/` folder can be committed to your repository, ensuring all team members use the same agent configurations and follow the same development principles defined in `guidelines.md`.