mirror of https://github.com/CherryHQ/cherry-studio.git synced 2025-12-19 06:30:10 +08:00

🍒 Cherry Studio is a desktop client that supports for multiple LLM providers.

agent anthropic assistant chatbot chatbotai electron llm mcp-client openai

Go to file

牡丹凤凰 9249ee9094 Update README.md (#1513 )		2025-02-12 23:07:46 +08:00
.github	feat: update AIHubMix OAuth and release workflow configuration	2025-02-12 18:24:57 +08:00
.vscode	Modified the prompt part Modified the minapp data part	2024-09-14 16:23:58 +08:00
.yarn/patches	chore: Update embedjs dependencies to version 0.1.28	2025-02-11 22:36:34 +08:00
build	Revert "feat: enable local network access on macOS #1178 "	2025-02-11 11:18:33 +08:00
docs	Update README.ja.md	2025-02-07 06:50:07 +08:00
packages	feat(constants): add C# file extension to textExts array #835	2025-01-23 13:22:17 +08:00
resources	feat: add file reading functionality and integrate system agents	2025-01-22 14:35:38 +08:00
scripts	feat: add windows platform support for node file detection and npm package download	2024-12-26 12:38:51 +08:00
src	feat: update AIHubMix OAuth and release workflow configuration	2025-02-12 18:24:57 +08:00
.editorconfig	fix: electron builder ignore files	2024-08-26 18:19:01 +08:00
.eslintignore	build: add scripts/cloudflare-worker.js	2024-11-22 10:01:54 +08:00
.eslintrc.cjs	feat: add generate to ai provider api	2024-09-13 09:57:27 +08:00
.gitignore	fix: knowledge bugs	2024-12-23 10:48:40 +08:00
.prettierignore	style: align tab content horizontally and ignore agents.json with prettier	2024-10-26 23:36:06 +08:00
.prettierrc	chore(lint): Update ESLint and Prettier configurations	2024-05-24 16:33:26 +08:00
.yarnrc.yml	chore(version): 0.6.2	2024-08-26 18:30:05 +08:00
CODE_OF_CONDUCT.md	docs: update documentation for a more inclusive environment and added japanese and chinese documentation	2024-10-25 00:09:01 +08:00
CONTRIBUTING.md	docs: update documentation to reflect project changes	2024-10-29 15:29:44 +08:00
dev-app-update.yml	feat: add update info ui	2024-12-10 17:06:29 +08:00
electron-builder.yml	chore(version): 0.9.20	2025-02-09 00:05:15 +08:00
electron.vite.config.ts	feat: Add image loader to embedjs configuration	2025-02-11 22:55:49 +08:00
LICENSE	docs: update LICENSE	2024-10-17 14:09:30 +08:00
package.json	feat: Add image loader to embedjs configuration	2025-02-11 22:55:49 +08:00
README.md	Update README.md (#1513 )	2025-02-12 23:07:46 +08:00
tsconfig.json	feat: add local module	2024-08-27 11:31:05 +08:00
tsconfig.node.json	refactor: shortcuts feature	2024-12-03 10:23:53 +08:00
tsconfig.web.json	refactor: shortcuts feature	2024-12-03 10:23:53 +08:00
yarn.lock	feat: Add image loader to embedjs configuration	2025-02-11 22:55:49 +08:00

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｜Discord | QQ Group(1022779719)

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

🌠 Screenshot

🌟 Key Features

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
AI Assistants & Conversations:
- 📚 300+ Pre-configured AI Assistants
- 🤖 Custom Assistant Creation
- 💬 Multi-model Simultaneous Conversations
Document & Data Processing:
- 📄 Support for Text, Images, Office, PDF, and more
- ☁️ WebDAV File Management and Backup
- 📊 Mermaid Chart Visualization
- 💻 Code Syntax Highlighting
Practical Tools Integration:
- 🔍 Global Search Functionality
- 📝 Topic Management System
- 🔤 AI-powered Translation
- 🎯 Drag-and-drop Sorting
- 🔌 Mini Program Support
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:

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

Getting Started

Fork the Repository: Fork and clone it to your local machine.
Create a Branch: For your changes.
Submit Changes: Commit and push your changes.
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!

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.