theforge-cli 0.0.0-stage → 0.1.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.
@@ -0,0 +1,147 @@
1
+ # Arquitetura
2
+
3
+ O forge-cli é um CLI Node.js (ESM + TypeScript) de fluxo único: um
4
+ orquestrador fino coordena módulos pequenos e testáveis. A regra de
5
+ organização é simples — **`src/index.ts` só orquestra; toda lógica
6
+ vive em módulos especializados.**
7
+
8
+ ## Mapa de módulos
9
+
10
+ | Módulo | Responsabilidade |
11
+ | ------------------------ | ------------------------------------------------------------------------------------------------------ |
12
+ | `src/index.ts` | Só despacha: parse de args, menu, resolução do subcomando, SIGINT e erros fatais. |
13
+ | `src/cmd/shared.ts` | Banner, preflight, catálogo efetivo, `--json`, seleção de Forjas por nome. |
14
+ | `src/cmd/batch.ts` | Execução sequencial com spinner/taskLog por Forja. |
15
+ | `src/cmd/query.ts` | `doctor`, `list`, `status`, `update --check`, `versions` (com `--json`). |
16
+ | `src/cmd/manage.ts` | `pin`, `unpin`, `rollback`, `uninstall <forjas>`, `self update`, PATH. |
17
+ | `src/cmd/run.ts` | Fluxo de instalação/clone/update/reinstall e resumo de execução com aprovação. |
18
+ | `src/prompts.ts` | Prompts interativos (diretório, seleção, confirmação) e tratamento de cancelamento via `isCancel()`. |
19
+ | `src/preflight.ts` | Verificações de ambiente antes de qualquer prompt: `git`, Node.js >= 20, `powershell.exe` no Windows. |
20
+ | `src/runner.ts` | Pipeline por repositório com cronômetro e fases: sincronizar → `.env` → script de instalação. |
21
+ | `src/env.ts` | Provisionamento do `.env` (`planEnvFile` decide, `ensureEnvFile` executa). |
22
+ | `src/report.ts` | Badges de status, linha por repositório e relatório consolidado. |
23
+ | `src/ui/theme.ts` | Paleta de cores (picocolors) e ícones emoji. Único ponto de contato com cores. |
24
+ | `src/ui/strings.ts` | Todas as strings visíveis ao usuário, em PT-BR. |
25
+ | `src/constants/repos.ts` | Catálogo fixo dos oito repositórios Forge. |
26
+ | `src/utils/system.ts` | Primitivas: resolução de caminho, `.git`, seleção de script por SO, `execa`, detalhe de erro. |
27
+ | `src/commands.ts` | Resolve o subcomando (`install`, `clone`, `update`, `pin`, `self ...`) a partir dos posicionais. |
28
+ | `src/menu.ts` | Menu principal; só aparece com TTY e sem comando/flags de seleção. |
29
+ | `src/safety.ts` | Nomes/URLs de repositório válidos, bloqueio de symlink/junction, redação de segredos, escrita atômica. |
30
+ | `src/git-revs.ts` | Tags, checkout destacado por ref/versão, verificação de atualização via fetch. |
31
+ | `src/lifecycle.ts` | Plano e execução de uninstall (com backup) e rollback de checkout. |
32
+ | `src/native-install.ts` | Monta o `<cli> install` nativo da Forja com as flags que ela documenta. |
33
+ | `src/status.ts` | Fase local (não clonado, clonado, instalado, falha), versão e alterações. |
34
+ | `src/self.ts` | Detecta o método de instalação do CLI e planeja o `self update`. |
35
+ | `src/types.ts` | Tipos compartilhados (`ForgeRepo`, `RepoResult`, `InstallScript`, `PreflightCheck`). |
36
+
37
+ ## Fluxo de execução
38
+
39
+ ```mermaid
40
+ flowchart TD
41
+ A[Banner animado + intro] --> B[Preflight: git, Node, powershell]
42
+ B -->|falha| Z1[log.error + exit 1]
43
+ B -->|ok| C[Prompt: diretório de destino]
44
+ C --> D[Resolve caminho + mkdir -p]
45
+ D --> E[Multiselect: 8 repositórios]
46
+ E --> F[Resumo + confirmar]
47
+ F -->|cancelou| Z2[cancel + exit 0]
48
+ F -->|confirmou| G[Para cada repositório]
49
+ G --> H{Pasta tem .git?}
50
+ H -->|sim| I[git pull]
51
+ H -->|não| J[git clone]
52
+ I --> K[Provisionar .env]
53
+ J --> K
54
+ K -->|falha| L[ERRO: pula script]
55
+ K --> M{Script do SO existe?}
56
+ M -->|não| N[AVISO: sem script]
57
+ M -->|sim| O[install.ps1 ou install.sh]
58
+ O -->|falha| P[ERRO]
59
+ O -->|ok| Q[OK]
60
+ L & N & P & Q --> R[Próximo repositório]
61
+ R -->|fim da lista| S[Relatório + outro]
62
+ ```
63
+
64
+ ## Camadas adicionadas no roadmap 2.0
65
+
66
+ - **Segurança antes de execução:** todo nome/URL passa por `safety.ts`; o
67
+ destino nunca é symlink; segredos são mascarados em logs, relatórios e erros.
68
+ - **Sync com política:** falha de pull, divergência ou remote diferente do
69
+ catálogo impedem a execução de scripts, salvo aprovação por flag.
70
+ - **Instalação em duas fases:** bootstrap (`setup.sh/ps1`) e, sob opt-in
71
+ (`--profile/--scope/--components`), o `<cli> install` da própria Forja —
72
+ sempre `--dry-run` sem `--yes`. Veja [capabilities.md](capabilities.md).
73
+ - **Independência:** nenhuma Forja depende do forge-cli; o estado em
74
+ `.forge-cli/` é auxiliar e pode ser descartado.
75
+
76
+ ## Decisões de design
77
+
78
+ ### `.env` antes do script de instalação
79
+
80
+ Os scripts `install.ps1`/`install.sh` presumem variáveis de ambiente.
81
+ O `runner` provisiona o `.env` entre a sincronização e o script: se o
82
+ provisionamento falhar, o script nem roda — falhar cedo evita
83
+ instalações parciais silenciosas.
84
+
85
+ ### `.env` nunca é sobrescrito
86
+
87
+ `planEnvFile` retorna `exists` quando o `.env` já está presente. O
88
+ repo pode ter segredos reais configurados; o CLI só cria o arquivo
89
+ quando ele não existe. Esta regra é coberta por teste em
90
+ `tests/env.test.ts`.
91
+
92
+ ### Preflight falha rápido
93
+
94
+ Ambiente sem `git` ou sem `powershell.exe` (Windows) não consegue
95
+ completar o fluxo. Melhor falhar com mensagem clara antes de criar
96
+ diretórios do que descobrir no meio do lote.
97
+
98
+ ### Isolamento de erro por repositório
99
+
100
+ `processRepo` converte cada falha (clone, `.env`, script) em um
101
+ `RepoResult` com `status: 'error'` em vez de lançar exceção. O laço
102
+ continua e o relatório final mostra o quadro completo.
103
+
104
+ ### Erro detalhado via execa
105
+
106
+ `errorDetail` extrai `stderr`, `shortMessage` ou `message` do erro do
107
+ `execa` — o relatório mostra a causa real (por exemplo, erro de
108
+ autenticação do git), não só "falhou".
109
+
110
+ ### Strings e cores centralizadas
111
+
112
+ Todo texto PT-BR vive em `src/ui/strings.ts` e toda cor em
113
+ `src/ui/theme.ts`. Isso mantém o código livre de literais soltos e
114
+ abre caminho para i18n futura sem reescrever módulos.
115
+
116
+ ## Tipos centrais
117
+
118
+ ```typescript
119
+ interface ForgeRepo {
120
+ name;
121
+ url;
122
+ description;
123
+ }
124
+ type RepoStatus = 'ok' | 'warning' | 'error';
125
+ type EnvAction = 'exists' | 'copied' | 'stub';
126
+ interface RepoResult {
127
+ repo;
128
+ status;
129
+ detail;
130
+ envNote?;
131
+ elapsedMs;
132
+ }
133
+ interface InstallScript {
134
+ file;
135
+ command;
136
+ args;
137
+ }
138
+ ```
139
+
140
+ ## Build e distribuição
141
+
142
+ - `tsup` compila `src/index.ts` para `dist/index.js` (ESM único,
143
+ ~12 KB), preservando o shebang do binário.
144
+ - `bin.forge-cli` aponta para `dist/index.js`; `npm link` registra o
145
+ comando global.
146
+ - Dependências ficam externas ao bundle e são instaladas via
147
+ `package.json`.
@@ -0,0 +1,108 @@
1
+ # Matriz de capacidades das Forjas
2
+
3
+ Levantamento estático (leitura do código e da documentação dos repositórios,
4
+ clones rasos em diretório temporário, sem executar instaladores). Nada aqui é
5
+ suposição: o que não pôde ser confirmado está marcado **não verificado**.
6
+
7
+ Revisões inspecionadas (HEAD de `main` em 2026-10-12):
8
+
9
+ | Forja | Commit |
10
+ | ----------------- | --------- |
11
+ | the-forge | `2f1d8bf` |
12
+ | spark-forge-aws | `b554143` |
13
+ | spark-forge-azure | `2063dc5` |
14
+ | api-forge | `7fcdf12` |
15
+ | platform-forge | `9ace433` |
16
+ | forge-doctor-api | `b927742` |
17
+ | forge-doctor-data | `3ac1cae` |
18
+ | forge-portal | `d0b6ba9` |
19
+
20
+ ## Modelo de instalação em duas fases
21
+
22
+ 1. **Bootstrap** — `setup.sh` / `setup.ps1` (todas as Forjas Python) chamam
23
+ `scripts/forge_bootstrap.py`. Aceita apenas: `--dry-run --editable
24
+ --extras --install-dir --no-deps --no-launcher --python --quiet --repo
25
+ --upgrade --version --allow-download` (`--persist-env` em api-forge).
26
+ **Não** aceita perfil, escopo ou componentes.
27
+ 2. **Instalador nativo do produto** — CLI da própria Forja, após o bootstrap:
28
+ `<cli> install [--scope project|workspace|user] [--profile
29
+ minimal|recommended|full] [--components ...] [--host claude|devin|codex|copilot|all]
30
+ [--gateway-profile economy|balanced|deep] [--dry-run] [--yes]`, além de
31
+ `install doctor`.
32
+
33
+ O forge-cli executa a fase 1 por padrão (comportamento histórico). A fase 2 só
34
+ roda quando o usuário passa `--profile`, `--scope` ou `--components`, e sempre
35
+ com `--dry-run`, a menos que `--yes` seja informado.
36
+
37
+ ## Matriz
38
+
39
+ | Capacidade | the-forge | spark-forge-aws | spark-forge-azure | api-forge | platform-forge | forge-doctor-api | forge-doctor-data | forge-portal |
40
+ | ------------------------------- | ------------------------ | ------------------------------- | -------------------------- | -------------------------- | ----------------------- | ---------------------------------------------------- | --------------------------- | ------------ |
41
+ | Clone Git | sim | sim | sim | sim | sim | sim | sim | sim |
42
+ | Bootstrap Windows | `setup.ps1` | `setup.ps1` | `setup.ps1` | `setup.ps1`, `install.ps1` | `setup.ps1` | `setup.ps1` | `setup.ps1` | — (npm) |
43
+ | Bootstrap Linux/macOS | `setup.sh` | `setup.sh` | `setup.sh` | `setup.sh`, `install.sh` | `setup.sh` | `setup.sh` | `setup.sh` | — (npm) |
44
+ | Instalador nativo (CLI) | `theforge install apply` | `sparkforge-aws install` | `sparkforge-azure install` | `apiforge install` | `platformforge install` | `scripts/forge_install.py install` (script, não CLI) | `forge-doctor-data install` | não |
45
+ | `--profile` | sim | sim | sim | sim | sim | sim (script) | sim | não |
46
+ | `--scope` | sim | sim | sim | sim | sim | sim (script) | sim | não |
47
+ | `--components` | sim | sim | sim | sim | sim | sim (script) | sim | não |
48
+ | Skills / agents / MCP | via instalador nativo | via instalador nativo | via instalador nativo | via instalador nativo | via instalador nativo | via `theforge install auto` | via instalador nativo | não |
49
+ | Perfis minimal/recommended/full | sim | sim | sim | sim | sim | **não verificado** | sim | não |
50
+ | Escopo workspace/user | sim | sim | sim | sim | sim | **não verificado** | sim | não |
51
+ | Doctor | `theforge doctor` | `sparkforge-aws install doctor` | **não verificado** | `apiforge doctor` | `platformforge doctor` | **não verificado** | **não verificado** | não |
52
+ | Atualização nativa | **não verificado** | **não verificado** | **não verificado** | `--upgrade` (bootstrap) | **não verificado** | **não verificado** | **não verificado** | `npm` |
53
+ | Desinstalação nativa | **não verificado** | **não verificado** | **não verificado** | **não verificado** | **não verificado** | **não verificado** | **não verificado** | não |
54
+
55
+ ## Operações nativas de ciclo de vida (confirmadas no código)
56
+
57
+ Segunda inspeção (leitura do parser de cada instalador). Todas aceitam
58
+ `--dry-run`; **nenhuma** das operações abaixo aceita `--yes` (aplicam quando
59
+ `--dry-run` está ausente). O forge-cli só as aciona com `--native`.
60
+
61
+ | Forja | update | uninstall |
62
+ | ----------------- | ---------------------------------- | ------------------------------------- |
63
+ | the-forge | `theforge install update` | `theforge install uninstall` |
64
+ | spark-forge-aws | `sparkforge-aws update` | `sparkforge-aws uninstall` |
65
+ | spark-forge-azure | `sparkforge-azure install update` | `sparkforge-azure install uninstall` |
66
+ | api-forge | `apiforge install update` | `apiforge install uninstall` |
67
+ | platform-forge | `platformforge upgrade` | `platformforge uninstall` |
68
+ | forge-doctor-data | `forge-doctor-data install update` | `forge-doctor-data install uninstall` |
69
+ | forge-doctor-api | não verificado | não verificado |
70
+ | forge-portal | — | — |
71
+
72
+ Regras do forge-cli: sem `--yes`, `update --native` roda a operação com
73
+ `--dry-run`; `uninstall --native --yes` executa a desinstalação nativa
74
+ **antes** de remover o clone e preserva o clone se ela falhar.
75
+
76
+ ## Flags adicionais do instalador nativo
77
+
78
+ | Forja | `--host` | `--gateway-profile` |
79
+ | ----------------- | -------------- | ------------------- |
80
+ | the-forge | sim | não verificado |
81
+ | spark-forge-aws | sim | sim |
82
+ | spark-forge-azure | sim | sim |
83
+ | api-forge | sim | sim |
84
+ | platform-forge | não verificado | não verificado |
85
+ | forge-doctor-data | não verificado | sim |
86
+
87
+ `forge-doctor-api` passou a usar o script documentado
88
+ `python scripts/forge_install.py install` (interpretador resolvido entre
89
+ `python3`, `python` e `py -3`).
90
+
91
+ Notas:
92
+
93
+ - A presença de `--scope`/`--profile`/`--components` foi confirmada no código
94
+ do parser de cada instalador (`install/service.py`, `cmd_install.py`,
95
+ `cli_install.py`, `install/cli.py`, `portable_cli.py`, `install_cmd.py`,
96
+ `scripts/forge_install.py`). Os valores aceitos vieram de `choices=` no
97
+ código.
98
+ - `forge-doctor-api` não expõe `install` como subcomando da CLI instalada na
99
+ documentação inspecionada; o fluxo documentado é `python scripts/forge_install.py
100
+ install` ou `theforge install auto --scope workspace`. Por isso o catálogo
101
+ **não** declara instalador nativo para ela (o forge-cli não simula suporte).
102
+ - `forge-portal` é Angular/Node: sem `setup.*`; o forge-cli usa `npm ci`/`npm
103
+ install` conforme a presença de `package-lock.json`.
104
+ - Atualização e desinstalação nativas não foram confirmadas; o forge-cli
105
+ atualiza o checkout Git (`update`) e remove clones limpos com backup
106
+ (`uninstall`), sem executar desinstaladores de terceiros.
107
+ - Cada repositório já possui `forge.json` (id, CLI, comando MCP). Pode ser
108
+ consumido opcionalmente no futuro, nunca como requisito.
@@ -0,0 +1,85 @@
1
+ # Solução de problemas
2
+
3
+ Falhas comuns do forge-cli e como resolver cada uma.
4
+
5
+ ## O preflight falha
6
+
7
+ O preflight roda antes de qualquer prompt e encerra com código `1`
8
+ quando algo falta:
9
+
10
+ | Falha | Causa | Correção |
11
+ | ----------------------------- | ----------------------------------- | ------------------------------------------------------ |
12
+ | `git` indisponível | Git não instalado ou fora do `PATH` | Instale o Git e abra um terminal novo |
13
+ | `Node.js >= 20` falha | Versão antiga | Atualize via [nodejs.org](https://nodejs.org) ou `nvm` |
14
+ | `powershell.exe` indisponível | Somente Windows; fora do `PATH` | Reinstale o PowerShell ou ajuste o `PATH` |
15
+
16
+ ## Falha no clone/pull (`[ERRO]`)
17
+
18
+ - **Autenticação**: os repositórios são privados. Confirme que suas
19
+ credenciais do Git funcionam — teste `git clone` manualmente em um
20
+ repositório da organização.
21
+ - **Rede/VPN**: verifique acesso a `github.com`.
22
+ - **Pull com alterações locais**: se a pasta já existe e tem
23
+ modificações, o `git pull` pode falhar. Resolva dentro da pasta do
24
+ repositório e rode o CLI de novo — ele retoma normalmente.
25
+
26
+ ## Falha ao provisionar `.env`
27
+
28
+ - **Permissão de escrita**: o diretório de destino precisa permitir
29
+ escrita. No Windows, evite pastas protegidas (por exemplo,
30
+ `C:\Program Files`).
31
+ - O erro no `.env` **pula o script de instalação** daquele
32
+ repositório de propósito: corrija a causa e rode de novo.
33
+
34
+ ## O script de instalação falha
35
+
36
+ - **Windows**: o CLI executa
37
+ `powershell.exe -NoProfile -ExecutionPolicy Bypass -File install.ps1`.
38
+ Se a política de execução estiver restrita demais ou o PowerShell for
39
+ o Core (`pwsh`), ajuste o script ou o ambiente.
40
+ - **Linux/macOS**: o CLI executa `chmod +x install.sh && ./install.sh`.
41
+ Confirme que o script é válido para o seu shell.
42
+ - **Sem script para o SO**: o repositório sai como `[AVISO]`, não
43
+ `[ERRO]` — isso é esperado quando o repo não publica script para a
44
+ sua plataforma.
45
+
46
+ ## Os scripts não rodaram (aviso de sync ou de repositório customizado)
47
+
48
+ - `Scripts não executados após falha de sincronização`: o pull falhou, o
49
+ branch divergiu ou o remote difere do catálogo. Resolva o repositório ou
50
+ reexecute com `--run-after-sync-failure`.
51
+ - `Repositório customizado: scripts não executados`: repositórios vindos de
52
+ `forge-cli.repos.json` exigem `--trust-custom`.
53
+ - `Working tree com alterações locais` ao usar `--ref`/`--version`: faça
54
+ commit ou stash antes de trocar de revisão.
55
+
56
+ ## O spinner trava ou a saída quebra
57
+
58
+ - Use um terminal moderno (Windows Terminal, VS Code, ou similar). O
59
+ Prompt de Comando legado pode não renderizar cores/Unicode.
60
+ - Scripts de instalação interativos (que pedem input) podem travar —
61
+ prefira scripts não interativos nos repositórios.
62
+
63
+ ## `Ctrl+C` durante a execução
64
+
65
+ - Nos prompts: `Ctrl+C` cancela de forma limpa.
66
+ - Durante clone/script: `SIGINT` encerra com código `130`. O `execa`
67
+ encerra o subprocesso filho junto; uma pasta parcialmente clonada
68
+ pode sobrar — o próximo run faz `git pull` se o `.git` existir, ou
69
+ `git clone` falha se a pasta existe sem `.git` (apague a pasta
70
+ parcial nesse caso).
71
+
72
+ ## `npm install` avisa sobre esbuild
73
+
74
+ Em ambientes com `allowScripts` restritivo, o postinstall do esbuild é
75
+ bloqueado — **o build continua funcionando**, porque os binários de
76
+ plataforma vêm como dependências opcionais. Se o `tsup` falhar com
77
+ erro de binário esbuild, rode
78
+ `npm install-scripts approve esbuild` e reinstale.
79
+
80
+ ## Dependências e versões
81
+
82
+ - `execa` é fixado em `^9` por decisão de spec — não atualize sem uma
83
+ spec nova.
84
+ - `vitest` é `^5` para evitar vulnerabilidades do `tinypool` (ver
85
+ `npm audit`).
package/package.json CHANGED
@@ -1,6 +1,73 @@
1
1
  {
2
2
  "name": "theforge-cli",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "description": "CLI interativa para clonar e configurar o ecossistema Forge",
5
+ "type": "module",
6
+ "bin": {
7
+ "forge-cli": "dist/index.js"
8
+ },
9
+ "engines": {
10
+ "node": ">=20"
11
+ },
12
+ "files": [
13
+ "dist",
14
+ "README.md",
15
+ "CHANGELOG.md",
16
+ "docs/*.md",
17
+ "LICENSE"
18
+ ],
19
+ "scripts": {
20
+ "dev": "tsx src/index.ts",
21
+ "build": "tsup",
22
+ "start": "node dist/index.js",
23
+ "test": "vitest run",
24
+ "typecheck": "tsc --noEmit",
25
+ "format": "prettier --write .",
26
+ "format:check": "prettier --check .",
27
+ "lint": "eslint .",
28
+ "coverage": "vitest run --coverage",
29
+ "prepublishOnly": "npm run typecheck && npm test && npm run build",
30
+ "pack": "npm pack --dry-run"
31
+ },
32
+ "dependencies": {
33
+ "@clack/prompts": "^1.8.1",
34
+ "execa": "^9.0.0",
35
+ "figlet": "^1.9.0",
36
+ "picocolors": "^1.1.0"
37
+ },
38
+ "devDependencies": {
39
+ "@eslint/js": "^10.0.1",
40
+ "@types/node": "^24.0.0",
41
+ "@vitest/coverage-v8": "^5.0.3",
42
+ "eslint": "^10.12.0",
43
+ "prettier": "^3.9.9",
44
+ "tsup": "^8.0.0",
45
+ "tsx": "^4.0.0",
46
+ "typescript": "^5.6.0",
47
+ "typescript-eslint": "^8.71.1",
48
+ "vitest": "^5.0.3"
49
+ },
50
+ "repository": {
51
+ "type": "git",
52
+ "url": "git+https://github.com/EdgarSocrates98/forge-cli.git"
53
+ },
54
+ "homepage": "https://github.com/EdgarSocrates98/forge-cli#readme",
55
+ "bugs": {
56
+ "url": "https://github.com/EdgarSocrates98/forge-cli/issues"
57
+ },
58
+ "keywords": [
59
+ "forge",
60
+ "cli",
61
+ "installer",
62
+ "git",
63
+ "agents",
64
+ "skills",
65
+ "mcp"
66
+ ],
67
+ "publishConfig": {
68
+ "access": "public",
69
+ "provenance": true
70
+ },
71
+ "license": "MIT",
72
+ "author": "Edgar Sócrates Caria"
73
+ }