Cherry Studio 技术文档

1. 安装指南

系统要求

• 支持操作系统：Windows 10/11、macOS 10.15+、Linux主流发行版
• 硬件配置：建议4GB以上内存，2GHz以上处理器

下载方式

1. 访问GitHub Releases页面获取最新稳定版安装包
2. 根据操作系统选择对应版本：
   • Windows: .exe安装程序
   • macOS: .dmg镜像文件
   • Linux: .AppImage通用包或.deb/.rpm包

2. 项目使用说明

基础功能

1. 多模型支持：

   • 支持OpenAI、Gemini、Anthropic等云端模型
   • 集成Claude、Peplexity等网页服务
   • 本地模型支持Ollama和LM Studio

2. AI助手功能：

   • 内置300+预配置AI助手
   • 支持自定义助手创建
   • 多模型并行对话功能

3. 文档处理：

   • 支持文本、图片、Office、PDF等格式
   • WebDAV文件管理与备份
   • Mermaid图表可视化
   • 代码语法高亮

高级功能

1. 全局搜索功能
2. 主题管理系统
3. AI翻译工具
4. 拖拽排序功能
5. 小程序支持
6. MCP服务器功能

3. 项目API使用文档

基础API接口

// 初始化客户端
const client = new CherryClient({
  apiKey: 'your_api_key',
  provider: 'openai' // 可选: openai/gemini/anthropic等
});

// 创建对话
const conversation = client.createConversation({
  model: 'gpt-4',
  assistantId: 'default'
});

// 发送消息
const response = await conversation.sendMessage({
  content: '你好，Cherry Studio!',
  attachments: [] // 可选附件
});

MCP服务器协议

1. 启动MCP服务：

   cherry-studio start-mcp --port 8080
   

2. 协议格式：

   • 请求：JSON格式，包含model、messages等字段
   • 响应：流式返回，支持SSE协议

4. 项目安装方式

标准安装

1. Windows：

   • 下载.exe安装包
   • 双击运行安装向导
   • 按提示完成安装

2. macOS：

   • 下载.dmg文件
   • 拖拽应用到Applications文件夹
   • 首次运行需在系统设置中授权

3. Linux：

   • AppImage：

     chmod +x Cherry-Studio-*.AppImage
     ./Cherry-Studio-*.AppImage
     

   • Debian/Ubuntu：

     sudo dpkg -i cherry-studio_*.deb
     sudo apt-get install -f
     

开发者安装

1. 克隆仓库：

   git clone https://github.com/CherryHQ/cherry-studio.git
   

2. 安装依赖：

   npm install
   

3. 运行开发版本：

   npm run dev
   

4. 构建生产版本：

   npm run build