跳转到主要内容

TUI 模式

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

输入模式

TUI 提供多种输入模式:

内置工具

Qoder CLI 内置 Grep、Read、Write、Bash 等工具,可用于文件/目录操作和 shell 命令执行。 如需了解工具能力和控制方式,见 工具

斜杠命令

通过以下内置斜杠命令快速访问功能和设置:

高级启动选项

启动 CLI 时,可以使用以下选项控制行为: 权限相关的启动参数和设置见 权限 Print 模式是非交互式模式。运行 qodercli --print 即可进入,输出会按照 --output-format 参数指定的格式打印。

参数

全局参数可用于任意命令:

Worktree

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

在 worktree 中启动

如果不传 worktree 名称,Qoder CLI 会自动生成一个名称。worktree 名称最多 256 个字符,可以包含字母、数字、点、下划线、短横线和用 / 分隔的片段。带 / 的名称会在目录名和分支名中转换成 + 创建新的命名 worktree 时,Qoder CLI 会把它放在 <repo>/.qoder/worktrees/<flattened-name> 下,并创建名为 worktree-<flattened-name> 的临时分支。如果同名 worktree 已存在,Qoder CLI 会直接复用该目录,而不是再创建一个。 新的 worktree 优先基于本地 origin/HEAD 指向的默认分支引用创建。如果没有配置 origin/HEAD,Qoder CLI 会在能够解析或获取 origin/main 时使用它;否则回退到当前 HEAD。如果必须从最新远端提交开始,请先执行 git fetch origin

复制本地文件

新的 worktree 是干净检出,默认不包含 .env 等未跟踪文件。需要把本地文件复制到新 worktree 时,在仓库根目录添加 .worktreeinclude
只有同时匹配 .worktreeinclude 且已经被 Git 忽略的文件会被复制。项目本地设置 .qoder/settings.local.json 存在时会自动复制。

恢复和清理

会话结束时,Qoder CLI 会打印 worktree 路径和恢复该会话的命令:
交互式退出会检查 worktree 中的未提交文件和新增提交。干净的 worktree 可以自动删除;存在本地文件或提交时,退出提示会让你选择保留或删除。删除会丢弃这些改动,并删除临时分支。 如需手动删除 worktree,执行:
如果不再需要 worktree-<flattened-name> 分支,可以单独删除该分支:

在会话中使用 worktree

在已有会话中,也可以要求 Qoder CLI 在隔离的 worktree 中处理任务。它会为当前会话创建并进入 worktree;需要离开时,可以要求它退出 worktree 并恢复原工作目录。 Subagent 也可以使用 worktree 隔离。某个 Markdown Subagent 需要在独立检出里改文件时,在定义中添加 isolation: worktree。干净的 Subagent worktree 会在 Subagent 结束后删除;有改动的 worktree 会保留。配置方式见 子代理 对于会话中创建的 worktree 和启用 worktree 隔离的 Subagent,WorktreeCreate Hook 可以提供自定义 worktree 路径。配套的 WorktreeRemove 清理行为见 Hooks--worktree 启动参数本身要求在 Git 仓库中使用,并使用 Git 创建 worktree。 如果需要完全手动控制目录和分支,可以直接使用 Git 创建 worktree,再在该目录中启动 Qoder CLI:

记忆

Qoder CLI 通过 AGENTS.md 文件和可选的自动记忆在会话间保留上下文。常用文件包括用户级 ~/.qoder/AGENTS.md、项目级 ${project}/AGENTS.md 和本地项目级 ${project}/AGENTS.local.md

自动生成

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

手动管理

  • 在项目中创建 AGENTS.md 并编辑其内容。
  • 在 TUI 中输入 /memory,管理用户级、项目级和本地记忆文件。
  • 自动记忆启用时,可在 /memory 面板打开 auto-memory folder,也可输入 /memory manage 管理自动保存的记忆文件。
完整说明见 记忆