CherryHQ-cherry-studio/docs/guides/development.md

🖥️ Develop

IDE Setup

VSCode like

• Editor: Cursor, etc. Any VS Code compatible editor.
• Recommended extensions are listed in .vscode/extensions.json.

Zed

1. Install extensions: Biome, oxc
2. Copy the example settings file to your local Zed config:

   cp .zed/settings.json.example .zed/settings.json
   

3. Customize .zed/settings.json as needed (it is git-ignored).

Windows: Enable Symlinks

This project uses symlinks to synchronize files such as AGENTS.md and skills. Windows developers must enable symlink support before cloning:

1. Enable Developer Mode (Settings → Update & Security → For developers), or grant SeCreateSymbolicLinkPrivilege via secpol.msc.
2. Configure Git:

   git config --global core.symlinks true
   

3. Clone (or re-clone) the repository after enabling symlink support.

Project Setup

Install

pnpm install

Development

Setup Node.js

The required Node.js version is defined in .node-version. Use a version manager like nvm or fnm to install it automatically:

nvm install

Setup pnpm

The pnpm version is locked in the packageManager field of package.json. Just enable corepack and it will use the correct version automatically:

corepack enable

Install Dependencies

pnpm install

ENV

cp .env.example .env

Start

pnpm dev

Debug

pnpm debug

Then input chrome://inspect in browser

Test

pnpm test

Build

# For windows
$ pnpm build:win

# For macOS
$ pnpm build:mac

# For Linux
$ pnpm build:linux