oxe-cc 0.3.3 → 0.3.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.
Files changed (42) hide show
  1. package/.cursor/commands/oxe-discuss.md +4 -2
  2. package/.cursor/commands/oxe-execute.md +6 -2
  3. package/.cursor/commands/oxe-help.md +10 -2
  4. package/.cursor/commands/oxe-next.md +10 -2
  5. package/.cursor/commands/oxe-plan.md +13 -2
  6. package/.cursor/commands/oxe-quick.md +6 -2
  7. package/.cursor/commands/oxe-review-pr.md +16 -0
  8. package/.cursor/commands/oxe-scan.md +13 -2
  9. package/.cursor/commands/oxe-spec.md +13 -2
  10. package/.cursor/commands/oxe-verify.md +13 -2
  11. package/.github/copilot-instructions.md +35 -14
  12. package/AGENTS.md +4 -2
  13. package/README.md +310 -244
  14. package/assets/readme-banner.svg +19 -18
  15. package/bin/lib/oxe-agent-install.cjs +460 -0
  16. package/bin/lib/oxe-install-resolve.cjs +93 -0
  17. package/bin/lib/oxe-manifest.cjs +117 -0
  18. package/bin/lib/oxe-project-health.cjs +464 -0
  19. package/bin/lib/oxe-workflows.cjs +145 -0
  20. package/bin/oxe-cc.js +1406 -123
  21. package/lib/sdk/README.md +54 -0
  22. package/lib/sdk/index.cjs +241 -0
  23. package/lib/sdk/index.d.ts +89 -0
  24. package/oxe/templates/CONFIG.md +32 -12
  25. package/oxe/templates/PLAN.template.md +1 -1
  26. package/oxe/templates/SPEC.template.md +9 -5
  27. package/oxe/templates/STATE.md +9 -1
  28. package/oxe/templates/WORKFLOW_AUTHORING.md +73 -0
  29. package/oxe/templates/config.template.json +18 -6
  30. package/oxe/workflows/discuss.md +31 -31
  31. package/oxe/workflows/execute.md +36 -28
  32. package/oxe/workflows/help.md +56 -22
  33. package/oxe/workflows/next.md +27 -13
  34. package/oxe/workflows/plan.md +14 -13
  35. package/oxe/workflows/quick.md +45 -32
  36. package/oxe/workflows/review-pr.md +13 -13
  37. package/oxe/workflows/scan.md +13 -11
  38. package/oxe/workflows/spec.md +15 -14
  39. package/oxe/workflows/verify.md +19 -16
  40. package/oxe/workflows/workflow-authoring.md +34 -0
  41. package/package.json +30 -3
  42. package/.cursor/rules/oxe-workflow.mdc +0 -15
@@ -1,5 +1,7 @@
1
1
  ---
2
- description: OXE — Discussão antes do plano (.oxe/DISCUSS.md)
2
+ description: "OXE — Discussão antes do plano"
3
3
  ---
4
4
 
5
- e executa **integralmente** o workflow em `oxe/workflows/discuss.md` na raiz do workspace. Usa o texto extra do utilizador como contexto ou respostas a perguntas pendentes.
5
+ Executa o workflow **OXE discuss** no repositório atual. e aplica **integralmente** o ficheiro no workspace:
6
+
7
+ `oxe/workflows/discuss.md`
@@ -1,5 +1,9 @@
1
1
  ---
2
- description: OXE — Executar onda do PLAN ou passos do QUICK
2
+ description: "OXE — Executar onda do PLAN ou passos do QUICK"
3
3
  ---
4
4
 
5
- e executa **integralmente** o workflow em `oxe/workflows/execute.md` na raiz do workspace. Se o utilizador indicar uma onda ou tarefas (ex. “onda 2”, “T3”), usa esse foco.
5
+ Executa o workflow **OXE execute** no repositório atual. e aplica **integralmente** o ficheiro no workspace:
6
+
7
+ `oxe/workflows/execute.md`
8
+
9
+ Usa o texto adicional desta mensagem como foco (onda, tarefa Tn, ou confirmação de progresso).
@@ -1,5 +1,13 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
1
5
  ---
2
- description: OXE — Ajuda (Cursor, Copilot, fluxo e artefatos)
6
+ name: oxe-help
7
+ agent: agent
8
+ description: OXE — Ajuda (Cursor, Copilot, artefatos)
3
9
  ---
4
10
 
5
- e executa **integralmente** o workflow em `oxe/workflows/help.md`.
11
+ Executa o workflow **OXE help**. e segue **integralmente**:
12
+
13
+ `oxe/workflows/help.md` (na raiz do repositório em contexto)
@@ -1,5 +1,13 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
1
5
  ---
2
- description: OXE — Indica o próximo passo (lê .oxe/STATE.md)
6
+ name: oxe-next
7
+ agent: agent
8
+ description: OXE — Próximo passo (lê STATE.md)
3
9
  ---
4
10
 
5
- e executa **integralmente** o workflow em `oxe/workflows/next.md`.
11
+ Executa o workflow **OXE next**. e aplica **integralmente**:
12
+
13
+ `oxe/workflows/next.md` (na raiz do repositório em contexto)
@@ -1,5 +1,16 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
1
5
  ---
2
- description: OXE — Gera .oxe/PLAN.md com tarefas e verificação por item
6
+ name: oxe-plan
7
+ agent: agent
8
+ description: OXE — Gera .oxe/PLAN.md com verificação por tarefa
9
+ argument-hint: "[opcional: --replan]"
3
10
  ---
4
11
 
5
- e executa **integralmente** o workflow em `oxe/workflows/plan.md`. Se o utilizador pedir replanejamento, inclui `--replan` na intenção.
12
+ Executa o workflow **OXE plan**. e aplica **integralmente**:
13
+
14
+ `oxe/workflows/plan.md` (na raiz do repositório em contexto)
15
+
16
+ Se o utilizador pedir replanejamento, trata como `--replan` conforme o workflow.
@@ -1,5 +1,9 @@
1
1
  ---
2
- description: OXE — Modo rápido (.oxe/QUICK.md + STATE)
2
+ description: "OXE — Modo rápido (.oxe/QUICK.md)"
3
3
  ---
4
4
 
5
- e executa **integralmente** o workflow em `oxe/workflows/quick.md` na raiz do workspace. Usa qualquer texto extra do utilizador como objetivo e contexto.
5
+ Executa o workflow **OXE quick** no repositório atual. e aplica **integralmente** o ficheiro no workspace:
6
+
7
+ `oxe/workflows/quick.md`
8
+
9
+ Usa o texto adicional desta mensagem como objetivo e contexto.
@@ -0,0 +1,16 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
5
+ ---
6
+ name: oxe-review-pr
7
+ agent: agent
8
+ description: OXE — Revisão de PR (link GitHub, branches ou SHAs)
9
+ argument-hint: "URL ou refs: https://github.com/org/repo/pull/10 | main feature/foo"
10
+ ---
11
+
12
+ Executa o workflow **OXE review-pr**. Lê e aplica **integralmente**:
13
+
14
+ `oxe/workflows/review-pr.md` (na raiz do repositório em contexto)
15
+
16
+ **Exemplos de entrada:** cola o URL da PR (`https://github.com/org/repo/pull/10`, com ou sem `/files`); ou `org/repo#10`; ou **base** e **head** (branches/tags/SHAs). Sem refs, o agente infere (ex.: `main` vs branch atual).
@@ -1,5 +1,16 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
1
5
  ---
2
- description: OXE — Escaneia o repo e gera .oxe/codebase/ + STATE.md
6
+ name: oxe-scan
7
+ agent: agent
8
+ description: OXE — Scan do repositório (.oxe/codebase/)
9
+ argument-hint: "[área opcional, ex. api]"
3
10
  ---
4
11
 
5
- e executa **integralmente** o workflow em `oxe/workflows/scan.md` na raiz do workspace. Usa qualquer texto extra do utilizador como foco opcional de área (ex. `api`).
12
+ Executa o workflow **OXE scan** no repositório atual. e aplica **integralmente** o ficheiro:
13
+
14
+ `oxe/workflows/scan.md` (na raiz do repositório em contexto)
15
+
16
+ Usa o texto adicional desta mensagem como foco opcional de área (pastas/módulos).
@@ -1,5 +1,16 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
1
5
  ---
2
- description: OXE — Cria ou atualiza .oxe/SPEC.md a partir do pedido
6
+ name: oxe-spec
7
+ agent: agent
8
+ description: OXE — Cria ou atualiza .oxe/SPEC.md
9
+ argument-hint: "[pedido ou contexto da feature]"
3
10
  ---
4
11
 
5
- e executa **integralmente** o workflow em `oxe/workflows/spec.md`. Entrada: mensagem do utilizador e ficheiros anexados.
12
+ Executa o workflow **OXE spec**. e aplica **integralmente**:
13
+
14
+ `oxe/workflows/spec.md` (na raiz do repositório em contexto)
15
+
16
+ Usa o resto desta mensagem e ficheiros anexados como entrada do utilizador.
@@ -1,5 +1,16 @@
1
+ ---
2
+ description: "Comando OXE"
3
+ ---
4
+
1
5
  ---
2
- description: OXE — Valida contra SPEC/PLAN e grava .oxe/VERIFY.md
6
+ name: oxe-verify
7
+ agent: agent
8
+ description: OXE — Valida implementação (.oxe/VERIFY.md)
9
+ argument-hint: "[opcional: Tn]"
3
10
  ---
4
11
 
5
- e executa **integralmente** o workflow em `oxe/workflows/verify.md`. Se o utilizador indicar `Tn`, focar essa tarefa.
12
+ Executa o workflow **OXE verify**. e aplica **integralmente**:
13
+
14
+ `oxe/workflows/verify.md` (na raiz do repositório em contexto)
15
+
16
+ Se o utilizador indicar uma tarefa `Tn`, restringe a verificação a essa tarefa.
@@ -1,15 +1,15 @@
1
1
  # OXE — fluxo spec-driven (Cursor + Copilot)
2
2
 
3
- Este repositório define o **OXE**: artefatos em `.oxe/` na raiz do projeto alvo e workflows em `oxe/workflows/*.md`.
3
+ Este repositório (ou o pacote **oxe-cc** instalado) define o **OXE**: artefatos em **`.oxe/`** na raiz do projeto alvo e workflows em **`oxe/workflows/*.md`** (no pacote) ou **`.oxe/workflows/*.md`** / **`oxe/workflows/*.md`** no projeto, conforme a instalação (layout mínimo vs clássico).
4
4
 
5
5
  ## Quando aplicar
6
6
 
7
- Se o utilizador mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o projeto”, “criar spec OXE”, “plano OXE com testes”, “verificar OXE”, trata como fluxo OXE e segue o ficheiro de workflow correspondente abaixo.
7
+ Se o usuário mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o projeto”, “criar spec OXE”, “plano OXE com testes”, “verificar OXE”, trate como fluxo OXE e siga o arquivo de workflow correspondente abaixo.
8
8
 
9
9
  ## Workflows (fonte única)
10
10
 
11
- | Passo | Ficheiro | Gatilhos naturais (exemplos) |
12
- |-------|----------|----------------------------|
11
+ | Passo | Arquivo | Gatilhos naturais (exemplos) |
12
+ |-------|---------|-------------------------------|
13
13
  | Scan | `oxe/workflows/scan.md` | “oxe scan”, “mapear o repo”, “atualizar codebase OXE” |
14
14
  | Spec | `oxe/workflows/spec.md` | “oxe spec”, “escrever SPEC.md”, “requisitos OXE” |
15
15
  | Discuss | `oxe/workflows/discuss.md` | “oxe discuss”, “perguntas antes do plano”, “DISCUSS.md” |
@@ -18,22 +18,43 @@ Se o utilizador mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear
18
18
  | Execute | `oxe/workflows/execute.md` | “oxe execute”, “executar onda”, “onda 2 OXE” |
19
19
  | Verify | `oxe/workflows/verify.md` | “oxe verify”, “validar plano OXE”, “VERIFY.md” |
20
20
  | Next | `oxe/workflows/next.md` | “oxe next”, “próximo passo OXE” |
21
- | Review PR | `oxe/workflows/review-pr.md` | “revisar PR”, link `…/pull/10`, “diff entre branches”, “code review OXE” *(prompt: `/oxe-review-pr`)* |
21
+ | Review PR | `oxe/workflows/review-pr.md` | “revisar PR”, link `…/pull/10`, “diff entre branches” *(prompt Copilot: `/oxe-review-pr`)* |
22
22
  | Help | `oxe/workflows/help.md` | “oxe help”, “como usar OXE” |
23
+ | Autoria de workflow | `oxe/workflows/workflow-authoring.md` | “rever workflow OXE”, “revisar `oxe/workflows/foo.md` contra o guia”, alinhar passo ao `WORKFLOW_AUTHORING.md` |
23
24
 
24
- **Regra:** o Markdown indicado e executa **todos** os passos e critérios de sucesso descritos nesse ficheiro. Não atalhes: cria ou atualiza os ficheiros em `.oxe/` conforme o workflow.
25
+ **Regra:** leia o Markdown indicado e execute **todos** os passos e critérios de sucesso descritos nesse arquivo. Não atalhe: crie ou atualize os arquivos em `.oxe/` conforme o workflow.
26
+
27
+ **Cursor:** há slash `/oxe-*` para scan…help em `~/.cursor/commands/`; **não** há comando slash dedicado a review-pr no Cursor — use linguagem natural + `oxe/workflows/review-pr.md` em contexto.
28
+
29
+ ## Onde ficam as integrações (após `npx oxe-cc`)
30
+
31
+ - **Cursor:** comandos em **`~/.cursor/commands/`** (slash `/oxe-*`). Diretório alternativo: variável **`CURSOR_CONFIG_DIR`**.
32
+ - **GitHub Copilot (VS Code):** instruções mescladas em **`~/.copilot/copilot-instructions.md`** (bloco OXE) e **prompt files** em **`~/.copilot/prompts/`** (`oxe-*.prompt.md`). **Não** espere `.github/prompts/` no repositório do projeto para o Copilot — o instalador usa **`~/.copilot/`** (`COPILOT_CONFIG_DIR` / `COPILOT_HOME` se definidos).
33
+ - **Copilot CLI:** com `oxe-cc --copilot-cli`, use **agent skills** em **`~/.copilot/skills/`** (`/oxe`, `/oxe-scan`, …). Depois de instalar: **`/skills reload`**. Pastas **`~/.claude/commands/`** e **`~/.copilot/commands/`** são cópia legado; **`CLAUDE_CONFIG_DIR`** altera o home Claude.
34
+ - **Multi-agente:** `oxe-cc --all-agents` (menu **6**) replica fluxos para **OpenCode**, **Gemini CLI** (`/commands reload`), **Codex**, **Windsurf**, **Antigravity**, além de Cursor/Copilot/Claude. **`XDG_CONFIG_HOME`** / **`CODEX_HOME`** afetam caminhos canónicos desses destinos. O núcleo no repo continua **`.oxe/`** (SPEC/PLAN/VERIFY em Markdown).
35
+
36
+ ## Configuração do projeto
37
+
38
+ - **`.oxe/config.json`**: fluxo (`discuss_before_plan`, `scan_max_age_days`, `spec_required_sections`, …) e opcionalmente **`install`** (perfil e layout quando o utilizador corre o instalador **sem** flags IDE explícitas). Referência: `oxe/templates/CONFIG.md`. Para ignorar o bloco `install` numa corrida: **`--no-install-config`**.
39
+ - Sem TTY (CI): **`OXE_NO_PROMPT=1`** — padrões de layout/integração; o ficheiro `install` em `config.json` aplica-se se existir e as flags não sobrepuserem.
25
40
 
26
41
  ## Artefatos
27
42
 
28
- - `.oxe/STATE.md`, `.oxe/config.json` (opcional), `.oxe/codebase/*.md`, `.oxe/SPEC.md`, `.oxe/DISCUSS.md` (opcional), `.oxe/PLAN.md`, `.oxe/VERIFY.md`, `.oxe/QUICK.md`, `.oxe/SUMMARY.md`
29
- - Templates: `oxe/templates/`
43
+ - `.oxe/STATE.md`, `.oxe/config.json` (opcional), `.oxe/codebase/*.md`, `.oxe/SPEC.md`, `.oxe/DISCUSS.md` (opcional), `.oxe/PLAN.md`, `.oxe/VERIFY.md`, `.oxe/QUICK.md`, `.oxe/SUMMARY.md` (opcional)
44
+ - Templates: `oxe/templates/` (ou `.oxe/templates/` em layout aninhado)
45
+
46
+ ## CLI e SDK
47
+
48
+ - **`npx oxe-cc`** ou **`npx oxe-cc install`** — instalação (equivalentes).
49
+ - **`npx oxe-cc doctor`** — validação completa (Node, workflows do pacote vs projeto, JSON, coerência STATE, regras SPEC/PLAN, **avisos** não bloqueantes sobre estrutura dos `.md` de workflow quando aplicável).
50
+ - **`npx oxe-cc status`** — mais leve: coerência `.oxe/` + **um** próximo passo (não exige o mesmo rigor de workflows que o `doctor`).
51
+ - **`npx oxe-cc init-oxe`**, **`uninstall`**, **`update`** — ver `oxe-cc --help` ou README do pacote.
52
+ - **SDK (Node):** `require('oxe-cc')` expõe `runDoctorChecks`, `health`, `workflows`, `install`, `manifest`, `agents` — útil para CI (`lib/sdk/README.md`, `lib/sdk/index.d.ts`).
30
53
 
31
- ## Cursor vs Copilot
54
+ **WSL:** usar Node **nativo do WSL**; o `oxe-cc` recusa Node do Windows dentro do WSL (caminhos incorretos).
32
55
 
33
- - **Cursor:** slash commands em `.cursor/commands/oxe-*.md` apontam para os mesmos workflows.
34
- - **Copilot (VS Code Chat):** prompt files em `.github/prompts/oxe-*.prompt.md`; cada um indica o workflow em `oxe/workflows/<passo>.md` na raiz do repo. **`oxe-review-pr`** existe só como prompt Copilot (não há slash command Cursor correspondente).
35
- - **Copilot CLI (terminal, experimental):** com `oxe-cc --copilot-cli`, os mesmos textos são copiados para **`.claude/commands/oxe-*.md`** — versões recentes do CLI podem expor **`/oxe-scan`**, etc. Isto depende da versão do `copilot`; não faz parte do contrato estável do OXE.
56
+ ## Manutenção do pacote oxe-build
36
57
 
37
- ## Manutenção deste pacote (oxe-build)
58
+ Ao alterar comportamento OXE, edite primeiro **`oxe/workflows/*.md`**; mantenha comandos Cursor e prompts Copilot alinhados a essa pasta.
38
59
 
39
- Ao alterar comportamento OXE, edita primeiro `oxe/workflows/*.md`; mantém comandos Cursor e prompts Copilot alinhados com essa pasta.
60
+ **Autoria de workflows:** guia em **`oxe/templates/WORKFLOW_AUTHORING.md`**. Para rever um `.md` de passo contra o guia, use o workflow **`oxe/workflows/workflow-authoring.md`** (ou `.oxe/workflows/` no projeto alvo).
package/AGENTS.md CHANGED
@@ -5,8 +5,10 @@ Este repositório empacota o fluxo **OXE** (spec-driven, artefatos em `.oxe/`).
5
5
  - **npm:** o nome do pacote é **`oxe-cc`** (`npx oxe-cc@latest` quando estiver publicado; se `npm view oxe-cc` der 404, usar `npm link` a partir deste repo ou `node bin/oxe-cc.js`).
6
6
  - **Instruções do repositório:** [.github/copilot-instructions.md](.github/copilot-instructions.md) — aplicadas automaticamente no Copilot Chat quando o repo está em contexto.
7
7
  - **Workflows canónicos:** [oxe/workflows/](oxe/workflows/) — editar aqui primeiro; Cursor e Copilot apontam para estes ficheiros (inclui `quick.md`, `execute.md`).
8
- - **CLI:** `oxe-cc` instala assets e bootstrap (`.oxe/STATE.md`, `config.json`, `codebase/`); `oxe-cc doctor` valida workflows, JSON de config e mapa scan; `oxe-cc init-oxe` só inicializa `.oxe/`.
8
+ - **CLI:** `oxe-cc` instala assets e bootstrap (`.oxe/STATE.md`, `config.json`, `codebase/`); `oxe-cc doctor` valida workflows, JSON de config, coerência STATE vs artefatos e regras opcionais de SPEC/PLAN; `oxe-cc status` mostra coerência `.oxe/` e **um** próximo passo; `oxe-cc init-oxe` só inicializa `.oxe/`.
9
+ - **SDK:** `require('oxe-cc')` expõe `runDoctorChecks`, `health`, `workflows`, `install`, `manifest`, `agents` — ver [lib/sdk/README.md](lib/sdk/README.md).
9
10
  - **Prompt files (Copilot / VS Code):** [.github/prompts/*.prompt.md](.github/prompts/) — invocar com `/` no chat (ex. `/oxe-scan`, `/oxe-review-pr` para diff tipo PR) após `chat.promptFiles` estar ativo.
10
- - **Copilot CLI (experimental):** `oxe-cc --copilot-cli` → `.claude/commands/oxe-*.md` para testar `/oxe-scan` no terminal.
11
+ - **Copilot CLI:** `oxe-cc --copilot-cli` → skills em **`~/.copilot/skills/`** (`/oxe`, `/oxe-scan`, …); após instalar use **`/skills reload`**. Cópia extra em `~/.claude/commands/` para compatibilidade.
12
+ - **Multi-agente:** `oxe-cc --all-agents` replica comandos/skills nos homes de **OpenCode**, **Gemini**, **Codex**, **Windsurf**, **Antigravity** (além de Cursor, Copilot, Claude); ver `README.md` e `bin/lib/oxe-agent-install.cjs`.
11
13
 
12
14
  Quando o utilizador pedir uma etapa OXE por linguagem natural, segue o ficheiro `oxe/workflows/<passo>.md` correspondente sem atalhar passos.