vilvona 1.0.3 → 1.0.4

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/README.md CHANGED
@@ -1,45 +1,35 @@
1
1
  <div align="center">
2
2
 
3
- <img src="ui/public/logo1.png" alt="Vilvona AI" width="120" />
3
+ <img src="ui/public/logo1.png" alt="Vilvona AI" width="110" />
4
4
 
5
5
  # Vilvona AI
6
6
 
7
7
  **Your personal AI that connects everything.**
8
8
 
9
- [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
10
- [![npm version](https://img.shields.io/npm/v/vilvona?color=orange)](https://www.npmjs.com/package/vilvona)
9
+ [![npm version](https://img.shields.io/npm/v/vilvona?label=npm&color=22c55e)](https://www.npmjs.com/package/vilvona)
10
+ [![License: MIT](https://img.shields.io/badge/license-MIT-22c55e.svg)](LICENSE)
11
+ [![Node 22+](https://img.shields.io/badge/node-22%2B-22c55e)](https://nodejs.org)
12
+ [![Claude Fable 5](https://img.shields.io/badge/AI-Claude%20Fable%205-15803d)](https://anthropic.com)
13
+ [![Mobile PWA](https://img.shields.io/badge/mobile-PWA-16a34a)](#mobile-pwa)
11
14
  [![GitHub Stars](https://img.shields.io/github/stars/vignesh2027/Vilvona-AI?style=social)](https://github.com/vignesh2027/Vilvona-AI)
12
- [![Claude Fable 5](https://img.shields.io/badge/AI-Claude%20Fable%205-blueviolet)](https://anthropic.com)
13
- [![Mobile PWA](https://img.shields.io/badge/Mobile-PWA%20Ready-0ea5e9)](#mobile-pwa)
14
- [![Node 22+](https://img.shields.io/badge/Node-22%2B-brightgreen)](https://nodejs.org)
15
- [![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-red)](https://github.com/sponsors/vignesh2027)
16
15
 
17
- Powered by **Claude Fable 5** — the most capable AI from Anthropic.
18
- Works on **desktop, mobile, and tablet**. Supports **Tamil**, **Hindi**, and 21 languages.
16
+ Powered by **Claude Fable 5** — Anthropic's most capable model.
17
+ Supports **Tamil**, **Hindi**, and 21 languages. Works on **desktop, mobile, and tablet**.
19
18
  100% **BYOK** — bring your own API key. Your data never leaves your machine.
20
19
 
21
- [Quick Start](#quick-start) · [Features](#features) · [Docker](#docker) · [Pro Tier](#pro-tier) · [Sponsors](#sponsors)
20
+ **[Docs](https://vignesh2027.github.io/Vilvona-AI)** &nbsp;·&nbsp;
21
+ **[npm](https://npmjs.com/package/vilvona)** &nbsp;·&nbsp;
22
+ **[Pro License](https://vignesh2027.mojo.page/vilvona-ai-pro)** &nbsp;·&nbsp;
23
+ **[Issues](https://github.com/vignesh2027/Vilvona-AI/issues)**
22
24
 
23
25
  </div>
24
26
 
25
27
  ---
26
28
 
27
- ## What is Vilvona AI?
28
-
29
- Vilvona AI is a self-hosted personal AI assistant that connects to all your apps — WhatsApp, Telegram, Slack, Gmail, Discord, Notion, GitHub, and more — from one clean interface. Run it locally or on your server. Zero data sent to third parties. You own everything.
30
-
31
- It is built on the foundation of [OpenClaw](https://openclaw.ai) (MIT license) with three key upgrades:
32
-
33
- 1. **Claude Fable 5** as the default model — the most intelligent AI available today
34
- 2. **Tamil & Hindi UI** — first AI assistant with native support for India's languages
35
- 3. **Mobile PWA** — install on your phone from the browser, no app store needed
36
-
37
- ---
38
-
39
29
  ## Quick Start
40
30
 
41
31
  ```bash
42
- # npm (recommended)
32
+ # npm (no install needed)
43
33
  npx vilvona
44
34
 
45
35
  # yarn
@@ -47,48 +37,53 @@ yarn dlx vilvona
47
37
 
48
38
  # pnpm
49
39
  pnpm dlx vilvona
40
+
41
+ # global install
42
+ npm install -g vilvona
43
+ vilvona
50
44
  ```
51
45
 
52
- Set your Anthropic API key (get one free at [console.anthropic.com](https://console.anthropic.com)):
46
+ Set your API key and start:
53
47
 
54
48
  ```bash
55
49
  export ANTHROPIC_API_KEY=sk-ant-...
56
50
  npx vilvona
57
51
  ```
58
52
 
59
- Open **http://localhost:4000** in your browser. That's it.
53
+ Open **http://localhost:4000** in your browser.
60
54
 
61
- > **Mobile:** Open http://your-ip:4000 on your phone and tap "Add to Home Screen" to install as a PWA app.
55
+ > **Mobile:** Open `http://your-machine-ip:4000` on your phone and tap "Add to Home Screen" to install as a PWA.
62
56
 
63
57
  ---
64
58
 
65
- ## Features
59
+ ## What is Vilvona AI?
66
60
 
67
- ### Core
61
+ Vilvona AI is a self-hosted personal AI assistant that connects to all your apps — WhatsApp, Telegram, Slack, Gmail, Discord, Notion, GitHub, and 100+ more — from one clean interface.
68
62
 
69
- | Feature | Details |
70
- | -------------------- | --------------------------------------------------------------------------------------------------------------- |
71
- | **Claude Fable 5** | Default model — 1M context, computer use, best reasoning |
72
- | **21 Languages** | Tamil (தமிழ்), Hindi (हिन्दी), English, Chinese, Japanese, Korean, Arabic, French, German, Spanish, and 12 more |
73
- | **Mobile PWA** | Install as an app on iOS and Android directly from your browser |
74
- | **BYOK** | Bring your own Anthropic API key — Vilvona pays nothing, you pay per token directly |
75
- | **Self-hosted** | Runs entirely on your machine; no cloud, no accounts, no tracking |
76
- | **All integrations** | 100+ app connections inherited from OpenClaw |
63
+ Built on [OpenClaw](https://github.com/openclaw/openclaw) (MIT), with three key additions:
77
64
 
78
- ### AI Models
65
+ | Addition | Description |
66
+ | -------------------- | ---------------------------------------------------------------------------------------- |
67
+ | **Claude Fable 5** | Anthropic's most capable model as the default — 1M context, computer use, best reasoning |
68
+ | **Tamil & Hindi UI** | First AI assistant with native support for India's two major languages |
69
+ | **Mobile PWA** | Install on your phone from the browser — no app store needed |
79
70
 
80
- ```bash
81
- # Claude Fable 5 (default — most capable)
82
- export VILVONA_DEFAULT_MODEL=fable
71
+ ---
72
+
73
+ ## Features
74
+
75
+ ### AI Models
83
76
 
84
- # Claude Opus 4.8 (balanced)
85
- export VILVONA_DEFAULT_MODEL=opus
77
+ Vilvona AI uses Claude Fable 5 by default — the most capable model from Anthropic.
86
78
 
87
- # Claude Sonnet 4.6 (fast & affordable)
88
- export VILVONA_DEFAULT_MODEL=sonnet
79
+ ```bash
80
+ # Set via environment variable
81
+ export VILVONA_DEFAULT_MODEL=fable # Claude Fable 5 (default, most capable)
82
+ export VILVONA_DEFAULT_MODEL=opus # Claude Opus 4.8 (balanced)
83
+ export VILVONA_DEFAULT_MODEL=sonnet # Claude Sonnet 4.6 (fast, affordable)
89
84
  ```
90
85
 
91
- Or set in your config file:
86
+ Or in your config file (`~/.openclaw/config.json`):
92
87
 
93
88
  ```json
94
89
  {
@@ -108,11 +103,29 @@ Or set in your config file:
108
103
  | **Productivity** | Google Calendar, Google Drive, Dropbox |
109
104
  | **Developer** | GitHub, GitLab, webhooks, custom MCP servers |
110
105
 
106
+ ### Languages
107
+
108
+ Vilvona AI is the first AI assistant with native Tamil and Hindi UI:
109
+
110
+ | Language | Script | Code | Status |
111
+ | --------- | -------- | ------- | --------- |
112
+ | **Tamil** | தமிழ் | `ta` | Full UI |
113
+ | **Hindi** | हिन्दी | `hi` | Full UI |
114
+ | English | English | `en` | Default |
115
+ | Chinese | 中文 | `zh-CN` | Supported |
116
+ | Japanese | 日本語 | `ja-JP` | Supported |
117
+ | Korean | 한국어 | `ko` | Supported |
118
+ | Arabic | العربية | `ar` | Supported |
119
+ | French | Français | `fr` | Supported |
120
+ | German | Deutsch | `de` | Supported |
121
+ | Spanish | Español | `es` | Supported |
122
+ | + 11 more | — | — | Supported |
123
+
111
124
  ---
112
125
 
113
126
  ## Installation
114
127
 
115
- ### npx — no install needed
128
+ ### npx — recommended, no install
116
129
 
117
130
  ```bash
118
131
  npx vilvona
@@ -121,25 +134,29 @@ npx vilvona
121
134
  ### yarn
122
135
 
123
136
  ```bash
137
+ # Run without installing
124
138
  yarn dlx vilvona
125
139
 
126
- # or install globally
140
+ # Install globally
127
141
  yarn global add vilvona
128
142
  vilvona
129
143
  ```
130
144
 
145
+ > Requires Corepack: `corepack enable`
146
+
131
147
  ### pnpm
132
148
 
133
149
  ```bash
150
+ # Run without installing
134
151
  pnpm dlx vilvona
135
152
 
136
- # or install globally
153
+ # Install globally
137
154
  pnpm add -g vilvona
138
155
  vilvona
139
156
  ```
140
157
 
141
- > **Note:** `pnpm dlx` requires the package to be 2+ days old due to pnpm's supply-chain security.
142
- > If it fails, use `npx vilvona` or run: `pnpm config set minimumReleaseAge 0`
158
+ > If `pnpm dlx` fails on a brand-new release, use `npx vilvona` or run:
159
+ > `pnpm config set minimumReleaseAge 0`
143
160
 
144
161
  ### npm global
145
162
 
@@ -151,10 +168,32 @@ vilvona
151
168
  ### Docker
152
169
 
153
170
  ```bash
171
+ # Quick start
154
172
  docker run \
155
173
  -e ANTHROPIC_API_KEY=sk-ant-... \
156
174
  -p 4000:4000 \
157
- ghcr.io/vignesh2027/vilvona-ai:latest
175
+ ghcr.io/vignesh2027/vilvona-ai
176
+
177
+ # With Pro key
178
+ docker run \
179
+ -e ANTHROPIC_API_KEY=sk-ant-... \
180
+ -e VILVONA_PRO_KEY=VLVN-XXXX-XXXX-XXXX-XXXX \
181
+ -p 4000:4000 \
182
+ ghcr.io/vignesh2027/vilvona-ai
183
+
184
+ # With persistent data
185
+ docker run \
186
+ -e ANTHROPIC_API_KEY=sk-ant-... \
187
+ -v ~/.vilvona:/root/.openclaw \
188
+ -p 4000:4000 \
189
+ ghcr.io/vignesh2027/vilvona-ai
190
+ ```
191
+
192
+ ### Windows (PowerShell)
193
+
194
+ ```powershell
195
+ $env:ANTHROPIC_API_KEY = "sk-ant-..."
196
+ npx vilvona
158
197
  ```
159
198
 
160
199
  ### Build from source
@@ -163,49 +202,54 @@ docker run \
163
202
  git clone https://github.com/vignesh2027/Vilvona-AI.git
164
203
  cd Vilvona-AI
165
204
  node --version # Must be 22+
166
- pnpm install
167
- pnpm dev
205
+ node openclaw.mjs
168
206
  ```
169
207
 
170
- > **Requires Node.js 22+.** If you have nvm: `nvm install 22 && nvm use 22`
208
+ > Requires Node.js 22.19+. Use nvm: `nvm install 22 && nvm use 22`
171
209
 
172
210
  ---
173
211
 
174
212
  ## Mobile PWA
175
213
 
176
- Vilvona AI works as a full mobile app — no App Store, no Play Store needed.
214
+ Vilvona AI works as a full mobile app — no App Store, no Play Store.
177
215
 
178
- **On iPhone (Safari):**
216
+ **iPhone (Safari):**
179
217
 
180
- 1. Open `http://your-machine-ip:4000`
218
+ 1. Open `http://your-machine-ip:4000` in Safari
181
219
  2. Tap the share icon → **Add to Home Screen**
182
220
  3. Vilvona AI is now on your home screen
183
221
 
184
- **On Android (Chrome):**
222
+ **Android (Chrome):**
185
223
 
186
- 1. Open `http://your-machine-ip:4000`
187
- 2. Tap the menu → **Install app**
224
+ 1. Open `http://your-machine-ip:4000` in Chrome
225
+ 2. Tap the three-dot menu → **Install app**
188
226
  3. Done
189
227
 
190
228
  ---
191
229
 
192
- ## Languages
230
+ ## Configuration
193
231
 
194
- Vilvona AI is the first AI assistant with built-in Tamil and Hindi UI:
232
+ Config file location: `~/.openclaw/config.json`
195
233
 
196
- | Language | Code | Status |
197
- | ------------------ | ------- | ------- |
198
- | Tamil (தமிழ்) | `ta` | Full UI |
199
- | Hindi (हिन्दी) | `hi` | Full UI |
200
- | English | `en` | Full UI |
201
- | Chinese Simplified | `zh-CN` | Full UI |
202
- | Japanese | `ja-JP` | Full UI |
203
- | Korean | `ko` | Full UI |
204
- | Arabic | `ar` | Full UI |
205
- | French | `fr` | Full UI |
206
- | German | `de` | Full UI |
207
- | Spanish | `es` | Full UI |
208
- | + 11 more | — | Full UI |
234
+ ```json
235
+ {
236
+ "defaults": {
237
+ "model": "anthropic/claude-fable-5"
238
+ },
239
+ "ui": {
240
+ "locale": "ta"
241
+ }
242
+ }
243
+ ```
244
+
245
+ ### Environment variables
246
+
247
+ | Variable | Description | Default |
248
+ | ----------------------- | -------------------------------------------- | ------- |
249
+ | `ANTHROPIC_API_KEY` | Your Anthropic API key (required) | — |
250
+ | `VILVONA_DEFAULT_MODEL` | Model alias: `fable`, `opus`, `sonnet` | `fable` |
251
+ | `VILVONA_PRO_KEY` | Pro license key (`VLVN-XXXX-XXXX-XXXX-XXXX`) | — |
252
+ | `OPENCLAW_PORT` | Port to listen on | `4000` |
209
253
 
210
254
  ---
211
255
 
@@ -215,19 +259,20 @@ Vilvona AI Pro unlocks enterprise and team features.
215
259
 
216
260
  | Feature | Free | Pro |
217
261
  | ------------------------------ | ---- | --- |
218
- | Claude Fable 5 | | |
219
- | All integrations | | |
220
- | Tamil & Hindi UI | | |
221
- | Mobile PWA | | |
222
- | Enterprise audit logs | — | |
223
- | Team config sync | — | |
224
- | Advanced analytics | — | |
225
- | Priority Fable 5 routing | — | |
226
- | Custom AI personas (unlimited) | — | |
227
- | Webhook & Zapier integrations | — | |
228
- | White-label branding | — | ✅ |
229
-
230
- **Get Pro — ₹4,100 one-time (~$49):** [vignesh2027.mojo.page/vilvona-ai-pro](https://vignesh2027.mojo.page/vilvona-ai-pro)
262
+ | Claude Fable 5 | Yes | Yes |
263
+ | All 100+ integrations | Yes | Yes |
264
+ | Tamil & Hindi UI | Yes | Yes |
265
+ | Mobile PWA | Yes | Yes |
266
+ | Enterprise audit logs | — | Yes |
267
+ | Team config sync | — | Yes |
268
+ | Priority Fable 5 routing | — | Yes |
269
+ | Custom AI personas (unlimited) | — | Yes |
270
+ | Webhook & Zapier integrations | — | Yes |
271
+ | White-label branding | — | Yes |
272
+
273
+ **One-time payment — ₹4,100 (~$49):** [vignesh2027.mojo.page/vilvona-ai-pro](https://vignesh2027.mojo.page/vilvona-ai-pro)
274
+
275
+ After purchase, activate your key:
231
276
 
232
277
  ```bash
233
278
  export VILVONA_PRO_KEY=VLVN-XXXX-XXXX-XXXX-XXXX
@@ -236,104 +281,94 @@ vilvona
236
281
 
237
282
  ---
238
283
 
239
- ## Docker
284
+ ## How it works
240
285
 
241
- ```bash
242
- # Quick start
243
- docker run -e ANTHROPIC_API_KEY=sk-ant-... -p 4000:4000 ghcr.io/vignesh2027/vilvona-ai
286
+ ```
287
+ npx vilvona
288
+ └── openclaw.mjs (Vilvona launcher)
289
+ ├── Checks Node.js 22+ (shows clear error if older)
290
+ ├── Prints Vilvona banner
291
+ ├── Downloads openclaw runtime → ~/.vilvona/runtime/ (first run only, ~97MB)
292
+ ├── Sets OPENCLAW_DEFAULT_MODEL=anthropic/claude-fable-5
293
+ └── Launches openclaw runtime (opens UI at localhost:4000)
294
+ ```
244
295
 
245
- # With Pro key
246
- docker run \
247
- -e ANTHROPIC_API_KEY=sk-ant-... \
248
- -e VILVONA_PRO_KEY=VLVN-XXXX-XXXX-XXXX-XXXX \
249
- -p 4000:4000 \
250
- ghcr.io/vignesh2027/vilvona-ai
296
+ The first run downloads the OpenClaw runtime (~97MB) to `~/.vilvona/runtime/`. Subsequent runs start instantly from cache.
251
297
 
252
- # With persistent data
253
- docker run \
254
- -e ANTHROPIC_API_KEY=sk-ant-... \
255
- -v ~/.vilvona:/root/.openclaw \
256
- -p 4000:4000 \
257
- ghcr.io/vignesh2027/vilvona-ai
258
- ```
298
+ ---
299
+
300
+ ## Why Vilvona AI vs OpenClaw?
301
+
302
+ | | Vilvona AI | OpenClaw |
303
+ | ----------------- | ---------------------------------------------- | ------------- |
304
+ | Default AI model | Claude Fable 5 (latest) | Varies |
305
+ | Tamil language UI | Built-in | Not supported |
306
+ | Hindi language UI | Built-in | Not supported |
307
+ | Mobile PWA | Enhanced manifest | Basic |
308
+ | Pro tier | Enterprise features | None |
309
+ | npm package | `npx vilvona` | Source only |
310
+ | Maintained by | [@vignesh2027](https://github.com/vignesh2027) | OpenClaw team |
259
311
 
260
312
  ---
261
313
 
262
- ## Configuration
314
+ ## npm + GitHub Actions Auto-Release
263
315
 
264
- Vilvona AI stores its config at `~/.openclaw/config.json`:
316
+ When you push a version tag, GitHub Actions automatically publishes to npm:
265
317
 
266
- ```json
267
- {
268
- "defaults": {
269
- "model": "anthropic/claude-fable-5"
270
- },
271
- "ui": {
272
- "locale": "ta"
273
- }
274
- }
318
+ ```bash
319
+ # Update version, commit, push tag — npm publishes automatically
320
+ npm version patch # bumps to next version
321
+ git push origin main --follow-tags
275
322
  ```
276
323
 
277
- **Environment variables:**
324
+ The `release.yml` workflow:
278
325
 
279
- | Variable | Description |
280
- | ----------------------- | ---------------------------------------------------- |
281
- | `ANTHROPIC_API_KEY` | Your Anthropic API key (required) |
282
- | `VILVONA_DEFAULT_MODEL` | Default model: `fable`, `opus`, `sonnet` |
283
- | `VILVONA_PRO_KEY` | Pro license key (format: `VLVN-XXXX-XXXX-XXXX-XXXX`) |
284
- | `OPENCLAW_PORT` | Port to run on (default: `4000`) |
326
+ 1. Runs on any `v*` tag push
327
+ 2. Validates package.json and launcher
328
+ 3. Publishes to npm with `--access public`
329
+ 4. Creates a GitHub Release with install instructions
285
330
 
286
331
  ---
287
332
 
288
- ## Why Vilvona vs OpenClaw?
333
+ ## Contributing
289
334
 
290
- | | Vilvona AI | OpenClaw |
291
- | -------------- | ---------------------------------------------- | ------------- |
292
- | Default model | Claude Fable 5 | Varies |
293
- | Tamil language | Built-in | Not supported |
294
- | Hindi language | Built-in | Not supported |
295
- | Mobile PWA | Enhanced | Basic |
296
- | Pro tier | Included | None |
297
- | Maintained by | [@vignesh2027](https://github.com/vignesh2027) | OpenClaw team |
335
+ Vilvona AI is built and maintained by **Vignesh S**. Found a bug or have a feature request? [Open an issue](https://github.com/vignesh2027/Vilvona-AI/issues).
298
336
 
299
337
  ---
300
338
 
301
- ## Sponsors
339
+ ## Support & Sponsorship
302
340
 
303
- Vilvona AI is free and open source. If it saves you time, consider sponsoring:
341
+ If Vilvona AI saves you time, consider supporting:
304
342
 
305
- [![GitHub Sponsors](https://img.shields.io/badge/Sponsor%20on-GitHub-ea4aaa?logo=github)](https://github.com/sponsors/vignesh2027)
306
- [![Get Pro](https://img.shields.io/badge/Get-Pro%20License-orange)](https://vignesh2027.mojo.page/vilvona-ai-pro)
343
+ [![Sponsor on GitHub](https://img.shields.io/badge/Sponsor%20on-GitHub-ea4aaa?logo=github)](https://github.com/sponsors/vignesh2027)
344
+ [![Get Pro License](https://img.shields.io/badge/Get-Pro%20License-15803d)](https://vignesh2027.mojo.page/vilvona-ai-pro)
307
345
 
308
346
  ---
309
347
 
310
- ## Reporting Issues
348
+ ## Changelog
311
349
 
312
- Found a bug? [Open an issue](https://github.com/vignesh2027/Vilvona-AI/issues)
350
+ See [CHANGELOG.md](CHANGELOG.md) for version history.
313
351
 
314
352
  ---
315
353
 
316
354
  ## License
317
355
 
318
- [MIT](LICENSE) — free to use, modify, and distribute.
356
+ [MIT](LICENSE) — free to use, modify, and redistribute.
319
357
 
320
- Built on [OpenClaw](https://openclaw.ai) (MIT). All OpenClaw contributors are credited in [UPSTREAM.md](UPSTREAM.md).
321
-
322
- ---
323
-
324
- ## Built by
325
-
326
- **Vignesh S** — [github.com/vignesh2027](https://github.com/vignesh2027)
327
-
328
- CSE student at Takshashila University, Chennai.
329
- Building tools that make AI accessible for everyone — especially in Tamil and Hindi.
358
+ Built on [OpenClaw](https://github.com/openclaw/openclaw) (MIT). Attribution in [UPSTREAM.md](UPSTREAM.md).
330
359
 
331
360
  ---
332
361
 
333
362
  <div align="center">
334
363
 
335
- **If Vilvona AI helped you, please star this repo**
364
+ **If Vilvona AI helped you, please star this repo**
365
+
366
+ [Docs](https://vignesh2027.github.io/Vilvona-AI) &nbsp;·&nbsp;
367
+ [Report a Bug](https://github.com/vignesh2027/Vilvona-AI/issues) &nbsp;·&nbsp;
368
+ [Get Pro](https://vignesh2027.mojo.page/vilvona-ai-pro) &nbsp;·&nbsp;
369
+ [Sponsor](https://github.com/sponsors/vignesh2027)
336
370
 
337
- [Report Bug](https://github.com/vignesh2027/Vilvona-AI/issues) · [Request Feature](https://github.com/vignesh2027/Vilvona-AI/issues) · [Get Pro](https://vignesh2027.mojo.page/vilvona-ai-pro) · [Sponsor](https://github.com/sponsors/vignesh2027)
371
+ Built by **Vignesh S** CSE student at Takshashila University, Chennai.
372
+ Building AI tools accessible to everyone, especially in Tamil and Hindi.
338
373
 
339
374
  </div>