Skip to main content
Getting Started

Quick Start

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

Prerequisites

  • Qoder CLI installed: Running qodercli --version should print the version number. If not yet installed, see Installation and Upgrade.
  • Signed in: You will be automatically guided through the sign-in process the first time you run qodercli. For details on sign-in methods, see Sign-in and Authentication.

Start

Navigate to your project root directory and launch the default interactive (TUI) mode: 
cd /path/to/your-project
qodercli
Once you see the conversation prompt >, simply 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: 
Help me outline the overall architecture and main modules of this project
Qoder will autonomously search and read relevant files, providing explanations along with file locations. You can follow up on its answers to dive deeper.
It is recommended to enter /init to generate a AGENTS.md memory file in your project, allowing Qoder to remember project conventions in subsequent sessions. See Memory for details.

Step 2: Make a Small Change

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

Step 3: Review and Commit

Once the changes are complete, enter /review to have Qoder review the local code changes. After confirming everything is correct, simply ask it to commit: 
Help me generate a commit message and commit this change
For more prompt examples for daily tasks (exploring code, fixing bugs, refactoring, handling PRs, etc.), see Common Development Tasks.

Quick Reference

InputAction
!Bash Mode: run shell commands directly
/Open the slash commands list
/helpDisplay TUI help
/statusView version, model, account, and API Connectivity
/usageView Credits usage
/resumeView and resume historical sessions
/quitExit TUI
For complete input modes, slash commands, and startup arguments, see Run Tasks.

Next Steps

Getting Started
Core Concepts
Using Qoder CLI
Extending Qoder CLI
Remote and Integrations
Configuration and Security
Reference
Troubleshooting