oxe-cc 0.3.4 → 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.
- package/.cursor/commands/oxe-discuss.md +4 -2
- package/.cursor/commands/oxe-execute.md +6 -2
- package/.cursor/commands/oxe-help.md +10 -2
- package/.cursor/commands/oxe-next.md +10 -2
- package/.cursor/commands/oxe-plan.md +13 -2
- package/.cursor/commands/oxe-quick.md +6 -2
- package/.cursor/commands/oxe-review-pr.md +16 -0
- package/.cursor/commands/oxe-scan.md +13 -2
- package/.cursor/commands/oxe-spec.md +13 -2
- package/.cursor/commands/oxe-verify.md +13 -2
- package/.github/copilot-instructions.md +25 -9
- package/AGENTS.md +3 -1
- package/README.md +310 -258
- package/assets/readme-banner.svg +19 -19
- package/bin/lib/oxe-agent-install.cjs +460 -0
- package/bin/lib/oxe-install-resolve.cjs +93 -0
- package/bin/lib/oxe-manifest.cjs +1 -1
- package/bin/lib/oxe-project-health.cjs +52 -0
- package/bin/lib/oxe-workflows.cjs +145 -0
- package/bin/oxe-cc.js +263 -58
- package/lib/sdk/README.md +54 -0
- package/lib/sdk/index.cjs +241 -0
- package/lib/sdk/index.d.ts +89 -0
- package/oxe/templates/CONFIG.md +32 -17
- package/oxe/templates/WORKFLOW_AUTHORING.md +73 -0
- package/oxe/templates/config.template.json +18 -11
- package/oxe/workflows/discuss.md +31 -31
- package/oxe/workflows/execute.md +36 -36
- package/oxe/workflows/help.md +46 -13
- package/oxe/workflows/next.md +7 -0
- package/oxe/workflows/quick.md +45 -45
- package/oxe/workflows/review-pr.md +2 -2
- package/oxe/workflows/workflow-authoring.md +34 -0
- package/package.json +30 -3
- package/.cursor/rules/oxe-workflow.mdc +0 -15
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: OXE — Discussão antes do plano
|
|
2
|
+
description: "OXE — Discussão antes do plano"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Executa o workflow **OXE discuss** no repositório atual. Lê 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
|
-
|
|
5
|
+
Executa o workflow **OXE execute** no repositório atual. Lê 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
|
-
|
|
6
|
+
name: oxe-help
|
|
7
|
+
agent: agent
|
|
8
|
+
description: OXE — Ajuda (Cursor, Copilot, artefatos)
|
|
3
9
|
---
|
|
4
10
|
|
|
5
|
-
|
|
11
|
+
Executa o workflow **OXE help**. Lê 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
|
-
|
|
6
|
+
name: oxe-next
|
|
7
|
+
agent: agent
|
|
8
|
+
description: OXE — Próximo passo (lê STATE.md)
|
|
3
9
|
---
|
|
4
10
|
|
|
5
|
-
|
|
11
|
+
Executa o workflow **OXE next**. Lê 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
|
-
|
|
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
|
-
|
|
12
|
+
Executa o workflow **OXE plan**. Lê 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
|
|
2
|
+
description: "OXE — Modo rápido (.oxe/QUICK.md)"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Executa o workflow **OXE quick** no repositório atual. Lê 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
|
-
|
|
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
|
-
|
|
12
|
+
Executa o workflow **OXE scan** no repositório atual. Lê 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
|
-
|
|
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
|
-
|
|
12
|
+
Executa o workflow **OXE spec**. Lê 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
|
-
|
|
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
|
-
|
|
12
|
+
Executa o workflow **OXE verify**. Lê 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,6 +1,6 @@
|
|
|
1
1
|
# OXE — fluxo spec-driven (Cursor + Copilot)
|
|
2
2
|
|
|
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`** ou **`.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
|
|
|
@@ -18,27 +18,43 @@ Se o usuário mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o
|
|
|
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” *(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
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.
|
|
25
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
|
+
|
|
26
29
|
## Onde ficam as integrações (após `npx oxe-cc`)
|
|
27
30
|
|
|
28
|
-
- **Cursor:** comandos em **`~/.cursor/commands/`** (slash `/oxe-*`).
|
|
29
|
-
- **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
|
|
30
|
-
- **Copilot CLI
|
|
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.
|
|
31
40
|
|
|
32
41
|
## Artefatos
|
|
33
42
|
|
|
34
|
-
- `.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`
|
|
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)
|
|
35
44
|
- Templates: `oxe/templates/` (ou `.oxe/templates/` em layout aninhado)
|
|
36
45
|
|
|
37
|
-
## CLI
|
|
46
|
+
## CLI e SDK
|
|
38
47
|
|
|
39
|
-
- **`npx oxe-cc
|
|
40
|
-
- **`npx oxe-cc
|
|
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`).
|
|
53
|
+
|
|
54
|
+
**WSL:** usar Node **nativo do WSL**; o `oxe-cc` recusa Node do Windows dentro do WSL (caminhos incorretos).
|
|
41
55
|
|
|
42
56
|
## Manutenção do pacote oxe-build
|
|
43
57
|
|
|
44
58
|
Ao alterar comportamento OXE, edite primeiro **`oxe/workflows/*.md`**; mantenha comandos Cursor e prompts Copilot alinhados a essa pasta.
|
|
59
|
+
|
|
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
|
@@ -6,7 +6,9 @@ Este repositório empacota o fluxo **OXE** (spec-driven, artefatos em `.oxe/`).
|
|
|
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
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
|
|
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.
|