oxe-cc 0.6.6 → 0.7.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/.cursor/commands/oxe-capabilities.md +11 -0
- package/.cursor/commands/oxe-dashboard.md +11 -0
- package/.github/prompts/oxe-capabilities.prompt.md +12 -0
- package/.github/prompts/oxe-dashboard.prompt.md +12 -0
- package/CHANGELOG.md +33 -0
- package/README.md +147 -11
- package/assets/oxe-framework-artifacts-paper.png +0 -0
- package/bin/banner.txt +1 -1
- package/bin/lib/oxe-azure.cjs +1445 -0
- package/bin/lib/oxe-dashboard.cjs +588 -0
- package/bin/lib/oxe-install-resolve.cjs +4 -1
- package/bin/lib/oxe-operational.cjs +670 -0
- package/bin/lib/oxe-project-health.cjs +372 -28
- package/bin/oxe-cc.js +1517 -312
- package/commands/oxe/capabilities.md +13 -0
- package/commands/oxe/dashboard.md +14 -0
- package/lib/sdk/README.md +9 -7
- package/lib/sdk/index.cjs +56 -0
- package/lib/sdk/index.d.ts +73 -0
- package/oxe/templates/ACTIVE-RUN.template.json +32 -0
- package/oxe/templates/CAPABILITIES.template.md +7 -0
- package/oxe/templates/CAPABILITY.template.md +45 -0
- package/oxe/templates/CHECKPOINTS.template.md +7 -0
- package/oxe/templates/EXECUTION-RUNTIME.template.md +68 -0
- package/oxe/templates/INVESTIGATION.template.md +38 -0
- package/oxe/templates/NOTES.template.md +16 -0
- package/oxe/templates/PLAN-REVIEW.template.md +31 -0
- package/oxe/templates/RESEARCH.template.md +11 -4
- package/oxe/templates/SPEC.template.md +6 -4
- package/oxe/templates/STATE.md +45 -7
- package/oxe/templates/config.template.json +11 -3
- package/oxe/workflows/ask.md +10 -1
- package/oxe/workflows/capabilities.md +23 -0
- package/oxe/workflows/dashboard.md +23 -0
- package/oxe/workflows/discuss.md +11 -9
- package/oxe/workflows/execute.md +57 -35
- package/oxe/workflows/help.md +256 -225
- package/oxe/workflows/obs.md +70 -20
- package/oxe/workflows/plan.md +83 -74
- package/oxe/workflows/quick.md +16 -11
- package/oxe/workflows/references/adaptive-discovery.md +27 -0
- package/oxe/workflows/research.md +12 -8
- package/oxe/workflows/retro.md +30 -5
- package/oxe/workflows/scan.md +1 -0
- package/oxe/workflows/spec.md +65 -48
- package/oxe/workflows/verify.md +52 -37
- package/package.json +2 -2
package/oxe/workflows/help.md
CHANGED
|
@@ -1,41 +1,67 @@
|
|
|
1
|
-
# OXE — Workflow: help
|
|
2
|
-
|
|
3
|
-
<objective>
|
|
4
|
-
Apresentar o fluxo OXE (scan → spec → research opcional → plan → execução → verify → validate-gaps opcional), o modo **quick**, o passo **execute**, e **como invocar em várias IDEs/CLIs** (Cursor e GitHub Copilot como referência principal; outras stacks na secção multi-agente). Mencionar o CLI `oxe-cc` (instalar, `doctor`, `status`, `init-oxe`, `uninstall`, `update`) e, em linha, o **SDK** npm (`require('oxe-cc')`) para CI.
|
|
5
|
-
</objective>
|
|
6
|
-
|
|
7
|
-
<context>
|
|
8
|
-
OXE é um fluxo **spec-driven** com artefatos em `.oxe/` no projeto alvo — **o núcleo é o mesmo** em Cursor, Copilot, Claude, OpenCode, Gemini, Codex, Windsurf, Antigravity ou outra CLI suportada pelo instalador. **Poucos comandos** por ferramenta em relação a fluxos de planeamento mais pesados; *context engineering* com arquivos pequenos por etapa. **GitHub Copilot (VS Code)** usa **`~/.copilot/`** após `npx oxe-cc` (bloco mesclado em `copilot-instructions.md` + **prompt files** em `~/.copilot/prompts/`), não `.github/` dentro do repo alvo por padrão; outras ferramentas usam os respetivos homes (ver secção **Multi-agente** abaixo).
|
|
9
|
-
|
|
10
|
-
No **projeto**, os passos canónicos estão em **`.oxe/workflows/*.md`** (layout mínimo) ou **`oxe/workflows/*.md`** (layout clássico com `--global`); no **pacote npm**, os modelos vivem em **`oxe/workflows/*.md`**.
|
|
11
|
-
</context>
|
|
12
|
-
|
|
13
|
-
<output>
|
|
1
|
+
# OXE — Workflow: help
|
|
2
|
+
|
|
3
|
+
<objective>
|
|
4
|
+
Apresentar o fluxo OXE (scan → spec → research opcional → plan → execução → verify → validate-gaps opcional), o modo **quick**, o passo **execute**, e **como invocar em várias IDEs/CLIs** (Cursor e GitHub Copilot como referência principal; outras stacks na secção multi-agente). Mencionar o CLI `oxe-cc` (instalar, `doctor`, `status`, `init-oxe`, `uninstall`, `update`) e, em linha, o **SDK** npm (`require('oxe-cc')`) para CI.
|
|
5
|
+
</objective>
|
|
6
|
+
|
|
7
|
+
<context>
|
|
8
|
+
OXE é um fluxo **spec-driven** com artefatos em `.oxe/` no projeto alvo — **o núcleo é o mesmo** em Cursor, Copilot, Claude, OpenCode, Gemini, Codex, Windsurf, Antigravity ou outra CLI suportada pelo instalador. **Poucos comandos** por ferramenta em relação a fluxos de planeamento mais pesados; *context engineering* com arquivos pequenos por etapa. **GitHub Copilot (VS Code)** usa **`~/.copilot/`** após `npx oxe-cc` (bloco mesclado em `copilot-instructions.md` + **prompt files** em `~/.copilot/prompts/`), não `.github/` dentro do repo alvo por padrão; outras ferramentas usam os respetivos homes (ver secção **Multi-agente** abaixo).
|
|
9
|
+
|
|
10
|
+
No **projeto**, os passos canónicos estão em **`.oxe/workflows/*.md`** (layout mínimo) ou **`oxe/workflows/*.md`** (layout clássico com `--global`); no **pacote npm**, os modelos vivem em **`oxe/workflows/*.md`**.
|
|
11
|
+
</context>
|
|
12
|
+
|
|
13
|
+
<output>
|
|
14
|
+
## Modos de uso
|
|
15
|
+
|
|
16
|
+
Escolha a complexidade certa. Comece simples e adicione estrutura quando precisar.
|
|
17
|
+
|
|
18
|
+
**Nano** — 1 comando, zero overhead:
|
|
19
|
+
```
|
|
20
|
+
/oxe-quick
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Standard** — ciclo completo para features e refatorações:
|
|
24
|
+
```
|
|
25
|
+
/oxe-scan → /oxe-spec → /oxe-plan → /oxe-execute → /oxe-verify → /oxe-retro
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**Full** — sessões, multi-agente, dashboard, capabilities:
|
|
29
|
+
```
|
|
30
|
+
/oxe-session new <nome> → /oxe-plan --agents → /oxe-execute → /oxe-dashboard (opt-in)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
14
35
|
## Comandos principais
|
|
15
|
-
|
|
16
|
-
```
|
|
36
|
+
|
|
37
|
+
```
|
|
17
38
|
/oxe → onde estou / o que faço / help (entrada universal)
|
|
18
39
|
/oxe-ask → entender a situação atual com leitura robusta de STATE + sessão + artefatos
|
|
19
40
|
/oxe-obs → registrei algo importante — incorporado automaticamente nos próximos passos
|
|
20
41
|
/oxe-quick → tarefa pequena, sem cerimônia (com agentes lean quando necessário)
|
|
42
|
+
/oxe-capabilities → listar, instalar, remover ou atualizar capabilities nativas do projeto
|
|
21
43
|
/oxe-session → criar, alternar, retomar, fechar ou migrar sessões OXE
|
|
44
|
+
/oxe-cc azure → autenticar, sincronizar inventário e operar Azure Service Bus, Event Grid e Azure SQL com checkpoint
|
|
22
45
|
/oxe-scan → mapeia o projeto (ou atualiza o mapa se já existir)
|
|
23
|
-
/oxe-spec → nova feature: perguntas → pesquisa → requisitos → roteiro → aprovação
|
|
24
|
-
/oxe-plan → tarefas por onda (--agents para blueprint multi-agente)
|
|
25
|
-
/oxe-execute → implementar (A: 1 sessão | B: por onda | C: por tarefa)
|
|
26
|
-
/oxe-verify → validar (camadas 5+6 opcionais via config: gaps + segurança)
|
|
27
|
-
|
|
28
|
-
|
|
46
|
+
/oxe-spec → nova feature: perguntas → pesquisa → requisitos → roteiro → aprovação
|
|
47
|
+
/oxe-plan → tarefas por onda (--agents para blueprint multi-agente)
|
|
48
|
+
/oxe-execute → implementar (A: 1 sessão | B: por onda | C: por tarefa)
|
|
49
|
+
/oxe-verify → validar (camadas 5+6 opcionais via config: gaps + segurança)
|
|
50
|
+
/oxe-dashboard → visão web opt-in para revisão de equipe e aprovação do plano
|
|
51
|
+
```
|
|
52
|
+
|
|
29
53
|
Tudo o mais é ativado automaticamente por contexto, por config, ou existe como escape hatch.
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
33
57
|
## Sessões OXE
|
|
34
58
|
|
|
35
59
|
- `active_session` em `.oxe/STATE.md` define a sessão ativa com path relativo completo (`sessions/sNNN-slug`).
|
|
36
60
|
- Com sessão ativa, workflows de spec/plan/execute/verify e suportes ligados à trilha escrevem em `.oxe/<active_session>/...`.
|
|
37
61
|
- Permanecem globais: `.oxe/STATE.md`, `.oxe/config.json`, `.oxe/codebase/`, `.oxe/SESSIONS.md`, `.oxe/global/LESSONS.md`, `.oxe/global/MILESTONES.md`.
|
|
38
62
|
- `oxe-cc status` / `doctor` devem refletir a sessão ativa, a autoavaliação do plano e a saúde lógica do fluxo.
|
|
63
|
+
- O escopo ativo também pode ter `EXECUTION-RUNTIME.md`, `CHECKPOINTS.md` e `INVESTIGATIONS.md` para operação, approvals e evidência.
|
|
64
|
+
- Quando o projeto usa Azure, o provider nativo materializa `.oxe/cloud/azure/profile.json`, `auth-status.json`, `inventory.json` e `INVENTORY.md`; estes artefatos alimentam `ask`, `spec`, `plan`, `execute`, `verify`, `status`, `doctor` e o dashboard.
|
|
39
65
|
|
|
40
66
|
### `/oxe-session`
|
|
41
67
|
|
|
@@ -47,94 +73,99 @@ Tudo o mais é ativado automaticamente por contexto, por config, ou existe como
|
|
|
47
73
|
- `migrate <nome>` — move artefatos session-scoped da raiz para uma nova sessão
|
|
48
74
|
|
|
49
75
|
## Integrações principais (referência)
|
|
50
|
-
|
|
51
|
-
### Cursor
|
|
52
|
-
|
|
53
|
-
Slash commands essenciais: `/oxe`, `/oxe-obs`, `/oxe-quick`, `/oxe-scan`, `/oxe-spec`, `/oxe-plan`, `/oxe-execute`, `/oxe-verify`
|
|
54
|
-
|
|
55
|
-
Slash commands completos: `/oxe-discuss`, `/oxe-plan-agent`, `/oxe-project`, `/oxe-loop`, `/oxe-security`, `/oxe-update`, `/oxe-forensics`, `/oxe-debug`, `/oxe-route`, `/oxe-research`, `/oxe-validate-gaps`, `/oxe-compact`, `/oxe-checkpoint`, `/oxe-ui-spec`, `/oxe-ui-review`, `/oxe-milestone`, `/oxe-workstream`, `/oxe-next`, `/oxe-help` (instalados em `~/.cursor/commands/` pelo `oxe-cc`). **Review de PR:** no Cursor não há slash dedicado — peça em linguagem natural seguindo `oxe/workflows/review-pr.md` em contexto.
|
|
56
|
-
|
|
57
|
-
### GitHub Copilot (VS Code)
|
|
58
|
-
|
|
59
|
-
1. **Instruções do usuário:** arquivo **`~/.copilot/copilot-instructions.md`** (conteúdo mesclado pelo instalador; contém o bloco OXE entre marcadores).
|
|
60
|
-
2. **Prompt files:** em **`~/.copilot/prompts/`** (ex.: `oxe-scan.prompt.md`). No chat, `/` e escolha **`oxe-scan`**, **`oxe-spec`**, etc. Requer `"chat.promptFiles": true` (exemplo em `.vscode/settings.json` do repo com layout `--global`).
|
|
61
|
-
3. **`/oxe-review-pr`** — revisão de PR/diff (prompt na pasta do usuário; fluxo em `review-pr.md`).
|
|
62
|
-
|
|
63
|
-
**Checkpoint vs compact (rotina de contexto em disco):**
|
|
64
|
-
|
|
65
|
-
| Aspeto | `/oxe-checkpoint` | `/oxe-compact` |
|
|
66
|
-
|--------|-------------------|----------------|
|
|
67
|
-
| Escopo | Sessão / trilha atual | Projeto inteiro |
|
|
68
|
-
| Tempo | Curto prazo | Longo prazo |
|
|
69
|
-
| Foco | Progresso (onde parei) | Conhecimento (como o repo é hoje) |
|
|
70
|
-
| Uso | Pausar / retomar com nome | Evoluir mapa + resumo OXE |
|
|
71
|
-
| Output | Snapshot em `.oxe/checkpoints/` | `.oxe/codebase/*` + `CODEBASE-DELTA.md` + `RESUME.md` |
|
|
72
|
-
|
|
73
|
-
### Momentos chave (rotina)
|
|
74
|
-
|
|
75
|
-
Sugestão para integrar **checkpoint** e **compact** no dia a dia (não são obrigatórios do fluxo canónico; ver `compact.md` / `checkpoint.md`):
|
|
76
|
-
|
|
77
|
-
| Momento | `/oxe-checkpoint` | `/oxe-compact` |
|
|
78
|
-
|---------|-------------------|----------------|
|
|
79
|
-
| Antes de branch longa ou spike arriscado | Sim (slug + nota) | Opcional se o mapa já reflete o repo |
|
|
80
|
-
| Após migração de stack (ex.: Angular 17 → 21) | Opcional | Sim — alinhar `.oxe/codebase/` ao código + `CODEBASE-DELTA.md` |
|
|
81
|
-
| Fim de feature / antes de PR grande | Opcional | Sim — reduzir drift entre doc OXE e implementação |
|
|
82
|
-
| Fim de dia com trabalho a meio | Sim | Não obrigatório |
|
|
83
|
-
| Pós-`verify_complete`, antes de nova entrega | Opcional (estado estável) | Opcional refresh dos mapas |
|
|
84
|
-
|
|
85
|
-
Com **`compact_max_age_days`** em `.oxe/config.json` (ver `oxe/templates/CONFIG.md`), **`oxe-cc doctor`** / **`status`** podem avisar quando o último compact em `STATE.md` está antigo.
|
|
86
|
-
|
|
87
|
-
## Fluxo completo
|
|
88
|
-
|
|
89
|
-
0. **obs** *(qualquer momento)* — `/oxe-obs` registra uma observação contextual; incorporada automaticamente no próximo spec/plan/execute sem re-explicar.
|
|
90
|
-
1. **scan** — após clonar ou quando o codebase mudar. **Inteligente:** se `.oxe/codebase/` já existir, opera em modo refresh (incremental) automaticamente — sem precisar chamar `/oxe-compact` separadamente. Use `--full` para forçar scan completo. Repositórios **legado** (COBOL, JCL, VB6): aplica `legacy-brownfield.md` automaticamente.
|
|
91
|
-
2. **spec** — fluxo em **5 fases**: perguntas (máx 3 rodadas) → pesquisa (proposta inline na Fase 2, sem sair do spec) → requisitos R-ID (v1/v2/fora) → roteiro (`.oxe/ROADMAP.md`) → aprovação. Se `discuss_before_plan: true` na config, o próximo passo após aprovação é `oxe:discuss` antes de plan.
|
|
92
|
-
3. **plan** — plano executável + **Verificar** por tarefa. Se 3+ domínios distintos, **sugere automaticamente** blueprint de agentes (`/oxe-plan --agents`). Sem `--agents`: solo. Com `--agents`: gera também `plan-agents.json` (schema 3 com `model_hint`).
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
Slash commands essenciais: `/oxe`, `/oxe-obs`, `/oxe-quick`, `/oxe-scan`, `/oxe-spec`, `/oxe-plan`, `/oxe-execute`, `/oxe-verify`
|
|
80
|
+
|
|
81
|
+
Slash commands completos: `/oxe-discuss`, `/oxe-plan-agent`, `/oxe-project`, `/oxe-loop`, `/oxe-security`, `/oxe-update`, `/oxe-forensics`, `/oxe-debug`, `/oxe-route`, `/oxe-research`, `/oxe-validate-gaps`, `/oxe-compact`, `/oxe-checkpoint`, `/oxe-ui-spec`, `/oxe-ui-review`, `/oxe-milestone`, `/oxe-workstream`, `/oxe-next`, `/oxe-help` (instalados em `~/.cursor/commands/` pelo `oxe-cc`). **Review de PR:** no Cursor não há slash dedicado — peça em linguagem natural seguindo `oxe/workflows/review-pr.md` em contexto.
|
|
82
|
+
|
|
83
|
+
### GitHub Copilot (VS Code)
|
|
84
|
+
|
|
85
|
+
1. **Instruções do usuário:** arquivo **`~/.copilot/copilot-instructions.md`** (conteúdo mesclado pelo instalador; contém o bloco OXE entre marcadores).
|
|
86
|
+
2. **Prompt files:** em **`~/.copilot/prompts/`** (ex.: `oxe-scan.prompt.md`). No chat, `/` e escolha **`oxe-scan`**, **`oxe-spec`**, etc. Requer `"chat.promptFiles": true` (exemplo em `.vscode/settings.json` do repo com layout `--global`).
|
|
87
|
+
3. **`/oxe-review-pr`** — revisão de PR/diff (prompt na pasta do usuário; fluxo em `review-pr.md`).
|
|
88
|
+
|
|
89
|
+
**Checkpoint vs compact (rotina de contexto em disco):**
|
|
90
|
+
|
|
91
|
+
| Aspeto | `/oxe-checkpoint` | `/oxe-compact` |
|
|
92
|
+
|--------|-------------------|----------------|
|
|
93
|
+
| Escopo | Sessão / trilha atual | Projeto inteiro |
|
|
94
|
+
| Tempo | Curto prazo | Longo prazo |
|
|
95
|
+
| Foco | Progresso (onde parei) | Conhecimento (como o repo é hoje) |
|
|
96
|
+
| Uso | Pausar / retomar com nome | Evoluir mapa + resumo OXE |
|
|
97
|
+
| Output | Snapshot em `.oxe/checkpoints/` | `.oxe/codebase/*` + `CODEBASE-DELTA.md` + `RESUME.md` |
|
|
98
|
+
|
|
99
|
+
### Momentos chave (rotina)
|
|
100
|
+
|
|
101
|
+
Sugestão para integrar **checkpoint** e **compact** no dia a dia (não são obrigatórios do fluxo canónico; ver `compact.md` / `checkpoint.md`):
|
|
102
|
+
|
|
103
|
+
| Momento | `/oxe-checkpoint` | `/oxe-compact` |
|
|
104
|
+
|---------|-------------------|----------------|
|
|
105
|
+
| Antes de branch longa ou spike arriscado | Sim (slug + nota) | Opcional se o mapa já reflete o repo |
|
|
106
|
+
| Após migração de stack (ex.: Angular 17 → 21) | Opcional | Sim — alinhar `.oxe/codebase/` ao código + `CODEBASE-DELTA.md` |
|
|
107
|
+
| Fim de feature / antes de PR grande | Opcional | Sim — reduzir drift entre doc OXE e implementação |
|
|
108
|
+
| Fim de dia com trabalho a meio | Sim | Não obrigatório |
|
|
109
|
+
| Pós-`verify_complete`, antes de nova entrega | Opcional (estado estável) | Opcional refresh dos mapas |
|
|
110
|
+
|
|
111
|
+
Com **`compact_max_age_days`** em `.oxe/config.json` (ver `oxe/templates/CONFIG.md`), **`oxe-cc doctor`** / **`status`** podem avisar quando o último compact em `STATE.md` está antigo.
|
|
112
|
+
|
|
113
|
+
## Fluxo completo
|
|
114
|
+
|
|
115
|
+
0. **obs** *(qualquer momento)* — `/oxe-obs` registra uma observação contextual; incorporada automaticamente no próximo spec/plan/execute sem re-explicar.
|
|
116
|
+
1. **scan** — após clonar ou quando o codebase mudar. **Inteligente:** se `.oxe/codebase/` já existir, opera em modo refresh (incremental) automaticamente — sem precisar chamar `/oxe-compact` separadamente. Use `--full` para forçar scan completo. Repositórios **legado** (COBOL, JCL, VB6): aplica `legacy-brownfield.md` automaticamente.
|
|
117
|
+
2. **spec** — fluxo em **5 fases**: perguntas (máx 3 rodadas) → pesquisa (proposta inline na Fase 2, sem sair do spec) → requisitos R-ID (v1/v2/fora) → roteiro (`.oxe/ROADMAP.md`) → aprovação. Se `discuss_before_plan: true` na config, o próximo passo após aprovação é `oxe:discuss` antes de plan.
|
|
118
|
+
3. **plan** — plano executável + **Verificar** por tarefa. Se 3+ domínios distintos, **sugere automaticamente** blueprint de agentes (`/oxe-plan --agents`). Sem `--agents`: solo. Com `--agents`: gera também `plan-agents.json` (schema 3 com `model_hint`).
|
|
93
119
|
4. **execute** — modo selecionado 1 vez: **A) Completo** (1 sessão), **B) Por onda**, **C) Por tarefa**. Antes de executar, validar a **Autoavaliação do Plano**: se `Melhor plano atual: não` ou a confiança estiver abaixo do limiar, o fluxo deve replanear em vez de implementar. Se Verificar falhar inline: diagnóstico automático (2-3 hipóteses + fix), sem precisar chamar `/oxe-debug` separadamente. Escalação para `/oxe-forensics` só se esgotar tentativas.
|
|
94
|
-
5. **verify** — até **6 camadas** por config: auditoria pré-exec, tarefas + critérios A*, fidelidade D-NN, **calibração do plano**, UAT, **gaps de cobertura** (camada 5 — `verification_depth: "thorough"`), **segurança OWASP** (camada 6 — `security_in_verify: true`). Sem comandos extras.
|
|
95
|
-
6. **retro** *(opcional, recomendado após verify_complete)* — `/oxe-retro` sintetiza 3–5 lições prescritivas em `.oxe/LESSONS.md`. Cada lição diz **o que fazer diferente** no próximo ciclo — consumida automaticamente pelo próximo spec/plan.
|
|
96
|
-
7. **→ próximo ciclo** — spec/plan do próximo ciclo lê LESSONS.md automaticamente. Os erros do ciclo anterior não se repetem.
|
|
97
|
-
|
|
98
|
-
**Escape hatches (não precisam ser decorados — aparecem quando necessários):**
|
|
99
|
-
|
|
100
|
-
- **`/oxe-forensics`** — sugerido automaticamente pelo execute/verify quando falha persiste. Diagnóstico pós-falha + 1 caminho de reentrada.
|
|
101
|
-
- **`/oxe-debug`** — diagnóstico técnico inline durante execute (já integrado ao execute; disponível standalone para controle explícito).
|
|
102
|
-
- **`/oxe-loop`** — iteração até verify passar (disponível standalone; integrado ao Modo B do execute via `loop_max`).
|
|
103
|
-
- **`/oxe-research`** — notas datadas em `.oxe/research/` para spikes, mapas de sistema, engenharia reversa.
|
|
104
|
-
- **`/oxe-
|
|
105
|
-
- **`/oxe-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
|
123
|
-
|
|
124
|
-
| **
|
|
125
|
-
|
|
126
|
-
**
|
|
127
|
-
|
|
128
|
-
**
|
|
129
|
-
|
|
130
|
-
**
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
120
|
+
5. **verify** — até **6 camadas** por config: auditoria pré-exec, tarefas + critérios A*, fidelidade D-NN, **coerência operacional** (runtime + checkpoints), **calibração do plano**, UAT, **gaps de cobertura** (camada 5 — `verification_depth: "thorough"`), **segurança OWASP** (camada 6 — `security_in_verify: true`). Sem comandos extras.
|
|
121
|
+
6. **retro** *(opcional, recomendado após verify_complete)* — `/oxe-retro` sintetiza 3–5 lições prescritivas em `.oxe/LESSONS.md`. Cada lição diz **o que fazer diferente** no próximo ciclo — consumida automaticamente pelo próximo spec/plan.
|
|
122
|
+
7. **→ próximo ciclo** — spec/plan do próximo ciclo lê LESSONS.md automaticamente. Os erros do ciclo anterior não se repetem.
|
|
123
|
+
|
|
124
|
+
**Escape hatches (não precisam ser decorados — aparecem quando necessários):**
|
|
125
|
+
|
|
126
|
+
- **`/oxe-forensics`** — sugerido automaticamente pelo execute/verify quando falha persiste. Diagnóstico pós-falha + 1 caminho de reentrada.
|
|
127
|
+
- **`/oxe-debug`** — diagnóstico técnico inline durante execute (já integrado ao execute; disponível standalone para controle explícito).
|
|
128
|
+
- **`/oxe-loop`** — iteração até verify passar (disponível standalone; integrado ao Modo B do execute via `loop_max`).
|
|
129
|
+
- **`/oxe-research`** — notas datadas em `.oxe/research/` para spikes, mapas de sistema, engenharia reversa.
|
|
130
|
+
- **`/oxe-capabilities`** — catálogo nativo de capabilities locais, por script ou conector, com metadata e diagnóstico.
|
|
131
|
+
- **`/oxe-dashboard`** — leitura visual/operacional do runtime, checkpoints e ondas ativas.
|
|
132
|
+
- **`/oxe-route`** — traduz linguagem natural → comando. Equivalente a `/oxe [texto]`.
|
|
133
|
+
- **`/oxe-compact`** — refresh explícito do codebase. Equivalente a `/oxe-scan` sem `--full`.
|
|
134
|
+
|
|
135
|
+
**Gestão de projeto (`/oxe-project`):**
|
|
136
|
+
|
|
137
|
+
Um único comando para: `milestone new|complete|status|audit`, `workstream new|switch|list|close <nome>`, `checkpoint [slug]`. Sem argumento: mostra status atual.
|
|
138
|
+
|
|
139
|
+
**Vertical UI (opcional, mesma trilha):**
|
|
140
|
+
|
|
141
|
+
- **`/oxe-ui-spec`** — após **spec**, contrato `.oxe/UI-SPEC.md` antes ou para alimentar o **plan** (ver `ui-spec.md`).
|
|
142
|
+
- **`/oxe-ui-review`** — após implementação UI, auditoria `.oxe/UI-REVIEW.md` antes ou como entrada para **verify** (ver `ui-review.md`).
|
|
143
|
+
|
|
144
|
+
## Modo rápido (quick) com Plan-Driven Dynamic Agents lean
|
|
145
|
+
|
|
146
|
+
- **`/oxe-quick`**: cria `.oxe/QUICK.md` (passos curtos + verificar) sem SPEC/PLAN longos, integrando o conceito de **Plan-Driven Dynamic Agents (lean)**:
|
|
147
|
+
|
|
148
|
+
| Princípio | Como se manifesta no Quick |
|
|
149
|
+
|-----------|---------------------------|
|
|
150
|
+
| **Spec-Driven Design** | `## Objetivo` é a minispec — restringe o escopo de todos os agentes e passos |
|
|
151
|
+
| **Spec-Driven Development** | `## Passos` é o mini-plano — os agentes são derivados dos passos, não os definem |
|
|
152
|
+
| **Plan-Driven Dynamic Agents** | Agentes criados **a partir dos passos**, para **esta demanda**, invalidados ao terminar |
|
|
153
|
+
|
|
154
|
+
**Quando ativar agentes:** tarefa com 2+ domínios distintos (ex.: backend + frontend), 5+ passos que agrupam naturalmente, ou flag `--agents`. Máx. 3 agentes — se precisar de mais, promover para `/oxe-plan-agent`.
|
|
155
|
+
|
|
156
|
+
**Artefatos com agentes:** além de `.oxe/QUICK.md` (com seção `## Agentes dinâmicos`), cria **`.oxe/quick-agents.json`** (schema lean; `status: active` → `done` após verify). Sem handoff de mensagens entre agentes (lean — sem `.oxe/plan-agent-messages/`).
|
|
157
|
+
|
|
158
|
+
**Perfil fast (sem agentes):** objetivo numa frase, ≤10 passos, verificação. **Promova** para spec/plan se o trabalho crescer (muitos arquivos, API pública, segurança, ou > 3 domínios). Se existir **`.oxe/plan-agents.json`** (schema 2) ainda activo, o quick **invalida** o blueprint — não reutilizar esses agentes neste fluxo; para novo roteiro com agentes, **`/oxe-plan-agent`**.
|
|
159
|
+
|
|
160
|
+
## CLI (terminal)
|
|
161
|
+
|
|
162
|
+
- **`npx oxe-cc`** ou **`npx oxe-cc install`** — mesma instalação (alias explícito).
|
|
163
|
+
- Instala workflows em `.oxe/` (layout mínimo) ou `oxe/` + `.oxe/` com **`--global`**; integrações em `~/.cursor`, `~/.copilot`, `~/.claude` (e mais destinos com **`--copilot-cli`** / **`--all-agents`**).
|
|
136
164
|
- **`oxe-cc doctor`** — Node, workflows do pacote vs projeto, `config.json`, bootstrap mínimo de `.oxe/`, mapas do codebase, **coerência STATE vs arquivos**, sessão ativa, autoavaliação do plano, scan antigo (`scan_max_age_days`), compact antigo (`compact_max_age_days`), seções SPEC, ondas do PLAN e **saúde lógica** (`healthy` | `warning` | `broken`).
|
|
137
|
-
- **`oxe-cc status`** — coerência `.oxe/` + **um** próximo passo (espelha `next.md`). Com **`--json`**, uma linha JSON com `healthStatus`, `activeSession`, `planSelfEvaluation` e `diagnostics` completos
|
|
165
|
+
- **`oxe-cc status`** — coerência `.oxe/` + **um** próximo passo (espelha `next.md`). Com **`--full`**, visão ANSI extendida: coverage matrix (SPEC/PLAN/VERIFY/LESSONS), readiness gate e active run — caminho padrão de inspeção no terminal. Com **`--json`**, uma linha JSON com `healthStatus`, `activeSession`, `planSelfEvaluation` e `diagnostics` completos. Com **`--hints`**, bloco **Lembretes (rotina OXE)**.
|
|
166
|
+
- **`oxe-cc dashboard`** — UI web opt-in em `localhost` para revisão de equipe e aprovação do plano; use `oxe-cc status --full` para inspeção diária no terminal. Fonte de verdade: apenas artefatos OXE reais, incluindo `ACTIVE-RUN.json` e `OXE-EVENTS.ndjson`.
|
|
167
|
+
- **`oxe-cc runtime`** — controla explicitamente `ACTIVE-RUN.json`, `runs/` e `OXE-EVENTS.ndjson` com ações `start`, `pause`, `resume`, `replay` e `status`.
|
|
168
|
+
- **`oxe-cc azure`** — provider Azure local-first via Azure CLI (opt-in, apenas quando o projeto usa Azure): `status`, `doctor`, `auth login [--tenant <id>]`, `auth set-subscription --subscription <id>`, `sync [--diff]`, `find [--type] [--filter-rg]`, `servicebus`, `eventgrid`, `sql`, `operations list`. Flags: `--dry-run`, `--vpn-confirmed`. **Fluxo corporativo Entra ID:** `auth login --tenant <tenant-id>` → `auth set-subscription --subscription <dev-sub-id>`.
|
|
138
169
|
- **`oxe-cc init-oxe`** — só bootstrap `.oxe/` (STATE, config, codebase).
|
|
139
170
|
- **`oxe-cc uninstall`** — remove integrações no HOME e, por omissão, pastas de workflows no repo (`--ide-only` só HOME).
|
|
140
171
|
- **`oxe-cc uninstall --global-cli`** — além da limpeza dos artefatos OXE, executa `npm uninstall -g oxe-cc` para remover o binário global do PATH.
|
|
@@ -142,121 +173,121 @@ Um único comando para: `milestone new|complete|status|audit`, `workstream new|s
|
|
|
142
173
|
- **`oxe-cc update --check`** — só comparar versão em execução com a `latest` no npm (sem instalar).
|
|
143
174
|
- **`oxe-cc update --if-newer`** — só executa o `npx oxe-cc@latest` se houver versão mais nova no npm.
|
|
144
175
|
- **`oxe-cc update` / `npx oxe-cc@latest --force`** — atualizar ficheiros OXE no projeto. Aceita flags extras como `--ide-local`, `--cursor`, `--copilot-cli`, `--global`, `--global-cli`.
|
|
145
|
-
|
|
146
|
-
**CI / sem perguntas:** `OXE_NO_PROMPT=1` — layout mínimo e integrações padrão no HOME, salvo flags (`--global`, `--cursor`, …). Se existir **`.oxe/config.json`** com bloco **`install`** (perfil, `repo_layout`), aplica-se quando **não** há flags IDE explícitas; para ignorar: **`--no-install-config`**. Detalhes: `oxe/templates/CONFIG.md`.
|
|
147
|
-
|
|
148
|
-
**Flags úteis (resumo):** `--force` / `-f`, `--dry-run`, `--all` / `-a` (Cursor+Copilot), `--oxe-only`, `--no-init-oxe`, `--global` / `--local`, `--copilot-cli`, `--all-agents`, `--vscode` (com `--global`), `--no-global-cli` / `-l`, `--config-dir` / `-c` (uma IDE de cada vez), `--dir <pasta>`. Ajuda completa: `oxe-cc --help`.
|
|
149
|
-
|
|
150
|
-
**WSL:** usar Node instalado **no** WSL; o instalador recusa Node do Windows dentro do WSL.
|
|
151
|
-
|
|
152
|
-
## Router (linguagem natural)
|
|
153
|
-
|
|
154
|
-
Um pedido → **um** destino (sem gerar contrato). O agente aplica `route.md` ou usa esta tabela:
|
|
155
|
-
|
|
156
|
-
| Se o utilizador disser (exemplos) | Comando / ação |
|
|
157
|
-
|-----------------------------------|----------------|
|
|
176
|
+
|
|
177
|
+
**CI / sem perguntas:** `OXE_NO_PROMPT=1` — layout mínimo e integrações padrão no HOME, salvo flags (`--global`, `--cursor`, …). Se existir **`.oxe/config.json`** com bloco **`install`** (perfil, `repo_layout`), aplica-se quando **não** há flags IDE explícitas; para ignorar: **`--no-install-config`**. Detalhes: `oxe/templates/CONFIG.md`.
|
|
178
|
+
|
|
179
|
+
**Flags úteis (resumo):** `--force` / `-f`, `--dry-run`, `--all` / `-a` (Cursor+Copilot), `--oxe-only`, `--no-init-oxe`, `--global` / `--local`, `--copilot-cli`, `--all-agents`, `--vscode` (com `--global`), `--no-global-cli` / `-l`, `--config-dir` / `-c` (uma IDE de cada vez), `--dir <pasta>`. Ajuda completa: `oxe-cc --help`.
|
|
180
|
+
|
|
181
|
+
**WSL:** usar Node instalado **no** WSL; o instalador recusa Node do Windows dentro do WSL.
|
|
182
|
+
|
|
183
|
+
## Router (linguagem natural)
|
|
184
|
+
|
|
185
|
+
Um pedido → **um** destino (sem gerar contrato). O agente aplica `route.md` ou usa esta tabela:
|
|
186
|
+
|
|
187
|
+
| Se o utilizador disser (exemplos) | Comando / ação |
|
|
188
|
+
|-----------------------------------|----------------|
|
|
158
189
|
| Não sei que passo OXE sou / “o que faço agora?” | `/oxe-next` ou `npx oxe-cc status` |
|
|
159
190
|
| Quero entender rapidamente a situação real da trilha atual | `/oxe-ask [pergunta]` |
|
|
160
191
|
| Acabei de clonar / falta OXE no projeto | `npx oxe-cc@latest` (ou `oxe-cc`) na raiz do repo |
|
|
161
|
-
| Verify falhou várias vezes / doctor estranho / artefatos incoerentes | `/oxe-forensics` |
|
|
162
|
-
| Teste ou erro técnico durante o trabalho (stack, flake) | `/oxe-debug` (com **Tn** se houver) |
|
|
163
|
-
| Revisar diff / PR antes do merge | `oxe/workflows/review-pr.md` em contexto *(Copilot: `/oxe-review-pr`)* |
|
|
164
|
-
| O que é OXE / lista de passos | `/oxe-help` |
|
|
165
|
-
| Dúvida entre dois comandos sem contexto claro | `/oxe-route` |
|
|
166
|
-
| Pesquisa técnica, spike, mapa de sistema grande, engenharia reversa, modernização antes do plano | `/oxe-research` |
|
|
167
|
-
| Quero registrar uma observação (restrição, descoberta, preferência) durante ou fora de execução | `/oxe-obs [texto]` |
|
|
168
|
-
| Quero executar todo o plano de uma vez (1 sessão) | `/oxe-execute` → escolher opção A (Completo) |
|
|
169
|
-
| Quero executar onda por onda com verificação entre ondas | `/oxe-execute` → escolher opção B (Por onda) |
|
|
170
|
-
| Gaps de cobertura de verificação / Nyquist-lite após verify | `/oxe-validate-gaps` |
|
|
171
|
-
| Mapa OXE desatualizado / quero sincronizar codebase com o código sem scan completo | `/oxe-compact` |
|
|
172
|
-
| Quero gravar um marco nomeado da sessão (antes de experimento grande) | `/oxe-checkpoint` + slug |
|
|
173
|
-
| Plano com **blueprint de agentes** (JSON + mesmo PLAN.md) / subagentes por onda | `/oxe-plan-agent` |
|
|
174
|
-
| Criar marco de entrega / versão / milestone | `/oxe-milestone new [nome]` |
|
|
175
|
-
| Verificar se o milestone está pronto para fechar | `/oxe-milestone audit` |
|
|
176
|
-
| Trabalho paralelo em trilhas separadas / feature branch OXE | `/oxe-workstream new <nome>` |
|
|
177
|
-
| Alternar entre trilhas de desenvolvimento | `/oxe-workstream switch <nome>` |
|
|
178
|
-
|
|
179
|
-
## Observações Contextuais (`/oxe-obs`)
|
|
180
|
-
|
|
181
|
-
**Princípio:** *observation-without-re-explaining* — registre uma observação em 1 request; ela é incorporada automaticamente nos workflows seguintes sem precisar re-explicar.
|
|
182
|
-
|
|
183
|
-
```
|
|
184
|
-
/oxe-obs JWT expiration deve ser via env var JWT_EXPIRES_IN, não hardcoded
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
- **Quando usar:** durante execute (descoberta técnica), após scan (restrição identificada), após spec (ajuste de escopo), a qualquer momento
|
|
188
|
-
- **Impacto:** classificado automaticamente em `spec` | `plan` | `execute` | `all`
|
|
189
|
-
- **Auto-incorporação:** o próximo `/oxe-spec` (Fase 3), `/oxe-plan`, `/oxe-discuss` ou `/oxe-execute` lê `.oxe/OBSERVATIONS.md` e aplica observações pendentes sem prompt extra
|
|
190
|
-
- **Urgência execute:** se chamado durante `executing` com impacto execute, oferece pausar onda atual ou continuar
|
|
191
|
-
|
|
192
|
-
## Notas pré-trilha (opcional)
|
|
193
|
-
|
|
194
|
-
- Ficheiro **`.oxe/NOTES.md`**: bullets `YYYY-MM-DD — …` como fila leve (**não** substitui SPEC). Em **`/oxe-discuss`**, **`/oxe-plan`** e **`/oxe-plan-agent`**, consumir ou marcar descartado/adiado.
|
|
195
|
-
|
|
196
|
-
## Milestones e Workstreams
|
|
197
|
-
|
|
198
|
-
- **`/oxe-milestone new [nome]`** — iniciar marco de entrega (M-01, M-02, …); registrado em `.oxe/MILESTONES.md`.
|
|
199
|
-
- **`/oxe-milestone complete`** — fechar milestone ativo, arquivar artefatos em `.oxe/milestones/M-NN/`.
|
|
200
|
-
- **`/oxe-milestone status`** / **`/oxe-milestone audit`** — progresso e Definition of Done.
|
|
201
|
-
- **`/oxe-workstream new <nome>`** — trilha paralela em `.oxe/workstreams/<nome>/`.
|
|
202
|
-
- **`/oxe-workstream switch <nome>`** — definir workstream ativo; workflows operam nos artefatos dessa trilha.
|
|
203
|
-
- **`/oxe-workstream list`** / **`/oxe-workstream close <nome>`** — gerenciar trilhas.
|
|
204
|
-
|
|
205
|
-
## Personas de agentes
|
|
206
|
-
|
|
207
|
-
Arquivos em `oxe/personas/` (ou `.oxe/personas/` após instalação) definem comportamentos de agentes para uso com `/oxe-plan-agent`. Personas builtin: `executor`, `planner`, `verifier`, `researcher`, `debugger`, `architect`, `ui-specialist`, `db-specialist`. Personas customizadas do projeto ficam em `.oxe/personas/`.
|
|
208
|
-
|
|
209
|
-
## Profiles de execução
|
|
210
|
-
|
|
211
|
-
O campo `profile` em `.oxe/config.json` expande automaticamente múltiplas keys:
|
|
212
|
-
- **`balanced`** (padrão): cerimônia moderada, verificação standard.
|
|
213
|
-
- **`strict`**: discuss obrigatório, verificação 4 camadas, UAT, aviso de scan antigo.
|
|
214
|
-
- **`fast`**: sem discuss, verificação quick, sem UAT.
|
|
215
|
-
- **`legacy`**: discuss obrigatório, verificação thorough, sem comando de test assumido.
|
|
216
|
-
|
|
217
|
-
## SDK (API programática)
|
|
218
|
-
|
|
219
|
-
Quem integra em pipeline pode usar **`require('oxe-cc')`** (entrada `main` do pacote):
|
|
220
|
-
- **`runDoctorChecks({ projectRoot })`** — gate em CI.
|
|
221
|
-
- **`parsePlan(planMd)`** — extrai tarefas, ondas, decisões e metadata de PLAN.md.
|
|
222
|
-
- **`parseSpec(specMd)`** — extrai critérios A* e seções obrigatórias.
|
|
223
|
-
- **`parseState(stateMd)`** — extrai fase, scan date, workstreams, milestone ativo.
|
|
224
|
-
- **`validateDecisionFidelity(discussMd, planMd)`** — verifica cobertura de decisões D-NN.
|
|
225
|
-
- **`security.checkPathSafety(path, root)`** — valida caminhos contra path traversal e segredos.
|
|
226
|
-
- **`plugins.loadPlugins(projectRoot)`** / **`plugins.runHook(plugins, hook, ctx)`** — plugin lifecycle.
|
|
227
|
-
- **`health.expandExecutionProfile(profile)`** — expande profile em keys individuais.
|
|
228
|
-
|
|
229
|
-
Ver **`lib/sdk/README.md`** e **`lib/sdk/index.d.ts`**.
|
|
230
|
-
|
|
231
|
-
## Variáveis de ambiente (referência)
|
|
232
|
-
|
|
233
|
-
| Variável | Uso |
|
|
234
|
-
|----------|-----|
|
|
235
|
-
| `OXE_NO_PROMPT` | `1` / `true`: sem menus interativos |
|
|
236
|
-
| `OXE_NO_BANNER` | `1` / `true`: sem banner no CLI |
|
|
237
|
-
| `OXE_UPDATE_SKIP_REGISTRY` | `1` / `true`: não consultar npm em `update --check` / `--if-newer` (saída `2` ou skip) |
|
|
238
|
-
| `CURSOR_CONFIG_DIR` | Base Cursor (default `~/.cursor`) |
|
|
239
|
-
| `COPILOT_CONFIG_DIR` / `COPILOT_HOME` | Base Copilot |
|
|
240
|
-
| `CLAUDE_CONFIG_DIR` | Base `~/.claude` |
|
|
241
|
-
| `XDG_CONFIG_HOME` | OpenCode e outros (multi-agente) |
|
|
242
|
-
| `CODEX_HOME` | Prompts Codex em instalação multi-agente |
|
|
243
|
-
|
|
244
|
-
## Artefatos
|
|
245
|
-
|
|
246
|
-
- `.oxe/STATE.md`, `.oxe/config.json` (opcional), `.oxe/codebase/*`, `.oxe/SPEC.md`, `.oxe/DISCUSS.md` (opcional, com IDs D-NN), `.oxe/PLAN.md`, `.oxe/VERIFY.md`, `.oxe/QUICK.md`, `.oxe/SUMMARY.md` (opcional), `.oxe/NOTES.md` (opcional, fila), `.oxe/RESUME.md` (opcional, trilha + ponte para delta), `.oxe/CODEBASE-DELTA.md` (opcional, último refresh documentado do codebase), `.oxe/CHECKPOINTS.md` (opcional, índice), `.oxe/checkpoints/*.md` (opcional, marcos de sessão), `.oxe/RESEARCH.md` (opcional, índice de pesquisa), `.oxe/research/*.md` (opcional, notas datadas), `.oxe/VALIDATION-GAPS.md` (opcional, pós-verify), `.oxe/FORENSICS.md` (opcional, recuperação), `.oxe/DEBUG.md` (opcional, sessões de debug), `.oxe/UI-SPEC.md` / `.oxe/UI-REVIEW.md` (opcional, front-end)
|
|
247
|
-
- **Novos artefatos:** `.oxe/MILESTONES.md` (marcos de entrega), `.oxe/milestones/M-NN/` (artefatos arquivados), `.oxe/workstreams/<nome>/` (trilhas paralelas), `.oxe/personas/*.md` (personas de agentes customizadas), `.oxe/plugins/*.cjs` (plugins de lifecycle), `.oxe/memory/*.md` (sidecars de memória por sessão).
|
|
248
|
-
- Templates: `oxe/templates/` (ou `.oxe/templates/` em layout aninhado, conforme instalação). Hooks Git **opt-in** (lembretes não bloqueantes): `oxe/templates/GIT_HOOKS_OXE.md`. Plugin system: `oxe/templates/PLUGINS.md`.
|
|
249
|
-
|
|
250
|
-
## Para autores (mantenedores)
|
|
251
|
-
|
|
252
|
-
- Guia de autoria dos workflows: **`oxe/templates/WORKFLOW_AUTHORING.md`** (no pacote) ou **`.oxe/templates/WORKFLOW_AUTHORING.md`** após instalação em layout aninhado.
|
|
253
|
-
- Revisão guiada de um ficheiro de workflow contra esse guia: workflow **`workflow-authoring.md`** (mesma pasta que os outros passos).
|
|
254
|
-
|
|
255
|
-
## Gatilhos em linguagem natural
|
|
256
|
-
|
|
257
|
-
Quando o usuário disser “oxe scan”, “oxe quick”, “executar onda OXE”, “revisar PR”, “forensics”, “debug OXE”, “oxe research”, “oxe compact”, “refresh codebase”, “sincronizar mapa OXE”, “oxe resume”, “oxe checkpoint”, “mapa do sistema”, “engenharia reversa”, “modernização”, “validate gaps”, “Nyquist-lite”, “UI spec”, “roteamento OXE”, “rever um workflow OXE” / “alinhar ao guia de autoria”, etc., siga o workflow correspondente em `oxe/workflows/*.md` ou `.oxe/workflows/*.md` (autoria: `workflow-authoring.md`; meta: `route.md`).
|
|
258
|
-
|
|
259
|
-
**GitHub Copilot CLI:** com `oxe-cc --copilot-cli`, use **agent skills** em **`~/.copilot/skills/`** — invoque **`/oxe`** (entrada, mesmo conteúdo que help) ou **`/oxe-scan`**, **`/oxe-plan`**, etc. Após instalar ou atualizar: **`/skills reload`** (ou reinicie o `copilot`). A pasta **`~/.copilot/commands/`** é só cópia legado; o CLI oficial não a usa como slash commands.
|
|
260
|
-
|
|
261
|
-
**Multi-agente:** `npx oxe-cc --all-agents` (ou opção **6** no instalador) replica os mesmos fluxos para **OpenCode** (`~/.config/opencode/commands` + `~/.opencode/commands`), **Gemini CLI** (`~/.gemini/commands` — `/oxe`, `/oxe:scan`, …; use **`/commands reload`**), **Codex** (`~/.agents/skills` + `~/.codex/prompts` com `/prompts:oxe-*`), **Windsurf** (`~/.codeium/windsurf/global_workflows` — `/oxe-scan`), **Google Antigravity** (`~/.gemini/antigravity/skills`), além de **Claude** (`~/.claude/commands`) e o já descrito Copilot.
|
|
262
|
-
</output>
|
|
192
|
+
| Verify falhou várias vezes / doctor estranho / artefatos incoerentes | `/oxe-forensics` |
|
|
193
|
+
| Teste ou erro técnico durante o trabalho (stack, flake) | `/oxe-debug` (com **Tn** se houver) |
|
|
194
|
+
| Revisar diff / PR antes do merge | `oxe/workflows/review-pr.md` em contexto *(Copilot: `/oxe-review-pr`)* |
|
|
195
|
+
| O que é OXE / lista de passos | `/oxe-help` |
|
|
196
|
+
| Dúvida entre dois comandos sem contexto claro | `/oxe-route` |
|
|
197
|
+
| Pesquisa técnica, spike, mapa de sistema grande, engenharia reversa, modernização antes do plano | `/oxe-research` |
|
|
198
|
+
| Quero registrar uma observação (restrição, descoberta, preferência) durante ou fora de execução | `/oxe-obs [texto]` |
|
|
199
|
+
| Quero executar todo o plano de uma vez (1 sessão) | `/oxe-execute` → escolher opção A (Completo) |
|
|
200
|
+
| Quero executar onda por onda com verificação entre ondas | `/oxe-execute` → escolher opção B (Por onda) |
|
|
201
|
+
| Gaps de cobertura de verificação / Nyquist-lite após verify | `/oxe-validate-gaps` |
|
|
202
|
+
| Mapa OXE desatualizado / quero sincronizar codebase com o código sem scan completo | `/oxe-compact` |
|
|
203
|
+
| Quero gravar um marco nomeado da sessão (antes de experimento grande) | `/oxe-checkpoint` + slug |
|
|
204
|
+
| Plano com **blueprint de agentes** (JSON + mesmo PLAN.md) / subagentes por onda | `/oxe-plan-agent` |
|
|
205
|
+
| Criar marco de entrega / versão / milestone | `/oxe-milestone new [nome]` |
|
|
206
|
+
| Verificar se o milestone está pronto para fechar | `/oxe-milestone audit` |
|
|
207
|
+
| Trabalho paralelo em trilhas separadas / feature branch OXE | `/oxe-workstream new <nome>` |
|
|
208
|
+
| Alternar entre trilhas de desenvolvimento | `/oxe-workstream switch <nome>` |
|
|
209
|
+
|
|
210
|
+
## Observações Contextuais (`/oxe-obs`)
|
|
211
|
+
|
|
212
|
+
**Princípio:** *observation-without-re-explaining* — registre uma observação em 1 request; ela é incorporada automaticamente nos workflows seguintes sem precisar re-explicar.
|
|
213
|
+
|
|
214
|
+
```
|
|
215
|
+
/oxe-obs JWT expiration deve ser via env var JWT_EXPIRES_IN, não hardcoded
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
- **Quando usar:** durante execute (descoberta técnica), após scan (restrição identificada), após spec (ajuste de escopo), a qualquer momento
|
|
219
|
+
- **Impacto:** classificado automaticamente em `spec` | `plan` | `execute` | `all`
|
|
220
|
+
- **Auto-incorporação:** o próximo `/oxe-spec` (Fase 3), `/oxe-plan`, `/oxe-discuss` ou `/oxe-execute` lê `.oxe/OBSERVATIONS.md` e aplica observações pendentes sem prompt extra
|
|
221
|
+
- **Urgência execute:** se chamado durante `executing` com impacto execute, oferece pausar onda atual ou continuar
|
|
222
|
+
|
|
223
|
+
## Notas pré-trilha (opcional)
|
|
224
|
+
|
|
225
|
+
- Ficheiro **`.oxe/NOTES.md`**: bullets `YYYY-MM-DD — …` como fila leve (**não** substitui SPEC). Em **`/oxe-discuss`**, **`/oxe-plan`** e **`/oxe-plan-agent`**, consumir ou marcar descartado/adiado.
|
|
226
|
+
|
|
227
|
+
## Milestones e Workstreams
|
|
228
|
+
|
|
229
|
+
- **`/oxe-milestone new [nome]`** — iniciar marco de entrega (M-01, M-02, …); registrado em `.oxe/MILESTONES.md`.
|
|
230
|
+
- **`/oxe-milestone complete`** — fechar milestone ativo, arquivar artefatos em `.oxe/milestones/M-NN/`.
|
|
231
|
+
- **`/oxe-milestone status`** / **`/oxe-milestone audit`** — progresso e Definition of Done.
|
|
232
|
+
- **`/oxe-workstream new <nome>`** — trilha paralela em `.oxe/workstreams/<nome>/`.
|
|
233
|
+
- **`/oxe-workstream switch <nome>`** — definir workstream ativo; workflows operam nos artefatos dessa trilha.
|
|
234
|
+
- **`/oxe-workstream list`** / **`/oxe-workstream close <nome>`** — gerenciar trilhas.
|
|
235
|
+
|
|
236
|
+
## Personas de agentes
|
|
237
|
+
|
|
238
|
+
Arquivos em `oxe/personas/` (ou `.oxe/personas/` após instalação) definem comportamentos de agentes para uso com `/oxe-plan-agent`. Personas builtin: `executor`, `planner`, `verifier`, `researcher`, `debugger`, `architect`, `ui-specialist`, `db-specialist`. Personas customizadas do projeto ficam em `.oxe/personas/`.
|
|
239
|
+
|
|
240
|
+
## Profiles de execução
|
|
241
|
+
|
|
242
|
+
O campo `profile` em `.oxe/config.json` expande automaticamente múltiplas keys:
|
|
243
|
+
- **`balanced`** (padrão): cerimônia moderada, verificação standard.
|
|
244
|
+
- **`strict`**: discuss obrigatório, verificação 4 camadas, UAT, aviso de scan antigo.
|
|
245
|
+
- **`fast`**: sem discuss, verificação quick, sem UAT.
|
|
246
|
+
- **`legacy`**: discuss obrigatório, verificação thorough, sem comando de test assumido.
|
|
247
|
+
|
|
248
|
+
## SDK (API programática)
|
|
249
|
+
|
|
250
|
+
Quem integra em pipeline pode usar **`require('oxe-cc')`** (entrada `main` do pacote):
|
|
251
|
+
- **`runDoctorChecks({ projectRoot })`** — gate em CI.
|
|
252
|
+
- **`parsePlan(planMd)`** — extrai tarefas, ondas, decisões e metadata de PLAN.md.
|
|
253
|
+
- **`parseSpec(specMd)`** — extrai critérios A* e seções obrigatórias.
|
|
254
|
+
- **`parseState(stateMd)`** — extrai fase, scan date, workstreams, milestone ativo.
|
|
255
|
+
- **`validateDecisionFidelity(discussMd, planMd)`** — verifica cobertura de decisões D-NN.
|
|
256
|
+
- **`security.checkPathSafety(path, root)`** — valida caminhos contra path traversal e segredos.
|
|
257
|
+
- **`plugins.loadPlugins(projectRoot)`** / **`plugins.runHook(plugins, hook, ctx)`** — plugin lifecycle.
|
|
258
|
+
- **`health.expandExecutionProfile(profile)`** — expande profile em keys individuais.
|
|
259
|
+
|
|
260
|
+
Ver **`lib/sdk/README.md`** e **`lib/sdk/index.d.ts`**.
|
|
261
|
+
|
|
262
|
+
## Variáveis de ambiente (referência)
|
|
263
|
+
|
|
264
|
+
| Variável | Uso |
|
|
265
|
+
|----------|-----|
|
|
266
|
+
| `OXE_NO_PROMPT` | `1` / `true`: sem menus interativos |
|
|
267
|
+
| `OXE_NO_BANNER` | `1` / `true`: sem banner no CLI |
|
|
268
|
+
| `OXE_UPDATE_SKIP_REGISTRY` | `1` / `true`: não consultar npm em `update --check` / `--if-newer` (saída `2` ou skip) |
|
|
269
|
+
| `CURSOR_CONFIG_DIR` | Base Cursor (default `~/.cursor`) |
|
|
270
|
+
| `COPILOT_CONFIG_DIR` / `COPILOT_HOME` | Base Copilot |
|
|
271
|
+
| `CLAUDE_CONFIG_DIR` | Base `~/.claude` |
|
|
272
|
+
| `XDG_CONFIG_HOME` | OpenCode e outros (multi-agente) |
|
|
273
|
+
| `CODEX_HOME` | Prompts Codex em instalação multi-agente |
|
|
274
|
+
|
|
275
|
+
## Artefatos
|
|
276
|
+
|
|
277
|
+
- `.oxe/STATE.md`, `.oxe/config.json` (opcional), `.oxe/codebase/*`, `.oxe/SPEC.md`, `.oxe/DISCUSS.md` (opcional, com IDs D-NN), `.oxe/PLAN.md`, `.oxe/VERIFY.md`, `.oxe/QUICK.md`, `.oxe/SUMMARY.md` (opcional), `.oxe/NOTES.md` (opcional, fila), `.oxe/RESUME.md` (opcional, trilha + ponte para delta), `.oxe/CODEBASE-DELTA.md` (opcional, último refresh documentado do codebase), `.oxe/CHECKPOINTS.md` (opcional, índice), `.oxe/checkpoints/*.md` (opcional, marcos de sessão), `.oxe/RESEARCH.md` (opcional, índice de pesquisa), `.oxe/research/*.md` (opcional, notas datadas), `.oxe/VALIDATION-GAPS.md` (opcional, pós-verify), `.oxe/FORENSICS.md` (opcional, recuperação), `.oxe/DEBUG.md` (opcional, sessões de debug), `.oxe/UI-SPEC.md` / `.oxe/UI-REVIEW.md` (opcional, front-end)
|
|
278
|
+
- **Novos artefatos:** `.oxe/MILESTONES.md` (marcos de entrega), `.oxe/milestones/M-NN/` (artefatos arquivados), `.oxe/workstreams/<nome>/` (trilhas paralelas), `.oxe/personas/*.md` (personas de agentes customizadas), `.oxe/plugins/*.cjs` (plugins de lifecycle), `.oxe/memory/*.md` (sidecars de memória por sessão), `.oxe/EXECUTION-RUNTIME.md` (runtime operacional), `.oxe/CAPABILITIES.md` + `.oxe/capabilities/` (catálogo nativo), `.oxe/INVESTIGATIONS.md` + `.oxe/investigations/` (investigações estruturadas), `.oxe/dashboard/` (camada visual opcional).
|
|
279
|
+
- Templates: `oxe/templates/` (ou `.oxe/templates/` em layout aninhado, conforme instalação). Hooks Git **opt-in** (lembretes não bloqueantes): `oxe/templates/GIT_HOOKS_OXE.md`. Plugin system: `oxe/templates/PLUGINS.md`.
|
|
280
|
+
|
|
281
|
+
## Para autores (mantenedores)
|
|
282
|
+
|
|
283
|
+
- Guia de autoria dos workflows: **`oxe/templates/WORKFLOW_AUTHORING.md`** (no pacote) ou **`.oxe/templates/WORKFLOW_AUTHORING.md`** após instalação em layout aninhado.
|
|
284
|
+
- Revisão guiada de um ficheiro de workflow contra esse guia: workflow **`workflow-authoring.md`** (mesma pasta que os outros passos).
|
|
285
|
+
|
|
286
|
+
## Gatilhos em linguagem natural
|
|
287
|
+
|
|
288
|
+
Quando o usuário disser “oxe scan”, “oxe quick”, “executar onda OXE”, “revisar PR”, “forensics”, “debug OXE”, “oxe research”, “oxe compact”, “refresh codebase”, “sincronizar mapa OXE”, “oxe resume”, “oxe checkpoint”, “mapa do sistema”, “engenharia reversa”, “modernização”, “validate gaps”, “Nyquist-lite”, “UI spec”, “roteamento OXE”, “rever um workflow OXE” / “alinhar ao guia de autoria”, etc., siga o workflow correspondente em `oxe/workflows/*.md` ou `.oxe/workflows/*.md` (autoria: `workflow-authoring.md`; meta: `route.md`).
|
|
289
|
+
|
|
290
|
+
**GitHub Copilot CLI:** com `oxe-cc --copilot-cli`, use **agent skills** em **`~/.copilot/skills/`** — invoque **`/oxe`** (entrada, mesmo conteúdo que help) ou **`/oxe-scan`**, **`/oxe-plan`**, etc. Após instalar ou atualizar: **`/skills reload`** (ou reinicie o `copilot`). A pasta **`~/.copilot/commands/`** é só cópia legado; o CLI oficial não a usa como slash commands.
|
|
291
|
+
|
|
292
|
+
**Multi-agente:** `npx oxe-cc --all-agents` (ou opção **6** no instalador) replica os mesmos fluxos para **OpenCode** (`~/.config/opencode/commands` + `~/.opencode/commands`), **Gemini CLI** (`~/.gemini/commands` — `/oxe`, `/oxe:scan`, …; use **`/commands reload`**), **Codex** (`~/.agents/skills` + `~/.codex/prompts` com `/prompts:oxe-*`), **Windsurf** (`~/.codeium/windsurf/global_workflows` — `/oxe-scan`), **Google Antigravity** (`~/.gemini/antigravity/skills`), além de **Claude** (`~/.claude/commands`) e o já descrito Copilot.
|
|
293
|
+
</output>
|