Reading the repo

Opening the box…

How to set up cherry-studio (CherryHQ/cherry-studio) · gitmanual

Assembly instructions

CherryHQ/cherry-studio

Your AI workspace for models, agents, and productivity.

Node.jsVite#agent-skills#agent-workspace#agentic-workspace#ai-agents

Difficulty: Moderate
Time: about 15 min
Stars: ★ 53,263
Activity: Updated this month
License: AGPL-3.0
Open issues: 2,464
Got it running: Be the first
Looked up: 3 h ago

Saved setup from 3 h ago

Start here

Website ↗cherryai.comThe project's own site.Docs ↗cherryai.comLinked from the README.

Will it work on my device?

Yes, it installs on your macOS

A ready-made macOS download is in the latest release.

Checking for

Download for macOS

v2.1.10 · 10/31/2026 ↗

Cherry-Studio-2.1.10-mac-arm64.dmg

dmg · Apple Silicon · 302.6 MB · 4,496 downloads · best match

Download

Drag the app into Applications.

curl -LO "https://github.com/CherryHQ/cherry-studio/releases/download/v2.1.10/Cherry-Studio-2.1.10-mac-arm64.dmg"
open "Cherry-Studio-2.1.10-mac-arm64.dmg"

Other macOS downloads (3)

Cherry-Studio-2.1.10-mac-arm64.zip

zip · Apple Silicon · 292.3 MB · 9,485 downloads

Download

If it contains an .app, move it to Applications.

curl -LO "https://github.com/CherryHQ/cherry-studio/releases/download/v2.1.10/Cherry-Studio-2.1.10-mac-arm64.zip"
unzip "Cherry-Studio-2.1.10-mac-arm64.zip"

Cherry-Studio-2.1.10-mac-x64.dmg

dmg · Intel · 326.8 MB · 552 downloads

Download

Drag the app into Applications.

curl -LO "https://github.com/CherryHQ/cherry-studio/releases/download/v2.1.10/Cherry-Studio-2.1.10-mac-x64.dmg"
open "Cherry-Studio-2.1.10-mac-x64.dmg"

Cherry-Studio-2.1.10-mac-x64.zip

zip · Intel · 315.9 MB · 605 downloads

Download

If it contains an .app, move it to Applications.

curl -LO "https://github.com/CherryHQ/cherry-studio/releases/download/v2.1.10/Cherry-Studio-2.1.10-mac-x64.zip"
unzip "Cherry-Studio-2.1.10-mac-x64.zip"

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 13 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js 24.18.1runtime
1×pnpm pnpm@12.6.0package manager

7× settings in .env

NODE_OPTIONS
API_KEYsecret
BASE_URL
MODEL
CSLOGGER_MAIN_LEVEL
CSLOGGER_RENDERER_LEVEL
MAIN_VITE_CHERRY_CLOUD_API_ORIGIN

Share this manual

Good to know

Monorepo (workspaces) — install from the repo root.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: native/system-speech/package.json, packages/agent-behavior/package.json, packages/agent-runtime-claude-code/package.json, packages/agent-runtime-pi-durable/package.json and 11 more

package.json scripts (131)

agent-notes:check-transitiontsx scripts/docsGovernance/verify-agent-note-transitions.ts
analyze:mainVISUALIZER_MAIN=true pnpm build
analyze:rendererVISUALIZER_RENDERER=true pnpm build
benchvitest bench --run
bench:aicorevitest bench --run --project "aiCore (bench)"
bench:mainvitest bench --run --project "main (bench)"
bench:renderervitest bench --run --project "renderer (bench)"
bench:sharedvitest bench --run --project "shared (bench)"
buildpnpm run typecheck && dotenv -v CHERRY_EDITION=global -- electron-vite build && pnpm run build:utility-process
build:builtin-knowledgetsx scripts/generate-cherry-assistant-knowledge
build:builtin-knowledge:checktsx scripts/generate-cherry-assistant-knowledge --check
build:checkpnpm check:all
build:cnpnpm run typecheck && dotenv -v CHERRY_EDITION=cn -- electron-vite build && pnpm run build:utility-process
build:linuxdotenv pnpm run build && electron-builder --linux --x64 --arm64
build:linux:arm64dotenv pnpm run build && electron-builder --linux --arm64
build:linux:arm64:cnpnpm run build:cn && electron-builder --config electron-builder.cn.config.cjs --linux --arm64
build:linux:cnpnpm run build:cn && electron-builder --config electron-builder.cn.config.cjs --linux --x64 --arm64
build:linux:x64dotenv pnpm run build && electron-builder --linux --x64
build:linux:x64:cnpnpm run build:cn && electron-builder --config electron-builder.cn.config.cjs --linux --x64
build:macdotenv pnpm run build && electron-builder --mac --arm64 --x64
build:mac:arm64dotenv pnpm run build && electron-builder --mac --arm64
build:mac:arm64:cnpnpm run build:cn && electron-builder --config electron-builder.cn.config.cjs --mac --arm64
build:mac:cnpnpm run build:cn && electron-builder --config electron-builder.cn.config.cjs --mac --arm64 --x64
build:mac:x64dotenv pnpm run build && electron-builder --mac --x64
build:mac:x64:cnpnpm run build:cn && electron-builder --config electron-builder.cn.config.cjs --mac --x64

Files we read (13)

.env.example

.github/workflows/auto-release-build.yml

.github/workflows/ci-metrics.yml

.github/workflows/ci-rerun-on-base-change.yml

.github/workflows/ci.yml

.github/workflows/e2e-regression-test.yml

.github/workflows/nightly-build.yml

.node-version

.nvmrc

CONTRIBUTING.md

README.md

package.json

pnpm-workspace.yaml

Branch main · 12,626 files in the repo