cherryhq / cherry-studio
Get started
Taken from the repository's own files on 24 Oct 2026. RepoPilot has not run these commands.
Prerequisites
node >=24.12.0from package.jsonpnpm@12.6.0from package.json
Commands
package.json| Task | Run | What it runs |
|---|---|---|
| dev | pnpm run dev | pnpm prepare:system-speech && pnpm rebuild:electron && pnpm download:binaries && pnpm run build:utility-process && dotenv electron-vite dev |
| start | pnpm run start | pnpm prepare:system-speech && pnpm rebuild:electron && electron-vite preview |
| build | pnpm run build | pnpm run typecheck && dotenv -v CHERRY_EDITION=global -- electron-vite build && pnpm run build:utility-process |
| test | pnpm run test | vitest run --silent |
| lint | pnpm run lint | oxlint --deny-warnings && eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --cache |
| typecheck | pnpm run typecheck | pnpm check --all --group types |
| check | pnpm run check | node scripts/validation/run.mjs |
Install and use
README.md- Read the Contributing Guide and Development Guide.
- Fork the repository and create a focused branch from
main. - Validate your changes, sign and sign off your commits, and open a pull request targeting
mainusing the repository template.
See the Branching Strategy for branch and release conventions.
Developing
CONTRIBUTING.mdPlease refer to the Developer Guide for instructions on setting up your local development environment, including prerequisites, installation steps, and available commands.
For a comprehensive overview of the project architecture, tech stack, conventions, and available commands, see CLAUDE.md.