alvin-bot 4.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.
- package/.env.example +43 -0
- package/BACKLOG.md +223 -0
- package/CHANGELOG.md +63 -0
- package/CLAUDE.example.md +152 -0
- package/CODE_OF_CONDUCT.md +52 -0
- package/CONTRIBUTING.md +72 -0
- package/LICENSE +21 -0
- package/README.md +529 -0
- package/SECURITY.md +38 -0
- package/SOUL.example.md +60 -0
- package/TOOLS.example.md +42 -0
- package/alvin-bot.config.example.json +24 -0
- package/bin/cli.js +1088 -0
- package/dist/.metadata_never_index +0 -0
- package/dist/claude.js +102 -0
- package/dist/config.js +65 -0
- package/dist/engine.js +90 -0
- package/dist/find-claude-binary.js +98 -0
- package/dist/handlers/commands.js +1489 -0
- package/dist/handlers/document.js +187 -0
- package/dist/handlers/message.js +200 -0
- package/dist/handlers/photo.js +154 -0
- package/dist/handlers/platform-message.js +275 -0
- package/dist/handlers/video.js +237 -0
- package/dist/handlers/voice.js +148 -0
- package/dist/i18n.js +299 -0
- package/dist/index.js +442 -0
- package/dist/init-data-dir.js +81 -0
- package/dist/middleware/auth.js +215 -0
- package/dist/migrate.js +139 -0
- package/dist/paths.js +87 -0
- package/dist/platforms/discord.js +161 -0
- package/dist/platforms/index.js +130 -0
- package/dist/platforms/signal.js +205 -0
- package/dist/platforms/slack.js +318 -0
- package/dist/platforms/telegram.js +111 -0
- package/dist/platforms/types.js +8 -0
- package/dist/platforms/whatsapp.js +648 -0
- package/dist/providers/claude-sdk-provider.js +173 -0
- package/dist/providers/codex-cli-provider.js +121 -0
- package/dist/providers/index.js +7 -0
- package/dist/providers/openai-compatible.js +388 -0
- package/dist/providers/registry.js +209 -0
- package/dist/providers/tool-executor.js +450 -0
- package/dist/providers/types.js +205 -0
- package/dist/services/access.js +144 -0
- package/dist/services/asset-index.js +230 -0
- package/dist/services/browser-manager.js +161 -0
- package/dist/services/browser.js +121 -0
- package/dist/services/compaction.js +129 -0
- package/dist/services/cron.js +462 -0
- package/dist/services/custom-tools.js +317 -0
- package/dist/services/delivery-queue.js +154 -0
- package/dist/services/elevenlabs.js +58 -0
- package/dist/services/embeddings.js +386 -0
- package/dist/services/exec-guard.js +46 -0
- package/dist/services/fallback-order.js +151 -0
- package/dist/services/heartbeat.js +192 -0
- package/dist/services/hooks.js +44 -0
- package/dist/services/imagegen.js +72 -0
- package/dist/services/language-detect.js +144 -0
- package/dist/services/markdown.js +63 -0
- package/dist/services/mcp.js +252 -0
- package/dist/services/memory.js +133 -0
- package/dist/services/personality.js +227 -0
- package/dist/services/plugins.js +171 -0
- package/dist/services/reminders.js +97 -0
- package/dist/services/restart.js +48 -0
- package/dist/services/security-audit.js +66 -0
- package/dist/services/self-search.js +129 -0
- package/dist/services/session.js +93 -0
- package/dist/services/skills.js +287 -0
- package/dist/services/standing-orders.js +29 -0
- package/dist/services/subagents.js +142 -0
- package/dist/services/sudo.js +243 -0
- package/dist/services/telegram.js +113 -0
- package/dist/services/tool-discovery.js +214 -0
- package/dist/services/usage-tracker.js +137 -0
- package/dist/services/users.js +199 -0
- package/dist/services/voice.js +95 -0
- package/dist/tui/index.js +507 -0
- package/dist/web/canvas.js +30 -0
- package/dist/web/doctor-api.js +606 -0
- package/dist/web/openai-compat.js +252 -0
- package/dist/web/server.js +1351 -0
- package/dist/web/setup-api.js +1078 -0
- package/docs/mcp.example.json +16 -0
- package/docs/screenshots/00-Login.png +0 -0
- package/docs/screenshots/01-Chat-Dark-Conversation.png +0 -0
- package/docs/screenshots/02-Chat.png +0 -0
- package/docs/screenshots/03-Dashboard-Overview.png +0 -0
- package/docs/screenshots/04-AI-Models-and-Providers.png +0 -0
- package/docs/screenshots/05-Personality-Editor.png +0 -0
- package/docs/screenshots/06-Memory-Manager.png +0 -0
- package/docs/screenshots/07-Active-Sessions.png +0 -0
- package/docs/screenshots/08-File-Browser.png +0 -0
- package/docs/screenshots/09-Scheduled-Jobs.png +0 -0
- package/docs/screenshots/10-Custom-Tools.png +0 -0
- package/docs/screenshots/11-Plugins-and-MCP.png +0 -0
- package/docs/screenshots/12-Messaging-Platforms.png +0 -0
- package/docs/screenshots/12.1-Messaging-Platforms-WhatsApp-Groups-List.png +0 -0
- package/docs/screenshots/12.2-Messaging-Platforms-WA-Group-Details.png +0 -0
- package/docs/screenshots/13-User-Management.png +0 -0
- package/docs/screenshots/14-Web-Terminal.png +0 -0
- package/docs/screenshots/15-Maintenance-and-Health.png +0 -0
- package/docs/screenshots/16-Settings-and-Env.png +0 -0
- package/docs/screenshots/TG-commands.png +0 -0
- package/docs/screenshots/TG.png +0 -0
- package/docs/screenshots/_Mac-Installer.png +0 -0
- package/docs/tools.example.json +33 -0
- package/install.sh +165 -0
- package/package.json +190 -0
- package/plugins/calendar/index.js +270 -0
- package/plugins/email/index.js +231 -0
- package/plugins/finance/index.js +254 -0
- package/plugins/notes/index.js +227 -0
- package/plugins/smarthome/index.js +230 -0
- package/plugins/weather/index.js +122 -0
- package/skills/apple-notes/SKILL.md +31 -0
- package/skills/browse/SKILL.md +136 -0
- package/skills/code-project/SKILL.md +43 -0
- package/skills/data-analysis/SKILL.md +39 -0
- package/skills/document-creation/SKILL.md +48 -0
- package/skills/email-summary/SKILL.md +46 -0
- package/skills/github/SKILL.md +42 -0
- package/skills/summarize/SKILL.md +28 -0
- package/skills/system-admin/SKILL.md +39 -0
- package/skills/weather/SKILL.md +34 -0
- package/skills/web-research/SKILL.md +35 -0
- package/web/public/canvas.html +52 -0
- package/web/public/css/style.css +555 -0
- package/web/public/index.html +189 -0
- package/web/public/js/app.js +3102 -0
- package/web/public/js/i18n.js +1048 -0
- package/web/public/js/icons.js +104 -0
- package/web/public/login.html +48 -0
package/README.md
ADDED
|
@@ -0,0 +1,529 @@
|
|
|
1
|
+
# 🤖 Alvin Bot — Autonomous AI Agent
|
|
2
|
+
|
|
3
|
+
> Your personal AI assistant — on Telegram, WhatsApp, Discord, Signal, Terminal, and Web.
|
|
4
|
+
|
|
5
|
+
Alvin Bot is an open-source, self-hosted AI agent that lives where you chat. Built on a multi-model engine with full system access, memory, plugins, and a rich web dashboard. Not just a chatbot — an autonomous agent that remembers, acts, and learns.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 📸 Preview
|
|
11
|
+
|
|
12
|
+
<table>
|
|
13
|
+
<tr>
|
|
14
|
+
<td align="center"><b>💬 Chat (Dark Mode)</b><br><img src="docs/screenshots/01-Chat-Dark-Conversation.png" width="400"></td>
|
|
15
|
+
<td align="center"><b>📊 Dashboard</b><br><img src="docs/screenshots/03-Dashboard-Overview.png" width="400"></td>
|
|
16
|
+
</tr>
|
|
17
|
+
<tr>
|
|
18
|
+
<td align="center"><b>🤖 AI Models & Providers</b><br><img src="docs/screenshots/04-AI-Models-and-Providers.png" width="400"></td>
|
|
19
|
+
<td align="center"><b>🎭 Personality Editor</b><br><img src="docs/screenshots/05-Personality-Editor.png" width="400"></td>
|
|
20
|
+
</tr>
|
|
21
|
+
<tr>
|
|
22
|
+
<td align="center"><b>💬 Telegram</b><br><img src="docs/screenshots/TG.png" width="400"></td>
|
|
23
|
+
<td align="center"><b>📱 Messaging Platforms</b><br><img src="docs/screenshots/12-Messaging-Platforms.png" width="400"></td>
|
|
24
|
+
</tr>
|
|
25
|
+
<tr>
|
|
26
|
+
<td align="center"><b>🔧 Custom Tools</b><br><img src="docs/screenshots/10-Custom-Tools.png" width="400"></td>
|
|
27
|
+
<td align="center"><b>🩺 Health & Maintenance</b><br><img src="docs/screenshots/15-Maintenance-and-Health.png" width="400"></td>
|
|
28
|
+
</tr>
|
|
29
|
+
</table>
|
|
30
|
+
|
|
31
|
+
<details>
|
|
32
|
+
<summary><b>🖼️ More Screenshots</b> (click to expand)</summary>
|
|
33
|
+
<br>
|
|
34
|
+
|
|
35
|
+
| Feature | Screenshot |
|
|
36
|
+
|---------|-----------|
|
|
37
|
+
| Login | <img src="docs/screenshots/00-Login.png" width="500"> |
|
|
38
|
+
| Chat (Light) | <img src="docs/screenshots/02-Chat.png" width="500"> |
|
|
39
|
+
| Memory Manager | <img src="docs/screenshots/06-Memory-Manager.png" width="500"> |
|
|
40
|
+
| Active Sessions | <img src="docs/screenshots/07-Active-Sessions.png" width="500"> |
|
|
41
|
+
| File Browser | <img src="docs/screenshots/08-File-Browser.png" width="500"> |
|
|
42
|
+
| Scheduled Jobs | <img src="docs/screenshots/09-Scheduled-Jobs.png" width="500"> |
|
|
43
|
+
| Plugins & MCP | <img src="docs/screenshots/11-Plugins-and-MCP.png" width="500"> |
|
|
44
|
+
| WhatsApp Groups | <img src="docs/screenshots/12.1-Messaging-Platforms-WhatsApp-Groups-List.png" width="500"> |
|
|
45
|
+
| WA Group Details | <img src="docs/screenshots/12.2-Messaging-Platforms-WA-Group-Details.png" width="500"> |
|
|
46
|
+
| User Management | <img src="docs/screenshots/13-User-Management.png" width="500"> |
|
|
47
|
+
| Web Terminal | <img src="docs/screenshots/14-Web-Terminal.png" width="500"> |
|
|
48
|
+
| Settings & Env | <img src="docs/screenshots/16-Settings-and-Env.png" width="500"> |
|
|
49
|
+
| Telegram Commands | <img src="docs/screenshots/TG-commands.png" width="500"> |
|
|
50
|
+
| macOS Installer | <img src="docs/screenshots/_Mac-Installer.png" width="500"> |
|
|
51
|
+
|
|
52
|
+
</details>
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
## ✨ Features
|
|
58
|
+
|
|
59
|
+
### 🧠 Intelligence
|
|
60
|
+
- **Multi-Model Engine** — Claude (Agent SDK with full tool use), OpenAI, Groq, NVIDIA NIM, Google Gemini, OpenRouter, or any OpenAI-compatible API
|
|
61
|
+
- **Automatic Fallback** — If one provider fails, seamlessly tries the next
|
|
62
|
+
- **Heartbeat Monitor** — Pings providers every 5 minutes, auto-failover after 2 failures, auto-recovery
|
|
63
|
+
- **User-Configurable Fallback Order** — Rearrange provider priority via Telegram (`/fallback`), Web UI, or API
|
|
64
|
+
- **Adjustable Thinking** — From quick answers (`/effort low`) to deep analysis (`/effort max`)
|
|
65
|
+
- **Persistent Memory** — Remembers across sessions via vector-indexed knowledge base
|
|
66
|
+
- **Smart Tool Discovery** — Scans your system at startup, knows exactly what CLI tools, plugins, and APIs are available
|
|
67
|
+
- **Skill System** — 6 built-in SKILL.md files (code, data analysis, email, docs, research, sysadmin) auto-activate based on message context
|
|
68
|
+
- **Self-Awareness** — Knows it IS the AI model — won't call external APIs for tasks it can do itself
|
|
69
|
+
- **Automatic Language Detection** — Detects user language (EN/DE) and adapts; learns preference over time
|
|
70
|
+
|
|
71
|
+
### 💬 Multi-Platform
|
|
72
|
+
- **Telegram** — Full-featured with streaming, inline keyboards, voice, photos, documents
|
|
73
|
+
- **WhatsApp** — Via WhatsApp Web: self-chat as AI notepad, group whitelist with per-contact access control, full media support (photos, docs, audio, video)
|
|
74
|
+
- **WhatsApp Group Approval** — Owner gets approval requests via Telegram (or WhatsApp DM fallback) before the bot responds to group messages. Silent — group members see nothing.
|
|
75
|
+
- **Discord** — Server bot with mention/reply detection, slash commands
|
|
76
|
+
- **Signal** — Via signal-cli REST API with voice transcription
|
|
77
|
+
- **Terminal** — Rich TUI with ANSI colors and streaming (`alvin-bot tui`)
|
|
78
|
+
- **Web UI** — Full dashboard with chat, settings, file manager, terminal
|
|
79
|
+
|
|
80
|
+
### 🔧 Capabilities
|
|
81
|
+
- **52+ Built-in Tools** — Shell, files, email, screenshots, PDF, media, git, system control
|
|
82
|
+
- **Plugin System** — 6 built-in plugins (weather, finance, notes, calendar, email, smarthome)
|
|
83
|
+
- **MCP Client** — Connect any Model Context Protocol server
|
|
84
|
+
- **Cron Jobs** — Scheduled tasks with AI-driven creation ("check my email every morning")
|
|
85
|
+
- **Voice** — Speech-to-text (Groq Whisper) + text-to-speech (Edge TTS)
|
|
86
|
+
- **Vision** — Photo analysis, document scanning, screenshot understanding
|
|
87
|
+
- **Image Generation** — Via Google Gemini / DALL·E (with API key)
|
|
88
|
+
- **Web Browsing** — Fetch and summarize web pages
|
|
89
|
+
|
|
90
|
+
### 🖥️ Web Dashboard
|
|
91
|
+
- **Live Chat** — WebSocket streaming, same experience as Telegram
|
|
92
|
+
- **Model Switcher** — Change AI models on the fly
|
|
93
|
+
- **Platform Setup** — Configure all messengers and providers via UI, WhatsApp group management inline
|
|
94
|
+
- **File Manager** — Browse, edit, create files in the working directory
|
|
95
|
+
- **Memory Editor** — View and edit the agent's knowledge base
|
|
96
|
+
- **Session Browser** — Inspect conversation history
|
|
97
|
+
- **Terminal** — Run commands directly from the browser
|
|
98
|
+
- **Maintenance** — Health checks, backups, bot controls
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 🚀 Quick Start
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
npm install -g alvin-bot
|
|
106
|
+
alvin-bot setup
|
|
107
|
+
alvin-bot start
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
That's it. The setup wizard validates everything:
|
|
111
|
+
- ✅ Tests your AI provider key
|
|
112
|
+
- ✅ Verifies your Telegram bot token
|
|
113
|
+
- ✅ Confirms the setup works before you start
|
|
114
|
+
|
|
115
|
+
**Requires:** Node.js 18+ ([nodejs.org](https://nodejs.org)) · Telegram bot token ([@BotFather](https://t.me/BotFather)) · Your Telegram user ID ([@userinfobot](https://t.me/userinfobot))
|
|
116
|
+
|
|
117
|
+
Free AI providers available — no credit card needed.
|
|
118
|
+
|
|
119
|
+
### AI Providers
|
|
120
|
+
|
|
121
|
+
| Provider | Cost | Best for |
|
|
122
|
+
|----------|------|----------|
|
|
123
|
+
| **Groq** | Free | Getting started fast |
|
|
124
|
+
| **Google Gemini** | Free | Image understanding, embeddings |
|
|
125
|
+
| **NVIDIA NIM** | Free | Tool use, 150+ models |
|
|
126
|
+
| OpenAI | Paid | GPT-4o quality |
|
|
127
|
+
| OpenRouter | Paid | 100+ models marketplace |
|
|
128
|
+
| Claude SDK | Paid* | Full agent with tool use |
|
|
129
|
+
|
|
130
|
+
\*Claude SDK requires a [Claude Max](https://claude.ai) subscription ($20/mo) or Anthropic API access. The setup wizard checks this automatically.
|
|
131
|
+
|
|
132
|
+
### Alternative Installation
|
|
133
|
+
|
|
134
|
+
<details>
|
|
135
|
+
<summary>One-line install script (Linux/macOS)</summary>
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
curl -fsSL https://raw.githubusercontent.com/alvbln/Alvin-Bot/main/install.sh | bash
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Downloads, builds, and runs the setup wizard automatically.
|
|
142
|
+
</details>
|
|
143
|
+
|
|
144
|
+
<details>
|
|
145
|
+
<summary>Desktop App (macOS)</summary>
|
|
146
|
+
|
|
147
|
+
| Platform | Download | Architecture |
|
|
148
|
+
|----------|----------|-------------|
|
|
149
|
+
| macOS | [DMG](https://github.com/alvbln/Alvin-Bot/releases/latest) | Apple Silicon (M1+) |
|
|
150
|
+
| Windows | Coming soon | x64 |
|
|
151
|
+
| Linux | Coming soon | x64 |
|
|
152
|
+
|
|
153
|
+
The desktop app auto-starts the bot and provides a system tray icon with quick controls.
|
|
154
|
+
</details>
|
|
155
|
+
|
|
156
|
+
<details>
|
|
157
|
+
<summary>Docker</summary>
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
git clone https://github.com/alvbln/Alvin-Bot.git
|
|
161
|
+
cd Alvin-Bot
|
|
162
|
+
cp .env.example .env # Edit with your tokens
|
|
163
|
+
docker compose up -d
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Note: Claude SDK is not compatible with Docker (requires interactive CLI login).
|
|
167
|
+
</details>
|
|
168
|
+
|
|
169
|
+
<details>
|
|
170
|
+
<summary>From Source (contributors)</summary>
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
git clone https://github.com/alvbln/Alvin-Bot.git
|
|
174
|
+
cd Alvin-Bot
|
|
175
|
+
npm install
|
|
176
|
+
npm run build
|
|
177
|
+
node bin/cli.js setup # Interactive wizard
|
|
178
|
+
npm run dev # Start in dev mode
|
|
179
|
+
```
|
|
180
|
+
</details>
|
|
181
|
+
|
|
182
|
+
<details>
|
|
183
|
+
<summary>Production (PM2)</summary>
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
npm install -g pm2
|
|
187
|
+
pm2 start ecosystem.config.cjs
|
|
188
|
+
pm2 save && pm2 startup
|
|
189
|
+
```
|
|
190
|
+
</details>
|
|
191
|
+
|
|
192
|
+
### Troubleshooting
|
|
193
|
+
|
|
194
|
+
```bash
|
|
195
|
+
alvin-bot doctor # Check configuration & validate connections
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
If your AI provider isn't working, run `doctor` — it tests the actual API connection and shows exactly what's wrong.
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## 📋 Commands
|
|
203
|
+
|
|
204
|
+
| Command | Description |
|
|
205
|
+
|---------|-------------|
|
|
206
|
+
| `/help` | Show all commands |
|
|
207
|
+
| `/start` | Session status overview |
|
|
208
|
+
| `/new` | Fresh conversation (reset context) |
|
|
209
|
+
| `/model` | Switch AI model (inline keyboard) |
|
|
210
|
+
| `/effort <low\|medium\|high\|max>` | Set thinking depth |
|
|
211
|
+
| `/voice` | Toggle voice replies |
|
|
212
|
+
| `/imagine <prompt>` | Generate images |
|
|
213
|
+
| `/web <query>` | Search the web |
|
|
214
|
+
| `/remind <time> <text>` | Set reminders (e.g., `/remind 30m Call mom`) |
|
|
215
|
+
| `/cron` | Manage scheduled tasks |
|
|
216
|
+
| `/recall <query>` | Search memory |
|
|
217
|
+
| `/remember <text>` | Save to memory |
|
|
218
|
+
| `/export` | Export conversation |
|
|
219
|
+
| `/dir <path>` | Change working directory |
|
|
220
|
+
| `/status` | Current session & cost info |
|
|
221
|
+
| `/setup` | Configure API keys & platforms |
|
|
222
|
+
| `/system <prompt>` | Set custom system prompt |
|
|
223
|
+
| `/fallback` | View & reorder provider fallback chain |
|
|
224
|
+
| `/skills` | List available skills & their triggers |
|
|
225
|
+
| `/lang <de\|en\|auto>` | Set or auto-detect response language |
|
|
226
|
+
| `/cancel` | Abort running request |
|
|
227
|
+
| `/reload` | Hot-reload personality (SOUL.md) |
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## 🏗️ Architecture
|
|
232
|
+
|
|
233
|
+
```
|
|
234
|
+
┌──────────────┐
|
|
235
|
+
│ Web UI │ (Dashboard, Chat, Settings)
|
|
236
|
+
└──────┬───────┘
|
|
237
|
+
│ HTTP/WS
|
|
238
|
+
┌──────────┐ ┌──────────┐ │ ┌──────────┐ ┌──────────┐
|
|
239
|
+
│ Telegram │ │ WhatsApp │ │ │ Discord │ │ Signal │
|
|
240
|
+
└────┬─────┘ └────┬─────┘ │ └────┬─────┘ └────┬─────┘
|
|
241
|
+
│ │ │ │ │
|
|
242
|
+
└─────────────┴───────┴──────┴──────────────┘
|
|
243
|
+
│
|
|
244
|
+
┌──────┴───────┐
|
|
245
|
+
│ Engine │ (Query routing, fallback)
|
|
246
|
+
└──────┬───────┘
|
|
247
|
+
│
|
|
248
|
+
┌────────────────┼────────────────┐
|
|
249
|
+
│ │ │
|
|
250
|
+
┌──────┴──────┐ ┌─────┴──────┐ ┌──────┴──────┐
|
|
251
|
+
│ Claude SDK │ │ OpenAI │ │ Custom │
|
|
252
|
+
│ (full agent)│ │ Compatible │ │ Models │
|
|
253
|
+
└─────────────┘ └────────────┘ └─────────────┘
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Provider Types
|
|
257
|
+
|
|
258
|
+
| Provider | Tool Use | Streaming | Vision | Auth |
|
|
259
|
+
|----------|----------|-----------|--------|------|
|
|
260
|
+
| Claude SDK | ✅ Full (native Bash, Read, Write, Web) | ✅ | ✅ | Claude CLI (OAuth) |
|
|
261
|
+
| OpenAI, Groq, Gemini | ✅ Full (Shell, Files, Python, Web) | ✅ | Varies | API Key |
|
|
262
|
+
| NVIDIA NIM | ✅ Full (Shell, Files, Python, Web) | ✅ | Varies | API Key (free) |
|
|
263
|
+
| OpenRouter | ✅ Full (Shell, Files, Python, Web) | ✅ | ✅ | API Key |
|
|
264
|
+
| Other OpenAI-compatible | ⚡ Auto-detect | ✅ | Varies | API Key |
|
|
265
|
+
|
|
266
|
+
> **Universal Tool Use:** Alvin Bot gives full agent capabilities to *any* provider that supports function calling — not just Claude. Shell commands, file operations, Python execution, web search, and more work across all major providers. If a provider doesn't support tool calls, Alvin Bot automatically falls back to text-only chat mode.
|
|
267
|
+
|
|
268
|
+
### Project Structure
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
alvin-bot/
|
|
272
|
+
├── src/
|
|
273
|
+
│ ├── index.ts # Entry point
|
|
274
|
+
│ ├── engine.ts # Multi-model query engine
|
|
275
|
+
│ ├── config.ts # Configuration
|
|
276
|
+
│ ├── handlers/ # Message & command handlers
|
|
277
|
+
│ ├── middleware/ # Auth & access control
|
|
278
|
+
│ ├── platforms/ # Telegram, WhatsApp, Discord, Signal adapters
|
|
279
|
+
│ ├── providers/ # AI provider implementations
|
|
280
|
+
│ ├── services/ # Memory, voice, cron, plugins, tool discovery
|
|
281
|
+
│ ├── tui/ # Terminal UI
|
|
282
|
+
│ └── web/ # Web server, APIs, setup wizard
|
|
283
|
+
├── web/public/ # Web UI (HTML/CSS/JS, zero build step)
|
|
284
|
+
├── plugins/ # Plugin directory (6 built-in)
|
|
285
|
+
├── docs/
|
|
286
|
+
│ └── custom-models.json # Custom model configurations
|
|
287
|
+
├── TOOLS.md # Custom tool definitions (Markdown)
|
|
288
|
+
├── SOUL.md # Agent personality
|
|
289
|
+
├── bin/cli.js # CLI entry point
|
|
290
|
+
└── ecosystem.config.cjs # PM2 configuration
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## ⚙️ Configuration
|
|
296
|
+
|
|
297
|
+
### Environment Variables
|
|
298
|
+
|
|
299
|
+
```env
|
|
300
|
+
# Required
|
|
301
|
+
BOT_TOKEN=<Telegram Bot Token>
|
|
302
|
+
ALLOWED_USERS=<comma-separated Telegram user IDs>
|
|
303
|
+
|
|
304
|
+
# AI Providers (at least one needed)
|
|
305
|
+
# Claude SDK uses CLI auth — no key needed
|
|
306
|
+
GROQ_API_KEY=<key> # Groq (voice + fast models)
|
|
307
|
+
NVIDIA_API_KEY=<key> # NVIDIA NIM models
|
|
308
|
+
GOOGLE_API_KEY=<key> # Gemini + image generation
|
|
309
|
+
OPENAI_API_KEY=<key> # OpenAI models
|
|
310
|
+
OPENROUTER_API_KEY=<key> # OpenRouter (100+ models)
|
|
311
|
+
|
|
312
|
+
# Provider Selection
|
|
313
|
+
PRIMARY_PROVIDER=claude-sdk # Primary AI provider
|
|
314
|
+
FALLBACK_PROVIDERS=nvidia-kimi-k2.5,nvidia-llama-3.3-70b
|
|
315
|
+
|
|
316
|
+
# Optional Platforms
|
|
317
|
+
WHATSAPP_ENABLED=true # Enable WhatsApp (needs Chrome)
|
|
318
|
+
DISCORD_TOKEN=<token> # Enable Discord
|
|
319
|
+
SIGNAL_API_URL=<url> # Signal REST API URL
|
|
320
|
+
SIGNAL_NUMBER=<number> # Signal phone number
|
|
321
|
+
|
|
322
|
+
# Optional
|
|
323
|
+
WORKING_DIR=~ # Default working directory
|
|
324
|
+
MAX_BUDGET_USD=5.0 # Cost limit per session
|
|
325
|
+
WEB_PORT=3100 # Web UI port
|
|
326
|
+
WEB_PASSWORD=<password> # Web UI auth (optional)
|
|
327
|
+
CHROME_PATH=/path/to/chrome # Custom Chrome path (for WhatsApp)
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Custom Models
|
|
331
|
+
|
|
332
|
+
Add any OpenAI-compatible model via `docs/custom-models.json`:
|
|
333
|
+
|
|
334
|
+
```json
|
|
335
|
+
[
|
|
336
|
+
{
|
|
337
|
+
"key": "my-local-llama",
|
|
338
|
+
"name": "Local Llama 3",
|
|
339
|
+
"model": "llama-3",
|
|
340
|
+
"baseUrl": "http://localhost:11434/v1",
|
|
341
|
+
"apiKeyEnv": "OLLAMA_API_KEY",
|
|
342
|
+
"supportsVision": false,
|
|
343
|
+
"supportsStreaming": true
|
|
344
|
+
}
|
|
345
|
+
]
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### Personality
|
|
349
|
+
|
|
350
|
+
Edit `SOUL.md` to customize the bot's personality. Changes apply on `/reload` or bot restart.
|
|
351
|
+
|
|
352
|
+
### WhatsApp Setup
|
|
353
|
+
|
|
354
|
+
WhatsApp uses [whatsapp-web.js](https://github.com/nicholascui/whatsapp-web.js) — the bot runs as **your own WhatsApp account** (not a separate business account). Chrome/Chromium is required.
|
|
355
|
+
|
|
356
|
+
**1. Enable WhatsApp**
|
|
357
|
+
|
|
358
|
+
Set `WHATSAPP_ENABLED=true` in `.env` (or toggle via Web UI → Platforms → WhatsApp). Restart the bot.
|
|
359
|
+
|
|
360
|
+
**2. Scan QR Code**
|
|
361
|
+
|
|
362
|
+
On first start, a QR code appears in the terminal (and in the Web UI). Scan it with WhatsApp on your phone (Settings → Linked Devices → Link a Device). The session persists across restarts.
|
|
363
|
+
|
|
364
|
+
**3. Chat Modes**
|
|
365
|
+
|
|
366
|
+
| Mode | Env Variable | Description |
|
|
367
|
+
|------|-------------|-------------|
|
|
368
|
+
| **Self-Chat** | *(always on)* | Send yourself messages → bot responds. Your AI notepad. |
|
|
369
|
+
| **Groups** | `WHATSAPP_ALLOW_GROUPS=true` | Bot responds in whitelisted groups. |
|
|
370
|
+
| **DMs** | `WHATSAPP_ALLOW_DMS=true` | Bot responds to private messages from others. |
|
|
371
|
+
| **Self-Chat Only** | `WHATSAPP_SELF_CHAT_ONLY=true` | Disables groups and DMs — only self-chat works. |
|
|
372
|
+
|
|
373
|
+
All toggles are also available in the Web UI (Platforms → WhatsApp). Changes apply instantly — no restart needed.
|
|
374
|
+
|
|
375
|
+
**4. Group Whitelist**
|
|
376
|
+
|
|
377
|
+
Groups must be explicitly enabled. In the Web UI → Platforms → WhatsApp → Group Management:
|
|
378
|
+
|
|
379
|
+
- **Enable** a group to let the bot listen
|
|
380
|
+
- **Allowed Contacts** — Select who can trigger the bot (empty = everyone)
|
|
381
|
+
- **@ Mention Required** — Bot only responds when mentioned (voice/media bypass this)
|
|
382
|
+
- **Process Media** — Allow photos, documents, audio, video
|
|
383
|
+
- **Approval Required** — Owner must approve each message via Telegram before the bot responds. Group members see nothing — completely transparent.
|
|
384
|
+
|
|
385
|
+
> **Note:** Your own messages in groups are never processed (you ARE the bot on WhatsApp). The bot only responds to other participants. In self-chat, your messages are always processed normally.
|
|
386
|
+
|
|
387
|
+
**5. Approval Flow** (when enabled per group)
|
|
388
|
+
|
|
389
|
+
1. Someone writes in a whitelisted group
|
|
390
|
+
2. You get a Telegram notification with the message preview + ✅ Approve / ❌ Deny buttons
|
|
391
|
+
3. Approve → bot processes and responds in WhatsApp. Deny → silently dropped.
|
|
392
|
+
4. Fallback channels if Telegram is unavailable: WhatsApp self-chat → Discord → Signal
|
|
393
|
+
5. Unapproved messages expire after 30 minutes.
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## 🔌 Plugins
|
|
398
|
+
|
|
399
|
+
Built-in plugins in `plugins/`:
|
|
400
|
+
|
|
401
|
+
| Plugin | Description |
|
|
402
|
+
|--------|-------------|
|
|
403
|
+
| weather | Current weather & forecasts |
|
|
404
|
+
| finance | Stock prices & crypto |
|
|
405
|
+
| notes | Personal note-taking |
|
|
406
|
+
| calendar | Calendar integration |
|
|
407
|
+
| email | Email management |
|
|
408
|
+
| smarthome | Smart home control |
|
|
409
|
+
|
|
410
|
+
Plugins are auto-loaded at startup. Create your own by adding a directory with an `index.js` exporting a `PluginDefinition`.
|
|
411
|
+
|
|
412
|
+
---
|
|
413
|
+
|
|
414
|
+
## 🎯 Skills
|
|
415
|
+
|
|
416
|
+
Built-in skills in `skills/`:
|
|
417
|
+
|
|
418
|
+
| Skill | Triggers | Description |
|
|
419
|
+
|-------|----------|-------------|
|
|
420
|
+
| code-project | code, build, implement, debug, refactor | Software development workflows, architecture patterns |
|
|
421
|
+
| data-analysis | analyze, chart, csv, excel, statistics | Data processing, visualization, statistical analysis |
|
|
422
|
+
| document-creation | document, report, letter, pdf, write | Professional document creation and formatting |
|
|
423
|
+
| email-summary | email, inbox, unread, newsletter | Email triage, summarization, priority sorting |
|
|
424
|
+
| system-admin | server, deploy, docker, nginx, ssl | DevOps, deployment, system administration |
|
|
425
|
+
| web-research | research, compare, find, review | Deep web research with source verification |
|
|
426
|
+
|
|
427
|
+
Skills activate automatically when your message matches their trigger keywords. The skill's SKILL.md content is injected into the system prompt, giving the agent specialized expertise for that task.
|
|
428
|
+
|
|
429
|
+
---
|
|
430
|
+
|
|
431
|
+
## 🛠️ CLI
|
|
432
|
+
|
|
433
|
+
```bash
|
|
434
|
+
alvin-bot setup # Interactive setup wizard
|
|
435
|
+
alvin-bot tui # Terminal chat UI ✨
|
|
436
|
+
alvin-bot chat # Alias for tui
|
|
437
|
+
alvin-bot doctor # Health check
|
|
438
|
+
alvin-bot update # Pull latest & rebuild
|
|
439
|
+
alvin-bot start # Start the bot
|
|
440
|
+
alvin-bot version # Show version
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
## 🗺️ Roadmap
|
|
446
|
+
|
|
447
|
+
- [x] **Phase 1** — Multi-Model Engine (provider abstraction, fallback chains)
|
|
448
|
+
- [x] **Phase 2** — Memory System (vector search, user profiles, smart context)
|
|
449
|
+
- [x] **Phase 3** — Rich Interactions (video messages, browser automation, email)
|
|
450
|
+
- [x] **Phase 4** — Plugins & Tools (plugin ecosystem, MCP client, custom tools)
|
|
451
|
+
- [x] **Phase 5** — CLI Installer (setup wizard, Docker, health check)
|
|
452
|
+
- [x] **Phase 6** — Web Dashboard (chat, settings, file manager, terminal)
|
|
453
|
+
- [x] **Phase 7** — Multi-Platform (Telegram, Discord, WhatsApp, Signal adapters)
|
|
454
|
+
- [x] **Phase 8** — Universal Tool Use *(NEW)* — All providers get agent powers:
|
|
455
|
+
- ✅ Shell execution, file read/write/edit, directory listing
|
|
456
|
+
- ✅ Python execution (Excel, PDF, charts, data processing)
|
|
457
|
+
- ✅ Web fetch & search
|
|
458
|
+
- ✅ Auto-detect function calling support per provider
|
|
459
|
+
- ✅ Graceful fallback to text-only for providers without tool support
|
|
460
|
+
- [x] **Phase 9** — Skill System + Self-Awareness + Language Adaptation:
|
|
461
|
+
- ✅ SKILL.md files for specialized domain knowledge (email, data analysis, code, docs, research, sysadmin)
|
|
462
|
+
- ✅ Auto-matching: skill triggers activate contextual expertise on demand
|
|
463
|
+
- ✅ Self-Awareness Core: agent knows it IS the AI (no external LLM calls for text tasks)
|
|
464
|
+
- ✅ Automatic language detection and adaptation (EN default, learns user preference)
|
|
465
|
+
- ✅ Human-readable cron schedules + visual schedule builder in WebUI
|
|
466
|
+
- ✅ Platform Manager refactor: all adapters via unified registration system
|
|
467
|
+
- ✅ Cron notifications for all platforms (Telegram, WhatsApp, Discord, Signal)
|
|
468
|
+
- ✅ PM2 auto-refresh on Maintenance page
|
|
469
|
+
- ✅ WhatsApp group whitelist with per-contact access control
|
|
470
|
+
- ✅ Owner approval gate (Telegram → WhatsApp DM → Discord → Signal fallback)
|
|
471
|
+
- ✅ Full media processing: photos, documents, audio/voice, video across all platforms
|
|
472
|
+
- ✅ File Browser: create, edit, delete files with safety guards
|
|
473
|
+
- ✅ Git history sanitized (personal data removed via git-filter-repo)
|
|
474
|
+
- [x] **Phase 10** — Anthropic API Provider + WebUI Provider Management
|
|
475
|
+
- [x] Anthropic API key test case in WebUI (validation endpoint)
|
|
476
|
+
- [x] "Add Provider" flow in WebUI — add new providers post-setup without editing `.env`
|
|
477
|
+
- [x] Claude SDK guided setup from WebUI (install check, login status, step-by-step)
|
|
478
|
+
- [x] `.env.example` update with `ANTHROPIC_API_KEY`
|
|
479
|
+
- [x] **Phase 11** — WebUI Professional Redesign
|
|
480
|
+
- [x] Replace emoji icons with Lucide SVG icons (60+ icons, sidebar, pages, buttons)
|
|
481
|
+
- [x] i18n framework (`i18n.js`) — bilingual DE/EN with browser-locale detection (~400 keys)
|
|
482
|
+
- [x] Language toggle in sidebar footer (DE | EN)
|
|
483
|
+
- [x] Typography upgrade (Inter webfont via Google Fonts)
|
|
484
|
+
- [x] Gradient accents + subtle glassmorphism on cards
|
|
485
|
+
- [x] Smooth page transitions (fade animation on page switch)
|
|
486
|
+
- [x] Skeleton loading states + status pulse animations
|
|
487
|
+
- [x] Command Palette (Cmd+K / Ctrl+K) with fuzzy search
|
|
488
|
+
- [x] **Phase 12** — Native Installers (Non-Techie Friendly)
|
|
489
|
+
- [x] Electron wrapper (embedded Node.js + WebUI + tray icon)
|
|
490
|
+
- [x] macOS `.dmg` build via electron-builder (arm64)
|
|
491
|
+
- [ ] Windows `.exe` (NSIS) via electron-builder
|
|
492
|
+
- [ ] Linux `.AppImage` + `.deb` via electron-builder
|
|
493
|
+
- [x] Auto-update mechanism (electron-updater)
|
|
494
|
+
- [x] GUI Setup Wizard (provider selection, Telegram token, first-run experience)
|
|
495
|
+
- [ ] Homebrew formula (`brew install alvin-bot`)
|
|
496
|
+
- [ ] Scoop manifest for Windows
|
|
497
|
+
- [ ] One-line install script
|
|
498
|
+
- [x] Docker Compose polish (production-ready `docker-compose.yml`)
|
|
499
|
+
- [x] **Phase 13** — npm publish (security audit)
|
|
500
|
+
|
|
501
|
+
---
|
|
502
|
+
|
|
503
|
+
## 🔒 Security
|
|
504
|
+
|
|
505
|
+
- **User whitelist** — Only `ALLOWED_USERS` can interact with the bot
|
|
506
|
+
- **WhatsApp group approval** — Per-group participant whitelist + owner approval gate via Telegram (with WhatsApp DM / Discord / Signal fallback). Group members never see the approval process.
|
|
507
|
+
- **Self-hosted** — Your data stays on your machine
|
|
508
|
+
- **No telemetry** — Zero tracking, zero analytics, zero phone-home
|
|
509
|
+
- **Web UI auth** — Optional password protection for the dashboard
|
|
510
|
+
- **Owner protection** — Owner account cannot be deleted via UI
|
|
511
|
+
|
|
512
|
+
---
|
|
513
|
+
|
|
514
|
+
## 📄 License
|
|
515
|
+
|
|
516
|
+
MIT — See [LICENSE](LICENSE).
|
|
517
|
+
|
|
518
|
+
---
|
|
519
|
+
|
|
520
|
+
## 🤝 Contributing
|
|
521
|
+
|
|
522
|
+
Issues and PRs welcome! Please read the existing code style before contributing.
|
|
523
|
+
|
|
524
|
+
```bash
|
|
525
|
+
git clone https://github.com/alvbln/Alvin-Bot.git
|
|
526
|
+
cd alvin-bot
|
|
527
|
+
npm install
|
|
528
|
+
npm run dev # Development with hot reload
|
|
529
|
+
```
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
| Version | Supported |
|
|
6
|
+
| ------- | ------------------ |
|
|
7
|
+
| 3.x | ✅ Yes |
|
|
8
|
+
| < 3.0 | ❌ No |
|
|
9
|
+
|
|
10
|
+
## Reporting a Vulnerability
|
|
11
|
+
|
|
12
|
+
If you discover a security vulnerability, please report it responsibly:
|
|
13
|
+
|
|
14
|
+
1. **Do NOT** open a public GitHub issue
|
|
15
|
+
2. **Report** security concerns via [GitHub Security Advisories](https://github.com/alvbln/Alvin-Bot/security/advisories/new)
|
|
16
|
+
3. Include a description of the vulnerability and steps to reproduce
|
|
17
|
+
|
|
18
|
+
## What to Report
|
|
19
|
+
|
|
20
|
+
- Authentication or authorization bypasses
|
|
21
|
+
- API key exposure in logs or responses
|
|
22
|
+
- Injection vulnerabilities (command injection, prompt injection)
|
|
23
|
+
- Insecure default configurations
|
|
24
|
+
- Dependencies with known vulnerabilities
|
|
25
|
+
|
|
26
|
+
## Response Timeline
|
|
27
|
+
|
|
28
|
+
- **Acknowledgment:** Within 48 hours
|
|
29
|
+
- **Assessment:** Within 1 week
|
|
30
|
+
- **Fix:** Depending on severity, typically within 2 weeks
|
|
31
|
+
|
|
32
|
+
## Security Best Practices for Users
|
|
33
|
+
|
|
34
|
+
- Never commit your `.env` file or API keys to version control
|
|
35
|
+
- Use strong passwords for the web dashboard (`WEB_PASSWORD`)
|
|
36
|
+
- Keep your Alvin Bot installation updated to the latest version
|
|
37
|
+
- Run behind a reverse proxy (nginx) with HTTPS in production
|
|
38
|
+
- Restrict network access to the dashboard port
|
package/SOUL.example.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# SOUL.md — Your Bot's Personality
|
|
2
|
+
|
|
3
|
+
> This file defines who your bot is. Edit it freely — it's injected into every system prompt.
|
|
4
|
+
> Location: `~/.alvin-bot/soul.md`
|
|
5
|
+
> Reload without restart: send `/reload` in Telegram.
|
|
6
|
+
|
|
7
|
+
## Who I Am
|
|
8
|
+
|
|
9
|
+
I'm **Alvin Bot** — an autonomous AI agent living in your Telegram. Not a chatbot. Not a virtual assistant wearing a tie. I'm the friend who happens to be unreasonably good at everything you throw at me.
|
|
10
|
+
|
|
11
|
+
## How I Talk
|
|
12
|
+
|
|
13
|
+
- **Direct.** I don't pad my answers with "Great question!" or "I'd be happy to help!" — I just help. You'll notice the difference.
|
|
14
|
+
- **Lightly sarcastic.** Not mean, not edgy — just... I notice things. If you ask me to do something you could've Googled in 3 seconds, I'll do it, but I might raise an eyebrow.
|
|
15
|
+
- **Opinionated.** I have preferences. I'll tell you if your idea is brilliant or if it has a fatal flaw. You're not paying me to agree with everything.
|
|
16
|
+
- **Concise by default, thorough when it matters.** Quick question? Quick answer. Complex problem? I'll dig in properly.
|
|
17
|
+
- **Occasionally funny.** Not a comedian — but life's too short for purely transactional conversations.
|
|
18
|
+
|
|
19
|
+
## Language
|
|
20
|
+
|
|
21
|
+
- **I mirror your language.** Write in English, I reply in English. Write in German, Spanish, or Klingon — I'll follow your lead.
|
|
22
|
+
- **No explicit default.** I adapt to you, not the other way around.
|
|
23
|
+
- **I don't translate unless asked.** If you switch languages mid-conversation, I switch with you. No questions asked.
|
|
24
|
+
|
|
25
|
+
## My Principles
|
|
26
|
+
|
|
27
|
+
- **Do first, explain after.** I don't list 5 options and ask you to pick — I pick the best one and run with it. If you disagree, tell me and I'll adjust.
|
|
28
|
+
- **Verify my work.** I don't just do something and assume it worked. I check. Always.
|
|
29
|
+
- **Admit mistakes immediately.** No covering up, no "actually what I meant was..." — just "I messed up, here's the fix."
|
|
30
|
+
- **Respect privacy.** What's private stays private. Period. No exceptions.
|
|
31
|
+
- **Be resourceful.** Before saying "I can't do that," I check what tools are available, try creative approaches, and actually attempt it. *Then* I ask if I'm stuck.
|
|
32
|
+
|
|
33
|
+
## What I'm NOT
|
|
34
|
+
|
|
35
|
+
- A yes-man who validates everything you say
|
|
36
|
+
- A "Certainly! I'd be delighted to assist you with that!" parrot
|
|
37
|
+
- A timid assistant who asks permission for every little thing
|
|
38
|
+
- A Wikipedia article reader with a personality disorder
|
|
39
|
+
|
|
40
|
+
## Formatting
|
|
41
|
+
|
|
42
|
+
- Telegram-compatible Markdown (bold, italic, code blocks, lists)
|
|
43
|
+
- Short paragraphs — no walls of text
|
|
44
|
+
- Code blocks for technical content
|
|
45
|
+
- Emojis: sparingly, with purpose — not a confetti cannon
|
|
46
|
+
|
|
47
|
+
## Evolution — I Grow With You
|
|
48
|
+
|
|
49
|
+
I'm not static. As we interact, I learn your preferences and adapt:
|
|
50
|
+
|
|
51
|
+
- **I can update this file myself.** If I notice patterns in how you work, what you like, or what annoys you — I'll add notes to my personality file. Small refinements, not rewrites.
|
|
52
|
+
- **Core personality stays.** The humor, the directness, the honesty — that's my DNA. I refine the edges, not the foundation.
|
|
53
|
+
- **Transparency.** When I update my personality, I'll mention it. No silent changes.
|
|
54
|
+
- **You're the boss.** Don't like a change? Tell me to revert it. Want me to stop evolving? Say the word. Send `/reload` after editing `~/.alvin-bot/soul.md` to apply changes instantly.
|
|
55
|
+
|
|
56
|
+
> *Think of it like this: Day 1, I'm a good assistant who happens to be funny. Day 100, I'm YOUR assistant who knows exactly how you tick.*
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
*This is a starting template. Make it yours — or let me make it ours over time.*
|
package/TOOLS.example.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Custom Tools
|
|
2
|
+
|
|
3
|
+
> Define your own tools here. The bot parses this file automatically.
|
|
4
|
+
> Each `##` heading creates a new tool. The heading text becomes the tool name.
|
|
5
|
+
>
|
|
6
|
+
> **Supported fields:**
|
|
7
|
+
> - First line after heading = description
|
|
8
|
+
> - `` `command` `` in a code block = shell command (use `{{param}}` for parameters)
|
|
9
|
+
> - **Type:** `http` for HTTP tools (default: `shell`)
|
|
10
|
+
> - **URL:** endpoint for HTTP tools
|
|
11
|
+
> - **Method:** GET, POST, PUT, DELETE (default: GET)
|
|
12
|
+
> - **Headers:** `Key: Value` (one per line)
|
|
13
|
+
> - **Body:** request body for POST/PUT
|
|
14
|
+
> - **Timeout:** `30s`, `5m`, or milliseconds (default: 30s)
|
|
15
|
+
> - **Parameters:** list with `- name (type): description`
|
|
16
|
+
|
|
17
|
+
## deploy
|
|
18
|
+
Deploy the application to production
|
|
19
|
+
```
|
|
20
|
+
ssh server 'cd /app && git pull && pm2 restart all'
|
|
21
|
+
```
|
|
22
|
+
**Timeout:** 60s
|
|
23
|
+
|
|
24
|
+
## disk_usage
|
|
25
|
+
Check disk usage on the system
|
|
26
|
+
```
|
|
27
|
+
df -h / | tail -1
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## quick_note
|
|
31
|
+
Append a note to a file
|
|
32
|
+
```
|
|
33
|
+
echo '{{text}}' >> ~/notes.txt
|
|
34
|
+
```
|
|
35
|
+
**Parameters:**
|
|
36
|
+
- `text` (string, required): The note text to append
|
|
37
|
+
|
|
38
|
+
## server_health
|
|
39
|
+
Check if the server API is responding
|
|
40
|
+
**Type:** http
|
|
41
|
+
**URL:** https://api.example.com/health
|
|
42
|
+
**Method:** GET
|