项目简介

SentryVibe是一个创新性的AI平台，旨在简化Web项目的开发流程。它允许用户通过自然语言描述来生成完整的、可运行的Web应用程序，并在本地环境中提供实时预览和管理功能。该平台集成了Model Context Protocol (MCP)，使其能够以标准化的方式与大型语言模型（LLM）进行交互，利用其智能生成代码、执行命令和管理项目资源。

主要功能点

• AI驱动的项目生成: 利用Claude AI和OpenAI Codex，根据用户提示自动生成React、Next.js、Astro等框架的Web项目。
• 实时构建流与可视化: 实时展示AI的思考过程、工具调用（如Shell命令、文件操作）和待办事项列表，提供透明的构建体验。
• 开发服务器与隧道管理: 自动管理本地开发服务器，检测端口，并支持通过Cloudflare隧道创建即时预览链接，方便远程访问和协作。
• MCP集成: 核心Runner组件集成了Model Context Protocol，作为AI的后端上下文服务，负责资源管理（文件读写）、工具执行（Shell命令、dev server控制）和Prompt模板渲染。
• 项目管理面板: 提供一个用户友好的界面，用于创建、浏览、编辑和删除项目，以及查看代码文件。
• TUI仪表板: 命令行界面提供美观的终端用户界面（TUI），实时监控服务状态、查看日志和管理隧道。
• 多代理支持: 可选择使用Claude Code或OpenAI Codex作为项目生成代理。

安装步骤

SentryVibe提供了一个便捷的CLI工具，用于安装和管理整个平台。

1. 安装CLI工具: 打开终端并运行以下命令：

   curl -fsSL https://raw.githubusercontent.com/codyde/sentryvibe/main/install-cli.sh | bash
   

   此脚本将自动检测您的系统环境，并安装SentryVibe CLI工具及其依赖。

2. 初始化SentryVibe: CLI安装完成后，您需要初始化平台配置并构建所有服务。

   • 交互式设置 (推荐首次使用):

     sentryvibe init
     

     这将引导您完成工作区路径、Broker URL、API URL、共享密钥和Runner ID的配置，并询问是否预构建所有服务以获得最佳性能。
   • 非交互式设置 (使用默认值):

     sentryvibe init -y
     

     此命令将使用推荐的默认设置快速完成初始化和构建。

3. 启动SentryVibe (完整堆栈): 初始化完成后，您可以启动Web应用程序、Broker服务和Runner。

   sentryvibe run
   

   这将在生产模式下启动所有服务，并提供一个实时的TUI仪表板。

   • 如果需要开发模式（支持热重载），可以运行 'sentryvibe run --dev'。

4. 访问Web界面: SentryVibe启动后，打开浏览器访问：'http://localhost:3000' 即可开始使用。

服务器配置 (MCP客户端使用)

SentryVibe的Runner组件作为MCP服务器的核心，通过WebSocket协议与Broker通信，并间接接收LLM客户端（SentryVibe Web应用）的命令。MCP客户端（如SentryVibe Web应用内部的LLM代理）需要配置与SentryVibe Runner/Broker建立连接。

以下是MCP客户端配置SentryVibe服务的关键信息：

• MCP服务器名称: 'SentryVibe Runner'
• 协议: 'WebSocket'
• Endpoint URL: 'ws://localhost:4000/socket' (默认本地模式)
  • 此URL指向SentryVibe的Broker服务，Broker负责将命令路由到正确的Runner实例。
  • 如果部署在远程，URL会是 'wss://<your-broker-domain>/socket'。
• 身份验证: 'Bearer Token'
  • 'Token': 在初始化SentryVibe ('sentryvibe init') 时配置的 '共享密钥 (shared secret)'。默认本地模式为 'dev-secret'。
  • MCP客户端需要在WebSocket连接请求的 'Authorization' 头部中包含 'Bearer <shared-secret>'。
• Runner ID (可选): 'local' (默认本地模式)
  • MCP客户端可以通过URL参数 'runnerId=<id>' 来指定目标Runner。
  • 例如：'ws://localhost:4000/socket?runnerId=my-laptop'

MCP客户端实际配置说明: MCP客户端通常不需要手动输入JSON格式的代码，而是通过配置项（如环境变量、配置文件或API参数）来指定这些信息。例如：

• MCP服务器地址配置项: 'SENTRYVIBE_BROKER_URL'，用于设置WebSocket连接的URL，例如 'ws://localhost:4000/socket'。
• 共享密钥配置项: 'SENTRYVIBE_SHARED_SECRET'，用于提供认证所需的Bearer Token，例如 'your-secure-secret'。
• Runner ID配置项: 'SENTRYVIBE_RUNNER_ID'，可选，用于指定与哪个Runner实例进行通信，例如 'local'。

这些配置使得MCP客户端能够构建正确的WebSocket请求，并连接到SentryVibe Broker，进而与Runner进行通信，利用Runner提供的文件系统、进程管理和网络隧道等功能。

基本使用方法

1. 启动服务: 运行 'sentryvibe run' 启动所有SentryVibe组件。
2. 创建新项目: 在Web界面中，输入您想要创建的Web项目描述（例如：“创建一个带TypeScript和Tailwind的React待办事项应用”）。
3. 实时预览: AI将开始生成项目代码并执行构建命令。您可以在Web界面实时查看AI的思考过程、文件更改和构建日志。一旦开发服务器启动，您将获得一个本地或通过Cloudflare隧道访问的实时预览URL。
4. 迭代与修改: 通过后续的提示，您可以继续修改和完善生成的项目。