clankie 0.2.2 → 0.2.3
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 +17 -16
- package/dist/cli.js +301851 -0
- package/dist/koffi-216xhpes.node +0 -0
- package/dist/koffi-2erktc37.node +0 -0
- package/dist/koffi-2rrez93a.node +0 -0
- package/dist/koffi-2wv0r22g.node +0 -0
- package/dist/koffi-3kae4xj3.node +0 -0
- package/dist/koffi-3rkr2zqv.node +0 -0
- package/dist/koffi-abxfktv9.node +0 -0
- package/dist/koffi-c67c0c5b.node +0 -0
- package/dist/koffi-cnf0q0dx.node +0 -0
- package/dist/koffi-df38sqz5.node +0 -0
- package/dist/koffi-gfbqb3a0.node +0 -0
- package/dist/koffi-kjemmmem.node +0 -0
- package/dist/koffi-kkrfq9yv.node +0 -0
- package/dist/koffi-mzaqwwqy.node +0 -0
- package/dist/koffi-q49fgkeq.node +0 -0
- package/dist/koffi-q54bk8bf.node +0 -0
- package/dist/koffi-x1790w0j.node +0 -0
- package/dist/koffi-yxvjwcj6.node +0 -0
- package/package.json +8 -7
- package/web-ui-dist/_shell.html +1 -1
- package/src/agent.ts +0 -118
- package/src/channels/channel.ts +0 -57
- package/src/channels/slack.ts +0 -376
- package/src/channels/web.ts +0 -1375
- package/src/cli.ts +0 -505
- package/src/config.ts +0 -261
- package/src/daemon.ts +0 -380
- package/src/extensions/workspace-jail.ts +0 -171
- package/src/service.ts +0 -374
- package/src/sessions.ts +0 -262
package/README.md
CHANGED
|
@@ -15,12 +15,12 @@ A minimal AI assistant that lives in Slack. Built on [pi](https://github.com/bad
|
|
|
15
15
|
|
|
16
16
|
### 1. Install Dependencies
|
|
17
17
|
|
|
18
|
-
**Runtime:** [Node.js](https://nodejs.org)
|
|
19
|
-
**Build:** [Bun](https://bun.sh) (for
|
|
18
|
+
**Runtime:** [Node.js](https://nodejs.org) v18+
|
|
19
|
+
**Build:** [Bun](https://bun.sh) v1.0+ (for bundling and building web-ui)
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
22
|
# Check Node version
|
|
23
|
-
node --version # Should be >=
|
|
23
|
+
node --version # Should be >= v18.0.0
|
|
24
24
|
|
|
25
25
|
# Install Bun (if not already installed)
|
|
26
26
|
curl -fsSL https://bun.sh/install | bash
|
|
@@ -46,9 +46,9 @@ npm install
|
|
|
46
46
|
npm link
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Now `clankie` is available from anywhere. If you skip `npm link`, use `
|
|
49
|
+
Now `clankie` is available from anywhere. If you skip `npm link`, use `bun src/cli.ts` (dev) or `node dist/cli.js` (built) instead of `clankie`.
|
|
50
50
|
|
|
51
|
-
**Note:** Bun
|
|
51
|
+
**Note:** Bun bundles TypeScript code into JavaScript that runs on Node.js v18+.
|
|
52
52
|
|
|
53
53
|
## Slack Setup
|
|
54
54
|
|
|
@@ -296,22 +296,23 @@ Logs are stored in `~/.clankie/logs/daemon.log`.
|
|
|
296
296
|
## Development
|
|
297
297
|
|
|
298
298
|
```bash
|
|
299
|
-
# Run directly with
|
|
300
|
-
|
|
301
|
-
|
|
299
|
+
# Run directly with Bun (no build step)
|
|
300
|
+
bun src/cli.ts chat
|
|
301
|
+
bun src/cli.ts send "hello"
|
|
302
302
|
|
|
303
|
-
# Or use
|
|
304
|
-
|
|
305
|
-
|
|
303
|
+
# Or use bun scripts
|
|
304
|
+
bun run dev chat
|
|
305
|
+
bun run dev send "hello"
|
|
306
|
+
|
|
307
|
+
# Build for production
|
|
308
|
+
bun run build # Bundles TypeScript → JavaScript for Node.js
|
|
306
309
|
|
|
307
310
|
# Code quality checks
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
+
bun run check # Run linter
|
|
312
|
+
bun run check:fix # Auto-fix issues
|
|
313
|
+
bun run format # Format code
|
|
311
314
|
```
|
|
312
315
|
|
|
313
|
-
**Note:** Bun is used for package installation and building the web-ui. The runtime requires Node.js v22.6.0+ with native TypeScript support.
|
|
314
|
-
|
|
315
316
|
## Troubleshooting
|
|
316
317
|
|
|
317
318
|
### Bot doesn't respond in threads
|