dsh-connect
Verifieddsh-connect · v1.0.14 · MIT · Web UI
All-in-one DeepSeek Harness (DSH) chat bridge: one plugin, one config block — Feishu/Lark, Telegram, DingTalk, and Web mirror adapters plus the web-settings pane, all behind a channels[] selector
Install
dsh plugin add dsh-connect Confirm the layer applied with dsh --profile default --dump-config — see the install guide.
Source
Tags
Creators
Readme
dsh-connect
English | 中文
多合一插件,将 DeepSeek Harness(DSH)智能体连接到聊天平台(飞书 / Lark、Telegram、钉钉,以及 Web 镜像,更多平台陆续到来):会话绑定、智能体驱动、流式回复桥接、交互式菜单卡片、本地命令,以及 Web 设置栈。
一次安装、一份配置:核心
connect服务、全部通道适配器(feishu / telegram / dingtalk / web)以及 Web 设置栈都内置在这个包里。通过channels选择器启用你要用的通道。此前的拆分包(dsh-connect-feishu、dsh-connect-telegram、dsh-connect-dingtalk、dsh-connect-web)与dsh-connect-all合集已不存在。
概述
dsh-connect 将聊天会话绑定到 DSH 智能体会话并端到端驱动它:
- 会话绑定与路由 —— 一个聊天 ⇄ 一个智能体会话,持久化保存在
bindings.json路由存储中;会话可以创建、恢复、切换、清除,并镜像到 DSH Web GUI。 - 流式回复 —— 模型的实时增量被桥接到渠道的原生流式能力(飞书打字机卡片):思考提示开启推理阶段,推理内容带可读的段落分隔实时流出,工具调用显示为
🔧进度行,心跳保活机制即使在长时间静默时(首个 token 等待过长、密集工具运行)也会让卡片保持更新,绝不会一直卡在「思考中…」。runner 保持两路订阅,因为0.1.5-rc.2把原本合二为一的东西拆开了:持久的session/event流承载回合、工具与结算,瞬时的agent/assistant-stream帧承载模型增量 —— 过去同时承载两者的assistant/chunk会话事件已被删除。 - 通知级别 —— 按聊天控制过程流式的详细程度:
尽量输出过程(完整过程)/输出重要节点(关键节点)/只输出结果(仅结果)。只有尽量输出过程会发送重复的状态行;两个更安静的级别只发送离散事件(见下表)。可随时通过设置菜单或/notify切换;选择按聊天持久化并立即生效。级别 思考提示 推理正文 工具调用行 心跳保活 5 分钟进度提醒 最终回答 尽量输出过程full一次 实时流出 实时流出 按定时器发送 发送,带步数 实时流出 输出重要节点important一次 不发送 不发送 不发送 发送,带步数 任务结束时整段发送一次 只输出结果result(默认)不发送 不发送 不发送 不发送 发送,带步数 任务结束时整段发送一次
心跳保活是重复的「还在跑」噪音,因此只有 full 会收到;5 分钟进度提醒是你用 progressTimeoutMs 主动配置的状态汇报,因此在所有级别都会执行——设为 0 即可全局关闭。两者都是就地编辑流式卡片,不会新增气泡。
- 上下文自动压缩 —— 可选,默认关闭。开启
autoCompact后,一轮任务结束时若上下文占用达到autoCompactThresholdPct(默认 80%),会自动压缩会话,长时间无人值守的任务不会因窗口占满而中断。任务结束卡片会说明当前生效的是哪条规则。可用/autocompact on|off|<1-99>按聊天开关。 - 任务结束统计 —— 每个任务结束后,一张紧凑卡片报告所用模型、输入/输出 token、耗时与上下文窗口占用百分比,并在上下文接近占满时建议
/compact(开启自动压缩后改为提示该规则)。 - 交互式菜单 —— 状态、任务、历史、目标、日程、模型/努力度切换、工作区选择、语言等按钮卡片(参见聊天内的
/命令)。 - 媒体处理 —— 下载用户图片/附件,并将其交给支持视觉的模型(或已配置的视觉模型),使纯文本主模型不会因图片而卡住。
- 锁与队列 —— 按聊天的写锁协调飞书与 Web 的写入方;锁释放后排队消息自动处理。
- Web 镜像(自动) —— 每个飞书会话都会自动作为镜像会话出现在 DSH Web GUI 中(可通过
autoMirror: false关闭)。
适用人群 —— 任何运行 DSH 并希望从聊天平台操作智能体的人:为自己工作区运行机器人的个人用户,以及通过白名单在群聊中共享机器人的小团队。
兼容性
| 方面 | 值 |
|---|---|
| DSH 版本 | ^0.2.0-rc.2(peer @deepseek-ai/dsh-agent、dsh-llm、dsh-session) |
| Cordis | ^4.0.1 |
| Node.js | ≥ 20(ESM,NodeNext) |
| 最后验证 | 2026-10-02,在 Windows 上针对 DSH 0.2.0-rc.2 验证(宿主加载、飞书 WebSocket 传输、Web 设置面板) |
peer 版本线必须与宿主保持同步。 上游不提供 changelog 或迁移说明,因此过期的版本范围是插件与静默损坏之间唯一的屏障:DSH 0.1.5-rc.2 直接删除了 Session.events 访问器和 assistant/chunk 事件类型,而所有 dsh-* 包共用同一条版本线。升级 DSH 时,请把 dsh-agent、dsh-llm、dsh-session 的 peerDependencies(以及 devDependencies)一起上调,重新运行 tsc,并重跑测试套件 —— 当版本范围与宿主版本不再有交集时,就是桥接需要再次迁移的信号。
DSH 会拒绝加载版本范围覆盖不到自己的插件,所以过期的范围至少是响亮的:在 0.2.0-rc.2 上安装 0.9.0 会在任何代码运行之前被拒绝,并提示 “可能导致崩溃或数据丢失”。覆盖 0.2.0-rc.2 的版本是 0.9.3,见从 0.9.0 升级。
插件运行在 DSH Host 平面(进程级单例服务)上,而不是在智能体预设内部。
安装 / 卸载
插件管理是 DSH profile 中对 pnpm 的轻量封装:
# 安装唯一的多合一插件(核心 + 全部通道适配器 + Web 设置)
dsh plugin --profile web add dsh-connect
升级
dsh plugin --profile web update dsh-connect
禁用 —— 在 profile patch 中将 bundle 注册的条目覆盖为 disabled: true(参见 ~/.dsh/profiles/<profile>/cordis.patch.yml):
- id: connect
name: dsh-connect
disabled: true
彻底移除 —— 卸载软件包并删除它产生的数据:
dsh plugin --profile web remove dsh-connect
# then remove the plugin data (see "Permissions & data" below):
rm -rf .dsh-connect # binding route store (stateDir)
rm -f ~/.dsh/.dsh-connect/feishu-credentials.json
在桌面端安装
桌面端持有自己的保留 profile(desktop),并且只能从它自己的界面里安装:dsh plugin --profile desktop … 会被拒绝,报 profile "desktop" is managed exclusively by the
Electron application —— 该 profile 只允许由应用自身的载体管理。在应用里,安装入口是侧边栏中
名为「插件」的面板(侧边栏面板列表的第一项),其标题栏按钮**「添加插件」**用来填包名;装完后
应用会提示更改将在下次启动生效。
「设置」里没有这个入口。 设置里是两个只读页——「内置插件」(内置部署的插件列表及运行 状态)与**「插件列表」**(会话插件 / 全局插件)——这也正是「插件」页自己的说明所指向的地方: 内置插件列表及运行状态可在「设置 → 内置插件」中查看。
dsh-connect 自己的页面(设置 → dsh-connect)只有在插件真的被安装并加载之后才会出现,所以
一次被拒绝的安装之后,那里本来就什么都找不到。
安装落到旧版本怎么办
pnpm 12 的两个行为会咬住全新安装,而且看起来都像在骗人:桌面端插件列表给出的是最新版,落到磁盘
上的却是上一版;或者安装以 ERR_PNPM_IGNORED_BUILDS 结束,但依赖仍然写进了 package.json。
- pnpm 内置的 24 小时发布冷静期。
minimumReleaseAge默认 1440 分钟,且是非严格的: 裸写add dsh-connect会解析到发布满 24 小时的最后一版。桌面端显示版本号用的是一次查询 而非安装,不受该策略约束——所以每次发布后的一天里,两者确实会不一致。 - 构建脚本未决。 经
@larksuiteoapi/node-sdk带进来的protobufjs带有一个构建脚本, pnpm 12 在你做出决定前拒绝执行它;而它是在写完依赖之后才报错的,所以失败看起来像 「装了一半」。
在 profile 的 pnpm-workspace.yaml($DSH_HOME/profiles/web/pnpm-workspace.yaml;Windows 上
桌面端的 profile 是 %USERPROFILE%\.dsh\profiles\desktop\pnpm-workspace.yaml)末尾追加以下
内容,然后重新安装:
minimumReleaseAgeExclude:
- dsh-connect
allowBuilds:
protobufjs: false
minimumReleaseAgeExclude 只豁免这一个包;请不要用 minimumReleaseAge: 0,那会把整个
profile 里所有依赖的 24 小时供应链保护一起关掉。allowBuilds 是 pnpm 12 认可的新写法——
onlyBuiltDependencies 与 ignoredBuiltDependencies 已不再生效,写了照样报同样的错。
这个豁免无法随包发布:一个包不能在自己的清单里为自己的传递依赖声明构建许可,所以它只能写在 消费方的 profile 里。
两条对策并不等价。显式指定版本——dsh plugin --profile web add dsh-connect@<版本>——确实
能单独绕过冷静期,但对构建脚本毫无作用:这条命令仍会以 ERR_PNPM_IGNORED_BUILDS 结束,
因为 protobufjs 只有 allowBuilds 能拍板。如果你完全不想改 profile,版本号能让你装到正确的
版本,但拿不到一次干净的退出。
另外两件值得知道的事:
- 重装前先卸载。 DSH 对已安装的插件会以
already-installed拒绝第二次add,请先卸载。 - 之后重启
dsh(或桌面端):宿主插件在进程启动时加载。
快速开始
安装插件(见上文)。
添加最小配置到
~/.dsh/profiles/<profile>/cordis.patch.yml—— 配置形状见examples/minimal.config.json,带完整注释的版本是仓库里的examples/profile-cordis.patch.yml(该路径不在发布产物内,故用绝对链接)。该插件会通过其 bundle 清单自动注册,因此这里只需要**覆盖(override)**它的配置——不要再用insert重新插入(重复的id会让 dsh 启动失败):- id: connect name: dsh-connect # workDir: D:\your\workdir # agent working directory (default: process cwd) config: channels: [feishu] # 启用哪些通道;省略 = 全部内置 # channelDefaults: { language: zh } # 应用到未单独设置该键的每个通道 feishu: appId: cli_xxxx appSecret: cli_secret_xxxx transport: websocket requireMention: true dmMode: open启动宿主 ——
dsh web(或dsh run)。未配置凭据时,feishu通道会进入一键开通流程:扫描日志中的二维码 / 打开链接以授权机器人。在飞书中给机器人发一条消息。机器人以流式卡片回复;
/help列出所有命令;会话也会自动出现在 DSH Web GUI 中(自动镜像)。
一个完全可复现的示例是 examples/ 文件夹加上仓库里的飞书配置手册(飞书应用创建、事件订阅、发布)。
对话中的提问与授权
智能体需要你拍板时会停下来问你,这些问答直接出现在飞书里,不用切到 Web GUI:
- 带选项的问题 —— 渲染成一张卡片,一个选项一个按钮,点一下即作答,卡片随即切到下一问。全部问题答完后,卡片会被替换成一张汇总(列出每一问和你选的答案),按钮同时消失——原来的按钮留在屏幕上会让人以为交互还没结束,而点它也不会有任何反应(重绘窗口内的点击会被静默忽略)。
- 不带选项的问题 —— 没有按钮可用,机器人把问题当提示发出来,你直接在聊天里回一条消息即可,这条消息就是答案。
- 工具授权(需要你点头才能执行的操作)—— 同样是一张卡片,按钮是允许一次 / 拒绝。这类请求只认按钮:等待授权时发来的普通聊天消息不会被当成授权结果。
同一时刻一个聊天只有一张待答卡片。第二个请求会交还给宿主自己的处理路径(即 Web GUI),既不跟第一张抢同一条消息,也不会被丢掉;卡片投递失败、或请求在你作答前被取消,同样如此,并且会释放该聊天——否则你接下来那条消息会被静默吞掉。
看到「此操作已失效」说明这张卡片已经过期(空闲 60 秒后自动关闭),重新发起一次即可。连点两下、或上一问刚答完时紧接着落下的那一下,属于卡片重绘的窗口,会被静默忽略,不会误报失效。
配置
配置位于 DSH profile patch(cordis.patch.yml)中该插件的 config: 下。项目根目录(或其父目录)中的 dsh.shared.config.json 可以提供工作区/状态默认值,并对这些键具有更高优先级。
dsh-connect(核心)
| 键 | 默认值 | 说明 |
|---|---|---|
agentPreset |
roster default | 组合进每个绑定会话的智能体预设 id。解析是尽力而为的:先试配置的 id,再试 standard(或 roster 中第一个可挂载项);两者都组合不出来时,智能体不带预设构建,回合照常运行。因此一个过期的 id 只会降级并留下日志,而不会让每条消息都失败。 |
workDir |
process cwd | 每个绑定智能体的绝对工作目录 |
workspaces |
[] |
/dir 选择器提供的额外工作区 |
visionModel |
auto-detected | 当主模型无法查看图片时,用于描述图片的 { provider, model } |
language |
zh |
面向用户的消息语言:zh / en |
allowUsers |
[] |
兜底发送者白名单,仅对没有单独设置名单的渠道生效。用户 ID 因渠道而异,因此每个渠道在自己的卡片上有独立名单;某渠道显式设为空列表表示该渠道不限制,会覆盖这里的兜底 |
allowChats |
[] |
兜底会话白名单;渠道自己的名单优先。见 allowUsers |
<渠道>.allowUsers |
[] |
该渠道的发送者白名单,使用该渠道自己的 ID 格式(飞书 ou_…、Telegram 数字)。空 = 该渠道不限制;不设置 = 用上面的兜底 |
<渠道>.allowChats |
[] |
该渠道的会话白名单。空 = 不限会话;不设置 = 用兜底 |
stateDir |
.dsh-connect |
保存 bindings.json 路由存储的目录(环境变量 DSH_CONNECT_STATE_DIR 可覆盖) |
autoMirror |
true |
为每个新会话自动创建 Web GUI 镜像 |
streamHeartbeatMs |
60000 |
流式卡片的心跳保活间隔(毫秒);0 表示禁用 |
autoCompact |
false |
一轮任务结束时,若上下文占用达到 autoCompactThresholdPct,自动压缩会话。默认关闭:压缩会改写对话历史。可通过 /autocompact on|off 按聊天覆盖 |
autoCompactThresholdPct |
80 |
触发自动压缩的上下文占用百分比(与任务结束卡片报的是同一个数),限制在 1–99。可通过 /autocompact <1-99> 按聊天覆盖 |
notifyLevel |
result |
默认通知级别:full(全部流式输出)/ important(关键节点)/ result(仅结果,默认);可通过设置菜单或 /notify 按聊天覆盖 |
progressTimeoutMs |
300000 |
主动进度通知间隔(毫秒):当一轮对话在此时间内没有发送独立卡片/文本时,状态卡片会报告最新节点;0 表示禁用;可通过设置菜单或 /progress 按聊天覆盖。在所有通知级别都会执行——它是你主动配置的状态汇报,不是心跳噪音(心跳是另一个、仅 full 的机制)。其进展行是不含工具名的步数。设为 0 可全局关闭 |
公共(所有通道)
| 键 | 默认值 | 说明 |
|---|---|---|
channels |
全部内置 | 启用哪些通道:feishu / telegram / dingtalk / web。省略则启用全部内置通道。 |
channelDefaults |
{} |
应用到未单独设置该键的每个通道(如 { language: "zh" })。 |
settingsStatePath |
<stateDir>/dsh-connect-settings.json |
Web 设置面板镜像非密钥配置的路径。默认落在 stateDir 之内的 dsh-connect-settings.json,与 bindings.json 同目录,二者不会各说各话;设置该键可覆盖。面板的权威数据源是当前 profile patch 中本插件的条目(见用户设置),本文件只是旧版 /dsh-connect RPC 读写的兼容镜像;0.2 之前的安装留在其中的那份副本会在升级时被读取一次(见从 0.9.0 升级)。 |
feishu(飞书 / Lark 通道)
| 键 | 默认值 | 说明 |
|---|---|---|
appId |
env FEISHU_APP_ID |
飞书自建应用 id(机密) |
appSecret |
env FEISHU_APP_SECRET |
飞书自建应用密钥(机密) |
transport |
websocket |
websocket = 长连接(无需公网);webhook 需要公网 HTTPS |
verificationToken |
— | Webhook 验证令牌(机密) |
encryptKey |
— | Webhook 加密密钥(机密) |
webhookPort |
9000 |
transport: "webhook" 时内置 webhook 服务的 HTTP 端口 |
webhookPath |
/ |
飞书事件回调所 POST 的 URL 路径(webhook 传输) |
requireMention |
true |
群聊中仅在 @机器人 时才会响应 |
dmMode |
open |
私聊策略:open / allowlist / pair / disabled |
language |
zh |
面向用户的消息语言:zh / en |
环境变量
| 变量 | 用途 |
|---|---|
FEISHU_APP_ID / FEISHU_APP_SECRET |
飞书凭据 —— 优于把机密写进配置文件 |
DSH_CONNECT_STATE_DIR |
覆盖绑定存储的 stateDir |
DSH_HOME |
覆盖凭据文件所在的 ~/.dsh 基目录 |
敏感项 —— appSecret、verificationToken、encryptKey 和 feishu-credentials.json。优先使用环境变量或一键开通;切勿将它们提交到版本控制。
创建应用。 两个一键入口(1.0.0):设置面板里的按钮;以及在终端里不带凭据启动插件,它会打印一条开通链接。两者都会把应用连同权限与事件预设一起建好、把凭据存进 DSH 凭据库;面板那条还会顺便启用渠道并把 transport 定为 websocket。CLI 那条在 onboarding: false 或 stdout 不是终端时会被跳过,因此无人应答的服务进程不会开始一个没人能完成的流程。Telegram 与钉钉没有这样的 API —— 面板对它们只给官方创建页面的链接。
telegram(Telegram 通道)
| 键 | 默认值 | 说明 |
|---|---|---|
botToken |
环境变量 TELEGRAM_BOT_TOKEN |
来自 @BotFather 的机器人 token(机密) |
requireMention |
true |
群聊仅在 @提及机器人(或回复机器人自己发的消息)时响应 |
pollingTimeoutSeconds |
50 |
getUpdates 长轮询超时(秒) |
baseUrl |
— | 可选:Bot API 基地址覆盖(如本地 Bot API 服务器) |
language |
zh |
面向用户的消息语言:zh / en |
dingtalk(钉钉通道)
| 键 | 默认值 | 说明 |
|---|---|---|
webhookUrl |
环境变量 DINGTALK_WEBHOOK_URL |
群自定义机器人 webhook(主动推送) |
secret |
环境变量 DINGTALK_WEBHOOK_SECRET |
仅启用加签时的 SEC… 密钥 |
stream.clientId / stream.clientSecret |
环境变量 DINGTALK_STREAM_CLIENT_ID / DINGTALK_STREAM_CLIENT_SECRET |
双向 stream 模式应用凭据(机密,嵌套在 stream 下) |
stream.requireMention |
true |
群回复需要 @提及(stream 模式) |
defaultAt |
— | 每次推送默认合并的 @列表({ mobiles, userIds, all }) |
language |
zh |
面向用户的消息语言:zh / en |
web(Web 镜像通道)
| 键 | 默认值 | 说明 |
|---|---|---|
pollIntervalMs |
1000 |
镜像会话轮询间隔(毫秒) |
环境变量(FEISHU_*、TELEGRAM_*、DINGTALK_*、DSH_CONNECT_STATE_DIR、DSH_HOME)与 DSH 凭据库是提供各通道密钥的推荐方式——Web 设置面板把密钥写入凭据库,加载时由 injectSecrets 注入。
权限与数据
- 写入的文件
<stateDir>/bindings.json(默认.dsh-connect/)—— 聊天 ⇄ 会话路由存储(聊天键、会话 id、镜像与锁状态)。<stateDir>/dsh-connect-settings.json(默认.dsh-connect/)—— 非密钥配置的兼容镜像,见settingsStatePath。<profile 目录>/.dsh-connect-legacy-imported—— 记录一次性升级导入已经跑过的标记文件。它就放在导入所写的那个 profile 条目旁边(见从 0.9.0 升级),内容只有一句话说明设置来自哪里,不存任何数据。- 当前 profile patch 中属于本插件的条目(
profileContext.patchPath,即cordis.patch.yml)—— 经由 DSH 第一方settings服务写入,原子、加锁、保留注释。 ~/.dsh/.dsh-connect/feishu-credentials.json—— 旧版、只读。一键开通过去把飞书凭据存在这里而不是凭据库,导致刚扫码授权完的用户永远看到「未配置凭据」。现在开通流程写入凭据库,已有安装会在启动时从这个文件回填一次;此后不再读写它。<workDir>/.dsh-connect-images/—— 为用户图片/附件暂存,供智能体工具使用。- DSH 自身在
~/.dsh/下的会话日志与设置(sessions、settings 等)。
- 网络
- 飞书开放平台:WebSocket 长连接(或通过公网 HTTPS 的 webhook),以及 HTTPS API 调用(媒体下载、卡片)。
- DSH 为智能体模型调用的 LLM 提供商 API(如 DeepSeek),以及可选的视觉模型。
- 用户数据 —— 消息文本与附件经由机器人流向智能体会话;它们与任何 DSH 会话一样保存在 DSH 会话日志中。白名单(
allowUsers/allowChats)限制了可以驱动机器人的人。
设置面板
dsh-connect 在 设置 → dsh-connect 下有自己的页面,顶部是两级导航:主导航(通用设置在前、机器人渠道在后),
下面才是渠道视图自己的页签条 + 若干可折叠卡片。每张卡片由一个按钮做标题行,低频字段收在第二级的高级选项折叠里,
保存/状态固定在滚动区底部。两层导航条都钉在滚动区顶部(position: sticky),内容从它们下面滚过去,而不是把它们带走。
设置项一行一个:字段网格是单列,面板变宽时标签/控件对不会再回流成两三列。
面板打开就停在「机器人渠道」,这样飞书的一键创建按钮零点击可达;它就排在飞书卡片正文的最顶端,App ID / App Secret 在它下面。
通用设置是原先只能靠聊天命令改的那十项——回复语言、通知级别、进度看门狗、工作目录与额外工作区、访问白名单、智能体预设、镜像与心跳。
它们在这里可改,但与渠道设置不同:这些值是插件加载时一次性读走的,所以每一项都写着「修改后需重启 dsh 才生效」。
真被 dsh.shared.config.json 压过的键会多一行来源提示,说明面板改它不生效;当前模型是只读一行,因为那是 DSH 的东西,要换请去 DSH 里换。
每张渠道卡片头部有两个徽章(1.0.5)。第一个是凭据徽章——这个渠道是否具备它需要的凭据,一直是这个意思。
第二个是接入状态,回答的是另一个问题:机器人现在连上没有。文案为
已连接 / 连接中 / 重连中(第 N 次)/ 空闲 / 运行中 / 未运行 / 接入失败 / 未启用,出问题时卡片下方的问题栏给出适配器自己的原因。
只有飞书报告真实的传输状态(LarkChannel.getConnectionStatus());其余三个渠道没有可问的探针,就只报告 runtime 能实证的东西,
而不是替一个没人检查过的连接编造「已连接」。宿主完全不提供状态时,第二个徽章不渲染——画一个「未知」占位就等于下结论。
渠道页打开期间会轮询,所以重连会自己出现;轮询只合并状态键,因此不会覆盖你还没保存的编辑。
下面的截图摄于 1.0.5 之前,所以每张渠道卡片头部只显示凭据徽章;上文所述的接入状态徽章 在运行时渲染在它旁边。双徽章头部由 client-bundle 测试覆盖,而不是靠截图。
| 渠道与凭据 | 通用设置 |
|---|---|
![]() |
![]() |
| 通用设置:只读的模型行 | 展开高级选项 |
|---|---|
![]() |
![]() |
| 飞书卡片:凭据字段(一键按钮在其上方) | Telegram 卡片:官方入口链接 |
|---|---|
![]() |
![]() |

英文截图:概览 · 通用设置 · 通用设置·模型 · 高级 · 公共默认 · 飞书凭据 · 官方入口。
截图取自一个凭据全是占位符的一次性 profile。上面没有任何真实密钥 —— 也不可能有:宿主会在 值到达浏览器之前完成打码(见下文面板回显与脱敏)。
卡片默认展开你已启用的渠道(一个都没启用时展开第一个)。点击页签会展开对应卡片并滚进视野, 不会收起其他卡片 —— 多张同时展开是合法状态。收起是卸载卡片主体而不是隐藏它,这之所 以安全,是因为你刚输入但尚未保存的密钥存在面板自身的 state 里,而不在卡片里。勾选某渠道的 启用框同样会展开它。
飞书卡片正文的最顶端有一个「一键创建并配置飞书机器人」按钮(1.0.0),排在 App ID / App Secret
上面——先给自动路径、再给手填路径,不让人填完才发现在上面有自动的。它由宿主执行飞书官方的
OAuth 2.0 设备授权流:按钮先给你一条在浏览器里打开的链接,应用在那里建好并预设好权限与接收
消息的事件,凭据存进 DSH 凭据库,feishu 被写进 channels 且 transport 定为 websocket
—— 不需要公网地址就能跑起来。Telegram 与钉钉没有对应的官方 API,所以它们的卡片里只放一
个官方创建入口的链接(@BotFather /
open-dev.dingtalk.com)和一句「把拿到的凭据粘到下面的字段
里」。这两个渠道没有任何自动化。
结果是一份逐条列出的事实,不会合并成一句「完成」:应用已创建(带 appId)/ 凭据已入库 /
渠道已启用 / 运行中的渠道是否就地重载 / 事件订阅的结果 / 还剩什么要你去开放平台收尾。
「凭据已写入凭据库」与「运行中的渠道没有重新加载」永远是两行 —— 凭据存下了但活着的适配器
还没采用,这是一个你需要知道的真实状态,重启 dsh 即可生效。事件订阅这一步按设计就是尽力而
为:SDK 注明它可能只适用于开发者后台创建的应用,而那里多数配置改动要提交发布后才生效。本插
件不代你发布,也绝不声称订阅已经生效。
用户设置
Web 设置面板(设置 下的 dsh-connect)编辑的是当前 profile patch 中属于本插件的
条目——也就是你手工编辑的那个 ~/.dsh/profiles/<profile>/cordis.patch.yml——走 DSH
自带的(第一方)settings 服务。该服务在文件锁下原子写入并保留你的注释,loader 会热重载结
果。因此渠道设置改完即生效,通用设置不会——workDir、language、notifyLevel、
progressTimeoutMs、workspaces、两个白名单、agentPreset、streamHeartbeatMs 这些在插
件加载时就被读走,要重启 dsh;面板上每一项都写明了这一点。
面板能编辑的字段在插件 config schema 里声明为 volatile。正是这个声明让保存变成就地
reconcile 而不是重挂载:loader 为每个声明字段交给插件一个活引用,设置写入会就地提交它们,
运行中的适配器在收到下一条消息时即采用新值。面板不拥有的字段则根本没有声明——这正是它写不
进去的原因。
取值分三层解析,越靠后越具体:
- 插件内置的 schema 默认值;
- 插件被组合进来时的配置(其继承条目);
- 当前 profile patch 中属于本插件的条目——你手写的值和面板保存的值都在这里。
保存只会投影到已声明的字段上,因此未声明的键——凭据、settingsStatePath、你自己加的
任何东西——即使调用方发过来也到不了文档里。反过来同样关键:宿主会把一次更新中被省略
的已声明字段重置回其继承值,所以每次保存写入的都是完整的已声明段。而你在该条目里手写的
未声明键,会在面板保存时原样保留。
一个值得知道的后果:按下「保存」会把通道列表钉住。 channels 是已声明字段,所以一次保存
写入的那一段会点名当时表单里的每一个通道——而面板没有办法把它解开,因为被省略的字段不是
被清空、而是回落到继承值。只要你至少保存过一次,后来新版本新增的通道就不会自动为你启用,除非
你勾上它再保存一次(或者手工删掉
~/.dsh/profiles/<profile>/cordis.patch.yml 里的 channels 键)。面板分不清「这就是用户
选定的列表」和「列表变了但用户还没看」,它也不会替你猜:一次只写入你改动内容的保存,会把其余
每个字段都重置回继承值。
面板永远不会写入凭据。 profile patch 是一份普通的、鼓励用户贴进 issue 的文档,所以你在
面板里输入的密钥会存进 DSH 凭据库(ctx.credentials)——一键开通流程与 FEISHU_* 这类
环境变量也正是写在那里。你自己在该条目里手写的密钥则原样保留。
旧版 /dsh-connect HTTP RPC 为面板兼容而保留;它现在读写同一个 namespace,并把非密钥配置
镜像到 settingsStatePath(见公共(所有通道)),以兼容旧面板。
面板回显与脱敏
每个已保存的密钥字段下方都有一行只读的「当前值:…」(没有值时显示「未配置」),这样你
不用重新输入就能确认自己填了什么。打码在宿主侧完成,只有一张共用的策略表
(src/settings/secret-disclosure.ts)——宿主按它打码,面板按它决定输入框渲染成
password 还是 text,两边因此不可能各说各话。
| 字段 | 显示方式 |
|---|---|
appId、clientId |
完整显示。它们是标识符而不是口令:每次出站 API 调用都会带上,厂家控制台也明文可见,遮住并不能保护什么。 |
appSecret、clientSecret、botToken、secret |
只留头尾,例如 a1b2…z9y8。太短、露头露尾就等于全露的值,改为固定长度的 ••••••。 |
webhookUrl(钉钉) |
URL 感知。保留域名、路径与参数名,只对令牌的中段打码——钉钉把令牌放在查询串里,整串打码(https…bcde)等于什么也确认不了。 |
| 其他 / 未列出的键 | 一律按最保守的方式打码。 |
有两条性质无论如何都成立:
- 可用密钥不会跨线。 值在离开宿主前就已打码,所以浏览器标签页(以及它的截图)永远拿不到 一个可用的密钥。
- 掩码不可能被写回。 预览是输入框旁边的文本,不是输入框的
value。输入框始终为空, 而「空」的含义是「不动已保存的值」——因此只保存配置时,一个凭据都不会被写入。
面板自身的全部文案(通道名、字段标签、选项文字、状态)都来自 client/locale.mjs,其中同时
提供 zh 与 en。有测试断言两种语言的键集合完全一致——宿主在缺键时会静默回退到另一种语言,
所以漏译不会报错,只会让页面变成中英混杂。
保存之后还有话要说时
「已保存」只意味着这次写入落盘了,仅此而已。还有别的情况要说时,保存条会在按钮上方长出一份清单 ——保存条是面板里唯一始终在屏幕上的部分,而渠道卡片可能被折叠、也可能被滚过去,恰恰在这种时候, 孤零零一句「已保存」最容易骗人。
| 行 | 含义 |
|---|---|
<通道> · 凭据状态未知 |
该通道的凭据库读不了——通常是权限问题,或存储文件损坏。这不是「未配置凭据」:密钥很可能就在里面。在确认凭据库之前不要重新输入;这也是该渠道卡片的徽标变成琥珀色而不是红色的原因。 |
<通道> · 渠道启动失败: 后接适配器自己的报错 |
适配器的 start() 抛错了。报错原样透传,因为只有它才点得出来到底是哪个凭据或哪项配置有问题。 |
凭据已保存,但运行中的渠道没能重新加载,请重启 dsh 后确认。 |
这次保存只生效了一半:密钥已经进了凭据库,但把它交给运行中适配器的 reconcile 失败了,所以在重启之前机器人用的还是旧凭据。 |
一次「保存」会发出多次调用(先配置、再逐个通道的凭据),警告会跨调用累积,而错误清单每次 都按当前世界状态重新推导。警告描述的是触发它的那一次调用,否则就会被下一个通道的保存抹掉 ——而被抹掉的恰好是你真正需要的那条。
凭据分组
当某通道的任意一组凭据被完整满足时,该通道即视为「已配置」;而单组内必须全部满足
——组内是 all-of,组间是 any-of。没有任何分组的通道(web)按定义就是已配置,永远不显示
告警徽标。
之所以要分组,是因为一个通道可能有不止一种互斥的认证方式;若要求全部满足,就会把明明能用的 机器人误报成未配置:
| 通道 | 分组 |
|---|---|
feishu |
app id + app secret |
telegram |
bot token |
dingtalk |
webhook URL + 签名密钥 —— 或 —— Stream 模式的 client id + client secret |
web |
无 |
因此,只用 webhook 推送(没有 Stream 凭据)的钉钉机器人会被正确判定为已配置,只用 Stream 模式的同样如此。
从 0.9.0 升级
仓库里的 0.9.1 同样适用——它只提交过、从未发布到 npm,所以用户实际都是从 0.9.0 升级上来的。
DSH 0.2 把每个插件的设置保存在 profile patch 里,而不是 $DSH_HOME/settings.yaml,
并且它不认识旧文档里的 dsh-connect: 段——宿主自己的迁移会重命名该文件并导入它认得的那几段,
我们这一段只会被丢下并记一条警告。不加处理的话,升级后各渠道照常工作(配置在 patch 里),
但每项只存在于面板里的选择都会在面板第一次打开时静默回到默认值。
因此 0.9.2 会在升级后的第一次启动时导入一次:
- 先在
$DSH_HOME/settings.yaml里找dsh-connect:段,再找settings.yaml.imported(宿主自己的迁移会重命名到那里,而它可能早于也可能晚于本次运行), 最后是插件自己的dsh-connect-settings.json—— 一个从来没有过可用设置对端的用户, 他的全部选择都在这个兜底存储里。 - 该段会被投影到面板拥有的字段上,因此凭据不可能随之迁移:它们在凭据库里,文件里其他 任何内容都原样留在原地。
- 它是合并,不是替换。当前生效的值是基底,旧值叠在其上——因为宿主会把一次更新中被省略的
已声明字段重置回继承值,一份只带单渠道键的导入否则会清掉
channels,把所有适配器关掉。 - 它走与面板保存完全相同的写入路径,所以运行中的适配器会立即对上,无需重启。
- 不删除、不重命名任何东西。 与宿主自己的导入不同,我们从不写
settings.yaml。 - 结果会一次性记录在一个以 profile 条目本身(
profileContext.patchPath)命名的标记里, 也就是<profile 目录>/.dsh-connect-legacy-imported,包括「本来就没有可导入内容」这种良性 情形,这样后续启动就不会把旧值重新盖到你此后的修改上。锚点是那条条目,而不是它过去所在 的状态文件:状态路径归你所有,你可以改(stateDir、DSH_CONNECT_STATE_DIR、settingsStatePath)也可以删,两者任一都会让下次启动误以为导入从未跑过。而 profile 目录只会 在 profile 本身移动时移动——那恰好就是「该重新导入」的唯一情形。
重试规则比「凡失败就重试」更窄,而且是有意为之。只有三种结果是终局、会写标记:文档不在、
文档里没有 dsh-connect: 段、以及导入成功。其余全部——文档解析不了、文档在却读不了
(权限问题,或 settings.yaml 其实是个目录)、写入被拒、宿主根本没有 settings 服务——
都不导入任何东西、两个文件都不动、也不写标记,于是下次启动在你修好原因后会自己再试。
把「不存在」和「读不了」分开的正是最后这条:在 0.9.2 之前它们是同一种结果,于是一份读不了的
文档就此静默地、永久地结束了整段迁移。
每一种失败都只留一行 connect: …,点名文件与原因;下面的故障排查表逐条列出。标记写不出去
同样会报告——没有它,每次启动都会重跑迁移,把旧值重新盖到你更新的修改上。如果你从未用过面板,
这一切你都看不到。
故障排查
日志来自 DSH 宿主日志器(在终端运行 dsh web);插件消息带有 connect: / connect-feishu: 前缀。
| 症状 | 可能原因 / 修复 |
|---|---|
在 DSH 0.2.0-rc.2 上安装 [email protected] 被拒绝:“[email protected] 与 DSH 0.2.0-rc.2 不兼容 …… 运行它可能导致崩溃或数据丢失” |
这不是 bug,也不是可以忽略的警告:DSH 的兼容性闸门会拒绝任何声明范围覆盖不到当前宿主的插件,而 0.9.0 早于 0.2.0 这条线。请安装 0.9.3(或更新的版本),它的 peer 要求 ^0.2.0-rc.2。 |
| 在桌面端找不到安装插件的地方,重启之后那个入口似乎就不见了 | 安装入口是侧边栏里的「插件」面板(面板列表第一项),不在「设置」里;设置只提供只读的插件列表。见在桌面端安装。如果面板打得开却显示「本部署没有可管理的 profile,无法安装或启停插件。」,说明宿主没有暴露插件管理器,该页处于不可用状态 —— 重启应用。另外 设置 → dsh-connect 只有在插件被安装并加载之后才存在,所以一次被拒绝的安装之后,那里本来就找不到东西。 |
安装时列表给的是最新版,装上的却是上一版;或者安装以 ERR_PNPM_IGNORED_BUILDS 结束 |
两者都属于 pnpm 12 的行为,而不是打包问题:裸写 add 会撞上 1440 分钟的 minimumReleaseAge 冷静期,而 protobufjs 的构建脚本处于未决状态。在 profile 的 pnpm-workspace.yaml 里加两行即可同时解决——见安装落到旧版本怎么办。 |
connect-feishu: adapter init failed / start failed |
凭据错误、应用未发布或网络被阻断。检查 appId/appSecret,重新运行开通流程,确认机器人在飞书开放平台后台处于在线状态。 |
connect: resume of <id> failed, creating fresh session |
持久化会话无法恢复(工作目录缺失、持久化问题)。检查 workDir 和 ~/.dsh/sessions。对话里也会收到通知(自 0.9.3 起):你会看到「无法恢复上次的会话,已为你开启一个新会话继续」,并附上原因——因为日志是聊天用户唯一不会去看的地方,而一条对自己刚才说过什么毫无记忆的回复,看起来像是机器人在忘事,而不是会话换了地方。旧会话并没有丢:它仍在会话存储里,也仍能在 Web 界面打开。 |
connect: binding store writes to <file> are working again / … cannot persist bindings … |
绑定文件写不进去,于是重启后已有对话都不会被恢复,每个对话都会开一个新会话。写入失效时提示一次、恢复时再提示一次。单看它只是磁盘或权限问题;但如果你同时看到上面那条恢复通知,两者是同一个原因。 |
connect: summary card could not be delivered … / connect: stats card could not be delivered … |
这一轮跑完了,但结果卡片没送到对话里,流式卡片会停在一帧上不动。通常是渠道侧的机器人接口或权限问题;答案本身在会话里,可以在 Web 界面查看。 |
| 提醒被接受了却从未触发 | 已在 0.9.3 修复:存储的写入失败被吞掉了,于是「已设置」可能是为一条撑不过重启的提醒发出的。确认消息现在会带上第二行说明。升级即可。 |
机器人对每条消息都回一行原始的 agent-presets: preset "…" not found,内容到不了智能体 |
$DSH_HOME/settings.yaml 里的 agent-presets.default 指向了任何已安装版本都不提供的 id。0.9.0 已修复:改为重试 standard 并记录决策,而不是让这一轮失败;在更旧的版本上,请把该键改成一个确实存在的 id(standard)。 |
| 会话锁定提示 | 另一个客户端(飞书或 Web)持有写锁。使用 /unlock 或等待锁超时。 |
| Web GUI 中的模型切换似乎被忽略 | 已在 0.9.0 修复:插件不再用静态默认模型覆盖 Web GUI 的会话选择。升级后重启 dsh web。 |
[用户发送了图片,但下载失败…] |
应用缺少飞书 im:resource 权限;授予该权限并重新授权。 |
| 流式回复是一整块没有分段 | 已在 0.9.0 修复:块边界与推理/回答分隔现在会插入空行(推理软换行已针对飞书卡片扩展)。升级后重启 dsh web。 |
| 长时间任务中卡片卡在「思考中…」没有进展 | 已在 0.9.0 修复:推理现在实时流出,工具调用显示为 🔧 进度行,静默期间心跳保活会更新卡片。升级后重启 dsh web。 |
| 智能体给出选项 / 请求工具授权,飞书里却什么都没有 | 已在 0.9.2 修复(仓库里的 0.9.1 从未发布):桥接此前订阅了一个宿主上并不存在的服务,问题只会静默落回宿主。升级后重启 dsh web。 |
| 点击卡片按钮提示「此操作已失效」,但卡片明明是刚发出来的 | 已在 0.9.2 修复(仓库里的 0.9.1 从未发布):卡片重绘期间(连点两下、上一问刚答完)落下的点击被误判为过期操作。升级后重启 dsh web。 |
connect: the legacy settings at <path> could not be parsed … |
旧(0.2 之前)文档存在 YAML 错误,一次性迁移(见从 0.9.0 升级)因而跳过它并原样留下文件。修好 YAML 后重启;在那之前不会导入任何内容,也不会写标记,所以重试是自动的。 |
connect: could not import the legacy dsh-connect settings from <path> … |
迁移找到了该段,但 DSH 拒绝了这次写入(通常是某个值没通过校验)。该段仍在文件里——修好被点名的那一项后重启。 |
connect: could not read the legacy settings candidate at <path> … |
候选文件在那里但读不了:权限、路径其实是个目录、或者 $DSH_HOME 里的 ~ 没被展开。这是迁移唯一不标记完成的失败——什么都没导入,什么都没标记,下次启动自动重试,所以修好之后不用做别的。之所以要区分「不存在」和「读不了」:两件事此前是同一种结果,于是一次 EACCES 就让整个迁移静默地、永久地结束了。 |
connect: could not write the one-shot import marker at <path> … |
导入本身成功了,但记录它的标记写不出去(通常是 profile 目录只读)。这不是无害的:没有标记,每次启动都会重跑整段迁移,把旧值重新盖到你升级后在面板里改过的设置上——面板看起来会「自己变回去」。修好 profile 目录的写权限,或手动创建该标记文件。 |
connect: the import marker at <path> could not be read … |
标记存在但读不了。此时按已导入处理并提示:宁可不再导入,也不愿把旧值盖到你更新的设置上。要重新触发导入,删掉这个标记文件再重启。 |
保存面板时报 Configuration for "connect" is overridden by a home patch or command-line overlay |
面板写的是 profile patch,但取值层级是 bundle → profile → $DSH_HOME/cordis.patch.yml → --patch,后两者的值会盖过面板保存的任何内容;DSH 因此直接拒绝这次写入,而不是让一次永远不可能生效的保存看起来成功了。想让面板接管这些设置,请改 home patch(或去掉 overlay)。 |
| 面板接受了保存,但渠道仍显示「未设置」,也不出现「接入状态」一行 | 已在 1.0.4 修复:插件的 Config 此前只是具名导出,加载器没把它挂到插件对象上,DSH 因此拒绝每一次面板写入(No configurable plugin entry "connect")。你刚填的 appId / appSecret 被丢掉、渠道一直是未配置状态;又因为拒绝发生在凭据写入之前,界面上没有任何东西说明这两半中哪一半失败了。1.0.3 就是以这个状态发布的,在那个版本上面板保存不了任何设置,请升级。1.0.4 起保存条把两半分开报告(配置 / 凭据),并附上宿主自己的错误码。 |
| 某个你从没碰过的渠道设置,保存一次面板后就没了 | 已在 1.0.5 修复。一次保存会整段重写该渠道的设置,而这一段是经逐字段白名单投影出来的——于是任何已声明但面板没渲染的键不是被保留,而是被重置,只要你保存过任何东西就会发生。飞书丢的是 threadIsolation 与 onboarding,钉钉丢的是 stream.url 与 stream.requireMention。钉钉的 defaultAt 比丢掉更糟:先被渲染成 [object Object],保存时又把这个字符串写回去盖掉了真正的对象。现在每个已声明的键恰好归入可改 / 密文 / 原样带过三类之一,且完整性测试从 schema 自省出发推导检查,新增的键无法被遗忘。升级后请把面板丢掉的值重新设一遍。 |
| 飞书卡片有凭据徽章,却看不出机器人到底连上没有 | 已在 1.0.5 修复:每张渠道卡片新增第二个接入状态徽章。在此之前,头部只回答「凭据是否已配置」——appSecret 有效但连接已死,看起来和健康的渠道一模一样。升级后看凭据徽章旁边那个;渠道页打开期间它还会自己刷新。 |
/send <路径> 不发送文件,只是把路径当文本发出来 |
已在 1.0.5 修复:重试包装体把适配器重建成对象字面量,只搬了固定几个成员,sendFile 不在其中,因此 runner 拿到的包装体上 adapter.sendFile 恒为 undefined,每次 /send 都静默退化成一条文本消息。升级即可。 |
| 菜单卡片不更新 / 过期 | 设计如此:卡片空闲 60 秒后自动关闭;重新打开菜单即可。提问与授权卡片同理——详见对话中的提问与授权。 |
进度提醒停了,但 /status 仍显示正在处理任务 |
已在 1.0.7 修复。问题出在 /status 的两个字段,而不是提醒逻辑本身:报出的完成时间取的是你发问那一刻的系统时钟(于是任何旧任务都显示成刚刚完成),而一个根本没有进程在驱动的任务被报成「正在处理任务」。若你已在 1.0.7 上仍看到该现象,说明任务确实已中断——状态现在会直接说明;而进度提醒依附于驱动它的那一轮任务,因此中途重启必然使其终止。重发消息即可开始新一轮。 |
回滚 —— 重新安装之前的版本(先移除当前版本,再执行 dsh plugin --profile web add dsh-connect@<version>),或在源码安装中 git checkout 到固定的提交。
开发
这是一个 pnpm workspace;dsh-connect 是 packages/ 下的唯一包:
packages/
connect/ # 本包 — 多合一插件
src/ # 核心:runner、service、binding、commands、menus、chat key …
src/channels/ # 通道适配器:feishu / telegram / dingtalk / web
src/settings/ # Web 设置栈:宿主 RPC、凭据库、脱敏策略
client/ # Web 设置前端插件 + 其纯函数模块(locale、panel-state)
test/ # node:test 套件(run-all.mjs 导入每个套件)
docs/images/ # 本 README 引用的截图
examples/ # minimal.config.json
pnpm install
# build & typecheck the package
pnpm --filter dsh-connect build
pnpm --filter dsh-connect typecheck
# unit tests (node:test) — run-all.mjs 进程内导入每个套件
pnpm test
# or run one suite
node packages/connect/test/unit.test.mjs
结构 —— src/runner.ts 负责每个聊天的智能体驱动与流式桥接(applyStreamChunk 是纯函数、有单元测试的块组装器);src/service.ts 负责适配器注册表与路由;src/channels/ 存放 feishu / telegram / dingtalk / web 通道适配器;src/settings/ 存放 Web 设置栈(宿主 RPC、凭据库、脱敏策略);src/binding.ts 是路由存储。
有两样东西原来是放在 src/ 的,现在移到了 client/,为的是能在不引入 React 的情况下单测:client/locale.mjs 存放设置面板的全部用户可见文案(zh 与 en,两边键集合必须一致 —— 宿主在缺键时会静默渲染另一种语言,所以漏译表现为中英混杂,而不是报错),client/panel-state.mjs 存放卡片的展开/高级折叠规则。两者都是零依赖的纯 ESM,分别由 test/locale.test.mjs 与 test/panel-state.test.mjs 直接断言。
贡献 —— 欢迎在 github.com/IvanWu2015/dsh-connect 提交 PR。对于面向用户的面板文案,请在 client/locale.mjs 中同时为 zh 和 en 添加键,然后重建产物(node scripts/build-client.mjs)—— test/client-bundle.test.mjs 跑的是构建产物,产物过期会直接失败。发布说明在 CHANGELOG.md 中;发布流程参见 docs/PUBLISHING.zh.md。
许可与安全
- 许可: MIT(见
LICENSE)。 - 安全: 请私下报告漏洞 —— 使用仓库的 GitHub security advisory 流程,或通过 GitHub 主页上列出的邮箱联系维护者。请不要为凭据泄露创建公开 issue。请将
appSecret/verificationToken/encryptKey/feishu-credentials.json视为机密:优先使用环境变量,切勿提交到版本控制。





