diff --git a/website/guide.html b/website/guide.html index 3498a3c..f4c97cb 100644 --- a/website/guide.html +++ b/website/guide.html @@ -96,8 +96,10 @@ ul{padding-left:20px} @@ -183,60 +185,257 @@ ul{padding-left:20px}

3 分钟快速上手

+ +

方式一:U 盘便携版(免安装)

1
插入 U 盘

将 U-Claw U 盘插入电脑

2
双击启动脚本 - - -
系统双击打开
macOSMac-从U盘启动.command
WindowsWindows-从U盘启动.bat
Linux终端运行 bash Linux-从U盘启动.sh
+macOSMac-Start.command +WindowsWindows-Start.bat +
+
3
首次配置

浏览器自动打开 Config.html → 选择 AI 模型 → 填写 API Key

+
4
开始使用

控制台自动打开 http://127.0.0.1:18789

+ +

方式二:桌面安装版

+
1
下载安装包

GitHub Releases 下载 DMG (Mac) 或 EXE (Windows)

+
2
安装并打开

双击安装,打开 U-Claw App

+
3
首次配置

App 自动弹出配置页面 → 选择模型 → 填 API Key

+ +

方式三:开发者自己搭建

+
1
克隆代码 +
git clone https://github.com/dongsheng123132/u-claw.git
+
+
2
一键安装 +
# 便携版
+cd u-claw/portable && bash setup.sh
+
+# 桌面版
+cd u-claw/u-claw-app && bash setup.sh
+

脚本自动从国内镜像下载 Node.js + 全部依赖,无需翻墙

+
+
3
启动 +
# 便携版
+bash Mac-Start.command   # Mac
+Windows-Start.bat        # Windows
+
+# 桌面版
+npm run dev
-
3
首次配置

选择 AI 模型 → 填写 API Key → 选择聊天平台

-
4
开始使用

浏览器自动打开控制台 http://127.0.0.1:18789

-

从 U 盘运行(便携模式)

-

便携模式下,所有配置、API Key、聊天记录保存在 U 盘的 portable-home/ 目录。换电脑插上 U 盘,配置还在。

+

从 U 盘运行(免安装便携模式)

+

便携模式下,所有配置、API Key、记忆保存在 U 盘的 data/ 目录。换电脑插上 U 盘,配置还在。

适合场景:老电脑、临时电脑、公司电脑、网吧、不想改本机环境

U 盘文件说明

- - - - - - - + + + + + + +
文件说明
Mac-从U盘启动.commandmacOS 一键启动(推荐)
Mac-全部功能.commandmacOS 完整功能菜单(17 项)
Mac-安装到电脑.command永久安装到 Mac
Windows-从U盘启动.batWindows 一键启动
Windows-全部功能.batWindows 完整功能菜单
Windows-安装到电脑.bat永久安装到 Windows
帮助文档.html本文档(浏览器打开)
Mac-Start.commandmacOS 一键启动(双击即可)
Mac-Menu.commandmacOS 功能菜单(8 项:配置、QQ、备份等)
Windows-Start.batWindows 一键启动
Windows-Menu.batWindows 功能菜单
Config.html首次配置页面(选模型、填 API Key)
U-Claw.html导航首页
setup.sh开发者搭建脚本(自动下载运行时)
+ +

目录结构

+
portable/
+├── app/                    ← 运行时(约 2.3GB)
+│   ├── core/                  OpenClaw + 依赖 + QQ 插件
+│   └── runtime/
+│       ├── node-mac-arm64/    Mac Apple Silicon
+│       └── node-win-x64/     Windows 64-bit
+├── data/                   ← 用户数据(配置、记忆、备份)
+│   ├── .openclaw/             openclaw.json 配置文件
+│   ├── memory/                AI 记忆
+│   └── backups/               备份
+└── [启动脚本和HTML页面]
+ +
注意:目前支持 Mac Apple Silicon (M1-M4)。Windows 版开发中,Mac Intel 暂不支持。
-

安装到电脑(永久模式)

-

方法一:从 U 盘安装

-

双击 Mac-安装到电脑.commandWindows-安装到电脑.bat

-

会将 Node.js + OpenClaw + 依赖复制到 ~/.uclaw/,并添加到系统 PATH

+

安装到电脑(桌面版)

+

桌面版是 Electron 应用,安装后像普通 App 一样使用。自动管理 OpenClaw 网关的启停。

-

方法二:在线安装(需联网)

-
# macOS / Linux
-curl -fsSL https://u-claw.org/install.sh | bash
+

方法一:下载安装包(推荐)

+
1
GitHub Releases 下载: + + + +
系统文件
Mac Apple Silicon (M1-M4)U-Claw-x.x.x-arm64.dmg
Mac IntelU-Claw-x.x.x-x64.dmg
WindowsU-Claw-x.x.x.exe
+
+
2
双击安装,打开 U-Claw
+
3
首次打开自动弹出配置页面,选择模型、填写 API Key
-# Windows PowerShell -iwr -useb https://u-claw.org/install.ps1 | iex +

方法二:开发者自己构建

+
git clone https://github.com/dongsheng123132/u-claw.git
+cd u-claw/u-claw-app
 
-# npm 国内镜像
-npm install -g openclaw@latest --registry https://registry.npmmirror.com
+# Mac / Linux 一键安装(自动下载 Node.js + Electron + 依赖,全部国内镜像) +bash setup.sh -

安装后使用

-
openclaw onboard --install-daemon   # 首次配置
-openclaw dashboard                   # 打开控制台
+# Windows 一键安装 +setup.bat + +# 打包 +npm run build:mac-arm64 # Mac Apple Silicon → release/U-Claw-x.x.x-arm64.dmg +npm run build:mac-x64 # Mac Intel → release/U-Claw-x.x.x-x64.dmg +npm run build:win # Windows → release/U-Claw-x.x.x.exe(需在 Windows 上运行)
+ +

安装版 vs 便携版

+ + + + + + + +
便携版 (U盘)安装版 (桌面App)
安装不需要,双击即用需要安装
数据位置U 盘 data/ 目录系统 ~/Library/Application Support/U-Claw/
换电脑插 U 盘就能用需要重新安装
体验终端 + 浏览器原生 App 窗口
适合临时电脑、公共电脑个人电脑长期使用
安全提醒:共享电脑、公司电脑建议用 U 盘便携模式,不要安装到电脑。
+ +
+

开发者搭建指南

+

克隆代码库后,一键脚本自动配置完整开发环境。全部依赖从国内镜像下载,无需翻墙。

+ +

代码库结构

+
+

这个代码库为以下 5 个目的服务:

+ + + + + + + +
#目的对应目录
1免安装版(U盘便携版)portable/
2安装版(桌面 Electron App)u-claw-app/
3国内环境适配(镜像、一键脚本)setup.sh / setup.bat
4维护工具(迁移、备份、诊断)migrate.js、Menu 脚本
5文档 + 官网website/
+

代码库只包含源代码和脚本(约 4MB),运行时依赖通过 setup.sh 自动下载。

+
+ +

搭建便携版(U 盘版)

+
git clone https://github.com/dongsheng123132/u-claw.git
+cd u-claw/portable
+
+# 一键搭建(自动下载 Node.js v22 + OpenClaw + QQ 插件)
+bash setup.sh
+
+# 启动测试
+bash Mac-Start.command   # Mac
+# 或双击 Windows-Start.bat  # Windows
+ +
setup.sh 自动完成: +
    +
  1. 检测系统(Mac ARM64 / Intel / Linux)
  2. +
  3. 从 npmmirror.com 下载 Node.js v22.14.0
  4. +
  5. 用国内镜像安装 OpenClaw + QQ 插件到 app/
  6. +
  7. 整个过程约 1 分钟
  8. +
+
+ +

搭建桌面版(Electron App)

+
cd u-claw/u-claw-app
+
+# Mac / Linux 一键安装
+bash setup.sh
+
+# Windows 一键安装
+setup.bat
+ +
setup.sh / setup.bat 自动完成: +
    +
  1. 检测或下载 Node.js v22(国内镜像)
  2. +
  3. 用国内镜像安装 npm 依赖 + Electron
  4. +
  5. 下载打包用 Node.js runtime
  6. +
  7. 询问是否立即启动
  8. +
+
+ +

打包分发

+
npm run dev              # 开发模式运行
+npm run build:mac-arm64  # 打包 Mac ARM64 → release/*.dmg
+npm run build:mac-x64    # 打包 Mac Intel → release/*.dmg
+npm run build:win        # 打包 Windows → release/*.exe(需在 Windows 上)
+ +

制作 U 盘

+

搭建完便携版后,把整个 portable/ 目录复制到 U 盘即可:

+
# 搭建完成后
+cp -R portable/ /Volumes/你的U盘/U-Claw/
+

U 盘容量建议 4GB 以上(便携版约 2.3GB)。

+ +

环境变量

+ + + + + +
变量说明默认值
OPENCLAW_HOME用户数据根目录./data
OPENCLAW_STATE_DIR配置文件目录./data/.openclaw
OPENCLAW_CONFIG_PATH配置文件路径./data/.openclaw/openclaw.json
+ +

配置文件格式

+
{
+  "gateway": {"mode": "local", "auth": {"token": "uclaw"}},
+  "agent": {
+    "model": "deepseek-chat",
+    "apiKey": "sk-xxx",
+    "baseUrl": "https://api.deepseek.com/v1"
+  },
+  "channels": {"qqbot": {"token": "appid:secret"}}
+}
+
+ + +
+

国内镜像源

+

U-Claw 的一键脚本默认使用国内镜像,无需翻墙即可完成全部安装。

+ +

npm 镜像

+ + + + + + +
镜像地址说明
npmmirror(淘宝)https://registry.npmmirror.com默认使用,速度最快
腾讯云https://mirrors.cloud.tencent.com/npm/备选
华为云https://repo.huaweicloud.com/repository/npm/备选
中科大https://npmreg.proxy.ustclug.org/学术网络快
+ +

手动切换镜像

+
# 临时使用(推荐)
+npm install --registry=https://registry.npmmirror.com
+
+# 永久设置
+npm config set registry https://registry.npmmirror.com
+
+# 恢复官方源
+npm config set registry https://registry.npmjs.org
+ +

Node.js 下载镜像

+ + + + + +
镜像地址
npmmirrorhttps://npmmirror.com/mirrors/node/
清华大学https://mirrors.tuna.tsinghua.edu.cn/nodejs-release/
中科大https://mirrors.ustc.edu.cn/node/
+ +

Electron 下载镜像

+

setup.sh 已自动设置,手动设置方法:

+
export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
+export ELECTRON_BUILDER_BINARIES_MIRROR="https://npmmirror.com/mirrors/electron-builder-binaries/"
+ +

Git 克隆加速

+
# 方法一:GitHub 镜像(如果直连慢)
+git clone https://ghproxy.com/https://github.com/dongsheng123132/u-claw.git
+
+# 方法二:Gitee 镜像(如果有的话)
+git clone https://gitee.com/dongsheng123132/u-claw.git
+ +
提示:所有 setup.sh 脚本已内置国内镜像配置,正常情况下无需手动设置。此页面供需要自定义或排查问题的用户参考。
+
+

首次配置向导