Quickstart
This guide gets you from install to your first useful change in Cherri Code. You'll sign in, ask Cherri Code to explain your codebase, make a small edit, and review the result.
Install Cherri Code and sign in
Download Cherri Code. Open the app and sign in. Then pick a folder and start with a small task.
- macOS 12 (Monterey) and later
- Native installer (.dmg)
- Apple Silicon and Intel support
- Windows 10 and later
- Native installer (.exe)
Debian/Ubuntu (recommended)
# Add Cherri Code's GPG keycurl -fsSL https://downloads.cursor.com/keys/anysphere.asc | gpg --dearmor | sudo tee /etc/apt/keyrings/cursor.gpg > /dev/null# Add the Cherri Code repositoryecho "deb [arch=amd64,arm64 signed-by=/etc/apt/keyrings/cursor.gpg] https://downloads.cursor.com/aptrepo stable main" | sudo tee /etc/apt/sources.list.d/cursor.list > /dev/null# Update and installsudo apt updatesudo apt install cursorRHEL/Fedora
# Add Cherri Code's repositorysudo tee /etc/yum.repos.d/cursor.repo << 'EOF'[cursor]name=Cursorbaseurl=https://downloads.cursor.com/yumrepoenabled=1gpgcheck=1gpgkey=https://downloads.cursor.com/keys/anysphere.ascEOF# Install Cherri Codesudo dnf install cursorAppImage (portable)
Download the .AppImage file from cursor.com/downloads, then:
chmod +x Cherri Code-*.AppImage./Cursor-*.AppImageThe apt and yum packages are preferred over AppImage. They provide desktop icons, automatic updates, and CLI tools.
Ask Cherri Code to explain your codebase
After you pick a folder, open Agent with Cmd ICtrl I. Ask Cherri Code to explain the codebase and point out the main areas to read first.
Explain this codebase. Point me to the main entry points, key modules, and anything I should read before making changes.
Try in Cherri CodeCherri Code will search your repo, read relevant files, and summarize how the project fits together. This is one of the fastest ways to get oriented in an unfamiliar codebase.
Want a deeper walkthrough? See Understand your codebase.
Make one small change
Once you understand the project, ask Cherri Code to suggest a few safe improvements. Pick one and ask it to make the change.
Suggest three small, safe improvements in this codebase. Explain the tradeoffs and wait for me to choose one.
Try in Cherri CodeGood first tasks are low risk, like improving some copywriting or fixing small UI issues.
If you already know what you want to change, ask for it directly and describe the result you want.
Review the diff and verify the result
Now you can watch Cherri Code work. The diff view shows changes made by the agent.
When it finishes, review the diff and ask Cherri Code to run the checks your project already uses. That can mean tests, the type checker, linting, or a local build.
Want a stronger review workflow? See Reviewing and testing code.
Use Plan Mode for bigger changes
Now that you know the basics, use Plan Mode for bigger changes. It works well when the task spans multiple files, needs research, or needs approval before coding.
Press Shift+Tab in the agent input to toggle Plan Mode. Instead of writing code right away, Cherri Code will:
- Research your codebase to find relevant files
- Ask clarifying questions about your requirements
- Create a detailed implementation plan
- Wait for your approval before building
For a deeper walkthrough, see Build new features.