oxe-cc 0.3.5 → 0.3.6
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-help.md +3 -9
- package/.cursor/commands/oxe-next.md +3 -9
- package/.cursor/commands/oxe-plan.md +5 -12
- package/.cursor/commands/oxe-review-pr.md +5 -12
- package/.cursor/commands/oxe-scan.md +5 -12
- package/.cursor/commands/oxe-spec.md +5 -12
- package/.cursor/commands/oxe-update.md +9 -0
- package/.cursor/commands/oxe-verify.md +5 -12
- package/.github/copilot-instructions.md +7 -5
- package/.github/prompts/oxe-help.prompt.md +1 -1
- package/.github/prompts/oxe-update.prompt.md +11 -0
- package/.github/workflows/ci.yml +20 -18
- package/AGENTS.md +5 -5
- package/README.md +167 -32
- package/assets/oxe-ciclo-por-trilha.png +0 -0
- package/bin/banner.txt +1 -1
- package/bin/lib/oxe-agent-install.cjs +87 -36
- package/bin/lib/oxe-npm-version.cjs +64 -0
- package/bin/lib/oxe-project-health.cjs +29 -1
- package/bin/oxe-cc.js +689 -121
- package/lib/sdk/index.cjs +1 -0
- package/oxe/templates/CONFIG.md +12 -0
- package/oxe/templates/DOCS_BROWNFIELD_LAYOUT.md +55 -0
- package/oxe/templates/SPEC.template.md +18 -0
- package/oxe/templates/WORKFLOW_AUTHORING.md +2 -0
- package/oxe/workflows/execute.md +1 -0
- package/oxe/workflows/help.md +13 -7
- package/oxe/workflows/plan.md +4 -0
- package/oxe/workflows/references/legacy-brownfield.md +136 -0
- package/oxe/workflows/scan.md +5 -3
- package/oxe/workflows/spec.md +2 -0
- package/oxe/workflows/update.md +33 -0
- package/oxe/workflows/verify.md +1 -0
- package/package.json +15 -4
|
@@ -1,13 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Ajuda (fluxo .oxe/, várias IDEs e CLIs, artefatos)"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
agent: agent
|
|
8
|
-
description: OXE — Ajuda (Cursor, Copilot, artefatos)
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
Executa o workflow **OXE help**. Lê e segue **integralmente**:
|
|
12
|
-
|
|
5
|
+
Executa o workflow **OXE help**. Lê e segue **integralmente**:
|
|
6
|
+
|
|
13
7
|
`oxe/workflows/help.md` (na raiz do repositório em contexto)
|
|
@@ -1,13 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Próximo passo (lê STATE.md)"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
agent: agent
|
|
8
|
-
description: OXE — Próximo passo (lê STATE.md)
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
Executa o workflow **OXE next**. Lê e aplica **integralmente**:
|
|
12
|
-
|
|
5
|
+
Executa o workflow **OXE next**. Lê e aplica **integralmente**:
|
|
6
|
+
|
|
13
7
|
`oxe/workflows/next.md` (na raiz do repositório em contexto)
|
|
@@ -1,16 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Gera .oxe/PLAN.md com verificação por tarefa"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
argument-hint: "[opcional: --replan]"
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
Executa o workflow **OXE plan**. Lê e aplica **integralmente**:
|
|
13
|
-
|
|
14
|
-
`oxe/workflows/plan.md` (na raiz do repositório em contexto)
|
|
15
|
-
|
|
5
|
+
Executa o workflow **OXE plan**. Lê e aplica **integralmente**:
|
|
6
|
+
|
|
7
|
+
`oxe/workflows/plan.md` (na raiz do repositório em contexto)
|
|
8
|
+
|
|
16
9
|
Se o utilizador pedir replanejamento, trata como `--replan` conforme o workflow.
|
|
@@ -1,16 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Revisão de PR (link GitHub, branches ou SHAs)"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
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
|
-
|
|
5
|
+
Executa o workflow **OXE review-pr**. Lê e aplica **integralmente**:
|
|
6
|
+
|
|
7
|
+
`oxe/workflows/review-pr.md` (na raiz do repositório em contexto)
|
|
8
|
+
|
|
16
9
|
**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,16 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Scan do repositório (.oxe/codebase/)"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
argument-hint: "[área opcional, ex. api]"
|
|
10
|
-
---
|
|
11
|
-
|
|
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
|
-
|
|
5
|
+
Executa o workflow **OXE scan** no repositório atual. Lê e aplica **integralmente** o ficheiro:
|
|
6
|
+
|
|
7
|
+
`oxe/workflows/scan.md` (na raiz do repositório em contexto)
|
|
8
|
+
|
|
16
9
|
Usa o texto adicional desta mensagem como foco opcional de área (pastas/módulos).
|
|
@@ -1,16 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Cria ou atualiza .oxe/SPEC.md"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
argument-hint: "[pedido ou contexto da feature]"
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
Executa o workflow **OXE spec**. Lê e aplica **integralmente**:
|
|
13
|
-
|
|
14
|
-
`oxe/workflows/spec.md` (na raiz do repositório em contexto)
|
|
15
|
-
|
|
5
|
+
Executa o workflow **OXE spec**. Lê e aplica **integralmente**:
|
|
6
|
+
|
|
7
|
+
`oxe/workflows/spec.md` (na raiz do repositório em contexto)
|
|
8
|
+
|
|
16
9
|
Usa o resto desta mensagem e ficheiros anexados como entrada do utilizador.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Atualizar oxe-cc no projeto — verificar versão no npm, alinhar ficheiros OXE e validar com doctor"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Executa o workflow **OXE update**. Lê e segue **integralmente**:
|
|
6
|
+
|
|
7
|
+
`oxe/workflows/update.md` (na raiz do repositório em contexto; ou `.oxe/workflows/update.md` se a instalação aninhou os workflows)
|
|
8
|
+
|
|
9
|
+
Na prática: na raiz do projeto, correr **`npx oxe-cc update --check`**, depois (se aplicável) **`npx oxe-cc update`** ou **`npx oxe-cc update --if-newer`**, e por fim **`npx oxe-cc doctor`**.
|
|
@@ -1,16 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "OXE — Valida implementação (.oxe/VERIFY.md)"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
argument-hint: "[opcional: Tn]"
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
Executa o workflow **OXE verify**. Lê e aplica **integralmente**:
|
|
13
|
-
|
|
14
|
-
`oxe/workflows/verify.md` (na raiz do repositório em contexto)
|
|
15
|
-
|
|
5
|
+
Executa o workflow **OXE verify**. Lê e aplica **integralmente**:
|
|
6
|
+
|
|
7
|
+
`oxe/workflows/verify.md` (na raiz do repositório em contexto)
|
|
8
|
+
|
|
16
9
|
Se o utilizador indicar uma tarefa `Tn`, restringe a verificação a essa tarefa.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# OXE — fluxo spec-driven (
|
|
1
|
+
# OXE — fluxo spec-driven (multi-IDE / multi-CLI)
|
|
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`** (no pacote) ou **`.oxe/workflows/*.md`** / **`oxe/workflows/*.md`** no projeto, conforme a instalação (layout mínimo vs clássico).
|
|
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). O fluxo é **agnóstico de ferramenta**; **Cursor** e **GitHub Copilot** são o caminho padrão mais conhecido, mas o mesmo OXE pode ser instalado em **Claude Code, OpenCode, Gemini CLI, Codex, Windsurf, Antigravity** e outras integrações via `oxe-cc --all-agents` (ou flags por runtime).
|
|
4
4
|
|
|
5
5
|
## Quando aplicar
|
|
6
6
|
|
|
@@ -20,11 +20,12 @@ Se o usuário mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o
|
|
|
20
20
|
| Next | `oxe/workflows/next.md` | “oxe next”, “próximo passo OXE” |
|
|
21
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
|
+
| Update | `oxe/workflows/update.md` | “oxe update”, “atualizar oxe-cc”, “há versão nova no npm” *(prompt: `/oxe-update`)* |
|
|
23
24
|
| 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` |
|
|
24
25
|
|
|
25
26
|
**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
|
|
|
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
|
+
**Cursor:** há slash `/oxe-*` para scan…help e **`/oxe-update`** 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
|
|
|
29
30
|
## Onde ficam as integrações (após `npx oxe-cc`)
|
|
30
31
|
|
|
@@ -36,6 +37,7 @@ Se o usuário mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o
|
|
|
36
37
|
## Configuração do projeto
|
|
37
38
|
|
|
38
39
|
- **`.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`**.
|
|
40
|
+
- **Legado / brownfield** (COBOL, JCL, copybooks, VB6, SQL procedures): seguir também `oxe/workflows/references/legacy-brownfield.md` quando o repo ou o pedido indicar mainframe ou desktop legado — scan preenche os sete ficheiros sem assumir Node; plan/verify aceitam evidência por Grep/leitura/checklist.
|
|
39
41
|
- 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.
|
|
40
42
|
|
|
41
43
|
## Artefatos
|
|
@@ -47,7 +49,7 @@ Se o usuário mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o
|
|
|
47
49
|
|
|
48
50
|
- **`npx oxe-cc`** ou **`npx oxe-cc install`** — instalação (equivalentes).
|
|
49
51
|
- **`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`).
|
|
52
|
+
- **`npx oxe-cc status`** — mais leve: coerência `.oxe/` + **um** próximo passo (não exige o mesmo rigor de workflows que o `doctor`). **`status --json`**: saída máquina-legível para CI (`nextStep`, `diagnostics`, …).
|
|
51
53
|
- **`npx oxe-cc init-oxe`**, **`uninstall`**, **`update`** — ver `oxe-cc --help` ou README do pacote.
|
|
52
54
|
- **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
55
|
|
|
@@ -55,6 +57,6 @@ Se o usuário mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o
|
|
|
55
57
|
|
|
56
58
|
## Manutenção do pacote oxe-build
|
|
57
59
|
|
|
58
|
-
Ao alterar comportamento OXE, edite primeiro **`oxe/workflows/*.md`**; mantenha comandos Cursor
|
|
60
|
+
Ao alterar comportamento OXE, edite primeiro **`oxe/workflows/*.md`**; mantenha prompts em **`.github/prompts/`** e comandos Cursor gerados pelo sync alinhados a essa pasta (e as integrações multi-agente coerentes com `oxe-agent-install.cjs`).
|
|
59
61
|
|
|
60
62
|
**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).
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-update
|
|
3
|
+
agent: agent
|
|
4
|
+
description: Atualizar oxe-cc no projeto — verificar versão no npm, alinhar ficheiros OXE e validar com doctor
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Executa o workflow **OXE update**. Lê e segue **integralmente**:
|
|
8
|
+
|
|
9
|
+
`oxe/workflows/update.md` (na raiz do repositório em contexto; ou `.oxe/workflows/update.md` se a instalação aninhou os workflows)
|
|
10
|
+
|
|
11
|
+
Na prática: na raiz do projeto, correr **`npx oxe-cc update --check`**, depois (se aplicável) **`npx oxe-cc update`** ou **`npx oxe-cc update --if-newer`**, e por fim **`npx oxe-cc doctor`**.
|
package/.github/workflows/ci.yml
CHANGED
|
@@ -1,18 +1,20 @@
|
|
|
1
|
-
name: CI
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
branches: [main, master]
|
|
6
|
-
pull_request:
|
|
7
|
-
branches: [main, master]
|
|
8
|
-
|
|
9
|
-
jobs:
|
|
10
|
-
test:
|
|
11
|
-
runs-on: ubuntu-latest
|
|
12
|
-
steps:
|
|
13
|
-
- uses: actions/checkout@v4
|
|
14
|
-
- uses: actions/setup-node@v4
|
|
15
|
-
with:
|
|
16
|
-
node-version: '20'
|
|
17
|
-
|
|
18
|
-
- run: npm
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main, master]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main, master]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
test:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
- uses: actions/setup-node@v4
|
|
15
|
+
with:
|
|
16
|
+
node-version: '20'
|
|
17
|
+
cache: npm
|
|
18
|
+
- run: npm ci
|
|
19
|
+
- run: npm test
|
|
20
|
+
- run: npm run scan:assets
|
package/AGENTS.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# OXE — agentes (
|
|
1
|
+
# OXE — agentes (multi-IDE / multi-CLI)
|
|
2
2
|
|
|
3
|
-
Este repositório empacota o fluxo **OXE** (spec-driven, artefatos em `.oxe/`).
|
|
3
|
+
Este repositório empacota o fluxo **OXE** (spec-driven, artefatos em `.oxe/`). O núcleo é agnóstico; o **`oxe-cc`** integra com **várias IDEs e CLIs** (Cursor e GitHub Copilot como caminho padrão conhecido, mais Claude, OpenCode, Gemini, Codex, Windsurf, Antigravity quando instalado com **`--all-agents`** ou flags granulares).
|
|
4
4
|
|
|
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
|
-
- **
|
|
7
|
-
- **
|
|
6
|
+
- **Workflows canónicos:** [oxe/workflows/](oxe/workflows/) — editar aqui primeiro; todas as integrações apontam para estes ficheiros (inclui `quick.md`, `execute.md`). Referência **legado / brownfield:** [oxe/workflows/references/legacy-brownfield.md](oxe/workflows/references/legacy-brownfield.md) (COBOL, JCL, copybooks, VB6, SP).
|
|
7
|
+
- **Instruções do repositório:** [.github/copilot-instructions.md](.github/copilot-instructions.md) — aplicadas automaticamente no **GitHub Copilot Chat** quando o repo está em contexto (outras ferramentas usam os seus próprios homes após `oxe-cc install`).
|
|
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
9
|
- **SDK:** `require('oxe-cc')` expõe `runDoctorChecks`, `health`, `workflows`, `install`, `manifest`, `agents` — ver [lib/sdk/README.md](lib/sdk/README.md).
|
|
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
|
+
- **Prompt files (Copilot / VS Code):** [.github/prompts/*.prompt.md](.github/prompts/) — invocar com `/` no chat (ex. `/oxe-scan`, `/oxe-update`, `/oxe-review-pr` para diff tipo PR) após `chat.promptFiles` estar ativo.
|
|
11
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
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`.
|
|
13
13
|
|
package/README.md
CHANGED
|
@@ -4,20 +4,22 @@
|
|
|
4
4
|
<img src="assets/readme-banner.svg" alt="OXE" width="920" />
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
|
-
**Fluxo spec-driven e context engineering
|
|
7
|
+
**Fluxo spec-driven e context engineering centrado em `.oxe/`** — o núcleo é o mesmo em qualquer ferramenta. O instalador integra com **[Cursor](https://cursor.com)** e **[GitHub Copilot](https://github.com/features/copilot)** por padrão e, com **`--all-agents`** ou escolhas no menu, também com **Claude Code, OpenCode, Gemini CLI, Codex, Windsurf** e **Antigravity**. **Poucos comandos** por runtime, workflows em **`.oxe/workflows/`** (ou **`oxe/workflows/`** com `--global`). Textos do CLI e resumos pós-comando em **português (Brasil)**.
|
|
8
8
|
|
|
9
9
|
[](https://www.npmjs.com/package/oxe-cc)
|
|
10
10
|
[](LICENSE)
|
|
11
11
|
|
|
12
|
+
**Versão deste repositório / próximo publish npm:** `0.3.6` (fonte: [`package.json`](package.json)). No registo use `npx oxe-cc@latest` ou, para pinar, `npx oxe-cc@0.3.6`.
|
|
13
|
+
|
|
12
14
|
```bash
|
|
13
15
|
npx oxe-cc@latest
|
|
14
16
|
# equivalente explícito:
|
|
15
17
|
# npx oxe-cc@latest install
|
|
16
18
|
```
|
|
17
19
|
|
|
18
|
-
**Manter atualizado:** `npx oxe-cc
|
|
20
|
+
**Manter atualizado:** no **Cursor** use **`/oxe-update`**; noutras CLIs siga o mesmo fluxo com o terminal no projeto (`npx oxe-cc update --check`, `npx oxe-cc update` ou `npx oxe-cc@latest --force`). Com **`--force`**, alterações locais em arquivos rastreados geram backup em **`~/.oxe-cc/oxe-local-patches/`**.
|
|
19
21
|
|
|
20
|
-
[Para quem é](#para-quem-é) · [Começar](#começar) · [Como funciona](#como-funciona) · [Modo rápido](#modo-rápido) · [Porque funciona](#porque-funciona) · [Comandos](#comandos) · [Configuração](#configuração) · [SDK](#sdk-api-programática) · [Problemas](#resolução-de-problemas)
|
|
22
|
+
[Para quem é](#para-quem-é) · [Começar](#começar) · [Como funciona](#como-funciona) · [Modo rápido](#modo-rápido) · [Porque funciona](#porque-funciona) · [Comandos](#comandos) · [CLI (`oxe-cc`)](#cli-do-pacote-oxe-cc) · [Configuração](#configuração) · [SDK](#sdk-api-programática) · [Problemas](#resolução-de-problemas)
|
|
21
23
|
|
|
22
24
|
</div>
|
|
23
25
|
|
|
@@ -27,7 +29,7 @@ npx oxe-cc@latest
|
|
|
27
29
|
|
|
28
30
|
Para quem quer **descrever o que quer e ver isso construído de forma consistente** — **sem** simular uma organização enorme de processos em cima do repositório.
|
|
29
31
|
|
|
30
|
-
OXE é **enxuto**: não há dezenas de
|
|
32
|
+
OXE é **enxuto**: não há dezenas de comandos por ferramenta. Há **um CLI** que deixa o repositório **só com `.oxe/`** (layout **padrão**) ou **`oxe/` + `.oxe/`** com **`--global`**, e copia integrações para os homes que escolheres — tipicamente **`~/.cursor`**, **`~/.copilot`** e **`~/.claude`**, ou **OpenCode, Gemini, Codex, Windsurf, Antigravity** quando ativas — sempre com **workflows em Markdown** e **estado em disco** para a sessão não ficar **sobrecarregada** com tudo o que já foi decidido.
|
|
31
33
|
|
|
32
34
|
---
|
|
33
35
|
|
|
@@ -41,11 +43,11 @@ Na **raiz do repositório** do seu projeto:
|
|
|
41
43
|
npx oxe-cc@latest
|
|
42
44
|
```
|
|
43
45
|
|
|
44
|
-
Em **terminal interativo**, o instalador pergunta em **
|
|
46
|
+
Em **terminal interativo**, o instalador pergunta em **vários passos**: (1) **para quais ambientes** (Cursor, Copilot, OpenCode, Gemini, … ou todos); (2) **global vs local** no disco; (3) **layout no repositório** — **clássico** (`oxe/` na raiz + `.oxe/`) ou **mínimo** (**só `.oxe/`**). Em modo **global IDE**, as integrações vão para pastas do **usuário** (`~/.cursor`, `~/.copilot`, …); com **`--ide-local`**, podem ficar no repo (`.cursor`, `.github`, …). Por omissão antiga, **não** se criam pastas IDE dentro do repo. Com layout clássico e **`--vscode`**, **`.vscode/`** fica no projeto.
|
|
45
47
|
|
|
46
48
|
Ao terminar, o CLI mostra um **resumo do que foi criado ou atualizado** e **próximos passos sugeridos** (por exemplo `npx oxe-cc doctor`, `/oxe-scan`).
|
|
47
49
|
|
|
48
|
-
Sem TTY (CI), o **layout mínimo** (só `.oxe/`) e integrações no **HOME** são o padrão (Cursor + Copilot
|
|
50
|
+
Sem TTY (CI), o **layout mínimo** (só `.oxe/`) e integrações no **HOME** são o padrão (Cursor + Copilot; sem **`--all-agents`** a menos que configures). Use **`--global`** para também ter **`oxe/`** na raiz. Flags: **`--cursor`**, **`--copilot`**, **`--all-agents`**, **`--all`**, **`--oxe-only`**, **`OXE_NO_PROMPT=1`**, etc.
|
|
49
51
|
|
|
50
52
|
Se já existir **`.oxe/config.json`** com o bloco **`install`** (perfil, `repo_layout`, …), o `oxe-cc` aplica isso **quando não passas** flags explícitas de integração — útil em CI. Para ignorar o ficheiro nessa corrida: **`--no-install-config`**. Detalhes: [`oxe/templates/CONFIG.md`](oxe/templates/CONFIG.md).
|
|
51
53
|
|
|
@@ -59,10 +61,13 @@ No fim, em modo interativo, pergunta se você quer instalar o **`oxe-cc` globalm
|
|
|
59
61
|
|
|
60
62
|
| Onde | O que executar |
|
|
61
63
|
|------|----------------|
|
|
62
|
-
| **Cursor** | `/oxe-help` |
|
|
64
|
+
| **Cursor** | `/oxe-help` ou outro `/oxe-*` |
|
|
63
65
|
| **Copilot** (VS Code) | `/oxe-help` no chat, se [prompt files](https://code.visualstudio.com/docs/copilot/customization/prompt-files) estiverem ativos (`"chat.promptFiles": true` — exemplo em [`.vscode/settings.json`](.vscode/settings.json)) |
|
|
66
|
+
| **Copilot CLI** | `/oxe` ou `/oxe-scan` após **`/skills reload`** |
|
|
67
|
+
| **Gemini CLI** | `/oxe` ou `/oxe:scan` após **`/commands reload`** (se instalou essa stack) |
|
|
68
|
+
| **OpenCode / Codex / Windsurf / Antigravity** | Ver caminhos no resumo pós-instalação e o README na secção **Multi-agente** |
|
|
64
69
|
|
|
65
|
-
> **Nota:** Instruções e prompt files do Copilot ficam em **`~/.copilot
|
|
70
|
+
> **Nota:** Instruções e prompt files do Copilot (VS Code) ficam em **`~/.copilot/`** por padrão, não em `.github/` no repo alvo. **`oxe-cc doctor`** aceita workflows em **`.oxe/workflows/`** ou **`oxe/workflows/`**. Em qualquer IDE, você ainda pode pedir em linguagem natural com o repositório e o workflow em contexto.
|
|
66
71
|
|
|
67
72
|
**Sem pacote no npm** (`npm view oxe-cc version` → 404): clone este repo, `npm link` na pasta **oxe-build**, `npm link oxe-cc` no seu projeto e execute `oxe-cc`. Alternativa: `node /caminho/oxe-build/bin/oxe-cc.js`.
|
|
68
73
|
|
|
@@ -98,10 +103,10 @@ No fim, em modo interativo, pergunta se você quer instalar o **`oxe-cc` globalm
|
|
|
98
103
|
|---------|--------|
|
|
99
104
|
| `oxe-cc` ou `oxe-cc install` | Instalação predefinida (mesmo comportamento; `install` é alias explícito) |
|
|
100
105
|
| `oxe-cc doctor` | Valida Node, workflows do pacote, `.oxe/`, coerência STATE vs arquivos, scan antigo (`scan_max_age_days`), seções da SPEC, ondas do PLAN |
|
|
101
|
-
| `oxe-cc status` | Leve: coerência `.oxe/` + **um** próximo passo sugerido (espelha o workflow `next`; não exige o conjunto completo de workflows como o `doctor`) |
|
|
106
|
+
| `oxe-cc status` | Leve: coerência `.oxe/` + **um** próximo passo sugerido (espelha o workflow `next`; não exige o conjunto completo de workflows como o `doctor`). **`--json`**: uma linha JSON com `nextStep`, `diagnostics`, etc., para CI ou scripts |
|
|
102
107
|
| `oxe-cc init-oxe` | Só o bootstrap `.oxe/` (STATE, config, codebase) |
|
|
103
108
|
| `oxe-cc uninstall` | Remove integrações OXE em `~/.cursor`, `~/.copilot`, `~/.claude` e pastas de workflows no repo (`--ide-only` só no HOME) |
|
|
104
|
-
| `oxe-cc update` | Executa `npx oxe-cc@latest --force` na pasta do projeto
|
|
109
|
+
| `oxe-cc update` | Executa `npx oxe-cc@latest --force` na pasta do projeto; **`--check`** só consulta o npm; **`--if-newer`** evita o npx quando já está na última |
|
|
105
110
|
|
|
106
111
|
</details>
|
|
107
112
|
|
|
@@ -123,6 +128,23 @@ Para testar no seu app: `npm link` aqui, depois `npm link oxe-cc` no projeto alv
|
|
|
123
128
|
|
|
124
129
|
## Como funciona
|
|
125
130
|
|
|
131
|
+
### Ciclo por trilha
|
|
132
|
+
|
|
133
|
+
Fluxo sugerido (cada iteração de trabalho segue a trilha e volta ao **scan** quando for hora de realinhar com o repo):
|
|
134
|
+
|
|
135
|
+
```mermaid
|
|
136
|
+
flowchart LR
|
|
137
|
+
scan --> spec
|
|
138
|
+
spec --> plan
|
|
139
|
+
plan --> execute
|
|
140
|
+
execute --> verify
|
|
141
|
+
verify -->|próxima trilha| scan
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
**verify (T):** as tarefas **T** do plano trazem o bloco **Verificar** (comando ou checklist) por item; o passo **`/oxe-verify`** cruza SPEC + PLAN com o código e grava **`.oxe/VERIFY.md`**.
|
|
145
|
+
|
|
146
|
+
<p align="center"><img src="assets/oxe-ciclo-por-trilha.png" alt="Diagrama: scan → spec → plan → execute → verify (T), seta de volta a scan" width="720" /></p>
|
|
147
|
+
|
|
126
148
|
**Já tem código no repositório?** Comece por **`/oxe-scan`**. Isso gera mapas em **`.oxe/codebase/`** (stack, estrutura, testes, convenções, etc.). Assim o **spec** e o **plan** alinham com o repo real antes de planear em grande escala.
|
|
127
149
|
|
|
128
150
|
### 1. Mapear — `/oxe-scan`
|
|
@@ -189,34 +211,145 @@ Se o trabalho crescer, **promova** para spec + plan completos.
|
|
|
189
211
|
|
|
190
212
|
## Comandos
|
|
191
213
|
|
|
192
|
-
|
|
214
|
+
Slash commands (Cursor: `~/.cursor/commands/` após instalar) e prompt files (Copilot: `~/.copilot/prompts/` com `chat.promptFiles`). A **fonte única** dos passos está em [`oxe/workflows/*.md`](oxe/workflows/) no pacote ou em [`.oxe/workflows/`](.oxe/workflows/) no projeto após `npx oxe-cc`.
|
|
215
|
+
|
|
216
|
+
### Resumo rápido
|
|
217
|
+
|
|
218
|
+
| Comando / prompt | Workflow (fonte dos passos) |
|
|
219
|
+
|------------------|-------------------|
|
|
220
|
+
| `/oxe-scan` | [`scan.md`](oxe/workflows/scan.md) |
|
|
221
|
+
| `/oxe-spec` | [`spec.md`](oxe/workflows/spec.md) |
|
|
222
|
+
| `/oxe-discuss` | [`discuss.md`](oxe/workflows/discuss.md) |
|
|
223
|
+
| `/oxe-plan` | [`plan.md`](oxe/workflows/plan.md) |
|
|
224
|
+
| `/oxe-quick` | [`quick.md`](oxe/workflows/quick.md) |
|
|
225
|
+
| `/oxe-execute` | [`execute.md`](oxe/workflows/execute.md) |
|
|
226
|
+
| `/oxe-verify` | [`verify.md`](oxe/workflows/verify.md) |
|
|
227
|
+
| `/oxe-next` | [`next.md`](oxe/workflows/next.md) |
|
|
228
|
+
| `/oxe-help` | [`help.md`](oxe/workflows/help.md) |
|
|
229
|
+
| `/oxe-update` | [`update.md`](oxe/workflows/update.md) |
|
|
230
|
+
| `/oxe-review-pr` *(prompt Copilot; ver nota abaixo)* | [`review-pr.md`](oxe/workflows/review-pr.md) |
|
|
231
|
+
| *(mantenedores)* `workflow-authoring` em linguagem natural | [`workflow-authoring.md`](oxe/workflows/workflow-authoring.md) |
|
|
232
|
+
|
|
233
|
+
### Referência completa por passo
|
|
234
|
+
|
|
235
|
+
#### `/oxe-scan`
|
|
236
|
+
|
|
237
|
+
- **O que faz:** Analisa o repositório e produz **sete** mapas estruturados em `.oxe/codebase/` (overview, stack, estrutura, testes, integrações, convenções, preocupações) e atualiza `.oxe/STATE.md` com data de scan e fase sugerida.
|
|
238
|
+
- **Artefatos:** `.oxe/codebase/*.md`, `.oxe/STATE.md` (não apaga `SPEC.md` / `PLAN.md`).
|
|
239
|
+
- **Quando usar:** Após clonar, quando o repo mudou muito, ou quando quiser foco opcional (pasta/módulo) ou `scan_focus_globs` em `.oxe/config.json`.
|
|
240
|
+
- **Limite:** Não executa testes por si; não substitui leitura do código — condensa para contexto de agente. Repositórios legado: segue também [`references/legacy-brownfield.md`](oxe/workflows/references/legacy-brownfield.md).
|
|
241
|
+
- **Workflow:** [`oxe/workflows/scan.md`](oxe/workflows/scan.md)
|
|
242
|
+
|
|
243
|
+
#### `/oxe-spec`
|
|
244
|
+
|
|
245
|
+
- **O que faz:** Regista o contrato do trabalho em `.oxe/SPEC.md`: objetivo, escopo, **critérios de aceite com IDs estáveis (A1, A2, …)** e coluna *Como verificar*, suposições e riscos.
|
|
246
|
+
- **Artefatos:** `.oxe/SPEC.md`, `.oxe/STATE.md` (fase `spec_ready`).
|
|
247
|
+
- **Quando usar:** Antes de planear qualquer entrega média ou grande; entrada pode ser texto livre ou `@ficheiro.md`.
|
|
248
|
+
- **Limite:** Não implementa código; o plano e o verify é que amarram tarefas aos **A*** .
|
|
249
|
+
- **Workflow:** [`oxe/workflows/spec.md`](oxe/workflows/spec.md)
|
|
250
|
+
|
|
251
|
+
#### `/oxe-discuss`
|
|
252
|
+
|
|
253
|
+
- **O que faz:** Regista perguntas, respostas e decisões em `.oxe/DISCUSS.md` (máx. 7 perguntas enxutas) antes do plano, alinhado à SPEC.
|
|
254
|
+
- **Artefatos:** `.oxe/DISCUSS.md`, `.oxe/STATE.md` (`discuss_complete`).
|
|
255
|
+
- **Quando usar:** Ambiguidade na SPEC, risco técnico, ou `discuss_before_plan: true` em `.oxe/config.json`.
|
|
256
|
+
- **Limite:** Opcional; não substitui a SPEC nem o PLAN.
|
|
257
|
+
- **Workflow:** [`oxe/workflows/discuss.md`](oxe/workflows/discuss.md)
|
|
258
|
+
|
|
259
|
+
#### `/oxe-plan`
|
|
260
|
+
|
|
261
|
+
- **O que faz:** Gera ou atualiza `.oxe/PLAN.md` com tarefas **Tn**, **ondas**, dependências, bloco **Verificar** por tarefa e **Aceite vinculado** aos critérios **A*** da SPEC; suporta `--replan` após `verify_failed` usando `VERIFY.md` / `SUMMARY.md`.
|
|
262
|
+
- **Artefatos:** `.oxe/PLAN.md`, `.oxe/STATE.md` (`plan_ready`).
|
|
263
|
+
- **Quando usar:** SPEC pronta (e discuss, se a config obrigar); base em `.oxe/codebase/*` e código real.
|
|
264
|
+
- **Limite:** Não executa as tarefas — isso é **execute** + o teu Git.
|
|
265
|
+
- **Workflow:** [`oxe/workflows/plan.md`](oxe/workflows/plan.md)
|
|
193
266
|
|
|
194
|
-
|
|
195
|
-
|---------|-----------|
|
|
196
|
-
| `/oxe-scan` | Mapeia o codebase → `.oxe/codebase/` |
|
|
197
|
-
| `/oxe-spec` | Escreve/atualiza `.oxe/SPEC.md` |
|
|
198
|
-
| `/oxe-discuss` | Decisões antes do plano → `.oxe/DISCUSS.md` |
|
|
199
|
-
| `/oxe-plan` | Pesquisa no repo + plano com ondas e Verificar |
|
|
200
|
-
| `/oxe-execute` | Execução guiada do plano (ou QUICK) |
|
|
201
|
-
| `/oxe-verify` | Validação; `.oxe/VERIFY.md` |
|
|
202
|
-
| `/oxe-next` | Sugere o próximo passo |
|
|
203
|
-
| `/oxe-help` | Ajuda e visão geral |
|
|
267
|
+
#### `/oxe-quick`
|
|
204
268
|
|
|
205
|
-
|
|
269
|
+
- **O que faz:** Fluxo curto com `.oxe/QUICK.md` (passos numerados + verificar) para trabalho pontual sem SPEC/PLAN longos.
|
|
270
|
+
- **Artefatos:** `.oxe/QUICK.md`, `.oxe/STATE.md` conforme fluxo.
|
|
271
|
+
- **Quando usar:** Fix ou spike muito pequeno; promover a spec/plan se o trabalho crescer.
|
|
272
|
+
- **Limite:** Menos trilha de auditoria que SPEC+PLAN completos.
|
|
273
|
+
- **Workflow:** [`oxe/workflows/quick.md`](oxe/workflows/quick.md)
|
|
206
274
|
|
|
207
|
-
|
|
208
|
-
|---------|-----------|
|
|
209
|
-
| `/oxe-quick` | `.oxe/QUICK.md` — tarefa pontual |
|
|
275
|
+
#### `/oxe-execute`
|
|
210
276
|
|
|
211
|
-
|
|
277
|
+
- **O que faz:** Guia a implementação **onda a onda** com base em `PLAN.md` (ou passos de `QUICK.md`), com checklist explícito e atualização de `.oxe/STATE.md` (progresso Tn / ondas).
|
|
278
|
+
- **Artefatos:** Código/docs que implementas; `.oxe/STATE.md` (checklist de onda).
|
|
279
|
+
- **Quando usar:** Durante a execução do plano ou do QUICK, para não saltar pré-requisitos nem verificações da onda.
|
|
280
|
+
- **Limite:** Não faz commits nem impõe subagentes — fica a teu critério de equipa.
|
|
281
|
+
- **Workflow:** [`oxe/workflows/execute.md`](oxe/workflows/execute.md)
|
|
212
282
|
|
|
213
|
-
|
|
214
|
-
|--------|-----------|
|
|
215
|
-
| `/oxe-review-pr` | Segue `oxe/workflows/review-pr.md`: diff estilo PR (`git diff base...head`, `gh pr diff <n>`, ou fetch `pull/<n>/head`), riscos, testes e checklist. Você pode colar o **link da PR** (ex.: `https://github.com/org/repo/pull/10`) ou indicar `main` e `feature/x`. **Não** há slash command em `.cursor/commands/`; no Cursor você pode pedir o mesmo em linguagem natural com o workflow em contexto. |
|
|
283
|
+
#### `/oxe-verify`
|
|
216
284
|
|
|
217
|
-
|
|
285
|
+
- **O que faz:** Corre ou orienta verificação: comandos do PLAN, confronto de **cada** critério **A*** da SPEC com evidência, registo em `.oxe/VERIFY.md`; opcionalmente rascunho de commit e checklist de PR conforme `.oxe/config.json`.
|
|
286
|
+
- **Artefatos:** `.oxe/VERIFY.md`, `.oxe/STATE.md` (`verify_complete` / `verify_failed`), `.oxe/SUMMARY.md` quando há gaps relevantes.
|
|
287
|
+
- **Quando usar:** Após implementar uma onda ou fechar o plano; pode focar uma tarefa **Tn** se indicares.
|
|
288
|
+
- **Limite:** Sandbox pode impedir comandos — regista “não executado aqui” e deixa o comando para correres localmente.
|
|
289
|
+
- **Workflow:** [`oxe/workflows/verify.md`](oxe/workflows/verify.md)
|
|
218
290
|
|
|
219
|
-
|
|
291
|
+
#### `/oxe-next`
|
|
292
|
+
|
|
293
|
+
- **O que faz:** Sugere o **único** próximo passo lógico com base nos artefactos `.oxe/` (equivalente conceptual ao que o terminal faz com `npx oxe-cc status`, sem validar o pacote de workflows completo).
|
|
294
|
+
- **Artefatos:** Pode sugerir atualizar `STATE.md` após confirmares a ação.
|
|
295
|
+
- **Quando usar:** Retomar trabalho ou desbloquear “o que faço agora?”.
|
|
296
|
+
- **Limite:** Heurística sobre arquivos existentes; não substitui leitura humana do PLAN.
|
|
297
|
+
- **Workflow:** [`oxe/workflows/next.md`](oxe/workflows/next.md)
|
|
298
|
+
|
|
299
|
+
#### `/oxe-help`
|
|
300
|
+
|
|
301
|
+
- **O que faz:** Apresenta o fluxo OXE (scan → spec → plan → execute → verify), modo quick, invocação em várias IDEs/CLIs e referência ao `oxe-cc` (install, doctor, status, …).
|
|
302
|
+
- **Artefatos:** Nenhum obrigatório (só saída no chat).
|
|
303
|
+
- **Quando usar:** Onboarding ou quando mudas de IDE.
|
|
304
|
+
- **Limite:** Resumo; detalhe máximo continua nos workflows linkados.
|
|
305
|
+
- **Workflow:** [`oxe/workflows/help.md`](oxe/workflows/help.md)
|
|
306
|
+
|
|
307
|
+
#### `/oxe-update`
|
|
308
|
+
|
|
309
|
+
- **O que faz:** Segue o workflow de atualização: verificar versão no npm, correr `npx oxe-cc@latest` com flags adequadas, `doctor`, e próximos passos (ex. `/oxe-scan` se workflows mudaram).
|
|
310
|
+
- **Artefatos:** Arquivos do pacote OXE no projeto e integrações conforme a tua instalação.
|
|
311
|
+
- **Quando usar:** Após anúncio de release ou quando queres alinhar workflows/templates à última versão publicada.
|
|
312
|
+
- **Limite:** Não altera o teu código de aplicação fora do que o instalador OXE gere.
|
|
313
|
+
- **Workflow:** [`oxe/workflows/update.md`](oxe/workflows/update.md)
|
|
314
|
+
|
|
315
|
+
#### Revisão de PR / diff (`review-pr`)
|
|
316
|
+
|
|
317
|
+
- **O que faz:** Análise estilo code review sobre diff entre branches, link de PR, ou `gh pr diff`: riscos, testes sugeridos, checklist.
|
|
318
|
+
- **Artefatos:** Saída no chat (não obriga arquivos em `.oxe/`).
|
|
319
|
+
- **Quando usar:** Antes de merge ou para revisão rápida de alterações alheias.
|
|
320
|
+
- **Copilot (VS Code):** prompt file **`/oxe-review-pr`** quando `chat.promptFiles` está ativo.
|
|
321
|
+
- **Cursor:** não há slash dedicado em `.cursor/commands/` — abre [`oxe/workflows/review-pr.md`](oxe/workflows/review-pr.md) no contexto ou pede em linguagem natural o mesmo fluxo.
|
|
322
|
+
- **Workflow:** [`oxe/workflows/review-pr.md`](oxe/workflows/review-pr.md)
|
|
323
|
+
|
|
324
|
+
#### Autoria de workflows (`workflow-authoring`)
|
|
325
|
+
|
|
326
|
+
- **O que faz:** Alinha edições de `oxe/workflows/*.md` ao guia de estrutura (objective/context/process/success_criteria), progressive disclosure, e coerência com Cursor/Copilot.
|
|
327
|
+
- **Artefatos:** Alterações nos próprios workflows do pacote ou fork.
|
|
328
|
+
- **Quando usar:** Manutenção do OXE ou contribuição de novos passos.
|
|
329
|
+
- **Limite:** Para utilizadores finais do fluxo spec/plan, não é necessário no dia a dia.
|
|
330
|
+
- **Workflow:** [`oxe/workflows/workflow-authoring.md`](oxe/workflows/workflow-authoring.md)
|
|
331
|
+
|
|
332
|
+
### Outros clientes (nomes `oxe:*`)
|
|
333
|
+
|
|
334
|
+
Em **Claude Code**, **Copilot CLI** (skills), **Gemini CLI**, **OpenCode**, **Codex**, **Windsurf**, **Antigravity**, os mesmos passos aparecem com nomes como **`oxe:scan`**, **`oxe:plan`**, **`/oxe-scan`**, etc., conforme o destino instalado com `oxe-cc --all-agents` ou flags granulares. O núcleo continua a ser `.oxe/` no **projeto alvo**.
|
|
335
|
+
|
|
336
|
+
---
|
|
337
|
+
|
|
338
|
+
## CLI do pacote (`oxe-cc`)
|
|
339
|
+
|
|
340
|
+
Comandos no terminal na **raiz do projeto** (ou `--dir`). Útil em CI, scripts e quando não estás num chat com slash commands.
|
|
341
|
+
|
|
342
|
+
| Subcomando | Poder principal |
|
|
343
|
+
|------------|-----------------|
|
|
344
|
+
| `oxe-cc` / `oxe-cc install` | Copia **workflows** e **templates** para `.oxe/` (layout mínimo) ou `oxe/` + `.oxe/` (`--global`), e instala integrações IDE/CLI conforme flags (`--cursor`, `--copilot`, `--all-agents`, …). |
|
|
345
|
+
| `oxe-cc doctor` | Validação **completa**: versão Node, diff workflows **pacote npm ↔ projeto**, parse de `.oxe/config.json`, coerência de **STATE** com arquivos esperados, scan antigo (`scan_max_age_days`), seções obrigatórias da SPEC, ondas do PLAN, avisos de estrutura dos `.md` de workflow, e **planWarn** (inclui tarefas **Tn** sem `**Aceite vinculado:**`). |
|
|
346
|
+
| `oxe-cc status` | Diagnóstico **mais leve**: mesma leitura de saúde `.oxe/` + config + **um único** próximo passo sugerido (`suggestNextStep`) — não exige o mesmo conjunto de checks pesados do `doctor` sobre o pacote. |
|
|
347
|
+
| `oxe-cc status --json` | Igual ao `status`, mas imprime **uma linha JSON** (`oxeStatusSchema`, `nextStep`, `cursorCmd`, `reason`, `artifacts`, `phase`, `diagnostics.*`) para pipelines e agentes automáticos. Sem banner quando `--json`. |
|
|
348
|
+
| `oxe-cc init-oxe` | Apenas **bootstrap** de `.oxe/STATE.md`, `.oxe/config.json` e pasta `.oxe/codebase/` — sem reinstalar integrações nas tuas pastas home. |
|
|
349
|
+
| `oxe-cc update` | Corre `npx oxe-cc@latest --force` no projeto (ou equivalente) para alinhar workflows/templates; **`--check`** só compara versão no npm; **`--if-newer`** evita o npx se já estiveres na última. |
|
|
350
|
+
| `oxe-cc uninstall` | Por omissão remove integrações em `~/.cursor`, `~/.copilot`, … **e** pastas de workflows no projeto (`.oxe/workflows`, `oxe/`, `commands/oxe`, …). **`--ide-only`** não remove workflows no repo (só integrações no HOME). **`--ide-local`** também remove integrações OXE **dentro** do repositório (`.cursor`, `.github`, `.claude`, `.copilot`, …). |
|
|
351
|
+
|
|
352
|
+
**SDK:** `require('oxe-cc')` expõe `runDoctorChecks`, `health.buildHealthReport`, `health.suggestNextStep`, etc. — ver secção [SDK](#sdk-api-programática) abaixo e [`lib/sdk/README.md`](lib/sdk/README.md).
|
|
220
353
|
|
|
221
354
|
---
|
|
222
355
|
|
|
@@ -224,6 +357,8 @@ Em **Claude Code** (ou ferramentas que leem `commands/oxe/`), os mesmos passos e
|
|
|
224
357
|
|
|
225
358
|
Preferências do projeto em **`.oxe/config.json`** (criado no bootstrap a partir de `oxe/templates/config.template.json`). Inclui opções de fluxo (`discuss_before_plan`, `scan_max_age_days`, `spec_required_sections`, …) e, opcionalmente, o bloco **`install`** (perfil de integração e layout do repo quando corres o instalador sem flags IDE). Referência completa: [`oxe/templates/CONFIG.md`](oxe/templates/CONFIG.md).
|
|
226
359
|
|
|
360
|
+
Repositórios **legado** (COBOL, JCL, copybooks, VB6, stored procedures): os workflows **scan**, **spec**, **plan**, **execute** e **verify** delegam padrões de análise e verificação em [`.oxe/workflows/references/legacy-brownfield.md`](oxe/workflows/references/legacy-brownfield.md) após `npx oxe-cc` (no pacote fonte: [`oxe/workflows/references/legacy-brownfield.md`](oxe/workflows/references/legacy-brownfield.md)).
|
|
361
|
+
|
|
227
362
|
---
|
|
228
363
|
|
|
229
364
|
## SDK (API programática)
|
|
@@ -247,7 +382,7 @@ Também estão disponíveis `oxe.health`, `oxe.workflows`, `oxe.install.resolveO
|
|
|
247
382
|
| Comandos não aparecem no Cursor | Confirme que `~/.cursor/commands/` (ou a pasta configurada) existe; reinicie o Cursor |
|
|
248
383
|
| Prompts `/oxe-*` não aparecem no Copilot | Ative `"chat.promptFiles": true`; confirme prompts em **`~/.copilot/prompts/`** (o OXE não coloca `.github/` no repo para o Copilot) |
|
|
249
384
|
| **`/oxe` ou `/oxe-*` não aparecem no Copilot CLI** | O CLI usa **skills** em **`~/.copilot/skills/`**, não a pasta `commands`. Rode `npx oxe-cc --copilot-cli` (ou perfil com CLI), depois **`/skills reload`**. Use **`/oxe`** (ajuda) ou **`/oxe-scan`**, etc. |
|
|
250
|
-
| **`ETARGET`** / versão não encontrada no `npx` | `npm cache clean --force`, `npx clear-npx-cache`, ou fixe a versão: `npx oxe-cc@0.3.
|
|
385
|
+
| **`ETARGET`** / versão não encontrada no `npx` | `npm cache clean --force`, `npx clear-npx-cache`, ou fixe a versão: `npx oxe-cc@0.3.6`. Verifique `npm config get registry` |
|
|
251
386
|
| **404** no `npm view oxe-cc` | Pacote com outro nome (scope) ou ainda não publicado — use `npm link` ou `node …/bin/oxe-cc.js` |
|
|
252
387
|
| Arquivos não atualizam | Reinstale com **`--force`** (com backup local se você tiver editado arquivos rastreados) |
|
|
253
388
|
| Erro no **WSL** sobre Node do Windows | Use **Node instalado dentro do WSL** (o `oxe-cc` recusa `node.exe` do Windows em ambiente WSL para evitar caminhos quebrados) |
|
|
Binary file
|