create-openclaw-bot 5.4.0 β 5.4.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.
- package/CHANGELOG.md +177 -157
- package/CHANGELOG.vi.md +175 -155
- package/README.md +321 -321
- package/README.vi.md +321 -321
- package/cli.js +17 -19
- package/package.json +1 -1
- package/setup.js +16 -5
- package/openclaw_correct_structure.md +0 -203
package/README.md
CHANGED
|
@@ -1,321 +1,321 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
|
|
3
|
-
# π¦ OpenClaw Setup
|
|
4
|
-
|
|
5
|
-
<p align="center">
|
|
6
|
-
<a href="https://github.com/tuanminhhole/openclaw-setup/releases"><img src="https://img.shields.io/badge/RELEASE-v5.4.
|
|
7
|
-
<a href="https://github.com/tuanminhhole/openclaw-setup?tab=MIT-1-ov-file"><img src="https://img.shields.io/badge/LICENSE-MIT-success?style=for-the-badge" alt="MIT License" /></a>
|
|
8
|
-
<a href="https://www.npmjs.com/package/create-openclaw-bot"><img src="https://img.shields.io/npm/v/create-openclaw-bot?style=for-the-badge&label=CLI&color=2563EB&logo=npm&logoColor=white" alt="NPM Version" /></a>
|
|
9
|
-
<a href="https://github.com/tuanminhhole/openclaw-setup/stargazers"><img src="https://img.shields.io/github/stars/tuanminhhole/openclaw-setup?style=for-the-badge&color=eab308&logo=github&logoColor=white" alt="GitHub Stars" /></a>
|
|
10
|
-
</p>
|
|
11
|
-
|
|
12
|
-
<p style="margin-top: 16px;">
|
|
13
|
-
<img src="https://flagcdn.com/24x18/gb.png" alt="English" width="24" height="18" style="vertical-align: sub;"> <strong>English</strong> Β·
|
|
14
|
-
<img src="https://flagcdn.com/24x18/vn.png" alt="TiαΊΏng Viα»t" width="24" height="18" style="vertical-align: sub;"> <a href="README.vi.md">TiαΊΏng Viα»t</a>
|
|
15
|
-
</p>
|
|
16
|
-
|
|
17
|
-
An interactive **CLI tool** and **Setup Wizard** to deploy your own free AI Bot on Telegram or Zalo in minutes β supports **Windows, macOS, Ubuntu, and VPS**.
|
|
18
|
-
|
|
19
|
-
<a href="https://github.com/tuanminhhole/openclaw-setup">
|
|
20
|
-
<img src="https://raw.githubusercontent.com/tuanminhhole/openclaw-setup/main/docs/preview.png" alt="OpenClaw Setup Hero Image" width="100%" style="border-radius: 8px; margin: 16px 0; border: 1px solid #333;" />
|
|
21
|
-
</a>
|
|
22
|
-
|
|
23
|
-
</div>
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
## π What's new in v5.4.
|
|
28
|
-
|
|
29
|
-
- ποΈ **Multi-bot architecture refactored** β All duplicate flags (`isTelegramMultiBot`, `isSharedMultiBot`, `isMultiBotWizard`) merged into a single `isMultiBot`. Generated `agentDir` paths now correctly point to `.openclaw/agents/{slug}/agent` relative to `OPENCLAW_HOME`.
|
|
30
|
-
- ποΈ **Telegram + Zalo combo channel removed** β Combo mode has been deprecated and removed from both the Web Wizard and CLI. It will be redesigned in a future release.
|
|
31
|
-
- π€ **Cross-workspace rules in `AGENTS.md`** β In multi-bot mode, each bot's `AGENTS.md` now includes a dedicated section describing which sibling workspace paths may be read and what write restrictions apply.
|
|
32
|
-
- π§Ή **Cleaner config generation** β Per-agent `auth-profiles.json` is no longer created for 9Router/proxy setups. Native scripts no longer generate `.env` files; credentials are managed via `openclaw channels login`.
|
|
33
|
-
|
|
34
|
-
<details>
|
|
35
|
-
<summary><b>Previous: What's new in v5.3.5</b></summary>
|
|
36
|
-
|
|
37
|
-
- π **Fix: Telegram token input missing in combo channel** β When selecting "Telegram + Zalo Personal", the wizard now shows the Telegram Bot Token input field AND the Zalo Personal warning side by side.
|
|
38
|
-
- π **Fix: Next button stuck on step 4 for combo** β Validation now correctly requires a Telegram token before enabling "Generate Configs" in combo mode.
|
|
39
|
-
- π **Fix: Windows Docker script crashes with "docker not recognized"** β The generated `.ps1` now uses `Get-Command` to locate Docker, checks that Docker Desktop is running, and calls it via `&` operator β works even when Docker isn't in the default PowerShell PATH.
|
|
40
|
-
- π **Fix: Zalo QR login instructions missing for combo in Windows script** β Post-install notes now show the `docker compose exec` login command when the combo channel is selected.
|
|
41
|
-
|
|
42
|
-
</details>
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## β¨ Features
|
|
47
|
-
|
|
48
|
-
- π€ **Multi-channel** β Telegram (single or multi-bot), Zalo Bot API, or Zalo Personal
|
|
49
|
-
- π§βπ€βπ§ **Multi-bot team** β Run up to 5 Telegram bots simultaneously. Bots share a workspace, collaborate on tasks, and coordinate in a group chat using the Department Room Model
|
|
50
|
-
- π§ **Multi-provider AI** β Google Gemini, Claude, GPT-4o, OpenRouter, Ollama (local), 9Router
|
|
51
|
-
- 𧩠**Skills** β Web Search, Browser Automation, Memory, RAG, Code Interpreter, Image Gen
|
|
52
|
-
- π **Plugins** β Voice Call, Matrix, MS Teams, Nostr
|
|
53
|
-
- π **9Router** β Free AI proxy. OAuth login, no API keys. Supports Claude Code, Codex, Gemini CLI.
|
|
54
|
-
- π§ **Setup Wizard** β 5-step visual web UI (`index.html`). No terminal required.
|
|
55
|
-
- π» **Interactive CLI** β `npx create-openclaw-bot` β best for Ubuntu, VPS, engineers.
|
|
56
|
-
- π **100% Free to start** β 9Router + Gemini free tier requires zero spending
|
|
57
|
-
- π **Private** β API keys stay on your machine, never sent anywhere
|
|
58
|
-
- β‘ **Fast** β From zero to working bot in under 5 minutes
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## πΊοΈ Choose your path
|
|
63
|
-
|
|
64
|
-
> **Not sure which method to use?** The table below has you covered:
|
|
65
|
-
|
|
66
|
-
| Who you are | Environment | Recommended path |
|
|
67
|
-
| -------------------------- | --------------- | ------------------------------------- |
|
|
68
|
-
| Not familiar with terminal | Windows / macOS | **Web Wizard** (`index.html`) |
|
|
69
|
-
| Not familiar with terminal | Ubuntu Desktop | **Web Wizard** β choose Native |
|
|
70
|
-
| Comfortable with terminal | Ubuntu / VPS | **CLI** (`npx create-openclaw-bot`) |
|
|
71
|
-
| Want full automation | Anywhere | **AI Agent** (Antigravity + SETUP.md) |
|
|
72
|
-
|
|
73
|
-
### 1οΈβ£ Option A β Web Wizard (No terminal required)
|
|
74
|
-
|
|
75
|
-
Best for **Windows and macOS**. No command line at all.
|
|
76
|
-
|
|
77
|
-
1. [Download ZIP](https://github.com/tuanminhhole/openclaw-setup/archive/refs/heads/main.zip) or clone this repo.
|
|
78
|
-
2. Open `index.html` in your browser.
|
|
79
|
-
3. Follow the **5-step wizard**:
|
|
80
|
-
- **Step 1:** Choose your OS (Windows / macOS / Ubuntu / VPS)
|
|
81
|
-
- **Step 2:** Choose your bot channel (Telegram / Zalo)
|
|
82
|
-
- **Step 3:** Choose your AI provider and model
|
|
83
|
-
- **Step 4:** Enter bot token and configure settings
|
|
84
|
-
- **Step 5:** Download your script and run it β done!
|
|
85
|
-
4. The downloaded script automatically installs everything needed (9Router, Ollama, Docker, etc.) based on your choices.
|
|
86
|
-
|
|
87
|
-
> **Docker or no Docker?**
|
|
88
|
-
>
|
|
89
|
-
> - **Windows / macOS** β Use **Docker** (fully isolated, easy to manage)
|
|
90
|
-
> - **Ubuntu / VPS** β Use **Native (no Docker)** (less RAM, more stable)
|
|
91
|
-
|
|
92
|
-
### 2οΈβ£ Option B β Interactive CLI (`npx`)
|
|
93
|
-
|
|
94
|
-
Best for **engineers, Ubuntu Desktop, VPS**. Fastest and most powerful.
|
|
95
|
-
|
|
96
|
-
```bash
|
|
97
|
-
npx create-openclaw-bot
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
Run in your terminal β follow the interactive prompts β startup script is generated automatically.
|
|
101
|
-
|
|
102
|
-
> Requires: **Node.js 20/22/24**. Check: `node -v`
|
|
103
|
-
>
|
|
104
|
-
> Note: **avoid Node.js 25 for now**. There are reports of OpenClaw failing on Node 25.
|
|
105
|
-
|
|
106
|
-
<details>
|
|
107
|
-
<summary><b>3οΈβ£ Option C β AI Agent (Antigravity)</b></summary>
|
|
108
|
-
<br>
|
|
109
|
-
|
|
110
|
-
1. Open [Antigravity IDE](https://antigravity.dev/)
|
|
111
|
-
2. Open this repo as your workspace
|
|
112
|
-
3. Paste into chat:
|
|
113
|
-
```
|
|
114
|
-
Read SETUP.md and set up OpenClaw v5.3.1 for me.
|
|
115
|
-
My bot token is X. Use 9Router (no API key).
|
|
116
|
-
My project folder: <YOUR_PATH>
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
</details>
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
## π Prerequisites
|
|
124
|
-
|
|
125
|
-
### Without Docker (Native β recommended for Ubuntu/VPS)
|
|
126
|
-
|
|
127
|
-
| Requirement | Notes |
|
|
128
|
-
| ----------------------- | -------------------------------------------------------------------------- |
|
|
129
|
-
| **Node.js 20/22/24** | [Download](https://nodejs.org/) Β· Check: `node -v` Β· Avoid Node 25 for now |
|
|
130
|
-
| **An AI provider** | 9Router (free) or Gemini/Claude/GPT-4o |
|
|
131
|
-
| **Bot Token** | From Telegram BotFather or Zalo Developer |
|
|
132
|
-
| **Ollama** _(optional)_ | Only if you want to run Gemma 4 locally Β· [Download](https://ollama.com/) |
|
|
133
|
-
|
|
134
|
-
### With Docker (recommended for Windows/macOS)
|
|
135
|
-
|
|
136
|
-
| Requirement | Notes |
|
|
137
|
-
| ------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
138
|
-
| **Node.js 20/22/24** | [Download](https://nodejs.org/) Β· Check: `node -v` Β· Avoid Node 25 for now |
|
|
139
|
-
| **Docker Desktop + Compose V2** | [Download](https://www.docker.com/products/docker-desktop/) Β· Check: `docker compose version` |
|
|
140
|
-
| **An AI provider** | 9Router runs as a sidecar container β no separate install needed |
|
|
141
|
-
| **Bot Token** | From Telegram BotFather or Zalo Developer |
|
|
142
|
-
|
|
143
|
-
---
|
|
144
|
-
|
|
145
|
-
## π§ Supported Providers
|
|
146
|
-
|
|
147
|
-
| Provider | Cost | API Key | Notes |
|
|
148
|
-
| -------------------- | ------------ | -------- | ----------------------------------------------------------------------------------------- |
|
|
149
|
-
| **9Router** | π Free | β OAuth | Recommended for beginners. Auto-routes to best model. Supports Claude CLI, Codex, Gemini. |
|
|
150
|
-
| **Google Gemini** | π Free tier | β
Yes | High quality. Very generous free tier. |
|
|
151
|
-
| **Ollama / Gemma 4** | π Free | β No | Runs 100% offline. Auto-pulls model on first start. |
|
|
152
|
-
| **Anthropic Claude** | π° Paid | β
Yes | Best reasoning and writing quality. |
|
|
153
|
-
| **OpenAI / Codex** | π° Paid | β
Yes | GPT-4o, Codex Mini. |
|
|
154
|
-
| **OpenRouter** | π/π° Mixed | β
Yes | Many models under one key. Some are free. |
|
|
155
|
-
|
|
156
|
-
> π **9Router v0.3.75+** adds lossless passthrough for Claude Code, Codex, Gemini CLI, and Antigravity β meaning these AI tools can use 9Router as their endpoint without any data loss. See [docs/ai-providers.md](docs/ai-providers.md) for setup details.
|
|
157
|
-
|
|
158
|
-
---
|
|
159
|
-
|
|
160
|
-
## π Supported Channels
|
|
161
|
-
|
|
162
|
-
- **Telegram** (β
Official) β Search **@BotFather** β `/newbot` β Copy token.
|
|
163
|
-
- **Zalo Bot API** (β
Official) β Go to [developers.zalo.me](https://developers.zalo.me) β Create bot β Copy token.
|
|
164
|
-
- **Zalo Personal** (β οΈ Unofficial) β Scan QR after setup (no token needed). Use a secondary account.
|
|
165
|
-
|
|
166
|
-
> β οΈ **Zalo Personal** uses an unofficial API. Your account may be restricted. Use a secondary account only.
|
|
167
|
-
|
|
168
|
-
---
|
|
169
|
-
|
|
170
|
-
## π Repo Structure
|
|
171
|
-
|
|
172
|
-
```
|
|
173
|
-
index.html β Setup Wizard UI (open in browser)
|
|
174
|
-
style.css β Wizard styles
|
|
175
|
-
setup.js β Wizard logic
|
|
176
|
-
cli.js β Interactive CLI (npx create-openclaw-bot)
|
|
177
|
-
CHANGELOG.md/.vi.md β Version history
|
|
178
|
-
README.md β You're here (English)
|
|
179
|
-
README.vi.md β HΖ°α»ng dαΊ«n tiαΊΏng Viα»t
|
|
180
|
-
SETUP.md/.vi.md β Technical guide for AI Agent
|
|
181
|
-
docs/
|
|
182
|
-
install-docker.md/.vi.md β Docker setup per OS
|
|
183
|
-
install-native.md/.vi.md β Native/PM2 install per OS
|
|
184
|
-
ai-providers.md/.vi.md β AI provider configuration
|
|
185
|
-
hardware-guide.md/.vi.md β RAM planning for Ollama/Gemma 4
|
|
186
|
-
faq.md/.vi.md β Frequently asked questions
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
> **Note:** Startup scripts (`.bat`, `.sh`) are **not included** in the repo β they are generated by the Web Wizard or CLI based on your specific configuration.
|
|
190
|
-
|
|
191
|
-
---
|
|
192
|
-
|
|
193
|
-
## β FAQ
|
|
194
|
-
|
|
195
|
-
<details>
|
|
196
|
-
<summary><b>Is it really free?</b></summary>
|
|
197
|
-
|
|
198
|
-
Yes. Docker, Google Gemini API (free tier), and Telegram/Zalo bot tokens are all free. You only pay if you choose a paid AI provider like Claude or GPT-4o.
|
|
199
|
-
|
|
200
|
-
</details>
|
|
201
|
-
|
|
202
|
-
<details>
|
|
203
|
-
<summary><b>Where does the bot run?</b></summary>
|
|
204
|
-
|
|
205
|
-
On your computer or server. With Docker it runs in a container; with Native mode it runs as a PM2-managed process. If the machine is off, the bot is off. Use a VPS for 24/7 uptime.
|
|
206
|
-
|
|
207
|
-
</details>
|
|
208
|
-
|
|
209
|
-
<details>
|
|
210
|
-
<summary><b>Do I need Docker?</b></summary>
|
|
211
|
-
|
|
212
|
-
No. Docker is optional. Windows/macOS users should use Docker for clean isolation. Ubuntu/VPS users should install natively with PM2 β less overhead and OpenClaw is already secure by design.
|
|
213
|
-
|
|
214
|
-
</details>
|
|
215
|
-
|
|
216
|
-
<details>
|
|
217
|
-
<summary><b>How do I stop/restart the bot?</b></summary>
|
|
218
|
-
|
|
219
|
-
**Docker:**
|
|
220
|
-
|
|
221
|
-
```bash
|
|
222
|
-
docker compose down # Stop
|
|
223
|
-
docker compose up -d # Start
|
|
224
|
-
docker compose restart # Restart
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
**PM2 (native):**
|
|
228
|
-
|
|
229
|
-
```bash
|
|
230
|
-
pm2 stop openclaw-bot
|
|
231
|
-
pm2 start openclaw-bot
|
|
232
|
-
pm2 restart openclaw-bot
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
</details>
|
|
236
|
-
|
|
237
|
-
<details>
|
|
238
|
-
<summary><b>Can I switch AI models later?</b></summary>
|
|
239
|
-
|
|
240
|
-
Yes. Re-run `npx create-openclaw-bot` in your bot folder, or edit `.openclaw/openclaw.json` directly and restart the bot.
|
|
241
|
-
|
|
242
|
-
</details>
|
|
243
|
-
|
|
244
|
-
<details>
|
|
245
|
-
<summary><b>Is it safe?</b></summary>
|
|
246
|
-
|
|
247
|
-
Your API keys are stored only on your machine in a local `.env` file. OpenClaw never transmits them anywhere. When using Ollama, all AI inference runs completely offline.
|
|
248
|
-
|
|
249
|
-
</details>
|
|
250
|
-
|
|
251
|
-
<details>
|
|
252
|
-
<summary><b>What is 9Router?</b></summary>
|
|
253
|
-
|
|
254
|
-
9Router is an open-source AI proxy. Instead of managing API keys from multiple providers, you log in once via OAuth at `localhost:20128/dashboard`. It auto-routes requests to the best available AI model. Starting v0.3.75, it also supports lossless passthrough for Claude Code, Codex, Gemini CLI, and Antigravity.
|
|
255
|
-
|
|
256
|
-
</details>
|
|
257
|
-
|
|
258
|
-
<details>
|
|
259
|
-
<summary><b>What's the difference between Skills and Plugins?</b></summary>
|
|
260
|
-
|
|
261
|
-
**Skills** add agent capabilities (Web Search, Browser Automation, Memory, RAG, Code Interpreter...) β install via `openclaw skills install` from ClawHub.
|
|
262
|
-
|
|
263
|
-
**Plugins** add channels or runtime extensions (Voice Call, Matrix, MS Teams...) β install via `openclaw plugins install` from npm.
|
|
264
|
-
|
|
265
|
-
</details>
|
|
266
|
-
|
|
267
|
-
<details>
|
|
268
|
-
<summary><b>How much RAM do I need for Gemma 4?</b></summary>
|
|
269
|
-
|
|
270
|
-
| Model | Min RAM (Native) | Min RAM (Docker) |
|
|
271
|
-
| ------------ | ---------------- | ---------------- |
|
|
272
|
-
| `gemma4:e2b` | ~4 GB | ~5 GB |
|
|
273
|
-
| `gemma4:e4b` | ~8 GB | ~9 GB |
|
|
274
|
-
| `gemma4:26b` | ~18 GB | ~20 GB |
|
|
275
|
-
| `gemma4:31b` | ~24 GB | ~26 GB |
|
|
276
|
-
|
|
277
|
-
See [docs/hardware-guide.md](docs/hardware-guide.md) for full details including VPS swap setup.
|
|
278
|
-
|
|
279
|
-
</details>
|
|
280
|
-
|
|
281
|
-
---
|
|
282
|
-
|
|
283
|
-
## π Links
|
|
284
|
-
|
|
285
|
-
- [OpenClaw Docs](https://openclaw.ai/docs)
|
|
286
|
-
- [9Router](https://github.com/decolua/9router)
|
|
287
|
-
- [Google AI Studio](https://aistudio.google.com/)
|
|
288
|
-
- [Telegram BotFather](https://t.me/BotFather)
|
|
289
|
-
- [Zalo Developer Platform](https://developers.zalo.me)
|
|
290
|
-
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
|
|
291
|
-
- [Ollama](https://ollama.com)
|
|
292
|
-
- [OpenRouter](https://openrouter.ai)
|
|
293
|
-
- [ClawHub (Skills)](https://clawhub.com)
|
|
294
|
-
|
|
295
|
-
---
|
|
296
|
-
|
|
297
|
-
## π Star History
|
|
298
|
-
|
|
299
|
-
<div align="center">
|
|
300
|
-
|
|
301
|
-
[](https://starchart.cc/tuanminhhole/openclaw-setup)
|
|
302
|
-
|
|
303
|
-
</div>
|
|
304
|
-
|
|
305
|
-
---
|
|
306
|
-
|
|
307
|
-
## π Acknowledgments
|
|
308
|
-
|
|
309
|
-
- [OpenClaw](https://openclaw.ai) β AI Gateway framework
|
|
310
|
-
- [9Router](https://github.com/decolua/9router) β Open-source AI proxy (OAuth-based, no API keys)
|
|
311
|
-
- [Playwright](https://playwright.dev) β Browser automation engine
|
|
312
|
-
- [ClawHub](https://clawhub.com) β Skills registry
|
|
313
|
-
- [TheSVG](https://thesvg.org) β High-quality SVG brand icons
|
|
314
|
-
|
|
315
|
-
---
|
|
316
|
-
|
|
317
|
-
<div align="center">
|
|
318
|
-
|
|
319
|
-
Made with π¦ by [Kent](https://github.com/tuanminhhole)
|
|
320
|
-
|
|
321
|
-
</div>
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# π¦ OpenClaw Setup
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://github.com/tuanminhhole/openclaw-setup/releases"><img src="https://img.shields.io/badge/RELEASE-v5.4.2-0EA5E9?style=for-the-badge" alt="Version 5.4.2" /></a>
|
|
7
|
+
<a href="https://github.com/tuanminhhole/openclaw-setup?tab=MIT-1-ov-file"><img src="https://img.shields.io/badge/LICENSE-MIT-success?style=for-the-badge" alt="MIT License" /></a>
|
|
8
|
+
<a href="https://www.npmjs.com/package/create-openclaw-bot"><img src="https://img.shields.io/npm/v/create-openclaw-bot?style=for-the-badge&label=CLI&color=2563EB&logo=npm&logoColor=white" alt="NPM Version" /></a>
|
|
9
|
+
<a href="https://github.com/tuanminhhole/openclaw-setup/stargazers"><img src="https://img.shields.io/github/stars/tuanminhhole/openclaw-setup?style=for-the-badge&color=eab308&logo=github&logoColor=white" alt="GitHub Stars" /></a>
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
<p style="margin-top: 16px;">
|
|
13
|
+
<img src="https://flagcdn.com/24x18/gb.png" alt="English" width="24" height="18" style="vertical-align: sub;"> <strong>English</strong> Β·
|
|
14
|
+
<img src="https://flagcdn.com/24x18/vn.png" alt="TiαΊΏng Viα»t" width="24" height="18" style="vertical-align: sub;"> <a href="README.vi.md">TiαΊΏng Viα»t</a>
|
|
15
|
+
</p>
|
|
16
|
+
|
|
17
|
+
An interactive **CLI tool** and **Setup Wizard** to deploy your own free AI Bot on Telegram or Zalo in minutes β supports **Windows, macOS, Ubuntu, and VPS**.
|
|
18
|
+
|
|
19
|
+
<a href="https://github.com/tuanminhhole/openclaw-setup">
|
|
20
|
+
<img src="https://raw.githubusercontent.com/tuanminhhole/openclaw-setup/main/docs/preview.png" alt="OpenClaw Setup Hero Image" width="100%" style="border-radius: 8px; margin: 16px 0; border: 1px solid #333;" />
|
|
21
|
+
</a>
|
|
22
|
+
|
|
23
|
+
</div>
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## π What's new in v5.4.2
|
|
28
|
+
|
|
29
|
+
- ποΈ **Multi-bot architecture refactored** β All duplicate flags (`isTelegramMultiBot`, `isSharedMultiBot`, `isMultiBotWizard`) merged into a single `isMultiBot`. Generated `agentDir` paths now correctly point to `.openclaw/agents/{slug}/agent` relative to `OPENCLAW_HOME`.
|
|
30
|
+
- ποΈ **Telegram + Zalo combo channel removed** β Combo mode has been deprecated and removed from both the Web Wizard and CLI. It will be redesigned in a future release.
|
|
31
|
+
- π€ **Cross-workspace rules in `AGENTS.md`** β In multi-bot mode, each bot's `AGENTS.md` now includes a dedicated section describing which sibling workspace paths may be read and what write restrictions apply.
|
|
32
|
+
- π§Ή **Cleaner config generation** β Per-agent `auth-profiles.json` is no longer created for 9Router/proxy setups. Native scripts no longer generate `.env` files; credentials are managed via `openclaw channels login`.
|
|
33
|
+
|
|
34
|
+
<details>
|
|
35
|
+
<summary><b>Previous: What's new in v5.3.5</b></summary>
|
|
36
|
+
|
|
37
|
+
- π **Fix: Telegram token input missing in combo channel** β When selecting "Telegram + Zalo Personal", the wizard now shows the Telegram Bot Token input field AND the Zalo Personal warning side by side.
|
|
38
|
+
- π **Fix: Next button stuck on step 4 for combo** β Validation now correctly requires a Telegram token before enabling "Generate Configs" in combo mode.
|
|
39
|
+
- π **Fix: Windows Docker script crashes with "docker not recognized"** β The generated `.ps1` now uses `Get-Command` to locate Docker, checks that Docker Desktop is running, and calls it via `&` operator β works even when Docker isn't in the default PowerShell PATH.
|
|
40
|
+
- π **Fix: Zalo QR login instructions missing for combo in Windows script** β Post-install notes now show the `docker compose exec` login command when the combo channel is selected.
|
|
41
|
+
|
|
42
|
+
</details>
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## β¨ Features
|
|
47
|
+
|
|
48
|
+
- π€ **Multi-channel** β Telegram (single or multi-bot), Zalo Bot API, or Zalo Personal
|
|
49
|
+
- π§βπ€βπ§ **Multi-bot team** β Run up to 5 Telegram bots simultaneously. Bots share a workspace, collaborate on tasks, and coordinate in a group chat using the Department Room Model
|
|
50
|
+
- π§ **Multi-provider AI** β Google Gemini, Claude, GPT-4o, OpenRouter, Ollama (local), 9Router
|
|
51
|
+
- 𧩠**Skills** β Web Search, Browser Automation, Memory, RAG, Code Interpreter, Image Gen
|
|
52
|
+
- π **Plugins** β Voice Call, Matrix, MS Teams, Nostr
|
|
53
|
+
- π **9Router** β Free AI proxy. OAuth login, no API keys. Supports Claude Code, Codex, Gemini CLI.
|
|
54
|
+
- π§ **Setup Wizard** β 5-step visual web UI (`index.html`). No terminal required.
|
|
55
|
+
- π» **Interactive CLI** β `npx create-openclaw-bot` β best for Ubuntu, VPS, engineers.
|
|
56
|
+
- π **100% Free to start** β 9Router + Gemini free tier requires zero spending
|
|
57
|
+
- π **Private** β API keys stay on your machine, never sent anywhere
|
|
58
|
+
- β‘ **Fast** β From zero to working bot in under 5 minutes
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## πΊοΈ Choose your path
|
|
63
|
+
|
|
64
|
+
> **Not sure which method to use?** The table below has you covered:
|
|
65
|
+
|
|
66
|
+
| Who you are | Environment | Recommended path |
|
|
67
|
+
| -------------------------- | --------------- | ------------------------------------- |
|
|
68
|
+
| Not familiar with terminal | Windows / macOS | **Web Wizard** (`index.html`) |
|
|
69
|
+
| Not familiar with terminal | Ubuntu Desktop | **Web Wizard** β choose Native |
|
|
70
|
+
| Comfortable with terminal | Ubuntu / VPS | **CLI** (`npx create-openclaw-bot`) |
|
|
71
|
+
| Want full automation | Anywhere | **AI Agent** (Antigravity + SETUP.md) |
|
|
72
|
+
|
|
73
|
+
### 1οΈβ£ Option A β Web Wizard (No terminal required)
|
|
74
|
+
|
|
75
|
+
Best for **Windows and macOS**. No command line at all.
|
|
76
|
+
|
|
77
|
+
1. [Download ZIP](https://github.com/tuanminhhole/openclaw-setup/archive/refs/heads/main.zip) or clone this repo.
|
|
78
|
+
2. Open `index.html` in your browser.
|
|
79
|
+
3. Follow the **5-step wizard**:
|
|
80
|
+
- **Step 1:** Choose your OS (Windows / macOS / Ubuntu / VPS)
|
|
81
|
+
- **Step 2:** Choose your bot channel (Telegram / Zalo)
|
|
82
|
+
- **Step 3:** Choose your AI provider and model
|
|
83
|
+
- **Step 4:** Enter bot token and configure settings
|
|
84
|
+
- **Step 5:** Download your script and run it β done!
|
|
85
|
+
4. The downloaded script automatically installs everything needed (9Router, Ollama, Docker, etc.) based on your choices.
|
|
86
|
+
|
|
87
|
+
> **Docker or no Docker?**
|
|
88
|
+
>
|
|
89
|
+
> - **Windows / macOS** β Use **Docker** (fully isolated, easy to manage)
|
|
90
|
+
> - **Ubuntu / VPS** β Use **Native (no Docker)** (less RAM, more stable)
|
|
91
|
+
|
|
92
|
+
### 2οΈβ£ Option B β Interactive CLI (`npx`)
|
|
93
|
+
|
|
94
|
+
Best for **engineers, Ubuntu Desktop, VPS**. Fastest and most powerful.
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npx create-openclaw-bot
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Run in your terminal β follow the interactive prompts β startup script is generated automatically.
|
|
101
|
+
|
|
102
|
+
> Requires: **Node.js 20/22/24**. Check: `node -v`
|
|
103
|
+
>
|
|
104
|
+
> Note: **avoid Node.js 25 for now**. There are reports of OpenClaw failing on Node 25.
|
|
105
|
+
|
|
106
|
+
<details>
|
|
107
|
+
<summary><b>3οΈβ£ Option C β AI Agent (Antigravity)</b></summary>
|
|
108
|
+
<br>
|
|
109
|
+
|
|
110
|
+
1. Open [Antigravity IDE](https://antigravity.dev/)
|
|
111
|
+
2. Open this repo as your workspace
|
|
112
|
+
3. Paste into chat:
|
|
113
|
+
```
|
|
114
|
+
Read SETUP.md and set up OpenClaw v5.3.1 for me.
|
|
115
|
+
My bot token is X. Use 9Router (no API key).
|
|
116
|
+
My project folder: <YOUR_PATH>
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
</details>
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## π Prerequisites
|
|
124
|
+
|
|
125
|
+
### Without Docker (Native β recommended for Ubuntu/VPS)
|
|
126
|
+
|
|
127
|
+
| Requirement | Notes |
|
|
128
|
+
| ----------------------- | -------------------------------------------------------------------------- |
|
|
129
|
+
| **Node.js 20/22/24** | [Download](https://nodejs.org/) Β· Check: `node -v` Β· Avoid Node 25 for now |
|
|
130
|
+
| **An AI provider** | 9Router (free) or Gemini/Claude/GPT-4o |
|
|
131
|
+
| **Bot Token** | From Telegram BotFather or Zalo Developer |
|
|
132
|
+
| **Ollama** _(optional)_ | Only if you want to run Gemma 4 locally Β· [Download](https://ollama.com/) |
|
|
133
|
+
|
|
134
|
+
### With Docker (recommended for Windows/macOS)
|
|
135
|
+
|
|
136
|
+
| Requirement | Notes |
|
|
137
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
138
|
+
| **Node.js 20/22/24** | [Download](https://nodejs.org/) Β· Check: `node -v` Β· Avoid Node 25 for now |
|
|
139
|
+
| **Docker Desktop + Compose V2** | [Download](https://www.docker.com/products/docker-desktop/) Β· Check: `docker compose version` |
|
|
140
|
+
| **An AI provider** | 9Router runs as a sidecar container β no separate install needed |
|
|
141
|
+
| **Bot Token** | From Telegram BotFather or Zalo Developer |
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## π§ Supported Providers
|
|
146
|
+
|
|
147
|
+
| Provider | Cost | API Key | Notes |
|
|
148
|
+
| -------------------- | ------------ | -------- | ----------------------------------------------------------------------------------------- |
|
|
149
|
+
| **9Router** | π Free | β OAuth | Recommended for beginners. Auto-routes to best model. Supports Claude CLI, Codex, Gemini. |
|
|
150
|
+
| **Google Gemini** | π Free tier | β
Yes | High quality. Very generous free tier. |
|
|
151
|
+
| **Ollama / Gemma 4** | π Free | β No | Runs 100% offline. Auto-pulls model on first start. |
|
|
152
|
+
| **Anthropic Claude** | π° Paid | β
Yes | Best reasoning and writing quality. |
|
|
153
|
+
| **OpenAI / Codex** | π° Paid | β
Yes | GPT-4o, Codex Mini. |
|
|
154
|
+
| **OpenRouter** | π/π° Mixed | β
Yes | Many models under one key. Some are free. |
|
|
155
|
+
|
|
156
|
+
> π **9Router v0.3.75+** adds lossless passthrough for Claude Code, Codex, Gemini CLI, and Antigravity β meaning these AI tools can use 9Router as their endpoint without any data loss. See [docs/ai-providers.md](docs/ai-providers.md) for setup details.
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## π Supported Channels
|
|
161
|
+
|
|
162
|
+
- **Telegram** (β
Official) β Search **@BotFather** β `/newbot` β Copy token.
|
|
163
|
+
- **Zalo Bot API** (β
Official) β Go to [developers.zalo.me](https://developers.zalo.me) β Create bot β Copy token.
|
|
164
|
+
- **Zalo Personal** (β οΈ Unofficial) β Scan QR after setup (no token needed). Use a secondary account.
|
|
165
|
+
|
|
166
|
+
> β οΈ **Zalo Personal** uses an unofficial API. Your account may be restricted. Use a secondary account only.
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## π Repo Structure
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
index.html β Setup Wizard UI (open in browser)
|
|
174
|
+
style.css β Wizard styles
|
|
175
|
+
setup.js β Wizard logic
|
|
176
|
+
cli.js β Interactive CLI (npx create-openclaw-bot)
|
|
177
|
+
CHANGELOG.md/.vi.md β Version history
|
|
178
|
+
README.md β You're here (English)
|
|
179
|
+
README.vi.md β HΖ°α»ng dαΊ«n tiαΊΏng Viα»t
|
|
180
|
+
SETUP.md/.vi.md β Technical guide for AI Agent
|
|
181
|
+
docs/
|
|
182
|
+
install-docker.md/.vi.md β Docker setup per OS
|
|
183
|
+
install-native.md/.vi.md β Native/PM2 install per OS
|
|
184
|
+
ai-providers.md/.vi.md β AI provider configuration
|
|
185
|
+
hardware-guide.md/.vi.md β RAM planning for Ollama/Gemma 4
|
|
186
|
+
faq.md/.vi.md β Frequently asked questions
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
> **Note:** Startup scripts (`.bat`, `.sh`) are **not included** in the repo β they are generated by the Web Wizard or CLI based on your specific configuration.
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## β FAQ
|
|
194
|
+
|
|
195
|
+
<details>
|
|
196
|
+
<summary><b>Is it really free?</b></summary>
|
|
197
|
+
|
|
198
|
+
Yes. Docker, Google Gemini API (free tier), and Telegram/Zalo bot tokens are all free. You only pay if you choose a paid AI provider like Claude or GPT-4o.
|
|
199
|
+
|
|
200
|
+
</details>
|
|
201
|
+
|
|
202
|
+
<details>
|
|
203
|
+
<summary><b>Where does the bot run?</b></summary>
|
|
204
|
+
|
|
205
|
+
On your computer or server. With Docker it runs in a container; with Native mode it runs as a PM2-managed process. If the machine is off, the bot is off. Use a VPS for 24/7 uptime.
|
|
206
|
+
|
|
207
|
+
</details>
|
|
208
|
+
|
|
209
|
+
<details>
|
|
210
|
+
<summary><b>Do I need Docker?</b></summary>
|
|
211
|
+
|
|
212
|
+
No. Docker is optional. Windows/macOS users should use Docker for clean isolation. Ubuntu/VPS users should install natively with PM2 β less overhead and OpenClaw is already secure by design.
|
|
213
|
+
|
|
214
|
+
</details>
|
|
215
|
+
|
|
216
|
+
<details>
|
|
217
|
+
<summary><b>How do I stop/restart the bot?</b></summary>
|
|
218
|
+
|
|
219
|
+
**Docker:**
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
docker compose down # Stop
|
|
223
|
+
docker compose up -d # Start
|
|
224
|
+
docker compose restart # Restart
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
**PM2 (native):**
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
pm2 stop openclaw-bot
|
|
231
|
+
pm2 start openclaw-bot
|
|
232
|
+
pm2 restart openclaw-bot
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
</details>
|
|
236
|
+
|
|
237
|
+
<details>
|
|
238
|
+
<summary><b>Can I switch AI models later?</b></summary>
|
|
239
|
+
|
|
240
|
+
Yes. Re-run `npx create-openclaw-bot` in your bot folder, or edit `.openclaw/openclaw.json` directly and restart the bot.
|
|
241
|
+
|
|
242
|
+
</details>
|
|
243
|
+
|
|
244
|
+
<details>
|
|
245
|
+
<summary><b>Is it safe?</b></summary>
|
|
246
|
+
|
|
247
|
+
Your API keys are stored only on your machine in a local `.env` file. OpenClaw never transmits them anywhere. When using Ollama, all AI inference runs completely offline.
|
|
248
|
+
|
|
249
|
+
</details>
|
|
250
|
+
|
|
251
|
+
<details>
|
|
252
|
+
<summary><b>What is 9Router?</b></summary>
|
|
253
|
+
|
|
254
|
+
9Router is an open-source AI proxy. Instead of managing API keys from multiple providers, you log in once via OAuth at `localhost:20128/dashboard`. It auto-routes requests to the best available AI model. Starting v0.3.75, it also supports lossless passthrough for Claude Code, Codex, Gemini CLI, and Antigravity.
|
|
255
|
+
|
|
256
|
+
</details>
|
|
257
|
+
|
|
258
|
+
<details>
|
|
259
|
+
<summary><b>What's the difference between Skills and Plugins?</b></summary>
|
|
260
|
+
|
|
261
|
+
**Skills** add agent capabilities (Web Search, Browser Automation, Memory, RAG, Code Interpreter...) β install via `openclaw skills install` from ClawHub.
|
|
262
|
+
|
|
263
|
+
**Plugins** add channels or runtime extensions (Voice Call, Matrix, MS Teams...) β install via `openclaw plugins install` from npm.
|
|
264
|
+
|
|
265
|
+
</details>
|
|
266
|
+
|
|
267
|
+
<details>
|
|
268
|
+
<summary><b>How much RAM do I need for Gemma 4?</b></summary>
|
|
269
|
+
|
|
270
|
+
| Model | Min RAM (Native) | Min RAM (Docker) |
|
|
271
|
+
| ------------ | ---------------- | ---------------- |
|
|
272
|
+
| `gemma4:e2b` | ~4 GB | ~5 GB |
|
|
273
|
+
| `gemma4:e4b` | ~8 GB | ~9 GB |
|
|
274
|
+
| `gemma4:26b` | ~18 GB | ~20 GB |
|
|
275
|
+
| `gemma4:31b` | ~24 GB | ~26 GB |
|
|
276
|
+
|
|
277
|
+
See [docs/hardware-guide.md](docs/hardware-guide.md) for full details including VPS swap setup.
|
|
278
|
+
|
|
279
|
+
</details>
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## π Links
|
|
284
|
+
|
|
285
|
+
- [OpenClaw Docs](https://openclaw.ai/docs)
|
|
286
|
+
- [9Router](https://github.com/decolua/9router)
|
|
287
|
+
- [Google AI Studio](https://aistudio.google.com/)
|
|
288
|
+
- [Telegram BotFather](https://t.me/BotFather)
|
|
289
|
+
- [Zalo Developer Platform](https://developers.zalo.me)
|
|
290
|
+
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
|
|
291
|
+
- [Ollama](https://ollama.com)
|
|
292
|
+
- [OpenRouter](https://openrouter.ai)
|
|
293
|
+
- [ClawHub (Skills)](https://clawhub.com)
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
## π Star History
|
|
298
|
+
|
|
299
|
+
<div align="center">
|
|
300
|
+
|
|
301
|
+
[](https://starchart.cc/tuanminhhole/openclaw-setup)
|
|
302
|
+
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
|
|
307
|
+
## π Acknowledgments
|
|
308
|
+
|
|
309
|
+
- [OpenClaw](https://openclaw.ai) β AI Gateway framework
|
|
310
|
+
- [9Router](https://github.com/decolua/9router) β Open-source AI proxy (OAuth-based, no API keys)
|
|
311
|
+
- [Playwright](https://playwright.dev) β Browser automation engine
|
|
312
|
+
- [ClawHub](https://clawhub.com) β Skills registry
|
|
313
|
+
- [TheSVG](https://thesvg.org) β High-quality SVG brand icons
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
<div align="center">
|
|
318
|
+
|
|
319
|
+
Made with π¦ by [Kent](https://github.com/tuanminhhole)
|
|
320
|
+
|
|
321
|
+
</div>
|