aico-cui

cui

AICO-CUI - Web UI Agent Platform

CUI Server 是一个基于 Claude Code 的 Web UI 代理平台，提供完整的 AI 对话界面、文件系统管理、权限控制和 MCP（Model Context Protocol）集成。

🚀 快速开始

安装

通用安装

npm install -g aico-cui
aico-cui start

Windows 用户

Windows 用户可能会遇到 native 模块编译问题，我们提供了专门的解决方案：

# 方法 1: 使用专用安装脚本（推荐）
powershell -ExecutionPolicy Bypass -File scripts/install-windows.ps1

# 方法 2: 手动安装
npm install -g aico-cui --force --build-from-source

详细的 Windows 安装指南：

• 📖 Windows 快速安装指南
• 🔧 详细故障排除指南

开发环境

# 克隆项目
git clone <repository-url>
cd aico-cui

# 安装依赖
npm install

# 开发模式运行
npm run dev

🏗️ 构建桌面应用

本项目支持使用 Tauri 构建原生桌面应用程序，支持 Windows、macOS 和 Linux 平台。

快速构建（推荐）

构建当前平台的应用程序：

pnpm build:tauri

构建选项

# 仅构建当前平台（默认）
pnpm build:tauri

# 尝试构建所有平台（需要特定环境配置）
pnpm build:tauri --all

# 跳过前端构建（如果前端已构建）
pnpm build:tauri --skip-web

平台特定构建

# macOS
pnpm build:tauri:mac

# Windows
pnpm build:tauri:windows

# Linux
pnpm build:tauri:linux

使用 GitHub Actions 自动构建

项目已配置 GitHub Actions，可以自动构建所有平台：

• 创建发布标签：

  git tag v0.0.16
  git push origin v0.0.16
  

• 手动触发：访问 GitHub Actions 页面手动触发构建

• 下载产物：在 Actions 页面下载各平台的应用包

📖 详细构建指南：BUILD_GUIDE.md

📁 项目结构

cui/
├── src/                    # 后端源代码
│   ├── server.ts          # Express 服务器
│   ├── routes/            # API 路由
│   ├── services/          # 业务逻辑服务
│   ├── middleware/        # Express 中间件
│   └── web/               # 前端 React 应用
├── src-tauri/             # Tauri 桌面应用
│   ├── src/               # Rust 源代码
│   └── tauri.conf.json    # Tauri 配置
├── dist/                  # 构建输出
├── scripts/               # 构建和部署脚本
└── docs/                  # 文档

🧪 测试

# 运行所有测试
npm test

# 运行单元测试
npm run unit-tests

# 运行集成测试
npm run integration-tests

# 测试覆盖率
npm run test:coverage

# 交互式测试界面
npm run test:ui

📚 文档

• 构建指南 - Tauri 应用构建详细说明
• Windows 安装指南 - Windows 平台安装说明
• Claude Agent SDK 指南 - AI Agent 集成说明

🔐 管理员权限说明

系统代理功能

系统代理功能需要管理员权限来修改系统网络设置。如果您看到"需要管理员权限"的错误，请按照以下方法之一操作：

Windows 用户

方法 1：使用提权脚本（推荐）

# 在 PowerShell 中运行
.\scripts\elevate-windows.ps1

# 或在命令行中运行
scripts\elevate-windows.bat

方法 2：手动以管理员身份运行

• 关闭当前程序
• 右键点击程序图标或快捷方式
• 选择"以管理员身份运行"
• 在 UAC 提示框中点击"是"

方法 3：从管理员 PowerShell 启动

# 以管理员身份打开 PowerShell
cd D:\work\workspace-aico\cui
pnpm dev

macOS/Linux 用户

# 使用 sudo 运行
sudo npm run dev

# 或
sudo pnpm dev

注意：

• 系统代理功能会修改系统网络设置
• 关闭应用时会自动恢复原始代理配置
• 只有在需要使用系统代理功能时才需要管理员权限
• 其他功能（如对话、文件管理等）不需要管理员权限

🔧 配置

应用配置通过环境变量和配置文件管理：

# 复制配置文件模板
cp .env.example .env

# 编辑配置
vi .env

主要配置项：

• PORT - 服务器端口（默认：13001）
• NODE_ENV - 运行环境（development/production）
• ANTHROPIC_API_KEY - Claude API 密钥
• LOG_LEVEL - 日志级别

🚢 部署

使用 PM2 部署

# 启动服务
npm run start:pm2

# 停止服务
npm run stop:pm2

# 重启服务
npm run restart:pm2

# 查看状态
npm run status:pm2

# 查看日志
npm run logs:pm2

Docker 部署

# 构建镜像
docker build -t aico-cui .

# 运行容器
docker run -p 13001:13001 aico-cui

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 许可证

MIT License