oxe-cc 0.6.4 → 0.6.5

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,323 +1,344 @@
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.4` · [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 já 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 texto → roteamento. Com "help" → 8 comandos. |
70
- | `/oxe-scan` | Se `.oxe/codebase/` já 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 engineeringestado 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-retro3–5 lições prescritivas .oxe/LESSONS.md
181
-
182
- /oxe-spec (próximo ciclo LESSONS)
183
- /oxe-plan (próximo ciclo lê 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: só `.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)
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.4` · [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 chamado quando necessário.
46
+
47
+ ---
48
+
49
+ ## Sessões OXE
50
+
51
+ Sessões organizam um ciclo completo em `.oxe/sessions/sNNN-slug/` sem misturar artefatos de entregas diferentes na raiz. Nesta versão, o suporte fica no layer de **workflows Markdown**: `spec`, `plan`, `execute`, `verify`, `checkpoint`, `research` e afins passam a respeitar `active_session` em `.oxe/STATE.md`, enquanto `oxe-cc status` e `oxe-cc doctor` continuam legados.
52
+
53
+ ```text
54
+ .oxe/
55
+ ├── STATE.md
56
+ ├── SESSIONS.md
57
+ ├── global/
58
+ │ ├── LESSONS.md
59
+ │ └── MILESTONES.md
60
+ ├── codebase/
61
+ └── sessions/
62
+ └── s001-exemplo/
63
+ ├── SESSION.md
64
+ ├── spec/
65
+ ├── plan/
66
+ ├── execution/
67
+ ├── verification/
68
+ ├── checkpoints/
69
+ ├── research/
70
+ └── workstreams/
71
+ ```
72
+
73
+ | Subcomando | O que faz |
74
+ |------------|-----------|
75
+ | `/oxe-session new <nome>` | Cria a sessão e define `active_session` |
76
+ | `/oxe-session list` | Lista sessões em `.oxe/SESSIONS.md` |
77
+ | `/oxe-session switch <id>` | Alterna a sessão ativa |
78
+ | `/oxe-session resume <id>` | Alias de `switch` |
79
+ | `/oxe-session status` | Mostra os metadados da sessão ativa |
80
+ | `/oxe-session close` | Arquiva a sessão ativa |
81
+ | `/oxe-session migrate <nome>` | Cria sessão nova e move artefatos session-scoped da raiz |
82
+
83
+ Exemplo de ciclo:
84
+
85
+ ```text
86
+ /oxe-session new auth-redesign
87
+ /oxe-spec
88
+ /oxe-plan
89
+ /oxe-execute
90
+ /oxe-verify
91
+ /oxe-session close
92
+ ```
93
+
94
+ ---
95
+
96
+ ## A cadeia
97
+
98
+ ```
99
+ /oxe-obs (qualquer momento)
100
+
101
+ /oxe-scan → /oxe-spec → /oxe-plan ──────────→ /oxe-execute → /oxe-verify → /oxe-retro
102
+ ↓ ↓
103
+ /oxe-quick (trabalho pequeno) .oxe/LESSONS.md
104
+
105
+ (alimenta o próximo ciclo)
106
+ ```
107
+
108
+ 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.
109
+
110
+ ---
111
+
112
+ ## Como cada comando funciona
113
+
114
+ | Comando | O que entrega |
115
+ |---------|--------------|
116
+ | `/oxe` | Sem input → próximo passo. Com texto → roteamento. Com "help" → 8 comandos. |
117
+ | `/oxe-scan` | Se `.oxe/codebase/` já existe → modo refresh automático. `--full` força scan completo. |
118
+ | `/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. |
119
+ | `/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). |
120
+ | `/oxe-execute` | Execução A/B/C. Se uma tarefa falha: **diagnóstico inline automático** (2-3 hipóteses + fix + retry) sem precisar de comando separado. Exibe `model_hint` ao iniciar cada agente do blueprint. |
121
+ | `/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. |
122
+ | `/oxe-retro` | Sintetiza 3–5 lições prescritivas em `.oxe/LESSONS.md` — consumidas automaticamente pelo próximo spec/plan. |
123
+ | `/oxe-obs` | Registra observação → propaga automaticamente para R-IDs e Tns afetados no próximo plan/spec/execute. |
124
+ | `/oxe-quick` | Objetivo → passos → agentes opcionais (PDDA lean) → verify. Para correções pontuais e features pequenas. |
125
+ | `/oxe-project` | `milestone` + `workstream` + `checkpoint` em um único comando. |
126
+
127
+ ---
128
+
129
+ ## Quando usar cada modo do execute
130
+
131
+ ```
132
+ A) Completo → todas as ondas em 1 sessão (ideal: Claude, Copilot, Gemini)
133
+ B) Por onda → onda 1, você verifica, chama de novo (N sessões)
134
+ C) Por tarefa → máximo controle (N tarefas = N sessões)
135
+ ```
136
+
137
+ Se uma tarefa falha: diagnóstico inline automático (2-3 hipóteses fix retry). O Modo B inclui loop iterativo com escalada automática para diagnóstico profundo quando necessário.
138
+
139
+ ---
140
+
141
+ ## Comandos especializados
142
+
143
+ Estes não precisam ser decorados — aparecem quando o contexto pede ou quando a situação específica justifica.
144
+
145
+ | Comando | Quando usar |
146
+ |---------|-------------|
147
+ | `/oxe-research` | Spike, mapa de sistema, engenharia reversa — antes de spec ou plano |
148
+ | `/oxe-forensics` | Falha persistente após múltiplas tentativas — diagnóstico profundo |
149
+ | `/oxe-ui-spec` | Contrato UI/UX derivado da SPEC (quando UI é domínio crítico) |
150
+ | `/oxe-ui-review` | Auditoria da implementação UI contra o contrato |
151
+ | `/oxe-review-pr` | Revisão de PR ou diff de branches |
152
+ | `/oxe-checkpoint` | Snapshot nomeado do estado da sessão |
153
+
154
+ ---
155
+
156
+ ## Conceitos-chave
157
+
158
+ ### Context engineering — estado em disco, não no chat
159
+
160
+ ```
161
+ .oxe/
162
+ ├── STATE.md ← fase atual, próximo passo, decisões ativas
163
+ ├── SPEC.md ← contrato: critérios A1, A2, …
164
+ ├── ROADMAP.md ← fases de entrega mapeadas a requisitos
165
+ ├── PLAN.md ← tarefas Tn com verificação por item
166
+ ├── VERIFY.md ← resultado da verificação em até 6 camadas
167
+ ├── OBSERVATIONS.md ← observações incorporadas automaticamente
168
+ ├── codebase/ ← mapa do repo (stack, estrutura, testes, …)
169
+ ├── milestones/ ← arquivo de entregas M-NN
170
+ └── workstreams/ ← trilhas paralelas de desenvolvimento
171
+ ```
172
+
173
+ ### `/oxe-spec` spec em 5 fases com auto-reflexão semântica
174
+
175
+ 1. **Perguntas**blocos de 3-5 por rodada, máximo 3 rodadas
176
+ 2. **Pesquisa** — proposta inline na Fase 2 (sem sair do spec)
177
+ 3. **Requisitos** — tabela R-ID com v1/v2/fora e critérios A*
178
+ 4. **Roteiro** — fases de entrega → `.oxe/ROADMAP.md`
179
+ 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.
180
+ 6. **Aprovação** instrui `/oxe-plan` ou `/oxe-plan --agents`
181
+
182
+ A spec `.oxe/LESSONS.md` antes de iniciar — lições do ciclo anterior informam as perguntas e os critérios.
183
+
184
+ ### `/oxe-plan` — test-first com complexidade explícita
185
+
186
+ Cada tarefa usa a ordem **Verificar Implementar** (test-first):
187
+ ```
188
+ Verificar: como saberei que está pronto? ← definido PRIMEIRO
189
+ Implementar: o mínimo para passar o Verificar
190
+ Complexidade: S | M | L | XL
191
+ ```
192
+
193
+ Tarefas `XL` bloqueiam o gate sem sub-tarefas ou justificativa. `/oxe-obs` propaga automaticamente constraints para os R-IDs e Tns afetados.
194
+
195
+ ### `/oxe-retro` loop de aprendizado
196
+
197
+ ```
198
+ /oxe-verify completo
199
+
200
+ /oxe-retro → 3–5 lições prescritivas → .oxe/LESSONS.md
201
+
202
+ /oxe-spec (próximo ciclo lê LESSONS)
203
+ /oxe-plan (próximo ciclo lê LESSONS)
204
+ ```
205
+
206
+ Lições não são diário — são instruções para o próximo ciclo. Exemplo:
207
+ > "Tarefas com integração de terceiros: `Complexidade: L` mínimo + `Verificar` com mock fallback"
208
+
209
+ ### Plan-Driven Dynamic Agents — agentes por demanda
210
+
211
+ Com `/oxe-plan --agents` (ou sugerido quando 3+ domínios detectados):
212
+ - `runId` único por demanda nunca reutilizado
213
+ - `role` específico ao domínio desta entrega
214
+ - `model_hint` por agente: `"fast"` / `"balanced"` / `"powerful"`
215
+ - Execute exibe o hint ao iniciar cada agente para o usuário configurar o modelo
216
+
217
+ ---
218
+
219
+ ## Instalação
220
+
221
+ **Requisito:** Node.js 18+
222
+
223
+ ```bash
224
+ npx oxe-cc@latest
225
+ ```
226
+
227
+ **Confirmar que funcionou:**
228
+
229
+ | IDE | Comando |
230
+ |-----|---------|
231
+ | Cursor | `/oxe` |
232
+ | Copilot (VS Code) | `/oxe` (requer `"chat.promptFiles": true`) |
233
+ | Claude Code | `/oxe` ou `oxe` |
234
+ | Gemini CLI | `/oxe` após `/commands reload` |
235
+ | Codex | `/prompts:oxe` |
236
+
237
+ <details>
238
+ <summary><strong>Flags de instalação</strong></summary>
239
+
240
+ | Flag | Efeito |
241
+ |------|--------|
242
+ | `--cursor` / `--copilot` | Só uma das stacks |
243
+ | `--all-agents` | Cursor + Copilot + Claude + OpenCode + Gemini + Codex + Windsurf + Antigravity |
244
+ | `--global` | Layout clássico: `oxe/` na raiz + `.oxe/` |
245
+ | `--local` | Layout mínimo: só `.oxe/` (padrão) |
246
+ | `--force` / `-f` | Sobrescreve arquivos existentes (use para atualizar) |
247
+ | `--dry-run` | Lista ações sem escrever |
248
+ | `--oxe-only` | Só workflows em `.oxe/`, sem integrações IDE |
249
+ | `--no-global-cli` / `-l` | Não instala `oxe-cc` globalmente (útil em CI) |
250
+ | `OXE_NO_PROMPT=1` | Modo não-interativo (CI) |
251
+
252
+ </details>
253
+
254
+ <details>
255
+ <summary><strong>Atualizar e desinstalar</strong></summary>
256
+
257
+ ```bash
258
+ npx oxe-cc@latest --force # atualizar workflows
259
+ npx oxe-cc update --check # verificar versão sem atualizar
260
+ npx oxe-cc uninstall --ide-only # remove integrações (mantém .oxe/)
261
+ ```
262
+
263
+ </details>
264
+
265
+ <details>
266
+ <summary><strong>Desenvolvimento (contribuir)</strong></summary>
267
+
268
+ ```bash
269
+ git clone https://github.com/propagno/oxe-build.git
270
+ cd oxe-build
271
+ npm test # 165 testes
272
+ node bin/oxe-cc.js --help
273
+ ```
274
+
275
+ </details>
276
+
277
+ ---
278
+
279
+ ## CLI (`oxe-cc`)
280
+
281
+ | Comando | O que faz |
282
+ |---------|-----------|
283
+ | `oxe-cc` / `oxe-cc install` | Instala workflows e integrações |
284
+ | `oxe-cc doctor` | Diagnóstico completo: Node, workflows, config, STATE, scan antigo |
285
+ | `oxe-cc status` | Próximo passo sugerido |
286
+ | `oxe-cc status --json` | Mesmo, em JSON (para pipelines) |
287
+ | `oxe-cc update` | Atualiza workflows para a versão mais recente |
288
+ | `oxe-cc init-oxe` | Bootstrap do `.oxe/` (STATE, config, codebase/) |
289
+ | `oxe-cc uninstall` | Remove integrações OXE do HOME e do repo |
290
+
291
+ ---
292
+
293
+ ## Configuração
294
+
295
+ Arquivo `.oxe/config.json`. Principais opções:
296
+
297
+ | Chave | Padrão | Descrição |
298
+ |-------|--------|-----------|
299
+ | `profile` | `"balanced"` | `strict` / `balanced` / `fast` / `legacy` |
300
+ | `verification_depth` | `"standard"` | `"thorough"` ativa gaps automático no verify (Camada 5) |
301
+ | `security_in_verify` | `false` | `true` ativa OWASP automático no verify (Camada 6) |
302
+ | `discuss_before_plan` | `false` | Exige aprovação de decisões antes do plano |
303
+ | `scale_adaptive` | `true` | Scan sugere o profile pelo tamanho do projeto |
304
+ | `scan_max_age_days` | `0` | Doctor avisa quando o scan estiver velho |
305
+ | `lessons_max_age_days` | `0` | Doctor avisa quando a última retro estiver velho |
306
+ | `plugins` | `[]` | Hooks de lifecycle em `.oxe/plugins/*.cjs` |
307
+
308
+ ---
309
+
310
+ ## SDK
311
+
312
+ ```js
313
+ const oxe = require('oxe-cc');
314
+
315
+ const plan = oxe.parsePlan(fs.readFileSync('.oxe/PLAN.md', 'utf8'));
316
+ const spec = oxe.parseSpec(fs.readFileSync('.oxe/SPEC.md', 'utf8'));
317
+ const state = oxe.parseState(fs.readFileSync('.oxe/STATE.md', 'utf8'));
318
+
319
+ const fidelity = oxe.validateDecisionFidelity(discussMd, planMd);
320
+ const result = oxe.runDoctorChecks({ projectRoot: process.cwd() });
321
+ const expanded = oxe.health.expandExecutionProfile('strict');
322
+ ```
323
+
324
+ TypeScript: [`lib/sdk/index.d.ts`](lib/sdk/index.d.ts) · Docs: [`lib/sdk/README.md`](lib/sdk/README.md)
325
+
326
+ ---
327
+
328
+ ## Resolução de problemas
329
+
330
+ | Situação | O que tentar |
331
+ |----------|-------------|
332
+ | Comandos não aparecem no Cursor | Confirme `~/.cursor/commands/`; reinicie o Cursor |
333
+ | `/oxe-*` não aparecem no Copilot | Ative `"chat.promptFiles": true`; confirme `~/.copilot/prompts/` |
334
+ | Arquivos não atualizam | Reinstale com `--force` |
335
+ | `ETARGET` / versão não encontrada | `npm cache clean --force` |
336
+ | Erro no WSL sobre Node | Use Node instalado dentro do WSL |
337
+
338
+ `oxe-cc --help` · `oxe-cc doctor` · `OXE_NO_BANNER=1` desativa o banner
339
+
340
+ ---
341
+
342
+ ## Licença
343
+
344
+ [GPL-3.0](LICENSE)