dsh-code-rag-index-panel
Code RAG 语义索引面板与设置卡片:输入框上方的实时索引条(开始/全量重建/取消),以及一键检测与配置(Qdrant/Ollama/预设/ignore)。
安装
dsh plugin --profile web add dsh-code-rag-index-panel
沙箱测试
这个插件还没测过。提交测试 →
README
dsh-code-rag-index-panel
中文 | [English](README.md)
DeepSeek Harness 客户端插件:Code RAG 索引面板。
在会话输入框上方(conversation.input.dock 插槽)渲染一条索引状态条:
- 显示:当前根、索引状态、进行中任务的进度条(% / 文件 / 分块)、错误明细;
- 按钮:开始索引(增量)/ 全量重建 / 取消;
- 数据与按钮操作与 MCP 工具(
mcp__code_rag__*)同源,直连 code-rag 服务器的
本地 HTTP 端点(GET /api/status、POST /api/index、POST /api/cancel,
端口 8756 起自动探测 31 个端口)。
结构
dsh-code-rag-index-panel/
├── package.json # dsh.client 声明 + dsh.bundle.patch
├── cordis.patch.yml # 注册插件行(id/name 与包名一致)
└── lib/
├── index.js # host 半部(纯 UI 插件,空 apply)
└── client.js # 浏览器半部(ModuleLoader 格式,React + slots)
安装(随 code-rag 接入完成)
推荐:在 code-rag 仓库根目录运行 npm run setup(scripts/setup.mjs)——
它会自动把本插件以 file: 依赖写入 web profile(~/.dsh/profiles/web)并同步
已安装副本,路径无需手工指定:
"dependencies": { "dsh-code-rag-index-panel": "file:<code-rag 仓库>/plugins/dsh-code-rag-index-panel" },
"dsh": { "profile": { "bundles": ["@deepseek-ai/dsh-base", "@deepseek-ai/dsh-web-app", "dsh-code-rag-index-panel"] } }
发布到 npm 后也可直接 npm install dsh-code-rag-index-panel(版本依赖),
此时无需本地路径。仓库挪位置后重新运行 npm run setup 即可。
改完 profile 配置后重启 DSH 生效(dsh --profile web)。之后修改
lib/client.js 会被 client-hmr 轮询到并自动热更新(浏览器无需刷新)。
动态版本
../index-panel.client.js 是该面板的动态 Cordis 插件版(随会话存在,交给
cordis_define 使用);本包是常驻版,逻辑同一来源。
设置页卡片(v1.1.0+)
本包同时注册一张 Code RAG 设置与诊断卡片,在设置页两个位置出现(v1.4.0 起):
「插件」区(settings.plugin.item 槽位,新设置架构的插件卡片页)与「Web 插件」区
(web-ui.plugin.item 槽位,兼容层,宿主为 @linxin666/dsh-client-ui-web-ui-settings)。
新架构下的「插件」区卡片依赖宿主半部注册的 dsh-code-rag-index-panel 设置命名空间
(settings 服务 + schemastery,缺一即静默降级到仅「Web 插件」区显示)。卡片数据由
host 半部的环回端点提供(仅本机来源可访问):
端点 · 作用
GET /api/code-rag/diag · 一键诊断:索引服务器(端口/pid/当前根/各根向量数)、Qdrant(可达/集合)、Ollama(可达/模型)、模式预设(路径/dist 产物)、配置文件,附问题清单
POST /api/code-rag/config · 写 <root>/.code-rag/config.json(白名单键合并,原子写)
POST /api/code-rag/action · index / rebuild / cancel(代理到索引服务器)+ setup(在仓库执行 scripts/setup.mjs 重新生成预设)
卡片提供:重新检测按钮、状态绿灯/红灯、问题清单、配置表单(Qdrant/Ollama
地址、嵌入模型、维度、集合、端口、分块行数,root 可改)、开始索引 / 全量重建 /
取消 / 重新生成预设按钮。卡片外观与交互与家族其它插件(如「图像理解」)一致:
圆角卡片外壳(--dsw-alias-bg-layer-3,展开态 bg-layer-2)、可折叠头部
(chevron 旋转动画、aria-expanded 无障碍标注)、border-top 分隔的 body/footer、
主/次按钮样式。所有文件读写均容错,宿主端点缺失时卡片显示提示而非报错。
索引条显示范围开关(v1.2.0+):卡片提供「索引条显示范围」二选一——
仅 Code RAG 模式会话(默认,严格模式:索引条跟随 MCP 工具/检索能力,只在
Code RAG 模式会话出现)或所有会话(任意会话都能对当前工作区直接索引)。
选择写入 DSH 设置(settings.yaml 的 dsh-code-rag-index-panel 命名空间,
strictIndexBar: false 即所有会话),立即生效,无需重启。
界面中英双语(v1.3.0+):索引条与设置卡片跟随页面语言
(<html lang>)自动切换中英文。
选模式即现索引条(v1.4.0+):索引条可见性以「会话预设是否为 Code RAG 模式」
为准(订阅会话列表,preset 落地即重渲染)——
用户选了 Code RAG 模式、尚未发消息时索引条立即出现,显示「正在启动索引服务器…」,
绝不自动开始索引(开始/全量重建按钮在服务器就绪前禁用,就绪后由用户手动触发,
避免误选模式直接占用本机资源)。
显示范围严格按模式判定(v1.4.1):严格模式(默认,仅 Code RAG 模式会话)下
索引条只按会话预设判定,服务器在线与否不影响显示范围——code-rag 服务器由某个
Code RAG 会话拉起后会常驻(切到其它模式会话时仍在运行),旧版「服务器在线兜底」
会让所有模式都显示索引条,现已移除;「所有会话」模式行为不变。
稳定性修复(v1.4.0):settingsScope 命名空间未注册/尚未加载时 getSnapshot().value
为 undefined,旧代码直接读 .strictIndexBar 抛 TypeError,导致索引条/设置卡片槽位
崩溃后 abdicate(本轮起永久隐藏,直到刷新/重启)。现在 undefined 视为「未设置」→
严格模式默认,同时命名空间注册后 value 走正式 schema,读写均校验。
host 半部自检:node scripts/selftest-panel.mjs(mock ctx 驱动,不依赖真实
服务器,不写用户目录);client 半部加载自检:node scripts/selftest-client.mjs
(mock 浏览器环境执行整个 bundle,验证槽位注册与 disposer)。
发布到 dsh-market
dsh-market 的插件目录来自 awesome-dsh-plugin
策展注册表(安装来源仅限该注册表),上架流程(以该仓库
为准):
1. 发布 npm 包(可选但推荐:市场可展示下载量,安装免构建授权)
cd plugins/dsh-code-rag-index-panel npm login # 首次:npm 账号 npm publish # 版本号在 package.json(当前 1.1.0)
配套 MCP 服务器包 @aylina_ankali/code-rag-mcp(仓库根目录)同样可 npm publish --access public;
市场条目只收录本面板插件,服务器作为其依赖在 README 说明。
两个包的 repository 字段已指回本仓库(市场据此关联,手写 npm: 键会被校验拒绝)。
2. 向 awesome-dsh-plugin 提交 PR(一个条目)
在 awesome-dsh-plugin 仓库新增 一个文件 data/plugins/Ankali-Aylina__code-rag--plugins-dsh-code-rag-index-panel.yml
(monorepo 子包:url 指向子目录,name 用 owner/repo#subname):
url: https://github.com/Ankali-Aylina/code-rag/tree/main/plugins/dsh-code-rag-index-panel name: Ankali-Aylina/code-rag#dsh-code-rag-index-panel category: dev description: en: 'Code RAG semantic index panel and settings card: live index bar with start/rebuild/cancel, plus one-click detection and configuration.' zh: 'Code RAG 语义索引面板与设置卡片:输入框上方的实时索引条(开始/全量重建/取消),以及一键检测与配置(Qdrant/Ollama/预设/ignore)。'
提交后在该仓库运行 npm ci && node scripts/generate-readme.mjs 重新生成两个 README,
与本 YAML 一起提交(README 由脚本生成,禁止手改)。
收录门槛(CI 自动检查,提交前自查)
- ✅ 仓库
package.json声明dsh.bundle(本插件已声明"bundle": { "patch": "./cordis.patch.yml" },
且位于 plugins/ 子包目录——CI 只认仓库根或 packages/·plugins/·apps/ 子包)
- ⏳ 仓库创建满 1 天且提交数 ≥ 10(当前不足,继续完善功能/文档凑够后提交;重提不影响评审)
- ✅ 真实可用代码、描述属实、活跃维护、
category从注册表取值(dev不合适维护者会直接改) - 📌 为 GitHub 仓库添加
dsh-plugintopic(仓库 Settings → Topics)
截图(已提供)
本插件已在 screenshots.json 声明两张市场截图(assets/settings-card.png
设置页卡片、assets/index-bar.png 输入框索引条);更换截图只需推送本仓库,
市场下一次构建自动生效。
以上内容来自 npm 上的 README,我们只做格式化,不改内容。
版本
npm 上共发布:4,最后更新 2026-08-29