Open ACE is a self-hosted enterprise platform that unifies multiple AI coding agents (Claude Code, Qwen Code, Codex, OpenClaw) in a single workspace while providing administrators with centralized governance, cost tracking, API key management, and audit capabilities. Designed for organizations needing private deployment, remote execution, team quotas, and compliance controls.
Self-hosted enterprise AI workspace and governance platform
README
🎯 这是什么?
Open ACE 是一个开源的自托管 AI Coding Agent 工作台、远程执行层与治理控制面:开发者可以在浏览器里统一使用 Claude Code、Qwen Code、Codex、ZCode、OpenClaw 等 AI 编码工具,并把它们运行在团队自己的远程机器上;管理员可以集中管理 API Key、权限、成本、配额、审计和合规;团队还可以把 GitHub Issue 驱动的 AI 自主开发工作流纳入同一套平台。
它适合已经把 AI Coding Agent 引入真实研发流程的组织,尤其适合需要私有化部署、内网远程机器、统一密钥代理、团队配额和可追溯审计的研发团队、IT 团队和 AI 平台团队。
| 问题 | 解决方案 |
|---|---|
| 🤖 团队同时使用多个 AI Coding Agent | 多 CLI 工作台统一 Claude Code、Qwen Code、Codex、ZCode、OpenClaw 等工具 |
| 🖥️ Agent 需要跑在内网、测试机或 GPU 机器上 | Remote Agent 让 AI CLI 直接在目标机器执行 |
| 🔑 API Key 不该散落在个人电脑和远程机器上 | API Key Proxy 把真实密钥留在服务端,只下发短生命周期、可回收的代理令牌 |
| 🔄 希望 AI 能围绕 Issue 持续开发,而不只是单次对话 | AI 自主开发工作流支持 Issue 解析、规划、执行、PR、评论与人工中断后继续 |
| 📊 成本、配额、风险和审计需要可见 | Manage 模式提供用量、成本、配额、异常、审计和合规视图 |
你可以用 Open ACE 做什么:
- 给团队一个统一入口,管理本地/远程 AI coding 会话、提示词、历史记录和项目上下文
- 通过 Remote Agent 把 Claude Code、Qwen Code、Codex、ZCode、OpenClaw 等 CLI 跑在团队自己的开发机、测试机或 GPU 机器上
- 围绕 GitHub Issue 创建 AI 自主开发任务,让工作流完成规划、编码、提交 PR、批注和人工接管/恢复
- 加密保存 LLM API Key,通过短生命周期、可回收的代理令牌给本地和远程会话安全调用模型
- 给管理者一套控制面板,查看 Token、成本、异常、配额、审计、合规报告和 ROI
- 在自己的网络里部署,保留企业数据边界,并接入 OIDC/OAuth2/SAML SSO、飞书/钉钉同步和 Kubernetes
🔥 近期功能亮点
| 功能 | 为什么重要 |
|---|---|
| AI Coding Agent 控制面 | 把团队已在使用的多个 AI CLI 纳入统一入口、权限、成本和审计体系 |
| 远程工作区与 Remote Agent | 用户在浏览器里选择远程机器,AI CLI 直接在目标机器运行,无需反复传 SSH 凭据 |
| 多 CLI 适配器 | Claude Code、Qwen Code、Codex、ZCode、OpenClaw 统一接入,包含会话恢复、权限模式和历史同步 |
| AI 自主开发工作流 | 支持按 GitHub Issue 创建/排队工作流,自动推进规划、实现、PR、评论、暂停恢复与分叉 |
| API Key 代理 | API Key 加密存储在服务器,远程 Agent 只拿短生命周期、可回收的代理令牌,统一配额和用量统计 |
| 终端与 VSCode/code-server 代理 | 支持浏览器终端、远程目录浏览和 code-server/VSCode 访问,适合真实研发工作流 |
| 合规与报表 | 支持审计追踪、配额检查、合规报告生成和 CSV 下载 |
| 开源协作基础 | 已补齐 Roadmap、Security Policy、Issue 模板、Dependabot、CODEOWNERS 和适合新手的 Issue 标签 |
✨ 两种模式,双重价值
🚀 Work 模式 — 让 AI 成为你的超级助手
面向每一位员工,提供流畅的 AI 交互体验
核心能力:
- 🤖 多 AI 工具集成 — Claude Code、Qwen Code、Codex、ZCode、OpenClaw 一个入口统一使用
- 🖥️ 远程工作区 — 在浏览器里选择远程机器,启动 AI 编码会话、终端和目录浏览
- 🔄 AI 自主开发 — 围绕 GitHub Issue 运行自治工作流,支持排队、暂停、恢复、分叉和批量推进
- 💬 智能会话管理 — 历史记录、会话恢复、上下文记忆和跨工具会话同步
- 📝 提示词库 — 团队共享优质提示词,最佳实践一键复用
- 🔍 快速检索 — 跨会话搜索历史对话,知识沉淀不丢失
📊 Manage 模式 — 让 AI 治理有据可依
面向管理者,提供全方位的 AI 使用洞察与管控
核心能力:
- 📈 用量可视化 — Token 消耗趋势、成本分析、使用热力图,一目了然
- 🔑 API Key 治理 — 加密存储 API Key,通过代理令牌调用模型,避免密钥下发到远程机器
- 🚨 智能告警 — 配额预警、异常检测、超支提醒,风险早知道
- 📋 合规审计 — 敏感内容检测、对话记录追溯、合规报告生成和 CSV 下载
- 👥 多租户管理 — 租户级会话、项目、用量与审计隔离,配合权限控制与资源配额实现精细化管理
- 💰 ROI 分析 — 基于可见、可配置假设的 ROI 规划估算与效率量化
🏢 为什么选择 Open ACE?
| 特性 | 说明 |
|---|---|
| 🔒 默认自托管 | 私有化部署,数据和 API Key 留在自己的网络与数据库里 |
| 🎛️ Agent 控制面 | 统一管理工具、用户、机器、密钥、配额、成本和审计,而不是替代每个 AI CLI |
| 🌐 多工具工作台 | Claude Code、Qwen Code、Codex、ZCode、OpenClaw 统一入口、统一历史、统一治理 |
| 🖥️ 远程执行 | Remote Agent 让 AI CLI 在目标机器运行,适合研发服务器、测试环境和 GPU 机器 |
| 🔄 自主开发闭环 | 从 GitHub Issue 到规划、实现、PR、评论和人工接管,形成可追踪的 AI 开发工作流 |
| 📊 治理可观测 | Token、成本、配额、异常、审计、合规和 ROI 统一分析 |
| 🔌 企业集成 | 支持 OIDC/OAuth2/SAML 2.0 SSO、飞书/钉钉组织同步、钉钉/飞书告警机器人、Kubernetes、反向代理和多租户权限模型 |
| 🆓 开放协作 | Apache 2.0 协议,Roadmap、贡献指南和 good first issue 已就位 |
🚀 5 分钟快速开始
方式一:一键部署(推荐)
# 克隆项目
git clone https://github.com/open-ace/open-ace.git
cd open-ace
# 构建并启动
docker compose up -d --build
# 访问 http://localhost:19888
💡 零配置:安全密钥(
SECRET_KEY/OPENACE_ENCRYPTION_KEY/UPLOAD_AUTH_KEY)在首次启动时自动生成,无需预先配置。⚠️ 生产环境请通过
.env显式设置强密钥(参考.env.example)、修改默认密码,并参阅 部署指南。自动生成的密钥仅存在于运行环境,容器/卷销毁后不保留。
🇨🇳 国内网络:若构建时拉取基础镜像卡住或超时,见 国内网络加速。
🇨🇳 国内网络加速
若构建时拉取 Docker Hub 基础镜像(python、node、postgres)卡住或超时,设置 BASE_REGISTRY 指向国内镜像源后重新构建:
export BASE_REGISTRY=docker.m.daocloud.io
docker compose up -d --build
该变量会同时作用于 Dockerfile 的基础镜像拉取和 postgres 镜像拉取。可选镜像源:
| 镜像源 | 地址 |
|---|---|
| DaoCloud | docker.m.daocloud.io |
| 1Panel | docker.1panel.live |
镜像源可用性会随时间变化,表中任选一个能 pull 通即可;也可换用其他公开的 Docker Hub 镜像。
也可在 Docker daemon 配置
registry-mirrors(Docker Desktop / OrbStack 的镜像加速设置),效果相同但作用于全局。
方式二:源码安装
# 1. 克隆项目
git clone https://github.com/open-ace/open-ace.git
cd open-ace
# 2. 安装后端依赖
pip install -r requirements.txt
# 3. 安装前端依赖并构建
cd frontend && npm install && npm run build && cd ..
# 4. 初始化配置和数据库
python3 cli.py config init
alembic upgrade head
python3 scripts/init_db.py
# 5. 启动服务
python3 server.py
# 访问 http://localhost:19888
默认账号
| 角色 | 用户名 | 密码 |
|---|---|---|
| 管理员 | admin | admin123 |
⚠️ 默认账号仅用于本地首次启动。生产环境请务必显式设置
SECRET_KEY、OPENACE_ENCRYPTION_KEY、UPLOAD_AUTH_KEY,修改默认密码,并参考 部署指南 完成安全配置。
📖 功能详解
📊 数据分析
| 功能 | 描述 |
|---|---|
| 趋势分析 | 按日/周/月查看 Token 使用趋势 |
| 对比分析 | 不同时间段、不同工具的用量对比 |
| 热力图 | 使用高峰时段可视化 |
| 成本分析 | Token 消耗与成本换算 |
💬 消息追踪
| 功能 | 描述 |
|---|---|
| 对话历史 | 查看完整对话记录 |
| 消息搜索 | 按关键词、用户、时间筛选 |
| 会话导出 | 导出对话记录用于审计 |
| 时间线视图 | 可视化展示对话流程 |
🖥️ 远程工作区
| 功能 | 描述 |
|---|---|
| Remote Agent | 在 Linux/macOS/Windows 远程机器上运行 AI CLI 守护进程 |
| CLI 适配器 | 支持 Claude Code、Qwen Code、Codex、ZCode、OpenClaw 的启动、会话恢复和权限模式 |
| 浏览器终端 | 通过 WebSocket 访问远程 shell,Linux/macOS 使用 PTY,Windows 使用管道子进程,并支持断线后的屏幕恢复 |
| VSCode/code-server | 代理远程 code-server/VSCode 路径,方便在浏览器中继续开发 |
| API Key 代理 | 真实密钥只保存在服务器,远程会话通过短生命周期、可回收的代理令牌访问模型 |
🔄 AI 自主开发
| 功能 | 描述 |
|---|---|
| GitHub Issue 解析 | 支持 issue 编号、范围和 URL,批量创建自主开发任务 |
| 工作流编排 | 排队、规划、编码、PR、评论、合并等阶段可视化推进 |
| 人机协作 | 支持暂停、继续、插入反馈、从中间节点分叉新工作流 |
| GitHub 操作集成 | 使用机器人账户令牌执行 issue、PR、评论等自动化操作 |
🔔 告警中心
| 功能 | 描述 |
|---|---|
| 配额告警 | 用量达到阈值自动提醒 |
| 异常检测 | 识别异常使用模式 |
| 邮件通知 | 定期发送用量报告 |
| Webhook / 机器人推送 | 实时推送告警到 Webhook,支持飞书 / Lark 和钉钉群机器人 |
👥 用户管理
| 功能 | 描述 |
|---|---|
| 多租户 | 支持多部门/团队隔离 |
| 角色权限 | 管理员/普通用户角色区分 |
| SSO 集成 | 支持 OIDC/OAuth2 与 SAML 2.0 企业单点登录 |
| 飞书同步 | 手动触发并可按配置自动同步飞书组织架构 |
| 钉钉同步 | 手动触发并可按配置自动同步钉钉组织架构,导入 OpenClaw 会话时解析钉钉用户名和群名称 |
📋 合规与报表
| 功能 | 描述 |
|---|---|
| 审计日志 | 追踪用户、会话、工具和关键管理操作 |
| 合规检查 | 覆盖数据留存、配额使用、敏感内容和访问控制 |
| 报告生成 | 生成企业合规报告,并支持 JSON/CSV 等格式 |
| 风险建议 | 基于检查结果给出治理建议和后续动作 |
🛠️ 技术栈
后端
- Python 3.10+
- Flask — Web 框架
- SQLAlchemy — ORM
- PostgreSQL / SQLite — 数据库
- Alembic — 数据库迁移
前端
- React 18 — UI 框架
- TypeScript — 类型安全
- Vite — 构建工具
- Bootstrap 5 — UI 组件
- Chart.js — 数据可视化
📁 项目结构
open-ace/
├── server.py # Web 服务入口
├── cli.py # CLI 工具入口
├── app/ # 后端应用
│ ├── routes/ # API 路由
│ ├── services/ # 业务逻辑
│ ├── modules/ # 工作区、合规等领域模块
│ ├── models/ # 数据模型
│ └── repositories/ # 数据访问
├── frontend/ # 前端应用
│ ├── src/ # 源代码
│ ├── e2e/ # Playwright 端到端测试
│ └── package.json # 依赖配置
├── remote-agent/ # 远程工作区 Agent 与 CLI 适配器
├── k8s/ # Kubernetes 部署清单
├── migrations/ # Alembic 数据库迁移
├── schema/ # 数据库 Schema 辅助文件
├── scripts/ # 核心脚本与运维辅助文件
│ ├── fetch_*.py # 数据收集
│ ├── cron/ # 定时任务脚本
│ ├── systemd/ # systemd service/timer 示例
│ └── shared/ # 共享模块
├── static/ # 运行时静态资源与前端构建产物
├── docs/ # 文档
└── tests/ # 测试
📚 文档
docs/ 目录保存产品文档源代码;对外发布的 Docusaurus 文档站在独立仓库 open-ace/open-ace-docs 中构建和部署。
- 文档站:https://open-ace.github.io/open-ace-docs/docs/intro
- 文档站源码仓库:https://github.com/open-ace/open-ace-docs
- 旧的
https://open-ace.github.io/open-ace/入口将重定向到当前文档站,避免看到过期页面
| 文档 | 说明 |
|---|---|
| 架构说明 | 系统架构与核心概念 |
| 部署指南 | 本地与生产环境部署 |
| 开发指南 | 参与开发 |
| 远程工作区 | 远程机器、Agent、API Key 代理与安全设计 |
| 远程 Agent | Agent 安装、CLI 适配器、终端和会话同步 |
| 权限模型 | 租户、角色与访问控制 |
| Kubernetes | K8s 部署参考(多副本 + 粘性会话边界) |
| 飞书配置 | 飞书集成配置 |
| 钉钉配置 | 钉钉集成配置 |
| API 文档 | API 接口说明 |
| 仓库设置 | GitHub topics、labels、分支保护和发布检查清单 |
🤝 贡献
我们欢迎所有形式的贡献!
- 🐛 发现 Bug?提交 Issue
- 💡 有想法?参与讨论
- 🗺️ 想了解计划?查看 Roadmap
- 🔧 想贡献代码?阅读 贡献指南
- 🌱 第一次贡献?从
good first issue或help wanted开始
适合参与的方向包括:远程工作区体验、CLI 适配器、部署脚本、文档翻译、前端可用性、测试覆盖和企业集成。
📄 许可证
本项目采用 Apache 2.0 许可证开源。
🎯 What is This?
Open ACE is an open-source self-hosted workspace, remote execution layer, and control plane for AI coding agents: developers can use Claude Code, Qwen Code, Codex, ZCode, OpenClaw, and similar tools from one browser workspace while running them on the team's own remote machines; administrators can centralize API keys, access control, quotas, cost visibility, audit trails, and compliance; teams can also bring GitHub issue-driven autonomous development workflows onto the same platform.
It is built for teams moving AI coding agents into real engineering workflows, especially organizations that need self-hosted deployment, private-network machines, centralized key proxying, team quotas, and traceable audit records.
| Challenge | Solution |
|---|---|
| 🤖 Teams use multiple AI coding agents | Multi-CLI workspace for Claude Code, Qwen Code, Codex, ZCode, OpenClaw, and more |
| 🖥️ Agents need to run on internal, staging, or GPU machines | Remote Agent runs AI CLIs directly on target machines |
| 🔑 API keys should not spread across laptops and remote boxes | API Key Proxy keeps real keys on the server and issues short-lived, revocable proxy tokens |
| 🔄 Teams want issue-driven execution, not just chat sessions | Autonomous workflows can parse issues, plan, implement, open PRs, comment, and resume after human interruption |
| 📊 Cost, quotas, risk, and audit need visibility | Manage Mode tracks usage, cost, quotas, anomalies, audit trails, and compliance |
What you can do with Open ACE:
- Give teams one place for local/remote AI coding sessions, prompts, history, and project context
- Run Claude Code, Qwen Code, Codex, ZCode, OpenClaw, and similar CLIs on your own development, staging, or GPU machines through the Remote Agent
- Create autonomous development tasks from GitHub issues and let workflows plan, implement, comment, open PRs, and continue with human guidance
- Store LLM API keys centrally and issue short-lived, revocable proxy tokens to local and remote sessions
- Give administrators a control plane for tokens, cost, anomalies, quotas, audits, compliance reports, and ROI
- Deploy inside your own network while integrating OIDC/OAuth2/SAML SSO, Feishu/DingTalk sync, and Kubernetes
🔥 Recent Highlights
| Capability | Why it matters |
|---|---|
| AI coding agent control plane | Bring the team's existing AI CLIs under one access, key, quota, cost, and audit model |
| Remote Workspace and Remote Agent | Users choose a remote machine in the browser and run AI CLIs there without repeatedly sharing SSH credentials |
| Multi-CLI adapters | Claude Code, Qwen Code, Codex, ZCode, and OpenClaw share one workspace with session recovery, permission modes, and history sync |
| Autonomous development workflows | Queue GitHub issue-driven workflows that move through planning, implementation, PR creation, commenting, pause/resume, and forks |
| API Key proxy | Keys are encrypted on the server; remote agents only receive short-lived, revocable proxy tokens with unified quota and usage tracking |
| Terminal and VSCode/code-server proxy | Browser terminal, remote directory browsing, and code-server/VSCode access make the workspace useful for real development loops |
| Compliance and reporting | Audit trails, quota checks, compliance reports, and CSV downloads are available for governance workflows |
| Open-source readiness | Roadmap, Security Policy, issue templates, Dependabot, CODEOWNERS, and beginner-friendly labels are in place |
✨ Two Modes, Double Value
🚀 Work Mode — Make AI Your Super Assistant
For every employee, providing a seamless AI interaction experience
Key Capabilities:
- 🤖 Multi-AI Integration — Claude Code, Qwen Code, Codex, ZCode, and OpenClaw behind one workspace
- 🖥️ Remote Workspace — Choose a remote machine in the browser, then start AI coding sessions, terminals, and directory browsing
- 🔄 Autonomous Development — Run issue-driven workflows with queueing, pause/resume, branching, and guided handoff points
- 💬 Smart Session Management — History, session recovery, context memory, and cross-tool history sync
- 📝 Prompt Library — Share best practices across your team with reusable prompts
- 🔍 Quick Search — Search across all conversations, knowledge preserved
📊 Manage Mode — Data-Driven AI Governance
For administrators, providing comprehensive AI usage insights and control
Key Capabilities:
- 📈 Usage Visualization — Token consumption trends, cost analysis, heatmaps at a glance
- 🔑 API Key Governance — Encrypt API keys on the server and call models through scoped proxy tokens
- 🚨 Smart Alerts — Quota warnings, anomaly detection, overspending alerts — know risks early
- 📋 Compliance Audit — Sensitive content detection, conversation trails, compliance reports, and CSV downloads
- 👥 Multi-tenant Management — Tenant-scoped session and project isolation, permission control, and resource quotas
- 💰 ROI Analysis — Configurable ROI planning estimates with transparent assumptions and efficiency metrics
🏢 Why Open ACE?
| Feature | Description |
|---|---|
| 🔒 Self-hosted by default | Keep data and API keys inside your own network and database |
| 🎛️ Agent control plane | Manage tools, users, machines, keys, quotas, cost, and audit trails without replacing every AI CLI |
| 🌐 Multi-tool workspace | Claude Code, Qwen Code, Codex, ZCode, and OpenClaw with unified access, history, and governance |
| 🖥️ Remote execution | Remote Agent runs AI CLIs on development servers, staging boxes, or GPU machines |
| 🔄 Autonomous dev loop | Move from GitHub issues to plans, implementation, PRs, comments, and human intervention in one traceable workflow |
| 📊 Governance observability | Analyze tokens, cost, quotas, anomalies, audits, compliance, and ROI together |
| 🔌 Enterprise integration | OIDC/OAuth2/SAML 2.0 SSO, Feishu/DingTalk org sync, Feishu/DingTalk alert bots, Kubernetes, reverse proxy, and multi-tenant permissions |
| 🆓 Open collaboration | Apache 2.0, roadmap, contributor guide, and good first issues are ready |
🚀 Quick Start in 5 Minutes
Option 1: One-click Deploy (Recommended)
# Clone the project
git clone https://github.com/open-ace/open-ace.git
cd open-ace
# Build and start
docker compose up -d --build
# Visit http://localhost:19888 (AI + ace mnemonic port)
💡 For production deployment, see Deployment Guide
Option 2: From Source
# 1. Clone the project
git clone https://github.com/open-ace/open-ace.git
cd open-ace
# 2. Install backend dependencies
pip install -r requirements.txt
# 3. Install frontend dependencies and build
cd frontend && npm install && npm run build && cd ..
# 4. Initialize configuration and database
python3 cli.py config init
alembic upgrade head
python3 scripts/init_db.py
# 5. Start the server
python3 server.py
# Visit http://localhost:19888 (AI + ace mnemonic port)
Default Credentials
| Role | Username | Password |
|---|---|---|
| Admin | admin | admin123 |
⚠️ The default account is only for the first local startup. For production, explicitly set
SECRET_KEY,OPENACE_ENCRYPTION_KEY, andUPLOAD_AUTH_KEY, change the default password, and follow the Deployment Guide.
📖 Feature Details
📊 Analytics
| Feature | Description |
|---|---|
| Trend Analysis | View token usage trends by day/week/month |
| Comparison | Compare usage across time periods and tools |
| Heatmap | Visualize peak usage hours |
| Cost Analysis | Convert token consumption to costs |
💬 Message Tracking
| Feature | Description |
|---|---|
| Conversation History | View complete conversation records |
| Message Search | Filter by keyword, user, time |
| Session Export | Export conversations for audit |
| Timeline View | Visualize conversation flow |
🖥️ Remote Workspace
| Feature | Description |
|---|---|
| Remote Agent | Run AI CLI daemons on Linux/macOS/Windows remote machines |
| CLI Adapters | Start, resume, and control permission modes for Claude Code, Qwen Code, Codex, ZCode, and OpenClaw |
| Browser Terminal | Access remote shells through WebSocket with PTY on Linux/macOS, a piped subprocess on Windows, and screen recovery after disconnects |
| VSCode/code-server | Proxy remote code-server/VSCode paths so users can continue development in the browser |
| API Key Proxy | Keep real keys on the server and let remote sessions call models through short-lived, revocable proxy tokens |
🔄 Autonomous Development
| Feature | Description |
|---|---|
| GitHub Issue Parsing | Accept issue numbers, ranges, and URLs to create one or many autonomous tasks |
| Workflow Orchestration | Visualize queued, planning, implementation, PR, comment, and merge stages |
| Human-in-the-loop Control | Pause, resume, inject feedback, or fork a workflow from intermediate milestones |
| GitHub Operations | Use bot-account tokens for issue, PR, and comment automation |
🔔 Alert Center
| Feature | Description |
|---|---|
| Quota Alerts | Automatic notifications when thresholds reached |
| Anomaly Detection | Identify unusual usage patterns |
| Email Reports | Periodic usage reports via email |
| Webhook / Bot Push | Real-time alerts to webhooks, including Feishu / Lark and DingTalk group bots |
👥 User Management
| Feature | Description |
|---|---|
| Multi-tenant | Department/team isolation |
| Role Permissions | Admin/user role distinction |
| SSO Integration | Enterprise single sign-on via OIDC/OAuth2 and SAML 2.0 |
| Feishu Sync | Manual and optionally scheduled Feishu organization sync |
| DingTalk Sync | Manual and optionally scheduled DingTalk organization sync, plus DingTalk user/group name resolution during OpenClaw import |
📋 Compliance and Reporting
| Feature | Description |
|---|---|
| Audit Logs | Track users, sessions, tools, and key administration actions |
| Compliance Checks | Cover data retention, quota usage, sensitive content, and access control |
| Report Generation | Generate governance reports with JSON/CSV export paths |
| Risk Recommendations | Turn report results into practical follow-up actions |
🛠️ Tech Stack
Backend
- Python 3.10+
- Flask — Web Framework
- SQLAlchemy — ORM
- PostgreSQL / SQLite — Database
- Alembic — Migrations
Frontend
- React 18 — UI Framework
- TypeScript — Type Safety
- Vite — Build Tool
- Bootstrap 5 — UI Components
- Chart.js — Visualization
📁 Project Structure
open-ace/
├── server.py # Web server entry
├── cli.py # CLI tool entry
├── app/ # Backend application
│ ├── routes/ # API routes
│ ├── services/ # Business logic
│ ├── modules/ # Domain modules: workspace, compliance, and more
│ ├── models/ # Data models
│ └── repositories/ # Data access
├── frontend/ # Frontend application
│ ├── src/ # Source code
│ ├── e2e/ # Playwright end-to-end tests
│ └── package.json # Dependencies
├── remote-agent/ # Remote Workspace agent and CLI adapters
├── k8s/ # Kubernetes manifests
├── migrations/ # Alembic database migrations
├── schema/ # Database schema helpers
├── scripts/ # Core scripts and operational helpers
│ ├── fetch_*.py # Data collection
│ ├── cron/ # Scheduled task scripts
│ ├── systemd/ # systemd service/timer examples
│ └── shared/ # Shared modules
├── static/ # Runtime static assets and frontend build output
├── docs/ # Documentation
└── tests/ # Tests
📚 Documentation
The docs/ directory is the source of truth for product documentation. The published Docusaurus docs site is built and deployed from the separate open-ace/open-ace-docs repository.
- Docs site: https://open-ace.github.io/open-ace-docs/docs/intro
- Docs source repository: https://github.com/open-ace/open-ace-docs
- The legacy
https://open-ace.github.io/open-ace/entry redirects to the current docs site to avoid stale content
| Document | Description |
|---|---|
| Architecture | System architecture and concepts |
| Deployment | Local and production deployment |
| Development | Contributing guide |
| Remote Workspace | Remote machines, Agent, API Key proxy, and security design |
| Remote Agent | Agent install, CLI adapters, terminal, and session sync |
| Permission Model | Tenants, roles, and access control |
| Kubernetes | K8s deployment reference with multi-replica sticky-session boundaries |
| Feishu Config | Feishu integration |
| DingTalk Config | DingTalk integration |
| API Reference | API documentation |
| Repository Setup | GitHub topics, labels, branch protection, and release checklist |
🤝 Contributing
We welcome all forms of contribution!
- 🐛 Found a bug? Submit an Issue
- 💡 Have an idea? Join the discussion
- 🗺️ Want to see what's next? Read the Roadmap
- 🔧 Want to contribute code? Read the Contributing Guide
- 🌱 First contribution? Start with
good first issueorhelp wanted
Good places to help include Remote Workspace UX, CLI adapters, deployment scripts, documentation translation, frontend usability, test coverage, and enterprise integrations.
📄 License
This project is licensed under the Apache 2.0 License.
Comments (0)
Sign in to join the discussion.
No comments yet
Be the first to share your take.