YakGPT

一个简单、可在本地运行的 ChatGPT 用户界面，让文本生成更快，聊天体验更有趣！

功能特性

• 通过 OpenAI API 支持 GPT 3.5 和 GPT 4
• 通过 Azure 和 OpenAI Whisper 实现 语音转文本
• 通过 Azure 和 Eleven Labs 实现 文本转语音
• 在浏览器中本地运行，无需安装任何应用程序
• 比官方 UI 更快——直接连接到 API
• 轻松集成麦克风，无需再手动输入！
• 使用您自己的 API 密钥——确保数据隐私与安全
• 通过 API 提交的数据不会用于训练，且仅存储 30 天
• 所有状态均本地存储在 localStorage 中——无分析或外部服务调用
• 可访问 https://yakgpt.vercel.app，也可在本地运行！

注意：使用 GPT-4 需要获得 API 访问权限。GPT 3.5 对所有用户开放。

截图

移动端	语音模式	浅色主题	深色主题

🚀 快速开始

访问 YakGPT，无需安装即可试用；或者按照以下步骤在本地运行：

前提条件

要在您的计算机上本地运行 YakGPT，需要安装以下工具：

• Git
• Yarn（或 npm 或 pnpm）
• 任何现代 Web 浏览器，如 Google Chrome、Mozilla Firefox 或 Microsoft Edge

安装步骤

1. 克隆仓库：

$ git clone https://github.com/yakGPT/YakGPT.git

2. 安装依赖项、构建打包文件并启动服务器：

$ yarn
$ yarn build
$ yarn start

然后访问 http://localhost:3000 即可。

恭喜您！🎉 您现在已经在本地成功运行了 YakGPT。

🔑 API 密钥配置

要使用 YakGPT，您需要获取 OpenAI 的 API 密钥。应用会提示您输入密钥。

添加到 .env.local（⚠️ 仅限本地使用）

如果您希望密钥在每次构建应用时都保留，可以将其添加到 .env.local 文件中：

$ echo "NEXT_PUBLIC_OPENAI_API_KEY=<your-open-ai-key-here>" > .env.local
$ echo "NEXT_PUBLIC_11LABS_API_KEY=<your-eleven-labs-key-here>" >> .env.local

🐳 Docker

要使用 Docker Hub 上的预构建镜像（仅适用于 amd64 架构），请运行：

$ docker run -it -p 3000:3000 yakgpt/yakgpt:latest

---

如果您想自行构建 Docker 镜像（例如在 arm64 架构上），请执行以下命令：

$ docker build -t yakgpt:latest .
$ docker run -it -p 3000:3000 yakgpt:latest

🎤 麦克风集成

YakGPT 的麦克风集成让聊天变得轻而易举！只需通过浏览器权限启用麦克风，YakGPT 就会自动将您的语音转换为文本。

您也可以根据需要点击应用中的麦克风图标来切换麦克风功能。

请确保使用支持的浏览器，并确认麦克风正常工作。

🛡️ 数据隐私与安全

YakGPT 通过允许您使用自己的 API 密钥来确保数据隐私和安全。您与 YakGPT 的对话直接在您的浏览器和 OpenAI 的 GPT-3 API 之间进行，没有任何中间服务器。

📃 许可证

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

🙌 致谢

• OpenAI 构建了如此出色的模型，并且价格非常实惠。
• Mantine UI 是一款全方位优秀的 UI 库。
• opus-media-recorder 对我来说至关重要：我希望能够在行走时进行语音交互。然而，OpenAI 的 Whisper API 无法接受 Safari 浏览器生成的音频，因此我不得不回到使用未压缩的 WAV 格式录音，但这在移动网络环境下速度极慢。opus-media-recorder 通过 Web Worker 技术实现了跨平台的压缩音频录制，彻底解决了我的问题。🤗

如有反馈、问题或想法，请随时提交 Issue！

YakGPT 快速上手指南

YakGPT 是一个简单、本地运行的 ChatGPT UI，支持 GPT-3.5/4 模型，具备语音转文字（STT）和文字转语音（TTS）功能。它直接在浏览器中运行，无需安装额外客户端，且通过直接使用你的 API Key 确保数据隐私。

环境准备

在开始之前，请确保你的计算机已安装以下工具：

• 操作系统：Windows, macOS 或 Linux
• Git：用于克隆代码仓库 (下载地址)
• Node.js 包管理器：推荐安装 Yarn，也可使用 npm 或 pnpm
• 浏览器：任意现代浏览器（如 Google Chrome, Microsoft Edge, Firefox）
• API Keys：
  • OpenAI API Key（必需，支持 GPT-3.5 和 GPT-4）
  • Eleven Labs API Key（可选，用于更高质量的语音合成）

提示：国内开发者若访问 GitHub 或 npm/yarn 源较慢，建议配置国内镜像加速（如使用 npmmirror 替代默认源）。

安装步骤

你可以选择直接访问在线版，或在本地部署以获得完全控制权。

方式一：在线直接使用（无需安装）

直接访问官方部署地址即可体验： https://yakgpt.vercel.app

方式二：本地源码部署

1. 克隆仓库

   git clone https://github.com/yakGPT/YakGPT.git
   cd YakGPT
   

2. 安装依赖并构建

   yarn
   yarn build
   

3. 启动服务

   yarn start
   

4. 访问应用 打开浏览器访问 http://localhost:3000。

方式三：Docker 部署（可选）

如果你偏好使用 Docker，可以直接运行预构建镜像（仅限 amd64 架构）：

docker run -it -p 3000:3000 yakgpt/yakgpt:latest

若是 arm64 架构（如 Apple Silicon Mac），需自行构建：

docker build -t yakgpt:latest .
docker run -it -p 3000:3000 yakgpt:latest

基本使用

1. 配置 API Key

   • 首次打开应用时，界面会提示你输入 OpenAI API Key。
   • 如需使用 Eleven Labs 的语音功能，也可在设置中输入对应的 API Key。
   • 进阶配置：若希望密钥在重新构建后持久化，可在项目根目录创建 .env.local 文件：

     echo "NEXT_PUBLIC_OPENAI_API_KEY=<你的 OpenAI Key>" > .env.local
     echo "NEXT_PUBLIC_11LABS_API_KEY=<你的 Eleven Labs Key>" >> .env.local
     

2. 开始对话

   • 在输入框打字或通过点击麦克风图标启用语音输入。
   • 选择模型（默认为 GPT-3.5，若有权限可选择 GPT-4）。
   • 发送消息后，系统将直接调用 OpenAI API 返回结果。

3. 语音交互

   • 确保浏览器已授予麦克风权限。
   • 点击麦克风图标说话，系统会自动将语音转为文字发送。
   • 回复内容可通过集成的 TTS 功能朗读出来（需配置相应 Key）。

注意：所有对话状态仅存储在你浏览器的 localStorage 中，不会上传到任何第三方分析服务器，数据安全性由你持有的 API Key 保障。