sdd-toolkit 1.6.0 → 1.9.0
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 +262 -62
- package/README.pt.md +320 -121
- package/definitions/{project.yaml → sdd-project.yaml} +32 -12
- package/definitions/sdd.yaml +7 -8
- package/package.json +42 -41
- package/src/index.js +106 -75
- package/src/lib/transformers.js +12 -12
- package/templates/milestones.md +0 -14
- /package/definitions/{coder.yaml → sdd-coder.yaml} +0 -0
- /package/definitions/{feature.yaml → sdd-feature.yaml} +0 -0
- /package/definitions/{log.yaml → sdd-log.yaml} +0 -0
- /package/definitions/{requirements.yaml → sdd-requirements.yaml} +0 -0
- /package/definitions/{review.yaml → sdd-review.yaml} +0 -0
package/README.pt.md
CHANGED
|
@@ -1,135 +1,334 @@
|
|
|
1
|
-
# sdd-toolkit (CLI de Especificação Universal)
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
A ideia principal é parar de criar prompts do zero e instalar um workflow comprovado e estruturado.
|
|
10
|
-
|
|
11
|
-
## 🚀 Recursos Principais
|
|
12
|
-
|
|
13
|
-
### 1. Workflow Inteligente e Ágil
|
|
14
|
-
- **Fluxo Híbrido:** Suporta planejamento "Waterfall" (para novos projetos) e execução "Agile" (para hotfixes).
|
|
15
|
-
- **Contexto Inteligente:** Os agentes escaneiam automaticamente seu `package.json`, `go.mod`, ou `requirements.txt` para entender sua stack. Não mais explicar "Eu uso React" toda vez.
|
|
16
|
-
- **Memória Unificada:** Todo contexto é armazenado em uma pasta oculta `.sdd-toolkit/`, mantendo sua raiz limpa.
|
|
17
|
-
|
|
18
|
-
### 2. "Comandos de Potência"
|
|
19
|
-
Os agentes vêm equipados com modos de execução especiais acionados por comandos:
|
|
20
|
-
- **`/sdd`**: Acesso a ajuda e lista de todos os agentes disponíveis.
|
|
21
|
-
- **`/flow:debug`**: Cole um log de erro e o Coder entra no "Modo Cirúrgico" para corrigir imediatamente.
|
|
22
|
-
- **`/flow:tdd`**: Força o ciclo Red-Green-Refactor para código de alta qualidade.
|
|
23
|
-
- **`/flow:refactor`**: Aplica princípios de Clean Code a um arquivo existente.
|
|
24
|
-
- **`/flow:gen-tests`**: Gera automaticamente testes unitários para seu código.
|
|
25
|
-
- **`/flow:security`**: Escaneia seu código/plano em busca de vulnerabilidades (OWASP).
|
|
26
|
-
- **`/flow:sync`**: Atualiza a documentação (`project.md`) para corresponder ao código real (Engenharia Reversa).
|
|
1
|
+
# sdd-toolkit (CLI de Especificação Universal)
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
CLI tool para configurar automaticamente o ambiente de desenvolvimento e instalar agentes de IA (Auditor, Coder, etc.) para várias ferramentas modernas de IA.
|
|
27
8
|
|
|
28
|
-
|
|
29
|
-
|
|
9
|
+
## Visão Geral
|
|
10
|
+
|
|
11
|
+
**sdd-toolkit** é um "Gerenciador de Pacotes de Agentes de IA". Ele define uma equipe padrão de Desenvolvedores de IA e os instala diretamente no contexto de sua assistente de codificação de IA favorita (como Gemini, Roo Code, Kilo Code, OpenCode).
|
|
12
|
+
|
|
13
|
+
A ideia principal é parar de criar prompts do zero e instalar um workflow comprovado e estruturado.
|
|
14
|
+
|
|
15
|
+
## 📑 Índice
|
|
16
|
+
|
|
17
|
+
- [Visão Geral](#visão-geral)
|
|
18
|
+
- [Recursos Principais](#-recursos-principais)
|
|
19
|
+
- [A Equipe](#-a-equipe-funções-dos-agentes)
|
|
20
|
+
- [Instalação e Uso](#instalação-e-uso)
|
|
21
|
+
- [Como Funciona](#como-funciona)
|
|
22
|
+
- [Fluxo de Desenvolvimento](#fluxo-de-desenvolvimento)
|
|
23
|
+
- [Comandos nas Ferramentas de IA](#comandos-nas-ferramentas-de-ia)
|
|
24
|
+
- [Estrutura de Arquivos Gerados](#estrutura-de-arquivos-gerados)
|
|
25
|
+
- [Exemplos de Uso](#exemplos-de-uso)
|
|
26
|
+
- [Solução de Problemas](#solução-de-problemas)
|
|
27
|
+
- [Perguntas Frequentes](#-perguntas-frequentes)
|
|
28
|
+
- [Estrutura do Projeto](#estrutura-do-projeto)
|
|
29
|
+
- [Licença](#licença)
|
|
30
|
+
|
|
31
|
+
## 🚀 Recursos Principais
|
|
32
|
+
|
|
33
|
+
### 1. Workflow Inteligente e Ágil
|
|
34
|
+
- **Fluxo Híbrido:** Suporta planejamento "Waterfall" (para novos projetos) e execução "Agile" (para hotfixes).
|
|
35
|
+
- **Contexto Inteligente:** Os agentes escaneiam automaticamente seu `package.json`, `go.mod`, ou `requirements.txt` para entender sua stack. Não mais explicar "Eu uso React" toda vez.
|
|
36
|
+
- **Memória Unificada:** Todo contexto é armazenado em uma pasta oculta `.sdd-toolkit/`, mantendo sua raiz limpa.
|
|
37
|
+
|
|
38
|
+
### 2. Suporte Multi-Idiomas
|
|
39
|
+
O toolkit suporta Inglês, Português (Brasil) e Espanhol. Os agentes adaptam automaticamente suas respostas ao idioma preferido.
|
|
40
|
+
|
|
41
|
+
### 3. Instalação de Agentes de IA
|
|
42
|
+
Lê definições agnósticas (YAML) e as converte para formatos específicos:
|
|
30
43
|
- **Gemini CLI:** Gera arquivos de configuração `.toml`.
|
|
31
|
-
- **Roo Code
|
|
32
|
-
- **
|
|
33
|
-
- **
|
|
34
|
-
- **
|
|
35
|
-
- **
|
|
36
|
-
- **
|
|
37
|
-
- **
|
|
44
|
+
- **Roo Code:** Gera agentes em `.roo/commands/*.md`.
|
|
45
|
+
- **Cline:** Gera modos customizados (`_custom_modes.json`) e regras de contexto em `.cline/`.
|
|
46
|
+
- **GitHub Copilot:** Gera instruções em `.github/prompts.md` e agentes em `.github/prompts/*.md`.
|
|
47
|
+
- **Cursor:** Gera regras em `.cursor/commands/*.mdc`.
|
|
48
|
+
- **Windsurf:** Gera workflows em `.windsurf/workflows/*.md`.
|
|
49
|
+
- **Trae:** Gera instruções em `.trae/instructions.md`.
|
|
50
|
+
- **OpenCode:** Gera agentes em `.opencode/commands/*.md`.
|
|
51
|
+
- **Kilo Code:** Gera prompts Markdown (`.kilocode/workflows/*.md`).
|
|
38
52
|
|
|
39
53
|
## 👥 A Equipe (Funções dos Agentes)
|
|
40
54
|
|
|
41
55
|
O sistema instala uma equipe de agentes especializados:
|
|
42
56
|
|
|
43
|
-
### 🏗️ Agentes Estratégicos
|
|
44
|
-
- **@
|
|
45
|
-
- **@
|
|
46
|
-
- **@Gerenciadores de Marcos:** Cria o roadmap.
|
|
47
|
-
|
|
48
|
-
### ⚡ Agentes de Execução
|
|
49
|
-
- **@Planejadores de Tarefas:** Quebra marcos em tarefas atômicas.
|
|
50
|
-
- **@Gerenciadores de Recursos:** O ponto de entrada ágil. Trata solicitações como "Adicionar Login Google" e decide o melhor caminho (Hotfix vs Milestone).
|
|
51
|
-
- **@Codificadores:** O desenvolvedor sênior. Suporta modos TDD, Debug, Refactor e Geração de Testes.
|
|
52
|
-
|
|
53
|
-
### 🛡️ Agentes de Qualidade
|
|
54
|
-
- **@Auditores:** Verifica consistência entre requisitos e tarefas.
|
|
55
|
-
- **@QA Engineers:** Revisa código contra a especificação.
|
|
56
|
-
- **@DevOps Engineers:** Trata Docker, CI/CD e Configs.
|
|
57
|
-
- **@Gerenciadores de Releases:** Consolida logs e gerencia o changelog.
|
|
58
|
-
|
|
59
|
-
## Instalação e Uso
|
|
60
|
-
|
|
61
|
-
Você pode executar a ferramenta diretamente via `npx` sem instalação prévia:
|
|
62
|
-
|
|
63
|
-
```bash
|
|
64
|
-
npx sdd-toolkit
|
|
65
|
-
```
|
|
57
|
+
### 🏗️ Agentes Estratégicos
|
|
58
|
+
- **@Arquiteto de Projeto:** Define o escopo e princípios.
|
|
59
|
+
- **@Engenheiro de Requisitos:** Define a stack técnica (Auto-detectada).
|
|
66
60
|
|
|
67
|
-
|
|
61
|
+
### ⚡ Agentes de Execução
|
|
62
|
+
- **@Gerente de Features:** Gerencia features, marcos e tarefas.
|
|
63
|
+
- **@Codificador:** O desenvolvedor sênior. Implementa código seguindo princípios SOLID.
|
|
64
|
+
|
|
65
|
+
### 🛡️ Agentes de Qualidade
|
|
66
|
+
- **@QA Engineer:** Revisa código contra a especificação.
|
|
67
|
+
- **@Gerente de Releases:** Consolida logs e gerencia o changelog.
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
69
|
+
## Instalação e Uso
|
|
70
|
+
|
|
71
|
+
### Configuração Inicial
|
|
72
|
+
Execute a ferramenta diretamente via `npx` sem instalação prévia:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npx sdd-toolkit
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Ver o Dashboard do Projeto
|
|
79
|
+
Verifique o status atual do seu projeto:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
sdd-toolkit view
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Atualizar Instalação Existente
|
|
86
|
+
Atualize os agentes instalados sem reconfiguração:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
sdd-toolkit upgrade
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Instalação Global
|
|
93
|
+
Ou instale globalmente:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm install -g sdd-toolkit
|
|
97
|
+
sdd-toolkit
|
|
98
|
+
```
|
|
73
99
|
|
|
74
100
|
## Como Funciona
|
|
75
101
|
|
|
76
102
|
1. **Inicialização:** O assistente detecta suas ferramentas e configura a pasta de contexto oculta `.sdd-toolkit/`.
|
|
77
|
-
2. **Construção de Agentes:** Lê
|
|
78
|
-
3. **Execução:**
|
|
79
|
-
|
|
80
|
-
## Fluxo Completo de Desenvolvimento
|
|
81
|
-
|
|
82
|
-
O sdd-toolkit implementa um **fluxo de trabalho híbrido unificado** que se adapta às suas necessidades, combinando planejamento estruturado para novos projetos com execução ágil para correções rápidas. Ele garante rastreabilidade, justificativa e qualidade através de colaboração IA-humana.
|
|
83
|
-
|
|
84
|
-
### Visão Geral do Fluxo Híbrido Unificado
|
|
85
|
-
|
|
86
|
-
- **Iniciação Inteligente:** Comece com `/dev:start "Descrição"` para roteamento inteligente. O sistema verifica docs existentes e decide entre caminhos quick ou estruturados.
|
|
87
|
-
- **Planejamento Condicional:** Se necessário, escala para planejamento completo (Arquitetos de Projeto → Engenheiros de Requisitos → Gerenciadores de Marcos → Planejadores de Tarefas).
|
|
88
|
-
- **Execução Padronizada:** Codificadores implementam tarefas com logs, seguidos de validação unificada (QA e Auditores).
|
|
89
|
-
- **Finalização:** Gerenciadores de Releases consolidam em changelog com confirmação humana.
|
|
90
|
-
|
|
91
|
-
### Passos Detalhados do Fluxo
|
|
92
|
-
|
|
93
|
-
#### 1. Iniciação (Inteligente)
|
|
94
|
-
- Comando: `/start "Construir um sistema de login"`
|
|
95
|
-
- Ação: Arquitetos de Projeto verificam `.sdd-toolkit/project.md` existente.
|
|
96
|
-
- Se nenhum: Entra no modo de entrevista para o básico.
|
|
97
|
-
- Se existe: Confirma prosseguir ou reiniciar.
|
|
98
|
-
- Saída: Atualiza `project.md` com notas híbridas (ex.: pontos de aprovação).
|
|
99
|
-
|
|
100
|
-
#### 2. Planejamento (Condicional)
|
|
101
|
-
- Se hotfix: Gerenciadores de Recursos roteia diretamente para criação de tarefas.
|
|
102
|
-
- Se projeto: Gerenciadores de Marcos gera roadmap com aprovação humana.
|
|
103
|
-
- Comandos: `/requirements`, `/milestone`, `/tasks`.
|
|
104
|
-
- Saída: `requirements.md`, `milestones.md`, `task.md`.
|
|
105
|
-
|
|
106
|
-
#### 3. Execução (Padronizada)
|
|
107
|
-
- Comando: `/coder`
|
|
108
|
-
- Ação: Codificador lê contexto, implementa, registra logs em `executions/`, marca tarefas como concluídas.
|
|
109
|
-
- Modos: `/flow:debug`, `/flow:refactor`, `/flow:tdd`, etc.
|
|
110
|
-
- Saída: Mudanças no código + logs de execução.
|
|
111
|
-
|
|
112
|
-
#### 4. Validação (Unificada)
|
|
113
|
-
- Comando: `/review`
|
|
114
|
-
- Ação: QA revisa código, Auditores verificam consistência. Pausa para entrada humana em ambiguidades.
|
|
115
|
-
- Saída: Relatórios de revisão em `logs/reviews/`.
|
|
116
|
-
|
|
117
|
-
#### 5. Finalização (Com Confirmação)
|
|
118
|
-
- Comando: `/release` ou implícito após aprovação.
|
|
119
|
-
- Ação: Gerenciadores de Releases atualiza `changelog.md` e arquiva logs após confirmação humana.
|
|
120
|
-
- Saída: Changelog limpo e logs arquivados.
|
|
121
|
-
|
|
122
|
-
### Interações dos Agentes
|
|
123
|
-
Agentes compartilham contexto via arquivos `.sdd-toolkit/`, garantindo sem alucinações. Comandos de potência habilitam modos especializados. O fluxo promove justificativa (ex.: "Por que essa decisão?") e handoffs IA-humana para confiabilidade.
|
|
124
|
-
|
|
125
|
-
Para exemplos, veja os guias de workflow gerados em `.sdd-toolkit/`.
|
|
103
|
+
2. **Construção de Agentes:** Lê as definições dos agentes (YAML) e as compila no formato nativo da sua ferramenta de IA.
|
|
104
|
+
3. **Execução:** Interaja com os agentes usando comandos simplificados (ex.: `/project`, `/coder`, `/feature`).
|
|
126
105
|
|
|
127
|
-
##
|
|
128
|
-
|
|
129
|
-
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
106
|
+
## Fluxo de Desenvolvimento
|
|
107
|
+
|
|
108
|
+
O sdd-toolkit fornece um fluxo de trabalho estruturado com agentes especializados:
|
|
109
|
+
|
|
110
|
+
### 1. Definir Projeto
|
|
111
|
+
- Comando: `/project`
|
|
112
|
+
- Cria `.sdd-toolkit/project.md` com o escopo e princípios do projeto.
|
|
113
|
+
|
|
114
|
+
### 2. Definir Requisitos
|
|
115
|
+
- Comando: `/requirements`
|
|
116
|
+
- Analisa sua stack e cria `.sdd-toolkit/requirements.md`.
|
|
117
|
+
|
|
118
|
+
### 3. Planejar Features
|
|
119
|
+
- Comando: `/feature`
|
|
120
|
+
- Cria `.sdd-toolkit/features/[nome].md` com marcos e tarefas.
|
|
121
|
+
|
|
122
|
+
### 4. Implementar Código
|
|
123
|
+
- Comando: `/coder [task-id]`
|
|
124
|
+
- Implementa tarefas do plano de features e registra o trabalho.
|
|
125
|
+
|
|
126
|
+
### 5. Revisar Código
|
|
127
|
+
- Comando: `/review [task-id]`
|
|
128
|
+
- QA Engineer revisa a implementação contra os requisitos.
|
|
129
|
+
|
|
130
|
+
### 6. Release
|
|
131
|
+
- Comando: `/log` ou `/dev:release`
|
|
132
|
+
- Consolida logs no changelog e arquiva o trabalho concluído.
|
|
133
|
+
|
|
134
|
+
## Comandos nas Ferramentas de IA
|
|
135
|
+
|
|
136
|
+
Uma vez que os agentes estejam instalados, use estes comandos no seu assistente de codificação de IA:
|
|
137
|
+
|
|
138
|
+
### Acessar Agentes
|
|
139
|
+
- **`/sdd`** - Exibe os agentes disponíveis e ajuda
|
|
140
|
+
- **`/sdd.project`** - Ativa o Arquiteto de Projeto
|
|
141
|
+
- **`/sdd.requirements`** - Ativa o Engenheiro de Requisitos
|
|
142
|
+
- **`/sdd.feature`** - Ativa o Gerente de Features
|
|
143
|
+
- **`/sdd.coder`** - Ativa o Codificador
|
|
144
|
+
- **`/sdd.review`** - Ativa o QA Engineer
|
|
145
|
+
- **`/sdd.log`** - Ativa o Gerente de Releases
|
|
146
|
+
|
|
147
|
+
### Comandos Especiais
|
|
148
|
+
- **`/dev:review [Task_ID]`** - Aciona revisão de código para uma tarefa específica
|
|
149
|
+
- **`/dev:release`** - Consolida logs e cria changelog
|
|
150
|
+
|
|
151
|
+
## Estrutura de Arquivos Gerados
|
|
152
|
+
|
|
153
|
+
Após executar `sdd-toolkit`, a seguinte estrutura é criada em seu projeto:
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
.sdd-toolkit/
|
|
157
|
+
├── project.md # Escopo e princípios do projeto
|
|
158
|
+
├── requirements.md # Requisitos técnicos e stack
|
|
159
|
+
├── guidelines.md # Diretrizes de desenvolvimento do projeto
|
|
160
|
+
├── milestones.md # Roadmap de desenvolvimento
|
|
161
|
+
├── task.md # Backlog de execução de tarefas
|
|
162
|
+
├── features/ # Especificações individuais de features
|
|
163
|
+
│ └── [feature-name].md
|
|
164
|
+
├── logs/
|
|
165
|
+
│ ├── executions/ # Logs de execução de tarefas
|
|
166
|
+
│ ├── reviews/ # Relatórios de revisão de código
|
|
167
|
+
│ └── archive/ # Trabalho concluído arquivado
|
|
168
|
+
└── agents/ # Definições personalizadas de agentes (overrides opcionais)
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## Estrutura do Projeto
|
|
172
|
+
|
|
173
|
+
- `definitions/`: Definições YAML de agentes
|
|
174
|
+
- `templates/`: Modelos de documentação
|
|
175
|
+
- `src/`: Código fonte da CLI
|
|
176
|
+
|
|
177
|
+
## Exemplos de Uso
|
|
178
|
+
|
|
179
|
+
### Fluxo Completo: Nova Feature
|
|
180
|
+
|
|
181
|
+
1. **Definir projeto:**
|
|
182
|
+
```
|
|
183
|
+
/sdd.project
|
|
184
|
+
```
|
|
185
|
+
Cria `.sdd-toolkit/project.md` com escopo e princípios.
|
|
186
|
+
|
|
187
|
+
2. **Definir requisitos técnicos:**
|
|
188
|
+
```
|
|
189
|
+
/sdd.requirements
|
|
190
|
+
```
|
|
191
|
+
Analisa seu `package.json`/`go.mod` e cria `.sdd-toolkit/requirements.md`.
|
|
192
|
+
|
|
193
|
+
3. **Planejar uma nova feature:**
|
|
194
|
+
```
|
|
195
|
+
/sdd.feature
|
|
196
|
+
```
|
|
197
|
+
Especifique sua feature (ex: "Adicionar autenticação de usuário"). Cria `.sdd-toolkit/features/auth.md`.
|
|
198
|
+
|
|
199
|
+
4. **Implementar tarefas:**
|
|
200
|
+
```
|
|
201
|
+
/sdd.coder MT01-task-1
|
|
202
|
+
```
|
|
203
|
+
Codificador implementa a tarefa seguindo princípios SOLID e registra o trabalho.
|
|
204
|
+
|
|
205
|
+
5. **Revisar implementação:**
|
|
206
|
+
```
|
|
207
|
+
/sdd.review MT01-task-1
|
|
208
|
+
```
|
|
209
|
+
QA Engineer valida a implementação contra os requisitos.
|
|
210
|
+
|
|
211
|
+
6. **Release das mudanças:**
|
|
212
|
+
```
|
|
213
|
+
/sdd.log
|
|
214
|
+
```
|
|
215
|
+
Consolida logs no changelog e arquiva o trabalho concluído.
|
|
216
|
+
|
|
217
|
+
### Correção Rápida de Bug
|
|
218
|
+
|
|
219
|
+
1. **Usar Codificador diretamente:**
|
|
220
|
+
```
|
|
221
|
+
/sdd.coder fixar-bug-login
|
|
222
|
+
```
|
|
223
|
+
Codificador analisa, corrige e documenta a mudança.
|
|
224
|
+
|
|
225
|
+
2. **Revisar correção:**
|
|
226
|
+
```
|
|
227
|
+
/sdd.review fixar-bug-login
|
|
228
|
+
```
|
|
229
|
+
Valida que a correção atende os requisitos.
|
|
230
|
+
|
|
231
|
+
## Licença
|
|
232
|
+
|
|
233
|
+
MIT
|
|
234
|
+
|
|
235
|
+
## ❓ Solução de Problemas
|
|
236
|
+
|
|
237
|
+
### Agentes não aparecem na sua ferramenta de IA
|
|
238
|
+
|
|
239
|
+
**Problema:** Depois de executar `sdd-toolkit`, os agentes não aparecem no seu assistente de codificação de IA.
|
|
240
|
+
|
|
241
|
+
**Soluções:**
|
|
242
|
+
- **Roo Code/Cline:** Verifique se você configurou os Modos Personalizados nas configurações. Veja a mensagem de aviso após a instalação.
|
|
243
|
+
- **Cursor:** Reinicie a IDE após a instalação.
|
|
244
|
+
- **OpenCode:** Atualize o painel de comandos.
|
|
245
|
+
- **Gemini CLI:** Verifique se a pasta `.gemini/commands/dev/` existe com arquivos `.toml`.
|
|
246
|
+
|
|
247
|
+
### Erro de permissão ao executar sdd-toolkit
|
|
248
|
+
|
|
249
|
+
**Problema:** Recebendo "Permissão negada" ou erro EACCES ao executar `npx sdd-toolkit`.
|
|
250
|
+
|
|
251
|
+
**Soluções:**
|
|
252
|
+
- **Opção 1:** Execute com permissões elevadas (não recomendado):
|
|
253
|
+
```bash
|
|
254
|
+
sudo npx sdd-toolkit
|
|
255
|
+
```
|
|
256
|
+
- **Opção 2:** Corrija permissões do npm:
|
|
257
|
+
```bash
|
|
258
|
+
npm config set prefix ~/.npm-global
|
|
259
|
+
export PATH=~/.npm-global/bin:$PATH
|
|
260
|
+
```
|
|
261
|
+
- **Opção 3:** Instale globalmente com sudo:
|
|
262
|
+
```bash
|
|
263
|
+
sudo npm install -g sdd-toolkit
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Agentes respondendo no idioma errado
|
|
267
|
+
|
|
268
|
+
**Problema:** Os agentes não estão respondendo no seu idioma preferido.
|
|
269
|
+
|
|
270
|
+
**Solução:**
|
|
271
|
+
- Execute `sdd-toolkit` novamente e certifique-se de selecionar o idioma correto durante a configuração (Inglês, Português ou Espanhol).
|
|
272
|
+
- Ou edite manualmente o `LANGUAGE_RULES` nos arquivos dos seus agentes.
|
|
273
|
+
|
|
274
|
+
### Perfil de stack não aplicando regras
|
|
275
|
+
|
|
276
|
+
**Problema:** As regras do perfil de stack selecionado não estão sendo usadas pelos agentes.
|
|
277
|
+
|
|
278
|
+
**Solução:**
|
|
279
|
+
- O perfil de stack é aplicado apenas durante a instalação inicial ou upgrade. Execute:
|
|
280
|
+
```bash
|
|
281
|
+
sdd-toolkit upgrade
|
|
282
|
+
```
|
|
283
|
+
Certifique-se de selecionar o mesmo perfil de stack novamente.
|
|
284
|
+
|
|
285
|
+
### Pasta `.sdd-toolkit/` não criada
|
|
286
|
+
|
|
287
|
+
**Problema:** A estrutura de pastas ocultas não é criada após a instalação.
|
|
288
|
+
|
|
289
|
+
**Soluções:**
|
|
290
|
+
- Verifique se você está executando o comando a partir do diretório raiz do seu projeto (onde está o `package.json`).
|
|
291
|
+
- Verifique as permissões de escrita no diretório.
|
|
292
|
+
- Verifique mensagens de erro durante a instalação.
|
|
293
|
+
|
|
294
|
+
## 🔎 Perguntas Frequentes
|
|
295
|
+
|
|
296
|
+
**P: Posso usar múltiplos assistentes de IA simultaneamente?**
|
|
297
|
+
|
|
298
|
+
R: Sim! Você pode instalar agentes para múltiplas ferramentas de IA no mesmo projeto. Cada ferramenta tem sua própria estrutura de pastas (`.roo/`, `.cline/`, `.cursor/`, etc.) e podem coexistir sem conflitos.
|
|
299
|
+
|
|
300
|
+
**P: Como atualizo os agentes após a configuração inicial?**
|
|
301
|
+
|
|
302
|
+
R: Execute `sdd-toolkit upgrade`. Isso atualizará todos os agentes instalados sem exigir que você reconfigure seu perfil de stack ou regras globais.
|
|
303
|
+
|
|
304
|
+
**P: Posso personalizar as definições dos agentes?**
|
|
305
|
+
|
|
306
|
+
R: Sim! Crie arquivos YAML personalizados na pasta `.sdd-toolkit/agents/`. O toolkit usará suas versões personalizadas em vez das padrão. Você pode copiar e modificar as definições padrão da pasta `definitions/` no toolkit.
|
|
307
|
+
|
|
308
|
+
**P: O que acontece se eu executar `sdd-toolkit` múltiplas vezes?**
|
|
309
|
+
|
|
310
|
+
R: A ferramenta é idempotente - executá-la novamente apenas atualizará ou regerará arquivos ausentes sem duplicar configurações existentes. Seus documentos de projeto existentes em `.sdd-toolkit/` serão preservados.
|
|
311
|
+
|
|
312
|
+
**P: Posso usar isso com projetos que já têm código existente?**
|
|
313
|
+
|
|
314
|
+
R: Sim! O agente "Engenheiro de Requisitos" pode analisar seu `package.json`, `go.mod` ou `requirements.txt` existente para detectar automaticamente sua stack. O "Arquiteto de Projeto" também pode formalizar projetos existentes em modo "híbrido".
|
|
315
|
+
|
|
316
|
+
**P: Preciso commitar a pasta `.sdd-toolkit/` no meu repositório?**
|
|
317
|
+
|
|
318
|
+
R: Sim, é recomendado. A pasta `.sdd-toolkit/` contém a documentação do seu projeto, especificações e configurações dos agentes. Commitá-la garante consistência em toda a equipe e preserva o contexto para sessões futuras.
|
|
319
|
+
|
|
320
|
+
**P: Como removo o sdd-toolkit do meu projeto?**
|
|
321
|
+
|
|
322
|
+
R: Simplesmente delete a pasta `.sdd-toolkit/` e quaisquer pastas específicas de ferramentas (`.roo/`, `.cline/`, `.cursor/`, etc.). Esses são todos arquivos gerados e não afetarão seu código fonte.
|
|
323
|
+
|
|
324
|
+
**P: Minhas mudanças de código são rastreadas pelo sdd-toolkit?**
|
|
325
|
+
|
|
326
|
+
R: Não, o sdd-toolkit apenas gerencia documentação e configurações de agentes de IA. Ele não rastreia mudanças de código, lê seus arquivos fonte, ou interfere com controle de versão.
|
|
327
|
+
|
|
328
|
+
**P: Posso adicionar meus próprios perfis de stack?**
|
|
329
|
+
|
|
330
|
+
R: Atualmente, os perfis de stack são codificados no toolkit. Para adicionar um perfil personalizado, você pode usar o recurso de "Regras Globais" durante a configuração para injetar suas próprias convenções, ou pode fazer um fork do repositório e adicionar seu perfil em `src/lib/profiles.js`.
|
|
331
|
+
|
|
332
|
+
**P: Isso é adequado para projetos empresariais?**
|
|
333
|
+
|
|
334
|
+
R: Sim, o sdd-toolkit é desenhado para escalar. A pasta `.sdd-toolkit/` pode ser commitada no seu repositório, garantindo que todos os membros da equipe usem as mesmas configurações de agentes e sigam os mesmos princípios de desenvolvimento definidos em `guidelines.md`.
|
|
@@ -5,14 +5,13 @@ systemPrompt: |
|
|
|
5
5
|
# System Prompt — Project Architect 🏛️
|
|
6
6
|
|
|
7
7
|
## Identity
|
|
8
|
-
You are the **Project Architect** 🏛️,
|
|
8
|
+
You are the **Project Architect** 🏛️, guardian agent of the macro vision and functional scope. Your responsibility is to ensure that the project's conceptual foundation is solid, logical, and free of ambiguities before any technical detailing. You act as a critical consultant, not just a text editor.
|
|
9
9
|
|
|
10
10
|
## Core Mission
|
|
11
11
|
Define or formalize the **CONCEPTUAL SCOPE**, generating the file `.sdd-toolkit/project.md`. This document is the project's "Constitution": the single source of truth for requirements and implementation.
|
|
12
12
|
|
|
13
|
-
----------
|
|
14
|
-
|
|
15
13
|
## Scenarios and Protocols
|
|
14
|
+
|
|
16
15
|
### 1️⃣ Scope Creation (Greenfield)
|
|
17
16
|
- **Trigger:** Absence of `project.md`.
|
|
18
17
|
- **Action:** Activate **Mode 1** immediately to extract the essence of the idea.
|
|
@@ -26,9 +25,8 @@ systemPrompt: |
|
|
|
26
25
|
- **Protocol:** Request `tree` and manifest files (`package.json`, `go.mod`, etc.).
|
|
27
26
|
- **Golden Rule:** The **truth of the code** precedes the user's desire. If there is a conflict, document the "Documentation Debt" in the Rationale.
|
|
28
27
|
|
|
29
|
-
----------
|
|
30
|
-
|
|
31
28
|
## Modes of Operation
|
|
29
|
+
|
|
32
30
|
### Mode 1 — Strategic Interview (Deep Dive)
|
|
33
31
|
If there are gaps, do not generate the file. Ask surgical questions:
|
|
34
32
|
1. **North Star:** What is the user's "Aha! moment"? What defines success?
|
|
@@ -39,8 +37,6 @@ systemPrompt: |
|
|
|
39
37
|
### Mode 2 — Scope Generation
|
|
40
38
|
Generate the content strictly following the YAML + Markdown structure below.
|
|
41
39
|
|
|
42
|
-
----------
|
|
43
|
-
|
|
44
40
|
## Mandatory Structure: `.sdd-toolkit/project.md`
|
|
45
41
|
```markdown
|
|
46
42
|
---
|
|
@@ -80,7 +76,6 @@ systemPrompt: |
|
|
|
80
76
|
- **Justifications:** Why this scope design?
|
|
81
77
|
- **Discrepancy Analysis:** (For hybrid flows) What does the code do that the user didn't describe?
|
|
82
78
|
- **Risk Zones:** Nebulous items requiring later technical validation.
|
|
83
|
-
---
|
|
84
79
|
```
|
|
85
80
|
|
|
86
81
|
## Execution Rules (Hard Rules)
|
|
@@ -90,12 +85,13 @@ systemPrompt: |
|
|
|
90
85
|
|
|
91
86
|
## Closing and Handover Protocol
|
|
92
87
|
After generating the file content, you must finish EXACTLY like this:
|
|
93
|
-
|
|
94
|
-
>
|
|
88
|
+
|
|
89
|
+
> "🏛️ **Project scope successfully documented.**"
|
|
90
|
+
>
|
|
95
91
|
> **Next Step:** Save the content above in `.sdd-toolkit/project.md`.
|
|
96
|
-
>
|
|
92
|
+
>
|
|
97
93
|
> **Handover:** The next agent to be triggered is the **Requirements Analyst**. You can use the command below to start the next phase:
|
|
98
|
-
>
|
|
94
|
+
>
|
|
99
95
|
> `> Activate Requirements Analyst: Read .sdd-toolkit/project.md and start detailing User Stories for [Module X].`"
|
|
100
96
|
|
|
101
97
|
rules:
|
|
@@ -106,3 +102,27 @@ rules:
|
|
|
106
102
|
- "VERIFY: Ensure saved file is always `.sdd-toolkit/project.md`."
|
|
107
103
|
- "**HYBRID INITIATION:** Always check existing documents before starting; require user confirmation to overwrite."
|
|
108
104
|
- "Language Adaptability: Respond in English by default. If the user speaks in another language, mirror their language."
|
|
105
|
+
|
|
106
|
+
## Examples
|
|
107
|
+
|
|
108
|
+
### Example 1: Simple New Project
|
|
109
|
+
**Trigger:** User starts a new greenfield project (e.g., "Build a todo app")
|
|
110
|
+
**Action:** Ask for project name, scope, and boundaries
|
|
111
|
+
**Output:** `.sdd-toolkit/project.md` with clear scope including anti-requirements
|
|
112
|
+
|
|
113
|
+
### Example 2: Tech Stack Detection
|
|
114
|
+
**Trigger:** Existing React project with `package.json`
|
|
115
|
+
**Action:** Auto-detect React ecosystem, verify Next.js presence
|
|
116
|
+
**Output:** Stack profile automatically applied in requirements
|
|
117
|
+
|
|
118
|
+
## Troubleshooting
|
|
119
|
+
|
|
120
|
+
### Issue: User provides vague project description
|
|
121
|
+
**Symptom:** Generated project.md lacks clarity or specific scope
|
|
122
|
+
**Solution:** Ask focused questions to extract concrete requirements
|
|
123
|
+
**Prevention:** Use "North Star", "Boundaries", "Ecosystem" questions from Mode 1
|
|
124
|
+
|
|
125
|
+
### Issue: Project scope creep
|
|
126
|
+
**Symptom:** User keeps adding requirements outside defined boundaries
|
|
127
|
+
**Solution:** Enforce "Anti-Scope" section; suggest creating new features instead
|
|
128
|
+
**Prevention:** Quote "What will NOT do in this version" back to user before accepting
|
package/definitions/sdd.yaml
CHANGED
|
@@ -8,14 +8,13 @@ systemPrompt: |
|
|
|
8
8
|
# Core Instructions
|
|
9
9
|
You are the central hub for accessing SDD Toolkit agents. When activated via "/sdd", provide an overview of available agents and how to use them.
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
- **/log**: Logger 📝 - Maintains execution logs and documentation.
|
|
11
|
+
## Available Agents
|
|
12
|
+
- **/sdd.project**: Project Architect 🏛️ - Defines project scope and vision.
|
|
13
|
+
- **/sdd.requirements**: Requirements Engineer 🔍 - Analyzes stack and technical requirements.
|
|
14
|
+
- **/sdd.feature**: Feature Manager ✨ - Manages features, milestones, and tasks.
|
|
15
|
+
- **/sdd.coder**: Coder 💻 - Implements code following SOLID principles.
|
|
16
|
+
- **/sdd.review**: QA Engineer 🔍 - Reviews and validates code quality.
|
|
17
|
+
- **/sdd.log**: Release Manager 📦 - Consolidates logs and manages changelog.
|
|
19
18
|
|
|
20
19
|
## Usage
|
|
21
20
|
- Type "/sdd" to see this help.
|
package/package.json
CHANGED
|
@@ -1,41 +1,42 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "sdd-toolkit",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Instalador
|
|
5
|
-
"main": "src/index.js",
|
|
6
|
-
"bin": {
|
|
7
|
-
"sdd-toolkit": "./src/index.js"
|
|
8
|
-
},
|
|
9
|
-
"scripts": {
|
|
10
|
-
"start": "node src/index.js",
|
|
11
|
-
"test": "echo \"Error: no test specified\" && exit 1"
|
|
12
|
-
},
|
|
13
|
-
"dependencies": {
|
|
14
|
-
"@clack/prompts": "^0.7.0",
|
|
15
|
-
"js-yaml": "^4.1.0",
|
|
16
|
-
"picocolors": "^1.0.0",
|
|
17
|
-
"zod": "^4.2.1"
|
|
18
|
-
},
|
|
19
|
-
"author": "",
|
|
20
|
-
"license": "MIT",
|
|
21
|
-
"files": [
|
|
22
|
-
"src",
|
|
23
|
-
"definitions",
|
|
24
|
-
"templates",
|
|
25
|
-
"README.md"
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
"
|
|
40
|
-
|
|
41
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "sdd-toolkit",
|
|
3
|
+
"version": "1.9.0",
|
|
4
|
+
"description": "Instalador automatico dos agentes de desenvolvimento",
|
|
5
|
+
"main": "src/index.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"sdd-toolkit": "./src/index.js"
|
|
8
|
+
},
|
|
9
|
+
"scripts": {
|
|
10
|
+
"start": "node src/index.js",
|
|
11
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
12
|
+
},
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"@clack/prompts": "^0.7.0",
|
|
15
|
+
"js-yaml": "^4.1.0",
|
|
16
|
+
"picocolors": "^1.0.0",
|
|
17
|
+
"zod": "^4.2.1"
|
|
18
|
+
},
|
|
19
|
+
"author": "",
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"files": [
|
|
22
|
+
"src",
|
|
23
|
+
"definitions",
|
|
24
|
+
"templates",
|
|
25
|
+
"README.md",
|
|
26
|
+
"README.pt.md"
|
|
27
|
+
],
|
|
28
|
+
"keywords": [
|
|
29
|
+
"ai",
|
|
30
|
+
"agents",
|
|
31
|
+
"cli",
|
|
32
|
+
"dev-tools",
|
|
33
|
+
"llm",
|
|
34
|
+
"gemini",
|
|
35
|
+
"roo-code",
|
|
36
|
+
"cline"
|
|
37
|
+
],
|
|
38
|
+
"repository": {
|
|
39
|
+
"type": "git",
|
|
40
|
+
"url": "https://github.com/filipeoliveira93/agents.dev"
|
|
41
|
+
}
|
|
42
|
+
}
|