Skip to content

CLI 使用

DimCode 只有一个 CLI 入口:dim

帮助

bash
dim --help

概要

text
Usage:
  dim [--route name] [--approvals auto|all] [--auto-approve|-y] [--cols N --rows N] [--record file] [--replay file] [--snapshot file] [--no-mouse] [--no-alt-screen] [--debug]
  dim version
  dim upgrade [version] [--check] [--quiet]
  dim server [--host HOST] [--port N] [--open] [--token TOKEN] [--verbose] [--debug-ui|--debug]
  dim gui [--host HOST] [--port N] [--gui-host HOST] [--gui-port N] [--open|--no-open] [--token TOKEN] [--verbose] [--debug-ui|--debug]
  dim exec [-c dir] <prompt>
  dim acp

命令

dim

启动交互式终端 UI(TUI)。

参数:

  • --route <name>:从指定 route 启动(高级)。
  • --approvals auto|all:工具审批模式(默认 auto)。
  • --auto-approve--yes-y:等同于 --approvals all
  • --cols <N>--rows <N>:强制终端尺寸(debug/testing)。
  • --record <file>:将 TUI 事件录制到文件。
  • --replay <file>:回放之前录制的会话。
  • --snapshot <file>:写入 UI snapshot(debug/testing)。
  • --no-mouse:禁用鼠标支持。
  • --no-alt-screen:禁用终端 alternate screen。
  • --debug:启用诊断(默认写入 ./dimcode-debug.log)。

dim exec

运行一次性 prompt(工具自动批准)。别名:dim e

bash
# 基本用法
dim exec "总结这个仓库并提出下一步计划"

# 指定工作目录
dim exec -c /path/to/repo "找出 bug 并修复"
dim exec --cwd ~/projects/myapp "生成测试"

# 从 stdin 读取
echo "审查这段代码" | dim exec

参数:

  • -c, --cwd, --chdir <dir>:设置工作目录。
  • --:停止解析参数(当 prompt 以 - 开头时有用)。

注意:

  • exec 模式下工具会自动批准。
  • 会话 ID 也可以通过 DIMCODE_SESSION_ID 环境变量设置。
  • 返回退出码:成功为 0,错误为 1,需要用户输入为 2。

dim server

启动本地 API 服务器并提供打包的 Web GUI。

bash
# 启动服务器
dim server

# 启动并打开浏览器
dim server --open

# 自定义主机/端口
dim server --host 0.0.0.0 --port 8080

# 设置认证 token
dim server --token mysecrettoken

# 启用详细日志
dim server --verbose

参数:

  • --host <HOST>:API 服务器主机(默认:127.0.0.1)。
  • --port <N>:API 服务器端口(默认:13442)。
  • --open, -o:启动后打开浏览器。
  • --no-open:不打开浏览器。
  • --token <TOKEN>:设置认证 token。如果 --token 没有提供值,则生成随机 token。
  • --verbose, -v:启用详细日志。
  • --debug, --debug-ui:启用 UI 调试模式。

环境变量:

  • DIMCODE_SERVER_TOKEN:默认 token 值。

注意:

  • 默认启用自动更新(设置 DIMCODE_DISABLE_AUTOUPDATE=1 禁用检查;设置 DIMCODE_AUTOUPDATE=0 禁用后台安装)。
  • npm 安装:通过 npm 检查更新。
  • 独立二进制:通过发布版本检查更新。

dim gui

启动 Nuxt 开发服务器(热重载)和本地 API 服务器。仅仓库版本可用: 期望 ./packages/gui 并需要 bun

bash
# 启动 GUI 开发服务器
dim gui

# 自定义端口
dim gui --port 13442 --gui-port 3001

# 不打开浏览器
dim gui --no-open

# 自定义 GUI 服务器主机/端口
dim gui --gui-host 0.0.0.0 --gui-port 8080

参数:

  • --host <HOST>:API 服务器主机(默认:127.0.0.1)。
  • --port <N>:API 服务器端口(默认:13442)。
  • --gui-host <HOST>:GUI 开发服务器主机(默认:127.0.0.1)。
  • --gui-port <N>:GUI 开发服务器端口(默认:3000)。
  • --open, -o:启动后打开浏览器(默认:true)。
  • --no-open:不打开浏览器。
  • --token <TOKEN>:设置认证 token。
  • --verbose, -v:启用详细日志。
  • --debug, --debug-ui:启用 UI 调试模式。

环境变量:

  • DIMCODE_SERVER_TOKEN:默认 token 值。

注意:

  • 使用 dim server --open 运行打包的 GUI 而不是开发服务器。

dim acp

启动 ACP server 模式,用于编辑器集成(如 Zed)。

bash
dim acp

见:/zh/acp

dim version

输出版本与运行时信息。

bash
dim version
dim --version
dim -v

dim upgrade

升级 独立二进制(如果你运行的是编译后的 dim)。

bash
# 检查更新
dim upgrade --check

# 升级到最新版本
dim upgrade

# 升级到指定版本
dim upgrade 1.2.3

# 静默模式(后台)
dim upgrade --quiet

参数:

  • --check:仅检查是否有可用更新,不安装。
  • --quiet, --background:抑制输出(适用于后台更新)。

如果你是通过 npm/pnpm/yarn/bun 安装的,请改用包管理器升级:

bash
npm install -g dimcode@latest

常用环境变量

关于 ~/.dimcode/ 的详细说明,见:/zh/config

变量含义
OPENAI_API_KEYAPI key(大多数提供方必需)
DIMCODE_OPENAI_BASE_URL / OPENAI_BASE_URL(旧:OPENAI_API_BASE_URLOpenAI 兼容端点的 Base URL
DIMCODE_MODEL默认模型 ID
DIMCODE_TEMPERATURE采样温度
DIMCODE_CONTEXT_WINDOW上下文窗口提示
DIMCODE_TOOL_APPROVALSauto(默认)或 all
DIMCODE_SESSION_IDexec 模式的会话 ID
DIMCODE_HOMEDimCode 数据基础目录
DIMCODE_STATE_DIR覆盖状态存储目录
DIMCODE_SERVER_TOKEN服务器认证 token
DIMCODE_DISABLE_AUTOUPDATE设为 1 禁用更新检查
DIMCODE_AUTOUPDATE设为 0 禁用后台安装
DIMCODE_DEBUG_LOG调试日志文件路径(默认:./dimcode-debug.log

快捷键

  • Ctrl+P:命令面板
  • F1:帮助与快捷键
  • Enter:发送 · Shift+Enter(或 Ctrl+J):换行
  • Ctrl+O:展开/折叠工具调用与思考
  • Ctrl+C:清空输入(非空时);否则退出

斜杠命令

在输入框直接输入:

命令作用
/connect连接提供方(也可添加自定义 / 本地提供方)
/models选择提供方与模型
/approvals工具审批(auto / all
/tool-settings工具设置(WebSearch 等)
/mcp-settingsMCP 服务器设置
/sessions列出/选择会话
/timeline/tl跳转到某条用户消息
/new新建会话
/rename <title>重命名当前会话
/compact压缩对话(降低上下文占用)
/language切换界面语言
/theme切换亮/暗主题
/settings/config打开设置
/review审查代码改动
/init初始化/改进 AGENTS.md
/debug打开调试对话框
/exit退出

数据存储位置

关于 ~/.dimcode/ 的详细说明,见:/zh/config

DimCode 把所有数据都存储在本地机器上。

配置目录(Config directory)

  • 如果设置了 DIMCODE_HOME$DIMCODE_HOME
  • 否则如果设置了 XDG_CONFIG_HOME$XDG_CONFIG_HOME/.dimcode
  • 否则:~/.dimcode

缓存目录(Cache directory)

  • 如果设置了 DIMCODE_HOME$DIMCODE_HOME/dimcode
  • 否则如果设置了 XDG_CONFIG_HOME$XDG_CONFIG_HOME/.dimcode/dimcode
  • 否则:~/.dimcode/dimcode

你可能会关心的文件:

  • config.json:提供方连接与 UI 设置
  • cache.json:缓存偏好 + 会话元数据
  • tools.json:工具配置(WebSearch、MCP 服务器)

诊断

bash
dim --debug

如果你要反馈 bug,附上 --record 文件会很有帮助:

bash
dim --record ./dim.tui-record.jsonl