@arzstack/hub 0.1.0 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +40 -52
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,52 +1,40 @@
1
- # @arzstack/hub — instalador
2
-
3
- CLI que instala itens do **ArzStack Hub** (skills, MCPs…) com um comando só,
4
- type-aware e com escolha de destino. Scaffold **a publicar no npm**.
5
-
6
- ```bash
7
- npx @arzstack/hub install <token> --global # ou --project
8
- ```
9
-
10
- O `<token>` é gerado na página do item no Hub (botão "Instalar" → copiar). É curto,
11
- assinado e escopado a 1 item + 1 org. O CLI:
12
-
13
- 1. lê o `hub` + `item` do token;
14
- 2. busca o manifesto em `GET {hub}/api/install/manifest?token=…`;
15
- 3. instala conforme o tipo:
16
- - **skill** `git clone` em `~/.agents/skills/<slug>` (`--global`) ou `.agents/skills/<slug>` (`--project`);
17
- - **mcp_server** roda o comando de configuração (ex.: `claude mcp add …`);
18
- - outros → mostra repositório/passos.
19
- 4. confirma antes de executar (`--yes` pula); reporta o uso pro Hub (analytics).
20
-
21
- Flags: `--global` | `--project` | `--dir <path>` | `--yes`.
22
-
23
- ## Desenvolver / testar local (sem publicar)
24
- ```bash
25
- cd tools/arzstack-installer
26
- node src/index.mjs login --hub http://localhost:3000 --token arz_...
27
- node src/index.mjs install <id-do-item> --project
28
- # ou deixe o comando `arzstack-hub` global apontando pro código local:
29
- npm link # cria o bin; rode: arzstack-hub install <id> ...
30
- npm unlink -g @arzstack/hub # quando terminar
31
- ```
32
-
33
- ## Publicar no npm
34
- Pré-requisitos (uma vez): conta npm (`npm login`) e o **scope `@arzstack`**
35
- (criar a org `arzstack` em npmjs.com — grátis pra pacotes públicos).
36
- ```bash
37
- cd tools/arzstack-installer
38
- npm publish --access public # --access public é obrigatório p/ scope
39
- ```
40
- Pra novas versões: suba `version` no `package.json` e `npm publish` de novo.
41
- Recomendado **mover este diretório pra um repo próprio** (`arzstack-hub-cli`)
42
- e publicar de lá — versionamento independente do portal.
43
-
44
- ## Usar (depois de publicado)
45
- ```bash
46
- npx @arzstack/hub install <id> --global # sem instalar (npx baixa na hora)
47
- # ou global:
48
- npm i -g @arzstack/hub && arzstack-hub install <id> --global
49
- ```
50
- Antes, autentique uma vez: `arzstack-hub login` (cola hub + token do Perfil).
51
-
52
- Contrato completo: `docs/specs/install-experience.md` e `docs/specs/cli-auth.md`.
1
+ # @arzstack/hub
2
+
3
+ Instalador do **ArzStack Hub**: instala itens do catálogo (skills, MCPs…) com **um
4
+ comando**, type-aware e com escolha de destino (projeto ou global).
5
+
6
+ ## Uso rápido
7
+ ```bash
8
+ # 1) autentique uma vez (gere o token no Hub: Perfil → Tokens de CLI)
9
+ npx @arzstack/hub login # pergunta o hub + token
10
+
11
+ # 2) instale um item (o id está na página do item no Hub)
12
+ npx @arzstack/hub install <id> --global # ou --project
13
+ ```
14
+ Prefere instalar global? `npm i -g @arzstack/hub` e use `arzstack-hub …`.
15
+
16
+ ## O que ele faz, por tipo
17
+ | tipo | ação | destino |
18
+ |---|---|---|
19
+ | **skill** | `git clone` da skill | `--global`: `~/.agents/skills/<slug>` · `--project`: `.agents/skills/<slug>` |
20
+ | **mcp_server** | roda o comando de configuração (ex.: `claude mcp add …`) | — |
21
+ | outros | mostra repositório / próximos passos | — |
22
+
23
+ Sempre confirma antes de executar (use `--yes` pra pular).
24
+
25
+ ## Autenticação
26
+ `arzstack-hub login` salva `hub` + `token` em `~/.config/arzstack/config.json`.
27
+ Alternativas: variáveis `ARZSTACK_HUB` / `ARZSTACK_TOKEN` (bom pra CI), ou as flags
28
+ `--hub` / `--token`. O token é pessoal, revogável e escopado à sua org (gere/gerencie
29
+ no Hub em **Perfil Tokens de CLI**).
30
+
31
+ ## Comandos e flags
32
+ ```
33
+ arzstack-hub login [--hub <url>] [--token <pat>]
34
+ arzstack-hub install <id|token> [--global | --project] [--dir <path>] [--yes]
35
+ ```
36
+
37
+ ---
38
+ <sub>Mantenedores: publicado via GitHub Actions (Trusted Publishing/OIDC) a cada bump de
39
+ `version`. Fonte e contrato: repositório do ArzStack Hub (`docs/specs/install-experience.md`,
40
+ `cli-auth.md`).</sub>
package/package.json CHANGED
@@ -1,15 +1,17 @@
1
1
  {
2
2
  "name": "@arzstack/hub",
3
- "version": "0.1.0",
3
+ "version": "1.0.0",
4
4
  "description": "Instalador genérico de itens do ArzStack Hub (skills, MCPs, etc.).",
5
5
  "type": "module",
6
6
  "bin": {
7
- "arzstack-hub": "./src/index.mjs"
7
+ "arzstack-hub": "src/index.mjs"
8
8
  },
9
9
  "engines": {
10
10
  "node": ">=18"
11
11
  },
12
- "files": ["src"],
12
+ "files": [
13
+ "src"
14
+ ],
13
15
  "license": "UNLICENSED",
14
16
  "private": false
15
17
  }