Skip to content

Commit 472ad95

Browse files
agentkernelclaude
andcommitted
docs(readme): split into English (default) and Chinese versions
README.md is now pure English; README.zh-CN.md is pure Chinese. Top of each file has a language switcher link to the other version. Improved typography: dividers around switcher, table layout for download info, cleaner section spacing. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 077aed6 commit 472ad95

2 files changed

Lines changed: 162 additions & 242 deletions

File tree

README.md

Lines changed: 64 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,82 @@
1-
<p align="center">
2-
<strong>Language / 语言:</strong>
3-
<strong>English</strong>
4-
|
5-
<a href="./README.zh-CN.md">简体中文</a>
6-
</p>
7-
81
<p align="center">
92
<img src="resources/apple-touch-icon.png" alt="OpenClaw Desktop" width="128" height="128" />
103
</p>
114

125
<h1 align="center">OpenClaw Desktop</h1>
136

147
<p align="center">
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.
8+
Community-maintained Windows desktop app and installer for
9+
<a href="https://github.com/openclaw/openclaw">OpenClaw</a>.<br />
10+
Native GUI, bundled runtime, guided setup wizard, and in-app updates —
11+
everything you need to run OpenClaw on Windows.
1712
</p>
1813

1914
<p align="center">
20-
<a href="https://github.com/agentkernel/openclaw-desktop/releases/latest"><img src="https://img.shields.io/github/v/release/agentkernel/openclaw-desktop?style=flat-square&color=2563eb&label=latest%20release" alt="Latest release"></a>
21-
<a href="https://github.com/agentkernel/openclaw-desktop/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/agentkernel/openclaw-desktop/ci.yml?style=flat-square&label=ci" alt="CI"></a>
22-
<a href="https://github.com/agentkernel/openclaw-desktop/actions/workflows/release.yml"><img src="https://img.shields.io/github/actions/workflow/status/agentkernel/openclaw-desktop/release.yml?style=flat-square&label=release" alt="Release workflow"></a>
23-
<a href="https://github.com/agentkernel/openclaw-desktop/releases"><img src="https://img.shields.io/github/downloads/agentkernel/openclaw-desktop/total?style=flat-square&color=16a34a&label=downloads" alt="Downloads"></a>
24-
<a href="LICENSE"><img src="https://img.shields.io/github/license/agentkernel/openclaw-desktop?style=flat-square" alt="License"></a>
15+
<a href="https://github.com/agentkernel/openclaw-desktop/releases/latest">
16+
<img src="https://img.shields.io/github/v/release/agentkernel/openclaw-desktop?style=flat-square&color=2563eb&label=latest+release" alt="Latest release" />
17+
</a>
18+
<a href="https://github.com/agentkernel/openclaw-desktop/actions/workflows/ci.yml">
19+
<img src="https://img.shields.io/github/actions/workflow/status/agentkernel/openclaw-desktop/ci.yml?style=flat-square&label=ci" alt="CI" />
20+
</a>
21+
<a href="https://github.com/agentkernel/openclaw-desktop/actions/workflows/release.yml">
22+
<img src="https://img.shields.io/github/actions/workflow/status/agentkernel/openclaw-desktop/release.yml?style=flat-square&label=release" alt="Release workflow" />
23+
</a>
24+
<a href="https://github.com/agentkernel/openclaw-desktop/releases">
25+
<img src="https://img.shields.io/github/downloads/agentkernel/openclaw-desktop/total?style=flat-square&color=16a34a&label=downloads" alt="Downloads" />
26+
</a>
27+
<a href="LICENSE">
28+
<img src="https://img.shields.io/github/license/agentkernel/openclaw-desktop?style=flat-square" alt="License" />
29+
</a>
2530
</p>
2631

2732
<p align="center">
28-
<a href="#overview">Overview</a> •
29-
<a href="#whats-new-in-v011">What's New</a> •
30-
<a href="#download">Download</a> •
31-
<a href="#screenshots">Screenshots</a> •
32-
<a href="#quick-start">Quick Start</a> •
33-
<a href="#features">Features</a> •
34-
<a href="#feishu-settings--pairing">Feishu</a> •
35-
<a href="#development">Development</a> •
36-
<a href="#faq">FAQ</a>
33+
<img src="resources/demo.gif" alt="OpenClaw Desktop Demo running on Windows" width="720" />
3734
</p>
3835

39-
<p align="center">
40-
<img src="resources/demo.gif" alt="OpenClaw Desktop Demo running an AI agent on Windows" width="720" />
41-
</p>
36+
---
37+
38+
**Language:** English · [简体中文](./README.zh-CN.md)
39+
40+
---
4241

4342
## Overview
4443

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.
44+
`OpenClaw Desktop` packages the OpenClaw runtime into a normal Windows install experience. Download one `.exe`, finish a setup wizard, configure your provider and channel, and run OpenClaw from a native desktop shell — no manual wiring required.
4645

47-
It is designed for users who want:
46+
Built for users who want:
4847

4948
- A Windows-first installer and GUI for OpenClaw
50-
- Bundled Node.js and bundled OpenClaw runtime
49+
- Bundled Node.js and OpenClaw runtime (no global install needed)
5150
- Guided provider, channel, and gateway setup
52-
- Built-in update flow from GitHub Releases
51+
- Built-in updates via GitHub Releases
5352
- Desktop-native Feishu pairing and allowlist management
5453

55-
## What's New In v0.1.1
54+
## What's New in v0.1.1
5655

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.
56+
- **Feishu Settings** Feishu credentials, DM pairing, and allowlist are now managed inside the app. Open it from **Settings**, the **Dashboard**, or the **tray menu**.
57+
- **Desktop approval flow** Pending Feishu requests are approved directly in the app. When only a pairing code is available, Desktop falls back to the bundled OpenClaw runtime.
58+
- **Runtime update** Bundled OpenClaw updated to `2026.3.13`.
59+
- **Kuae proxy fix** When the gateway inherits `HTTP(S)_PROXY`, Desktop now merges `NO_PROXY` for `coding-plan-endpoint.kuaecloud.net` and `.kuaecloud.net` so Kuae traffic bypasses HTTPS proxies that break TLS.
6160

62-
More history: [CHANGELOG.md](CHANGELOG.md)
61+
Full history: [CHANGELOG.md](CHANGELOG.md)
6362

6463
## Download
6564

66-
Primary download: [GitHub Releases](https://github.com/agentkernel/openclaw-desktop/releases/latest)
65+
**Primary download:** [GitHub Releases](https://github.com/agentkernel/openclaw-desktop/releases/latest)
6766

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
67+
| Item | Value |
68+
| --- | --- |
69+
| Release | `v0.1.1` |
70+
| Installer | `OpenClaw-Setup-0.1.1.exe` |
71+
| Platform | Windows 10/11 x64 |
72+
| Includes | Electron shell, bundled Node.js, bundled OpenClaw |
73+
| Extras | SHA-256 checksum, `latest.yml` for in-app updates |
7374

7475
## Screenshots
7576

7677
| Installer | Setup Wizard | Dashboard |
7778
| --- | --- | --- |
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" /> |
79+
| <img src="resources/screenshot-installer-user-scope.png" alt="Installer" width="260" /> | <img src="resources/screenshot-setup-wizard.png" alt="Setup Wizard" width="260" /> | <img src="resources/screenshot-gateway-dashboard.png" alt="Dashboard" width="260" /> |
7980

8081
## Quick Start
8182

@@ -85,42 +86,34 @@ Primary download: [GitHub Releases](https://github.com/agentkernel/openclaw-desk
8586
4. Complete the first-run setup for your model provider, channel, and gateway.
8687
5. Start using OpenClaw from the desktop shell.
8788

88-
System requirements:
89-
90-
- Windows 10/11 x64
91-
- About 350 MB free disk space
92-
- Internet connection for provider API calls and update checks
89+
**System requirements:** Windows 10/11 x64 · ~350 MB free disk space · Internet connection for API calls and update checks
9390

9491
## Features
9592

9693
- Native Windows installer with Start Menu and Desktop shortcuts
9794
- 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
95+
- Bundled Node.js runtime (no system-wide install required)
96+
- Bundled OpenClaw runtime for faster first launch
10097
- Built-in updater powered by GitHub Releases and `electron-updater`
10198
- Update center with health checks, bundle verification, rollback guidance, and diagnostics
102-
- Tray integration and auto-start support
99+
- System tray integration and auto-start support
103100
- 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
101+
- 50+ AI providers and multiple channels: Telegram, Discord, Slack, WhatsApp, Feishu, and more
105102

106103
## Feishu Settings & Pairing
107104

108-
Desktop keeps the Feishu DM flow practical for first-time setup:
105+
Desktop streamlines the Feishu DM pairing flow:
109106

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.
107+
1. Configure Feishu credentials in the setup wizard or in **Settings**.
108+
2. Keep DM mode on `pairing` if you want to approve users before they can chat.
112109
3. Ask the requester to DM the bot in Feishu.
113110
4. Open **Feishu Settings** to review pending requests, approve a sender, edit the allowlist, or add an `open_id` manually.
114111

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.
112+
If the pending list is empty but you already received a pairing code in Feishu, use the code-based approval path on the same screenDesktop will use the bundled runtime as a fallback.
116113

117114
## Development
118115

119-
Prerequisites:
120-
121-
- Node.js `>= 22.16.0`
122-
- `pnpm`
123-
- Windows 10/11 for packaging and end-to-end validation
116+
**Prerequisites:** Node.js `>= 22.16.0` · `pnpm` · Windows 10/11
124117

125118
```bash
126119
git clone https://github.com/agentkernel/openclaw-desktop.git
@@ -129,7 +122,7 @@ pnpm install
129122
pnpm dev
130123
```
131124

132-
Useful commands:
125+
**Common commands:**
133126

134127
```bash
135128
pnpm lint
@@ -142,11 +135,9 @@ pnpm run prepare-bundle
142135
pnpm run package:win
143136
```
144137

145-
Build output:
146-
147-
- `dist/OpenClaw-Setup-<version>.exe`
138+
Build output: `dist/OpenClaw-Setup-<version>.exe`
148139

149-
Related docs:
140+
**Related docs:**
150141

151142
- [CHANGELOG.md](CHANGELOG.md)
152143
- [docs/product-design.md](docs/product-design.md)
@@ -166,16 +157,16 @@ No. The installer ships with a portable Node.js runtime.
166157
<details>
167158
<summary><strong>Where do I download the installer?</strong></summary>
168159

169-
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>.
160+
Use the latest release page: [github.com/agentkernel/openclaw-desktop/releases/latest](https://github.com/agentkernel/openclaw-desktop/releases/latest). The main asset is `OpenClaw-Setup-<version>.exe`.
170161
</details>
171162

172163
<details>
173164
<summary><strong>Where is user data stored?</strong></summary>
174165

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>
166+
- OpenClaw config: `%USERPROFILE%\.openclaw\openclaw.json`
167+
- Desktop config: `%APPDATA%\OpenClaw Desktop\config.json`
168+
- Logs: `%USERPROFILE%\.openclaw\`
169+
- Backups: `%USERPROFILE%\.openclaw\backups\`
179170

180171
Uninstalling the app does not remove user configuration by default.
181172
</details>
@@ -189,9 +180,9 @@ Desktop checks GitHub Releases and can download updates through the built-in upd
189180
<details>
190181
<summary><strong>What does the Kuae HTTPS proxy fix do?</strong></summary>
191182

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.
183+
When the bundled OpenClaw gateway inherits `HTTP(S)_PROXY`, some local proxies break TLS to Kuae's Coding Plan endpoint. Desktop merges `NO_PROXY` / `no_proxy` for `coding-plan-endpoint.kuaecloud.net` and `.kuaecloud.net` so Kuae traffic goes direct while other traffic still uses your proxy.
193184

194-
To disable this behavior for debugging, set <code>OPENCLAW_SKIP_KUAE_NO_PROXY=1</code> before starting the app.
185+
To disable this behavior for debugging, set `OPENCLAW_SKIP_KUAE_NO_PROXY=1` before starting the app.
195186
</details>
196187

197188
## License

0 commit comments

Comments
 (0)