Skip to content

Commit 077aed6

Browse files
agentkernelclaude
andcommitted
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>
1 parent fa6b192 commit 077aed6

1 file changed

Lines changed: 86 additions & 195 deletions

File tree

README.md

Lines changed: 86 additions & 195 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,19 @@
11
<p align="center">
2-
<img src="resources/apple-touch-icon.png" alt="OpenClaw Desktop" width="128" height="128" />
3-
</p>
4-
5-
<h1 align="center">OpenClaw Desktop – Windows Installer &amp; Native Desktop App for OpenClaw AI Agents</h1>
6-
7-
<p align="center">
8-
<strong>Official-style desktop installer &amp; Windows distribution for <a href="https://github.com/openclaw/openclaw">OpenClaw</a>. Part of the OpenClaw ecosystem.</strong><br />
9-
<strong>OpenClaw 小龙虾官方桌面版一键安装部署 EXE 程序。</strong>
10-
</p>
11-
12-
<p align="center">
13-
<strong>v0.1.1 — What’s new / 更新亮点</strong><br />
14-
<strong>EN:</strong> <strong>Feishu Access</strong> — DM pairing &amp; 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 />
15-
<strong>中文:</strong> <strong>飞书访问</strong> — 应用内私聊配对与放行名单(设置、控制台、托盘);配对批准走内置运行时。捆绑 OpenClaw <code>2026.3.13</code>;使用 HTTPS 代理时为网关合并 Kuae 域名至 <code>NO_PROXY</code>。<br />
16-
<a href="#whats-new">Full notes ↓</a>
17-
</p>
18-
19-
<p align="center">
20-
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-
<p align="center">
24-
⭐ <strong>If this project helps you, please give it a star!</strong> ⭐<br />
25-
⭐ <strong>如果这个项目对你有帮助,请点一个 Star 让更多人看到!</strong> ⭐
26-
</p>
27-
28-
<p align="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+
<a href="./README.zh-CN.md">简体中文</a>
316
</p>
327

338
<p align="center">
34-
<img src="resources/demo.gif" alt="OpenClaw Desktop Demo running an AI agent on Windows" width="600" />
35-
</p>
36-
37-
<p align="center">
38-
<img src="resources/screenshot-installer-user-scope.png" alt="OpenClaw Desktop Windows installer user scope options" width="420" />
9+
<img src="resources/apple-touch-icon.png" alt="OpenClaw Desktop" width="128" height="128" />
3910
</p>
4011

41-
<p align="center">
42-
<img src="resources/screenshot-setup-wizard.png" alt="OpenClaw Desktop first-run setup wizard on Windows" width="640" />
43-
</p>
12+
<h1 align="center">OpenClaw Desktop</h1>
4413

4514
<p align="center">
46-
<img src="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 <a href="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.
4717
</p>
4818

4919
<p align="center">
@@ -55,144 +25,100 @@
5525
</p>
5626

5727
<p align="center">
58-
<a href="./README.zh-CN.md">简体中文 / Chinese</a> •
59-
<a href="#whats-new">What's new</a> •
28+
<a href="#overview">Overview</a> •
29+
<a href="#whats-new-in-v011">What's New</a> •
6030
<a href="#download">Download</a> •
61-
<a href="#how-to-install-openclaw-on-windows">Why it exists</a> •
31+
<a href="#screenshots">Screenshots</a> •
32+
<a href="#quick-start">Quick Start</a> •
6233
<a href="#features">Features</a> •
63-
<a href="#quick-start">Quick start</a> •
34+
<a href="#feishu-settings--pairing">Feishu</a> •
6435
<a href="#development">Development</a> •
65-
<a href="#changelog">Changelog</a> •
6636
<a href="#faq">FAQ</a>
6737
</p>
6838

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.
77-
78-
**中文 — v0.1.1 亮点**
79-
80-
- **飞书访问与配对:** 在桌面端内完成飞书私聊配对与放行名单管理,无需依赖全局安装的 `openclaw` CLI。可通过 **设置 → 飞书访问****控制台****托盘菜单** 进入;查看待处理配对码、批准请求、维护已放行用户或手动添加 `open_id`。批准操作通过**内置** Node/OpenClaw 运行时调用,与上游行为一致。
81-
- **首次运行提示:** 使用飞书且为配对模式时,完成向导会提示先向机器人发私聊,再到 **设置 → 飞书访问** 完成授权。
82-
83-
> `OpenClaw Desktop` is a Windows distribution that packages the upstream OpenClaw runtime into an easier desktop experience. Part of the broader OpenClaw ecosystem.
84-
85-
## Download
86-
87-
**Primary download:** [GitHub Releases](https://github.com/agentkernel/openclaw-desktop/releases/latest)
88-
**主要下载渠道:** [GitHub Releases](https://github.com/agentkernel/openclaw-desktop/releases/latest)
89-
90-
- Installer filename / 安装包文件名: `OpenClaw-Setup-0.1.1.exe`
91-
- Target platform / 适用系统: Windows 10/11 x64
92-
- Includes / 包含内容: Electron shell, bundled Node.js runtime, bundled OpenClaw package
93-
- Also published / 同时发布: checksum file and `latest.yml` for in-app updates
39+
<p align="center">
40+
<img src="resources/demo.gif" alt="OpenClaw Desktop Demo running an AI agent on Windows" width="720" />
41+
</p>
9442

95-
## Changelog
43+
## Overview
9644

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.
9846

99-
- **Feishu access & pairing (desktop):** In-app **Feishu Access** for pending DM pairing and allowlist management (Settings, Dashboard, tray); `pairing approve` uses the bundled Node/OpenClaw runtime. **中文:** 应用内 **飞书访问**,待处理配对与放行名单(设置 / 控制台 / 托盘);批准走内置运行时。
100-
- **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:
10348

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
10554

106-
- Initial public release track with Windows installer, setup wizard, bundled runtime, and updater.
55+
## What's New In v0.1.1
10756

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.
10961

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)
11163

112-
`OpenClaw Desktop` turns that into a normal desktop install experience:
64+
## Download
11365

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
66+
Primary download: [GitHub Releases](https://github.com/agentkernel/openclaw-desktop/releases/latest)
11867

119-
This project is the ideal **OpenClaw Windows installer**, **OpenClaw desktop app**, and **OpenClaw GUI** for your AI agents.
68+
- Current desktop release: `v0.1.1`
69+
- Main installer: `OpenClaw-Setup-0.1.1.exe`
70+
- Platform: Windows 10/11 x64
71+
- Includes: Electron shell, bundled Node.js runtime, bundled OpenClaw package
72+
- Extra assets: checksum files and `latest.yml` for in-app updates
12073

121-
## Features
74+
## Screenshots
12275

123-
- Native Windows installer with Start Menu and Desktop shortcuts
124-
- Guided setup wizard for model, channel, gateway, and API key configuration
125-
- Bundled Node.js runtime so system-wide Node.js is not required
126-
- Bundled OpenClaw runtime for fast first launch
127-
- Built-in update flow based on GitHub Releases and `electron-updater`
128-
- Update center with health checks, bundle verification, rollback guidance, and diagnostics
129-
- System tray integration and auto-start at login
130-
- Multi-language UI: English, 简体中文, 繁體中文, 日本語, 한국어, Español, Français
131-
- Support for 50+ AI providers and multiple channels including Telegram, Discord, Slack, WhatsApp, and Feishu
76+
| Installer | Setup Wizard | Dashboard |
77+
| --- | --- | --- |
78+
| <img src="resources/screenshot-installer-user-scope.png" alt="OpenClaw Desktop Windows installer user scope options" width="260" /> | <img src="resources/screenshot-setup-wizard.png" alt="OpenClaw Desktop first-run setup wizard on Windows" width="260" /> | <img src="resources/screenshot-gateway-dashboard.png" alt="OpenClaw Control gateway dashboard running on Windows" width="260" /> |
13279

13380
## Quick Start
13481

13582
1. Download the latest installer from [Releases](https://github.com/agentkernel/openclaw-desktop/releases/latest).
13683
2. Run `OpenClaw-Setup-0.1.1.exe`.
137-
3. Finish the installation wizard and launch `OpenClaw Desktop`.
138-
4. Complete the first-run setup for your model provider and gateway.
139-
5. Start using OpenClaw from a native Windows desktop shell.
84+
3. Finish the installer and launch `OpenClaw Desktop`.
85+
4. Complete the first-run setup for your model provider, channel, and gateway.
86+
5. Start using OpenClaw from the desktop shell.
14087

14188
System requirements:
14289

14390
- Windows 10/11 x64
144-
- Around 350 MB free disk space
145-
- Internet connection for model API calls and update checks
146-
147-
## OpenClaw Ecosystem
148-
149-
```text
150-
OpenClaw
151-
|
152-
----------------------------
153-
| | |
154-
Desktop GUI Plugins
155-
|
156-
Installer
157-
```
91+
- About 350 MB free disk space
92+
- Internet connection for provider API calls and update checks
15893

159-
Related Projects:
160-
- [openclaw](https://github.com/openclaw/openclaw)
161-
- [openclaw-desktop](https://github.com/agentkernel/openclaw-desktop)
162-
163-
## Release Assets
164-
165-
Every release is intended to expose the Windows installer in the most obvious place for end users:
94+
## Features
16695

167-
- `OpenClaw-Setup-<version>.exe`: the installer most users should download
168-
- `OpenClaw-Setup-<version>.exe.sha256`: checksum for manual verification
169-
- `latest.yml` or `latest-beta.yml`: metadata consumed by the in-app updater
96+
- Native Windows installer with Start Menu and Desktop shortcuts
97+
- Guided setup wizard for model, channel, gateway, and API key configuration
98+
- Bundled Node.js runtime so no system-wide Node.js install is required
99+
- Bundled OpenClaw runtime for a faster first launch
100+
- Built-in updater powered by GitHub Releases and `electron-updater`
101+
- Update center with health checks, bundle verification, rollback guidance, and diagnostics
102+
- Tray integration and auto-start support
103+
- Multi-language UI: English, Simplified Chinese, Traditional Chinese, Japanese, Korean, Spanish, French
104+
- Support for 50+ AI providers and multiple channels including Telegram, Discord, Slack, WhatsApp, and Feishu
170105

171-
## Architecture
106+
## Feishu Settings & Pairing
172107

173-
```text
174-
OpenClaw Desktop
175-
├─ Electron main process
176-
├─ React renderer UI
177-
├─ Preload bridge and IPC layer
178-
├─ Gateway process manager
179-
├─ Update service
180-
└─ Bundled resources
181-
├─ portable Node.js runtime
182-
└─ bundled OpenClaw package
183-
```
108+
Desktop keeps the Feishu DM flow practical for first-time setup:
184109

185-
More detail:
110+
1. Configure Feishu credentials in the setup flow or in **Settings**.
111+
2. Keep DM mode on `pairing` if you want approval before users can chat.
112+
3. Ask the requester to DM the bot in Feishu.
113+
4. Open **Feishu Settings** to review pending requests, approve a sender, edit the allowlist, or add an `open_id` manually.
186114

187-
- [Architecture notes](docs/ARCHITECTURE.md)
188-
- [Product notes](docs/product-design.md)
189-
- [Feishu pairing & access (Desktop)](docs/feishu-pairing-ux-plan.md)
115+
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.
190116

191117
## Development
192118

193119
Prerequisites:
194120

195-
- Node.js `>= 22.12.0`
121+
- Node.js `>= 22.16.0`
196122
- `pnpm`
197123
- Windows 10/11 for packaging and end-to-end validation
198124

@@ -211,6 +137,7 @@ pnpm type-check
211137
pnpm build
212138
pnpm run download-node
213139
pnpm run download-openclaw
140+
pnpm run verify-bundle
214141
pnpm run prepare-bundle
215142
pnpm run package:win
216143
```
@@ -219,94 +146,58 @@ Build output:
219146

220147
- `dist/OpenClaw-Setup-<version>.exe`
221148

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:
240150

241-
<details>
242-
<summary><strong>Is this part of the OpenClaw ecosystem?</strong></summary>
151+
- [CHANGELOG.md](CHANGELOG.md)
152+
- [docs/product-design.md](docs/product-design.md)
153+
- [docs/feishu-pairing-ux-plan.md](docs/feishu-pairing-ux-plan.md)
154+
- [docs/powershell-setup.md](docs/powershell-setup.md)
155+
- [CONTRIBUTING.md](CONTRIBUTING.md)
156+
- [SECURITY.md](SECURITY.md)
243157

244-
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
246159

247160
<details>
248161
<summary><strong>Do I need Node.js installed globally?</strong></summary>
249162

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.
251164
</details>
252165

253166
<details>
254-
<summary><strong>Where do I download the EXE?</strong></summary>
167+
<summary><strong>Where do I download the installer?</strong></summary>
255168

256169
Use the latest release page: <a href="https://github.com/agentkernel/openclaw-desktop/releases/latest">github.com/agentkernel/openclaw-desktop/releases/latest</a>. The main asset is <code>OpenClaw-Setup-&lt;version&gt;.exe</code>.
257170
</details>
258171

259172
<details>
260-
<summary><strong>Where is my data stored?</strong></summary>
173+
<summary><strong>Where is user data stored?</strong></summary>
261174

262-
- OpenClaw config: `%USERPROFILE%\.openclaw\openclaw.json`
263-
- Desktop shell config: `%APPDATA%\OpenClaw Desktop\config.json`
264-
- Logs: `%USERPROFILE%\.openclaw\`
265-
- Backups: `%USERPROFILE%\.openclaw\backups\`
175+
- OpenClaw config: <code>%USERPROFILE%\.openclaw\openclaw.json</code>
176+
- Desktop config: <code>%APPDATA%\OpenClaw Desktop\config.json</code>
177+
- Logs: <code>%USERPROFILE%\.openclaw\</code>
178+
- Backups: <code>%USERPROFILE%\.openclaw\backups\</code>
266179

267-
Uninstalling the app does not delete user configuration by default.
180+
Uninstalling the app does not remove user configuration by default.
268181
</details>
269182

270183
<details>
271184
<summary><strong>How do updates work?</strong></summary>
272185

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.
274187
</details>
275188

276189
<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>
278191

279-
The bundled OpenClaw **gateway** runs as a child process that inherits `HTTP(S)_PROXY`. Some local proxies break TLS to Kuaes 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 gateway inherits <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.
280193

281-
To disable this merge (e.g. debugging), set environment variable `OPENCLAW_SKIP_KUAE_NO_PROXY=1` before starting OpenClaw Desktop.
282-
283-
捆绑的 OpenClaw **网关** 以子进程运行并继承系统 `HTTP(S)_PROXY`。部分本机代理会导致访问 Kuae API 时 TLS 失败;桌面端在启动网关时会自动合并 `NO_PROXY`,使 Kuae 域名直连,其它请求仍可走代理。调试可设 `OPENCLAW_SKIP_KUAE_NO_PROXY=1` 关闭该行为。
194+
To disable this behavior for debugging, set <code>OPENCLAW_SKIP_KUAE_NO_PROXY=1</code> before starting the app.
284195
</details>
285196

286-
## Community & Support
287-
288-
**Star History**
289-
290-
If this project helps you run OpenClaw, please consider giving us a star!
291-
292-
**Contributors**
293-
294-
Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
295-
296-
**Community**
297-
298-
Join our Discussions to ask questions, showcase what you've built, or request new features.
299-
300-
## Keywords / 搜索关键词
301-
302-
OpenClaw Desktop · OpenClaw Windows · OpenClaw installer · OpenClaw Windows installer · OpenClaw desktop app ·
303-
OpenClaw GUI · how to install OpenClaw on Windows · run OpenClaw locally · OpenClaw 桌面版 · OpenClaw Windows 安装器 ·
304-
OpenClaw 安装教程
305-
306197
## License
307198

308199
[GPL-3.0](LICENSE)
309200

310201
<!-- SEO: OpenClaw Desktop, OpenClaw Windows, OpenClaw installer, OpenClaw desktop app, OpenClaw setup wizard,
311202
OpenClaw Windows installer, OpenClaw GUI, OpenClaw app for Windows, install OpenClaw on Windows, run OpenClaw locally,
312-
OpenClaw 桌面版, OpenClaw Windows 安装器, OpenClaw デスクトップ, OpenClaw 데스크톱, how to install openclaw, openclaw setup -->
203+
OpenClaw 桌面版, OpenClaw Windows 安装器, OpenClaw デスクトップ, OpenClaw 데스크톱, how to install openclaw, openclaw setup -->

0 commit comments

Comments
 (0)