zeta-assistant 0.2.0 → 0.7.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.
- package/LICENSE +22 -0
- package/README.md +34 -5
- package/package.json +10 -6
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Zeta Assistant Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
CHANGED
|
@@ -38,11 +38,7 @@ The assistant runs **only while the terminal is open**. No cloud, no webhooks, n
|
|
|
38
38
|
OPEN_AI_API_KEY=sk-... npx zeta-assistant
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
npx zeta-assistant --OPEN_AI_API_KEY=sk-...
|
|
45
|
-
```
|
|
41
|
+
> ⚠️ **Security:** Always prefer the env var method above. Passing the key via `--OPEN_AI_API_KEY=` flag exposes it in `ps aux` to other users on the same machine.
|
|
46
42
|
|
|
47
43
|
### Option 2: Clone and run with npm
|
|
48
44
|
|
|
@@ -210,6 +206,26 @@ npm run format
|
|
|
210
206
|
|
|
211
207
|
---
|
|
212
208
|
|
|
209
|
+
## Releases
|
|
210
|
+
|
|
211
|
+
Releases are fully automated via GitHub Actions. When a **PR is merged into `main`**:
|
|
212
|
+
|
|
213
|
+
1. CI runs lint, type check, and build
|
|
214
|
+
2. Version is bumped (minor)
|
|
215
|
+
3. `CHANGELOG.md` is generated with all commits since the last release
|
|
216
|
+
4. A git tag is created (`v0.3.0`, `v0.4.0`, etc.)
|
|
217
|
+
5. The package is published to [npm](https://www.npmjs.com/package/zeta-assistant)
|
|
218
|
+
|
|
219
|
+
No manual steps required. Just merge and it ships.
|
|
220
|
+
|
|
221
|
+
### Required GitHub Secrets
|
|
222
|
+
|
|
223
|
+
| Secret | Where to get it |
|
|
224
|
+
|---|---|
|
|
225
|
+
| `NPM_TOKEN` | [npmjs.com → Access Tokens → Generate New Token (Automation)](https://www.npmjs.com/settings/~/tokens) |
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
213
229
|
## Roadmap
|
|
214
230
|
|
|
215
231
|
| Phase | Goal | Status |
|
|
@@ -231,6 +247,19 @@ npm run format
|
|
|
231
247
|
|
|
232
248
|
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for coding standards, naming conventions, testing requirements, and best practices.
|
|
233
249
|
|
|
250
|
+
### How to Help
|
|
251
|
+
|
|
252
|
+
The best way to contribute is to **use Zeta Assistant and report issues through it**:
|
|
253
|
+
|
|
254
|
+
1. Run the assistant:
|
|
255
|
+
```bash
|
|
256
|
+
OPEN_AI_API_KEY=sk-... npx zeta-assistant
|
|
257
|
+
```
|
|
258
|
+
2. Use it normally — send messages, ask it to run commands, explore its limits.
|
|
259
|
+
3. When something breaks or behaves unexpectedly, **send a WhatsApp audio or text message describing the problem**. This way we collect real-world issues from actual usage and can fix them for everyone at once.
|
|
260
|
+
|
|
261
|
+
The more people running Zeta in different environments and use cases, the faster we catch edge cases and improve the assistant for all users.
|
|
262
|
+
|
|
234
263
|
---
|
|
235
264
|
|
|
236
265
|
## License
|
package/package.json
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zeta-assistant",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"description": "A locally running AI operator controlled via WhatsApp Web",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/shadebit/zeta-assistant"
|
|
8
|
+
},
|
|
5
9
|
"type": "module",
|
|
6
10
|
"main": "./dist/index.js",
|
|
7
11
|
"types": "./dist/index.d.ts",
|
|
@@ -24,10 +28,10 @@
|
|
|
24
28
|
"start": "node dist/main.js",
|
|
25
29
|
"test": "node --experimental-vm-modules node_modules/.bin/jest",
|
|
26
30
|
"test:coverage": "node --experimental-vm-modules node_modules/.bin/jest --coverage",
|
|
27
|
-
"lint": "eslint src/
|
|
28
|
-
"lint:fix": "eslint src/
|
|
29
|
-
"format": "prettier --write \"src/**/*.ts\"
|
|
30
|
-
"format:check": "prettier --check \"src/**/*.ts\"
|
|
31
|
+
"lint": "eslint src/",
|
|
32
|
+
"lint:fix": "eslint src/ --fix",
|
|
33
|
+
"format": "prettier --write \"src/**/*.ts\"",
|
|
34
|
+
"format:check": "prettier --check \"src/**/*.ts\"",
|
|
31
35
|
"typecheck": "tsc --noEmit",
|
|
32
36
|
"prepare": "husky",
|
|
33
37
|
"prepack": "npm run build"
|
|
@@ -51,7 +55,7 @@
|
|
|
51
55
|
"winston": "3.19.0"
|
|
52
56
|
},
|
|
53
57
|
"devDependencies": {
|
|
54
|
-
"@types/jest": "
|
|
58
|
+
"@types/jest": "29.5.14",
|
|
55
59
|
"@types/node": "22.13.4",
|
|
56
60
|
"@typescript-eslint/eslint-plugin": "8.24.0",
|
|
57
61
|
"@typescript-eslint/parser": "8.24.0",
|