mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2025-12-25 03:10:08 +08:00
8d4b40fa85
* fix: update README files to enhance navigation and add project badges * fix: english version * fix: sponsor link error
214 lines
8.9 KiB
Markdown
214 lines
8.9 KiB
Markdown
<h1 align="center">
|
||
<a href="https://github.com/CherryHQ/cherry-studio/releases">
|
||
<img src="https://github.com/CherryHQ/cherry-studio/blob/main/build/icon.png?raw=true" width="150" height="150" alt="banner" /><br>
|
||
</a>
|
||
</h1>
|
||
<p align="center">English | <a href="./docs/README.zh.md">中文</a> | <a href="./docs/README.ja.md">日本語</a> | <a href="https://cherry-ai.com">Official Site</a> | <a href="https://docs.cherry-ai.com/cherry-studio-wen-dang/en-us">Documents</a> | <a href="./docs/dev.md">Development</a> | <a href="https://github.com/CherryHQ/cherry-studio/issues">Feedback</a><br></p>
|
||
|
||
<!-- 题头徽章组合 -->
|
||
|
||
<div align="center">
|
||
|
||
[![][deepwiki-shield]][deepwiki-link]
|
||
[![][twitter-shield]][twitter-link]
|
||
[![][discord-shield]][discord-link]
|
||
[![][telegram-shield]][telegram-link]
|
||
|
||
</div>
|
||
|
||
<!-- 项目统计徽章 -->
|
||
|
||
<div align="center">
|
||
|
||
[![][github-stars-shield]][github-stars-link]
|
||
[![][github-forks-shield]][github-forks-link]
|
||
[![][github-release-shield]][github-release-link]
|
||
[![][github-contributors-shield]][github-contributors-link]
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
[![][license-shield]][license-link]
|
||
[![][commercial-shield]][commercial-link]
|
||
[![][sponsor-shield]][sponsor-link]
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
<a href="https://hellogithub.com/repository/1605492e1e2a4df3be07abfa4578dd37" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=1605492e1e2a4df3be07abfa4578dd37" alt="Featured｜HelloGitHub" style="width: 200px; height: 43px;" width="200" height="43" /></a>
|
||
<a href="https://trendshift.io/repositories/11772" target="_blank"><img src="https://trendshift.io/api/badge/repositories/11772" alt="kangfenmao%2Fcherry-studio | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry-studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt" style="width: 200px; height: 43px;" width="200" height="43" /></a>
|
||
</div>
|
||
|
||
# 🍒 Cherry Studio
|
||
|
||
Cherry Studio is a desktop client that supports for multiple LLM providers, available on Windows, Mac and Linux.
|
||
|
||
👏 Join [Telegram Group](https://t.me/CherryStudioAI)｜[Discord](https://discord.gg/wez8HtpxqQ) | [QQ Group(575014769)](https://qm.qq.com/q/lo0D4qVZKi)
|
||
|
||
❤️ Like Cherry Studio? Give it a star 🌟 or [Sponsor](docs/sponsor.md) 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, Peplexity, Poe, and others
|
||
- 💻 Local Model Support with Ollama, LM Studio
|
||
|
||
2. **AI Assistants & Conversations**:
|
||
|
||
- 📚 300+ Pre-configured AI Assistants
|
||
- 🤖 Custom Assistant Creation
|
||
- 💬 Multi-model Simultaneous Conversations
|
||
|
||
3. **Document & Data Processing**:
|
||
|
||
- 📄 Support for Text, Images, Office, PDF, and more
|
||
- ☁️ WebDAV File Management and Backup
|
||
- 📊 Mermaid Chart Visualization
|
||
- 💻 Code Syntax Highlighting
|
||
|
||
4. **Practical Tools Integration**:
|
||
|
||
- 🔍 Global Search Functionality
|
||
- 📝 Topic Management System
|
||
- 🔤 AI-powered Translation
|
||
- 🎯 Drag-and-drop Sorting
|
||
- 🔌 Mini Program Support
|
||
- ⚙️ MCP(Model Context Protocol) Server
|
||
|
||
5. **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 - Smart content selection enhancement
|
||
- Deep Research - Advanced research capabilities
|
||
- Memory System - Global context awareness
|
||
- Document Preprocessing - Improved document handling
|
||
- MCP Marketplace - Model Context Protocol ecosystem
|
||
|
||
2. 🗂 **Knowledge Management**
|
||
|
||
- Notes and Collections
|
||
- Dynamic Canvas visualization
|
||
- OCR capabilities
|
||
- TTS (Text-to-Speech) support
|
||
|
||
3. 📱 **Platform Support**
|
||
|
||
- HarmonyOS Edition (PC)
|
||
- Android App (Phase 1)
|
||
- iOS App (Phase 1)
|
||
- Multi-Window support
|
||
- Window Pinning functionality
|
||
|
||
4. 🔌 **Advanced Features**
|
||
|
||
- Plugin System
|
||
- ASR (Automatic Speech Recognition)
|
||
- Assistant and Topic Interaction Refactoring
|
||
|
||
Track our progress and contribute on our [project board](https://github.com/orgs/CherryHQ/projects/7).
|
||
|
||
Want to influence our roadmap? Join our [GitHub Discussions](https://github.com/CherryHQ/cherry-studio/discussions) to share your ideas and feedback!
|
||
|
||
# 🌈 Theme
|
||
|
||
- Theme Gallery: <https://cherrycss.com>
|
||
- Aero Theme: <https://github.com/hakadao/CherryStudio-Aero>
|
||
- PaperMaterial Theme: <https://github.com/rainoffallingstar/CherryStudio-PaperMaterial>
|
||
- Claude dynamic-style: <https://github.com/bjl101501/CherryStudio-Claudestyle-dynamic>
|
||
- Maple Neon Theme: <https://github.com/BoningtonChen/CherryStudio_themes>
|
||
|
||
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](docs/branching-strategy-en.md) 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](./CONTRIBUTING.md).
|
||
|
||
Thank you for your support and contributions!
|
||
|
||
# 🔗 Related Projects
|
||
|
||
- [one-api](https://github.com/songquanpeng/one-api):LLM API management and distribution system, supporting mainstream models like OpenAI, Azure, and Anthropic. Features unified API interface, suitable for key management and secondary distribution.
|
||
|
||
- [ublacklist](https://github.com/iorate/ublacklist):Blocks specific sites from appearing in Google search results
|
||
|
||
# 🚀 Contributors
|
||
|
||
<a href="https://github.com/CherryHQ/cherry-studio/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=CherryHQ/cherry-studio" />
|
||
</a>
|
||
<br /><br />
|
||
|
||
# ⭐️ Star History
|
||
|
||
[](https://star-history.com/#CherryHQ/cherry-studio&Timeline)
|
||
|
||
<!-- Links & Images -->
|
||
[deepwiki-shield]: https://img.shields.io/badge/Deepwiki-CherryHQ-0088CC?style=plastic
|
||
[deepwiki-link]: https://deepwiki.com/CherryHQ/cherry-studio
|
||
[twitter-shield]: https://img.shields.io/badge/Twitter-CherryStudioApp-0088CC?style=plastic&logo=x
|
||
[twitter-link]: https://twitter.com/CherryStudioApp
|
||
[discord-shield]: https://img.shields.io/badge/Discord-@CherryStudio-0088CC?style=plastic&logo=discord
|
||
[discord-link]: https://discord.gg/wez8HtpxqQ
|
||
[telegram-shield]: https://img.shields.io/badge/Telegram-@CherryStudioAI-0088CC?style=plastic&logo=telegram
|
||
[telegram-link]: https://t.me/CherryStudioAI
|
||
|
||
<!-- Links & Images -->
|
||
[github-stars-shield]: https://img.shields.io/github/stars/CherryHQ/cherry-studio?style=social
|
||
[github-stars-link]: https://github.com/CherryHQ/cherry-studio/stargazers
|
||
[github-forks-shield]: https://img.shields.io/github/forks/CherryHQ/cherry-studio?style=social
|
||
[github-forks-link]: https://github.com/CherryHQ/cherry-studio/network
|
||
[github-release-shield]: https://img.shields.io/github/v/release/CherryHQ/cherry-studio
|
||
[github-release-link]: https://github.com/CherryHQ/cherry-studio/releases
|
||
[github-contributors-shield]: https://img.shields.io/github/contributors/CherryHQ/cherry-studio
|
||
[github-contributors-link]: https://github.com/CherryHQ/cherry-studio/graphs/contributors
|
||
|
||
<!-- Links & Images -->
|
||
[license-shield]: https://img.shields.io/badge/License-AGPLv3-important.svg?style=plastic&logo=gnu
|
||
[license-link]: https://www.gnu.org/licenses/agpl-3.0
|
||
[commercial-shield]: https://img.shields.io/badge/License-Contact-white.svg?style=plastic&logoColor=white&logo=telegram&color=blue
|
||
[commercial-link]: mailto:license@cherry-ai.com?subject=Commercial%20License%20Inquiry
|
||
[sponsor-shield]: https://img.shields.io/badge/Sponsor-FF6699.svg?style=plastic&logo=githubsponsors&logoColor=white
|
||
[sponsor-link]: https://github.com/CherryHQ/cherry-studio/blob/main/docs/sponsor.md
|