Skip to main content
Getting started

Quick Start

Complete your first task in 10 minutes: launch Qoder CLI CN, understand the project, make a small change, and commit it

Prerequisites

  • Qoder CLI CN installed: running qodercn --version should print the version number. If not installed yet, see Installation and Upgrade.
  • Signed in: the first run of qodercn automatically guides you through sign-in. For sign-in methods, see Sign-in and Authentication.

Launch

Go to your project root and start the default interactive (TUI) mode:
cd /path/to/your-project
qodercn
Once you see the conversation prompt >, just describe what you want to do in natural language.

Complete your first task

Step 1: Let Qoder understand the project

Start with an exploratory question:
Walk me through the overall architecture and main modules of this project
Qoder searches and reads the relevant files on its own and gives an explanation with file locations. You can follow up on its answers to dig deeper step by step.
We recommend also typing /init to generate an AGENTS.md memory file in the project, so Qoder remembers project conventions in later sessions. See Memory.

Step 2: Make a small change

Describe a concrete small task in natural language, for example:
Add a unit test for <some function> and run it to verify
Before performing operations with side effects (such as writing files or running commands), Qoder asks for your confirmation according to your permission settings. For the confirmation mechanism and allow rules, see Permissions and Directory Trust.

Step 3: Review and commit

When the change is done, type /review to have Qoder review the local code changes; once everything looks good, simply ask it to commit:
Generate a commit message and commit this change for me
For more prompt examples for everyday tasks (exploring code, fixing bugs, refactoring, handling PRs, and more), see Common Development Tasks.

Handy operations at a glance

InputPurpose
!Bash mode — run shell commands directly
/Open the slash command list
/helpShow TUI help
/statusCheck version, model, account, and API connectivity
/usageCheck Credits usage
/resumeView and resume past sessions
/quitExit the TUI
For the full set of input modes, slash commands, and startup flags, see Running Tasks.

Next steps

Quick Start - Qoder CN