oxe-cc 0.5.0 → 0.6.2

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.
Files changed (37) hide show
  1. package/.cursor/commands/oxe-loop.md +11 -0
  2. package/.cursor/commands/oxe-project.md +11 -0
  3. package/.cursor/commands/oxe-retro.md +11 -0
  4. package/.cursor/commands/oxe-security.md +11 -0
  5. package/.cursor/commands/oxe.md +9 -0
  6. package/.github/prompts/oxe-loop.prompt.md +12 -0
  7. package/.github/prompts/oxe-project.prompt.md +12 -0
  8. package/.github/prompts/oxe-retro.prompt.md +12 -0
  9. package/.github/prompts/oxe-security.prompt.md +12 -0
  10. package/.github/prompts/oxe.prompt.md +12 -0
  11. package/README.md +323 -307
  12. package/bin/banner.txt +1 -1
  13. package/bin/oxe-cc.js +1 -1
  14. package/commands/oxe/loop.md +17 -0
  15. package/commands/oxe/oxe.md +16 -0
  16. package/commands/oxe/project.md +16 -0
  17. package/commands/oxe/retro.md +16 -0
  18. package/commands/oxe/security.md +16 -0
  19. package/oxe/templates/LESSONS.template.md +43 -0
  20. package/oxe/templates/PLAN.template.md +2 -1
  21. package/oxe/templates/SECURITY.template.md +72 -0
  22. package/oxe/templates/plan-agents.template.json +3 -2
  23. package/oxe/workflows/execute.md +22 -0
  24. package/oxe/workflows/help.md +41 -24
  25. package/oxe/workflows/loop.md +57 -0
  26. package/oxe/workflows/obs.md +7 -0
  27. package/oxe/workflows/oxe.md +115 -0
  28. package/oxe/workflows/plan-agent.md +24 -7
  29. package/oxe/workflows/plan.md +22 -6
  30. package/oxe/workflows/project.md +50 -0
  31. package/oxe/workflows/research.md +16 -0
  32. package/oxe/workflows/retro.md +62 -0
  33. package/oxe/workflows/scan.md +14 -0
  34. package/oxe/workflows/security.md +61 -0
  35. package/oxe/workflows/spec.md +26 -0
  36. package/oxe/workflows/verify.md +7 -3
  37. package/package.json +1 -1
package/README.md CHANGED
@@ -1,307 +1,323 @@
1
- <div align="center">
2
-
3
- <p align="center">
4
- <img src="assets/readme-banner.svg" alt="OXE" width="920" />
5
- </p>
6
-
7
- [![npm](https://img.shields.io/npm/v/oxe-cc.svg?style=flat-square)](https://www.npmjs.com/package/oxe-cc)
8
- [![license](https://img.shields.io/npm/l/oxe-cc.svg?style=flat-square)](LICENSE)
9
-
10
- **Versão:** `0.5.0` · [package.json](package.json)
11
-
12
- ```bash
13
- npx oxe-cc@latest
14
- ```
15
-
16
- </div>
17
-
18
- ---
19
-
20
- ## O que é o OXE
21
-
22
- OXE é um **framework de desenvolvimento assistido por IA** baseado em três princípios:
23
-
24
- - **Spec-driven design** — antes de escrever código, você define *o que* construir e *como saber que está pronto*. Essa especificação restringe e guia tudo o que vem depois.
25
- - **Context engineering** — o estado do trabalho fica em arquivos pequenos dentro de `.oxe/`, não na memória do chat. O agente lê o que precisa, quando precisa — sem sobrecarregar o contexto com decisões já tomadas.
26
- - **Plan-Driven Dynamic Agents** — quando há múltiplos domínios, o plano cria agentes específicos para *aquela demanda*. Agentes não são reaproveitados entre projetos ou demandas.
27
-
28
- O resultado: **menos requisições**, **mais coerência**, e um fluxo de desenvolvimento que funciona do mesmo jeito em qualquer IDE — Cursor, Claude Code, Copilot, Codex ou qualquer outra suportada.
29
-
30
- ---
31
-
32
- ## A cadeia
33
-
34
- ```
35
- /oxe-obs ← registrar uma observação a qualquer momento
36
- (incorporada automaticamente no próximo passo)
37
-
38
- /oxe-scan /oxe-spec /oxe-plan ──────────────────→ /oxe-execute /oxe-verify
39
- ↓ ↓
40
- /oxe-discuss /oxe-plan-agent (com agentes)
41
- (decisões)
42
- atalho para trabalho pequeno
43
- /oxe-quick (spec + plan + agentes, tudo lean)
44
- ```
45
-
46
- Cada passo lê o anterior como contexto e escreve seu artefato em `.oxe/`. Nenhum passo depende de você re-explicar o que já foi decidido.
47
-
48
- ---
49
-
50
- ## Comandos
51
-
52
- ### Fluxo principal
53
-
54
- | Comando | O que faz | Artefato |
55
- |---------|-----------|----------|
56
- | `/oxe-scan` | Mapeia o repositório: stack, estrutura, testes, convenções. Base para spec e plan. | `.oxe/codebase/*.md` |
57
- | `/oxe-spec` | Conduz 5 fases: perguntas → pesquisa → requisitos (v1/v2/fora) → roteiro → aprovação. Produz o contrato da entrega. | `.oxe/SPEC.md` + `.oxe/ROADMAP.md` |
58
- | `/oxe-discuss` | Registra decisões de implementação com IDs estáveis (D-01, D-02, …) antes de planejar. | `.oxe/DISCUSS.md` |
59
- | `/oxe-plan` | Gera tarefas atômicas em ondas, cada uma com bloco de verificação e critérios vinculados à SPEC. | `.oxe/PLAN.md` |
60
- | `/oxe-plan-agent` | Igual ao plan + blueprint de agentes por domínio: roles específicos, ondas paralelas, handoffs. Agentes são novos por demanda. | `.oxe/PLAN.md` + `.oxe/plan-agents.json` |
61
- | `/oxe-execute` | Executa o plano. Pergunta UMA vez como executar: **Completo** (1 sessão), **Por onda**, ou **Por tarefa**. | `.oxe/STATE.md` |
62
- | `/oxe-verify` | Validação em 4 camadas: auditoria do PLAN, critérios da SPEC, fidelidade das decisões D-NN, checklist UAT. | `.oxe/VERIFY.md` |
63
-
64
- ### Atalhos e suporte
65
-
66
- | Comando | O que faz |
67
- |---------|-----------|
68
- | `/oxe-obs [texto]` | Registra uma observação (restrição, descoberta, preferência) que é incorporada automaticamente no próximo spec/plan/execute — sem re-explicar. |
69
- | `/oxe-quick` | Fluxo lean para trabalho pequeno: objetivo (minispec)passos (mini-plano)agentes por domínio se necessário → verificar. |
70
- | `/oxe-research` | Cria notas de pesquisa datadas (spike, mapa de sistema, engenharia reversa) antes de planejar. |
71
- | `/oxe-validate-gaps` | Auditoria de cobertura pós-verify: gaps de teste e evidência fraca. |
72
- | `/oxe-next` | Sugere o próximo passo lógico a partir do `STATE.md`. |
73
- | `/oxe-route` | Traduz linguagem natural para o comando OXE correto. |
74
- | `/oxe-forensics` | Diagnóstico pós-falha: linha do tempo, hipótese de causa, reentrada na trilha. |
75
- | `/oxe-debug` | Ciclo hipótese experimento evidência durante a execução. |
76
-
77
- ### Contexto e sessão
78
-
79
- | Comando | O que faz |
80
- |---------|-----------|
81
- | `/oxe-compact` | Atualiza os mapas `.oxe/codebase/` com o estado atual do repo + delta do que mudou. |
82
- | `/oxe-checkpoint` | Snapshot nomeado da sessão atual. |
83
- | `/oxe-milestone new\|complete\|status\|audit` | Marcos de entrega (M-01, M-02, …). `complete` arquiva SPEC/PLAN/VERIFY em `.oxe/milestones/M-NN/`. |
84
- | `/oxe-workstream new\|switch\|list\|close` | Trilhas paralelas de desenvolvimento. Cada trilha tem artefatos independentes em `.oxe/workstreams/<nome>/`. |
85
-
86
- ### UI e revisão
87
-
88
- | Comando | O que faz |
89
- |---------|-----------|
90
- | `/oxe-ui-spec` | Contrato de UI/UX derivado da SPEC (estados, acessibilidade, breakpoints). |
91
- | `/oxe-ui-review` | Auditoria da implementação de UI contra o UI-SPEC. |
92
- | `/oxe-review-pr` | Revisão de PR/diff: riscos, testes sugeridos, checklist. |
93
-
94
- ---
95
-
96
- ## Conceitos-chave
97
-
98
- ### Context engineering estado em disco, não no chat
99
-
100
- O problema: agentes perdem contexto entre sessões, e re-explicar tudo em cada sessão é caro. A solução do OXE: cada decisão, requisito e tarefa fica em um arquivo pequeno em `.oxe/`. O agente lê o que precisa, quando precisa.
101
-
102
- ```
103
- .oxe/
104
- ├── STATE.md ← fase atual, próximo passo, decisões ativas
105
- ├── SPEC.md ← o contrato: critérios A1, A2,
106
- ├── ROADMAP.md ← fases de entrega mapeadas a requisitos
107
- ├── DISCUSS.md ← decisões D-01, D-02, com rastreabilidade
108
- ├── PLAN.md ← tarefas Tn com verificação por item
109
- ├── VERIFY.md ← resultado da verificação em 4 camadas
110
- ├── OBSERVATIONS.md ← observações que se incorporam automaticamente
111
- ├── codebase/ ← mapa do repo (stack, estrutura, testes, …)
112
- ├── milestones/ ← arquivo de entregas M-NN
113
- └── workstreams/ ← trilhas paralelas de desenvolvimento
114
- ```
115
-
116
- ### /oxe-spec — spec em 5 fases, máx 3 rodadas de perguntas
117
-
118
- Em vez de 10 idas e vindas para clarificar o que você quer, o spec estrutura a conversa:
119
-
120
- 1. **Perguntas**blocos de 3-5 perguntas por rodada, máximo 3 rodadas
121
- 2. **Pesquisa** — investigação de domínio antes de escrever requisitos (opcional)
122
- 3. **Requisitos** — tabela R-ID com versão v1 (agora), v2 (depois), fora (nunca)
123
- 4. **Roteiro** — fases de entrega mapeadas a requisitos → `.oxe/ROADMAP.md`
124
- 5. **Aprovação** você confirma e escolhe: `/oxe-plan` ou `/oxe-plan-agent`
125
-
126
- ### /oxe-execute economia de requisições explícita
127
-
128
- Quando o plano tem 2+ ondas, o execute pergunta **uma vez**:
129
-
130
- ```
131
- A) Completo → todas as ondas em 1 sessão (ideal: Copilot, Claude, Gemini)
132
- B) Por onda → onda 1, você verifica, chama de novo (N sessões)
133
- C) Por tarefa → máximo controle (N tarefas = N sessões)
134
- ```
135
-
136
- Modo A é o padrão para quem quer gastar menos requisições. A escolha fica salva no `STATE.md`.
137
-
138
- ### /oxe-obsobservação sem re-explicar
139
-
140
- Percebeu uma restrição durante a execução? Registre em 1 request:
141
-
142
- ```
143
- /oxe-obs JWT expiration deve ser configurável via env var, não hardcoded
144
- ```
145
-
146
- O próximo `/oxe-plan`, `/oxe-spec` ou `/oxe-execute` `.oxe/OBSERVATIONS.md` e incorpora a observação automaticamente — sem você precisar repetir.
147
-
148
- ### Plan-Driven Dynamic Agents — agentes por demanda, não genéricos
149
-
150
- Quando você usa `/oxe-plan-agent`, os agentes são criados **para aquele plano específico**:
151
- - Cada `runId` é único nunca reutilizado entre demandas
152
- - O `role` descreve o domínio da demanda: "Especialista em autenticação JWT para este plano", não "Backend Developer"
153
- - Agentes são invalidados quando o plano termina ou uma nova demanda começa
154
-
155
- O `/oxe-quick` tem a versão lean: até 3 agentes derivados dos passos, criados para aquele quick task, sem handoff de mensagens.
156
-
157
- ---
158
-
159
- ## Instalação
160
-
161
- **Requisito:** Node.js 18+
162
-
163
- ```bash
164
- # Na raiz do seu projeto
165
- npx oxe-cc@latest
166
- ```
167
-
168
- O instalador interativo pergunta: (1) quais IDEs integrar, (2) layout (mínimo só `.oxe/` ou clássico `oxe/` + `.oxe/`). Ao final mostra o que foi criado e sugere o primeiro passo (`/oxe-scan`).
169
-
170
- **Confirmar que funcionou:**
171
-
172
- | IDE | Comando |
173
- |-----|---------|
174
- | Cursor | `/oxe-help` |
175
- | Copilot (VS Code) | `/oxe-help` (requer `"chat.promptFiles": true`) |
176
- | Claude Code | `/oxe-help` ou `oxe:help` |
177
- | Gemini CLI | `/oxe` após `/commands reload` |
178
- | Codex | `/prompts:oxe-help` |
179
-
180
- <details>
181
- <summary><strong>Flags de instalação</strong></summary>
182
-
183
- | Flag | Efeito |
184
- |------|--------|
185
- | `--cursor` / `--copilot` | Só uma das stacks |
186
- | `--all-agents` | Cursor + Copilot + Claude + OpenCode + Gemini + Codex + Windsurf + Antigravity |
187
- | `--global` | Layout clássico: `oxe/` na raiz + `.oxe/` |
188
- | `--local` | Layout mínimo: só `.oxe/` (padrão) |
189
- | `--force` / `-f` | Sobrescreve arquivos existentes (use para atualizar) |
190
- | `--dry-run` | Lista ações sem escrever |
191
- | `--oxe-only` | workflows em `.oxe/`, sem integrações IDE |
192
- | `--no-global-cli` / `-l` | Não instala `oxe-cc` globalmente (útil em CI) |
193
- | `OXE_NO_PROMPT=1` | Modo não-interativo (CI) |
194
-
195
- </details>
196
-
197
- <details>
198
- <summary><strong>Atualizar e desinstalar</strong></summary>
199
-
200
- ```bash
201
- # Atualizar workflows no projeto
202
- npx oxe-cc@latest --force
203
- # ou via Cursor:
204
- /oxe-update
205
-
206
- # Verificar se há versão nova sem atualizar
207
- npx oxe-cc update --check
208
-
209
- # Desinstalar integrações do HOME (mantém .oxe/ no repo)
210
- npx oxe-cc uninstall --ide-only
211
- ```
212
-
213
- </details>
214
-
215
- <details>
216
- <summary><strong>Desenvolvimento (contribuir)</strong></summary>
217
-
218
- ```bash
219
- git clone https://github.com/propagno/oxe-build.git
220
- cd oxe-build
221
- npm test # 144 testes
222
- node bin/oxe-cc.js --help
223
- ```
224
-
225
- Para testar no seu projeto: `npm link` aqui, depois `npm link oxe-cc` no projeto alvo.
226
-
227
- </details>
228
-
229
- ---
230
-
231
- ## CLI (`oxe-cc`)
232
-
233
- Comandos de terminal para usar em CI ou sem chat aberto:
234
-
235
- | Comando | O que faz |
236
- |---------|-----------|
237
- | `oxe-cc` / `oxe-cc install` | Instala workflows e integrações |
238
- | `oxe-cc doctor` | Diagnóstico completo: Node, workflows, config, STATE, scan/compact antigos, SPEC, PLAN |
239
- | `oxe-cc status` | Diagnóstico leve + um único próximo passo sugerido |
240
- | `oxe-cc status --json` | Mesmo, em JSON (para pipelines e automações) |
241
- | `oxe-cc update` | Atualiza workflows do projeto para a versão mais recente |
242
- | `oxe-cc init-oxe` | Só bootstrap do `.oxe/` (STATE, config, codebase/) |
243
- | `oxe-cc uninstall` | Remove integrações OXE do HOME e do repo |
244
-
245
- ---
246
-
247
- ## Configuração
248
-
249
- Arquivo `.oxe/config.json` criado no install. Principais opções:
250
-
251
- | Chave | Padrão | Descrição |
252
- |-------|--------|-----------|
253
- | `profile` | `"balanced"` | `strict` / `balanced` / `fast` / `legacy` — expande em múltiplas opções |
254
- | `scale_adaptive` | `true` | `/oxe-scan` sugere o profile automaticamente pelo tamanho do projeto |
255
- | `discuss_before_plan` | `false` | Exige `/oxe-discuss` antes do `/oxe-plan` |
256
- | `verification_depth` | `"standard"` | `quick` / `standard` / `thorough` |
257
- | `after_verify_suggest_uat` | `false` | Gera checklist UAT (Camada 4) ao final do verify |
258
- | `scan_max_age_days` | — | `doctor` avisa quando o scan estiver velho |
259
- | `plugins` | — | Habilita hooks de lifecycle em `.oxe/plugins/*.cjs` |
260
-
261
- Referência completa: [`oxe/templates/CONFIG.md`](oxe/templates/CONFIG.md)
262
-
263
- ---
264
-
265
- ## SDK
266
-
267
- ```js
268
- const oxe = require('oxe-cc');
269
-
270
- // Parsear artefatos
271
- const plan = oxe.parsePlan(fs.readFileSync('.oxe/PLAN.md', 'utf8'));
272
- const spec = oxe.parseSpec(fs.readFileSync('.oxe/SPEC.md', 'utf8'));
273
- const state = oxe.parseState(fs.readFileSync('.oxe/STATE.md', 'utf8'));
274
-
275
- // Validar que as decisões D-NN foram cobertas no plano
276
- const fidelity = oxe.validateDecisionFidelity(discussMd, planMd);
277
-
278
- // Doctor com verificação de segurança
279
- const result = oxe.runDoctorChecks({ projectRoot: process.cwd(), includeSecurity: true });
280
-
281
- // Profiles e health
282
- const expanded = oxe.health.expandExecutionProfile('strict');
283
- ```
284
-
285
- Namespaces: `oxe.health`, `oxe.workflows`, `oxe.security`, `oxe.plugins`, `oxe.install`.
286
- TypeScript: [`lib/sdk/index.d.ts`](lib/sdk/index.d.ts) · Docs: [`lib/sdk/README.md`](lib/sdk/README.md)
287
-
288
- ---
289
-
290
- ## Resolução de problemas
291
-
292
- | Situação | O que tentar |
293
- |----------|-------------|
294
- | Comandos não aparecem no Cursor | Confirme `~/.cursor/commands/`; reinicie o Cursor |
295
- | `/oxe-*` não aparecem no Copilot | Ative `"chat.promptFiles": true`; confirme prompts em `~/.copilot/prompts/` |
296
- | Copilot CLI não reconhece `/oxe` | Use `--copilot-cli` no install e rode `/skills reload` |
297
- | Arquivos não atualizam | Reinstale com `--force` |
298
- | `ETARGET` / versão não encontrada | `npm cache clean --force` ou `npx oxe-cc@0.5.0` |
299
- | Erro no WSL sobre Node | Use Node instalado dentro do WSL |
300
-
301
- `oxe-cc --help` · `oxe-cc doctor` · `OXE_NO_BANNER=1` desativa o banner
302
-
303
- ---
304
-
305
- ## Licença
306
-
307
- [GPL-3.0](LICENSE)
1
+ <div align="center">
2
+
3
+ <p align="center">
4
+ <img src="assets/readme-banner.svg" alt="OXE" width="920" />
5
+ </p>
6
+
7
+ [![npm](https://img.shields.io/npm/v/oxe-cc.svg?style=flat-square)](https://www.npmjs.com/package/oxe-cc)
8
+ [![license](https://img.shields.io/npm/l/oxe-cc.svg?style=flat-square)](LICENSE)
9
+
10
+ **Versão:** `0.6.2` · [package.json](package.json)
11
+
12
+ ```bash
13
+ npx oxe-cc@latest
14
+ ```
15
+
16
+ </div>
17
+
18
+ ---
19
+
20
+ ## O que é o OXE
21
+
22
+ OXE é um **framework de desenvolvimento assistido por IA** baseado em três princípios:
23
+
24
+ - **Spec-driven design** — antes de escrever código, você define *o que* construir e *como saber que está pronto*. Essa especificação restringe e guia tudo o que vem depois.
25
+ - **Context engineering** — o estado do trabalho fica em arquivos pequenos dentro de `.oxe/`, não na memória do chat. O agente lê o que precisa, quando precisa — sem sobrecarregar o contexto com decisões já tomadas.
26
+ - **Plan-Driven Dynamic Agents** — quando há múltiplos domínios, o plano cria agentes específicos para *aquela demanda*. Agentes não são reaproveitados entre projetos ou demandas.
27
+
28
+ O resultado: **menos requisições**, **mais coerência**, e um fluxo que funciona do mesmo jeito em qualquer IDE.
29
+
30
+ ---
31
+
32
+ ## Os 8 comandos que você precisa conhecer
33
+
34
+ ```
35
+ /oxe onde estou / o que faço / help
36
+ /oxe-obs → registrei algo importante (incorporado automaticamente)
37
+ /oxe-quick → tarefa pequena, sem cerimônia
38
+ /oxe-scan mapeia o projeto (ou atualiza se já mapeado)
39
+ /oxe-spec → nova feature: perguntas → requisitos → roteiro
40
+ /oxe-plan tarefas por onda (--agents para multi-agente)
41
+ /oxe-execute → implementar (A: 1 sessão | B: por onda | C: por tarefa)
42
+ /oxe-verify → validar que está pronto
43
+ ```
44
+
45
+ Tudo o mais é ativado automaticamente por contexto ou existe como escape hatch.
46
+
47
+ ---
48
+
49
+ ## A cadeia
50
+
51
+ ```
52
+ /oxe-obs (qualquer momento)
53
+
54
+ /oxe-scan /oxe-spec /oxe-plan ──────────→ /oxe-execute /oxe-verify → /oxe-retro
55
+ ↓ ↓
56
+ /oxe-quick (trabalho pequeno) .oxe/LESSONS.md
57
+
58
+ (alimenta o próximo ciclo)
59
+ ```
60
+
61
+ Cada passo lê o anterior como contexto e escreve seu artefato em `.oxe/`. Nenhum passo depende de você re-explicar o que foi decidido. Os erros do ciclo anterior não se repetem.
62
+
63
+ ---
64
+
65
+ ## Como cada comando fica mais inteligente
66
+
67
+ | Comando | Inteligência embutida |
68
+ |---------|----------------------|
69
+ | `/oxe` | Sem input próximo passo. Com textoroteamento. Com "help" 8 comandos. |
70
+ | `/oxe-scan` | Se `.oxe/codebase/` existe modo refresh automático. `--full` força scan completo. |
71
+ | `/oxe-spec` | **Auto-reflexão semântica** antes da aprovação: detecta contradições, critérios vagos, escopo creep e conflitos com stack — sem requisição extra. Lê `LESSONS.md` para não repetir erros do ciclo anterior. |
72
+ | `/oxe-plan` | **Test-first:** `Verificar` vem antes de `Implementar` em cada tarefa. `Complexidade: S/M/L/XL` — tarefas XL bloqueiam o gate sem sub-tarefas. Com `--agents`: `model_hint` por agente orienta qual tier de modelo usar (schema v3). |
73
+ | `/oxe-execute` | Verificar falha diagnóstico inline (2-3 hipóteses + fix). Sem precisar chamar `/oxe-debug`. Exibe `model_hint` ao iniciar cada agente do blueprint. |
74
+ | `/oxe-verify` | Até 6 camadas por config: audit + critérios + decisões + UAT + gaps (`verification_depth: thorough`) + OWASP (`security_in_verify: true`). Sugere `/oxe-retro` ao concluir. |
75
+ | `/oxe-retro` | Sintetiza 3–5 lições prescritivas em `LESSONS.md` consumidas automaticamente pelo próximo spec/plan. |
76
+ | `/oxe-research` | **Thinking depth:** classifica `surface` / `standard` / `deep` e recomenda raciocínio estendido para reverse engineering e arquitetura complexa. |
77
+ | `/oxe-loop` | Retry iterativo de onda: executa → verifica → diagnostica (2-3 hipóteses) → corrige → repete até `max` tentativas; escala para `/oxe-forensics` se esgotar. |
78
+ | `/oxe-security` | Auditoria OWASP Top 10 filtrada pelo stack. Achados P0/P1/P2 vinculados a tarefas existentes. Integrado ao verify via `security_in_verify: true`. |
79
+ | `/oxe-project` | `milestone` + `workstream` + `checkpoint` em um único comando. |
80
+
81
+ ---
82
+
83
+ ## Comandos completos
84
+
85
+ ### Fluxo principal
86
+
87
+ | Comando | O que faz | Artefato |
88
+ |---------|-----------|----------|
89
+ | `/oxe` | Entrada universal: próximo passo, roteamento ou help | — |
90
+ | `/oxe-scan` | Mapeia o repo (bootstrap) ou atualiza mapas (refresh automático) | `.oxe/codebase/*.md` |
91
+ | `/oxe-spec` | Spec em 5 fases: perguntas pesquisa → requisitos R-ID → roteiro → aprovação | `.oxe/SPEC.md` + `.oxe/ROADMAP.md` |
92
+ | `/oxe-plan` | Plano por ondas. `--agents` ativa blueprint com `model_hint` por agente | `.oxe/PLAN.md` [+ `plan-agents.json`] |
93
+ | `/oxe-execute` | Execução A/B/C com debug inline automático em falhas | `.oxe/STATE.md` |
94
+ | `/oxe-verify` | Até 6 camadas por config: audit + critérios + decisões + UAT + gaps + segurança | `.oxe/VERIFY.md` |
95
+ | `/oxe-obs` | Registra observação → propaga automaticamente para R-IDs e Tns afetados → auto-incorporada | `.oxe/OBSERVATIONS.md` |
96
+ | `/oxe-quick` | Lean: objetivo → passos → agentes opcionais → verify | `.oxe/QUICK.md` |
97
+ | `/oxe-retro` | Retrospectiva: 3–5 lições prescritivas → alimenta spec/plan do próximo ciclo | `.oxe/LESSONS.md` |
98
+ | `/oxe-project` | Unifica: `milestone`, `workstream`, `checkpoint` | vários |
99
+
100
+ ### Escape hatches (não precisam ser decorados)
101
+
102
+ | Comando | Quando usar |
103
+ |---------|-------------|
104
+ | `/oxe-research` | Spike, mapa de sistema, engenharia reversa |
105
+ | `/oxe-forensics` | Sugerido automaticamente pelo execute/verify em falha persistente |
106
+ | `/oxe-debug` | Diagnóstico técnico standalone (integrado ao execute) |
107
+ | `/oxe-loop` | Retry iterativo de onda standalone (integrado ao Modo B do execute) |
108
+ | `/oxe-security` | Auditoria OWASP standalone (automático no verify via config) |
109
+ | `/oxe-validate-gaps` | Auditoria de cobertura standalone (automático no verify via config) |
110
+ | `/oxe-ui-spec` | Contrato UI/UX derivado da SPEC |
111
+ | `/oxe-ui-review` | Auditoria da implementação UI |
112
+ | `/oxe-review-pr` | Revisão de PR/diff |
113
+ | `/oxe-discuss` | Decisões D-NN (ativado via `discuss_before_plan: true`) |
114
+ | `/oxe-compact` | Refresh explícito do codebase (equivalente a `/oxe-scan` em modo refresh) |
115
+
116
+ ---
117
+
118
+ ## Conceitos-chave
119
+
120
+ ### Context engineering estado em disco, não no chat
121
+
122
+ ```
123
+ .oxe/
124
+ ├── STATE.md ← fase atual, próximo passo, decisões ativas
125
+ ├── SPEC.md ← contrato: critérios A1, A2, …
126
+ ├── ROADMAP.md ← fases de entrega mapeadas a requisitos
127
+ ├── PLAN.md ← tarefas Tn com verificação por item
128
+ ├── VERIFY.md ← resultado da verificação em até 6 camadas
129
+ ├── OBSERVATIONS.md ← observações incorporadas automaticamente
130
+ ├── codebase/ ← mapa do repo (stack, estrutura, testes, …)
131
+ ├── milestones/ ← arquivo de entregas M-NN
132
+ └── workstreams/ ← trilhas paralelas de desenvolvimento
133
+ ```
134
+
135
+ ### `/oxe-spec` — spec em 5 fases com auto-reflexão semântica
136
+
137
+ 1. **Perguntas** — blocos de 3-5 por rodada, máximo 3 rodadas
138
+ 2. **Pesquisa**proposta inline na Fase 2 (sem sair do spec)
139
+ 3. **Requisitos** — tabela R-ID com v1/v2/fora e critérios A*
140
+ 4. **Roteiro** fases de entrega `.oxe/ROADMAP.md`
141
+ 5. **Auto-reflexão** *(automática, sem requisição extra)* — detecta contradições, critérios vagos, escopo creep, conflitos com stack. Corrige antes de apresentar ao usuário.
142
+ 6. **Aprovação** → instrui `/oxe-plan` ou `/oxe-plan --agents`
143
+
144
+ A spec lê `.oxe/LESSONS.md` antes de iniciar — lições do ciclo anterior informam as perguntas e os critérios.
145
+
146
+ ### `/oxe-execute` economia de requisições com debug automático
147
+
148
+ ```
149
+ A) Completo → todas as ondas em 1 sessão (ideal: Claude, Copilot, Gemini)
150
+ B) Por onda → onda 1, você verifica, chama de novo (N sessões)
151
+ C) Por tarefa máximo controle (N tarefas = N sessões)
152
+ ```
153
+
154
+ Se uma tarefa falha: diagnóstico inline automático (2-3 hipóteses → fix → retry). Sem precisar chamar `/oxe-debug` separadamente.
155
+
156
+ ### `/oxe-obs` — observação sem re-explicar
157
+
158
+ ```
159
+ /oxe-obs JWT expiration deve ser configurável via env var, não hardcoded
160
+ ```
161
+
162
+ O próximo `/oxe-plan`, `/oxe-spec` ou `/oxe-execute` incorpora automaticamente — sem prompt extra.
163
+
164
+ ### `/oxe-plan` test-first com complexidade explícita
165
+
166
+ Cada tarefa usa a ordem **Verificar → Implementar** (test-first):
167
+ ```
168
+ Verificar: como saberei que está pronto? ← definido PRIMEIRO
169
+ Implementar: o mínimo para passar o Verificar
170
+ Complexidade: S | M | L | XL
171
+ ```
172
+
173
+ Tarefas `XL` bloqueam o gate sem sub-tarefas ou justificativa. `/oxe-obs` propaga automaticamente constraints para os R-IDs e Tns afetados.
174
+
175
+ ### `/oxe-retro` loop de aprendizado
176
+
177
+ ```
178
+ /oxe-verify completo
179
+
180
+ /oxe-retro → 3–5 lições prescritivas → .oxe/LESSONS.md
181
+
182
+ /oxe-spec (próximo ciclo lê LESSONS)
183
+ /oxe-plan (próximo ciclo LESSONS)
184
+ ```
185
+
186
+ Lições não são diário são instruções para o próximo ciclo. Exemplo:
187
+ > "Tarefas com integração de terceiros: `Complexidade: L` mínimo + `Verificar` com mock fallback"
188
+
189
+ ### Plan-Driven Dynamic Agents agentes por demanda
190
+
191
+ Com `/oxe-plan --agents` (ou sugerido quando 3+ domínios detectados):
192
+ - `runId` único por demanda nunca reutilizado
193
+ - `role` específico ao domínio desta entrega
194
+ - `model_hint` por agente: `"fast"` / `"balanced"` / `"powerful"`
195
+ - Execute exibe o hint ao iniciar cada agente para o usuário configurar o modelo
196
+
197
+ ---
198
+
199
+ ## Instalação
200
+
201
+ **Requisito:** Node.js 18+
202
+
203
+ ```bash
204
+ npx oxe-cc@latest
205
+ ```
206
+
207
+ **Confirmar que funcionou:**
208
+
209
+ | IDE | Comando |
210
+ |-----|---------|
211
+ | Cursor | `/oxe` |
212
+ | Copilot (VS Code) | `/oxe` (requer `"chat.promptFiles": true`) |
213
+ | Claude Code | `/oxe` ou `oxe` |
214
+ | Gemini CLI | `/oxe` após `/commands reload` |
215
+ | Codex | `/prompts:oxe` |
216
+
217
+ <details>
218
+ <summary><strong>Flags de instalação</strong></summary>
219
+
220
+ | Flag | Efeito |
221
+ |------|--------|
222
+ | `--cursor` / `--copilot` | Só uma das stacks |
223
+ | `--all-agents` | Cursor + Copilot + Claude + OpenCode + Gemini + Codex + Windsurf + Antigravity |
224
+ | `--global` | Layout clássico: `oxe/` na raiz + `.oxe/` |
225
+ | `--local` | Layout mínimo: `.oxe/` (padrão) |
226
+ | `--force` / `-f` | Sobrescreve arquivos existentes (use para atualizar) |
227
+ | `--dry-run` | Lista ações sem escrever |
228
+ | `--oxe-only` | Só workflows em `.oxe/`, sem integrações IDE |
229
+ | `--no-global-cli` / `-l` | Não instala `oxe-cc` globalmente (útil em CI) |
230
+ | `OXE_NO_PROMPT=1` | Modo não-interativo (CI) |
231
+
232
+ </details>
233
+
234
+ <details>
235
+ <summary><strong>Atualizar e desinstalar</strong></summary>
236
+
237
+ ```bash
238
+ npx oxe-cc@latest --force # atualizar workflows
239
+ npx oxe-cc update --check # verificar versão sem atualizar
240
+ npx oxe-cc uninstall --ide-only # remove integrações (mantém .oxe/)
241
+ ```
242
+
243
+ </details>
244
+
245
+ <details>
246
+ <summary><strong>Desenvolvimento (contribuir)</strong></summary>
247
+
248
+ ```bash
249
+ git clone https://github.com/propagno/oxe-build.git
250
+ cd oxe-build
251
+ npm test # 144 testes
252
+ node bin/oxe-cc.js --help
253
+ ```
254
+
255
+ </details>
256
+
257
+ ---
258
+
259
+ ## CLI (`oxe-cc`)
260
+
261
+ | Comando | O que faz |
262
+ |---------|-----------|
263
+ | `oxe-cc` / `oxe-cc install` | Instala workflows e integrações |
264
+ | `oxe-cc doctor` | Diagnóstico completo: Node, workflows, config, STATE, scan antigo |
265
+ | `oxe-cc status` | Próximo passo sugerido |
266
+ | `oxe-cc status --json` | Mesmo, em JSON (para pipelines) |
267
+ | `oxe-cc update` | Atualiza workflows para a versão mais recente |
268
+ | `oxe-cc init-oxe` | Bootstrap do `.oxe/` (STATE, config, codebase/) |
269
+ | `oxe-cc uninstall` | Remove integrações OXE do HOME e do repo |
270
+
271
+ ---
272
+
273
+ ## Configuração
274
+
275
+ Arquivo `.oxe/config.json`. Principais opções:
276
+
277
+ | Chave | Padrão | Descrição |
278
+ |-------|--------|-----------|
279
+ | `profile` | `"balanced"` | `strict` / `balanced` / `fast` / `legacy` |
280
+ | `verification_depth` | `"standard"` | `"thorough"` ativa gaps automático no verify (Camada 5) |
281
+ | `security_in_verify` | `false` | `true` ativa OWASP automático no verify (Camada 6) |
282
+ | `discuss_before_plan` | `false` | Exige `/oxe-discuss` antes do `/oxe-plan` |
283
+ | `scale_adaptive` | `true` | Scan sugere o profile pelo tamanho do projeto |
284
+ | `scan_max_age_days` | — | Doctor avisa quando o scan estiver velho |
285
+ | `plugins` | — | Hooks de lifecycle em `.oxe/plugins/*.cjs` |
286
+
287
+ ---
288
+
289
+ ## SDK
290
+
291
+ ```js
292
+ const oxe = require('oxe-cc');
293
+
294
+ const plan = oxe.parsePlan(fs.readFileSync('.oxe/PLAN.md', 'utf8'));
295
+ const spec = oxe.parseSpec(fs.readFileSync('.oxe/SPEC.md', 'utf8'));
296
+ const state = oxe.parseState(fs.readFileSync('.oxe/STATE.md', 'utf8'));
297
+
298
+ const fidelity = oxe.validateDecisionFidelity(discussMd, planMd);
299
+ const result = oxe.runDoctorChecks({ projectRoot: process.cwd() });
300
+ const expanded = oxe.health.expandExecutionProfile('strict');
301
+ ```
302
+
303
+ TypeScript: [`lib/sdk/index.d.ts`](lib/sdk/index.d.ts) · Docs: [`lib/sdk/README.md`](lib/sdk/README.md)
304
+
305
+ ---
306
+
307
+ ## Resolução de problemas
308
+
309
+ | Situação | O que tentar |
310
+ |----------|-------------|
311
+ | Comandos não aparecem no Cursor | Confirme `~/.cursor/commands/`; reinicie o Cursor |
312
+ | `/oxe-*` não aparecem no Copilot | Ative `"chat.promptFiles": true`; confirme `~/.copilot/prompts/` |
313
+ | Arquivos não atualizam | Reinstale com `--force` |
314
+ | `ETARGET` / versão não encontrada | `npm cache clean --force` ou `npx oxe-cc@0.6.0` |
315
+ | Erro no WSL sobre Node | Use Node instalado dentro do WSL |
316
+
317
+ `oxe-cc --help` · `oxe-cc doctor` · `OXE_NO_BANNER=1` desativa o banner
318
+
319
+ ---
320
+
321
+ ## Licença
322
+
323
+ [GPL-3.0](LICENSE)