前言¶
在 DSH 里装多个「深鲸守护」类守卫插件时,每个插件各自有一条 CLI、各自一份报告。交材料或做上线前自查时,往往需要的是一份能一眼看完的结论:哪一块有问题、几处、依据是什么、文件在哪一行。逐个执行 dsh-cn-mlps、dsh-cn-log-retention 等命令,既费时,也不利于 CI 卡口。
dsh-guard-suite(npm 包名 @deepwhale-cn/dsh-guard-suite)定位是体检编排器:把你已经装好的守卫插件规则集合起来,一次扫描、一份按插件分组的报告。它自己不携带判据,规则全部来自本机已安装的 dsh-* 守卫插件。
维护者 feely0208,GitHub 仓库 feely0208/dsh-guard-suite。社区目录页:skillhub.cn 上的 dsh-guard-suite。分类为工作流。
这是什么、不是什么¶
是:编排器。发现本机可用的守卫插件规则,对指定项目根目录跑一遍适用检查,输出分组汇总(终端、JSON、HTML 等)。
不是:新的判据库。README 明确写「自己一条规则都没有」;找到几个已装插件就跑几个,没装的不会参与体检。
核心功能¶
下面介绍资料中已写明的能力。
- 一键体检:相对「以前一条条跑各插件 CLI」,用
dsh-guard-suite --root ./my-app一次完成,报告按插件模块分组。 - 列出已发现插件:
--list-plugins用于确认「装全了没」。 - 输出格式:默认终端报告;
--json供 CI 或文档生成;--html 体检.html生成可存档的 HTML。 - 范围控制:
--only cn-mlps,cn-log-retention只跑指定块;--skip cn-crypto跳过某块。 - CI 卡口:
--fail-on medium调整失败阈值(默认high);退出码 0/1/2 见下文。 - 规则发现(本地、不联网):按顺序使用
--rules-from <目录>、与本插件同级的dsh-*目录、node_modules/@deepwhale-cn/dsh-*、环境变量DSH_GUARD_PLUGINS(冒号分隔)。 - 报告语义:0 命中的插件仍会显示,以区分「查了没问题」和「压根没查」;不适用的规则单独列出,区分「没跑」与「跑过且通过」。
- 无规则源时硬失败:若未发现任何守卫插件规则,以 exit 2 报错退出,避免「一条规则都没跑」却看起来像全绿。
插件不联网、不上传代码、不下载规则;不替代等保测评、监管检查或第三方审计,只报事实与依据。
安装与启用¶
安装命令来自仓库 README(profile 为 web 时需与你的工作流一致):
dsh plugin --profile web add @deepwhale-cn/dsh-guard-suite
编排器只调度已安装的守卫插件;需要检查的模块需自行安装,例如:
dsh plugin --profile web add @deepwhale-cn/dsh-cn-mlps
package.json 标明:Node >=18,DSH 引擎 >=0.1.0-rc.6 <0.3.0,许可证 MIT,当前版本 0.1.0。
典型用法¶
先看本机能被编排器发现的插件:
dsh-guard-suite --list-plugins
对项目根目录做体检:
dsh-guard-suite --root ./my-app
CI 或自动化可读 JSON:
dsh-guard-suite --root ./my-app --json
需要截图或归档时生成 HTML:
dsh-guard-suite --root ./my-app --html 体检.html
只跑或跳过部分模块:
dsh-guard-suite --only cn-mlps,cn-log-retention
dsh-guard-suite --skip cn-crypto
在流水线里按严重级别失败:
dsh-guard-suite --root ./my-app --fail-on medium
README 中的报告示例结构包括:已装插件数与规则数、实际检查条数、命中统计(高/中/低),以及「按插件」分组与「不适用」规则列表。
退出码¶
| 码 | 含义 |
|---|---|
| 0 | 没有达到 --fail-on 的命中 |
| 1 | 有达到阈值的命中(可挂 CI) |
| 2 | 参数错误,或一个规则源都没发现(不当作全绿) |
适用场景与注意¶
适合:已安装多个深鲸守护类 dsh-* 插件的团队,需要在本地或 CI 做一次汇总扫描;需要等保自查、上线检查、合规材料前的「一条命令总览」时。
注意:
- 体检覆盖面取决于你实际安装了哪些守卫插件;编排器不会替你下载或补齐规则。
- 与所有 DSH 插件一样,扫描以当前
dsh进程权限读取项目文件;安装前请查看源码与 MIT 许可证,确认符合组织策略。 - DSH 社区插件目录(如 skillhub.cn、dsh-plugin.org)为独立生态站点,与 DeepSeek / 幻方无官方从属关系;本文事实以 GitHub README 为准。
README 称该产品属于「深鲸守护」编排与交付线中的「一键体检」插件,与同系列各「一个插件查一件事」的守卫插件配套使用;更多系列说明见 deepwhale.org.cn/guard.html。
结尾¶
dsh-guard-suite 解决的是「多份单插件报告难以汇总」的问题:一条命令跑完本机已装守卫的适用检查,按模块给出总报告,并区分未安装、未适用与已检查无命中。目录页:https://www.skillhub.cn/plugins/feely0208/dsh-guard-suite;源码与用法细节:https://github.com/feely0208/dsh-guard-suite。