PearAI 主仓库

PearAI 致力于成为一个精选前沿 AI 工具的集合平台。我们的统一界面（unified interface）无缝整合这些解决方案，让用户无需费力寻找替代工具即可轻松切换。

您在此看到的是构成完整 PearAI 项目的全部仓库集合。这仅仅是开始，工具列表将持续扩展。详情请访问各子仓库：

• pearai-app：这是 PearAI 的 VSCode 分支，也是项目的外层目录，包含编辑器主要功能
• pearai-submodule：这是 PearAI 的 Continue 分支，作为 pearai-app 的子模块，包含 AI 聊天核心功能
• pear-landing-page：这是 PearAI 的落地页
• pearai-documentation：这是 PearAI 的文档页面，与落地页相互关联
• pearai-server：这是 PearAI 的服务器组件（半私有状态以确保安全）。使用 PearAI 服务器是可选的，主要为不愿使用自有 API 密钥的用户提供便利
• pearai-server-issues-public：这是 PearAI 服务器的公开问题跟踪仓库

贡献指南

我们欢迎社区贡献！无论是修复漏洞、改进文档还是添加新功能，我们都非常感谢您对提升 PearAI 所做的帮助。由于项目涉及内容较多，初次参与可能会感到复杂。以下是关键信息摘要和协作方式说明：

• 我们有大量开放问题（详见各仓库的 issues 标签页），欢迎认领。请先留言表明您正在处理该问题（同时查看是否有他人已留言）
• 随时提交 PR，我们通常会快速审核
• 如果您发现 PearAI 有任何可改进之处，请随时告知！
• 由于开发任务繁重，我们可能遗漏某些问题。最有效的提醒方式是在我们的 Discord 服务器中直接 @我们

[!IMPORTANT] 修改我们维护的更新分支（pearai-app 和 pearai-roo-code）时，请注意拉取上游更新时可能引入的潜在问题

🛠 系统要求

请确保已安装以下工具：

• 🦀 Rust/Cargo
• 🐙 Git
• 🌐 Node.JS，x64 架构，版本 =20.18.0（其他版本未测试）- 推荐使用 Node 版本管理器 (nvm)
• 📦 Npm，版本 =10.8.2（其他版本未测试）
• 📦 Yarn 1，版本 >=1.10.1 且 <2
• 🐍 Python，版本 =3.11.X（node-gyp 依赖）- 推荐使用 pyvenv
• ⚙️ 平台对应的 C/C++ 编译器工具链：
  • Windows：通过 Visual Studio 安装程序安装 Windows 构建工具，包含以下组件：
    • 使用 C++ 的桌面开发（工作负载）
    • C++ MFC for v143 构建工具（含 Spectre 缓解措施）
    • MSVC v143 - VS 2022 C++ x64/x86 Spectre 缓解库
  • macOS：安装 Xcode 及命令行工具 xcode-select --install
  • Linux：按说明安装必要的开发工具

安装步骤

要开始 PearAI 开发，请克隆本仓库（pearai-master）并安装各组件依赖：

1. PearAI 应用：

cd ./pearai-app && npm i

2. PearAI Roo Code：

cd ./pearai-roo-code && npm run install:all

3. PearAI 子模块：

./pearai-submodule/install-and-build.sh  # Unix/Mac 系统
./pearai-submodule/install-and-build.ps1 # Windows 系统

开发流程

启动开发流程：

1. 启动开发服务器：

   • 在 PearAI（或 VSCode）中打开运行和调试界面
   • 选择并运行 "🚀 Start All Dev Servers" 任务

2. 启动 PearAI 实例：

./pearai-app/scripts/code.sh  # Unix/Mac 系统
./pearai-app/scripts/code.ps1 # Windows 系统

[!NOTE] React 前端（Roo Code 前端、创建者覆盖层和聊天面板）已启用热模块重载（HMR） 其他组件的修改需要通过 code 脚本重启 VSCode 实例

技术栈

• PearAI 主体：TypeScript/Electron.js
• PearAI 落地页：Next.js/React 框架，使用 Supabase 认证（TailwindCSS + Shadcn）
• PearAI 后端：Python FastAPI 服务器，搭配 Supabase 数据库
• 日志/遥测：Axiom 和 PostHog

联系方式

如有任何问题或需要帮助，欢迎提交 issue，或通过以下方式联系我们：

• PearAI Discord
• 邮箱：team@trypear.ai

常见问题解答

请访问我们的 FAQ 页面 获取更多信息

PearAI 快速上手指南

环境准备

系统要求

• 操作系统：Windows/macOS/Linux
• 硬件配置：建议8GB内存以上

前置依赖

请安装以下工具（国内用户建议使用镜像加速安装）：

• 🦀 Rust/Cargo
• 🐙 Git
• 🌐 Node.js x64 20.18.0（推荐使用nvm管理）
• 📦 Npm 10.8.2
• 📦 Yarn 1 >=1.10.1 and <2
• 🐍 Python 3.11.X（推荐使用pyvenv）
• ⚙️ C/C++编译工具链：
  • Windows：安装Visual Studio 2022 C++开发组件
  • macOS：xcode-select --install
  • Linux：安装系统开发工具包

安装步骤

# 克隆主仓库
git clone https://github.com/trypear/pearai-master.git
cd pearai-master

# 安装各模块依赖
# 1. PearAI App
cd ./pearai-app && npm i

# 2. PearAI Roo Code
cd ../pearai-roo-code && npm run install:all

# 3. PearAI Submodule（根据系统选择命令）
cd ../pearai-submodule
./install-and-build.sh  # Unix/Mac
# 或
./install-and-build.ps1 # Windows

基本使用

# 启动开发服务器（通过VSCode调试面板运行）
# 选择并执行 "🚀 Start All Dev Servers" 任务

# 启动PearAI实例
cd ../pearai-app
./scripts/code.sh  # Unix/Mac
# 或
./scripts/code.ps1 # Windows

📌 热更新说明：React前端组件支持HMR热更新（Roo Code前端、对话面板等），非前端组件修改需重启VSCode实例。