smolerclaw 1.0.1 → 1.0.2

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/dist/README.md +159 -0
  2. package/package.json +6 -2
package/dist/README.md ADDED
@@ -0,0 +1,159 @@
1
+ # smolerclaw
2
+
3
+ A micro AI assistant built on top of Claude, designed for Windows.
4
+ One binary, zero config, full TUI.
5
+
6
+ ---
7
+
8
+ ## Quick Start
9
+
10
+ ```bash
11
+ # 1. Set your key (or use Claude Code subscription — auto-detected)
12
+ set ANTHROPIC_API_KEY=sk-ant-...
13
+
14
+ # 2. Run
15
+ bun run start
16
+ ```
17
+
18
+ That's it. No setup wizards, no config files, no Docker.
19
+
20
+ ## Install as a system-wide command
21
+
22
+ ```powershell
23
+ powershell -ExecutionPolicy Bypass -File install.ps1
24
+ ```
25
+
26
+ Then from anywhere:
27
+
28
+ ```
29
+ smolerclaw
30
+ ```
31
+
32
+ ## What it does
33
+
34
+ smolerclaw is a terminal AI assistant that lives on your Windows machine. It can:
35
+
36
+ - **Read, write, and edit files** in your project
37
+ - **Run commands** and analyze output
38
+ - **Open Windows apps** — Excel, Outlook, VS Code, browser, etc.
39
+ - **Manage tasks & reminders** — with Windows Task Scheduler integration (reminders work even when smolerclaw is closed)
40
+ - **Track people & delegations** — team, family, contacts
41
+ - **Take notes** — searchable memo system with tags
42
+ - **Draft emails** — opens directly in Outlook
43
+ - **Daily briefing** — calendar, tasks, news, follow-ups in one summary
44
+ - **Investigate issues** — structured evidence collection, findings, reports
45
+ - **Run workflows** — multi-step automated routines
46
+ - **Monitor processes** — watch Windows processes, notify on changes
47
+ - **Track finances** — income/expense logging with monthly summaries
48
+ - **Log decisions** — record context and rationale for important choices
49
+ - **Pomodoro timer** — focus sessions with toast notifications
50
+
51
+ ## TUI Commands
52
+
53
+ ```
54
+ /help All commands /clear Clear conversation
55
+ /task 18h buy bread /tasks List pending
56
+ /briefing Morning summary /news Headlines
57
+ /open excel Launch app /calendar Outlook events
58
+ /investigar List investigations /memo #tag Save a note
59
+ /email Draft email /pomodoro Focus timer
60
+ /model sonnet Switch model /export Save to markdown
61
+ ```
62
+
63
+ ## Auth
64
+
65
+ Three ways, in priority order:
66
+
67
+ 1. `ANTHROPIC_API_KEY` env var
68
+ 2. Claude Code subscription (auto-detected from `~/.claude/.credentials.json`)
69
+ 3. `apiKey` in `~/.config/smolerclaw/config.json`
70
+
71
+ ## Requirements
72
+
73
+ - **Windows 10/11**
74
+ - **Bun** runtime (`irm bun.sh/install.ps1 | iex`)
75
+
76
+ ## License
77
+
78
+ MIT
79
+
80
+ ---
81
+
82
+ # smolerclaw (PT-BR)
83
+
84
+ Um micro assistente de IA construido em cima do Claude, feito para Windows.
85
+ Um binario, zero configuracao, TUI completa.
86
+
87
+ ---
88
+
89
+ ## Inicio Rapido
90
+
91
+ ```bash
92
+ # 1. Configure sua chave (ou use assinatura Claude Code — detectada automaticamente)
93
+ set ANTHROPIC_API_KEY=sk-ant-...
94
+
95
+ # 2. Rode
96
+ bun run start
97
+ ```
98
+
99
+ So isso. Sem wizards, sem arquivos de config, sem Docker.
100
+
101
+ ## Instalar como comando do sistema
102
+
103
+ ```powershell
104
+ powershell -ExecutionPolicy Bypass -File install.ps1
105
+ ```
106
+
107
+ Depois, de qualquer lugar:
108
+
109
+ ```
110
+ smolerclaw
111
+ ```
112
+
113
+ ## O que faz
114
+
115
+ smolerclaw e um assistente de IA no terminal que vive na sua maquina Windows. Ele pode:
116
+
117
+ - **Ler, escrever e editar arquivos** no seu projeto
118
+ - **Executar comandos** e analisar saida
119
+ - **Abrir apps do Windows** — Excel, Outlook, VS Code, navegador, etc.
120
+ - **Gerenciar tarefas e lembretes** — integrado com o Agendador de Tarefas do Windows (lembretes funcionam mesmo com o smolerclaw fechado)
121
+ - **Rastrear pessoas e delegacoes** — equipe, familia, contatos
122
+ - **Fazer anotacoes** — sistema de memos com busca e tags
123
+ - **Rascunhar emails** — abre direto no Outlook
124
+ - **Resumo matinal** — calendario, tarefas, noticias, follow-ups em um so resumo
125
+ - **Investigar problemas** — coleta estruturada de evidencias, conclusoes, relatorios
126
+ - **Executar workflows** — rotinas automatizadas de multiplos passos
127
+ - **Monitorar processos** — vigiar processos do Windows, notificar mudancas
128
+ - **Controle financeiro** — registro de entradas/saidas com resumo mensal
129
+ - **Registrar decisoes** — guardar contexto e justificativa de escolhas importantes
130
+ - **Timer Pomodoro** — sessoes de foco com notificacoes toast
131
+
132
+ ## Comandos na TUI
133
+
134
+ ```
135
+ /ajuda Todos os comandos /limpar Limpar conversa
136
+ /tarefa 18h comprar pao /tarefas Listar pendentes
137
+ /resumo Briefing matinal /noticias Manchetes
138
+ /abrir excel Abrir app /calendario Eventos Outlook
139
+ /investigar Listar investigacoes /memo #tag Salvar anotacao
140
+ /email Rascunho de email /foco Timer Pomodoro
141
+ /modelo sonnet Trocar modelo /exportar Salvar em markdown
142
+ ```
143
+
144
+ ## Autenticacao
145
+
146
+ Tres formas, em ordem de prioridade:
147
+
148
+ 1. Variavel de ambiente `ANTHROPIC_API_KEY`
149
+ 2. Assinatura Claude Code (detectada automaticamente de `~/.claude/.credentials.json`)
150
+ 3. `apiKey` em `~/.config/smolerclaw/config.json`
151
+
152
+ ## Requisitos
153
+
154
+ - **Windows 10/11**
155
+ - **Bun** runtime (`irm bun.sh/install.ps1 | iex`)
156
+
157
+ ## Licenca
158
+
159
+ MIT
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "smolerclaw",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Micro AI assistant for tiny machines. Inspired by OpenClaw.",
5
5
  "type": "module",
6
6
  "bin": {
7
- "smolerclaw": "./dist/index.js"
7
+ "smolerclaw": "dist/index.js"
8
8
  },
9
9
  "scripts": {
10
10
  "start": "bun run src/index.ts",
@@ -21,6 +21,10 @@
21
21
  "dist",
22
22
  "README.md"
23
23
  ],
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "https://github.com/ktfth/smolerclaw"
27
+ },
24
28
  "license": "MIT",
25
29
  "devDependencies": {
26
30
  "bun-types": "^1.3.11",