dimcode 0.0.64 → 0.0.65

package/README.md

@@ -1,128 +1,451 @@
 # Dimcode
 
-AI 编程助手 CLI。支持交互式 TUI、单次执行、多会话管理、MCP 扩展、多家主流大模型提供商。
+AI coding agent CLI with an interactive terminal UI, one-shot execution, session history, MCP connectors, plugins, skills, and built-in model provider management.
 
-## 安装
+## Installation
 
 ```bash
 npm install -g dimcode
 ```
 
-安装后可通过 `dim` 或 `dimcode` 运行。
+After installation, run the CLI with either binary:
 
-## 快速开始
+```bash
+dim
+dimcode
+```
+
+## Quick Start
+
+Start the interactive TUI:
+
+```bash
+dim
+```
+
+Inside the TUI:
+
+```text
+/connect   connect a model provider
+/models    select the active model
+hello      start chatting
+```
+
+## One-shot Execution
+
+Run a prompt and exit:
+
+```bash
+dim "Run the tests and fix any failures"
+```
+
+Run from a specific project directory:
+
+```bash
+dim --cwd ./my-project --no-interaction "Refactor the auth middleware"
+```
+
+Read the prompt from stdin:
+
+```bash
+printf "Summarize this repository" | dim --no-interaction
+```
+
+Reuse a known session id:
+
+```bash
+dim --session my-session "Continue the previous task"
+```
+
+One-shot mode auto-approves tools and prints the final answer to stdout. `--no-interaction` disables follow-up questions and runs in agent mode.
+
+## Interactive Commands
+
+Type `/` in the TUI to open command suggestions. Press `Ctrl+P` for the command palette and `F1` for help.
+
+| Command              | Action                                           |
+| -------------------- | ------------------------------------------------ |
+| `/sessions`          | List, switch, or delete saved sessions           |
+| `/new`               | Start a new session                              |
+| `/timeline` or `/tl` | Jump to a user message in the current session    |
+| `/resume`            | Resume a paused queue                            |
+| `/compact`           | Compact the current session context              |
+| `/redo`              | Redo after reverting messages                    |
+| `/rename <title>`    | Rename the current session                       |
+| `/connect`           | Connect or switch model providers                |
+| `/models`            | Select the active model                          |
+| `/settings`          | Edit custom provider settings                    |
+| `/approvals`         | Configure tool approval mode                     |
+| `/mcp`               | Manage MCP connectors                            |
+| `/plugins`           | Manage plugins                                   |
+| `/debug`             | Configure SDK observability JSONL logs           |
+| `/language`          | Switch UI language                               |
+| `/theme`             | Switch the UI theme                              |
+| `/skills`            | View and activate loaded skills                  |
+| `/review`            | Ask Dimcode to review current code changes       |
+| `/init`              | Ask Dimcode to initialize or improve `AGENTS.md` |
+| `/exit`              | Exit the application                             |
+
+## CLI Commands
+
+```bash
+dim version              # Print version info
+dim upgrade [version]    # Upgrade the CLI
+dim acp                  # Start the ACP server for editor integrations
+```
+
+Auto-update checks run by default. Set `DIMCODE_DISABLE_AUTOUPDATE=1` to disable them.
+
+`dim upgrade` tracks the current release channel. Pass an explicit npm version to switch channels:
+
+```bash
+npm install -g dimcode@1.2.0-beta.3
+```
+
+## Options
+
+```text
+Usage:
+  dim                              Interactive TUI
+  dim [--cwd dir] [--session id] [--debug dir] [--no-interaction] "prompt"
+                                   One-shot execution
+  dim version
+  dim upgrade [version]
+  dim acp
+
+Options:
+  --approvals auto|normal|strict   Tool approval mode for the TUI
+  --auto-approve, --yes, -y        Shorthand for --approvals auto
+  --cwd, -c, -cwd, --chdir <dir>   Working directory for one-shot execution
+  --session, -s <id>               Session id for one-shot execution
+  --no-interaction                 One-shot mode with follow-up questions disabled
+  --debug <dir>                    Write SDK observability logs for this run
+  -h, --help                       Show CLI help
+```
+
+The interactive TUI starts with `normal` approvals. One-shot execution sets tool approvals to `auto`.
+
+## Configuration
+
+Dimcode stores user data under `~/.dimcode` by default:
+
+| Path                            | Purpose                                       |
+| ------------------------------- | --------------------------------------------- |
+| `~/.dimcode/config.json`        | Provider, model, and custom provider settings |
+| `~/.dimcode/tools.json`         | Tool-specific settings such as WebSearch      |
+| `~/.dimcode/mcp.json`           | MCP server settings                           |
+| `~/.dimcode/dimcode/cache.json` | UI cache and recent settings                  |
+| `~/.dimcode/state/`             | Session state, uploads, and runtime artifacts |
+
+Move the whole config home with:
+
+```bash
+export DIMCODE_HOME=/path/to/dimcode-home
+```
+
+Move runtime state only with:
+
+```bash
+export DIMCODE_STATE_DIR=/path/to/state
+```
+
+Daily configuration is available in the TUI:
+
+| Entry        | Purpose                                                 |
+| ------------ | ------------------------------------------------------- |
+| `/connect`   | Configure provider API keys and editable base URLs      |
+| `/models`    | Select the model for the active provider                |
+| `/settings`  | Manage custom providers and advanced model parameters   |
+| `/mcp`       | Edit and load MCP connectors                            |
+| `/approvals` | Choose `auto`, `normal`, or `strict` tool approvals     |
+| `/debug`     | Choose `Off`, `On`, or `Auto` SDK observability logging |
+
+Debug logs are written as JSONL files at `<debug-dir>/<session-id>.jsonl`.
+
+## Model Providers
+
+Built-in providers include OpenAI, DimCode OAuth, OpenRouter, Aihubmix, Model Studio Coding Plan, ZhipuAI, Z.AI, DeepSeek, ZenMux, Moonshot, Kimi For Coding, Google, Anthropic, SiliconFlow, PPInfra, Ark Code, Ollama, LM Studio, xAI, Xiaomi Token Plan, and MiniMax variants.
+
+Custom providers support OpenAI-compatible, OpenAI Responses, Gemini, and Anthropic adapters. Built-in base URLs are editable for OpenAI, Anthropic, Google, Ollama, and LM Studio.
+
+## MCP, Plugins, and Skills
+
+`/mcp` manages stdio, HTTP, and SSE MCP servers from `~/.dimcode/mcp.json`.
+
+`/plugins` manages installed plugins.
+
+The command palette also includes Tool Settings for the WebSearch API key.
+
+`/skills` lists loaded skills. Mention a skill with `$skill-name` in the prompt to force it for that turn.
 
-### 启动交互式 TUI
+## Keyboard Shortcuts
+
+| Shortcut                 | Action                                |
+| ------------------------ | ------------------------------------- |
+| `F1`                     | Open help                             |
+| `Ctrl+P`                 | Open command palette                  |
+| `Ctrl+K`                 | Open settings                         |
+| `Ctrl+O`                 | Expand or collapse tools and thinking |
+| `Tab`                    | Switch mode or focus                  |
+| `Shift+Enter` / `Ctrl+J` | Insert a newline                      |
+| `Cmd+Delete` / `Ctrl+W`  | Clear input                           |
+| `Ctrl+Click`             | Open files or links                   |
+| `Esc`                    | Cancel the current dialog or action   |
+
+The command palette, timeline, and new session shortcuts can be customized in settings.
+
+## Editor Integration
+
+Start the ACP server:
+
+```bash
+dim acp
+```
+
+Example Zed settings:
+
+```json
+{
+  "agent_servers": {
+    "dimcode": {
+      "command": "dim",
+      "args": ["acp"]
+    }
+  }
+}
+```
+
+## Help
+
+```bash
+dim --help
+```
+
+Inside the TUI, press `F1`.
+
+---
+
+# Dimcode 中文版
+
+Dimcode 是一个 AI 编程助手 CLI，提供交互式终端 UI、单次执行、会话历史、MCP 连接器、插件、Skills，以及内置模型提供方管理。
+
+## 安装
+
+```bash
+npm install -g dimcode
+```
+
+安装后可使用任一命令运行：
 
 ```bash
 dim
+dimcode
 ```
 
-进入 TUI 后，直接输入任务或问题即可开始对话。
+## 快速开始
 
-### 执行单次命令
+启动交互式 TUI：
 
 ```bash
-dim "帮我写一个 Python 函数，计算斐波那契数列"
+dim
+```
+
+进入 TUI 后：
+
+```text
+/connect   连接模型提供方
+/models    选择当前模型
+hello      开始对话
 ```
 
+## 单次执行
+
+执行提示词并退出：
+
 ```bash
-dim --cwd ./my-project --no-interaction "运行测试并修复报错"
+dim "Run the tests and fix any failures"
 ```
 
-单次执行模式下工具会自动批准，执行完成后自动退出。配合 `--no-interaction` 可在 CI/脚本中使用。
+在指定项目目录运行：
 
-## 常用交互命令
+```bash
+dim --cwd ./my-project --no-interaction "Refactor the auth middleware"
+```
 
-在 TUI 中输入以下命令（以 `/` 开头）可快速操作：
+从 stdin 读取提示词：
 
-| 命令                 | 说明                                          |
-| -------------------- | --------------------------------------------- |
-| `/new`               | 开始新会话                                    |
-| `/sessions`          | 列出或切换会话                                |
-| `/connect`           | 连接大模型提供商（配置 API Key / Base URL）   |
-| `/models`            | 选择当前使用的模型                            |
-| `/approvals`         | 设置工具审批模式（auto / normal / strict）    |
-| `/mcp`               | 配置 MCP 服务器与扩展                         |
-| `/settings`          | 自定义提供商参数                              |
-| `/language`          | 切换界面语言                                  |
-| `/theme`             | 切换界面主题（浅色 / 深色）                   |
-| `/timeline` 或 `/tl` | 跳转到指定用户消息                            |
-| `/compact`           | 压缩会话上下文，节省 Token                    |
-| `/rename <名称>`     | 重命名当前会话                                |
-| `/resume`            | 恢复已暂停的队列                              |
-| `/retry`             | 重试上一条用户消息                            |
-| `/redo`              | 基于当前消息重做                              |
-| `/pin` / `/pins`     | 置顶上一条消息 / 打开置顶列表                 |
-| `/status`            | 切换状态栏详情                                |
-| `/skills`            | 查看已加载的 Skills                           |
-| `/plugins`           | 管理插件                                      |
-| `/debug`             | 管理 SDK observability JSONL 日志与 Auto 模式 |
-| `/toolsettings`      | 管理工具级设置                                |
-| `/review`            | 审查当前代码变更                              |
-| `/init`              | 初始化或改进 AGENTS.md                        |
-| `/help`              | 查看帮助与快捷键                              |
-| `/exit`              | 退出程序                                      |
+```bash
+printf "Summarize this repository" | dim --no-interaction
+```
 
-在聊天中选中某条消息后，可按回车复制消息文本到剪贴板。
+复用指定会话 id：
 
-## 子命令
+```bash
+dim --session my-session "Continue the previous task"
+```
 
-除交互式 TUI 外，还支持以下子命令：
+单次执行模式会自动批准工具调用，并将最终回答输出到 stdout。`--no-interaction` 会关闭追问并使用 agent 模式。
+
+## 交互命令
+
+在 TUI 中输入 `/` 可打开命令建议。按 `Ctrl+P` 打开命令面板，按 `F1` 打开帮助。
+
+| 命令                 | 功能                                |
+| -------------------- | ----------------------------------- |
+| `/sessions`          | 列出、切换或删除已保存会话          |
+| `/new`               | 开始新会话                          |
+| `/timeline` 或 `/tl` | 跳转到当前会话中的用户消息          |
+| `/resume`            | 恢复已暂停队列                      |
+| `/compact`           | 压缩当前会话上下文                  |
+| `/redo`              | 在消息回退后重做                    |
+| `/rename <title>`    | 重命名当前会话                      |
+| `/connect`           | 连接或切换模型提供方                |
+| `/models`            | 选择当前模型                        |
+| `/settings`          | 编辑自定义提供方设置                |
+| `/approvals`         | 配置工具审批模式                    |
+| `/mcp`               | 管理 MCP 连接器                     |
+| `/plugins`           | 管理插件                            |
+| `/debug`             | 配置 SDK observability JSONL 日志   |
+| `/language`          | 切换界面语言                        |
+| `/theme`             | 切换界面主题                        |
+| `/skills`            | 查看并启用已加载 Skills             |
+| `/review`            | 让 Dimcode 审查当前代码变更         |
+| `/init`              | 让 Dimcode 初始化或改进 `AGENTS.md` |
+| `/exit`              | 退出应用                            |
+
+## CLI 命令
 
 ```bash
-dim version              # 查看版本信息
-dim upgrade [version]    # 升级 CLI
-dim acp                  # 启动 ACP Server（供编辑器集成，如 Zed）
+dim version              # Print version info
+dim upgrade [version]    # Upgrade the CLI
+dim acp                  # Start the ACP server for editor integrations
 ```
 
-## 配置说明
+自动更新检查默认开启。设置 `DIMCODE_DISABLE_AUTOUPDATE=1` 可关闭。
 
-Dimcode 的数据默认保存在 `~/.dimcode/` 目录下。你可以通过设置环境变量修改存储位置：
+`dim upgrade` 会跟随当前发布通道。传入明确 npm 版本可切换通道：
 
 ```bash
-export DIMCODE_HOME=/path/to/config
+npm install -g dimcode@1.2.0-beta.3
 ```
 
-**日常配置不需要手动编辑文件**。在 TUI 中使用以下入口即可图形化配置：
+## 选项
+
+```text
+Usage:
+  dim                              Interactive TUI
+  dim [--cwd dir] [--session id] [--debug dir] [--no-interaction] "prompt"
+                                   One-shot execution
+  dim version
+  dim upgrade [version]
+  dim acp
+
+Options:
+  --approvals auto|normal|strict   Tool approval mode for the TUI
+  --auto-approve, --yes, -y        Shorthand for --approvals auto
+  --cwd, -c, -cwd, --chdir <dir>   Working directory for one-shot execution
+  --session, -s <id>               Session id for one-shot execution
+  --no-interaction                 One-shot mode with follow-up questions disabled
+  --debug <dir>                    Write SDK observability logs for this run
+  -h, --help                       Show CLI help
+```
+
+交互式 TUI 默认使用 `normal` 审批模式。单次执行会将工具审批设为 `auto`。
 
-- `/connect` — 添加或切换提供商，输入 API Key 与 Base URL
-- `/models` — 选择当前会话使用的模型
-- `/settings` — 调整上下文窗口、温度、最大 Token 等高级参数
-- `/mcp` — 编辑 `mcp.json` 并加载 MCP 工具
-- `/debug` — 选择 Off / On / Auto，并配置 Auto 使用的日志目录；文件按会话写入 `<目录>/<session-id>.jsonl`
+## 配置
 
-配置、会话历史、用户缓存会自动保存。
+Dimcode 默认将用户数据保存到 `~/.dimcode`：
 
-## 命令行选项
+| 路径                            | 用途                           |
+| ------------------------------- | ------------------------------ |
+| `~/.dimcode/config.json`        | 提供方、模型、自定义提供方设置 |
+| `~/.dimcode/tools.json`         | WebSearch 等工具级设置         |
+| `~/.dimcode/mcp.json`           | MCP server 设置                |
+| `~/.dimcode/dimcode/cache.json` | UI 缓存和最近设置              |
+| `~/.dimcode/state/`             | 会话状态、上传文件、运行时产物 |
+
+移动完整配置目录：
 
 ```bash
-dim [选项] [命令或提示]
+export DIMCODE_HOME=/path/to/dimcode-home
+```
 
-选项:
-  --approvals auto|normal|strict   工具审批模式（默认 normal）
-  --auto-approve, --yes, -y        等价于 --approvals auto
-  --no-interaction                 单次执行时禁用交互式追问
-  --cwd <dir>                      指定工作目录（单次执行）
-  --session <id>                   指定会话 ID（单次执行）
-  --debug <dir>                    本次执行启用 SDK observability，写入 <dir>/<session-id>.jsonl
-  -h, --help                       显示帮助
+单独移动运行时状态目录：
+
+```bash
+export DIMCODE_STATE_DIR=/path/to/state
 ```
 
+日常配置可在 TUI 中完成：
+
+| 入口         | 用途                                              |
+| ------------ | ------------------------------------------------- |
+| `/connect`   | 配置提供方 API key 和可编辑 base URL              |
+| `/models`    | 为当前提供方选择模型                              |
+| `/settings`  | 管理自定义提供方和高级模型参数                    |
+| `/mcp`       | 编辑并加载 MCP 连接器                             |
+| `/approvals` | 选择 `auto`、`normal` 或 `strict` 工具审批        |
+| `/debug`     | 选择 `Off`、`On` 或 `Auto` SDK observability 日志 |
+
+Debug 日志会以 JSONL 写入 `<debug-dir>/<session-id>.jsonl`。
+
+## 模型提供方
+
+内置提供方包括 OpenAI、DimCode OAuth、OpenRouter、Aihubmix、Model Studio Coding Plan、ZhipuAI、Z.AI、DeepSeek、ZenMux、Moonshot、Kimi For Coding、Google、Anthropic、SiliconFlow、PPInfra、Ark Code、Ollama、LM Studio、xAI、Xiaomi Token Plan、MiniMax 等变体。
+
+自定义提供方支持 OpenAI-compatible、OpenAI Responses、Gemini、Anthropic adapters。OpenAI、Anthropic、Google、Ollama、LM Studio 的内置 base URL 可编辑。
+
+## MCP、插件与 Skills
+
+`/mcp` 会从 `~/.dimcode/mcp.json` 管理 stdio、HTTP、SSE MCP servers。
+
+`/plugins` 用于管理已安装插件。
+
+命令面板中的 Tool Settings 可配置 WebSearch API key。
+
+`/skills` 用于查看已加载 Skills。在提示词中使用 `$skill-name` 可为当前轮次指定 Skill。
+
 ## 快捷键
 
-| 快捷键                   | 功能                        |
-| ------------------------ | --------------------------- |
-| `Ctrl+C` / `Esc`         | 取消当前操作 / 退出         |
-| `Ctrl+P`                 | 打开命令面板                |
-| `F1`                     | 打开帮助                    |
-| `Tab`                    | 切换模式或焦点              |
-| `↑/↓`                    | 浏览历史输入或列表          |
-| `Ctrl+O`                 | 展开/收起工具输出与思考过程 |
-| `Ctrl+K`                 | 打开设置                    |
-| `Shift+Enter` / `Ctrl+J` | 输入框换行                  |
+| 快捷键                   | 功能                      |
+| ------------------------ | ------------------------- |
+| `F1`                     | 打开帮助                  |
+| `Ctrl+P`                 | 打开命令面板              |
+| `Ctrl+K`                 | 打开设置                  |
+| `Ctrl+O`                 | 展开或收起工具与 thinking |
+| `Tab`                    | 切换模式或焦点            |
+| `Shift+Enter` / `Ctrl+J` | 输入换行                  |
+| `Cmd+Delete` / `Ctrl+W`  | 清空输入                  |
+| `Ctrl+Click`             | 打开文件或链接            |
+| `Esc`                    | 取消当前对话框或操作      |
+
+命令面板、时间线、新会话快捷键可在设置中自定义。
+
+## 编辑器集成
+
+启动 ACP server：
+
+```bash
+dim acp
+```
+
+Zed 配置示例：
+
+```json
+{
+  "agent_servers": {
+    "dimcode": {
+      "command": "dim",
+      "args": ["acp"]
+    }
+  }
+}
+```
 
 ## 获取帮助
 
-- 在 TUI 中输入 `/help`
-- 运行 `dim --help`
+```bash
+dim --help
+```
+
+在 TUI 内按 `F1`。