> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

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

<div id="prerequisites">
  # Prerequisites
</div>

* **Qoder CLI installed**: Running `qodercli --version` should print the version number. If not yet installed, see [Installation and Upgrade](/en/cli/01-getting-started/install).
* **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](/en/cli/01-getting-started/auth).

<div id="start">
  # Start
</div>

Navigate to your project root directory and launch the default interactive (TUI) mode:

```shell theme={null}
cd /path/to/your-project
qodercli
```

Once you see the conversation prompt `>`, simply describe what you want to do in natural language.

<div id="first-task">
  # Complete Your First Task
</div>

## Step 1: Let Qoder Understand the Project

Start with an exploratory question:

```text theme={null}
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](/en/cli/04-extending-qoder-cli/memory) for details.

## Step 2: Make a Small Change

Describe a specific, small task in natural language, for example:

```text theme={null}
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](/en/cli/06-configuration-and-security/permissions).

## 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:

```text theme={null}
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](/en/cli/03-using-qoder-cli/01-starting-a-task/common-tasks).

<div id="cheatsheet">
  # Quick Reference
</div>

| Input     | Action                                             |
| :-------- | :------------------------------------------------- |
| `!`       | Bash Mode: run shell commands directly             |
| `/`       | Open the slash commands list                       |
| `/help`   | Display TUI help                                   |
| `/status` | View version, model, account, and API Connectivity |
| `/usage`  | View Credits usage                                 |
| `/resume` | View and resume historical sessions                |
| `/quit`   | Exit TUI                                           |

For complete input modes, slash commands, and startup arguments, see [Using the CLI](/en/cli/03-using-qoder-cli/01-starting-a-task/using-cli).

<div id="next-steps">
  # Next Steps
</div>

* Learn about interaction methods and startup arguments: [Using the CLI](/en/cli/03-using-qoder-cli/01-starting-a-task/using-cli).
* Find prompts by task scenario: [Common Development Tasks](/en/cli/03-using-qoder-cli/01-starting-a-task/common-tasks).
* Explore more working modes like Plan, Goal, and Scheduled Tasks: [Choosing the Right Working Mode](/en/cli/02-core-concepts/work-modes).
