You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): restructure for clarity, improve Quick Start section
Simplify hero banner, reorganize sections for better scannability,
and update screenshots table layout.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
<h1align="center">OpenClaw Desktop – Windows Installer & Native Desktop App for OpenClaw AI Agents</h1>
6
-
7
-
<palign="center">
8
-
<strong>Official-style desktop installer & Windows distribution for <ahref="https://github.com/openclaw/openclaw">OpenClaw</a>. Part of the OpenClaw ecosystem.</strong><br />
9
-
<strong>OpenClaw 小龙虾官方桌面版一键安装部署 EXE 程序。</strong>
10
-
</p>
11
-
12
-
<palign="center">
13
-
<strong>v0.1.1 — What’s new / 更新亮点</strong><br />
14
-
<strong>EN:</strong> <strong>Feishu Access</strong> — DM pairing & allowlist inside the app (Settings, Dashboard, tray); <code>pairing approve</code> uses the bundled runtime. Updated bundled OpenClaw <code>2026.3.13</code>; Kuae domains merged into <code>NO_PROXY</code> for the gateway when using HTTPS proxy.<br />
This project provides a one-click desktop installer for OpenClaw on Windows, packaging the official OpenClaw runtime with a native desktop experience.
21
-
</p>
22
-
23
-
<palign="center">
24
-
⭐ <strong>If this project helps you, please give it a star!</strong> ⭐<br />
25
-
⭐ <strong>如果这个项目对你有帮助,请点一个 Star 让更多人看到!</strong> ⭐
26
-
</p>
27
-
28
-
<palign="center">
29
-
Run OpenClaw on Windows with a native GUI, bundled runtime, guided setup wizard, built‑in updater, and a downloadable <code>.exe</code> installer.<br />
30
-
在 Windows 上通过原生桌面 GUI、内置运行时、引导式安装向导和可下载的 <code>.exe</code> 安装程序,一键运行 OpenClaw。
2
+
<strong>Language / 语言:</strong>
3
+
<strong>English</strong>
4
+
|
5
+
<ahref="./README.zh-CN.md">简体中文</a>
31
6
</p>
32
7
33
8
<palign="center">
34
-
<imgsrc="resources/demo.gif"alt="OpenClaw Desktop Demo running an AI agent on Windows"width="600" />
35
-
</p>
36
-
37
-
<palign="center">
38
-
<imgsrc="resources/screenshot-installer-user-scope.png"alt="OpenClaw Desktop Windows installer user scope options"width="420" />
<imgsrc="resources/screenshot-setup-wizard.png"alt="OpenClaw Desktop first-run setup wizard on Windows"width="640" />
43
-
</p>
12
+
<h1align="center">OpenClaw Desktop</h1>
44
13
45
14
<palign="center">
46
-
<imgsrc="resources/screenshot-gateway-dashboard.png"alt="OpenClaw Control gateway dashboard running on Windows"width="640" />
15
+
<strong>Community-maintained Windows desktop app and installer for <ahref="https://github.com/openclaw/openclaw">OpenClaw</a>.</strong><br />
16
+
Native GUI, bundled runtime, guided setup wizard, and in-app updates for running OpenClaw on Windows.
47
17
</p>
48
18
49
19
<palign="center">
@@ -55,144 +25,100 @@
55
25
</p>
56
26
57
27
<palign="center">
58
-
<ahref="./README.zh-CN.md">简体中文 / Chinese</a> •
59
-
<ahref="#whats-new">What's new</a> •
28
+
<ahref="#overview">Overview</a> •
29
+
<ahref="#whats-new-in-v011">What's New</a> •
60
30
<ahref="#download">Download</a> •
61
-
<ahref="#how-to-install-openclaw-on-windows">Why it exists</a> •
31
+
<ahref="#screenshots">Screenshots</a> •
32
+
<ahref="#quick-start">Quick Start</a> •
62
33
<ahref="#features">Features</a> •
63
-
<ahref="#quick-start">Quick start</a> •
34
+
<ahref="#feishu-settings--pairing">Feishu</a> •
64
35
<ahref="#development">Development</a> •
65
-
<ahref="#changelog">Changelog</a> •
66
36
<ahref="#faq">FAQ</a>
67
37
</p>
68
38
69
-
## What's new
70
-
71
-
**Current release: v0.1.1** — same highlights as the banner above, with more detail.
72
-
73
-
**English — highlights in v0.1.1**
74
-
75
-
-**Feishu access & pairing:** Approve Feishu DM pairing and manage the allowlist inside the desktop app—no global `openclaw` CLI required. Open **Feishu Access** from **Settings**, the **Dashboard**, or the **tray menu**; review pending pairing codes, approve requests, edit approved senders, or add an `open_id` manually. Approval calls use the **bundled** Node/OpenClaw runtime so behavior matches upstream.
76
-
-**First-run guidance:** The setup wizard completion step reminds you to DM the bot and then finish access under **Settings → Feishu Access** when using Feishu with pairing.
> `OpenClaw Desktop` is a Windows distribution that packages the upstream OpenClaw runtime into an easier desktop experience. Part of the broader OpenClaw ecosystem.
- Includes / 包含内容: Electron shell, bundled Node.js runtime, bundled OpenClaw package
93
-
- Also published / 同时发布: checksum file and `latest.yml` for in-app updates
39
+
<palign="center">
40
+
<imgsrc="resources/demo.gif"alt="OpenClaw Desktop Demo running an AI agent on Windows"width="720" />
41
+
</p>
94
42
95
-
## Changelog
43
+
## Overview
96
44
97
-
### 0.1.1
45
+
`OpenClaw Desktop` packages the OpenClaw runtime into a normal Windows install experience. You download one `.exe`, finish a setup wizard, configure your provider and channel, and run OpenClaw from a native desktop shell instead of wiring everything by hand.
-**OpenClaw runtime:** Bundled OpenClaw has been updated to the latest version `2026.3.13`, and the desktop app now supports the latest OpenClaw runtime.
101
-
-**Kuae (夸娥云 Coding Plan) & HTTPS proxy:** When the bundled OpenClaw **gateway** child process inherits system `HTTP(S)_PROXY`, some local proxies break TLS to Kuae’s API (`coding-plan-endpoint.kuaecloud.net`). The desktop app now **merges**`NO_PROXY` / `no_proxy` for `coding-plan-endpoint.kuaecloud.net` and `.kuaecloud.net` on gateway spawn so Kuae traffic can go **direct** while other providers still follow your proxy settings. Set `OPENCLAW_SKIP_KUAE_NO_PROXY=1` to disable this merge. See [FAQ → Kuae and HTTPS proxy](#faq).
102
-
-**文档 / Docs:** README FAQ and changelog for the above (English + 简体中文).
47
+
It is designed for users who want:
103
48
104
-
### 0.1.0
49
+
- A Windows-first installer and GUI for OpenClaw
50
+
- Bundled Node.js and bundled OpenClaw runtime
51
+
- Guided provider, channel, and gateway setup
52
+
- Built-in update flow from GitHub Releases
53
+
- Desktop-native Feishu pairing and allowlist management
105
54
106
-
- Initial public release track with Windows installer, setup wizard, bundled runtime, and updater.
55
+
## What's New In v0.1.1
107
56
108
-
## How to install OpenClaw on Windows?
57
+
-**Feishu Settings:** Feishu credentials, DM pairing, and allowlist management now live inside the desktop app. Open **Feishu Settings** from **Settings**, the **Dashboard**, or the **tray menu**.
58
+
-**Desktop approval flow:** Pending Feishu requests can be approved directly in the app. If you only have a pairing code, Desktop falls back to the bundled OpenClaw runtime for approval.
59
+
-**Bundled runtime update:** Bundled OpenClaw is updated to `2026.3.13`.
60
+
-**Kuae proxy fix:** When the gateway inherits `HTTP(S)_PROXY`, Desktop now merges `NO_PROXY` / `no_proxy` for `coding-plan-endpoint.kuaecloud.net` and `.kuaecloud.net` so Kuae traffic can bypass problematic HTTPS proxies.
109
61
110
-
`OpenClaw` is a powerful open-source AI agent project, but many users wonder **how to install OpenClaw on Windows**, **how to run OpenClaw locally**, or **how to get an OpenClaw Windows installer** without a terminal‑only setup flow.
62
+
More history: [CHANGELOG.md](CHANGELOG.md)
111
63
112
-
`OpenClaw Desktop` turns that into a normal desktop install experience:
64
+
## Download
113
65
114
-
- Download one installer instead of wiring everything manually
115
-
- Launch from Start Menu or Desktop shortcut
116
-
- Configure providers, channels, and gateway from a visual setup wizard
117
-
- Update from GitHub Releases without reinstalling from scratch each time
If the pending list is empty but you already received a pairing code in Feishu, use the code-based approval path on the same screen. Desktop will use the bundled runtime as a fallback for that case.
190
116
191
117
## Development
192
118
193
119
Prerequisites:
194
120
195
-
- Node.js `>= 22.12.0`
121
+
- Node.js `>= 22.16.0`
196
122
-`pnpm`
197
123
- Windows 10/11 for packaging and end-to-end validation
198
124
@@ -211,6 +137,7 @@ pnpm type-check
211
137
pnpm build
212
138
pnpm run download-node
213
139
pnpm run download-openclaw
140
+
pnpm run verify-bundle
214
141
pnpm run prepare-bundle
215
142
pnpm run package:win
216
143
```
@@ -219,94 +146,58 @@ Build output:
219
146
220
147
-`dist/OpenClaw-Setup-<version>.exe`
221
148
222
-
Windows 安装包使用 NSIS;仓库根目录下的 `build/installer.nsh` 为自定义脚本(由 `electron-builder` 引用),**需保留并提交**,勿删除(`.gitignore` 已对该文件单独放行)。
223
-
224
-
## Project Structure
225
-
226
-
```text
227
-
openclaw-desktop/
228
-
├─ src/
229
-
│ ├─ main/
230
-
│ ├─ preload/
231
-
│ ├─ renderer/
232
-
│ └─ shared/
233
-
├─ scripts/
234
-
├─ resources/
235
-
├─ build/
236
-
└─ .github/workflows/
237
-
```
238
-
239
-
## FAQ
149
+
Related docs:
240
150
241
-
<details>
242
-
<summary><strong>Is this part of the OpenClaw ecosystem?</strong></summary>
Yes, this is an official-style desktop distribution that packages upstream OpenClaw into a Windows desktop shell for an easier local setup.
245
-
</details>
158
+
## FAQ
246
159
247
160
<details>
248
161
<summary><strong>Do I need Node.js installed globally?</strong></summary>
249
162
250
-
No. The installer bundles a portable Node.js runtime that is shipped with the application.
163
+
No. The installer ships with a portable Node.js runtime.
251
164
</details>
252
165
253
166
<details>
254
-
<summary><strong>Where do I download the EXE?</strong></summary>
167
+
<summary><strong>Where do I download the installer?</strong></summary>
255
168
256
169
Use the latest release page: <ahref="https://github.com/agentkernel/openclaw-desktop/releases/latest">github.com/agentkernel/openclaw-desktop/releases/latest</a>. The main asset is <code>OpenClaw-Setup-<version>.exe</code>.
257
170
</details>
258
171
259
172
<details>
260
-
<summary><strong>Where is my data stored?</strong></summary>
173
+
<summary><strong>Where is user data stored?</strong></summary>
Uninstalling the app does not delete user configuration by default.
180
+
Uninstalling the app does not remove user configuration by default.
268
181
</details>
269
182
270
183
<details>
271
184
<summary><strong>How do updates work?</strong></summary>
272
185
273
-
The app checks GitHub Releases and can download updates through the built-in updater. Release assets also remain available for manual download and rollback.
186
+
Desktop checks GitHub Releases and can download updates through the built-in updater. You can also download older assets manually for rollback.
274
187
</details>
275
188
276
189
<details>
277
-
<summary><strong>Kuae (夸娥云) and HTTPS proxy on Windows</strong></summary>
190
+
<summary><strong>What does the Kuae HTTPS proxy fix do?</strong></summary>
278
191
279
-
The bundled OpenClaw **gateway** runs as a child process that inherits `HTTP(S)_PROXY`. Some local proxies break TLS to Kuae’s Coding Plan endpoint. The desktop app therefore **merges**`NO_PROXY` / `no_proxy` for `coding-plan-endpoint.kuaecloud.net` and `.kuaecloud.net` when spawning the gateway, so Kuae traffic goes **direct** while other URLs can still use the proxy.
192
+
When the bundled OpenClaw gatewayinherits <code>HTTP(S)_PROXY</code>, some local proxies break TLS to Kuae's Coding Plan endpoint. Desktop therefore merges <code>NO_PROXY</code> / <code>no_proxy</code> for <code>coding-plan-endpoint.kuaecloud.net</code> and <code>.kuaecloud.net</code> so Kuae traffic can go direct while other traffic still uses your proxy.
280
193
281
-
To disable this merge (e.g. debugging), set environment variable `OPENCLAW_SKIP_KUAE_NO_PROXY=1` before starting OpenClaw Desktop.
0 commit comments