跳转到主要内容

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.

​
TUI 模式

在任意项目根目录运行 qodercli 即可进入默认的 TUI（交互式）模式。你可以通过文本与 CLI 对话，也可以通过斜杠命令执行特定功能。

​
输入模式

TUI 提供多种输入模式：
命令描述
>对话模式（默认）。输入任意文本即可与 CLI 对话
!Bash 模式。在对话模式下输入 ! 可直接运行 shell 命令
/斜杠模式。在对话模式下输入 / 可打开并运行内置命令
\ ⏎按 Enter 开始多行输入

​
内置工具

Qoder CLI 内置 Grep、Read、Write、Bash 等工具，可用于文件/目录操作和 shell 命令执行。

​
斜杠命令

通过以下内置斜杠命令快速访问功能和设置：
命令描述
/login登录你的 Qoder 账号
/help显示 TUI 帮助
/init在项目中初始化或更新 AGENTS.md 记忆文件
/memory打开记忆管理器，管理用户级、项目级和本地记忆文件
/quest执行基于 Spec 的委派任务
/review对本地代码改动进行评审
/resume查看并恢复会话
/clear清除当前会话的历史上下文
/compact总结当前会话的历史上下文
/usage显示当前 Credits 使用情况
/status查看 CLI 状态，包括版本、模型、账号、API 连通性、工具状态等
/config查看 Qoder CLI 的系统配置
/agents子 Agent 命令：查看、创建、管理子 Agent
/tasks查看当前正在运行的后台任务
/release-notes显示 Qoder CLI 更新日志
/vim打开外部编辑器来编辑输入
/feedback发送 Qoder CLI 相关反馈
/quit退出 TUI
/logout退出你的 Qoder 账号

​
高级启动选项

启动 CLI 时，可以使用以下选项控制行为：
命令说明示例
-w指定工作区目录qodercli -w /Users/demo/projects/nacos
-c继续上次会话qodercli -c
-r恢复指定会话qodercli -r *******-c09a-40a9-82a7-a565413fa39
--allowed-tools仅允许指定工具qodercli --allowed-tools=Read,Write
--disallowed-tools禁止指定工具qodercli --disallowed-tools=Read,Write
--max-turns最大对话轮数qodercli --max-turns=10
--yolo跳过权限检查qodercli --yolo
权限相关的启动参数和设置见 权限。 Print 模式是非交互式模式。运行 qodercli --print 即可进入，输出会按照 --output-format 参数指定的格式打印。

​
参数

全局参数可用于任意命令：
参数说明示例
-p以非交互方式运行 Agentqodercli -q -p hi
--output-format输出格式：text、json、stream-jsonqodercli --output-format=json
-w指定工作区目录qodercli -w /Users/qoder_user/projects/qoder_demo
-c继续上次会话qodercli -c
-r恢复指定会话qodercli -r ********-c09a-40a9-82a7-a565413fa393
--allowed-tools仅允许指定工具qodercli --allowed-tools=Read,Write
--disallowed-tools禁止指定工具qodercli --disallowed-tools=Read,Write
--max-turns最大对话轮数qodercli --max-turns=10
--yolo跳过权限检查qodercli --yolo

​
Worktree

使用 --worktree [name] 可以在独立的 Git worktree 中启动 Qoder CLI 会话。适合在同一个仓库中并行处理多个任务，避免多个会话共享同一个工作目录。
要求：在 Git 仓库中运行该命令，并确保本地已安装 Git。

​
在 worktree 中启动

qodercli --worktree feature-a
qodercli --worktree feature-a "Implement the login fix"
qodercli --worktree
如果不传 worktree 名称，Qoder CLI 会自动生成一个名称。worktree 准备完成后，Qoder CLI 会切换到该 worktree 并正常启动会话。 会话结束时，Qoder CLI 会打印 worktree 路径和恢复该会话的命令： 
cd <worktree-path> && qodercli --resume <session-id>
如需手动删除 worktree，执行： 
git worktree remove <worktree-path>

​
记忆

Qoder CLI 使用 AGENTS.md 作为记忆文件，文件内容会自动加载到 CLI 中，作为指导开发的上下文。典型内容包括：
  • 开发规范与说明
  • 整体系统架构
  • …
本地文件路径： 
# 用户级，适用于所有项目
~/.qoder/AGENTS.md
# 项目级，适用于当前项目
${project}/AGENTS.md
# 本地项目级，仅在当前机器生效
${project}/AGENTS.local.md

​
自动生成

在目标项目中启动 TUI，并输入 /init，即可在项目目录中生成 AGENTS.md。

​
手动管理

  • 在项目中创建 AGENTS.md 并编辑其内容。
  • 在 TUI 中输入 /memory，管理用户级、项目级和本地记忆文件。