README.md

English | 中文 | 日本語

🍒 Cherry Studio

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

👏 Join Telegram Group

🌠 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

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

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

🖥️ Develop

IDE Setup

Cursor + ESLint + Prettier

Project Setup

Install

$ yarn

Development

$ yarn dev

Build

# For windows
$ yarn build:win

# For macOS
$ yarn build:mac

# For Linux
$ yarn build:linux

🤝 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.

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!

🚀 Contributors

🌐 Community

Telegram | Email | Twitter

📣 Product Hunt

☕ Sponsor

Buy Me a Coffee

📃 License

LICENSE

⭐️ Star History