sunpeak.ai

✨ Sunpeak.ai：快速发布你的 ChatGPT 应用

Sunpeak.ai 是一个专为 ChatGPT 应用量身打造的开发框架，旨在于帮助开发者快速启动项目，并在本地构建、测试及发布他们的应用。它完全免费且开源，采用 MIT 许可证，方便用户查看和自定义源码。

---

💡 核心功能亮点

• 本地开发模拟器： 🚀 提供 ChatGPT 模拟器，用于本地 UI 组件开发，让您在部署前就能看到效果。
• 预构建组件库： 🎨 基于 OpenAI 的 apps-sdk-ui 构建，提供生产就绪的 UI 组件，遵循 ChatGPT 设计指南。
• 跨平台UI开发： 💻 支持跨平台的 MCP UI 应用开发接口。
• 内置MCP服务器： 📡 提供基础 MCP 服务器，开箱即用，可将您的 UI 提供给真实的 ChatGPT。
• 高级测试框架： ✅ replicates advanced ChatGPT behavior locally.
• 丰富的 React Hooks： 🔗 提供 14+ 通用 React hooks，用于与 ChatGPT 运行时交互，包括访问 widget API、主题检测、显示模式和状态管理。

---

🚀 如何开始？

创建一个新的 Sunpeak 项目非常简单！

1. 使用 CLI 命令 pnpm dlx sunpeak new 创建一个新项目，它会为您搭建完整的项目结构，包含所有必要的依赖、构建工具和测试基础设施。
2. 对于现有 React 项目，您也可以通过 npm 或其他您喜欢的包管理器安装 Sunpeak 作为依赖。

---

❓ 常见问题解答

什么是 MCP 服务器？

MCP（Model Context Protocol）服务器负责在 ChatGPT 请求时，向您的应用提供内容。它使得工具、资源和提示可以被 ChatGPT 使用。Sunpeak 包含一个内置的 MCP 服务器，您可以使用 sunpeak mcp 命令在本地运行，并配合模拟数据进行测试和开发。

我可以在本地测试应用吗？

当然可以！ Sunpeak 提供了一个 ChatGPT 模拟器（一个 React 组件），它能复刻 ChatGPT 的环境，让您在部署之前就能在本地充分测试您的应用。您还可以结合内置的 MCP 服务器和模拟数据，在真实的 ChatGPT 环境中测试您的本地应用。

如何部署我的应用？

使用 sunpeak build 命令可以创建生产就绪的应用 bundles。构建过程针对 ChatGPT 部署进行了优化，包含所有必要的优化和配置。只需将为每个 Resource 创建的单个文件放入您的生产 MCP 服务器，即可完成部署！

是否包含测试支持？

是的！ Sunpeak 通过 Vitest 提供了内置的测试支持。您可以使用 sunpeak test 命令运行测试。框架提供了测试工具和示例，帮助您为 ChatGPT 应用编写全面的测试。

ChatGPT Apps 和 MCP Apps 有什么区别？

ChatGPT Apps 是用户面向的应用，而 MCP（Model Context Protocol）是底层的协议。您的 ChatGPT 应用 UI 实际上就是 MCP Resources，ChatGPT 可以与之交互。MCP Apps 是一种通用 UI 运行时协议，目前处于早期活跃开发阶段。

哪里可以找到文档？

完整的 Sunpeak 文档可在 docs.sunpeak.ai 获取。它包含了快速入门指南、API 参考、集成说明和部署指南，帮助您构建您的 ChatGPT 应用。

Sunpeak 是开源的吗？

是的！ Sunpeak 是开源的，并在 GitHub 上提供：github.com/sunpeak-AI/sunpeak。您也可以在 npm 上找到该软件包：npmjs.com/package/sunpeak。

有哪些 CLI 命令？

Sunpeak 提供了几个 CLI 命令：

• sunpeak new：用于创建项目。
• sunpeak dev：用于运行开发服务器。
• sunpeak build：用于生产构建。
• sunpeak mcp：用于运行 MCP 服务器。
• sunpeak test：用于单元测试。

---

📚 更多信息

查看我们全面的文档或联系我们的支持团队以获取更多帮助！