Skip to content

dsh-databoard

Verified

dsh-databoard · v0.4.2 · MIT · Web UI

Browse dashboards built from your local data and filter them by tag; create, edit and tag them in the conversation.

Install

dsh plugin add dsh-databoard

Confirm the layer applied with dsh --profile default --dump-config — see the install guide.

Source

Tags

Creators

Readme

dsh-databoard

DSH 视图与报表插件。数据源(本地 SQLite / CSV / Excel .xlsx 导入)→ 可复用 SQL 视图 → Evidence 渲染的报表;页面只做「看板列表 + 右侧详情栏」,新建/编辑在 DSH 对话中完成,数据源与导入由 Agent 工具维护。v0.3 起报表与 Evidence 页面能力对齐:任意组件、Row/Stack/Tabs 布局、多页报表、页面 frontmatter 设置、项目级 partials、一等输入组件,以及 Evidence 原生页面校验。

安装

dsh plugin --profile <name> add dsh-databoard

Evidence 运行时(只读 SQLite 连接器 fork)随插件从 npm 安装:本包的 optionalDependencies 固定五个平台包 dsh-databoard-runtime-<platform>-<arch>(各带 os/cpu),pnpm 只安装与当前机器匹配的那一个,安装后无需 再联网下载或本地构建。解析顺序:config.evidenceBinary → DATABOARD_EVIDENCE_BINARY → PATH 中的 evidence/evd → 已安装的 npm 平台包(校验包内 sha256)→ 仓库构建产物;只有显式配置 allowRuntimeDownload: true 时才从 GitHub Release 下载。构建方法见仓库 scripts/build-evidence.mjs / docs/install.md。

Evidence 运行时随插件自动启动(autoStart 默认 true);没有 web 路由载体的 headless profile 不会启动,可用 autoStart: false 显式关闭。

配置

- id: databoard
  config:
    root: !!js dshHomePath('databoard')
    # evidenceBinary: /path/to/evidence   # 仅覆盖 npm 平台包/PATH 时使用
    autoStart: true            # 随插件自动启动 Evidence 运行时(headless 不启动)
    allowFrames: true          # 本机 iframe 浏览
    queryRowLimit: 1000
    queryTimeoutMs: 15000
    datasourceAllowlist: []    # 空 = 允许任意本地 SQLite
    allowRuntimeDownload: false # 仅显式开启时才从 GitHub Release 下载(校验 sha256)

界面

  • 原生 DSH:主栏 Databoard /「数据看板」页面 + 侧栏入口(main + sidebar.panellist)。
  • qwatt:qwatt.page + qwatt.nav.private-data(槽位存在时自动注册)。
  • 页面只有两个功能:看板列表 + 右侧详情栏(单行标签筛选条、搜索、行内标签与行内操作;详情栏为 Tasks 同构的 tabs + 标题/摘要/标签/元信息 + 内容区,分栏可拖拽;新建/编辑交给 DSH 对话,删除在页面内用原生确认框)与右侧详情栏(标题/摘要/标签/元信息 → Evidence 页面 tabs → 内容区,分栏可拖拽,iframe 承载 Evidence)。
  • 浏览 URL:http://127.0.0.1:<port>/<page-slug>?fullscreen&embed&theme=<light|dark>(多页报表顶栏可切换页面,稳定预览 URL 支持 &page=<slug>);?fullscreen 去掉 Evidence 自带侧栏/顶栏,?embed 去掉演示模式的浮动退出按钮,?theme 让看板跟随 DSH 明暗。
  • 页面由 shell 的 @deepseek-ai/dsh-client-ui-primitives 原生组件构成(960px 原生列表、Modal/Toast/Menu/图标),没有数据源/导入 Tab、编辑器或运行时启停/状态 UI。
  • 运行时:插件自动启动;浏览页轮询 /runtime/status,失败时显示错误并可重试;framing 被拒时提供「在浏览器打开」。

HTTP API(/api/databoard)

GET /health、GET /state;POST /datasources/{create,scan,remove}、/views/{upsert,remove,preview}、/reports/{upsert,remove,validate,tags}、/partials/{upsert,remove}、/runtime/{start,stop,restart,ensure}、/import(multipart CSV/.xlsx 或 text/csv);GET /runtime/status、GET /preview?report=<id>&theme=<light|dark>[&page=<slug>]。错误统一 { error: { code, message } }。

导入的 .xlsx 由内置的无依赖读取器解析(仅 node:zlib):读取第一个工作表,日期单元格归一化为 ISO 字符串;旧二进制 .xls 不支持,请另存为 .xlsx 或 CSV。

Agent 工具与技能

15 个工具:databoard_list_sources、databoard_add_datasource、databoard_import、databoard_scan_source、databoard_preview_query、databoard_list_reports、databoard_upsert_view、databoard_upsert_report、databoard_set_tags、databoard_set_report_meta、databoard_upsert_partial、databoard_remove_partial、databoard_validate_report、databoard_refresh_preview、databoard_status。数据源注册与 CSV/Excel 导入只有工具入口(页面没有数据源/导入 Tab);bundled 技能 databoard-reports 驱动整条流程,并记录 Evidence 页面/组件/输入/partial 的作者指南。

安全

SQLite 只读 + 单语句白名单(select/with/explain)+ 行数上限 + 超时;仅监听回环;connection.yaml 不落凭证;数据内容按数据处理(防提示注入)。

License

MIT