@pathbit/agentdevkit 0.0.8 → 0.0.10
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 +4 -2
- package/.pbai4devs/INSTRUCTIONS.md +4 -0
- package/.pbai4devs/commands/sincronizar/COMMAND.md +4 -3
- package/.pbai4devs/rules/documentacao/RULE.md +4 -0
- package/.pbai4devs/rules/qualidade/RULE.md +4 -2
- package/.pbai4devs/scripts/README.md +3 -3
- package/.pbai4devs/scripts/inspecionar-projeto/README.md +31 -0
- package/.pbai4devs/scripts/inspecionar-projeto/SCRIPT.mjs +142 -1
- package/.pbai4devs/scripts/inspecionar-projeto/tests/TEST.mjs +168 -1
- package/.pbai4devs/scripts/lib/native-paths.mjs +35 -0
- package/.pbai4devs/scripts/sincronizar-agentes/README.md +3 -0
- package/.pbai4devs/scripts/sincronizar-agentes/SCRIPT.mjs +73 -29
- package/.pbai4devs/scripts/sincronizar-agentes/tests/COEXISTENCE.mjs +190 -0
- package/.pbai4devs/scripts/sincronizar-agentes/tests/HUMAN_OWNERSHIP.mjs +8 -2
- package/.pbai4devs/scripts/sincronizar-agentes/tests/TEST.mjs +28 -28
- package/.pbai4devs/scripts/verificar-recursos/SCRIPT.mjs +56 -8
- package/.pbai4devs/scripts/verificar-recursos/tests/TEST.mjs +92 -1
- package/.pbai4devs/skills/produto/criar-design-doc/SKILL.md +2 -0
- package/.pbai4devs/skills/produto/criar-prd/SKILL.md +2 -0
- package/.pbai4devs/skills/produto/criar-ux-ui/SKILL.md +2 -0
- package/.pbai4devs/skills/projeto/atualizar-documentacao/SKILL.md +18 -4
- package/.pbai4devs/skills/projeto/configurar-projeto/SKILL.md +2 -0
- package/.pbai4devs/skills/projeto/criar-recurso/SKILL.md +1 -0
- package/.pbai4devs/skills/projeto/sincronizar-agentes/SKILL.md +3 -2
- package/.pbai4devs/skills/specs/criar-spec/SKILL.md +1 -0
- package/.pbai4devs/skills/specs/gerenciar-roadmap/SKILL.md +2 -1
- package/.pbai4devs/templates/README.md +4 -1
- package/.pbai4devs/templates/configuracao/TEMPLATE.md +6 -0
- package/CHANGELOG.md +18 -0
- package/README.en.md +18 -5
- package/README.es.md +19 -6
- package/README.md +16 -3
- package/docs/README.md +4 -2
- package/docs/guides/README.md +3 -1
- package/docs/guides/cli.md +5 -0
- package/docs/guides/documentation.md +63 -0
- package/docs/guides/installation.md +71 -14
- package/docs/guides/prerequisites.md +123 -0
- package/docs/guides/resources.md +6 -5
- package/docs/guides/tools-and-testing.md +2 -1
- package/docs/guides/troubleshooting.md +29 -13
- package/docs/guides/workflow.md +2 -0
- package/docs/maintainers/README.md +1 -1
- package/docs/maintainers/maintenance.md +8 -4
- package/docs/maintainers/packages.md +45 -13
- package/docs/product/design.md +12 -0
- package/docs/product/prd.md +4 -1
- package/docs/product/roadmap.md +4 -0
- package/docs/specs/README.md +3 -0
- package/docs/specs/dual-registry/SPEC.md +43 -0
- package/docs/specs/v0.0.10/README.md +9 -0
- package/docs/specs/v0.0.10/SPEC.md +42 -0
- package/docs/specs/v0.0.9/README.md +9 -0
- package/docs/specs/v0.0.9/SPEC.md +68 -0
- package/package.json +3 -2
- package/src/cli.mjs +3 -0
- package/src/i18n.mjs +3 -0
- package/src/install.mjs +84 -16
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Evoluir documentos existentes e criar somente o que falta.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Documentação sem perder o contexto
|
|
6
|
+
|
|
7
|
+
O pacote instala as skills e suas ferramentas. O agente usa esses recursos
|
|
8
|
+
para ler o projeto, propor complementos e editar os documentos autorizados.
|
|
9
|
+
|
|
10
|
+
## Começar pelo que existe
|
|
11
|
+
|
|
12
|
+
Depois de instalar o kit, peça ao seu agente:
|
|
13
|
+
|
|
14
|
+
```text
|
|
15
|
+
Use atualizar-documentacao. Primeiro inventarie e leia os documentos existentes.
|
|
16
|
+
Proponha complementos por arquivo, preservando conteúdo, nomes e decisões.
|
|
17
|
+
Organize por índices e links; crie apenas documentos que realmente faltam.
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
O inventário pode ser consultado na raiz do projeto:
|
|
21
|
+
|
|
22
|
+
```console
|
|
23
|
+
node .pbai4devs/scripts/inspecionar-projeto/SCRIPT.mjs
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
O campo `documentation` lista documentos encontrados, possíveis papéis e
|
|
27
|
+
limitações da busca. Os papéis são indícios: o agente ainda precisa ler e
|
|
28
|
+
confirmar o conteúdo. Um nome como `ARCHITECTURE.md` pode servir ao design;
|
|
29
|
+
não é necessário renomeá-lo nem recriá-lo em outra pasta.
|
|
30
|
+
|
|
31
|
+
## Planejar o complemento
|
|
32
|
+
|
|
33
|
+
| Situação | Ação |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| Documento já suficiente | Manter e registrar ausência de impacto. |
|
|
36
|
+
| Falta uma informação comprovada | Acrescentar à seção apropriada. |
|
|
37
|
+
| Documentos difíceis de encontrar | Criar ou completar índices e links. |
|
|
38
|
+
| Documento necessário não existe | Combinar caminho e criar só o necessário. |
|
|
39
|
+
| Decisão não encontrada ou contraditória | Perguntar antes de escrever. |
|
|
40
|
+
|
|
41
|
+
Os templates ajudam a identificar lacunas. Não substituem documentos
|
|
42
|
+
existentes. Preserve suas seções, âncoras, fatos e decisões; repetir o fluxo
|
|
43
|
+
não deve duplicar conteúdo. Não mova nem exclua arquivos para padronizar.
|
|
44
|
+
|
|
45
|
+
## Projeto novo ou existente
|
|
46
|
+
|
|
47
|
+
Em projeto existente, aproveite README, guias, ADRs e documentos de produto.
|
|
48
|
+
Preparar o ambiente ou melhorar a documentação não exige reiniciar o produto.
|
|
49
|
+
|
|
50
|
+
Em projeto novo, descubra produto e experiência antes de arquitetura e specs.
|
|
51
|
+
Enquanto o objetivo for apenas configurar agentes, mantenha os modelos sem
|
|
52
|
+
inventar PRD, tecnologia ou aprovação. Siga o [fluxo de trabalho](workflow.md).
|
|
53
|
+
|
|
54
|
+
## Conferir o resultado
|
|
55
|
+
|
|
56
|
+
Revise o diff e os links. Confirme que o conteúdo anterior foi preservado,
|
|
57
|
+
que arquivos fora do plano não mudaram e que não surgiram decisões inventadas.
|
|
58
|
+
Use `verificar-trabalho` e `revisar-entrega`; salve as provas em `.agent-tests/`.
|
|
59
|
+
|
|
60
|
+
[Wiki](../README.md) · [Skill compartilhada][skill] · [Testes][tests]
|
|
61
|
+
|
|
62
|
+
[skill]: ../../.pbai4devs/skills/projeto/atualizar-documentacao/SKILL.md
|
|
63
|
+
[tests]: ../../tests/README.md
|
|
@@ -9,23 +9,58 @@ O pacote traz o gerador e as fontes compartilhadas. A instalação prepara
|
|
|
9
9
|
|
|
10
10
|
## Pré-requisitos
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
Sem Node/npm, o agente precisa primeiro instalar o runtime pelo mecanismo do
|
|
17
|
-
sistema operacional e continuar. `npx` não funciona antes dessa instalação.
|
|
18
|
-
O [guia de preparo][bootstrap] explica as duas situações.
|
|
12
|
+
Prepare [Node.js 24+ com npm e npx](prerequisites.md) no Windows, macOS ou Linux.
|
|
13
|
+
O guia inclui instalação manual e como pedir ao agente para preparar a máquina.
|
|
14
|
+
Git é opcional para instalar o kit. Com Node 18–23 existente, o launcher pode
|
|
15
|
+
preparar Node 24 localmente usando `tar`; veja o [bootstrap][bootstrap].
|
|
19
16
|
|
|
20
17
|
## Instalar
|
|
21
18
|
|
|
22
|
-
|
|
23
|
-
|
|
19
|
+
Os dois registries oferecem o mesmo [`@pathbit/agentdevkit`](../maintainers/packages.md).
|
|
20
|
+
Escolha um deles e execute na pasta do projeto.
|
|
21
|
+
|
|
22
|
+
### npm público
|
|
23
|
+
|
|
24
|
+
É o caminho padrão e não exige conta nem login:
|
|
24
25
|
|
|
25
26
|
```console
|
|
26
27
|
npx @pathbit/agentdevkit init
|
|
27
28
|
```
|
|
28
29
|
|
|
30
|
+
Para escolher explicitamente esse registry:
|
|
31
|
+
|
|
32
|
+
```console
|
|
33
|
+
npx --registry=https://registry.npmjs.org @pathbit/agentdevkit init
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### GitHub Packages
|
|
37
|
+
|
|
38
|
+
O pacote é público, mas esse registry exige autenticação para baixar.
|
|
39
|
+
Crie um [personal access token clássico][tokens] com `read:packages`.
|
|
40
|
+
Autentique uma vez no seu computador:
|
|
41
|
+
|
|
42
|
+
```console
|
|
43
|
+
npm login --registry=https://npm.pkg.github.com --auth-type=legacy --scope=
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Informe seu usuário do GitHub e use o token no campo de senha. O npm guarda
|
|
47
|
+
a credencial no arquivo do seu usuário, vinculada ao host do GitHub.
|
|
48
|
+
`--scope=` evita criar um mapeamento permanente do escopo; nunca coloque
|
|
49
|
+
o token nos comandos compartilhados ou no repositório. Veja a
|
|
50
|
+
[autenticação oficial][github-auth].
|
|
51
|
+
|
|
52
|
+
Depois instale com npx:
|
|
53
|
+
|
|
54
|
+
```console
|
|
55
|
+
npx --registry=https://npm.pkg.github.com @pathbit/agentdevkit init
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
As opções de npx, como `--registry`, ficam **antes** do nome do pacote.
|
|
59
|
+
Um `@pathbit:registry` já configurado pode prevalecer sobre essa opção;
|
|
60
|
+
confira o [diagnóstico de registry](troubleshooting.md#download-plataforma-ou-ferramenta-falhando).
|
|
61
|
+
|
|
62
|
+
### Opções e verificação
|
|
63
|
+
|
|
29
64
|
Sem comando adicional, o pacote executa `init`. Em terminal interativo,
|
|
30
65
|
pergunta idioma e agentes. No aplicativo desktop, peça ao agente para reunir
|
|
31
66
|
as escolhas no chat e usar `--lang` e `--agents` na CLI.
|
|
@@ -34,6 +69,19 @@ Consulte [CLI](cli.md) para acrescentar seleção, destino e simulação. `--jso
|
|
|
34
69
|
`--yes`, `--dry-run` ou ausência de terminal interativo evitam perguntas.
|
|
35
70
|
Sem escolha explícita ou salva, `all` mantém todos os clientes compatíveis.
|
|
36
71
|
|
|
72
|
+
Após instalar, confirme a versão, o diagnóstico e os apontamentos:
|
|
73
|
+
|
|
74
|
+
```console
|
|
75
|
+
npx @pathbit/agentdevkit --version
|
|
76
|
+
npx @pathbit/agentdevkit doctor
|
|
77
|
+
npx @pathbit/agentdevkit sync --check
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Se escolheu GitHub Packages, use o mesmo prefixo
|
|
81
|
+
`npx --registry=https://npm.pkg.github.com` nesses comandos. Para fixar a versão,
|
|
82
|
+
use `@pathbit/agentdevkit@0.0.10` no lugar do nome sem versão, em qualquer destino.
|
|
83
|
+
O próximo passo é [preparar as ferramentas](prerequisites.md#depois-de-instalar-o-kit).
|
|
84
|
+
|
|
37
85
|
## O que fica no projeto
|
|
38
86
|
|
|
39
87
|
| Conteúdo | Tratamento |
|
|
@@ -84,9 +132,16 @@ gerenciados alterados geram conflito; use `--force` somente após revisar o
|
|
|
84
132
|
backup e o conteúdo que será substituído. Preserve os dados locais, as
|
|
85
133
|
configurações próprias e os commits do projeto.
|
|
86
134
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
135
|
+
Entradas, configurações, skills e agentes humanos permanecem intactos, mesmo
|
|
136
|
+
quando seus nomes coincidem com os do kit. Links simbólicos preexistentes nas
|
|
137
|
+
entradas ou nos clientes são preservados sem leitura ou escrita pelo link.
|
|
138
|
+
O campo `preserved` do JSON informa os caminhos que o kit deixou sob controle
|
|
139
|
+
do projeto; os apontamentos são gerados nas demais rotas disponíveis.
|
|
140
|
+
|
|
141
|
+
Essa preservação não autoriza trocar arquivos gerenciados por links. Links
|
|
142
|
+
em caminhos já pertencentes ao kit, no hub, no estado ou em ferramentas
|
|
143
|
+
continuam sujeitos à recusa de segurança. Nenhum link humano é adotado como
|
|
144
|
+
propriedade do kit, e `--force` não o substitui.
|
|
90
145
|
|
|
91
146
|
Arquivos humanos não se tornam gerenciados apenas por conterem um link.
|
|
92
147
|
As alterações de arquivos existentes preservam permissões, inclusive em backup
|
|
@@ -95,7 +150,9 @@ e restauração após falha.
|
|
|
95
150
|
O [fluxo de trabalho](workflow.md) orienta a próxima etapa do projeto.
|
|
96
151
|
Se houver erro, consulte [solução de problemas](troubleshooting.md).
|
|
97
152
|
|
|
98
|
-
[Wiki](../README.md) · [Spec v0.0.
|
|
153
|
+
[Wiki](../README.md) · [Spec v0.0.10][spec]
|
|
99
154
|
|
|
100
155
|
[bootstrap]: ../../.pbai4devs/scripts/preparar-ferramentas/BOOTSTRAP.md
|
|
101
|
-
[spec]: ../specs/v0.0.
|
|
156
|
+
[spec]: ../specs/v0.0.10/SPEC.md
|
|
157
|
+
[tokens]: https://github.com/settings/tokens
|
|
158
|
+
[github-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Instalar Node.js e npm no Windows, macOS ou Linux antes de usar o kit.
|
|
3
|
+
language: pt
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Preparar os pré-requisitos
|
|
7
|
+
|
|
8
|
+
Instale **Node.js 24+ com npm**. O npm inclui o comando `npx`; não é preciso
|
|
9
|
+
instalar Python, Bun ou o AgentDevKit globalmente. Git é opcional para instalar
|
|
10
|
+
o kit e necessário para trabalhar com o controle de versão do projeto.
|
|
11
|
+
|
|
12
|
+
## Confira antes de instalar
|
|
13
|
+
|
|
14
|
+
No terminal do computador ou do agente, execute:
|
|
15
|
+
|
|
16
|
+
```console
|
|
17
|
+
node --version
|
|
18
|
+
npm --version
|
|
19
|
+
npx --version
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Com Node 24+ e os três comandos funcionando, siga para a
|
|
23
|
+
[instalação pelo npm ou GitHub Packages](installation.md#instalar).
|
|
24
|
+
Use o mesmo ambiente em que abrirá o projeto: Windows e WSL, por exemplo,
|
|
25
|
+
têm instalações separadas.
|
|
26
|
+
|
|
27
|
+
## Windows
|
|
28
|
+
|
|
29
|
+
No PowerShell, com [WinGet][winget] disponível:
|
|
30
|
+
|
|
31
|
+
```powershell
|
|
32
|
+
winget install --id OpenJS.NodeJS.LTS --exact --source winget
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Sem WinGet, abra o [download oficial do Node.js][node], selecione uma versão
|
|
36
|
+
LTS 24 ou superior e use o instalador Windows `.msi` da sua arquitetura.
|
|
37
|
+
Mantenha npm e a inclusão no PATH habilitados. Feche e reabra o terminal;
|
|
38
|
+
no VS Code, reabra também o terminal integrado. Repita os três comandos acima.
|
|
39
|
+
|
|
40
|
+
## macOS
|
|
41
|
+
|
|
42
|
+
No [download oficial][node], selecione Node LTS 24 ou superior e o instalador
|
|
43
|
+
macOS `.pkg`. Conclua a instalação, reabra o terminal e confira as versões.
|
|
44
|
+
O instalador inclui npm e npx.
|
|
45
|
+
|
|
46
|
+
Se já usa Homebrew, pode manter esse fluxo:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
brew install node@24
|
|
50
|
+
export PATH="$(brew --prefix node@24)/bin:$PATH"
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
A segunda linha vale para o terminal atual. Para outros terminais, siga as
|
|
54
|
+
instruções de PATH exibidas pelo Homebrew; não substitua seu perfil inteiro.
|
|
55
|
+
Veja a [fórmula oficial][brew].
|
|
56
|
+
|
|
57
|
+
## Linux
|
|
58
|
+
|
|
59
|
+
Em Bash ou Zsh, use o [nvm][nvm] para instalar Node 24 no seu usuário.
|
|
60
|
+
Em Debian/Ubuntu, prepare as dependências se faltarem:
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
sudo apt-get update
|
|
64
|
+
sudo apt-get install -y curl ca-certificates tar xz-utils
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Em outra distribuição, instale os equivalentes pelo seu gerenciador de pacotes.
|
|
68
|
+
Execute o instalador oficial do nvm e depois instale o Node:
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.41.0/install.sh | bash
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Reabra o terminal para carregar o nvm; então execute:
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
nvm install 24
|
|
78
|
+
nvm use 24
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
O nvm configura o perfil do seu usuário e inclui npm/npx com o Node.
|
|
82
|
+
Em Alpine ou outra distribuição com musl, confirme o suporte da versão e
|
|
83
|
+
arquitetura no [download oficial][node]; não use um binário glibc nesse ambiente.
|
|
84
|
+
|
|
85
|
+
## Preparar com ajuda do agente
|
|
86
|
+
|
|
87
|
+
Você também pode pedir no aplicativo ou terminal do seu agente:
|
|
88
|
+
|
|
89
|
+
> Confira Node, npm e npx neste ambiente. Se faltarem, instale Node 24+ pelo
|
|
90
|
+
> mecanismo adequado ao meu sistema, preserve a configuração existente e
|
|
91
|
+
> continue até validar os três comandos. Depois me ajude a escolher npm ou
|
|
92
|
+
> GitHub Packages e os agentes que usarei neste projeto.
|
|
93
|
+
|
|
94
|
+
O agente precisa de acesso ao terminal, à rede e das permissões de instalação
|
|
95
|
+
do sistema. Sem Node/npm, o `npx` ainda não pode executar o kit. Com Node
|
|
96
|
+
18–23 existente, o launcher pode preparar Node 24 localmente; prefira atualizar
|
|
97
|
+
o ambiente para Node 24+ antes de começar.
|
|
98
|
+
|
|
99
|
+
O [bootstrap do kit][bootstrap] usa `tar` nativo quando precisa baixar um
|
|
100
|
+
runtime, verifica o checksum e não altera o PATH permanentemente.
|
|
101
|
+
|
|
102
|
+
## Depois de instalar o kit
|
|
103
|
+
|
|
104
|
+
Na pasta do projeto, prepare e verifique as ferramentas compatíveis:
|
|
105
|
+
|
|
106
|
+
```console
|
|
107
|
+
npx @pathbit/agentdevkit tools setup
|
|
108
|
+
npx @pathbit/agentdevkit tools check all
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Para usar GitHub Packages, acrescente `--registry=https://npm.pkg.github.com`
|
|
112
|
+
antes do nome do pacote, como no [guia de instalação](installation.md#github-packages).
|
|
113
|
+
`tools setup base` limita o preparo a navegador e lint. A instalação dos CLIs
|
|
114
|
+
não instala browsers, FFmpeg nem concede permissões desktop; veja os requisitos
|
|
115
|
+
da tarefa em [ferramentas e testes](tools-and-testing.md).
|
|
116
|
+
|
|
117
|
+
[Wiki](../README.md) · [Instalar o kit](installation.md)
|
|
118
|
+
|
|
119
|
+
[node]: https://nodejs.org/en/download
|
|
120
|
+
[winget]: https://learn.microsoft.com/en-us/windows/package-manager/winget/install
|
|
121
|
+
[brew]: https://formulae.brew.sh/formula/node@24
|
|
122
|
+
[nvm]: https://github.com/nvm-sh/nvm#installing-and-updating
|
|
123
|
+
[bootstrap]: ../../.pbai4devs/scripts/preparar-ferramentas/BOOTSTRAP.md
|
package/docs/guides/resources.md
CHANGED
|
@@ -84,18 +84,19 @@ node .pbai4devs/scripts/verificar-recursos/SCRIPT.mjs
|
|
|
84
84
|
O primeiro comando atualiza apontamentos e índices; `--check` só compara.
|
|
85
85
|
O manifesto instalado respeita os clientes escolhidos. Não o substitua por uma
|
|
86
86
|
lista de todos para reparar recursos; altere a seleção pela CLI se necessário.
|
|
87
|
-
Conflitos
|
|
87
|
+
Conflitos em arquivos gerenciados exigem revisão. Quando a substituição for
|
|
88
88
|
intencional, `--force` faz backup local antes de reparar caminhos gerenciados.
|
|
89
89
|
Não apague pastas inteiras para contornar um conflito.
|
|
90
90
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
Escolha a operação pelo escopo; não prometa preservação indistinta.
|
|
91
|
+
Recursos nativos humanos são preservados, inclusive com `--force` e nomes
|
|
92
|
+
iguais aos do kit. Links humanos são tratados como caminhos opacos; o gerador
|
|
93
|
+
não os atravessa. A CLI informa essas rotas em `preserved` no JSON.
|
|
95
94
|
|
|
96
95
|
Não edite ou versione `catalog.json`, `skills.json`, `rules.json` ou
|
|
97
96
|
`agents.json`: são derivados locais. Configurações nativas e documentos
|
|
98
97
|
do projeto não devem ser substituídos por cópias desses índices.
|
|
98
|
+
Em uma instalação existente, `verificar-recursos` confere o hub e as derivações
|
|
99
|
+
registradas, sem exigir frontmatter nos documentos humanos do projeto.
|
|
99
100
|
|
|
100
101
|
## O que permanece fora dos espelhos
|
|
101
102
|
|
|
@@ -11,7 +11,8 @@ nem escolhe a stack da aplicação. Consulte o [catálogo][tools].
|
|
|
11
11
|
|
|
12
12
|
O núcleo usa Node.js 24+ com npm. O launcher aceita Node 18+ e prepara o runtime
|
|
13
13
|
atual quando necessário. Sem Node, o agente precisa instalá-lo pelo mecanismo
|
|
14
|
-
do sistema operacional antes de iniciar `npx
|
|
14
|
+
do sistema operacional antes de iniciar `npx`; siga os
|
|
15
|
+
[pré-requisitos por sistema](prerequisites.md).
|
|
15
16
|
|
|
16
17
|
Para preparar somente o runtime a partir do hub:
|
|
17
18
|
|
|
@@ -29,7 +29,7 @@ agente; arquivos próprios também podem manter uma pasta após a desmarcação.
|
|
|
29
29
|
| Sintoma ou código | Próxima ação |
|
|
30
30
|
| --- | --- |
|
|
31
31
|
| `node` ou `npx` não encontrado | Siga [sem Node/npm][runtime]. |
|
|
32
|
-
| `E401` ou `E403` no registry |
|
|
32
|
+
| `E401` ou `E403` no registry | No npm, confira o destino; no GitHub, confira [token e login][github-install]. |
|
|
33
33
|
| `E404` ao baixar o pacote | Confira registry, versão e permissão. |
|
|
34
34
|
| `E_ARGS` | Confira comando e aspas com `agentdevkit --help`. |
|
|
35
35
|
| `E_MISSING` | Confirme `--target`; inicialize o projeto correto. |
|
|
@@ -84,27 +84,43 @@ peça ao agente para comparar as fontes e planejar o reparo com `init`/`sync`.
|
|
|
84
84
|
Entradas humanas permanecem separadas das geradas. Na migração de versões
|
|
85
85
|
antigas, o kit retira somente seu bloco reconhecido e preserva o texto humano.
|
|
86
86
|
Não altere os marcadores dos blocos que ainda serão migrados.
|
|
87
|
-
|
|
87
|
+
Links humanos preexistentes nas entradas e nos clientes são mantidos sem
|
|
88
|
+
atravessá-los. Consulte `preserved` no JSON para ver as rotas que não receberam
|
|
89
|
+
apontamentos. Não transforme o hub ou caminhos já gerenciados em links.
|
|
88
90
|
Destinos dentro de `.git`, `node_modules` ou `.pbai4devs` são recusados,
|
|
89
91
|
inclusive com variações de maiúsculas/minúsculas.
|
|
90
92
|
|
|
91
|
-
Na CLI
|
|
92
|
-
|
|
93
|
-
|
|
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.
|
|
93
|
+
Na CLI e no script `sincronizar-agentes`, `--force` repara conflitos gerenciados
|
|
94
|
+
com backup. Recursos nativos humanos e links preservados continuam intactos.
|
|
95
|
+
Para manter a instalação e sua seleção de clientes, prefira a CLI.
|
|
96
96
|
|
|
97
97
|
## Download, plataforma ou ferramenta falhando
|
|
98
98
|
|
|
99
|
-
|
|
100
|
-
atualize somente esse escopo e repita a instalação:
|
|
99
|
+
Confira o destino padrão e um possível mapeamento do escopo:
|
|
101
100
|
|
|
102
101
|
```console
|
|
103
|
-
npm config
|
|
102
|
+
npm config get registry
|
|
103
|
+
npm config get @pathbit:registry
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
|
|
107
|
-
|
|
106
|
+
Um valor de `@pathbit:registry` prevalece sobre `npx --registry=...`.
|
|
107
|
+
Se esse mapeamento foi criado apenas para uma instalação antiga, remova
|
|
108
|
+
**somente essa chave** do arquivo que a definiu. No arquivo do usuário:
|
|
109
|
+
|
|
110
|
+
```console
|
|
111
|
+
npm config delete @pathbit:registry --location=user
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Se a chave está no `.npmrc` do projeto ou em variáveis de ambiente, revise
|
|
115
|
+
nesse local; o comando acima não muda essas configurações. Preserve mapeamentos
|
|
116
|
+
exigidos por outras dependências e nunca apague o `.npmrc` inteiro.
|
|
117
|
+
Sem mapeamento do escopo, escolha o registry por execução no
|
|
118
|
+
[guia de instalação](installation.md#instalar).
|
|
119
|
+
|
|
120
|
+
O npm público não exige login para baixar o kit. No GitHub Packages, use
|
|
121
|
+
um token clássico com `read:packages` e o [login específico][github-install].
|
|
122
|
+
Publicar versões exige permissões adicionais; login no GitHub CLI (`gh`)
|
|
123
|
+
não configura automaticamente a autenticação do npm.
|
|
108
124
|
|
|
109
125
|
Confira acesso ao GitHub, ao registro npm e a `nodejs.org`, conforme a etapa.
|
|
110
126
|
Mantenha a verificação de certificados e hashes; resolva proxy, rede ou
|
|
@@ -148,4 +164,4 @@ Use as [issues do projeto][issues] ou volte ao [índice](../README.md).
|
|
|
148
164
|
[runtime]: installation.md#pré-requisitos
|
|
149
165
|
[tools]: ../../.pbai4devs/scripts/preparar-ferramentas/README.md
|
|
150
166
|
[issues]: https://github.com/pathbit/AgentDevKit/issues
|
|
151
|
-
[
|
|
167
|
+
[github-install]: installation.md#github-packages
|
package/docs/guides/workflow.md
CHANGED
|
@@ -41,6 +41,8 @@ documentos, não comprova comportamento e não autoriza substituir decisões.
|
|
|
41
41
|
|
|
42
42
|
## 2. Reunir as perguntas no início
|
|
43
43
|
|
|
44
|
+
Antes de criar documentos, [inventarie e leia o que existe](documentation.md).
|
|
45
|
+
Reutilize os caminhos e complemente lacunas, sem substituir pelo template.
|
|
44
46
|
Antes de escrever documentos ou código, leia o contexto já disponível.
|
|
45
47
|
Reúna as dúvidas que alteram objetivo, escopo, dependências ou critérios.
|
|
46
48
|
Não pergunte novamente o que o usuário já decidiu ou o projeto já registra.
|
|
@@ -6,7 +6,7 @@ description: Desenvolvimento, contribuição e publicação do AgentDevKit.
|
|
|
6
6
|
|
|
7
7
|
- [Desenvolvimento](development.md)
|
|
8
8
|
- [Manutenção e releases](maintenance.md)
|
|
9
|
-
- [Pacote npm
|
|
9
|
+
- [Pacote no npm e GitHub Packages](packages.md)
|
|
10
10
|
- [Participação na comunidade](community.md)
|
|
11
11
|
|
|
12
12
|
[Voltar à documentação](../README.md)
|
|
@@ -67,9 +67,9 @@ nada. Nunca versione o tarball ou seus relatórios.
|
|
|
67
67
|
O [workflow de release][release] localiza o CI aprovado de um push na branch
|
|
68
68
|
principal, confere o commit e baixa seu artifact por ID. Verifica procedência,
|
|
69
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),
|
|
71
|
-
integridade
|
|
72
|
-
|
|
70
|
+
Também envia o mesmo pacote ao [npm público e GitHub Packages](packages.md),
|
|
71
|
+
confere a integridade nos dois destinos e testa versão, instalação, diagnóstico
|
|
72
|
+
e sincronização. O consumo pelo npm é anônimo; pelo GitHub, autenticado.
|
|
73
73
|
|
|
74
74
|
Se o artifact expirou, reexecute o CI original do push e depois a release.
|
|
75
75
|
Uma execução manual de CI serve para diagnóstico, mas não substitui essa
|
|
@@ -86,10 +86,14 @@ Para reiniciar uma publicação que falhou, use **Re-run failed jobs** ou
|
|
|
86
86
|
o secret `NPMJS_TOKEN` do repositório; sem ele, usa OIDC, conforme
|
|
87
87
|
[publicação](packages.md).
|
|
88
88
|
|
|
89
|
-
Se a release já existe e falta somente o pacote
|
|
89
|
+
Se a release já existe e falta somente o pacote em um registro, use o modo
|
|
90
90
|
`package_only` descrito em [pacote npm](packages.md#publicar-pelo-actions).
|
|
91
91
|
Ele não tenta recriar a release existente.
|
|
92
92
|
|
|
93
|
+
Execuções concluídas com falha podem ser removidas mediante solicitação,
|
|
94
|
+
sem apagar execuções aprovadas, tags ou releases. Confira a lista e preserve
|
|
95
|
+
os identificadores das execuções e releases mantidas antes da limpeza.
|
|
96
|
+
|
|
93
97
|
## Conferir a entrega pública
|
|
94
98
|
|
|
95
99
|
Confira a versão na [página do pacote][package] e instale pelo nome em um
|
|
@@ -1,13 +1,24 @@
|
|
|
1
1
|
---
|
|
2
|
-
description:
|
|
2
|
+
description: Publicação sincronizada do AgentDevKit no npm e no GitHub Packages.
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
# Pacote
|
|
5
|
+
# Pacote nos dois registries
|
|
6
6
|
|
|
7
7
|
O AgentDevKit é um único pacote: [`@pathbit/agentdevkit`][package]. Ele contém
|
|
8
8
|
a CLI e os recursos compartilhados; a instalação prepara os apontamentos dos
|
|
9
9
|
agentes escolhidos no projeto.
|
|
10
10
|
|
|
11
|
+
Cada versão usa o mesmo TGZ nos dois destinos, com o mesmo número e checksum.
|
|
12
|
+
|
|
13
|
+
| Destino | Visibilidade | Instalação |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| [npm público][package] | Pública | `npx`, sem login; opção padrão. |
|
|
16
|
+
| [GitHub Packages][github] | Pública | Exige autenticação do GitHub. |
|
|
17
|
+
|
|
18
|
+
No GitHub Packages, público significa que o pacote é visível a todos;
|
|
19
|
+
o registry npm do GitHub exige token também para baixar pacotes públicos.
|
|
20
|
+
Consulte a [autenticação oficial][github-auth] se escolher esse destino.
|
|
21
|
+
|
|
11
22
|
Os metadados identificam PathBit como autor, palavras-chave do kit e licença
|
|
12
23
|
MIT. O README público é gerado sem frontmatter e com links absolutos do GitHub;
|
|
13
24
|
a fonte versionada conserva o YAML. O `LICENSE` canônico acompanha o pacote e
|
|
@@ -17,13 +28,21 @@ não integram o TGZ do AgentDevKit.
|
|
|
17
28
|
|
|
18
29
|
## Instalar no projeto
|
|
19
30
|
|
|
20
|
-
|
|
31
|
+
Prepare os [pré-requisitos](../guides/prerequisites.md), depois escolha o destino:
|
|
21
32
|
|
|
22
33
|
```console
|
|
23
34
|
npx @pathbit/agentdevkit init
|
|
24
35
|
```
|
|
25
36
|
|
|
26
|
-
|
|
37
|
+
O comando acima usa o npm público, sem login. Para GitHub Packages, faça a
|
|
38
|
+
[autenticação inicial](../guides/installation.md#github-packages) e execute:
|
|
39
|
+
|
|
40
|
+
```console
|
|
41
|
+
npx --registry=https://npm.pkg.github.com @pathbit/agentdevkit init
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Para repetir uma instalação, fixe a versão após o nome, como
|
|
45
|
+
`@pathbit/agentdevkit@0.0.10`, nos dois destinos.
|
|
27
46
|
|
|
28
47
|
Acrescente `--agents codex,claude` para selecionar clientes, `--dry-run` para
|
|
29
48
|
simular ou use `update`, `doctor` e `sync --check` no lugar de `init`.
|
|
@@ -34,12 +53,12 @@ da aplicação. Para conferir as versões:
|
|
|
34
53
|
npm view @pathbit/agentdevkit versions --json
|
|
35
54
|
```
|
|
36
55
|
|
|
37
|
-
Se existir um mapeamento
|
|
38
|
-
[
|
|
56
|
+
Se existir um mapeamento de `@pathbit` que impeça alternar o destino, siga o
|
|
57
|
+
[diagnóstico de registry][fix].
|
|
39
58
|
|
|
40
59
|
## Publicar pelo Actions
|
|
41
60
|
|
|
42
|
-
A publicação usa o mesmo TGZ aprovado pelo CI
|
|
61
|
+
A publicação usa o mesmo TGZ aprovado pelo CI nos dois registries. O workflow
|
|
43
62
|
confere versão, origem e integridade; uma versão existente só é aceita quando
|
|
44
63
|
contém os mesmos bytes. Não reempacote nem substitua uma versão publicada.
|
|
45
64
|
|
|
@@ -48,6 +67,11 @@ variável interna `NPM_TOKEN` somente na publicação. O token precisa permitir
|
|
|
48
67
|
publicar no escopo `@pathbit`; credenciais nunca entram nos arquivos
|
|
49
68
|
versionados.
|
|
50
69
|
|
|
70
|
+
O passo do GitHub Packages usa `GITHUB_TOKEN` com `packages: write` e confirma
|
|
71
|
+
a visibilidade pública. Tokens de um registry não são enviados ao outro.
|
|
72
|
+
O npm continua usando `NPMJS_TOKEN` ou OIDC, com prova de consumo anônimo;
|
|
73
|
+
as provas do GitHub usam autenticação própria.
|
|
74
|
+
|
|
51
75
|
Sem esse secret, o workflow usa OIDC. Configure o **Trusted Publisher** do npm:
|
|
52
76
|
|
|
53
77
|
| Campo | Valor |
|
|
@@ -61,14 +85,19 @@ O fallback recebe `id-token: write`. O npm exige CLI 11.5.1+ e Node 22.14+;
|
|
|
61
85
|
o projeto usa Node 24. Configure a relação de confiança depois que o pacote
|
|
62
86
|
existir; a primeira publicação pode usar o secret `NPMJS_TOKEN`.
|
|
63
87
|
|
|
64
|
-
|
|
88
|
+
Por padrão, uma tag publica nos dois destinos. Para completar o GitHub
|
|
89
|
+
Packages de uma tag existente, preservando a release e o npm:
|
|
65
90
|
|
|
66
91
|
```console
|
|
67
|
-
gh workflow run
|
|
92
|
+
gh workflow run Release -f tag=v0.0.10 -F package_only=true -f registry=github
|
|
68
93
|
```
|
|
69
94
|
|
|
70
95
|
Se o artefato expirou, reexecute o CI original da tag antes da publicação.
|
|
71
|
-
|
|
96
|
+
`registry` aceita `both`, `npm` ou `github`. `package_only` impede alterar a
|
|
97
|
+
release existente; cada registry recusa versões com bytes diferentes e pula
|
|
98
|
+
a publicação se a mesma versão já estiver correta.
|
|
99
|
+
|
|
100
|
+
Depois do envio ao npm, o job usa um ambiente sem credenciais e cache novo para
|
|
72
101
|
executar `--version`, `init`, `doctor` e `sync --check` pelo nome e versão
|
|
73
102
|
publicados. Assim, a verificação comprova o acesso de um usuário comum.
|
|
74
103
|
Confirme também que `latest` aponta para a versão estável e que o tarball é
|
|
@@ -76,12 +105,15 @@ baixável; metadados visíveis sozinhos não comprovam uma instalação funciona
|
|
|
76
105
|
Se o registro ainda não disponibilizar o pacote, aguarde a verificação sem
|
|
77
106
|
republicar automaticamente a mesma versão.
|
|
78
107
|
|
|
79
|
-
|
|
80
|
-
|
|
108
|
+
O GitHub Packages verifica os mesmos comandos com autenticação. Metadados
|
|
109
|
+
devem indicar visibilidade pública e associação ao repositório correto.
|
|
110
|
+
Uma falha parcial permite repetir apenas o destino pendente usando o artefato
|
|
111
|
+
original; nunca recrie uma versão publicada com outro conteúdo.
|
|
81
112
|
|
|
82
113
|
[Wiki](../README.md) · [Manutenção](maintenance.md) ·
|
|
83
114
|
[Instalação](../guides/installation.md)
|
|
84
115
|
|
|
85
116
|
[package]: https://www.npmjs.com/package/@pathbit/agentdevkit
|
|
86
|
-
[
|
|
117
|
+
[github]: https://github.com/pathbit/AgentDevKit/pkgs/npm/agentdevkit
|
|
118
|
+
[github-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry
|
|
87
119
|
[fix]: ../guides/troubleshooting.md#download-plataforma-ou-ferramenta-falhando
|
package/docs/product/design.md
CHANGED
|
@@ -66,6 +66,18 @@ O estado registra versão, escolha e propriedade local. Índices e manifesto
|
|
|
66
66
|
podem ser reconstruídos. Downloads, credenciais e relatórios ficam fora do
|
|
67
67
|
pacote e do Git.
|
|
68
68
|
|
|
69
|
+
## Inventário e evolução documental
|
|
70
|
+
|
|
71
|
+
O inspetor inclui metadados de documentação no JSON: caminhos, tipo, papel
|
|
72
|
+
provável, origem da indicação, tamanho e hash quando couber nos limites.
|
|
73
|
+
Ele não escreve arquivos, não emite conteúdo e não lê destinos simbólicos.
|
|
74
|
+
Limites e avisos impedem interpretar uma busca parcial como ausência de docs.
|
|
75
|
+
|
|
76
|
+
A skill `atualizar-documentacao` usa esse inventário antes dos templates.
|
|
77
|
+
O agente lê o material, propõe ações por arquivo e aplica complementos
|
|
78
|
+
autorizados. Organização usa índices e links, preservando caminhos e conteúdo.
|
|
79
|
+
Produto e aprovações dependem das decisões reais do usuário.
|
|
80
|
+
|
|
69
81
|
## Runtime
|
|
70
82
|
|
|
71
83
|
O launcher aceita Node 18+ e prepara Node 24+ antes de carregar o núcleo.
|
package/docs/product/prd.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
description: Requisitos da distribuição portátil AgentDevKit.
|
|
3
3
|
status: aprovado
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.10
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# PRD do AgentDevKit
|
|
@@ -40,6 +40,9 @@ extraído do projeto de origem como produto independente.
|
|
|
40
40
|
| FR-018 | Publicar autoria PathBit, palavras-chave e licença MIT no npm. |
|
|
41
41
|
| FR-019 | Exibir README legível no npm sem alterar o Markdown fonte. |
|
|
42
42
|
| FR-020 | Levar a licença do kit ao hub sem alterar a licença do projeto. |
|
|
43
|
+
| FR-021 | Inventariar documentos existentes antes de propor alterações. |
|
|
44
|
+
| FR-022 | Complementar documentação sem substituir arquivos por templates. |
|
|
45
|
+
| FR-023 | Provar o fluxo documental em projetos reais e em projeto vazio. |
|
|
43
46
|
|
|
44
47
|
Execuções repetidas devem ser idempotentes; a CLI oferece simulação e JSON.
|
|
45
48
|
As instruções permanecem concisas, com detalhes opcionais em referências.
|
package/docs/product/roadmap.md
CHANGED
|
@@ -19,6 +19,8 @@ status: vigente
|
|
|
19
19
|
| Apresentação e licença v0.0.6 | Distribuição e atualização | [Spec][public]. |
|
|
20
20
|
| Compatibilidade real v0.0.7 | Testes em clones existentes | [Spec][oss]. |
|
|
21
21
|
| Preservação v0.0.8 | Auditoria e regressões | [Spec][robustness]. |
|
|
22
|
+
| Coexistência v0.0.9 | Agentes, documentos e projetos reais | [Spec][coexistence]. |
|
|
23
|
+
| Instalação nos dois registries v0.0.10 | Pacote e guias de pré-requisitos | [Spec][dual-install]. |
|
|
22
24
|
|
|
23
25
|
A primeira entrega segue a [spec v0.0.1](../specs/v0.0.1/SPEC.md), disponível
|
|
24
26
|
na [release v0.0.1][release]. Os detalhes de mudanças estão no
|
|
@@ -40,3 +42,5 @@ comportamento existente, sem alterar a versão de uma release já publicada.
|
|
|
40
42
|
[public]: ../specs/v0.0.6/SPEC.md
|
|
41
43
|
[oss]: ../specs/v0.0.7/SPEC.md
|
|
42
44
|
[robustness]: ../specs/v0.0.8/SPEC.md
|
|
45
|
+
[coexistence]: ../specs/v0.0.9/SPEC.md
|
|
46
|
+
[dual-install]: ../specs/v0.0.10/SPEC.md
|
package/docs/specs/README.md
CHANGED
|
@@ -13,6 +13,9 @@ description: Incrementos verificáveis do AgentDevKit.
|
|
|
13
13
|
- [v0.0.6](v0.0.6/SPEC.md): apresentação pública, licença e atualização segura.
|
|
14
14
|
- [v0.0.7](v0.0.7/SPEC.md): projetos reais e proteção local de artefatos.
|
|
15
15
|
- [v0.0.8](v0.0.8/SPEC.md): preservação, transações e validação aprofundada.
|
|
16
|
+
- [v0.0.9](v0.0.9/SPEC.md): coexistência e evolução documental sem perdas.
|
|
17
|
+
- [Dois registries](dual-registry/SPEC.md): versão e bytes iguais no npm e GitHub.
|
|
18
|
+
- [v0.0.10](v0.0.10/SPEC.md): release com instalação pelos dois registries e pré-requisitos.
|
|
16
19
|
|
|
17
20
|
Cada incremento vincula requisitos, critérios, testes e evidências locais.
|
|
18
21
|
|