# ClawKit

**Repository Path**: open2ai/ClawKit

## Basic Information

- **Project Name**: ClawKit
- **Description**: 一款名为「OpenClaw 龙虾一键安装助手」的工具，核心功能是让 0 基础用户无需手动配置环境，一键完成 OpenClaw 的安装、环境检测、API 绑定、基础技能预装，支持 Windows/macOS/Linux 主流系统，最终输出可直接打包分发的成品工具及使用文档。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-13
- **Last Updated**: 2026-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ClawKit - OpenClaw 一键安装工具

[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg)](README.md)

## 项目简介

ClawKit 是一个专为 OpenClaw AI 智能体设计的跨平台一键安装工具。它让零基础用户也能轻松部署和配置 OpenClaw Gateway 网关，支持 WhatsApp、Telegram、Discord、iMessage 等多种消息渠道。

### 核心特性

- 🚀 **一键部署** - 自动化完成 OpenClaw 的安装和配置
- 🌐 **跨平台支持** - 支持 Windows 10/11、macOS 10.15+、Ubuntu 20.04+
- 🔒 **安全可靠** - 本地存储 API 密钥，不传输敏感数据
- 📊 **智能检测** - 自动检测系统环境和端口占用
- 🛠️ **故障修复** - 内置 95% 常见环境问题的解决方案
- 🎯 **用户友好** - 彩色命令行界面，清晰的进度提示

## 快速开始

### 系统要求

- **操作系统**: Windows 10/11, macOS 10.15+, Ubuntu 20.04+
- **Python**: 3.8 或更高版本
- **npm**: 6.0 或更高版本
- **内存**: 至少 4GB RAM
- **磁盘空间**: 至少 500MB 可用空间

### 安装步骤

1. **下载项目**
   ```bash
   git clone https://gitee.com/open2ai/ClawKit.git
   cd ClawKit
   ```

2. **安装依赖**
   ```bash
   pip install -r requirements.txt
   ```

3. **运行安装工具**
   ```bash
   python src/clawkit.py
   ```

### 静默安装模式

如需无人值守安装，可使用静默模式：
```bash
python src/clawkit.py --silent
```

## 功能特性

### 1. 系统环境检测
- ✅ 操作系统兼容性检查
- ✅ Python 版本验证
- ✅ npm 安装状态检测
- ✅ 端口占用检查（默认端口 18789）

### 2. OpenClaw 部署
- ✅ 通过 npm 全局安装 OpenClaw
- ✅ 自动配置国内镜像源（腾讯云、阿里云等）
- ✅ 服务启动和验证
- ✅ 控制界面访问测试

### 3. API 密钥配置
- 🔑 **OpenAI** - GPT 系列模型
- 🔑 **Kimi** - 月之暗面智能助手
- 🔑 **智谱AI** - GLM 系列模型
- 🔑 **讯飞星火** - 星火认知大模型

### 4. 基础技能包预装
- 📁 **文件自动化** - 文档处理、格式转换
- ✍️ **文案生成** - 内容创作、文本优化
- 📊 **数据统计** - 数据分析、报表生成

## 项目结构

```
ClawKit/
├── src/                    # 源代码目录
│   ├── clawkit.py         # 主程序入口
│   ├── installer.py       # OpenClaw 安装器
│   ├── system_check.py    # 系统环境检测
│   ├── api_config.py      # API 密钥配置
│   ├── skills.py          # 技能包管理
│   ├── helper.py          # 辅助功能
│   └── utils.py           # 工具函数
├── scripts/               # 打包脚本
│   ├── build_win.py      # Windows 打包
│   ├── build_mac.py      # macOS 打包
│   └── build_linux.py    # Linux 打包
├── docs/                  # 文档目录
│   ├── BUILD.md          # 编译指南
│   └── USER_GUIDE.md     # 用户手册
├── tests/                # 测试文件
├── requirements.txt      # Python 依赖
└── README.md            # 项目说明
```

## 使用说明

### 首次运行流程

1. **启动工具**
   ```bash
   python src/clawkit.py
   ```

2. **系统检测** - 工具会自动检测您的系统环境

3. **OpenClaw 安装** - 自动通过 npm 安装 OpenClaw

4. **API 配置** - 选择并配置您的大模型 API 密钥

5. **技能包安装** - 选择需要预装的基础技能包

6. **部署验证** - 验证 OpenClaw 服务是否正常运行

### 控制界面访问

安装完成后，访问以下地址开始使用：
- **OpenClaw 控制台**: http://localhost:18789
- **默认端口**: 18789（如被占用会自动选择其他端口）

### 配置文件位置

- **OpenClaw 配置**: `~/.openclaw/openclaw.json`
- **ClawKit 日志**: `~/.clawkit/logs/`

## 开发指南

### 环境设置

1. **克隆仓库**
   ```bash
   git clone https://gitee.com/open2ai/ClawKit.git
   cd ClawKit
   ```

2. **创建虚拟环境**
   ```bash
   python -m venv venv
   source venv/bin/activate  # Linux/macOS
   venv\Scripts\activate    # Windows
   ```

3. **安装开发依赖**
   ```bash
   pip install -r requirements.txt
   ```

### 运行测试

```bash
# 运行安装器测试
python test_installer.py

# 运行语法检查
python test_syntax.py
```

### 代码贡献

1. Fork 本项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

## 打包发布

### Windows 打包
```bash
python scripts/build_win.py
```

### macOS 打包
```bash
python scripts/build_mac.py
```

### Linux 打包
```bash
python scripts/build_linux.py
```

详细打包说明请参考 [docs/BUILD.md](docs/BUILD.md)。

## 故障排除

### 常见问题

**Q: npm 命令未找到**
A: 请先安装 Node.js 和 npm，或确保 npm 在系统 PATH 中

**Q: 端口 18789 被占用**
A: 工具会自动检测并选择其他可用端口

**Q: OpenClaw 服务启动失败**
A: 检查防火墙设置，确保端口访问权限

**Q: API 密钥配置失败**
A: 确认 API 密钥格式正确，网络连接正常

### 日志文件

- 安装日志: `~/.clawkit/logs/install.log`
- 错误日志: `~/.clawkit/logs/error.log`

## 技术支持

- **文档**: [用户手册](docs/USER_GUIDE.md)
- **问题反馈**: [GitHub Issues](https://github.com/your-org/ClawKit/issues)
- **联系方式**: ClawKit-Support (微信)

## 版本历史

- **v1.0.0** (2026-03-20)
  - 初始版本发布
  - 支持 OpenClaw npm 安装
  - 跨平台兼容性
  - 基础技能包管理

## 许可证

本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。

## 致谢

- [OpenClaw](https://docs.openclaw.ai/) - AI 智能体框架
- [colorama](https://pypi.org/project/colorama/) - 跨平台彩色终端输出
- [cryptography](https://pypi.org/project/cryptography/) - 安全加密库

---

**让 AI 部署变得简单，让每个人都能享受智能助手的便利！** 🦞