cherry-studio Documentation

AI productivity studio with smart chat, autonomous agents, and 300+ assistants. Unified access to frontier LLMs

RAW Doc

1. Project Overview & Quickstart (CherryHQ/cherry-studio)

File: README.md

🌐 Language

text
[English](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=en)
    [简体中文](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=zh-CN)
    [繁體中文](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=zh-TW)
    [日本語](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=ja)
    [한국어](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=ko)
    [हिन्दी](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=hi)
    [ไทย](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=th)
    [Français](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=fr)
    [Deutsch](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=de)
    [Español](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=es)
    [Italiano](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=it)
    [Русский](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=ru)
    [Português](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=pt)
    [Nederlands](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=nl)
    [Polski](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=pl)
    [العربية](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=ar)
    [فارسی](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=fa)
    [Türkçe](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=tr)
    [Tiếng Việt](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=vi)
    [Bahasa Indonesia](https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=id)

🍒 Cherry Studio

Cherry Studio is a desktop client that supports multiple LLM providers, available on Windows, Mac and Linux.

👏 Join Telegram Group|Discord | QQ Group(575014769)

❤️ Like Cherry Studio? Give it a star 🌟 or Sponsor to support the development!

🌠 Screenshot

🌟 Key Features

  1. Diverse LLM Provider Support:
  • ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more
  • 🔗 AI Web Service Integration: Claude, Perplexity, Poe, and others
  • 💻 Local Model Support with Ollama, LM Studio
  1. AI Assistants & Conversations:
  • 📚 300+ Pre-configured AI Assistants
  • 🤖 Custom Assistant Creation
  • 💬 Multi-model Simultaneous Conversations
  1. Document & Data Processing:
  • 📄 Supports Text, Images, Office, PDF, and more
  • ☁️ WebDAV File Management and Backup
  • 📊 Mermaid Chart Visualization
  • 💻 Code Syntax Highlighting
  1. Practical Tools Integration:
  • 🔍 Global Search Functionality
  • 📝 Topic Management System
  • 🔤 AI-powered Translation
  • 🎯 Drag-and-drop Sorting
  • 🔌 Mini Program Support
  • ⚙️ MCP(Model Context Protocol) Server
  1. Enhanced User Experience:
  • 🖥️ Cross-platform Support for Windows, Mac, and Linux
  • 📦 Ready to Use - No Environment Setup Required
  • 🎨 Light/Dark Themes and Transparent Window
  • 📝 Complete Markdown Rendering
  • 🤲 Easy Content Sharing

📝 Roadmap

We're actively working on the following features and improvements:

  1. 🎯 Core Features
  • Selection Assistant with smart content selection enhancement
  • Deep Research with advanced research capabilities
  • Document Preprocessing with improved document handling
  • MCP Marketplace for Model Context Protocol ecosystem
  1. 🗂 Knowledge Management
  • Notes and Collections
  • Dynamic Canvas visualization
  • OCR capabilities
  • TTS (Text-to-Speech) support
  1. 📱 Platform Support
  • HarmonyOS Edition (PC)
  • Android App (Phase 1)
  • iOS App (Phase 1)
  • Multi-Window support
  • Window Pinning functionality
  • Intel AI PC (Core Ultra) Support
  1. 🔌 Advanced Features
  • Plugin System
  • ASR (Automatic Speech Recognition)
  • Assistant and Topic Interaction Refactoring

Track our progress and contribute on our project board.

Want to influence our roadmap? Join our GitHub Discussions to share your ideas and feedback!

🌈 Theme

Welcome PR for more themes

🤝 Contributing

We welcome contributions to Cherry Studio! Here are some ways you can contribute:

  1. Contribute Code: Develop new features or optimize existing code.
  2. Fix Bugs: Submit fixes for any bugs you find.
  3. Maintain Issues: Help manage GitHub issues.
  4. Product Design: Participate in design discussions.
  5. Write Documentation: Improve user manuals and guides.
  6. Community Engagement: Join discussions and help users.
  7. Promote Usage: Spread the word about Cherry Studio.

Refer to the Branching Strategy for contribution guidelines

Getting Started

  1. Fork the Repository: Fork and clone it to your local machine.
  2. Create a Branch: For your changes.
  3. Submit Changes: Commit and push your changes.
  4. Open a Pull Request: Describe your changes and reasons.

For more detailed guidelines, please refer to our Contributing Guide.

Thank you for your support and contributions!

🔧 Developer Co-creation Program

We are launching the Cherry Studio Developer Co-creation Program to foster a healthy and positive-feedback loop within the open-source ecosystem. We believe that great software is built collaboratively, and every merged pull request breathes new life into the project.

We sincerely invite you to join our ranks of contributors and shape the future of Cherry Studio with us.

Contributor Rewards Program

To give back to our core contributors and create a virtuous cycle, we have established the following long-term incentive plan.

The inaugural tracking period for this program will be Q3 2025 (July, August, September). Rewards for this cycle will be distributed on October 1st.

Within any tracking period (e.g., July 1st to September 30th for the first cycle), any developer who contributes more than 30 meaningful commits to any of Cherry Studio's open-source projects on GitHub will be eligible for the following benefits:

  • Cursor Subscription Sponsorship: Receive a $70 USD credit or reimbursement for your Cursor subscription, making AI your most efficient coding partner.
  • Unlimited Model Access: Get unlimited API calls for the DeepSeek and Qwen models.
  • Cutting-Edge Tech Access: Enjoy occasional perks, including API access to models like Claude, Gemini, and OpenAI, keeping you at the forefront of technology.

Growing Together & Future Plans

A vibrant community is the driving force behind any sustainable open-source project. As Cherry Studio grows, so will our rewards program. We are committed to continuously aligning our benefits with the best-in-class tools and resources in the industry. This ensures our core contributors receive meaningful support, creating a positive cycle where developers, the community, and the project grow together.

Moving forward, the project will also embrace an increasingly open stance to give back to the entire open-source community.

How to Get Started?

We look forward to your first Pull Request!

You can start by exploring our repositories, picking up a good first issue, or proposing your own enhancements. Every commit is a testament to the spirit of open source.

Thank you for your interest and contributions.

Let's build together.

🏢 Enterprise Edition

Building on the Community Edition, we are proud to introduce Cherry Studio Enterprise Edition—a privately-deployable AI productivity and management platform designed for modern teams and enterprises.

The Enterprise Edition addresses core challenges in team collaboration by centralizing the management of AI resources, knowledge, and data. It empowers organizations to enhance efficiency, foster innovation, and ensure compliance, all while maintaining 100% control over their data in a secure environment.

Core Advantages

  • Unified Model Management: Centrally integrate and manage various cloud-based LLMs (e.g., OpenAI, Anthropic, Google Gemini) and locally deployed private models. Employees can use them out-of-the-box without individual configuration.
  • Enterprise-Grade Knowledge Base: Build, manage, and share team-wide knowledge bases. Ensures knowledge retention and consistency, enabling team members to interact with AI based on unified and accurate information.
  • Fine-Grained Access Control: Easily manage employee accounts and assign role-based permissions for different models, knowledge bases, and features through a unified admin backend.
  • Fully Private Deployment: Deploy the entire backend service on your on-premises servers or private cloud, ensuring your data remains 100% private and under your control to meet the strictest security and compliance standards.
  • Reliable Backend Services: Provides stable API services and enterprise-grade data backup and recovery mechanisms to ensure business continuity.

✨ Online Demo

🔗 Cherry Studio Enterprise

Version Comparison

Feature Community Edition Enterprise Edition
Open Source ✅ Yes ⭕️ Partially released to customers
Cost AGPL-3.0 License Buyout / Subscription Fee
Admin Backend — ● Centralized Model Access● Employee Management● Shared Knowledge Base● Access Control● Data Backup
Server — ✅ Dedicated Private Deployment

Get the Enterprise Edition

We believe the Enterprise Edition will become your team's AI productivity engine. If you are interested in Cherry Studio Enterprise Edition and would like to learn more, request a quote, or schedule a demo, please feel free to contact us.

  • new-api: The next-generation LLM gateway and AI asset management system supports multiple languages.

  • one-api: LLM API management and distribution system supporting mainstream models like OpenAI, Azure, and Anthropic. Features a unified API interface, suitable for key management and secondary distribution.

  • Poe: Poe gives you access to the best AI, all in one place. Explore GPT-5, Claude Opus 4.1, DeepSeek-R1, Veo 3, ElevenLabs, and millions of others.

  • ublacklist: Blocks specific sites from appearing in Google search results

🚀 Contributors

📊 GitHub Stats

⭐️ Star History

📜 License

The Cherry Studio Community Edition is governed by the standard GNU Affero General Public License v3.0 (AGPL-3.0), available at https://www.gnu.org/licenses/agpl-3.0.html.

Use of the Cherry Studio Community Edition for commercial purposes is permitted, subject to full compliance with the terms and conditions of the AGPL-3.0 license.

Should you require a commercial license that provides an exemption from the AGPL-3.0 requirements, please contact us at [email protected].


File: docs/sponsor.md

2. Official Technical Reference & Guides (CherryHQ/cherry-studio-docs)


icon: cherries

项目简介

关注我们的社交账号:推特(X)、小红书、微博、哔哩哔哩、抖音

加入我们的社群:QQ 群、Telegram、Discord、微信群


Cherry Studio 是一款集多模型对话、智能体 Agent、知识库管理、AI 绘画、翻译等功能于一体的全能 AI 工作台。Cherry Studio 高度自定义的设计、强大的扩展能力和友好的用户体验,使其成为专业用户和 AI 爱好者的理想选择。无论是零基础用户还是开发者,都能在 Cherry Studio 中找到适合自己的 AI 功能,提升工作效率和创造力。


**核心功能与特色**

**1. 基础对话功能**

  • 一问多答:支持同一问题通过多个模型同时生成回复,方便用户对比不同模型的表现,详见 对话界面。
  • 自动分组:每个助手的对话记录会自动分组管理,便于用户快速查找历史对话。
  • 对话导出:支持将完整对话或部分对话导出为多种格式(如 Markdown、Word 等),方便储存与分享。
  • 高度自定义参数:除了基础参数调整外,还支持用户填写自定义参数,满足个性化需求。
  • 预设助手:可在对话中的助手模块浏览和使用预设助手,涵盖翻译、编程、写作等场景,同时支持用户自定义助手。
  • 多种格式渲染:支持 Markdown 渲染、公式渲染、HTML 实时预览等功能,提升内容展示效果。

**2. 智能体与自动化**

  • 智能体(Agent):可在 工作 页面中读取文件、运行命令并完成多步任务,详见 工作。
  • 技能(Skill):为助手或智能体加装的"专业能力包"(如做小红书图文、画流程图),开箱即用,详见 技能。
  • MCP:通过 Model Context Protocol 接入外部工具与服务(数据库、Notion、GitHub 等),详见 MCP 使用教程。
  • 频道:将智能体派驻到飞书 / 微信 / Telegram / Discord 等 IM 平台担任群机器人,详见 频道。
  • 定时任务:让智能体按计划自动运行(如每日新闻简报、每周汇总),详见 定时任务。

**3. 多种特色功能集成**

  • AI 绘画:提供专用绘画面板,用户可通过自然语言描述生成高质量图像。
  • AI 小程序:集成多种免费 Web 端 AI 工具,无需切换浏览器即可直接使用。
  • 翻译功能:支持专用翻译面板、对话翻译、提示词翻译等多种翻译场景。
  • 笔记:内置 Markdown 编辑器,支持与对话内容互通,便于沉淀整理。
  • 文件管理:对话、绘画和知识库中的文件统一分类管理,避免繁琐查找。
  • 全局搜索:支持快速定位历史记录和知识库内容,提升工作效率。

**4. 多服务商统一管理机制**

  • 服务商模型聚合:支持 OpenAI、Gemini、Anthropic、Azure 等主流服务商的模型统一调用。
  • 模型自动获取:一键获取完整模型列表,无需手动配置。
  • 多秘钥轮询:支持多个 API 秘钥轮换使用,避免速率限制问题。
  • 精准头像匹配:为每个模型自动匹配专属头像,提升辨识度。
  • 自定义服务商:支持符合 OpenAI、Gemini 、Anthropic 等规范的三方服务商接入,兼容性强。

**5. 高度自定义界面和布局**

  • 自定义 CSS:支持全局样式自定义,打造专属界面风格。
  • 自定义对话布局:支持列表或气泡样式布局,并可自定义消息样式(如代码片段样式)。
  • 自定义头像:支持为软件和助手设置个性化头像。
  • 自定义侧边栏菜单:用户可根据需求隐藏或排序侧边栏功能,优化使用体验。

**6. 本地知识库系统**

  • 多种格式支持:支持 PDF、DOCX、PPTX、XLSX、TXT、MD 等多种文件格式导入。
  • 多种数据源支持:支持本地文件、网址、站点地图甚至手动输入内容作为知识库源。
  • 知识库导出:支持将处理好的知识库导出并分享给他人使用。
  • 支持搜索检查:知识库导入后,用户可实时检索测试,查看处理结果和分段效果。

**7. 特色聚焦功能**

  • 快捷问答:在任何场景(如微信、浏览器)中呼出快捷助手,快速获取答案。
  • 划词助手:在任意应用选中文字后,通过浮动工具栏一键调用 AI 做翻译、解释、优化、总结等操作。
  • 快捷翻译:支持快速翻译其他场景中的词汇或文本。
  • 内容总结:对长文本内容进行快速总结,提升信息提取效率。
  • 解释说明:无需复杂提示词,一键解释说明不懂的问题。

**8. 数据保障**

  • 多种备份方案:支持本地备份、WebDAV 备份和定时备份,确保数据安全。
  • 数据安全:支持全本地场景使用,结合本地大模型,避免数据泄漏风险。

**项目优势**

  1. 小白友好:Cherry Studio 致力于降低技术门槛,零基础用户也能快速上手,让用户专注于工作、学习或者创作。
  2. 文档完善:提供详细的使用文档和常见问题处理手册,帮助用户快速解决问题。
  3. 持续迭代:项目团队积极响应用户反馈,持续优化功能,确保项目健康发展。
  4. 开源与扩展性:支持用户通过开源代码进行定制和扩展,满足个性化需求。

**适用场景**

  • 知识管理与查询:通过本地知识库功能,快速构建和查询专属知识库,适用于研究、教育等领域。
  • 多模型对话与创作:支持多模型同时对话,帮助用户快速获取信息或生成内容。
  • 翻译与办公自动化:内置翻译助手和文件处理功能,适合需要跨语言交流或文档处理的用户。
  • AI 绘画与设计:通过自然语言描述生成图像,满足创意设计需求。

Star History

关注我们的社交账号

小红书 1.png https://www.xiaohongshu.com/user/profile/662b6853000000000b031d9a?xsec_token=YB_1nKvlH4r5hPYVVbbsNHF8Y6n6AKlm5-DaggPCtd2DQ%3D&xsec_source=app_share&xhsshare=CopyLink&appuid=662b6853000000000b031d9a&apptime=1738627324&share_id=ace5db41b5954fab8d98a2a7865a62bc&share_channel=copy_link
哔哩哔哩 3.png https://b23.tv/hIfGgDW
微博 2.png https://weibo.com/u/7975656228
抖音 4.png https://v.douyin.com/ifTpX4X7
推特(X) 5.png https://x.com/CherryStudioHQ?t=DYR0ulaLur-bO4Us3bG79A&s=05