# install-openclaw

**Repository Path**: guhanfei/install-openclaw

## Basic Information

- **Project Name**: install-openclaw
- **Description**: 开发一个图形界面软件，帮助想要玩OpenClaw的用户简单快速完成配置和使用
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-05
- **Last Updated**: 2026-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GHF · OpenClaw 辅助工具

一款跨平台桌面 GUI 程序，帮助用户一键安装、配置并管理 [OpenClaw](https://openclaw.ai)。

---

## 支持平台

| 平台 | 版本要求 |
|------|---------|
| Windows（家用） | Windows 10 及以上 |
| Windows Server | Server 2016 及以上 |
| macOS | macOS 10.15 (Catalina) 及以上 |

---

## 功能介绍

| 功能 | 说明 |
|------|------|
| 检测本机电脑 | 查看 CPU / 内存 / 磁盘 / OpenClaw 数据目录 |
| 安装 OpenClaw | 自动安装 Git、Node.js、OpenClaw，并为 npm 优先使用国内镜像 |
| 启动 / 停止 | 启动、停止、重启网关服务，一键打开聊天界面 |
| 升级 OpenClaw | 检测并一键升级本机已安装的 OpenClaw（`openclaw` 命令行工具）到最新版 |
| 模型厂商 | 可视化切换 AI 服务商及 API Key |
| 卸载 OpenClaw | 完整卸载程序与配置目录 |

---

## 下载使用

### Windows 用户
1. 下载 Windows 安装包并运行
2. 首次安装时，程序会按系统架构自动下载安装 Git / Node.js，并继续安装 OpenClaw
3. 如系统弹出管理员权限确认，请点击「是」

### macOS 用户
1. 下载 `.dmg` 文件，将应用拖拽至 Applications 文件夹
2. 从启动台打开即可使用
3. 首次安装依赖时，程序会优先使用清华 Homebrew 镜像与 `npmmirror`

> 重复打开程序时，会自动检测 `~/.openclaw` 目录中的现有配置，无需重新设置。
> 国内网络环境下，建议优先使用项目内置镜像或你自己的文件源，以减少外网下载依赖。

### 升级说明

- **升级 OpenClaw**：这是本工具的正式业务功能；在应用内「升级 OpenClaw」页面中，用于升级本机已安装的 OpenClaw。
- **升级本工具**：本桌面辅助工具目前**不支持**应用内检查更新或自动更新。如需更新本程序，请从您当初获取安装包的分发渠道下载新版安装包并重新安装。

---

## 本地开发

### 环境要求

- [Node.js](https://nodejs.org/) 20+
- [Rust](https://www.rust-lang.org/tools/install)（含 cargo）
- [Tauri CLI 前置依赖](https://v2.tauri.app/start/prerequisites/)

### 启动开发模式

```bash
npm install --registry=https://registry.npmmirror.com
npm run tauri dev
```

首次运行会自动编译 Rust 后端，耗时约 1-2 分钟，后续热重载极快。

### 运行测试

```bash
npm test
npm run test:rust
npm run test:all
```

项目内测试分为两层：
- 前端：`Vitest` 覆盖版本比较、架构识别、镜像列表解析等纯逻辑
- 后端：`cargo test` 覆盖命令转义、文本解析、frontmatter 解析等 Rust 纯函数

CI 会在 macOS 与 Windows 上分别执行上述测试，确保平台分支持续可用。

### 构建发布包

```bash
make check        # 检查环境工具是否齐全
make install-deps # 首次使用：安装交叉编译依赖
make build-mac    # 打包 macOS（Apple Silicon）
make build-win    # 打包 Windows（x86_64）
make all          # 同时打包两个平台
```

产物统一输出到 `./builds/` 目录：
- macOS：`install-openclaw-<version>-macos-arm64.dmg`
- Windows：`install-openclaw-<version>-windows-x86_64.exe`

更多平台安装与开发说明见：
- [macOS 开发编译环境准备](./docs/dev-setup-macos.md)
- [Windows 开发编译环境准备](./docs/dev-setup-windows.md)

---

## 技术栈

- **前端**：Vue 3 + TypeScript + Vite
- **后端**：Rust + Tauri 2.0
- **UI 图标**：lucide-vue-next

---

## License

Copyright 2026 GHF

Licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for details.