dsh-data-agent README

The project's README from github.com/omdsh-dev/dsh-data-agent. As one markdown file: README.md.

DSH Data Agent · 用对话分析数据与商业洞察

中文 | English

DSH Data Agent Banner

Version   dshfind 小标   dshfind 下载量   Stars   npm   License

专为数据分析与商业分析人打造的 DeepSeek 智能数据分析助手
自然语言提问 · 自动编写执行 SQL · 智能图表与报告 · AI 辅助业务治理 · 深度商业洞察 · 本地安全只读

产品亮点 · 快速上手 · 使用场景 · 工作台与报告 · 支持数据源 · 安全与隐私 · 常见问题 · 开源协议

产品亮点

每次做数据分析,都要反复提需求写 SQL、手动导出 Excel 拼接加工、在多个图表工具里调格式?面对繁杂的库表和晦涩的英文缩写字段,业务含义无从查起?

DSH Data Agent 让数据分析回归业务决策本身:

DSH Data Agent 核心特性

快速上手

1. 运行环境准备

2. 快速安装

在终端执行以下命令直接从 npm 安装插件:

# 安装到 Web 界面(推荐)
dsh plugin --profile web add @yejiming/dsh-data-agent

# 或安装到终端命令行(dsh-tui)
dsh plugin --profile dsh-tui add @yejiming/dsh-data-agent

3. 开始分析

升级插件后首次启动会自动更新已识别的原版 data-agent 预设,使其兼容新版 DSH 必填的 persona.config.prefix,同时保留旧版 DSH 使用的 text。自定义过的预设不会被覆盖;若启动报 $.prefix missing required value,请备份 $DSH_HOME/.agent-presets/data-agent/agent.cordis.yml(默认位于 ~/.dsh),在 persona 的 config 中让 prefix 与原 text 使用相同提示词,再重启。

方式一:Web 界面(推荐)

启动 Web 控制台后,新建会话并选择 「数据模式」:

dsh --profile web
  1. 在新会话页点击 「数据模式」 旁的 「连接配置」,或进入会话后点击输入框右上角的 数据库图标,在弹出的工作台中填写连接信息(支持测试连接);
  2. 连接成功后,直接在对话框中用自然语言提出你的业务分析问题;
  3. 根据初步结论继续追问,AI 会沿着上下文层层下钻深挖。

方式二:终端命令行(dsh-tui)

适合键盘流与极客用户,在终端中快速连接并展开分析:

dsh --profile dsh-tui

在会话中输入 /preset data-agent 切换模式,输入 /database connect 连接数据库,即可开始提问。

使用场景

场景分类 提示词示例
📈 销售与营收复盘 "分析最近 30 天各渠道销售额与环比变化,找出下滑最明显的商品品类,并分析主要原因"
👥 用户画像与客群分层 "根据近半年的购买频次和客单价对会员进行 RFM 分层,统计各层级用户的留存率与复购周期"
🛒 运营转化与漏斗分析 "统计本月新用户从注册、搜索、加购到下单的各环节转化率,找出流失率最高的步骤"
📦 库存与供应链监控 "排查周转天数超过 60 天的高库存 SKU,结合近期销售速度预测断货或积压风险"
📑 周报 / 月报自动生成 "汇总上周核心业务指标(GMV、活跃用户数、客单价),生成一段适合汇报的管理层周报小结"

工作台与报告产物

1. 多功能数据库工作台

Web 界面内置一站式数据库工作台,包含 连接配置、库表浏览、数据治理 与 SQL 执行 四大功能模块,方便在对话之余随时查验数据资产。

数据库工作台

2. AI 辅助数据治理

在工作台中打开“数据治理”,AI 会自动扫描库表结构并生成直观的中文业务释义,支持逐项确认、删除与补充业务指标,告别“字段对齐全靠问同事”的尴尬。

AI 数据治理

3. 交互式离线分析报告

当分析需要可视化呈现时,Agent 会自动生成单图或多维 Dashboard,并自动在工作目录的 analysis-reports/ 目录下保存独立的离线 HTML 报告。包含丰富的指标卡、动态图表与明细数据表,无需网络即可随时双击打开或发送给同事。

分析报告图表

支持数据源

DSH Data Agent 广泛支持各类主流业务数据库、分析型数仓及本地文件:

安全与隐私

常见问题

Q: 我完全不会写 SQL,能用它做好数据分析吗? 完全可以!DSH Data Agent 专门面向非技术背景的业务人员与分析师设计。你只需用平时的业务语言描述需求,AI 会自动理解意图、查找对应的数据表、编写并执行准确的 SQL 查询,并将结果整理成通俗易懂的商业图表与结论。
Q: 连接生产数据库会不会有误删或误改数据的风险? 不会。我们建议连接时配置数据库只读账号并勾选“只读模式”。在只读保护下,任何写入、修改、删除(如 UPDATE, DELETE, DROP)等高危指令都会被严格拦截,保障生产数据绝对安全。
Q: 公司的数据库表名和字段都是缩写拼音/英文,AI 能看懂吗? 可以。你可以使用内置的“数据治理”功能,让 AI 结合表注释和字段上下文一键扫描生成业务释义,你也可以手动录入公司特有的术语和计算公式(如“净成交额 = 订单金额 - 退款金额”),AI 会在后续分析中自动采用这些经过确认的业务口径。
Q: 生成的分析报告如何分享给不使用 DSH 的同事或领导? 每次生成的图表报告都会在本地保存为独立的 .html 文件(位于 analysis-reports/ 目录)。该文件内置了所有图表样式与交互数据,无需安装任何软件或连接网络,直接通过微信、邮件或钉钉发送给同事,用任意浏览器双击即可全屏查看与交互。
Q: 如果对分析出来的图表或结论有疑问,可以继续追问吗? 当然可以!就像和真实的专业分析师沟通一样,你可以在当前对话中继续追问(例如“再帮我按省份拆解一下”、“把柱状图换成饼图”、“为什么华东区 5 月份环比下降了”),AI 会基于上一步的结果继续深入分析。

开源协议

本项目基于 MIT License 开源。

友情链接

dsh-data-agent (omdsh-dev/dsh-data-agent)

Searching Database…

What is this?DSH Data Agent is a DeepSeek Harness (DSH) plugin that lets you connect to your database and analyze data through natural-language conversation, automatically writing and running SQL, generating charts and dashboards, and surfacing business insights.
Is this a standalone app, or does it plug into something else?It is a plugin that runs inside DeepSeek Harness (DSH), adding a data-analysis mode you reach from the DSH Web console or its terminal UI (dsh-tui), not a separate program you run on its own.
How do I install and start using it?Install the plugin from npm in a terminal, then in the DSH Web console start a new chat, switch to Data Mode and configure the database connection, or in dsh-tui type /preset data-agent and /database connect to begin asking questions.
Do I need DeepSeek Harness already set up?Yes, it requires the DeepSeek Harness (DSH) runtime plus local or network access to the target database, whether a local SQLite file or a LAN/cloud database.
Is it safe to point this at a production database?Yes if you use a read-only setup: the project recommends a read-only database account with read-only mode enabled, which strictly blocks high-risk statements like UPDATE, DELETE and DROP.
Which databases can I connect to?It supports relational databases (MySQL, PostgreSQL, SQLite, Oracle, Microsoft SQL Server) and OLAP warehouses (ClickHouse, Apache Doris, Apache Hive, Apache Impala), plus local SQLite files that work out of the box without any server.
How do I share the charts it generates with people who don't use DSH?Each analysis can produce a self-contained offline HTML report saved under the analysis-reports/ folder, with charts and data tables built in, so anyone can open it in a browser without installing software or needing network access.
Can I use this if I don't know SQL at all?Yes, it's built for non-technical business users: you describe what you want in plain language and the agent finds the right tables, writes and runs the SQL, and returns readable charts and conclusions.
What does the built-in data governance feature do?It has the AI scan your tables and columns and auto-generate plain-language business definitions, which you can review, correct, or extend with custom metrics (like 'net revenue = order amount - refunds') for consistent future analysis.
What are similar projects?Chat2DB, dbx, usql, clearai-dsh, sqlit, mcp-toolbox, navop, redash
Creator
omdsh-dev
Size
17.1 MB
Stars
209
Age
2mo
Commits · 90 Days