@fabioforest/openclaw 3.4.0 → 3.4.1

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 +417 -46
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,73 +1,425 @@
1
- # OpenClaw OS
1
+ # 🦀 OpenClaw AI OS
2
2
 
3
- CLI e starter kit para configuração segura do OpenClaw em VPS, Mac, Windows e Docker.
3
+ **Sistema universal de agentes para IDEs** instale, configure e use via chat ou terminal.
4
4
 
5
- ## Instalação
5
+ O OpenClaw transforma qualquer projeto em um workspace inteligente com skills, regras de segurança e roteamento econômico de modelos de IA. Funciona em **Cursor, VSCode, Gemini Code Assist, Antigravity** e qualquer IDE com suporte a agentes.
6
+
7
+ ---
8
+
9
+ ## 📦 Instalação
10
+
11
+ ### Opção 1: Via npx (recomendado — sem instalar nada)
6
12
 
7
13
  ```bash
8
- # Via npx (recomendado)
14
+ # Simula o que será feito (modo seguro, não altera nada)
9
15
  npx @fabioforest/openclaw init
10
16
 
11
- # Ou instale globalmente
17
+ # Instala de fato no projeto
18
+ npx @fabioforest/openclaw init --apply
19
+ ```
20
+
21
+ ### Opção 2: Instalação global
22
+
23
+ ```bash
12
24
  npm install -g @fabioforest/openclaw
13
- openclaw init
25
+ openclaw init --apply
26
+ ```
27
+
28
+ ### Opção 3: Instalação completa para IDEs
29
+
30
+ ```bash
31
+ # Instala o "AI OS" com skills, rules, state e hooks
32
+ npx @fabioforest/openclaw ide install --apply
33
+ ```
34
+
35
+ > **💡 Dica**: Todos os comandos operam em **modo PLAN por padrão** (read-only). Nada é alterado sem `--apply`.
36
+
37
+ ---
38
+
39
+ ## 🎯 Quando usar cada comando
40
+
41
+ ### Resumo rápido
42
+
43
+ | Situação | Comando | O que faz |
44
+ |----------|---------|-----------|
45
+ | Primeira vez no projeto | `init --apply` | Cria `.agent/` com templates |
46
+ | Atualizar skills/rules | `update --apply` | Atualiza preservando customizações |
47
+ | Ver o que está instalado | `status` | Lista componentes e config |
48
+ | Algo não funciona | `doctor` | Diagnóstico completo |
49
+ | Quero entender meu ambiente | `inspect` | Análise 100% read-only |
50
+ | Preciso de ajuda geral | `assist` | Assistente com roteamento de skills |
51
+ | Instalar AI OS na IDE | `ide install --apply` | Skills + rules + state + hooks |
52
+ | Verificar IDE configurada | `ide doctor` | Checa se tudo está "armado" |
53
+ | Configurar do zero | `setup` | Wizard interativo passo a passo |
54
+ | Problemas de rede/VPN | `debug` | Diagnóstico de conectividade |
55
+ | Instalar ou reparar (automático) | `check` | Orquestrador inteligente |
56
+
57
+ ---
58
+
59
+ ## 📖 Manual de Uso Detalhado
60
+
61
+ ### `openclaw init` — Instalar no projeto
62
+
63
+ **Quando usar:** Primeira vez que você quer adicionar o OpenClaw a um projeto.
64
+
65
+ ```bash
66
+ # 1. Primeiro, simule para ver o que vai acontecer
67
+ npx @fabioforest/openclaw init
68
+ # → Mostra plano: "CREATE .agent/", "COPY templates", "CREATE openclaw.json"
69
+ # → Nenhum arquivo é criado
70
+
71
+ # 2. Se estiver tudo certo, aplique
72
+ npx @fabioforest/openclaw init --apply
73
+ # → Cria .agent/ com skills, rules, hooks e workflows
74
+ # → Cria openclaw.json com configurações default
75
+
76
+ # 3. Se já existe e quer sobrescrever (exige confirmação forte)
77
+ npx @fabioforest/openclaw init --apply --force
78
+ # → Pede para digitar "DESTROY .agent" para confirmar
79
+ ```
80
+
81
+ **Flags disponíveis:**
82
+
83
+ | Flag | O que faz |
84
+ |------|-----------|
85
+ | `--apply` | Executa de fato (sem isso, só simula) |
86
+ | `--force` | Permite sobrescrever `.agent/` existente |
87
+ | `--path ./dir` | Instala em outro diretório |
88
+ | `--yes` | Pula confirmações interativas |
89
+ | `--no-audit` | Não gera log de auditoria |
90
+
91
+ ---
92
+
93
+ ### `openclaw update` — Atualizar templates
94
+
95
+ **Quando usar:** Quando sair uma versão nova do OpenClaw e você quiser atualizar skills/rules sem perder customizações.
96
+
97
+ ```bash
98
+ # Simula a atualização (mostra o que mudou)
99
+ npx @fabioforest/openclaw update
100
+
101
+ # Aplica a atualização
102
+ npx @fabioforest/openclaw update --apply
103
+
104
+ # Merge seguro (preserva customizações)
105
+ npx @fabioforest/openclaw update --apply --merge
106
+ ```
107
+
108
+ **Como funciona:**
109
+ - Compara cada arquivo por hash SHA-256
110
+ - Se você customizou um arquivo, faz backup (`.bak`) antes de atualizar
111
+ - Novos templates são copiados normalmente
112
+ - Tudo é registrado em `.agent/audit/`
113
+
114
+ ---
115
+
116
+ ### `openclaw inspect` — Analisar ambiente (read-only)
117
+
118
+ **Quando usar:** Antes de qualquer ação, para entender o contexto. 100% read-only — nunca altera nada.
119
+
120
+ ```bash
121
+ npx @fabioforest/openclaw inspect
14
122
  ```
15
123
 
16
- ## Comandos
124
+ **Saída de exemplo:**
125
+
126
+ ```
127
+ 🔎 OpenClaw Inspect (Read-Only)
17
128
 
18
- | Comando | Descrição |
19
- |---------|-----------|
20
- | `openclaw init` | Instala templates `.agent/` no projeto |
21
- | `openclaw update` | Atualiza templates preservando customizações |
22
- | `openclaw status` | Mostra status da instalação |
23
- | `openclaw doctor` | Healthcheck automatizado do ambiente |
24
- | `openclaw setup` | Roda wizard interativo de configuração |
129
+ 🖥️ Plataforma: darwin
130
+ 🐳 Docker: false
131
+ 🪟 WSL: false
132
+ 💻 IDE: cursor
133
+ 📂 Path: /home/user/meu-projeto
134
+ 📦 OpenClaw instalado: Sim
135
+ 📋 Config: Sim
136
+ 🐙 Git repo: Sim
25
137
 
26
- ### Opções
138
+ 🧠 Skills instaladas (15):
139
+ • content-sourcer • context-flush
140
+ • drive-organizer • linkedin-optimizer
141
+ • mission-control • openclaw-router
142
+ • smart-router • web-scraper
143
+ ...
144
+
145
+ ✅ Inspect concluído (nenhuma alteração feita).
146
+ ```
147
+
148
+ **Modo JSON (para automações):**
27
149
 
28
150
  ```bash
29
- openclaw init --force # Sobrescreve .agent/ existente
30
- openclaw init --path ./dir # Instala em diretório específico
31
- openclaw doctor --quiet # Saída mínima
151
+ npx @fabioforest/openclaw inspect --quiet
152
+ # Retorna JSON puro, ideal para pipes e scripts
32
153
  ```
33
154
 
34
- ## O que é instalado
155
+ ---
156
+
157
+ ### `openclaw assist` — Assistente geral com roteamento
35
158
 
36
- O comando `init` cria a seguinte estrutura no seu projeto:
159
+ **Quando usar:** Quando não sabe qual skill usar. O assist analisa sua solicitação e sugere a skill mais adequada.
160
+
161
+ ```bash
162
+ npx @fabioforest/openclaw assist
163
+ ```
164
+
165
+ **Como funciona:**
166
+ 1. Detecta contexto (IDE, plataforma, skills disponíveis)
167
+ 2. Pede sua solicitação em linguagem natural
168
+ 3. Roteia para a skill mais relevante via triggers
169
+ 4. Mostra alternativas e protocolo recomendado
170
+
171
+ **Exemplo de interação:**
172
+
173
+ ```
174
+ 🧠 OpenClaw Assist — Modo PLAN por padrão (seguro)
175
+ IDE: cursor | OpenClaw: instalado
176
+
177
+ Descreva o que deseja fazer:
178
+ > otimizar meu perfil do linkedin
179
+
180
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
181
+ 🎯 Skill selecionada: linkedin-optimizer
182
+ Descrição: Ajuda a otimizar perfil e posts para LinkedIn
183
+
184
+ Alternativas:
185
+ • content-sourcer: Busca fontes públicas
186
+ • smart-router: Roteia para perfis de modelo
187
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
188
+ ```
189
+
190
+ ---
191
+
192
+ ### `openclaw ide install` — Instalar AI OS na IDE
193
+
194
+ **Quando usar:** Para preparar sua IDE para usar o OpenClaw como agente via chat. Instala skills, rules, hooks e state templates.
195
+
196
+ ```bash
197
+ # Simula a instalação (mostra o plano)
198
+ npx @fabioforest/openclaw ide install
199
+
200
+ # Aplica a instalação
201
+ npx @fabioforest/openclaw ide install --apply
202
+
203
+ # Força reinstalação completa
204
+ npx @fabioforest/openclaw ide install --apply --force
205
+ ```
206
+
207
+ **O que é instalado:**
37
208
 
38
209
  ```
39
210
  .agent/
40
- ├── agents/ # Personas de agente (ex: sysadmin-proativo)
41
- ├── hooks/ # Hooks de segurança (PreToolUse)
42
- ├── rules/ # Guardrails de segurança
43
- ├── skills/
44
- │ ├── universal-setup/ # Wizard de configuração interativo
45
- └── openclaw-ops/ # 8 skills operacionais
46
- └── workflows/ # Runbooks e slash commands
211
+ ├── agents/ # Personas (sysadmin, automator, setup)
212
+ ├── hooks/ # pre-tool-use.js (bloqueia comandos destrutivos)
213
+ ├── rules/ # 5 regras de segurança
214
+ ├── CONSENT_FIRST.md
215
+ │ ├── SECURITY.md
216
+ ├── ROUTER_PROTOCOL.md
217
+ │ ├── DEV_MODE.md
218
+ │ └── WEB_AUTOMATION.md
219
+ ├── skills/ # 15 skills disponíveis
220
+ │ ├── openclaw-router/ # Roteador central chat-first
221
+ │ ├── openclaw-inspect/ # Inspeção read-only
222
+ │ ├── smart-router/ # Roteador econômico de modelos
223
+ │ ├── mission-control/ # Empresa de Agentes
224
+ │ ├── linkedin-optimizer/ # Otimização de LinkedIn
225
+ │ ├── drive-organizer/ # Google Drive via API
226
+ │ ├── site-tester/ # Lighthouse + Playwright
227
+ │ ├── web-scraper/ # Scraping responsável
228
+ │ ├── content-sourcer/ # Pesquisa de fontes
229
+ │ └── ... (+ 6 skills operacionais)
230
+ ├── state/ # Estado persistente
231
+ │ ├── mission_control.json # Empresa de Agentes
232
+ │ └── MEMORY.md # Memória do workspace
233
+ └── workflows/ # Slash commands e runbooks
234
+ ```
235
+
236
+ ---
237
+
238
+ ### `openclaw ide doctor` — Verificar IDE
239
+
240
+ **Quando usar:** Para confirmar que sua IDE está "armada" com todas as regras e skills necessárias.
241
+
242
+ ```bash
243
+ npx @fabioforest/openclaw ide doctor
244
+ ```
245
+
246
+ **Saída de exemplo:**
247
+
248
+ ```
249
+ 🏥 IDE Doctor — Verificando instalação para IDE:
250
+
251
+ ✅ .agent/
252
+ ✅ rules/CONSENT_FIRST.md
253
+ ✅ rules/ROUTER_PROTOCOL.md
254
+ ✅ skills/openclaw-router/SKILL.md
255
+ ✅ skills/openclaw-inspect/SKILL.md
256
+ ✅ skills/openclaw-dev/SKILL.md
257
+ ✅ hooks/pre-tool-use.js
258
+
259
+ 🎉 IDE está totalmente configurada!
260
+ ```
261
+
262
+ ---
263
+
264
+ ### `openclaw status` — Ver status da instalação
265
+
266
+ **Quando usar:** Para ver rapidamente o que está instalado e configurado.
267
+
268
+ ```bash
269
+ npx @fabioforest/openclaw status
270
+ ```
271
+
272
+ Mostra: componentes instalados, versão, config ativa (com tokens mascarados).
273
+
274
+ ---
275
+
276
+ ### `openclaw doctor` — Healthcheck completo
277
+
278
+ **Quando usar:** Quando algo não funciona. Faz diagnóstico completo do ambiente.
279
+
280
+ ```bash
281
+ npx @fabioforest/openclaw doctor
282
+ npx @fabioforest/openclaw doctor --quiet # Saída mínima
283
+ ```
284
+
285
+ Verifica: config, portas, VPN, integridade de arquivos, dependências.
286
+
287
+ ---
288
+
289
+ ### `openclaw setup` — Wizard interativo
290
+
291
+ **Quando usar:** Primeira configuração completa com perguntas guiadas.
292
+
293
+ ```bash
294
+ npx @fabioforest/openclaw setup
295
+ ```
296
+
297
+ Guia passo a passo para configurar ambiente, modelo de IA, canais e segurança.
298
+
299
+ ---
300
+
301
+ ### `openclaw check` — Orquestrador inteligente
302
+
303
+ **Quando usar:** Quando não sabe se precisa instalar ou reparar. Ele decide por você.
304
+
305
+ ```bash
306
+ npx @fabioforest/openclaw check
307
+ ```
308
+
309
+ Detecta se o OpenClaw já existe e oferece opções: instalar, atualizar, reparar ou forçar.
310
+
311
+ ---
312
+
313
+ ### `openclaw debug` — Diagnóstico avançado
314
+
315
+ **Quando usar:** Problemas de rede, VPN, npm ou GitHub.
316
+
317
+ ```bash
318
+ npx @fabioforest/openclaw debug
47
319
  ```
48
320
 
49
- ### Skills Operacionais
321
+ Verifica conectividade, proxy, versões e integridade do ambiente.
322
+
323
+ ---
324
+
325
+ ## 🧠 Skills Disponíveis (15)
326
+
327
+ ### Core — Infraestrutura do AI OS
328
+
329
+ | Skill | O que faz | Quando usar |
330
+ |-------|-----------|-------------|
331
+ | `openclaw-router` | Roteador central chat-first | Sempre ativo — decide qual skill usar |
332
+ | `openclaw-inspect` | Inspeção read-only | Para analisar sem alterar |
333
+ | `openclaw-dev` | Modo Devin-like | Para criar features, backend, frontend |
334
+ | `openclaw-security` | Hardening | Para melhorar segurança do workspace |
335
+ | `openclaw-assist` | Assistente geral | Para menu de ações e ajuda |
336
+ | `mission-control` | Empresa de Agentes | Para orquestrar múltiplos agentes |
337
+ | `smart-router` | Roteador econômico | Para escolher modelo de IA por custo |
338
+ | `context-flush` | Flush de memória | Para economizar tokens em sessões longas |
339
+
340
+ ### Produtividade — Automação e Web
341
+
342
+ | Skill | O que faz | Quando usar |
343
+ |-------|-----------|-------------|
344
+ | `linkedin-optimizer` | Textos para LinkedIn | Para otimizar perfil/posts (human-in-the-loop) |
345
+ | `drive-organizer` | Google Drive via API | Para organizar arquivos na nuvem |
346
+ | `site-tester` | Lighthouse + Playwright | Para testar performance/SEO/acessibilidade |
347
+ | `web-scraper` | Scraping responsável | Para extrair dados de sites |
348
+ | `content-sourcer` | Pesquisa de fontes | Para criar dossiês citáveis |
349
+
350
+ ### Operacionais — DevOps e Infra
351
+
352
+ | Skill | O que faz | Quando usar |
353
+ |-------|-----------|-------------|
354
+ | `universal-setup` | Setup em qualquer ambiente | Para instalação em VPS/Docker/Mac/Windows |
355
+ | `openclaw-installation-debugger` | Debug de instalação | Para resolver problemas de setup |
356
+
357
+ ---
358
+
359
+ ## 🔒 Segurança
360
+
361
+ O OpenClaw segue 3 princípios fundamentais:
362
+
363
+ ### 1. Read-only por padrão
364
+ Todo comando opera em **modo PLAN** (simulação). Nada é alterado sem `--apply`.
365
+
366
+ ### 2. Consent-first
367
+ Antes de qualquer alteração, o sistema mostra exatamente o que vai fazer e pede confirmação. Ações destrutivas exigem **confirmação forte** (digitar frase específica).
368
+
369
+ ### 3. Audit-first
370
+ Toda ação gera log detalhado em `.agent/audit/` com timestamp, comando, modo, contexto e resultado.
371
+
372
+ ### Proteções ativas
50
373
 
51
- | # | Skill | Descrição |
52
- |---|-------|-----------|
53
- | 01 | VPN WireGuard | Provisiona VPN entre VPS e hosts |
54
- | 02 | Enroll Host | Onboarding com aprovação humana |
55
- | 03 | Policy Baseline | RBAC + allowlists deny-by-default |
56
- | 04 | Remote Exec | Runbooks com timeout e auditoria |
57
- | 05 | File Transfer | Transferência com hash e allowlist |
58
- | 06 | Audit Logging | Log JSON com redaction de segredos |
59
- | 07 | Safe Update | Canary + rollback automático |
60
- | 08 | Healthchecks | Circuit breaker + auto-restart |
374
+ | Proteção | Como funciona |
375
+ |----------|---------------|
376
+ | **Hook pre-tool-use** | Bloqueia 12+ padrões destrutivos (`rm -rf`, `mkfs`, `dd`, `shutdown`) |
377
+ | **VPN-first** | Sem VPN, sem acesso remoto |
378
+ | **Bind localhost** | Serviços acessíveis localmente por padrão |
379
+ | **Auth token** | Token obrigatório para acesso |
380
+ | **Break-glass** | Acesso emergencial com expiração automática |
381
+ | **WEB_AUTOMATION rule** | Checklist de compliance para automação web |
61
382
 
62
- ## Segurança
383
+ ---
63
384
 
64
- - **VPN-first** sem VPN, sem acesso remoto
65
- - **bind localhost** + **auth token** por padrão
66
- - **Hook `pre-tool-use`** — bloqueia comandos destrutivos (`rm -rf`, `mkfs`, `dd`, `shutdown`)
67
- - **Break-glass** — acesso emergencial com expiração automática
68
- - **Auditoria** — todos os eventos logados com `request_id`
385
+ ## 💰 Roteador Econômico de Modelos
69
386
 
70
- ## Desenvolvimento
387
+ O `smart-router` escolhe automaticamente o modelo de IA mais econômico para cada tarefa:
388
+
389
+ | Perfil | Quando | Provedor default (free) |
390
+ |--------|--------|------------------------|
391
+ | **cheap** | Tarefas simples, formatação, resumos | Gemini Flash-Lite → Groq |
392
+ | **smart** | Planejamento, análise, raciocínio | Gemini Pro → Claude |
393
+ | **coding** | Código, debug, refactor, testes | Gemini Pro → GPT-5.2 |
394
+
395
+ Prioridade: **free-first** — só usa provedores pagos com autorização explícita.
396
+
397
+ ---
398
+
399
+ ## 🚀 Guia Rápido: Do Zero ao Funcionando
400
+
401
+ ```bash
402
+ # 1. Instale no seu projeto
403
+ npx @fabioforest/openclaw ide install --apply
404
+
405
+ # 2. Verifique se está tudo OK
406
+ npx @fabioforest/openclaw ide doctor
407
+
408
+ # 3. Analise seu ambiente
409
+ npx @fabioforest/openclaw inspect
410
+
411
+ # 4. Use o assistente
412
+ npx @fabioforest/openclaw assist
413
+ ```
414
+
415
+ **Ou via chat na IDE (Cursor, VSCode, Antigravity, Gemini):**
416
+ - Basta perguntar no chat! As skills e rules em `.agent/` guiam o agente automaticamente.
417
+ - O `openclaw-router` decide qual skill usar com base nos triggers de cada uma.
418
+ - Tudo segue o fluxo: **INSPECT → PLAN → CONSENT → APPLY → AUDIT**.
419
+
420
+ ---
421
+
422
+ ## 🛠️ Desenvolvimento
71
423
 
72
424
  ```bash
73
425
  # Instalar dependências
@@ -83,6 +435,25 @@ npm run test:watch
83
435
  npm run test:coverage
84
436
  ```
85
437
 
86
- ## Licença
438
+ ---
439
+
440
+ ## 📋 Flags Globais
441
+
442
+ Todas as flags funcionam com qualquer comando:
443
+
444
+ | Flag | Descrição | Padrão |
445
+ |------|-----------|--------|
446
+ | `--plan` | Modo simulação (read-only) | **Sim** |
447
+ | `--apply` | Modo execução (aplica alterações) | Não |
448
+ | `--yes, -y` | Pula confirmações | Não |
449
+ | `--force, -f` | Permite operações destrutivas | Não |
450
+ | `--path, -p <dir>` | Diretório alvo | `./` |
451
+ | `--quiet, -q` | Saída mínima | Não |
452
+ | `--no-audit` | Desabilita logs de auditoria | Não |
453
+ | `--merge` | Atualização segura (preserva customizações) | Não |
454
+
455
+ ---
456
+
457
+ ## 📄 Licença
87
458
 
88
459
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fabioforest/openclaw",
3
- "version": "3.4.0",
3
+ "version": "3.4.1",
4
4
  "description": "Agentes autônomos para engenharia de software",
5
5
  "publishConfig": {
6
6
  "access": "public"