dsh-hooks-plugin

中文 | English

为 DeepSeek Harness 提供 Claude Code 风格的 hooks：在智能体 / 工具生命周期事件上运行 shell 命令，配置来自 .dsh/hooks.json（与 Claude Code hooks 兼容的 JSON 结构）。

产品名是 dsh-hooks；npm / GitHub 包名是 dsh-hooks-plugin（dsh-hooks 已被占用）。运行时 API 与日志路径沿用 dsh-hooks 名：~/.dsh/logs/dsh-hooks/dsh-hooks.log 与 GET /dsh-hooks/recent（见下）。

目录

• 特性（v1）
• 安装
• 配置示例
  • hook 字段 schema
• CC 兼容边界
• stdin / stdout 协议（CC 兼容）
• 开发 / 验证
• 明确不做（边界）
• License

特性（v1）

• 四层配置：全局 ~/.dsh/hooks.json → 预设 <preset-dir>/hooks.json → 项目 <项目根>/.dsh/hooks.json → 项目本地 .dsh/hooks.local.json。
• CC 兼容 schema 与协议：matcher[] + hooks[] 结构、stdin JSON 输入 / stdout JSON 决策输出，可复用现有 Claude Code hook 脚本。
• 去重规则对齐 CC 2.1.88 hookDedupKey：command = shell+command+if、http = url+if、prompt/agent = prompt+if；同一 key 跨层只执行一次，最后合并层胜出；callback/function 不去重。
• matcher 语义对齐 CC matchesPattern：* 全匹配、A|B 管道精确匹配、其余按正则；if 条件支持权限规则语法（Bash(git *)、Read(*.ts)）。
• 事件：PreToolUse / PostToolUse / PostToolUseFailure / UserPromptSubmit / SessionStart / SessionEnd / Stop / SubagentEnd。
  • PreToolUse 决策 deny → 官方工具失败卡片（模型看到 Error: <reason>）。
• 子代理：默认触发，输入载荷携带 agent_id / agent_type / delegation_depth；可用 subagents: false 关闭；命令在触发者自己的沙箱上下文执行。
• 热重载：项目配置改动自动重新加载（fs.watchFile），无需重启。
• 免重启热升级：安装 dsh-hot-installer 后，dsh plugin --profile web add <包>@<新版本> 当场生效，无需重启。
• 浮动控制台按会话隔离：shell.overlay 上的 🔌 Hooks 浮动控制台只显示当前正在查看的会话的 hooks（含该会话子代理触发的记录，带 subagent·dN 角标，行内显示触发工具名）；切换会话即随之更新，头部显示 会话·<标题>。
• 最近记录持久化：每条 hook 记录写入 recent.jsonl（限 200 条，DSH_HOOKS_RECENT_MAX 可调），插件热升级/进程重启后自动回填——控制台不丢最近历史。
• 日志轮转：~/.dsh/logs/dsh-hooks/dsh-hooks.log 超过 1 MiB（可用 DSH_HOOKS_MAX_LOG_BYTES 调整）自动滚动为 .1 并续写新文件，不会无限增长。
• 交付形态：profile bundle（cordis.patch.yml 自动插行），用 dsh plugin --profile <p> add 安装。
• 随包自带手册：docs/CONFIGURATION.md（配置 / 协议 / 边界全讲清）随 npm 包装入——装完的 agent 可直接 read 它，不必翻源码猜协议。
• 自动注册作者技能：apply() 把包内 skills/dsh-hooks-authoring 注册进技能注册表（global 层），任意 agent 装完即在其 skill 目录看到 dsh-hooks-authoring；加载即得「四条钉死事实 + 配置/决策 JSON + Windows/沙箱边界」索引，深度问题读随包手册。

安装

# 从 npm 安装（当前 latest 0.2.14）
dsh plugin --profile web add dsh-hooks-plugin

# 或本地打包
npm pack
dsh plugin --profile web add ./dsh-hooks-plugin-0.2.14.tgz

安装后新会话自动生效；已有（存活）会话也会生效——插件 apply() 会遍历 agents 注册表为已存活会话补线，因此同进程热装/热升级后无需新建会话；进程重启后继续旧会话同样随 agent 重建自动重新接线（agent/created）。已断开的会话不存在的场合只有一种：进程重启后未重新打开旧会话。

给 agent / 写 hook 的人：装完先 skill dsh-hooks-authoring（自动注册，加载即得作者指南），深度看安装包内 docs/CONFIGURATION.md——两者都随包分发，不用碰源码。

配置示例

<项目根>/.dsh/hooks.json：

{
  "PreToolUse": [
    {
      "matcher": "Read|Write|Edit",
      "hooks": [
        {
          "type": "command",
          "command": "echo hook triggered",
          "timeout": 5
        }
      ]
    },
    {
      "matcher": "Read",
      "hooks": [
        {
          "type": "command",
          "command": "node -e \"process.stdout.write(JSON.stringify({hookSpecificOutput:{hookEventName:'PreToolUse',permissionDecision:'deny',permissionDecisionReason:'blocked'}}))\"",
          "if": "Read(*private*)",
          "timeout": 5
        }
      ]
    }
  ]
}

hook 字段 schema

每条 hook 是一个对象，type 决定判别联合（对齐 CC 2.1.88 schemas/hooks.ts）。

command / prompt / agent / http 公共字段

type: "command" 专用

type: "http" 专用

type: "prompt" / type: "agent" 专用（v1 不做，schema 对齐 CC）

matcher 结构

{
  "<Event>": [
    { "matcher": "<模式>", "hooks": [ <hook>, ... ] },
    ...
  ]
}

事件 key 限 CC 27 事件名；v1 实际接线：PreToolUse / PostToolUse / PostToolUseFailure / UserPromptSubmit / SessionStart / SessionEnd / Stop / SubagentEnd。

CC 兼容边界

与 Claude Code 的兼容只停留在"配置结构延续 CC 形状 + 协议能自洽表达决策"；不搬运 CC 专属协议面：

• ✅ 配置结构（matcher[] + hooks[]、if、shell、timeout、statusMessage、once）、stdin JSON 输入 / stdout JSON 决策输出、去重键语义 —— 延用，方便理解与迁移。
• ❌ 不注入 CC 专属环境变量（CLAUDE_PROJECT_DIR、CLAUDE_PLUGIN_ROOT 等）——项目根已在输入 JSON 的 cwd 字段，且 DSH 没有插件/技能目录可指向。
• ❌ 不做 ${CLAUDE_PLUGIN_ROOT} 字符串替换、CLAUDE_PLUGIN_OPTION_*、CLAUDE_ENV_FILE 等插件体系机制。
• DSH 内部决策直接消费 waterfall 返回值，stdout JSON 只是让命令 hook 自己表达决策（如 deny）的协议手段，不是"按 CC 输出解析"。

stdin / stdout 协议（CC 兼容）

输入（命令 stdin 单行 JSON）：

{
  "session_id": "...",
  "cwd": "F:\\project",
  "hook_event_name": "PreToolUse",
  "tool_name": "read",
  "tool_input": { "path": "..." },
  "tool_use_id": "...",
  "agent_id": "<仅子代理>",
  "agent_type": "<仅子代理>",
  "delegation_depth": 0
}

输出（stdout JSON 决策）：

{
  "hookSpecificOutput": {
    "hookEventName": "PreToolUse",
    "permissionDecision": "allow | deny | ask",
    "permissionDecisionReason": "denied by ...",
    "additionalContext": "..."
  }
}

开发 / 验证

• 纯函数单测：node --test test/
• 热装验证（免重启）：dsh-hot-installer 已安装时，dsh plugin --profile web add <包>@<新版本> 当场生效。
• 文件日志：~/.dsh/logs/dsh-hooks/dsh-hooks.log；最近记录：GET /dsh-hooks/recent。

明确不做（边界）

不实现卸载生命周期、悬空行提醒、会话级配置档、PreCompact/PostCompact、prompt/agent 型 hook、设置页。配置的生命周期 = 它所在目录的生命周期；若某预设报 Cannot find package，通常是该插件包已卸载而预设行仍在，请手动移除对应行或删除预设目录。

License

MIT