dsh-better-sidebar

https://github.com/user-attachments/assets/23187822-047e-45cc-b480-fe997bd55b86

✨ 功能一览

• 🗂️ 资源管理器：懒加载目录树（根 = 会话 cwd）、点击在侧边栏打开、行尾 @文件 引用到输入框、右键复制路径
• 📝 编辑与预览：CodeMirror 6 多语言高亮 + Ctrl/Cmd+S 原子保存；图片 / Markdown（预览/编辑切换）/ HTML（沙箱 iframe 预览，相对资源可加载）/ PDF / Word / Excel / PPT 内联预览，切换 Tab 不丢草稿
• ⚡ 客户端懒加载：Office / 终端 / 代码编辑器等重依赖按需分块加载——启动只拉 ~325KB 核心，打开 .xlsx 才拉 Univer（~20MB）、打开 .docx 只拉 docx 预览器、打开终端才拉 xterm；首次打开短暂 loading 后即用（详见 docs/plans/2026-08-12-lazy-chunks-design.md）
• 🌐 浏览器：内嵌网页浏览 tab（多开），后退/前进/刷新 +「在浏览器中打开」；页面在沙箱 iframe 中运行（不透明源：无法访问界面数据与本地文件，拒绝 localhost 等本机地址），界面实时显示沙箱状态、可临时解锁（关闭时红色警示）；被站点拒绝嵌入（X-Frame-Options）时显示原因面板；聊天/界面里的 http(s) 外链默认在侧边栏打开（侧边栏折叠时自动展开面板）
• 💻 终端：xterm.js + node-pty 真实 shell（每会话 3 个 UI 上限）、Tab 保活重连回放；可选为模型注入 8 个 terminal_* 工具
• 🌿 Git 面板：真 diff + VSCode 式 diff tab、懒加载历史、右键暂存/放弃/提交/还原/捡取
• 🧩 后台任务页：主会话完整 agent 拓扑、点击直达执行记录、实时工具调用轮询、新子代理自动展开；同页显示后台任务（当前树全部后台任务，bash/pwsh 类型徽标 + 退出码，点击查看实时输出——自动跟随底部、非消费 peek，不干扰模型的 job_output；两击确认可强制终止）
• 🪟 底部面板：独立的第二个工作台（与右侧栏同类的标签页），只挤占中间 Agent 输出区、不覆盖左右侧边栏；首次展开自动开一个新终端（终端卡片二级设置可关）；右上角 x 一键折叠
• 📱 移动端：视口 < 768px（真正的移动端宽度，不对齐宿主 1024 断点）时只显示右侧栏——进入窄屏时底部面板的标签页直接并入右侧栏标签条，右上角只剩一枚开关，面板为全宽抽屉；新会话默认收起，聊天里点文件/外链自动展开，不挤压对话区
• 🔧 分栏工作台：拖 Tab 拆分/合并分栏（可跨面板拖 Tab）、分隔线调比例；右上角持久按钮簇（底栏 + 侧拉 glyph）折叠/展开两个面板；两面板共享拐角双向拖动调节尺寸，拖动 rAF 直写 DOM 保持流畅
• 🔁 会话隔离：布局/分栏/Tab/两面板状态按会话持久化（localStorage），陈旧状态自动净化；聊天「产出文件」改在侧边栏打开（面板折叠时自动展开）
• ⚙️ 声明式设置：设置页「侧边卡片」分区按注册表渲染功能清单（小卡片网格，高亮 = 启用），每项可独立开/关；二级设置（子代理自动展开、终端工具、底部面板首展自动开终端、沙箱开关等）经齿轮按钮在原生弹窗中编辑
• 🔌 服务化：暴露 ctx.betterSidebar 服务，其他插件可注册侧边栏 tab 与文件预览器（内置 7 tab + 9 viewer 也走同一服务，详见 AGENTS.md）
• 🌏 多语言：界面文案跟随 DSH 的语言设置（zh/en）实时切换——Host 偏好优先于浏览器语言，词典注册进 DSH 的 i18n 命名空间；切换语言无需刷新

🚀 安装

前置：已安装 DSH（dsh web 可运行，含 dsh plugin 命令），Node.js ≥ 20、pnpm ≥ 10。插件已发布到 npm：dsh-better-sidebar@0.10.2（@deepseek-ai/* peer 依赖对齐宿主实际版本 ^0.1.0-rc.6 / @deepseek-ai/cordis@^4.0.1，同版本单实例）。包内声明了 dsh.bundle.patch（随包发布的 cordis.patch.yml），官方 CLI 一条命令完成安装 + 挂载，不修改 DSH 源码。

官方 CLI 安装（推荐）

dsh plugin --profile web add dsh-better-sidebar@0.10.2
# 或（本机无 dsh 命令时）
npx -y --package @deepseek-ai/dsh dsh plugin --profile web add dsh-better-sidebar@0.10.2
# 或安装最新发布版
dsh plugin --profile web add dsh-better-sidebar

命令自动完成：pnpm add 登记依赖到 ~/.dsh/profiles/web/package.json → 识别包内 dsh.bundle.patch，把插件自动加进 dsh.profile.bundles → 下次启动自动挂载（无需手写 cordis.patch.yml 挂载行）。更新同理：dsh plugin --profile web add dsh-better-sidebar@<新版>。

⚠️ 首次在新 profile 上执行时，pnpm 11 的 strict-dep-builds 会拦截 node-pty/protobufjs 的构建脚本，命令会报 Ignored build scripts（包仍已安装、node-pty 预编译产物可直接用）。此时在 ~/.dsh/profiles/web 执行 pnpm approve-builds --all 再重跑一次即可；scripts/install.sh 会自动处理（预写 allowBuilds + 清理旧挂载行）。

一键脚本（自动处理 allowBuilds / 旧挂载行）

curl -fsSL https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.sh | bash
# 指定版本：         curl -fsSL <同上> | bash -s 0.10.2
# 装完自动重启 DSH： curl -fsSL <同上> | bash -s -- --restart

更新

dsh plugin --profile web add dsh-better-sidebar@<新版>

或手动把 ~/.dsh/profiles/web/package.json 里版本号改到新版（如 "^0.10.2"）后 pnpm install。随后重启 DSH 并硬刷新（Cmd/Ctrl+Shift+R）。

提示：若 pnpm 因 minimumReleaseAge（发布 <24h 的新版本）拒绝安装，会自动向 ~/.dsh/profiles/web/pnpm-workspace.yaml 追加 minimumReleaseAgeExclude 条目；也可手动补一行 dsh-better-sidebar@<版本>。

1. git clone https://github.com/omdsh-dev/DSH-better-sidebar.git ~/Code/DSH-better-sidebar
   cd ~/Code/DSH-better-sidebar && pnpm install && pnpm build
2. ~/.dsh/profiles/web/package.json 的 dependencies 写 "dsh-better-sidebar": "link:<克隆目录绝对路径>"
3. ~/.dsh/profiles/web/cordis.patch.yml 追加挂载行（同上）
4. 在 ~/.dsh/profiles/web 执行 pnpm install
5. 重启 DSH 并硬刷新

git clone https://github.com/omdsh-dev/DSH-better-sidebar.git && cd DSH-better-sidebar
pnpm install && pnpm build
node scripts/package-registry.mjs   # 组装 registry/ 暂存（含清单 + 产物 + README，不入库）
dsh registry install ./registry     # 安装（默认禁用）
dsh registry enable dsh-external/dsh-better-sidebar

⌨️ 快捷键

🔌 服务化：注册 tab 与文件预览器

从 v0.4.0 起暴露 ctx.betterSidebar 服务，其他插件可注册侧边栏页面与文件预览器（内置 7 tab + 9 viewer 也走同一服务，吃自己的狗粮）：

import type {} from 'dsh-better-sidebar'  // 触发 ctx.betterSidebar 类型合并
export const inject = ['betterSidebar']
export function apply(ctx: Context) {
  ctx.effect(() => ctx.betterSidebar.registerTab({
    id: 'my-plugin:db', title: 'Database', component: ({ scope }) => <DbView sessionId={scope.sessionId} />,
  }))
}

完整接入文档（TabDescriptor / FileViewerDescriptor 全字段、匹配算法、HMR 陷阱、声明式设置）：见 AGENTS.md。

🛠️ 开发与构建

pnpm install      # @deepseek-ai/* 已发布到 npm（^0.1.0-rc.6），直接解析、无需令牌
pnpm typecheck    # tsc --noEmit
pnpm build        # → lib/index.js + lib/invariant.js + lib/client.js + lib/client-registry.js + lib/types
pnpm test         # vitest（含 manifest 一致性守卫，需先 build）
pnpm watch        # tsdown --watch

架构：单 npm 包、host/client 双半结构——host（src/index.ts）：/sidebar/api/* JSON API、/sidebar/file 媒体路由、/sidebar/html 预览路由、/sidebar/ws/terminal WebSocket（fs / git / pty / 预览，全部会话级 + 信任围栏）；client（src/client/index.tsx）：portal 侧边栏 + 各视图 + 拦截；状态按会话持久化 localStorage。插件按 DSH 官方规范组织（无 default 导出、双 client bundle），运行期不依赖 npm / checkout（@deepseek-ai/* 由 web profile 提供）。

🔐 安全

• 路由受 Host 头信任围栏保护（与 /api 一致）；fs.write 原子写入；媒体/预览路由仅限会话 cwd 内文件；git 只调 CLI、绝不设置身份
• HTML 预览与浏览器 tab 的内容在不透明源沙箱 iframe 中渲染（无 allow-same-origin/allow-top-navigation、no-referrer、权限策略全禁）；/sidebar/html 路由带 CSP sandbox + 大小/路径边界；地址栏拒绝 javascript:/data:/file: 与 localhost 等本机地址
• 界面实时显示沙箱状态（关闭时红色警示），可临时解锁当前页面；设置页可按功能关闭沙箱（默认关闭该设置，带警告文案）——关闭后内容与界面同源，仅建议对完全可信内容使用

⚠️ 已知限制

• Git 无 push/pull/fetch；无文件 watcher（手动刷新）；工具行内文件打开按钮不可拦截
• 终端 Tab 拖到另一分栏会重挂载（shell 重开）
• .xlsx 预览不保留单元格样式（SheetJS 社区版限制）；Office/PPTX 预览内联进 client bundle（约 23MB），首次加载较慢
• 浏览器沙箱无登录态/第三方 Cookie 受限，部分站点登录需走弹窗；被 X-Frame-Options/frame-ancestors 拒绝嵌入的站点（如 arxiv.org）显示原因面板（含「在浏览器中打开」）；iframe 内部跳转不进后退栈
• HTML 预览渲染的是已保存文件（不反映未保存草稿）
• 移动端（<768px）无底部面板：进入窄屏时其标签页一次性并入右侧栏（迁移后回桌面仍保留在右侧栏），桌面端的底部面板只在宽视口下可用；移动端底部首展自动开终端不触发

🖥️ 平台支持

Windows / Linux / macOS 三平台适配（macOS 日常验证；其余经单元测试覆盖）；node-pty 优先预编译二进制，失败需编译工具链（Windows VS Build Tools / Linux make+g+++python3 / macOS Xcode CLT）。