Skip to content

quentinzhang/ConsoleY

 
 

Repository files navigation

ConsoleY

ConsoleY 是一个轻量级的跨平台桌面应用,提供了一个隔离的 GUI 环境,允许 AI 像人类一样操作计算机。受 Anthropic 的 Computer Use 项目启发,ConsoleY 提供了一个安全、可控的环境,支持通过 API 进行屏幕截图、鼠标点击等操作。

✨ 特性

  • 🖥️ 跨平台支持 (Windows, macOS, Linux)
  • 🔒 隔离的 Docker 容器环境
  • 🖱️ 完整的 GUI 桌面环境
  • 🛠️ RESTful API 接口
  • 📦 预装常用应用 (Firefox, LibreOffice 等)
  • 🎨 可自定义的桌面设置
  • 🔄 实时屏幕同步
  • 🎯 精确的鼠标和键盘控制

🚀 快速开始

用户安装

Releases 页面下载适合您系统的安装包。

运行要求

首次运行时,应用会自动下载所需的 Docker 镜像。

开发环境要求

以下依赖仅开发者需要安装:

开发者安装

  1. 克隆仓库
git clone https://github.com/EvalsOne/consoley.git
cd consoley
  1. 构建 Docker 镜像
docker build -t consoleai/desktop:latest ./docker/desktop
  1. 安装依赖
#安装前端依赖
npm install
#安装 Rust 依赖
cd src-tauri
cargo build
cd ..
  1. 启动开发环境
npm run tauri dev

📡 API 接口

ConsoleY 提供以下 API 接口:

GET /computer/screenshot # 获取屏幕截图
POST /computer/click # 模拟鼠标点击
POST /computer/keypress # 模拟按键
GET /computer/status # 获取系统状态
......

详细的 API 文档请参考 API.md

🛠️ 开发

项目结构

consoley/
├── src-tauri/ # Tauri 配置和后端代码
├── docker/ # Docker 相关文件
├── public/ # 前端静态资源
├── src/ # 前端源代码
└── docker-compose.yml # Docker 编排配置

构建

# 开发模式
npm run tauri dev
# 构建发布版本
npm run tauri build

🤝 贡献

欢迎提交 Pull Request 和 Issue!在提交之前,请确保:

  1. 更新测试用例
  2. 更新文档
  3. 遵循现有的代码风格

📄 许可证

本项目采用 MIT 许可证。

🙏 致谢

📞 联系方式

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 47.6%
  • TypeScript 16.8%
  • Shell 12.5%
  • Dockerfile 11.9%
  • CSS 10.1%
  • HTML 1.1%