我正在重写这个项目，它的 v2 版本将是一个通用的 GitHub 作为 MCP 托管平台的项目。如果你对它目前的功能感兴趣，请 fork 这个仓库并自行维护。感谢你的关注！

Dewhale

Dewhale 是一个基于 GitHub 的 AI 工具，旨在让开发工作更加轻松高效。

中文文档

如果你在寻找 vx.dev，请查看我们的品牌重塑讨论。

快速开始

有关如何设置和使用 Dewhale 的详细说明，请参阅我们的指南。

借助我们的配额管理功能，我们允许给项目加星标的人士进行 3 次试用。

你也可以观看这个演示视频。

更多示例可以在议题列表中找到。

功能特性

更低的使用成本

Dewhale 在 GPT-4 模型的基础上运用提示工程技巧来发出指令。主要的成本取决于输入和完成的 token 数量。我们当前的提示模板位于 prompts/ui-gen.md，其中包含了针对 shadcn/ui、lucide 和 nivo charts 的指导说明。

如果你不需要某些组件（例如图表），可以通过从提示模板中移除相关指令来降低每次生成的 API 费用。

此外，你还可以切换到其他 AI 模型以进一步降低使用成本。

易于定制

由于 Dewhale 的提示模板是开源的，你可以参考现有的模板，并根据自己的需求替换为其他 UI 组件库或编码风格。

你也可以完全自定义整个工作流程，比如构建一个类似 v0.dev 的 Web 应用程序，仅将 Dewhale 的提示模板作为核心部分。

无缝集成 GitHub

生成的代码会存储在 GitHub 上，天然具备版本控制、代码审查和协作功能。

此外，你还可以使用私有仓库，使代码生成结果仅对协作者可见。

工作原理

要了解 Dewhale 的底层架构和工作原理，请参阅我们详细的架构概述。

加入讨论

如果你喜欢 Dewhale 的设计理念，欢迎加入我们的Github 讨论区。

Dewhale 快速上手指南

重要提示：本项目作者正在重写 Dewhale，v2 版本将转型为通用的 "GitHub as a MCP Host" 项目。如果您需要使用当前版本的功能（基于 GitHub 的 AI 开发工具），请自行 Fork 该仓库并进行维护。

Dewhale 是一款利用 GitHub 作为后端存储和协作平台的 AI 开发工具，能够根据自然语言指令生成前端代码（支持 shadcn/ui, Lucide, Nivo Charts 等）。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (WSL 推荐)
• Node.js：建议安装 LTS 版本 (v18+)
• Git：已安装并配置好 SSH 密钥
• GitHub 账号：用于存储生成的代码和管理权限
• AI API Key：需要拥有 OpenAI API Key (或其他兼容模型 Key)，因为 Dewhale 核心依赖 LLM 进行代码生成。

安装步骤

由于项目处于重构过渡期，官方不再提供直接的 npm 全局安装包，推荐通过源码部署：

1. 克隆仓库

   git clone https://github.com/Yuyz0112/dewhale.git
   cd dewhale
   

2. 安装依赖

   npm install
   # 或者使用 yarn / pnpm
   # yarn install
   # pnpm install
   

3. 配置环境变量 在项目根目录创建 .env 文件，填入必要的配置信息：

   cp .env.example .env
   

   编辑 .env 文件，设置以下内容：

   # OpenAI API Key (或兼容模型的 Key)
   OPENAI_API_KEY=your_api_key_here
   
   # GitHub Personal Access Token (需具备 repo 权限)
   GITHUB_TOKEN=your_github_token_here
   
   # 其他可选配置 (如模型名称)
   MODEL_NAME=gpt-4-turbo-preview
   

4. 启动服务

   npm run dev
   

   启动成功后，终端通常会显示本地访问地址（例如 http://localhost:3000）。

基本使用

Dewhale 的核心工作流是通过自然语言描述需求，自动生成代码并提交到 GitHub 仓库。

1. 访问界面 在浏览器中打开启动时显示的本地地址。

2. 授权 GitHub 首次使用时，系统会引导您授权访问 GitHub 账户，以便创建和管理代码仓库。您可以选择创建公开或私有仓库。

3. 生成代码 在输入框中输入您的需求描述。例如：

   "Create a dashboard with a sidebar, a header, and a line chart showing monthly sales data using shadcn/ui and nivo."

4. 查看结果

   • Dewhale 会调用 AI 模型生成代码。
   • 生成的代码会自动提交到您授权的 GitHub 仓库中。
   • 您可以在界面上预览生成的 UI，或直接前往 GitHub 仓库查看源代码、进行 Code Review 和协作开发。

5. 降低成本与定制 (进阶)

   • 修改 Prompt：编辑 prompts/ui-gen.md 文件，移除不需要的组件库指令（如不需要图表可删除 nivo 相关说明），以减少 Token 消耗。
   • 切换模型：在 .env 中更改 MODEL_NAME 以使用成本更低的模型。

---

更多详细架构说明请参考项目文档 docs/architecture.md，示例代码可查阅仓库的 Issues 列表。