zhenghy/u-claw
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: 文档改为英文，并修正过时内容
Some checks failed
Tests / test (push) Has been cancelled
Details

Browse Source 
不是翻译 —— 多数文档描述的行为已经不存在了。

先修一个更基本的问题：我们不拥有 u-claw.org 域名，那是上游的。所以之前写在
README、诊断包提示、联系方式里的 help@u-claw.org 全都会把用户的问题发给
上游 —— 一个没有理由回复的人。改为指向我们自己的 issue tracker，并加断言
禁止再出现指向该域名的支持入口。

重写（内容过时，不是语言问题）：
- install/README.md —— 还写着 10 个中国技能、DeepSeek 优先、国内镜像。
  现在按实际流程写：技能读 manifest、模型菜单 Gemini 优先、bundle 有
  SHA256 校验。并如实写明 curl|bash 在受管企业电脑上会被 EDR 拦。
- CLAUDE.md 的模型配置整节 —— 还在描述虾盘云首选卡片和 12 个 provider，
  那个界面已经换成单框 Key 输入了。
- SECURITY.md —— 安全报告原本指向上游维护者个人邮箱。fork 之后那条路由
  是错的：漏洞会发给写不了这份代码、也修不了的人。
- CONTRIBUTING.md —— 补上 fork 关系、pre-push 钩子怎么装、以及
  `node --test tests/` 为什么不能用。

翻译并保留：
- bootable/README.md、TROUBLESHOOTING.md —— 面向用户，顺带把
  「国内镜像」「小米/华为 BIOS 按键」等换成目标市场的实际情况

HANDOFF.md 重写为一份事故复盘：原文一半是过时的一次性交接笔记（引用的
website/guide.html 已不在本仓库），另一半是 persistence.dat 未格式化导致
启动失败的排查记录 —— 后者有长期价值，尤其是「读 offset 1080 的两字节
验证 ext4」这个判断方法，已同时写进 bootable/README.md。

bootable/IMPROVEMENTS_SUMMARY.md 保留中文，加了说明：它是上游 fork 前的
历史改进记录，没人引用，描述的是已完成的工作而非当前行为。翻译它反而会
让人误以为是现行文档。

新增 skills/en/uclaw-help —— 把「怎么用、东西在哪、出问题怎么办」做成
内置知识，每个角色都装。方案 C10.8：能问的产品才是不需要学的产品。
This commit is contained in:
zheng
2026-08-17 19:12:07 +08:00
parent 46a1218fc8
commit 3221856d50
20 changed files with 937 additions and 883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
install/README.md
View File

@@ -1,132 +1,102 @@
# U-Claw 一键安装 / One-Line Install
# One-line install
> 一行命令安装 OpenClaw + 技能包 + 模型配置
> One command to install OpenClaw + skills + model config
Installs OpenClaw, the skills and a model configuration in a single command,
without a USB drive.
## 安装 / Install
## Install
### Mac / Linux
**Mac / Linux**
```bash
curl -fsSL https://u-claw.org/install.sh | bash
```
### Windows (PowerShell 管理员)
**Windows** (PowerShell)
```powershell
irm https://u-claw.org/install.ps1 | iex
```
### 本地运行
**From a checkout**
```bash
# Mac/Linux
bash install/install.sh
# Windows
powershell -ExecutionPolicy Bypass -File install\install.ps1
bash install/install.sh # Mac / Linux
powershell -ExecutionPolicy Bypass -File install\install.ps1 # Windows
```
## 安装流程
> These pipe a script from the network straight into a shell. That pattern is
> widely warned about, and on a managed corporate machine an EDR agent will
> often block it outright. If you are on a work laptop, use the USB build
> instead — that is what it is for.
### Mac / Linux（7 步）
## What it does
| 步骤 | 内容 | 说明 |
|------|------|------|
| 1 | Node.js v22 | 安装到 `~/.uclaw/runtime/`，系统有 v20+ 则复用 |
| 2 | OpenClaw | npm 安装到 `~/.uclaw/core/` |
| 3 | QQ 插件 | 非致命，失败不影响主功能 |
| 4 | 10 个中国技能 | 小红书、B站、微博等内容创作技能 |
| 5 | 模型配置 | 中文交互菜单，默认 DeepSeek |
| 6 | 启动脚本 | 生成 start.command (Mac) / start.sh (Linux) |
| 7 | 验证 | 检查各组件安装状态 |
| Step | Mac / Linux | Windows |
|---|---|---|
| 1 | Node.js — into `~/.uclaw/runtime/`, or reuses the system copy if it is v20+ | same, under `%USERPROFILE%\.uclaw\` |
| 2 | OpenClaw via npm | downloads a pre-built bundle, **checksum verified** |
| 3 | QQ plugin — optional, a failure here does not stop anything else | same |
| 4 | Skills — read from `skills/manifest.json`, fetched from the repo | same |
| 5 | Model — pick one and paste a key | same |
| 6 | Start script — `start.command` / `start.sh` | `start.bat` |
| 7 | Verify what landed | same |
### Windows（6 步）
Neither script contains any skill text of its own. Both call
`lib/install-skills.mjs`, which is the same installer the USB build and the
release pipeline use — that is what keeps the two platforms from drifting apart,
which they had badly done before.
| 步骤 | 内容 | 说明 |
|------|------|------|
| 1 | Node.js v22 | 下载到 `%USERPROFILE%\.uclaw\runtime\`，系统有 v20+ 则复用 |
| 2 | OpenClaw + QQ 插件 | 下载预打包 bundle，走国内镜像 |
| 3 | 10 个中国技能 | 小红书、B站、微博等内容创作技能 |
| 4 | 模型配置 | 交互菜单，默认 DeepSeek |
| 5 | 启动脚本 | 生成 start.bat |
| 6 | 验证 | 检查各组件安装状态 |
## Models
## 支持的 AI 模型
The menu leads with what is easiest to get working:
### 国内（无需翻墙）
| | Model | Why |
|---|---|---|
| 1 | **Gemini** | Easiest key to obtain — Google account, no card, free tier |
| 2 | **Claude** | Best all-rounder |
| 3 | **GPT** | Most widely used |
| 4 | **OpenRouter** | One key across many models |
| 5 | **SEA-LION** | Malay, Tamil and Singlish. Free, but rate-limited to 10 requests a minute |
| 6 | **Local** | Runs offline through Ollama |
| 7 | Other | Paste your own endpoint and model name |
| 编号 | 模型 | 说明 |
|------|------|------|
| 1 | DeepSeek | ⭐ 推荐，性价比最高 |
| 2 | Kimi/月之暗面 | 长文档 |
| 3 | 通义千问 | 有免费额度 |
| 4 | 智谱GLM | 学术场景 |
| 5 | MiniMax | 多模态 |
| 6 | 豆包 | 火山引擎 |
| 7 | 硅基流动 | 聚合多模型 |
Others — DeepSeek, Kimi, Qwen, GLM and so on — work fine through option 7.
### 海外
| 编号 | 模型 |
|------|------|
| 8 | Claude |
| 9 | GPT |
### 本地
| 编号 | 模型 |
|------|------|
| 10 | Ollama |
## 安装目录结构
## Where things land
```
~/.uclaw/
├── runtime/node-{platform}/ # Node.js v22
├── core/ # OpenClaw + QQ 插件
│ ├── package.json
│ └── node_modules/
│ └── openclaw/skills/ ← 技能在这里
├── runtime/node-{platform}/ Node.js
├── core/ OpenClaw and plugins
│ └── node_modules/openclaw/skills/ installed skills
├── data/
│ ├── .openclaw/openclaw.json ← 模型配置
│ ├── memory/ ← AI 记忆
│ └── backups/ ← 备份
├── start.command (Mac) ← 启动脚本
└── start.bat (Windows) ← 启动脚本
│ ├── .openclaw/openclaw.json your model and key
│ ├── memory/ what the AI remembers
│ └── backups/
└── start.command | start.sh | start.bat
```
## 技术细节
## Notes
- **Node.js**: 只装到 `~/.uclaw/runtime/`，不动系统 Node；系统已有 v20+ 则复用
- **下载源**: Node 二进制走 `nodejs.org`，npm 包走 `registry.npmjs.org`；Windows bundle 直连 GitHub Releases
- **Windows 编码**: `chcp 65001` + UTF8 输出确保中文显示
- **管道模式**: `curl | bash` 时自动跳过交互，使用默认配置
- **卸载**: `rm -rf ~/.uclaw` (Mac/Linux) 或删除 `%USERPROFILE%\.uclaw` (Windows)
- **Nothing touches your system Node.** It installs into `~/.uclaw/runtime/`, and
reuses a system copy only if it is already v20 or newer.
- **Download sources** are `nodejs.org` and `registry.npmjs.org`; the Windows
bundle comes from our own releases and its SHA256 is checked before it is
unpacked. Until recently the only check was "is the file bigger than 1MB",
which is not a check.
- **Piped mode**: under `curl | bash` there is no terminal to prompt on, so it
takes the defaults and you set the model afterwards.
- **Uninstall**: `rm -rf ~/.uclaw`, or delete `%USERPROFILE%\.uclaw` on Windows.
## 包含技能
| 技能 | 用途 |
|------|------|
| xiaohongshu-writer | 小红书笔记写作 |
| bilibili-helper | B站视频优化 |
| weibo-poster | 微博内容创作 |
| wechat-article | 微信公众号文章 |
| zhihu-writer | 知乎回答/文章 |
| douyin-script | 抖音短视频脚本 |
| china-search | 国内搜索引擎 |
| china-translate | 中英互译 |
| china-weather | 天气查询 |
| deepseek-helper | DeepSeek API 助手 |
## 与其他分发形式的关系
## How this relates to the other builds
```
install/ ← 一键在线安装（本模块）
portable/ ← U 盘便携版
u-claw-app/ ← Electron 桌面版
bootable/ ← Linux 可启动 U 盘
install/ one-line install over the network — this module
portable/ the USB build, the main product
bootable/ a Linux USB that boots a machine with no OS
u-claw-app/ Electron desktop app — deprecated, kept for archive
```
install/ 安装的结果与 portable/ 的 Mac-Install.command 相同，
区别是不需要 U 盘，直接从网络下载所有组件。
The result is the same as running `advanced/Mac-Install.command` from the USB
build. The difference is only that everything is fetched from the network rather
than copied off a drive.