XiaoZuoClaw (小左爪) 🍇

XiaoZuoClaw 是您的个人、本地部署的 AI 助手，专为提高办公效率和无缝工作流自动化而设计。

功能特性

• 本地记忆：安全、基于向量的长期记忆，完全本地存储。
• 办公技能：读取、创建和修改 Word、Excel 和 PowerPoint 文件。
• 多 Agent 系统：针对不同任务的专用 Agent（例如：Office Agent）。
• Web 界面：现代、响应式的聊天界面，支持多语言（中/英）。
• 可扩展性：插件系统和技能注册表，方便添加新功能。

安装指南

请选择最适合您的安装方式。

方式一：下载桌面客户端 (最适合小白用户)

如果您不想安装 Node.js 或使用命令行，可以直接下载我们预编译好的桌面客户端。

1. 前往 GitHub Releases 页面。
2. 下载适用于您操作系统（Windows .exe, macOS .dmg, Linux .AppImage）的最新版本安装包。
3. 双击安装并运行。

方式二：通过 npm 安装 (推荐)

这是安装和运行 XiaoZuoClaw 最简单的方式。

1. 全局安装：

   npm install -g xiaozuo-claw

2. 启动应用：

   xiaozuoClaw start

3. 访问界面： 在浏览器中打开 http://localhost:3001。

方式二：源码安装（开发者）

如果您想贡献代码或修改功能，请使用此方式。

1. 克隆仓库：

   git clone https://github.com/mantlelau-lgtm/claw.git
   cd claw

2. 安装依赖：

   npm install

3. 构建并链接：

   npm run build
   npm link

4. 启动：

   xiaozuoClaw start

5. 访问界面： 在浏览器中打开 http://localhost:3001。

更新指南

如果通过 npm 安装

npm update -g xiaozuo-claw

如果通过源码安装

1. 进入项目目录。
2. 拉取最新代码并重新构建：

   git pull origin main
   npm install
   npm run build

卸载指南

如果通过 npm 安装

npm uninstall -g xiaozuo-claw

如果通过源码安装

1. 取消链接：

   npm unlink -g

2. 删除项目文件夹：

   rm -rf claw

（注意：卸载操作不会自动删除您的本地数据/配置文件（如果它们存储在包目录之外）。如果是源码安装，项目文件夹内的数据会在删除文件夹时一并被删除。）

Docker 部署（即将推出）

我们正在开发 Docker Compose 配置，以便更轻松地部署。敬请期待！

文档

• API 使用指南
• 数据迁移指南
• 产品需求文档
• 技术架构

开发与构建

本地运行 Electron 客户端

npm run electron:dev

构建安装包

npm run electron:build

构建产物将位于 release 目录下。

许可证

MIT