Files
u-claw/README.zh-CN.md
zheng d2cd9d4528
Some checks failed
Tests / test (push) Has been cancelled
docs: 中文 README 与英文版同步
中文版一直是上游的旧内容,和英文版已经完全对不上:虾盘云首选卡片、
10 个中国技能、QQ 列为预装、还夹着上游另一个产品的推广段落。312 → 165 行。

现在两版讲同一个产品,面向新加坡的华语用户,而不是中国市场。

顺带修掉一条和事实相反的建议:中文版原来写着「U 盘请用 NTFS 格式(不要
exFAT/FAT32)」。macOS 对 NTFS 只读 —— 照做的话「配置跟着盘走」在 Mac 上
直接失效,首次启动连配置都写不进去。这和 release.yml 里那条是同一个错误,
两处都改了。

英文版补上 fork 说明(原来只写在 CLAUDE.md 里),两版现在都写明这是
dongsheng123132/u-claw 的分支、且不向上游提交。

新增断言 tests/i18n-pages.test.mjs:两版必须互链、必须都写明是 fork、
必须都建议 exFAT 且不得出现推荐 NTFS 的措辞、中文版不得再出现英文版
已经删掉的那批上游内容。这条断言的存在是因为它们上次就是这么漂开的。
2026-08-17 19:29:03 +08:00

166 lines
7.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<img src="assets/readme/hero.svg" alt="U-Claw —— 装在 U 盘里的 AI 工作空间" width="100%" />
</p>
<h1 align="center">U-Claw</h1>
<p align="center"><strong>装在 U 盘里的 AI 工作空间。插到任何一台电脑上,设置、记忆和工具都跟着走。</strong></p>
<p align="center">
<a href="https://gitea.fanghe.it.com/zhenghy/u-claw/releases">下载</a> ·
<a href="#三步开始">三步开始</a> ·
<a href="#自己构建">从源码构建</a> ·
<a href="README.md">English</a>
</p>
<p align="center">
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-1f7a8c?style=flat-square" alt="MIT License" /></a>
<img src="https://img.shields.io/badge/Portable-USB%20first-123343?style=flat-square" alt="USB first" />
<img src="https://img.shields.io/badge/Runtime-OpenClaw-48d1c1?style=flat-square" alt="OpenClaw runtime" />
</p>
> [!IMPORTANT]
> 这个仓库不是"做 U 盘的工具"**它本身就是 U 盘里的内容**。跑一次 `setup.sh` 把运行时补齐,然后把 `portable/` 整个拷到盘里就行。
## 为什么是 U 盘
三个理由,也就是这个产品的全部卖点:
1. **公司电脑经常不让装软件。** 金融、政府外包和多数受监管行业都锁得很死。U 盘不需要安装程序,也不需要管理员权限。
2. **你的配置跟着你走。** 模型密钥、聊天记录、项目记忆都在盘上的 `data/` 里,不在你临时借用的那台机器上。
3. **主机上不留东西。** 拔盘走人。(有一条要说清楚:为了让慢速 U 盘启动不至于难以忍受U-Claw 会往主机本地磁盘写一份可重建的缓存。`advanced/` 里有一键清理。)
## 三步开始
1. 从 [Releases](https://gitea.fanghe.it.com/zhenghy/u-claw/releases) 下载便携版,解压到 U 盘,双击 `START HERE - Windows.bat`(或 `START HERE - Mac.command`
2. 设置页会自动打开。**粘贴一个 API 密钥就行** —— U-Claw 会自己认出是哪家的,并在接受之前先测一下通不通
3. 开始对话
**还没有密钥?** [Google Gemini](https://aistudio.google.com/apikey) 最容易拿:用 Google 账号登录,不用绑卡,有免费额度。想一个密钥用多种模型的话,[OpenRouter](https://openrouter.ai/keys) 是不错的第二选择。
## 用哪个模型
| 模型 | 适合 |
|---|---|
| **Claude** | 综合最强 |
| **GPT** | 用的人最多 |
| **Gemini** | 有免费额度,注册最简单 |
| **SEA-LION** | 马来语、泰米尔语、Singlish —— AI Singapore 做的 |
| **本地模型** | 离线。数据不出这台机器。 |
其他模型DeepSeek、Kimi、通义、GLM 等)在设置页的「高级」里填自己的接口地址即可。
> **关于 SEA-LION**:托管 API 免费,但目前限流 **每人每分钟 10 次请求**且官方没公布付费档。聊天够用agent 类工作量偏紧 —— 所以它是特色选项而不是默认。
## 聊天软件
| 平台 | 状态 | 说明 |
|---|---|---|
| Telegram | ✅ 内置 | — |
| WhatsApp | ⚠️ 内置 | 用的是 Baileys 非官方协议,**账号有被封的真实风险**。接入之前先看设置页里的提示,不要接你离不开的号码 |
| Discord | ✅ 内置 | — |
| Slack | ✅ 内置 | — |
| 微信 · QQ · 飞书 · 钉钉 | 可选 | 主要给在中国的用户,在设置页的折叠区里 |
## 自己构建
```bash
git clone ssh://git@gitea.fanghe.it.com:222/zhenghy/u-claw.git
cd u-claw/portable/advanced && bash setup.sh # 下载 Node.js + OpenClaw约一分钟
cp -R portable/ /Volumes/你的U盘/U-Claw/ # Mac
# Windows 上直接把文件夹拖到盘里
```
## 盘上有什么
U 盘里**只有三个能点的文件**,其余都在 `advanced/` 里。
| | Mac | Windows |
|---|---|---|
| **启动** | `START HERE - Mac.command` | `START HERE - Windows.bat` |
| **看说明** | `Read me first.html` | `Read me first.html` |
| **设置** | 首次启动自动打开 | 首次启动自动打开 |
| *诊断、命令行、装到本机* | `advanced/` | `advanced/` |
```
U-Claw/
├── START HERE - Windows.bat ← 双击这个
├── START HERE - Mac.command ← 或这个
├── Read me first.html 三步上手
├── advanced/ 诊断、命令行、装到电脑、构建脚本
├── skills/ 技能内容和 manifest.json
├── lib/ 启动器、i18n、辅助脚本
├── app/ 运行时setup.sh 下载,不在 git 里)
└── data/ 你的数据(不在 git 里)
├── .openclaw/ 配置
├── memory/ AI 记住的东西
└── backups/
```
## Linux 可启动 U 盘
目标电脑上连操作系统都没有?从盘启动进 UbuntuU-Claw 已经装好。见 [`bootable/`](bootable/),基于 Ventoy + Ubuntu 24.04 LTS + 持久化。
> Electron 桌面版(`u-claw-app/`**已于 2026-06-19 停止发布**,代码仅作存档,见 [`u-claw-app/DEPRECATED.md`](u-claw-app/DEPRECATED.md)。便携 U 盘版才是产品本体。
## 这安全吗
- **你的 API 密钥只写在盘上。** 除了你自己选的那家模型服务商,不会发到任何地方。
- **没有任何遥测。** 不打设备指纹、不上报使用情况、不需要注册账号 —— 这些代码在这个版本里根本不存在。
- **对话记录留在盘上的 `data/` 里。**
- **确实会离开这台机器的**:你发的消息会到你配置的那家模型服务商,和你直接用他们的 App 是一样的。如果这对你的数据不可接受,请用本地模型。
## U 盘用什么格式
**exFAT。不要用 NTFS。**
macOS 对 NTFS **只读**,用 NTFS 的话「配置跟着盘走」这件事在 Mac 上直接失效 —— 首次启动连配置都写不进去。
exFAT 处理大量小文件确实慢,所以 U-Claw 启动时会把可重建的缓存挪到主机本地磁盘。你的实际数据仍然留在盘上。
## 参与开发
见 [CONTRIBUTING.md](CONTRIBUTING.md)。每次 push 前会跑测试:
```bash
node --test
```
> 不是 `node --test tests/` —— Node 会把那个路径当模块加载并报 `Cannot find module`,一个测试都不跑。
它检查的是那些会悄悄坏掉的东西:启动器有没有保持精简、`.bat` 有没有保持纯 ASCII、有没有中国下载源溜回来、两个安装器对技能的处理是否一致、每个界面字符串是不是在每种语言里都有。
## 常见问题
**需要安装什么吗?**
不需要。这就是重点。
**Mac 和 Windows 都能用吗?**
同一个盘两边都能用。Windows 版发布时已经带好运行时Mac 第一次启动会自己下载,约一分钟。
**我的设置存在哪?**
盘上的 `data/.openclaw/openclaw.json`。复制这个盘,就复制了你的整套配置。
**能离线用吗?**
可以,用本地模型。其他都需要能连上你的模型服务商。
**界面语言能改吗?**
能,设置页里。而且**语言记在盘上而不是浏览器里** —— 你把盘插到同事的英文系统上,看到的仍然是中文。
## 关于这个分支
这是 [dongsheng123132/u-claw](https://github.com/dongsheng123132/u-claw) 的一个 fork面向新加坡 / 东南亚市场做了改造:默认值国际化、界面双语、降低非技术用户的上手门槛。
**我们不向上游提交改动** —— 这个版本移除的中国市场默认值,恰恰是上游项目存在的意义。
## 联系
- Issues — [gitea.fanghe.it.com/zhenghy/u-claw/issues](https://gitea.fanghe.it.com/zhenghy/u-claw/issues)
---
<p align="center"><a href="README.md">English</a> · <strong>中文</strong></p>
<p align="center">MIT License</p>