内容
# 快速入门
从存储库的检出副本中,安装依赖项并启动CloudAgent Console:
```bash
npm install
npm start
```
# CloudAgent Console
CloudAgent Console是一个开源的桌面控制台,用于组织云环境和运行针对云环境的AI代理。

它将工作负载文档、图表、仪表板、技能、MCP、治理和多代理执行带到一个本地工作区,支持原生CloudAgent运行器、**Codex CLI**、**Cursor Agent**和**Claude Code**。
CloudAgent Console仍处于早期阶段。欢迎为新云提供商、数据源、扫描器集成、代理运行时、工作流、文档和平台改进做出贡献。
## 为什么有这个项目?
AI代理的实用性取决于它们所拥有的上下文。没有共享的云上下文,每次会话都从头开始:架构笔记需要手动粘贴,资源需要重复发现,重要的关系、成本信号、健康问题或合规状态仍然可能被遗漏。
CloudAgent Console使该上下文可用。它发现账户和工作负载,映射资源关系,生成图表,并将成本、健康、威胁、合规、扫描器和代理运行数据收集到一个持久的本地工作区。
## 设计原则
- **本地运行:** 控制台、工作区、MCP服务器和可选的代理CLI都在您的机器上运行。
- **您的密钥,您的提供商:** 模型推理使用您的API密钥,云发现使用您现有的云凭证。
- **受限访问:** 代理根据需要访问批准的上下文,具有范围权限和运行历史。
- **代理无关:** 使用CloudAgent、Codex CLI、Claude Code、Cursor Agent或任何MCP兼容的客户端。
## 用例
<table>
<tr>
<td width="25%">
<img src="docs/assets/workload-diagram.png" alt="Workload Diagram Example" width="100%" />
<br />
<strong>工作负载图表</strong>
</td>
<td width="25%">
<img src="docs/assets/cost-dashboard.png" alt="Cost Dashboard" width="100%" />
<br />
<strong>仪表板和洞察</strong>
</td>
<td width="25%">
<img src="docs/assets/command-center.png" alt="Command Center" width="100%" />
<br />
<strong>指挥中心</strong>
</td>
<td width="25%">
<img src="docs/assets/agent-codex-example.png" alt="Agent Running Example" width="100%" />
<br />
<strong>代理运行和历史</strong>
</td>
</tr>
</table>
使用CloudAgent Console,您可以:
- **记录云工作负载:** 发现账户和工作负载,维护架构上下文,生成图表,并将操作笔记保存在靠近云资源的附近。
- **为代理集中云数据:** 在一个本地工作区中收集成本、健康、威胁、库存、扫描器、工作负载、图表和代理运行工件。
- **通过桌面UI运行和跟踪代理:** 创建CloudAgent技能,使用AI完善它们,使用支持的代理运行它们,在运行时比较结果,并查看运行历史和工件。
- **将CloudAgent Console用作MCP上下文服务器:** 通过本地MCP服务器公开批准的工作负载、环境和云数据,以便兼容的代理和工具可以访问结构化的云上下文。
- **调查云信号:** 使用收集的成本、健康、威胁、库存和扫描器数据支持云分析和操作工作流。
- **构建可重复的云操作:** 创建可以演变成可重复的云操作和代理辅助运行手册的技能和工作流。
- **应用治理和安全控制:** 在代理辅助云操作周围组织访问控制、批准工作流、审计日志、防护栏和策略强制执行。
## 支持的云环境
当前支持:
- AWS
计划支持:
- Azure
- Google Cloud
- GitHub
- GitLab
## 支持的代理运行时
CloudAgent Console包括原生CloudAgent运行器,并且可以在安装和配置后将技能运行委派给支持的本地编码代理CLI。
支持的运行时:
- CloudAgent原生运行器,支持OpenAI和OpenAI代理SDK。
- Codex CLI。
- Cursor Agent。
- Claude Code。
单独安装可选的代理CLI,然后在**首选项**中设置它们的路径。CloudAgent Console可以在不安装每个可选运行时时运行;不可用的工具将不会被使用。
## 工作原理
CloudAgent Console可以以两种主要方式使用。
### 使用桌面控制台
您可以使用桌面应用程序作为主要操作界面。
从UI中,您可以配置云环境,发现账户和工作负载,查看仪表板和洞察,记录架构上下文,管理图表和笔记,创建和运行CloudAgent技能,配置代理运行时,并检查代理运行的工件。
### 使用本地MCP服务器
您还可以使用CloudAgent Console作为本地MCP上下文服务器。
在此模式下,系统上运行的兼容代理和工具可以使用MCP服务器以结构化方式访问批准的云环境数据。这允许外部代理检索工作负载上下文、环境元数据、文档、图表、扫描器输出和其他云工件,而无需每个代理独立重新发现或重建该上下文。
桌面控制台和MCP服务器都使用同一个本地工作区,因此云上下文可以组织一次,并在UI、CloudAgent技能和兼容的本地代理工具之间重用。
## 本地数据工作区
CloudAgent Console在本地工作区中存储首选项、云上下文、工作负载文档、图表、扫描器输出和代理运行工件。
可选集成可以扩展上下文的来源和使用的代理运行时,但核心控制台设计为从本地桌面环境运行。
## 路线图
计划工作领域包括:
- 云操作和代理辅助运行手册的可重复工作流。
- 更广泛的Azure和Google Cloud支持。
- GitHub和GitLab上下文集成。
- 更多扫描器、库存、成本、健康、威胁和合规数据源。
- 更灵活的MCP和代理运行时附件点。
- 用于公共桌面下载的强化包装安装程序流程。
## 桌面开发目标
CloudAgent Console当前支持在以下平台上进行源代码开发:
- macOS
- Windows
打包配置目前针对macOS和Windows。Linux打包不是当前的目标。
## 要求
从源代码运行CloudAgent Console所需:
- **OpenAI API密钥**,用于CloudAgent、技能生成和AI辅助分析。
- **Node.js `20.19.0`或更新版本**和npm。
- **AWS环境**,如果您想启用账户发现、扫描、工作负载文档和云洞察,请进行注册。
- **AWS CLI**已安装并配置,如果您想使用AWS发现和相关的云操作。
## 安装和入门
### 从源代码安装
CloudAgent Console尚未提供强化公共桌面安装程序。目前,请从检出的源代码仓库运行它。
对于检出的存储库副本,从存储库根目录运行本地设置脚本:
```bash
npm run setup:local
```
设置脚本安装npm依赖项,构建桌面UI,并启动本地Electron应用程序。它是一个源代码检出引导脚本,而不是最终的可下载桌面安装程序。
要安装依赖项而不启动应用程序:
```bash
npm run setup:local -- --no-launch
```
要在不重新安装依赖项的情况下启动应用程序:
```bash
npm run setup:local -- --skip-install
```
设置完成后,您也可以直接使用以下命令启动已构建的本地应用程序:
```bash
npm start
```
### 首次运行设置
1. 打开**首选项**。
2. 添加您的OpenAI提供商密钥和模型。
3. 确认本地数据目录。
4. 启用或禁用本地MCP服务器。
5. 为AWS CLI、Codex CLI、Cursor Agent和Claude Code配置可选CLI路径。
6. 打开**云设置**并添加AWS环境。
7. 运行账户发现以清点账户和发现工作负载。
CloudAgent Console本地保存这些设置。环境变量是开发人员覆盖项,不需要设置。
### 注册AWS账户
1. 确认您的AWS CLI配置文件在CloudAgent Console之外有效。
2. 打开**云设置**。
3. 添加AWS账户或组织详细信息。
4. 运行发现。
5. 在**工作负载**下查看已发现的账户和工作负载。
## 如何贡献
有用的贡献包括:
- 具有清晰重现步骤的错误报告。
- 改进设置、云注册、MCP、技能、仪表板和工作流的文档。
- 新的云提供商、开发人员平台、数据源、扫描器集成或代理运行时集成。
- 关注一个功能或修复的拉取请求。
在打开拉取请求之前,请运行相关本地检查:
```bash
npm --workspace @cloudagent/desktop-ui run build
```
## 项目文档
- [变更日志](CHANGELOG.md)
- [桌面应用程序架构和打包](cloudagent-desktop/README.md)
- [MCP服务器和工具](core/mcp/README.md)
- [技能:构建、创建和管理技能](core/skills/README.md)
- [管理和云环境和工作负载](core/workloads/README.md)
- [仪表板和洞察:成本、健康和威胁](cloudagent-desktop/apps/ui/README.md)
- [扫描器和数据收集](core/scanners/README.md)
- [支持的代理运行时](core/agent-runtime/README.md)
- [CloudAgent编排](core/cloudagent/README.md)
- [工作流](core/workflows/README.md)