hezi2020/dsh-plugin-wiki--plugins-DSH-better-sidebar0

dsh-better-sidebar

DSH web plugin: a VSCode-like right sidebar (explorer / editor / terminal / git / browser), isolated per conversation session. Exposes a service for other plugins to register sidebar tabs and file viewers.

AI Analysis

核心用途是为 DSH 引入多功能右侧栏和底部面板,实现会话隔离的完整开发工作流。适合需要在 AI 辅助下直接进行文件编辑、终端执行和 Git 提交的开发者。必要条件是 Node.js >= 20。

Package
dsh-better-sidebar
Version
0.10.0
License
MIT
Last updated
Aug 14, 2026

Install

This plugin has no verified bundle, or compatibility checks failed. Read the repository notes first. Read the full README ↗

dsh-better-sidebar

一个插件,一套完整工作台

文件管理 编辑预览 内嵌浏览器 真实终端 Git 面板 后台任务页

右侧栏 + 底部面板双工作台,一个插件全部搞定。

支持 Tab 窗口随意拖拽,支持三方拓展注册新 Tab 页面和文件预览

🌏 中文 · English

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

6c4293e1bec2e935031bf0e986d6ec65

✨ 功能一览

  • 🗂️ 资源管理器:懒加载目录树(根 = 会话 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 一键折叠
  • 📱 移动端:视口 " b. ~/.dsh/profiles/web/cordis.patch.yml 追加: - insert: - id: better-sidebar name: 'dsh-better-sidebar'
  1. 在 ~/.dsh/profiles/web 执行 pnpm install
  2. 重启 DSH 并硬刷新(Cmd/Ctrl+Shift+R)验证

> 安装 = 依赖登记(等价 `dsh plugin --profile web add link:`)+ 一行挂载行。**DSH 以 npm 包启动(如 `npx -p @deepseek-ai/dsh@0.1.0-rc.6 dsh web`)同样可用**(v0.4.3 起实测验证)。

### 通过 npm 安装(推荐)

插件已发布到 npm:**`dsh-better-sidebar@0.10.0`**(`@deepseek-ai/*` 依赖已对齐宿主实际版本 `^0.1.0-rc.6` / `@deepseek-ai/cordis@^4.0.1`,同版本单实例)。挂载仍走 profile + `cordis.patch.yml`,只是依赖来源换成 npm 包:

```text
1. ~/.dsh/profiles/web/package.json 的 dependencies 写 "dsh-better-sidebar": "^0.10.0"
2. ~/.dsh/profiles/web/cordis.patch.yml 追加:
   - insert:
       - id: better-sidebar
         name: 'dsh-better-sidebar'
3. 在 ~/.dsh/profiles/web 执行 pnpm install
4. 重启 DSH 并硬刷新(Cmd/Ctrl+Shift+R)验证

更新:改版本号(如 ^0.10.1)→ pnpm install → 重启。若 profile 的 pnpm 因 minimumReleaseAge(发布 `。

更新

1. cd ~/Code/DSH-better-sidebar && git pull && pnpm install && pnpm build
2. 核对注册仍有效(缺失才补):profile package.json 的 link: 依赖 + cordis.patch.yml 挂载行
3. 仅 client(src/client/*)→ 硬刷新即可;含 host(src/index.ts、src/config.ts 等)→ 重启 DSH + 硬刷新

通过 plugin-registry 安装(可选,与上述二选一)

前置:DSH 已集成 plugin-registrydsh registry 可用)。同时启用两个通道会双挂载(Node 半挂两次、页面两个侧边栏)。

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

更新:git pull && pnpm install && pnpm buildnode scripts/package-registry.mjsdsh registry uninstall/install/enable。切换通道前先移除另一通道的挂载。

⌨️ 快捷键

操作按键
保存编辑Ctrl/Cmd + S
Git 提交Ctrl + Enter
关闭 Tab鼠标中键
拆分/合并分栏拖 Tab 到分栏边缘 / 中间
引用文件到输入框悬浮行尾 @文件 按钮
复制文件路径右键行 → 复制相对/绝对地址

🔌 服务化:注册 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 }) => ,
  }))
}

完整接入文档(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-navigationno-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)。