@deepseek-harness-tui/dsh-tui 0.11.2 → 0.13.0

package/guide/dsh-tui-guide/getting-started.md

@@ -0,0 +1,399 @@
+# 安装与快速开始
+
+[文档索引](README.md) · [English](getting-started.en.md)
+
+## 前置条件
+
+- Node.js `^22.19 || >=24`。CI 使用 Node 24。
+- 官方 DeepSeek Harness CLI：`@deepseek-ai/dsh`。
+- `pnpm` **10 或更高**（CI 使用 11）。`dsh plugin` 把 profile 内的包安装
+  交给 pnpm；pnpm 9 的传递依赖提升行为不同，会让 `dsh-working-activity`
+  解析不到，表现为启动后立刻退出且几乎无报错（issue #60，见下方常见问题）。
+- 支持交互输入的终端 TTY。`dsh-tui` 不支持把 stdout 重定向后启动。
+- `deepseek-official` 模型路由需要 `DEEPSEEK_API_KEY`；DSH 0.2.0-rc.1+ 的标准 profile 也可通过 `/auth login deepseek-account` 登录独立的 DeepSeek 账号路由。其他支持的账号可用 `/provider` 或 `/auth` 登录。自定义兼容端点还可设置 `DEEPSEEK_BASE_URL`。
+
+macOS/Linux：
+
+```sh
+export DEEPSEEK_API_KEY='your-key'
+```
+
+PowerShell：
+
+```powershell
+$env:DEEPSEEK_API_KEY = 'your-key'
+```
+
+不要把真实密钥提交到仓库。正常的 profile 启动直接读取环境变量。
+
+## 安装
+
+最快路径（全局安装后自带 `dsh-tui` 直达命令）：
+
+```sh
+# 官方 CLI + 本插件
+npm install -g @deepseek-ai/dsh @deepseek-harness-tui/dsh-tui
+
+# pnpm 未安装时任选一种方式（首次启动自动初始化 profile 时需要）
+npm install -g pnpm
+# 或：corepack enable pnpm
+
+# 启动：首次运行自动执行 dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui@<版本>
+dsh-tui
+```
+
+手工分步（等价）：
+
+```sh
+npm install -g @deepseek-ai/dsh
+
+# pnpm 未安装时任选一种方式
+npm install -g pnpm
+# 或：corepack enable pnpm
+
+dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui
+dsh --profile dsh-tui   # 或 dsh-tui
+```
+
+从仓库检出运行时，也可以执行：
+
+```sh
+sh install.sh
+```
+
+`install.sh` 只封装 profile 插件命令并检查 `dsh`、`pnpm` 是否可用；它不会
+复制源码，也不需要本地构建。
+
+## 从旧包迁移
+
+早期版本使用无 scope 包 `dsh-cc-tui` 和 `cc-tui` profile：
+
+- 环境变量前缀为 `CC_TUI_*`/`DSH_CC_*`。
+- 数据目录为 `~/.dsh-cc`。
+
+新版本统一为组织包 `@deepseek-harness-tui/dsh-tui` 与 `dsh-tui` profile。
+执行以下命令创建新 profile：
+
+```sh
+dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui
+dsh --profile dsh-tui
+```
+
+新版本只使用 `DSH_TUI_*` 环境变量与 `~/.dsh-tui` 数据目录，旧名不再被读取，
+也不自动迁移数据。首次启动后，请把旧数据目录（`~/.dsh-cc` 等）中的主题、
+配置与历史文件自行复制到 `~/.dsh-tui`。
+
+确认新 profile 正常后：
+
+- 旧的 `$DSH_HOME/profiles/cc-tui` 与旧数据目录残留可按需删除。
+- 不要把旧包和新包同时添加到同一个 profile。
+
+## 安装命令做了什么
+
+首次执行 `dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui` 时，
+官方 CLI 会：
+
+1. 在 `$DSH_HOME/profiles/dsh-tui/` 初始化 profile。未设置 `DSH_HOME` 时，
+   默认根目录通常是 `~/.dsh`。
+2. 让 profile 的第一层 bundle 使用 `@deepseek-ai/dsh-base`。
+3. 在 profile 内通过 pnpm 安装 `@deepseek-harness-tui/dsh-tui`。
+4. 读取包内 `dsh.bundle.patch` 元数据，将 `cordis.patch.yml` 追加为组合层。
+
+启动时的主要顺序是：
+
+```text
+dsh-base -> 其他 bundle -> @deepseek-harness-tui/dsh-tui patch -> 用户 profile patch
+```
+
+- base 提供 Agent、模型、会话、文件、Shell、策略和注册表等服务。
+- 本插件的 patch 覆盖或插入 TUI、Agent preset 名册、SQLite 会话持久化与
+  工作状态行。
+
+`dsh-working-activity` 已经是本包依赖，并由 `dsh-tui` 的 patch 自动插入。
+不要对同一个 profile 再单独执行 `add dsh-working-activity`，否则可能出现重复行。
+
+## 启动
+
+```sh
+dsh --profile dsh-tui
+```
+
+命令从当前目录启动，因此 Agent 的默认工作区也是当前目录。进入目标项目目录后再
+启动即可。
+
+Windows 仓库检出还提供：
+
+```bat
+dsh-tui.cmd
+dsh-tui.cmd --resume
+```
+
+- `--resume` 会读取 `%USERPROFILE%\.dsh-tui\resume.txt`，恢复 TUI 最近选择的
+  会话。
+- 设置 `DSH_TUI_WORKSPACE` 可以覆盖批处理启动器采用的工作目录。
+
+## CLI 子命令
+
+`dsh-tui help`（或 `dst help`）打印完整用法，`dst` 别名接受相同命令：
+
+| 命令 | 作用 |
+| --- | --- |
+| `dsh-tui update` | 更新 profile 到最新版本并对齐启动器（与 TUI 内 `/update` 同一安装逻辑，不进入 TUI） |
+| `dsh-tui doctor` | 环境检查：dsh/pnpm、profile 安装与版本对齐、API key 是否设置（只报状态不读值）、配置文件存在性；与 TUI 内 `/doctor` 会话诊断互补 |
+| `dsh-tui safe` | 安全模式：只读诊断、插件清单与修复指引（`safe --rescue` 还会创建/校验干净的救援 profile） |
+| `dsh-tui version` | 显示启动器与 profile 版本（`--version`/`-v` 等价） |
+| `dsh-tui help` | 显示用法（`--help`/`-h` 等价） |
+
+`help`/`version` 在 dsh 缺失或 profile 未初始化时也能用；其余参数原样转发给
+`dsh --profile dsh-tui`。
+
+## 安全模式（`dsh-tui safe`）
+
+dsh 意外结束时，安全模式提供只读的环境诊断、profile 插件清单与修复指引。
+
+- **两个入口**：手动运行 `dsh-tui safe`；或 dsh 非零退出后按提示进入。
+  - 提示仅出现在交互终端；脚本/管道只加一行提示、退出码不变。
+  - 只覆盖最终 dsh 子进程的非零退出码，不含启动挂起（启动失败按退出码 1）。
+- **只读边界**：诊断/清单/指引不改状态。两个例外：
+  - 重试正常启动；若 `~/.dsh-tui/resume.txt` 里有指针则一并带上
+    （`DSH_TUI_RESUME_SESSION`），崩溃后重试会回到当时所在会话而不是新空会话。
+  - 创建/复用救援 profile，只写 `$DSH_HOME/profiles/dsh-tui-safe/`。
+  注：每次 dsh 启动仍会写 `$DSH_HOME/profiles/node_modules` 回退链接与
+  pnpm 全局 store（非安全模式引入）。
+- **救援 profile 必须干净，证不出就拒绝**。逐条校验，任一不成立即拒绝：
+  - 候选目录已存在，但不是可识别的 profile。
+  - 既有 profile 的根 manifest 声明了第三方插件。
+  - `$DSH_HOME/cordis.patch.yml`（home 层）**存在即拒绝**。
+  - `dsh-tui-safe/cordis.patch.yml`（profile 层）**有条目即拒绝**；dsh 默认
+    生成的「注释 + `[]`」不算条目。
+  删除/重建救援 profile 前会**按名字与形态核对顶层条目**，发现别的名字或
+  形态不符就拒绝并列出，**不会静默删你的文件**。
+- **非交互**：`dsh-tui safe --rescue` 跑同一套门禁与创建/复用，只报结论
+  （就绪退出 0，拒绝退出 1）。
+- **旧全局启动器**：profile 副本不可读或过旧时，先升级：
+  `npm install -g --legacy-peer-deps @deepseek-harness-tui/dsh-tui@<版本>`。
+- **修复命令需自行执行**（安全模式只列出）：
+  - `dsh plugin --profile dsh-tui remove <第三方插件>` 逐个移除可疑插件；
+  - `dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui@<版本>`
+    重装对齐；
+  - `dsh-tui doctor` 环境诊断。
+
+## 在 VS Code / Herdr 中运行
+
+- **VS Code**：可在集成终端直接运行，或用已上架 Marketplace 的 companion 扩展
+  `dsh-tui-vscode`（真实终端会话、会话历史、指定会话恢复、IDE 选区通道）。
+  见 [VS Code 使用指南](vscode.md)。
+- **Herdr**：直接在 [Herdr](https://herdr.dev) 窗格中运行 `dsh-tui`，无需额外
+  配置；dsh-TUI 经 Herdr 本地集成 API 报告 `idle` / `working` / `blocked`
+  （问卷与工具审批记为 `blocked`），在 Herdr 之外不做任何事。
+
+## 更新到最新版本
+
+项目迭代很快，更新复用安装命令，显式指定 `@latest`：
+
+```sh
+# 更新 Profile runtime（TUI 内 /update 做的就是这件事）
+dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui@latest
+```
+
+通过全局 `dsh-tui` 命令启动时，还需要让 Launcher 对齐（TUI 内的
+`/update` 只更新 profile，不会动全局安装）：
+
+```sh
+npm install -g @deepseek-harness-tui/dsh-tui@latest
+# 或（原本用 pnpm 全局安装时）
+pnpm add -g @deepseek-harness-tui/dsh-tui@latest
+```
+
+- 不带 `@latest` 时 pnpm 会按 profile `package.json` 里已记录的版本范围
+  （如 `^0.1.4`）就地解析，可能停留在旧的主线上——这是"重复执行安装命令
+  但版本没变"的常见原因。
+- 修复"版本不一致"时，优先使用启动器打印的"精确版本"命令（例如
+  `npm install -g @deepseek-harness-tui/dsh-tui@0.8.3`）；日常主动升级才
+  使用 `@latest`。
+- 确认生效：启动横幅右上角显示当前版本（`✦ dsh-TUI vX.Y.Z`）。
+- 用户覆盖层 `cordis.patch.yml` 在更新中原样保留。
+- 会话数据的存放位置可能随版本变化（如 0.3.7 起 `/resume` 改用与 dsh web
+  共享的 JSONL 会话库），跨大版本更新后旧会话不在列表属预期，原数据不会被删除。
+
+### pnpm 安装脚本拦截与异平台原生包
+
+若 `dsh plugin` 安装时报 `ERR_PNPM_IGNORED_BUILDS`（pnpm ≥11 默认阻止带
+安装脚本的依赖，如 `@google/genai`、`protobufjs`——这些脚本运行时不需要，
+忽略即可），在 profile 的 `pnpm-workspace.yaml` 里加入：
+
+```yaml
+allowBuilds:
+  '@google/genai': false
+  protobufjs: false
+```
+
+`/update` 与 `dsh-tui update` 会自动写入这份配置，无需手工处理。
+
+更新时还会维护 `ignoredOptionalDependencies`（忽略异平台的 `@img/sharp-*`
+原生包）：
+
+- sharp 以全平台可选依赖分发，不处理时 `pnpm update` 会把各平台二进制一起
+  下载（实测约 200MB）。
+- 名单每次更新按当前平台重算，异平台原生包不再下载（当前平台原生包与无平台
+  归属的 wasm 回退包保留）。
+- 把 profile 搬到别的平台或 musl 容器后，在那台机器上跑一次更新即可刷新。
+- 老 profile 的 lockfile 里仍写着全平台条目，第一次更新会照旧下载一遍，之后
+  才被忽略。
+- 块内不属于这两张平台表的条目（`fsevents`、自己写的 `@img/sharp-wasm32`
+  豁免）原样保留；需要 pnpm 支持该键，不认识的版本不会因此报错，只失去这项
+  收益。
+
+## Profile 配置
+
+用户覆盖文件位于：
+
+```text
+$DSH_HOME/profiles/dsh-tui/cordis.patch.yml
+```
+
+配置一个节点时，`config` 块是整段替换，不是逐字段深合并。复制示例时需要保留
+仍然有效的字段。完整说明见[配置参考](configuration.md)。
+
+仓库根目录的 `cordis.yml` 是裸组合示例；正常的 npm/profile 安装以
+`cordis.patch.yml` 为准，不需要把根配置复制到 profile。
+
+## 从源码开发
+
+```sh
+git clone --recurse-submodules https://github.com/ccch1mneyyy/dsh-TUI.git
+cd dsh-TUI
+pnpm install --frozen-lockfile
+pnpm build
+pnpm smoke
+```
+
+本仓库只有一个子模块，且安装必需：
+
+- `vendor/dsh-std`：`pnpm-workspace.yaml` 把 `vendor/dsh-std/packages/*` 列为
+  workspace 包。
+
+TUI Profile（插件准入与私有协议定义）在 `tui-profile/`，是**普通文件**（不再是
+子模块），随本仓库代码一起检出与修订，供契约检查使用。
+
+漏掉 `--recurse-submodules` 会让这些目录为空，
+`pnpm install --frozen-lockfile` 直接失败。已经克隆过的检出补一条：
+
+```sh
+git submodule update --init --recursive
+```
+
+`pnpm build` 会清理忽略入库的 `lib/`，把 `src/` 编译到 `lib/types/`，再运行
+构建门禁。
+
+- **Git URL 安装不受支持**（workspace 依赖/子模块/pnpm ≥11 prepare 白名单
+  三重阻断）。
+- 发布 workflow 也会在打包前显式执行干净编译和包面验证。
+
+真实测试当前源码时，首次使用或正式模型/密钥配置变化后运行：
+
+```sh
+pnpm dev:copy-config
+```
+
+以后每次修改源码后，一条命令构建、打包、隔离安装并启动：
+
+```sh
+pnpm dev
+```
+
+`pnpm dev:copy-config` 只复制 `~/.dsh/settings.yaml` 与
+`~/.dsh/.credentials.yaml`。Unix 上文件权限设为 `0600`；Windows 使用系统管理的
+文件 ACL。
+
+`pnpm dev` 使用独立的 `HOME`、`DSH_HOME` 和会话目录，不覆盖正式
+`~/.dsh/profiles/dsh-tui`、`~/.dsh-tui` 或正式会话。默认测试目录：
+
+- Unix：`$XDG_CACHE_HOME/dsh-tui-dev`（未设置时为 `~/.cache/dsh-tui-dev`）。
+- Windows：`%LOCALAPPDATA%\dsh-tui-dev`。
+- 可通过 `DSH_TUI_DEV_ROOT` 覆盖。
+
+不启动 TUI、只验证构建、打包和安装流程时运行：
+
+```sh
+pnpm dev:test
+```
+
+CI 还会运行三条渲染回归：
+
+```sh
+node --import tsx/esm scripts/repro-askpanel.tsx
+node --import tsx/esm scripts/verify-askpanel-layout.tsx
+node --import tsx/esm scripts/repro-toolcards.tsx
+```
+
+`pnpm tui` 调用的 `scripts/run.ts` 直接组合 DeepSeek Harness 源码 patch，默认
+假设包位于 Harness monorepo 的 `packages/*` 布局中；独立 checkout 需要另外
+设置 `DSH_TUI_DEV_WORKSPACE` 指向 Harness 根目录。只测试本仓库当前源码时，
+优先使用上述 `pnpm dev`，它会走与用户安装一致的 profile 路径。
+
+## 常见问题
+
+### Git URL 安装报错
+
+Git URL（如 `https://github.com/ccch1mneyyy/dsh-TUI`）安装不受支持，报以下错误码：
+
+- `ERR_PNPM_GIT_DEP_PREPARE_NOT_ALLOWED`
+- `ERR_PNPM_WORKSPACE_PKG_NOT_FOUND`
+
+三重阻断：
+
+- 源 manifest 的 `@dsh-std/*` 是 workspace 依赖（git tarball 原样保留，
+  profile 内无法解析）。
+- `vendor/dsh-std` 是 git 子模块（依赖抓取不带子模块内容，编译必败）。
+- pnpm ≥11 默认拒绝 git 依赖执行 `prepare` 构建脚本。
+
+请安装 registry 包：
+
+```sh
+dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui
+```
+
+### `dsh-tui requires an interactive terminal`
+
+stdout 不是 TTY。请直接在终端中启动，不要把主进程输出管道到文件或其他命令。
+
+如果 dsh-tui 只是装在某个 profile 里、而实际由 Web / Tauri / GUI 等非终端
+宿主启动 DSH，dsh-tui 会检测到 stdout 不是 TTY 且并非由 `dsh-tui` launcher
+启动，自动跳过 TUI 前端（不报错、不影响宿主启动）。
+
+只有显式执行 `dsh-tui`（含 standalone 便携版）却没有 TTY 时，才会报上面的
+错误。
+
+### 找不到 `dsh` 或 `pnpm`
+
+确认全局 npm bin 目录在 `PATH` 中，并重新打开终端。`install.sh` 会在安装前
+检查这两个命令。
+
+### 启动后立刻退回 shell，几乎没有报错（pnpm 9）
+
+pnpm 9 安装的 profile 里，传递依赖 `dsh-working-activity` 不会被提升到
+loader 可解析的位置，模块解析失败导致整棵插件树被回收，TUI 打印 resume
+提示后直接退出（issue #60）。升级 pnpm 到 10+ 后重装即可：
+
+```sh
+npm install -g pnpm@latest
+dsh plugin --profile dsh-tui add @deepseek-harness-tui/dsh-tui@latest
+```
+
+### 模型启动失败或提示没有凭证
+
+若使用 `deepseek-official`，确认启动 `dsh` 的同一个 Shell 中存在 `DEEPSEEK_API_KEY`；
+自定义端点同时检查 `DEEPSEEK_BASE_URL`。若使用 `deepseek-account` 或订阅模型，
+用 `/auth status` 检查登录状态，必要时重新运行 `/auth login <provider>`。
+
+### 工作状态行重复
+
+检查 profile 是否曾单独添加 `dsh-working-activity`。保留本包 patch 自动插入的
+`working-activity` 行，移除重复 bundle 配置。
+
+### TUI 显示错位或终端退出后状态异常
+
+先运行 `/doctor`，记录终端类型和模式，再参考[交互文档](interaction.md)与
+[架构文档](architecture.md)。渲染问题可使用 `DSH_TUI_RENDER_LOG` 采集原始帧，
+但日志可能包含会话可见内容，应妥善处理。