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

# 快速上手

> 10 分钟完成第一次任务：启动 Qoder CLI，理解项目、完成一个小改动并提交

<div id="prerequisites">
  # 前提条件
</div>

* **已安装 Qoder CLI**：运行 `qodercli --version` 能打印版本号即可。尚未安装见 [安装与升级](/zh/cli/01-开始使用/install)。
* **已完成登录**：首次运行 `qodercli` 时会自动引导登录。登录方式详见 [登录与认证](/zh/cli/01-开始使用/auth)。

<div id="start">
  # 启动
</div>

进入你的项目根目录，启动默认的交互式（TUI）模式：

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

看到对话提示符 `>` 后，直接用自然语言描述你想做的事情即可。

<div id="first-task">
  # 完成第一次任务
</div>

## 第一步：让 Qoder 理解项目

从一个了解型的问题开始：

```text theme={null}
帮我梳理这个项目的整体架构和主要模块
```

Qoder 会自主搜索和读取相关文件，给出带文件位置的解释。你可以顺着它的回答继续追问，逐步深入。

> 建议顺手输入 `/init`，在项目中生成 `AGENTS.md` 记忆文件，让 Qoder 在后续会话中记住项目约定。详见 [记忆](/zh/cli/04-扩展QoderCLI/memory)。

## 第二步：做一个小改动

用自然语言描述一个具体的小任务，例如：

```text theme={null}
给 <某个函数> 补一个单元测试，并运行验证
```

Qoder 在执行有副作用的操作（如写文件、运行命令）前，会根据权限设置向你确认。确认机制与放行规则见 [权限](/zh/cli/06-配置与安全/permissions)。

## 第三步：审查并提交

改动完成后，输入 `/review` 让 Qoder 评审本地代码改动；确认无误后，直接让它提交：

```text theme={null}
帮我生成提交信息并提交这次改动
```

更多日常任务的提示词示例（探索代码、修复缺陷、重构、处理 PR 等），见 [常见开发任务](/zh/cli/03-使用QoderCLI/01-开始一个任务/common-tasks)。

<div id="cheatsheet">
  # 常用操作速查
</div>

| 输入        | 作用                    |
| :-------- | :-------------------- |
| `!`       | Bash 模式，直接运行 shell 命令 |
| `/`       | 打开斜杠命令列表              |
| `/help`   | 显示 TUI 帮助             |
| `/status` | 查看版本、模型、账号与 API 连通性   |
| `/usage`  | 查看 Credits 使用情况       |
| `/resume` | 查看并恢复历史会话             |
| `/quit`   | 退出 TUI                |

完整的输入模式、斜杠命令与启动参数，见 [使用 CLI](/zh/cli/03-使用QoderCLI/01-开始一个任务/using-cli)。

<div id="next-steps">
  # 下一步
</div>

* 系统了解交互方式与启动参数：[使用 CLI](/zh/cli/03-使用QoderCLI/01-开始一个任务/using-cli)。
* 按任务场景查提示词：[常见开发任务](/zh/cli/03-使用QoderCLI/01-开始一个任务/common-tasks)。
* 了解 Plan、Goal、定时任务等更多工作方式：[选择合适的工作方式](/zh/cli/02-核心概念/work-modes)。