Chef 是唯一一款懂后端的 AI 应用构建工具。它能够基于内置数据库、零配置身份验证、文件上传、实时 UI 和后台工作流，快速构建全栈 Web 应用。如果你想一探驱动 Chef 的“秘密配方”，可以在此处查看或下载系统提示：这里。

Chef 的强大功能得益于其基于 Convex 构建——这是一款开源的响应式数据库，专为简化 Web 应用开发者的工作而设计。Chef 的“神奇”之处就在于它直接使用了 Convex 的 API，而这些 API 非常适合用于代码生成。

Chef 的开发由 Convex 团队主导。我们欢迎 修复 Bug，也十分乐意听取大家的反馈（加入 Discord 社区）。

本项目是 bolt.diy 的 stable 分支的一个分支。

快速入门

请访问我们的 文档 了解更多关于 Chef 的信息，并查看我们的提示指南：这里。

使用 Chef 进行开发最简单的方式是通过我们的托管 Web 应用，该应用提供慷慨的免费套餐。如果你希望在本地运行 Chef，可以按照以下指南操作。

【重要提示】 Chef 按原样提供，采用的是 Convex 内部控制平面专用的身份验证配置，用于管理用户账户。

如果你计划开发一个用于生产环境或再分发的 Chef 分支，那么你的分支需要将现有的身份验证系统替换为你自己的实现。我们建议使用 OAuth 授权码授予流程 来授权访问 Convex 团队或项目。更多关于可用平台 API 的信息，请参阅 这里。

在不作任何修改的情况下，Chef 非常易于本地开发。接下来将介绍如何在本地使用 Chef。

在本地运行

注意：此处将使用托管的 Convex 控制平面来部署 Convex 项目。不过，在此环境中使用的 Chef 令牌不会计入你的 Convex 账户用量。

1. 克隆项目

通过以下命令克隆 GitHub 仓库并进入目录：

git clone https://github.com/get-convex/chef.git
cd chef

2. 配置本地环境

在终端中执行以下命令：

nvm install
nvm use
npm install -g pnpm
pnpm i
echo 'VITE_CONVEX_URL=placeholder' >> .env.local
npx convex dev --once # 按照步骤在你的团队中创建一个 Convex 项目

注意：nvm 仅适用于 Mac 和 Linux 系统。如果你使用 Windows，可能需要寻找替代方案。

3. 设置 Chef OAuth 应用程序

前往 Convex 的 仪表板，创建一个 OAuth 应用程序。你用来创建该应用程序的团队将是你在本地 Chef 上唯一可登录的团队。重定向 URI 并不重要，但你可以将其设置为 http://127.0.0.1:5173（或你运行 Chef UI 的任意端口），以便表单能够提交。

4. 配置 Convex 部署

使用 npx convex dashboard 打开 Convex 的 仪表板，进入“设置 → 环境变量”。然后设置以下环境变量：

BIG_BRAIN_HOST=https://api.convex.dev
CONVEX_OAUTH_CLIENT_ID=<从 OAuth 设置中获取的值>
CONVEX_OAUTH_CLIENT_SECRET=<从 OAuth 设置中获取的值>
WORKOS_CLIENT_ID=<从 .env.development 中获取的值>

5. 添加模型提供商的 API 密钥

在你的 .env.local 文件中添加以下任一 API 密钥，以启用代码生成：

ANTHROPIC_API_KEY=<你的 API 密钥>
GOOGLE_API_KEY=<你的 API 密钥>
OPENAI_API_KEY=<你的 API 密钥>
XAI_API_KEY=<你的 API 密钥>

注意：你也可以通过 Chef 的设置页面添加自己的 API 密钥。

6. 启动 Chef 后端和前端

在终端中执行以下命令：

pnpm run dev

## 在另一个终端
npx convex dev

恭喜！你现在已经在本地成功运行了 Chef！你可以使用现有的 Convex 账户登录 Chef。

注意：Chef 可通过 http://127.0.0.1:{port}/ 访问，而无法正常运行于 http://localhost:{port}/。

仓库结构

• app/ 包含所有客户端代码以及一些无服务器 API。

  • components/ 定义 UI 组件
  • lib/ 包含客户端逻辑，用于同步本地状态与服务器
  • routes/ 定义部分客户端和服务器路由

• chef-agent/ 负责处理代理循环，包括注入系统提示、定义工具以及调用模型提供商。

• chefshot/ 定义了一个用于与 Chef Web 应用交互的 CLI 界面。

• convex/ 包含存储聊天记录和用户元数据的数据库。

• template/ 包含我们用于启动所有 Chef 项目的模板。

• test-kitchen/ 包含用于测试 Chef 代理循环的测试框架。

Chef 快速上手指南

Chef 是一个基于 Convex 的 AI 应用构建工具，支持零配置认证、文件上传、实时 UI 和后台工作流等功能。以下为快速上手指南。

---

环境准备

系统要求

• 操作系统：Mac 或 Linux（Windows 需要使用 WSL 或其他兼容方案）
• Node.js：建议使用 nvm 管理多个版本
• Git：用于克隆项目仓库

前置依赖

确保已安装以下工具：

• Node.js（推荐使用 nvm 安装和管理）
• Git
• pnpm（可通过 npm install -g pnpm 安装）

---

安装步骤

1. 克隆项目

在终端中运行以下命令，将 Chef 项目克隆到本地：

git clone https://github.com/get-convex/chef.git
cd chef

2. 设置本地环境

执行以下命令初始化项目环境：

nvm install
nvm use
npm install -g pnpm
pnpm i
echo 'VITE_CONVEX_URL=placeholder' >> .env.local
npx convex dev --once # 按照提示创建 Convex 项目

注意：nvm 仅适用于 Mac 和 Linux，Windows 用户可考虑使用 WSL 或其他替代方案。

3. 设置 OAuth 应用

访问 Convex 控制台，创建一个 OAuth 应用。此应用将用于本地 Chef 登录。

设置重定向 URI（如 http://127.0.0.1:5173）以便后续使用。

4. 设置 Convex 部署

运行以下命令打开 Convex 控制台：

npx convex dashboard

进入 Settings → Environment Variables，添加以下环境变量：

BIG_BRAIN_HOST=https://api.convex.dev
CONVEX_OAUTH_CLIENT_ID=<OAuth 客户端 ID>
CONVEX_OAUTH_CLIENT_SECRET=<OAuth 客户端密钥>
WORKOS_CLIENT_ID=<来自 .env.development 的值>

5. 添加模型提供商 API 密钥

在 .env.local 文件中添加以下任意模型提供商的 API 密钥以启用代码生成功能：

ANTHROPIC_API_KEY=<你的 API 密钥>
GOOGLE_API_KEY=<你的 API 密钥>
OPENAI_API_KEY=<你的 API 密钥>
XAI_API_KEY=<你的 API 密钥>

你也可以通过 Chef 设置页面添加自己的 API 密钥。

6. 启动 Chef 后端与前端

分别在两个终端窗口中运行以下命令：

pnpm run dev

## 在另一个终端中
npx convex dev

---

基本使用

启动完成后，访问以下地址即可使用 Chef：

http://127.0.0.1:5173

使用你已有的 Convex 账号登录，即可开始构建 AI 应用。

注意：本地运行的 Chef 使用的是 Convex 内部控制平面，不会影响你的 Convex 账户使用额度。

---

通过以上步骤，你可以快速在本地运行 Chef，并开始构建 AI 应用。