@pathbit/agentdevkit 0.0.0-stage → 0.0.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/.pbai4devs/COMPATIBILIDADE.md +109 -0
- package/.pbai4devs/INSTRUCTIONS.md +87 -0
- package/.pbai4devs/README.md +50 -0
- package/.pbai4devs/agents/README.md +18 -0
- package/.pbai4devs/agents/revisor/AGENT.md +16 -0
- package/.pbai4devs/agents/revisor/antigravity.yaml +8 -0
- package/.pbai4devs/agents/revisor/claude.yaml +5 -0
- package/.pbai4devs/agents/revisor/cursor.yaml +5 -0
- package/.pbai4devs/agents/revisor/gemini.yaml +6 -0
- package/.pbai4devs/agents/revisor/github.yaml +5 -0
- package/.pbai4devs/agents/revisor/kimi-code.yaml +5 -0
- package/.pbai4devs/agents/revisor/mimocode.yaml +10 -0
- package/.pbai4devs/agents/revisor/opencode.yaml +7 -0
- package/.pbai4devs/agents/revisor/zcode.yaml +5 -0
- package/.pbai4devs/commands/README.md +30 -0
- package/.pbai4devs/commands/atualizar-ferramentas/COMMAND.md +17 -0
- package/.pbai4devs/commands/diagnosticar/COMMAND.md +18 -0
- package/.pbai4devs/commands/instalar-ferramentas/COMMAND.md +21 -0
- package/.pbai4devs/commands/preparar-dev/COMMAND.md +14 -0
- package/.pbai4devs/commands/proximos-passos/COMMAND.md +9 -0
- package/.pbai4devs/commands/revisar-entrega/COMMAND.md +29 -0
- package/.pbai4devs/commands/sincronizar/COMMAND.md +20 -0
- package/.pbai4devs/commands/status-roadmap/COMMAND.md +12 -0
- package/.pbai4devs/commands/testar-navegador/COMMAND.md +16 -0
- package/.pbai4devs/commands/verificar-agentes/COMMAND.md +19 -0
- package/.pbai4devs/estado/README.md +12 -0
- package/.pbai4devs/external-skills/CATALOG.json +121 -0
- package/.pbai4devs/external-skills/README.md +48 -0
- package/.pbai4devs/rules/README.md +18 -0
- package/.pbai4devs/rules/ambiente-local/RULE.md +33 -0
- package/.pbai4devs/rules/ambiente-local/cursor.yaml +4 -0
- package/.pbai4devs/rules/documentacao/RULE.md +11 -0
- package/.pbai4devs/rules/documentacao/cursor.yaml +4 -0
- package/.pbai4devs/rules/estrutura/RULE.md +33 -0
- package/.pbai4devs/rules/estrutura/cursor.yaml +4 -0
- package/.pbai4devs/rules/git/RULE.md +18 -0
- package/.pbai4devs/rules/git/cursor.yaml +4 -0
- package/.pbai4devs/rules/proximos-passos/RULE.md +14 -0
- package/.pbai4devs/rules/qualidade/RULE.md +32 -0
- package/.pbai4devs/rules/qualidade/cursor.yaml +4 -0
- package/.pbai4devs/scripts/README.md +69 -0
- package/.pbai4devs/scripts/diagnosticar-ambiente/SCRIPT.mjs +41 -0
- package/.pbai4devs/scripts/diagnosticar-ambiente/tests/TEST.mjs +30 -0
- package/.pbai4devs/scripts/executar-script/README.md +28 -0
- package/.pbai4devs/scripts/executar-script/SCRIPT.mjs +78 -0
- package/.pbai4devs/scripts/executar-script/tests/TEST.mjs +122 -0
- package/.pbai4devs/scripts/gerenciar-skills-externas/README.md +31 -0
- package/.pbai4devs/scripts/gerenciar-skills-externas/SCRIPT.mjs +182 -0
- package/.pbai4devs/scripts/gerenciar-skills-externas/tests/TEST.mjs +134 -0
- package/.pbai4devs/scripts/inspecionar-projeto/SCRIPT.mjs +190 -0
- package/.pbai4devs/scripts/inspecionar-projeto/tests/TEST.mjs +161 -0
- package/.pbai4devs/scripts/lib/README.md +9 -0
- package/.pbai4devs/scripts/lib/adapters.mjs +135 -0
- package/.pbai4devs/scripts/lib/catalog.mjs +170 -0
- package/.pbai4devs/scripts/lib/gitignore.mjs +348 -0
- package/.pbai4devs/scripts/lib/npm.mjs +17 -0
- package/.pbai4devs/scripts/lib/resource-path.mjs +20 -0
- package/.pbai4devs/scripts/lib/runtime.mjs +28 -0
- package/.pbai4devs/scripts/lib/script-config.mjs +8 -0
- package/.pbai4devs/scripts/preparar-ferramentas/BOOTSTRAP.md +34 -0
- package/.pbai4devs/scripts/preparar-ferramentas/BOOTSTRAP.mjs +189 -0
- package/.pbai4devs/scripts/preparar-ferramentas/README.md +71 -0
- package/.pbai4devs/scripts/preparar-ferramentas/SCRIPT.mjs +455 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/FIXTURE.html +20 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/SMOKE_BROWSER.mjs +55 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/SMOKE_DESKTOP.mjs +61 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/SMOKE_VERCEL.mjs +192 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/TEST.mjs +552 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/bootstrap.test.mjs +94 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/fixtures-vercel/just-bash/input.txt +2 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/fixtures-vercel/just-bash-overlay/input.txt +1 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/fixtures-vercel/skills/agentdevkit-smoke/SKILL.md +8 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/fixtures-vercel/webreel/index.html +6 -0
- package/.pbai4devs/scripts/preparar-ferramentas/tests/fixtures-vercel/webreel/webreel.config.json +10 -0
- package/.pbai4devs/scripts/revisar-entrega/README.md +36 -0
- package/.pbai4devs/scripts/revisar-entrega/SCRIPT.mjs +249 -0
- package/.pbai4devs/scripts/revisar-entrega/tests/TEST.mjs +249 -0
- package/.pbai4devs/scripts/sincronizar-agentes/README.md +41 -0
- package/.pbai4devs/scripts/sincronizar-agentes/SCRIPT.mjs +473 -0
- package/.pbai4devs/scripts/sincronizar-agentes/tests/LOCAL_IGNORE.mjs +290 -0
- package/.pbai4devs/scripts/sincronizar-agentes/tests/TEST.mjs +869 -0
- package/.pbai4devs/scripts/testar-infraestrutura/SCRIPT.mjs +39 -0
- package/.pbai4devs/scripts/testar-infraestrutura/tests/TEST.mjs +29 -0
- package/.pbai4devs/scripts/testar-maturidade/README.md +54 -0
- package/.pbai4devs/scripts/testar-maturidade/SCRIPT.mjs +477 -0
- package/.pbai4devs/scripts/testar-maturidade/assets/calculator.mjs +1 -0
- package/.pbai4devs/scripts/testar-maturidade/assets/calculator.test.mjs.template +8 -0
- package/.pbai4devs/scripts/testar-maturidade/assets/http-api.test.mjs.template +28 -0
- package/.pbai4devs/scripts/testar-maturidade/assets/server.mjs +34 -0
- package/.pbai4devs/scripts/testar-maturidade/tests/TEST.mjs +305 -0
- package/.pbai4devs/scripts/testar-navegador/REFERENCE.md +49 -0
- package/.pbai4devs/scripts/testar-navegador/SCRIPT.conf +1 -0
- package/.pbai4devs/scripts/testar-navegador/SCRIPT.js +64 -0
- package/.pbai4devs/scripts/testar-navegador/tests/FAIL.js +8 -0
- package/.pbai4devs/scripts/testar-navegador/tests/SUCCESS.js +13 -0
- package/.pbai4devs/scripts/verificar-recursos/README.md +25 -0
- package/.pbai4devs/scripts/verificar-recursos/SCRIPT.mjs +209 -0
- package/.pbai4devs/scripts/verificar-recursos/tests/TEST.mjs +310 -0
- package/.pbai4devs/scripts/verificar-recursos/tests/ambiente-local.mjs +80 -0
- package/.pbai4devs/skills/README.md +24 -0
- package/.pbai4devs/skills/git/git-branch/SKILL.md +11 -0
- package/.pbai4devs/skills/git/git-commit/SKILL.md +16 -0
- package/.pbai4devs/skills/git/git-diff/SKILL.md +9 -0
- package/.pbai4devs/skills/git/git-fetch/SKILL.md +10 -0
- package/.pbai4devs/skills/git/git-log/SKILL.md +9 -0
- package/.pbai4devs/skills/git/git-merge/SKILL.md +13 -0
- package/.pbai4devs/skills/git/git-pull/SKILL.md +12 -0
- package/.pbai4devs/skills/git/git-push/SKILL.md +12 -0
- package/.pbai4devs/skills/git/git-status/SKILL.md +9 -0
- package/.pbai4devs/skills/git/git-worktree/SKILL.md +10 -0
- package/.pbai4devs/skills/produto/criar-design-doc/SKILL.md +37 -0
- package/.pbai4devs/skills/produto/criar-prd/SKILL.md +35 -0
- package/.pbai4devs/skills/produto/criar-ux-ui/SKILL.md +34 -0
- package/.pbai4devs/skills/projeto/atualizar-documentacao/SKILL.md +26 -0
- package/.pbai4devs/skills/projeto/configurar-projeto/SKILL.md +62 -0
- package/.pbai4devs/skills/projeto/criar-agente/SKILL.md +20 -0
- package/.pbai4devs/skills/projeto/criar-comando/SKILL.md +25 -0
- package/.pbai4devs/skills/projeto/criar-recurso/SKILL.md +41 -0
- package/.pbai4devs/skills/projeto/criar-regra/SKILL.md +19 -0
- package/.pbai4devs/skills/projeto/criar-skill/SKILL.md +22 -0
- package/.pbai4devs/skills/projeto/executar-script/SKILL.md +29 -0
- package/.pbai4devs/skills/projeto/preparar-dev/SKILL.md +45 -0
- package/.pbai4devs/skills/projeto/preparar-ferramentas/SKILL.md +56 -0
- package/.pbai4devs/skills/projeto/proximos-passos/SKILL.md +23 -0
- package/.pbai4devs/skills/projeto/sincronizar-agentes/SKILL.md +42 -0
- package/.pbai4devs/skills/projeto/usar-skills-externas/SKILL.md +28 -0
- package/.pbai4devs/skills/projeto/verificar-trabalho/SKILL.md +45 -0
- package/.pbai4devs/skills/specs/criar-spec/SKILL.md +33 -0
- package/.pbai4devs/skills/specs/gerenciar-roadmap/SKILL.md +26 -0
- package/.pbai4devs/skills/specs/implementar-spec/SKILL.md +48 -0
- package/.pbai4devs/templates/README.md +65 -0
- package/.pbai4devs/templates/adr/TEMPLATE.md +21 -0
- package/.pbai4devs/templates/ambiente-local/Makefile.template +48 -0
- package/.pbai4devs/templates/ambiente-local/TEMPLATE.md +48 -0
- package/.pbai4devs/templates/ambiente-local/compose.local.yml.template +16 -0
- package/.pbai4devs/templates/ambiente-local/dockerignore.template +28 -0
- package/.pbai4devs/templates/changelog/TEMPLATE.md +17 -0
- package/.pbai4devs/templates/claude/TEMPLATE.md +8 -0
- package/.pbai4devs/templates/clients/ADAPTERS.json +306 -0
- package/.pbai4devs/templates/clients/TEMPLATE.md +12 -0
- package/.pbai4devs/templates/comando/TEMPLATE.md +15 -0
- package/.pbai4devs/templates/configuracao/TEMPLATE.md +46 -0
- package/.pbai4devs/templates/configuracao-raiz/TEMPLATE.md +22 -0
- package/.pbai4devs/templates/configuracao-raiz/editorconfig.template +21 -0
- package/.pbai4devs/templates/configuracao-raiz/env.example.template +3 -0
- package/.pbai4devs/templates/configuracao-raiz/gitattributes.template +6 -0
- package/.pbai4devs/templates/contribuicao/TEMPLATE.md +23 -0
- package/.pbai4devs/templates/design/TEMPLATE.md +30 -0
- package/.pbai4devs/templates/entrypoints/AGENTS.md +19 -0
- package/.pbai4devs/templates/entrypoints/CLAUDE.md +7 -0
- package/.pbai4devs/templates/entrypoints/GEMINI.md +7 -0
- package/.pbai4devs/templates/entrypoints/TEMPLATE.md +12 -0
- package/.pbai4devs/templates/gitignore/TEMPLATE.md +42 -0
- package/.pbai4devs/templates/gitignore/agents.ignore +45 -0
- package/.pbai4devs/templates/gitignore/clients.json +20 -0
- package/.pbai4devs/templates/gitignore/local.ignore +10 -0
- package/.pbai4devs/templates/gitignore/shared.ignore +60 -0
- package/.pbai4devs/templates/instrucoes-agentes/TEMPLATE.md +25 -0
- package/.pbai4devs/templates/plano-implementacao/TEMPLATE.md +27 -0
- package/.pbai4devs/templates/prd/TEMPLATE.md +30 -0
- package/.pbai4devs/templates/readme-pasta/TEMPLATE.md +16 -0
- package/.pbai4devs/templates/readme-projeto/TEMPLATE.md +34 -0
- package/.pbai4devs/templates/release/TEMPLATE.md +23 -0
- package/.pbai4devs/templates/revisao-entrega/TEMPLATE.md +41 -0
- package/.pbai4devs/templates/roadmap/TEMPLATE.md +18 -0
- package/.pbai4devs/templates/seguranca/TEMPLATE.md +22 -0
- package/.pbai4devs/templates/spec/TEMPLATE.md +61 -0
- package/.pbai4devs/templates/tasks/TEMPLATE.md +20 -0
- package/.pbai4devs/templates/ux-ui/TEMPLATE.md +26 -0
- package/.pbai4devs/tools/README.md +87 -0
- package/.pbai4devs/tools/agent-browser/README.md +26 -0
- package/.pbai4devs/tools/agent-browser/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/agent-browser/TOOL.json +33 -0
- package/.pbai4devs/tools/agent-desktop/README.md +26 -0
- package/.pbai4devs/tools/agent-desktop/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/agent-desktop/TOOL.json +30 -0
- package/.pbai4devs/tools/just-bash/README.md +23 -0
- package/.pbai4devs/tools/just-bash/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/just-bash/TOOL.json +27 -0
- package/.pbai4devs/tools/markdownlint-cli2/README.md +18 -0
- package/.pbai4devs/tools/markdownlint-cli2/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/markdownlint-cli2/TOOL.json +28 -0
- package/.pbai4devs/tools/opensrc/README.md +25 -0
- package/.pbai4devs/tools/opensrc/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/opensrc/TOOL.json +29 -0
- package/.pbai4devs/tools/portless/README.md +21 -0
- package/.pbai4devs/tools/portless/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/portless/TOOL.json +30 -0
- package/.pbai4devs/tools/skills/README.md +24 -0
- package/.pbai4devs/tools/skills/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/skills/TOOL.json +33 -0
- package/.pbai4devs/tools/webreel/README.md +23 -0
- package/.pbai4devs/tools/webreel/SCRIPT.mjs +5 -0
- package/.pbai4devs/tools/webreel/TOOL.json +25 -0
- package/CHANGELOG.md +58 -0
- package/CONTRIBUTING.md +73 -0
- package/LICENSE +21 -0
- package/README.en.md +78 -0
- package/README.es.md +80 -0
- package/README.md +88 -2
- package/bin/README.md +8 -0
- package/bin/agentdevkit.mjs +35 -0
- package/docs/README.md +81 -0
- package/docs/guides/README.md +14 -0
- package/docs/guides/cli.md +81 -0
- package/docs/guides/installation.md +78 -0
- package/docs/guides/resources.md +121 -0
- package/docs/guides/tools-and-testing.md +85 -0
- package/docs/guides/troubleshooting.md +151 -0
- package/docs/guides/workflow.md +130 -0
- package/docs/maintainers/README.md +12 -0
- package/docs/maintainers/community.md +49 -0
- package/docs/maintainers/development.md +54 -0
- package/docs/maintainers/maintenance.md +104 -0
- package/docs/maintainers/packages.md +76 -0
- package/docs/product/README.md +12 -0
- package/docs/product/design.md +94 -0
- package/docs/product/prd.md +64 -0
- package/docs/product/roadmap.md +36 -0
- package/docs/product/ux-ui.md +42 -0
- package/docs/specs/README.md +20 -0
- package/docs/specs/github-packages/SPEC.md +45 -0
- package/docs/specs/v0.0.1/README.md +10 -0
- package/docs/specs/v0.0.1/SPEC.md +57 -0
- package/docs/specs/v0.0.2/README.md +10 -0
- package/docs/specs/v0.0.2/SPEC.md +67 -0
- package/docs/specs/v0.0.3/README.md +10 -0
- package/docs/specs/v0.0.3/SPEC.md +64 -0
- package/docs/specs/v0.0.4/README.md +10 -0
- package/docs/specs/v0.0.4/SPEC.md +53 -0
- package/docs/specs/v0.0.5/README.md +9 -0
- package/docs/specs/v0.0.5/SPEC.md +42 -0
- package/package.json +52 -4
- package/src/README.md +16 -0
- package/src/adapters/index.mjs +1 -0
- package/src/cli.mjs +162 -0
- package/src/config.mjs +14 -0
- package/src/i18n.mjs +42 -0
- package/src/install.mjs +367 -0
- package/src/next.mjs +79 -0
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Diagnóstico, conflitos, backups e recuperação do AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Solução de problemas
|
|
6
|
+
|
|
7
|
+
Comece pelo erro completo e pelo diretório usado. Nos exemplos, `agentdevkit`
|
|
8
|
+
representa o executável obtido por npx, conforme a [referência da CLI][cli].
|
|
9
|
+
O comando completo está na [instalação](installation.md).
|
|
10
|
+
|
|
11
|
+
## Diagnóstico rápido
|
|
12
|
+
|
|
13
|
+
```console
|
|
14
|
+
agentdevkit --version
|
|
15
|
+
agentdevkit doctor --target "./meu projeto" --json
|
|
16
|
+
agentdevkit sync --check --target "./meu projeto" --json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
`doctor` verifica a instalação do kit. Para as ferramentas, use
|
|
20
|
+
`agentdevkit tools check all`; para o aplicativo, use os testes do projeto.
|
|
21
|
+
Antes de compartilhar uma saída, remova dados privados e caminhos pessoais.
|
|
22
|
+
|
|
23
|
+
Se faltarem recursos, confira a seleção com `agentdevkit agents`.
|
|
24
|
+
Para incluir um cliente, use `agentdevkit agents codex,claude` com a lista
|
|
25
|
+
completa, ou `agentdevkit agents all`. Reabra a sessão do cliente quando ele
|
|
26
|
+
exigir recarregar as skills. Pastas compartilhadas podem atender mais de um
|
|
27
|
+
agente; arquivos próprios também podem manter uma pasta após a desmarcação.
|
|
28
|
+
|
|
29
|
+
| Sintoma ou código | Próxima ação |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| `node` ou `npx` não encontrado | Siga [sem Node/npm][runtime]. |
|
|
32
|
+
| `E401` ou `E403` no registry | Confira se usa o [npm público][packages]. |
|
|
33
|
+
| `E404` ao baixar o pacote | Confira registry, versão e permissão. |
|
|
34
|
+
| `E_ARGS` | Confira comando e aspas com `agentdevkit --help`. |
|
|
35
|
+
| `E_MISSING` | Confirme `--target`; inicialize o projeto correto. |
|
|
36
|
+
| `E_TARGET`, `E_SYMLINK` | Use a pasta real, fora dos diretórios reservados. |
|
|
37
|
+
| `E_CONFLICT` ou lista `conflicts` | Revise o plano e os arquivos afetados. |
|
|
38
|
+
| `E_STATE`, `E_BLOCK`, `E_TEMPLATE` | Restaure o arquivo; não invente hashes. |
|
|
39
|
+
| `E_CHANGED` | Um arquivo mudou durante a operação; gere outro plano. |
|
|
40
|
+
|
|
41
|
+
## Conflitos e backups
|
|
42
|
+
|
|
43
|
+
Simule antes de substituir uma alteração própria:
|
|
44
|
+
|
|
45
|
+
```console
|
|
46
|
+
agentdevkit update --target "./meu projeto" --dry-run --json
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Compare cada `conflicts` com o que deseja manter. Edite a origem em
|
|
50
|
+
`.pbai4devs/`, não os apontamentos gerados, quando estiver personalizando um
|
|
51
|
+
recurso. Use `sync` para atualizar suas derivações. `update` reaplica os
|
|
52
|
+
recursos do pacote invocado e pode conflitar com essa personalização.
|
|
53
|
+
|
|
54
|
+
Quando a substituição for intencional, repita com `--force`. Arquivos
|
|
55
|
+
existentes afetados recebem backup antes da escrita, inclusive em operações
|
|
56
|
+
normais. O campo `backup` informa uma pasta relativa ao projeto:
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
.agent-tests/agentdevkit/backups/<identificador>/
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
O layout interno repete os caminhos originais. Para recuperar:
|
|
63
|
+
|
|
64
|
+
1. Pare as edições e faça uma cópia do projeto ou um checkpoint no Git.
|
|
65
|
+
2. Compare os arquivos do backup com os atuais no editor.
|
|
66
|
+
3. Restaure somente os arquivos desejados, preservando edições posteriores.
|
|
67
|
+
4. Execute `doctor` e revise o novo plano antes de aplicar qualquer correção.
|
|
68
|
+
|
|
69
|
+
Não existe comando `undo`. Copiar o backup inteiro não remove arquivos que a
|
|
70
|
+
operação criou; um rollback completo exige conferir o plano e o diff do Git.
|
|
71
|
+
Os backups são locais e ignorados; não substituem o controle de versão.
|
|
72
|
+
|
|
73
|
+
## Estado ou apontamentos inconsistentes
|
|
74
|
+
|
|
75
|
+
`missing`, `modified` e `outdated` em `issues` indicam arquivo ausente,
|
|
76
|
+
conteúdo alterado ou derivação pendente. Use `sync --check` para inspecionar;
|
|
77
|
+
se as alterações da origem forem intencionais, execute `sync` e confira de novo.
|
|
78
|
+
|
|
79
|
+
Se `.pbai4devs/estado/agentdevkit.json` estiver inválido, recupere um backup
|
|
80
|
+
local coerente com os arquivos correspondentes. O estado pessoal não é
|
|
81
|
+
versionado. Não invente hashes nem apague o estado para ocultar conflitos;
|
|
82
|
+
peça ao agente para comparar as fontes e planejar o reparo com `init`/`sync`.
|
|
83
|
+
|
|
84
|
+
Entradas humanas permanecem separadas das geradas. Na migração de versões
|
|
85
|
+
antigas, o kit retira somente seu bloco reconhecido e preserva o texto humano.
|
|
86
|
+
Não altere os marcadores dos blocos que ainda serão migrados.
|
|
87
|
+
Não transforme diretórios de agentes ou o hub em links simbólicos.
|
|
88
|
+
Destinos dentro de `.git`, `node_modules` ou `.pbai4devs` são recusados,
|
|
89
|
+
inclusive com variações de maiúsculas/minúsculas.
|
|
90
|
+
|
|
91
|
+
Na CLI, `sync --force` substitui conflitos identificados, com backup, e
|
|
92
|
+
preserva arquivos nativos próprios que não são do kit. O script compartilhado
|
|
93
|
+
`sincronizar-agentes` tem um modo `--force` mais amplo: pode limpar conteúdo
|
|
94
|
+
extra nas áreas de skills, agents, commands e rules. Prefira a CLI para manter
|
|
95
|
+
a instalação; não trate esses dois comandos como equivalentes.
|
|
96
|
+
|
|
97
|
+
## Download, plataforma ou ferramenta falhando
|
|
98
|
+
|
|
99
|
+
Se uma instalação antiga configurou `@pathbit` para o GitHub Packages,
|
|
100
|
+
atualize somente esse escopo e repita a instalação:
|
|
101
|
+
|
|
102
|
+
```console
|
|
103
|
+
npm config set @pathbit:registry https://registry.npmjs.org --location=user
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
O pacote público não exige autenticação para instalar. Publicar uma versão
|
|
107
|
+
exige acesso de mantenedor no npm; são operações diferentes.
|
|
108
|
+
|
|
109
|
+
Confira acesso ao GitHub, ao registro npm e a `nodejs.org`, conforme a etapa.
|
|
110
|
+
Mantenha a verificação de certificados e hashes; resolva proxy, rede ou
|
|
111
|
+
dependências do SO e repita. Não troque por um binário de outra arquitetura.
|
|
112
|
+
O launcher aceita Node.js 18+ e prepara Node 24+ para o núcleo. Sem Node/npm,
|
|
113
|
+
o agente precisa instalar o runtime pelo mecanismo do SO antes de usar npx.
|
|
114
|
+
|
|
115
|
+
`tools setup` reutiliza instalações saudáveis e verifica as compatíveis.
|
|
116
|
+
Não aplicável em uma seleção geral não significa “instalado”. Esse preparo
|
|
117
|
+
também não baixa browsers, concede permissões desktop ou inicia aplicativos.
|
|
118
|
+
Veja [ferramentas][tools] para requisitos adicionais da tarefa.
|
|
119
|
+
|
|
120
|
+
Um lock indica instalação em andamento ou interrompida. Aguarde a operação
|
|
121
|
+
ativa. Se o processo terminou, tente `agentdevkit tools unlock <nome>`; só um lock
|
|
122
|
+
local com PID comprovadamente morto é removido. Não apague locks ativos ou
|
|
123
|
+
indeterminados para forçar duas instalações ao mesmo tempo.
|
|
124
|
+
|
|
125
|
+
## Sessões, loops ou calculadora abrindo
|
|
126
|
+
|
|
127
|
+
O AgentDevKit não agenda sessões, abre a calculadora nem inicia loops por
|
|
128
|
+
conta própria. Uma execução explícita de ferramenta pode abrir o aplicativo
|
|
129
|
+
solicitado. Se algo continua executando, identifique a sessão, tarefa do
|
|
130
|
+
editor, extensão ou processo que o iniciou e pare-o pela interface responsável.
|
|
131
|
+
Apagar apenas os logs não interrompe um processo que continua gravando.
|
|
132
|
+
|
|
133
|
+
Pastas de clientes e saídas como `.opencode/opencode-loop`, `.playwright*`,
|
|
134
|
+
caches e relatórios
|
|
135
|
+
não devem ser versionados. Verifique com `git status` e `git check-ignore -v
|
|
136
|
+
<caminho>`. Se um arquivo já estava rastreado, acrescentar um ignore não o
|
|
137
|
+
retira automaticamente do Git; revise a remoção do índice sem apagar dados.
|
|
138
|
+
|
|
139
|
+
O `.gitignore` do hub não controla pastas irmãs. Confira a proteção local
|
|
140
|
+
gerada pelo kit, incluindo `info/exclude` nos repositórios Git. Preserve
|
|
141
|
+
configurações humanas em `.github` e `.vscode` ao migrar arquivos antigos.
|
|
142
|
+
|
|
143
|
+
Para pedir ajuda, inclua SO/arquitetura, versões de Node/npm/AgentDevKit,
|
|
144
|
+
comando executado, código de saída e trecho relevante do JSON, sem segredos.
|
|
145
|
+
Use as [issues do projeto][issues] ou volte ao [índice](../README.md).
|
|
146
|
+
|
|
147
|
+
[cli]: cli.md
|
|
148
|
+
[runtime]: installation.md#pré-requisitos
|
|
149
|
+
[tools]: ../../.pbai4devs/scripts/preparar-ferramentas/README.md
|
|
150
|
+
[issues]: https://github.com/pathbit/AgentDevKit/issues
|
|
151
|
+
[packages]: ../maintainers/packages.md#instalar-no-projeto
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Do preparo do kit à implementação e revisão de uma entrega.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Fluxo de trabalho
|
|
6
|
+
|
|
7
|
+
[Documentação](../README.md) · [Instalação](installation.md) ·
|
|
8
|
+
[Recursos](resources.md) · [Ferramentas e testes](tools-and-testing.md)
|
|
9
|
+
|
|
10
|
+
O AgentDevKit organiza o trabalho; ele não substitui decisões do projeto.
|
|
11
|
+
Instalar o kit cria sua estrutura de apoio, sem criar um produto, escolher
|
|
12
|
+
uma stack ou gerar PRD, design e specs automaticamente.
|
|
13
|
+
|
|
14
|
+
## 1. Identificar a situação
|
|
15
|
+
|
|
16
|
+
Na preparação do kit, escolha os agentes que usa: a CLI pergunta em um terminal
|
|
17
|
+
interativo ou aceita `--agents codex,claude`. Um agente de desktop deve reunir
|
|
18
|
+
essa escolha com você antes de executar a instalação; não deve deduzi-la pelo
|
|
19
|
+
nome do aplicativo ou pelas pastas existentes. Sem resposta disponível, o
|
|
20
|
+
padrão é `all`. A seleção salva continua nas atualizações e sincronizações.
|
|
21
|
+
Use `agents` para consultar ou alterar depois; veja a [referência](cli.md).
|
|
22
|
+
|
|
23
|
+
Use `doctor` para conferir o kit e `next` para consultar a próxima etapa.
|
|
24
|
+
Nos exemplos, `agentdevkit` representa a CLI; no checkout, use
|
|
25
|
+
`npm run cli -- <comando>`. A invocação por npx está na instalação.
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
agentdevkit doctor --target .
|
|
29
|
+
agentdevkit next --target .
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
O diagnóstico descreve sinais e arquivos existentes. Ele não aprova
|
|
33
|
+
documentos, não comprova comportamento e não autoriza substituir decisões.
|
|
34
|
+
|
|
35
|
+
| Situação | Comece por |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| Só está instalando os agentes | Manter modelos; não iniciar o produto. |
|
|
38
|
+
| Projeto novo, ainda sem decisões | [configurar-projeto][configurar]. |
|
|
39
|
+
| Aplicação existente que precisa rodar | [preparar-dev][preparar]. |
|
|
40
|
+
| Nova funcionalidade em projeto existente | Reutilizar documentos e planejar. |
|
|
41
|
+
|
|
42
|
+
## 2. Reunir as perguntas no início
|
|
43
|
+
|
|
44
|
+
Antes de escrever documentos ou código, leia o contexto já disponível.
|
|
45
|
+
Reúna as dúvidas que alteram objetivo, escopo, dependências ou critérios.
|
|
46
|
+
Não pergunte novamente o que o usuário já decidiu ou o projeto já registra.
|
|
47
|
+
A escolha dos clientes precede o preparo opcional de ferramentas; não aprova
|
|
48
|
+
downloads, início do produto ou mudanças na aplicação.
|
|
49
|
+
|
|
50
|
+
```text
|
|
51
|
+
Use configurar-projeto. Primeiro leia o repositório e reúna as dúvidas.
|
|
52
|
+
Neste momento quero apenas preparar os agentes; não crie produto ou aplicação.
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Quando o produto começar, combine os caminhos dos documentos no estado de
|
|
56
|
+
configuração. Não presuma que todo projeto usa as mesmas pastas de documentos.
|
|
57
|
+
O registro é `.pbai4devs/estado/configuracao/ESTADO.md`.
|
|
58
|
+
|
|
59
|
+
## 3. Definir produto e experiência
|
|
60
|
+
|
|
61
|
+
[criar-prd][prd] define problema, público, escopo, limites e sucesso esperado.
|
|
62
|
+
[criar-ux-ui][ux] define jornadas e interface. Quando UX/UI não se aplicar,
|
|
63
|
+
registre a justificativa e sua aprovação; ausência de arquivo não significa
|
|
64
|
+
aprovação. Os modelos são preenchidos com respostas reais.
|
|
65
|
+
|
|
66
|
+
Cada documento começa como rascunho. Uma alteração material exige revisar
|
|
67
|
+
sua aprovação e o impacto nos documentos dependentes.
|
|
68
|
+
|
|
69
|
+
## 4. Aprovar o desenho técnico
|
|
70
|
+
|
|
71
|
+
[criar-design-doc][design] usa o produto aprovado para definir arquitetura,
|
|
72
|
+
tecnologia, integrações, riscos e alternativas. Esta etapa registra decisões;
|
|
73
|
+
ela não deve iniciar a aplicação antes da aprovação do trabalho necessário.
|
|
74
|
+
|
|
75
|
+
[gerenciar-roadmap][roadmap] organiza incrementos, dependências e releases.
|
|
76
|
+
Não invente datas ou funcionalidades futuras para preencher o planejamento.
|
|
77
|
+
|
|
78
|
+
## 5. Criar uma spec executável
|
|
79
|
+
|
|
80
|
+
[criar-spec][spec] exige PRD/design aprovados e UX/UI aprovado ou justificado.
|
|
81
|
+
A spec delimita um incremento e vincula seus critérios, como `AC-001`, às
|
|
82
|
+
provas planejadas: método, pré-requisito, assertiva e evidência local.
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
Use criar-spec para este incremento. Reúna as dúvidas antes de escrever.
|
|
86
|
+
Vincule os documentos existentes e defina como provar cada critério de aceite.
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## 6. Aprovar o plano antes de implementar
|
|
90
|
+
|
|
91
|
+
[implementar-spec][implementar] começa em leitura e planejamento: examina a
|
|
92
|
+
spec, o código, as dependências e as dúvidas restantes. Apresenta tarefas,
|
|
93
|
+
decisões, riscos e verificação, aguardando a aprovação necessária do plano.
|
|
94
|
+
|
|
95
|
+
Depois do plano aprovado, complete a configuração técnica que faltar usando
|
|
96
|
+
as decisões já aprovadas. Só marque a configuração como concluída com prova.
|
|
97
|
+
Implemente o escopo da spec; não antecipe recursos de ciclos futuros.
|
|
98
|
+
|
|
99
|
+
## 7. Provar e revisar a entrega
|
|
100
|
+
|
|
101
|
+
Use [verificar-trabalho][verificar] para executar as provas relevantes.
|
|
102
|
+
Código e fixtures de teste são versionados; relatórios e capturas ficam em
|
|
103
|
+
`.agent-tests/<referencia>/<execucao>/`, ignorados pelo Git.
|
|
104
|
+
|
|
105
|
+
[atualizar-documentacao][documentacao] mantém os documentos afetados coerentes.
|
|
106
|
+
O [comando revisar-entrega][revisao] reúne critérios, evidências e revisão
|
|
107
|
+
independente. Seu fluxo é `prepare` → revisão → `seal` → `check`.
|
|
108
|
+
Critério sem prova, falha ou revisão pendente impede concluir a entrega.
|
|
109
|
+
|
|
110
|
+
## Em um projeto existente
|
|
111
|
+
|
|
112
|
+
Preparar o ambiente não exige recriar PRD/design/spec ou reorganizar o código.
|
|
113
|
+
Preserve dados, lockfiles, configurações e comandos reais. Uma nova mudança
|
|
114
|
+
funcional precisa de escopo próprio; um reparo não autoriza uma migração ampla.
|
|
115
|
+
Mesmo uma mudança sem spec exige critérios claros e revisão da entrega.
|
|
116
|
+
|
|
117
|
+
**[ Próximo passo ]** Consulte `next` e use a skill indicada, preservando as
|
|
118
|
+
decisões existentes. Consulte [recursos](resources.md) se faltar um fluxo.
|
|
119
|
+
|
|
120
|
+
[configurar]: ../../.pbai4devs/skills/projeto/configurar-projeto/SKILL.md
|
|
121
|
+
[preparar]: ../../.pbai4devs/skills/projeto/preparar-dev/SKILL.md
|
|
122
|
+
[prd]: ../../.pbai4devs/skills/produto/criar-prd/SKILL.md
|
|
123
|
+
[ux]: ../../.pbai4devs/skills/produto/criar-ux-ui/SKILL.md
|
|
124
|
+
[design]: ../../.pbai4devs/skills/produto/criar-design-doc/SKILL.md
|
|
125
|
+
[roadmap]: ../../.pbai4devs/skills/specs/gerenciar-roadmap/SKILL.md
|
|
126
|
+
[spec]: ../../.pbai4devs/skills/specs/criar-spec/SKILL.md
|
|
127
|
+
[implementar]: ../../.pbai4devs/skills/specs/implementar-spec/SKILL.md
|
|
128
|
+
[verificar]: ../../.pbai4devs/skills/projeto/verificar-trabalho/SKILL.md
|
|
129
|
+
[documentacao]: ../../.pbai4devs/skills/projeto/atualizar-documentacao/SKILL.md
|
|
130
|
+
[revisao]: ../../.pbai4devs/commands/revisar-entrega/COMMAND.md
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Desenvolvimento, contribuição e publicação do AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Manutenção
|
|
6
|
+
|
|
7
|
+
- [Desenvolvimento](development.md)
|
|
8
|
+
- [Manutenção e releases](maintenance.md)
|
|
9
|
+
- [Pacote npm público](packages.md)
|
|
10
|
+
- [Participação na comunidade](community.md)
|
|
11
|
+
|
|
12
|
+
[Voltar à documentação](../README.md)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Como relatar problemas e propor melhorias para o AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Participar da evolução
|
|
6
|
+
|
|
7
|
+
Use as [issues do AgentDevKit][issues] para relatar problemas e sugerir melhorias.
|
|
8
|
+
Procure relatos semelhantes antes de abrir um novo. Uma reação ou um exemplo
|
|
9
|
+
reproduzível na issue existente ajuda a reunir o contexto.
|
|
10
|
+
|
|
11
|
+
## Relatar um problema
|
|
12
|
+
|
|
13
|
+
Escolha [Relatar um problema][bug]. O formulário pede versão do kit, sistema,
|
|
14
|
+
agente/editor, comando ou ação, passos, resultado esperado e observado.
|
|
15
|
+
Logs são opcionais: inclua só o trecho necessário e remova dados privados.
|
|
16
|
+
|
|
17
|
+
Se não souber uma informação, explique isso. Um exemplo pequeno que reproduz
|
|
18
|
+
o problema costuma ser mais útil que um repositório inteiro.
|
|
19
|
+
|
|
20
|
+
## Propor uma melhoria
|
|
21
|
+
|
|
22
|
+
Escolha [Sugerir uma melhoria][feature] e descreva o problema antes da solução.
|
|
23
|
+
Informe quem se beneficia, um exemplo de uso e como reconhecer o resultado.
|
|
24
|
+
O formulário também aceita melhorias na documentação.
|
|
25
|
+
|
|
26
|
+
Issues não são executadas automaticamente por agentes. Uma proposta precisa
|
|
27
|
+
de triagem e definição de escopo antes de virar implementação ou release.
|
|
28
|
+
Não há prazo de atendimento prometido.
|
|
29
|
+
|
|
30
|
+
## Acompanhar e contribuir
|
|
31
|
+
|
|
32
|
+
Os labels `bug`, `enhancement` e `documentation` ajudam a classificar o assunto.
|
|
33
|
+
Mantenedores podem pedir informações, reunir duplicatas e vincular a mudança
|
|
34
|
+
a um PR. Consulte o [roadmap](../product/roadmap.md) para o escopo registrado.
|
|
35
|
+
|
|
36
|
+
Para contribuir com código ou documentos, siga [Contribuir][contrib]. O modelo
|
|
37
|
+
de PR pede problema, mudança e verificação. Após a revisão, as mudanças passam
|
|
38
|
+
pelo CI; a publicação segue o [fluxo de releases](maintenance.md).
|
|
39
|
+
|
|
40
|
+
Issues e anexos de um repositório público são públicos. Não envie tokens,
|
|
41
|
+
senhas, dados pessoais ou acesso a serviços. Resultados locais de testes
|
|
42
|
+
continuam fora do Git, conforme o [guia de ferramentas](../guides/tools-and-testing.md).
|
|
43
|
+
|
|
44
|
+
[Wiki](../README.md) · [Solução de problemas](../guides/troubleshooting.md)
|
|
45
|
+
|
|
46
|
+
[issues]: https://github.com/pathbit/AgentDevKit/issues
|
|
47
|
+
[bug]: https://github.com/pathbit/AgentDevKit/issues/new?template=bug_report.yml
|
|
48
|
+
[feature]: https://github.com/pathbit/AgentDevKit/issues/new?template=feature_request.yml
|
|
49
|
+
[contrib]: ../../CONTRIBUTING.md
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Guia rápido para desenvolver e validar o AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Desenvolver o AgentDevKit
|
|
6
|
+
|
|
7
|
+
Comece com Git, Node.js 24+ e npm. Na raiz do checkout:
|
|
8
|
+
|
|
9
|
+
```console
|
|
10
|
+
npm ci --ignore-scripts
|
|
11
|
+
npm run check
|
|
12
|
+
npm test
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Onde trabalhar
|
|
16
|
+
|
|
17
|
+
| Pasta | Conteúdo |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| [`src/`](../../src/README.md) | Código da CLI e do instalador. |
|
|
20
|
+
| [`bin/`](../../bin/README.md) | Executável do pacote. |
|
|
21
|
+
| [`tests/`][tests] | Testes do produto. |
|
|
22
|
+
| [`scripts/`][scripts] | Verificação, build e publicação. |
|
|
23
|
+
| [`examples/`][examples] | Exemplos para estudar o resultado. |
|
|
24
|
+
| [`.pbai4devs/`](../../.pbai4devs/README.md) | Recursos compartilhados dos agentes. |
|
|
25
|
+
| [`docs/`](../README.md) | Guias, decisões e especificações. |
|
|
26
|
+
|
|
27
|
+
## Escolha a próxima ação
|
|
28
|
+
|
|
29
|
+
| Objetivo | Comando |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| Conhecer os comandos da CLI local | `npm run cli -- --help` |
|
|
32
|
+
| Gerar exemplos com `.claude`, `.codex` e outros | `npm run examples` |
|
|
33
|
+
| Executar os oito cenários de exemplo | `npm run test:examples` |
|
|
34
|
+
| Conferir recursos e documentação | `npm run check` |
|
|
35
|
+
| Testar o produto | `npm test` |
|
|
36
|
+
| Verificar tudo e o pacote real | `npm run verify` |
|
|
37
|
+
| Gerar somente o tarball | `npm run build` |
|
|
38
|
+
|
|
39
|
+
`generate` é um alias para gerar os exemplos. `agents:sync` sincroniza uma
|
|
40
|
+
configuração local de agentes do próprio checkout, quando adotada de forma
|
|
41
|
+
explícita. O projeto não precisa de todas as pastas de clientes na raiz.
|
|
42
|
+
|
|
43
|
+
Edite fontes e templates, não os arquivos gerados. Testes e fixtures entram
|
|
44
|
+
no Git; relatórios, caches e `examples/generated/` ficam locais. Antes de
|
|
45
|
+
enviar uma alteração, siga [contribuição](../../CONTRIBUTING.md) e a
|
|
46
|
+
[revisão de entrega][review]. A [publicação](maintenance.md) reaproveita o
|
|
47
|
+
artefato aprovado pelo CI.
|
|
48
|
+
|
|
49
|
+
[Wiki](../README.md) · [Exemplos][examples]
|
|
50
|
+
|
|
51
|
+
[review]: ../../.pbai4devs/commands/revisar-entrega/COMMAND.md
|
|
52
|
+
[tests]: https://github.com/pathbit/AgentDevKit/tree/master/tests
|
|
53
|
+
[scripts]: https://github.com/pathbit/AgentDevKit/tree/master/scripts
|
|
54
|
+
[examples]: https://github.com/pathbit/AgentDevKit/tree/master/examples
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Verificação, pacotes e releases do AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Manutenção e releases
|
|
6
|
+
|
|
7
|
+
Para atualizar o kit em um projeto, use [instalação](../guides/installation.md).
|
|
8
|
+
Este guia explica como manter e publicar o gerador.
|
|
9
|
+
|
|
10
|
+
## Manter fontes e guias
|
|
11
|
+
|
|
12
|
+
Edite `src/` para o código, `tests/` para os testes e `.pbai4devs/` para os
|
|
13
|
+
recursos compartilhados. Documente objetivo, pré-requisito, exemplo e resultado
|
|
14
|
+
esperado. Use links para os detalhes e evite repetir a mesma regra.
|
|
15
|
+
|
|
16
|
+
Ao mudar layouts, revise templates, compatibilidade e testes. Ao mudar comandos,
|
|
17
|
+
revise ajuda, idiomas e exemplos. Markdown começa com frontmatter e H1.
|
|
18
|
+
Resultados e capturas de verificação permanecem ignorados.
|
|
19
|
+
|
|
20
|
+
## Verificar sem desperdiçar CI
|
|
21
|
+
|
|
22
|
+
O CI tem quatro perfis:
|
|
23
|
+
|
|
24
|
+
| Perfil | Responsabilidade |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| Linux / Node 24 | Fontes, produto, infraestrutura, lint e pacote real. |
|
|
27
|
+
| Windows / Node 24 | Portabilidade da CLI, arquivos e runtime. |
|
|
28
|
+
| macOS / Node 24 | Portabilidade da CLI, arquivos e runtime. |
|
|
29
|
+
| Linux / Node 26 | Smoke de compatibilidade. |
|
|
30
|
+
|
|
31
|
+
A distribuição real é testada uma vez no perfil completo. Os outros perfis
|
|
32
|
+
validam seus riscos específicos. Execuções antigas da mesma referência podem
|
|
33
|
+
ser canceladas quando substituídas, sem cancelar uma publicação em andamento.
|
|
34
|
+
|
|
35
|
+
`npm run verify` executa o perfil completo. `ci:portable` e `ci:smoke`
|
|
36
|
+
executam os demais perfis localmente. `npm run test:examples` verifica os
|
|
37
|
+
cenários em `examples/generated/` quando a mudança afeta a geração.
|
|
38
|
+
A [contribuição](../../CONTRIBUTING.md) explica os checks durante o
|
|
39
|
+
desenvolvimento.
|
|
40
|
+
|
|
41
|
+
## Gerar um pacote
|
|
42
|
+
|
|
43
|
+
O [CI][ci] roda em pushes e PRs; também pode ser iniciado em **Run workflow**.
|
|
44
|
+
O perfil completo produz `agentdevkit-<versão>.tgz`, `SHA256SUMS`, notas e
|
|
45
|
+
manifesto. O artifact inclui commit, execução e checksum para identificar
|
|
46
|
+
exatamente o que foi testado. Downloads do Actions exigem login e expiram.
|
|
47
|
+
A instalação usa o pacote nomeado no [npm público](packages.md);
|
|
48
|
+
as releases preservam artefatos e checksums para auditoria.
|
|
49
|
+
|
|
50
|
+
Para investigar localmente:
|
|
51
|
+
|
|
52
|
+
```console
|
|
53
|
+
npm run build
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
O resultado fica em `.agent-tests/release/<versão>/`. Esse comando não publica
|
|
57
|
+
nada. Nunca versione o tarball ou seus relatórios.
|
|
58
|
+
`pack:release` permanece disponível com o mesmo comportamento.
|
|
59
|
+
|
|
60
|
+
## Publicar uma versão
|
|
61
|
+
|
|
62
|
+
1. Atualize versão e lockfile, changelog, exemplos e escopo da entrega.
|
|
63
|
+
2. Conclua testes, documentação e revisão independente.
|
|
64
|
+
3. Envie o commit à branch principal e aguarde o CI aprovado.
|
|
65
|
+
4. Crie e envie a tag `v<versão>` para esse mesmo commit.
|
|
66
|
+
|
|
67
|
+
O [workflow de release][release] localiza o CI aprovado de um push na branch
|
|
68
|
+
principal, confere o commit e baixa seu artifact por ID. Verifica procedência,
|
|
69
|
+
versão e checksum antes de publicar. Não repete a suíte nem reempacota.
|
|
70
|
+
Também envia o pacote ao [npm público](packages.md), confere sua
|
|
71
|
+
integridade no registro e testa versão, instalação, diagnóstico e sincronização
|
|
72
|
+
com a CLI instalada por ele.
|
|
73
|
+
|
|
74
|
+
Se o artifact expirou, reexecute o CI original do push e depois a release.
|
|
75
|
+
Uma execução manual de CI serve para diagnóstico, mas não substitui essa
|
|
76
|
+
procedência. Uma release existente não é sobrescrita.
|
|
77
|
+
|
|
78
|
+
Se o upload falhar após a criação do rascunho, ele permanece privado. Confira
|
|
79
|
+
o rascunho antes de tentar novamente: o publicador não substitui uma release
|
|
80
|
+
existente, mesmo em rascunho. Remova somente o rascunho incompleto dessa
|
|
81
|
+
tentativa após conferir a origem; nunca apague uma release publicada para
|
|
82
|
+
repetir o fluxo.
|
|
83
|
+
|
|
84
|
+
Para reiniciar uma publicação que falhou, use **Re-run failed jobs** ou
|
|
85
|
+
`gh workflow run release.yml --ref vX.Y.Z` com a tag real. A publicação prioriza
|
|
86
|
+
o secret `NPMJS_TOKEN` do repositório; sem ele, usa OIDC, conforme
|
|
87
|
+
[publicação](packages.md).
|
|
88
|
+
|
|
89
|
+
Se a release já existe e falta somente o pacote no registro, use o modo
|
|
90
|
+
`package_only` descrito em [pacote npm](packages.md#publicar-pelo-actions).
|
|
91
|
+
Ele não tenta recriar a release existente.
|
|
92
|
+
|
|
93
|
+
## Conferir a entrega pública
|
|
94
|
+
|
|
95
|
+
Confira a versão na [página do pacote][package] e instale pelo nome em um
|
|
96
|
+
projeto descartável, seguindo [pacote npm](packages.md). Teste seleção,
|
|
97
|
+
`doctor` e `sync --check`. Compare a integridade do registro com o artefato
|
|
98
|
+
aprovado; uma aprovação de CI não substitui a instalação real pelo registro.
|
|
99
|
+
|
|
100
|
+
[Wiki](../README.md) · [Comunidade](community.md)
|
|
101
|
+
|
|
102
|
+
[ci]: https://github.com/pathbit/AgentDevKit/actions/workflows/ci.yml
|
|
103
|
+
[release]: https://github.com/pathbit/AgentDevKit/actions/workflows/release.yml
|
|
104
|
+
[package]: https://www.npmjs.com/package/@pathbit/agentdevkit
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Instalação e publicação do pacote npm público do AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Pacote npm público
|
|
6
|
+
|
|
7
|
+
O AgentDevKit é um único pacote: [`@pathbit/agentdevkit`][package]. Ele contém
|
|
8
|
+
a CLI e os recursos compartilhados; a instalação prepara os apontamentos dos
|
|
9
|
+
agentes escolhidos no projeto.
|
|
10
|
+
|
|
11
|
+
## Instalar no projeto
|
|
12
|
+
|
|
13
|
+
Com Node.js 18+ e npm, execute na pasta do projeto. Não é necessário login:
|
|
14
|
+
|
|
15
|
+
```console
|
|
16
|
+
npx @pathbit/agentdevkit init
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Para fixar a versão, use `npx @pathbit/agentdevkit@0.0.5 init`.
|
|
20
|
+
|
|
21
|
+
Acrescente `--agents codex,claude` para selecionar clientes, `--dry-run` para
|
|
22
|
+
simular ou use `update`, `doctor` e `sync --check` no lugar de `init`.
|
|
23
|
+
Não é necessário instalar globalmente nem adicionar o kit às dependências
|
|
24
|
+
da aplicação. Para conferir as versões:
|
|
25
|
+
|
|
26
|
+
```console
|
|
27
|
+
npm view @pathbit/agentdevkit versions --json
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Se existir um mapeamento antigo para o GitHub Packages, siga a
|
|
31
|
+
[correção de registry][fix].
|
|
32
|
+
|
|
33
|
+
## Publicar pelo Actions
|
|
34
|
+
|
|
35
|
+
A publicação usa o mesmo TGZ aprovado pelo CI, com acesso público. O workflow
|
|
36
|
+
confere versão, origem e integridade; uma versão existente só é aceita quando
|
|
37
|
+
contém os mesmos bytes. Não reempacote nem substitua uma versão publicada.
|
|
38
|
+
|
|
39
|
+
O workflow prioriza o secret do repositório `NPMJS_TOKEN`, recebido pela
|
|
40
|
+
variável interna `NPM_TOKEN` somente na publicação. O token precisa permitir
|
|
41
|
+
publicar no escopo `@pathbit`; credenciais nunca entram nos arquivos
|
|
42
|
+
versionados.
|
|
43
|
+
|
|
44
|
+
Sem esse secret, o workflow usa OIDC. Configure o **Trusted Publisher** do npm:
|
|
45
|
+
|
|
46
|
+
| Campo | Valor |
|
|
47
|
+
| --- | --- |
|
|
48
|
+
| Organization or user | `pathbit` |
|
|
49
|
+
| Repository | `AgentDevKit` |
|
|
50
|
+
| Workflow filename | `release.yml` |
|
|
51
|
+
| Allowed action | Publicação direta com `npm publish` |
|
|
52
|
+
|
|
53
|
+
O fallback recebe `id-token: write`. O npm exige CLI 11.5.1+ e Node 22.14+;
|
|
54
|
+
o projeto usa Node 24. Configure a relação de confiança depois que o pacote
|
|
55
|
+
existir; a primeira publicação pode usar o secret `NPMJS_TOKEN`.
|
|
56
|
+
|
|
57
|
+
Para publicar somente o pacote de uma tag que já tem artefato aprovado:
|
|
58
|
+
|
|
59
|
+
```console
|
|
60
|
+
gh workflow run release.yml --ref master -f tag=v0.0.5 -F package_only=true
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Se o artefato expirou, reexecute o CI original da tag antes da publicação.
|
|
64
|
+
Depois do envio, o job usa um ambiente sem credenciais e cache novo para
|
|
65
|
+
executar `--version`, `init`, `doctor` e `sync --check` pelo nome e versão
|
|
66
|
+
publicados. Assim, a verificação comprova o acesso de um usuário comum.
|
|
67
|
+
|
|
68
|
+
As versões antigas no [GitHub Packages][legacy] permanecem disponíveis;
|
|
69
|
+
o canal de instalação padrão é o npm público.
|
|
70
|
+
|
|
71
|
+
[Wiki](../README.md) · [Manutenção](maintenance.md) ·
|
|
72
|
+
[Instalação](../guides/installation.md)
|
|
73
|
+
|
|
74
|
+
[package]: https://www.npmjs.com/package/@pathbit/agentdevkit
|
|
75
|
+
[legacy]: https://github.com/pathbit/AgentDevKit/pkgs/npm/agentdevkit
|
|
76
|
+
[fix]: ../guides/troubleshooting.md#download-plataforma-ou-ferramenta-falhando
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Requisitos, experiência e decisões do produto AgentDevKit.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Produto
|
|
6
|
+
|
|
7
|
+
- [Requisitos do produto](prd.md)
|
|
8
|
+
- [Experiência da CLI](ux-ui.md)
|
|
9
|
+
- [Design técnico](design.md)
|
|
10
|
+
- [Roadmap](roadmap.md)
|
|
11
|
+
|
|
12
|
+
[Voltar à documentação](../README.md)
|