dsh-f
把 DeepSeek Harness 接入飞书 | Bridge DeepSeek Harness into Feishu / Lark
🔗 原项目 | Upstream
dsh-lark-bot(DeepSeek Harness × 飞书桥接插件)
dsh-f 是 dsh-lark-bot 的独立改造分支(derivative)。安装、配置、命令与
原项目完全一致;项目的完整介绍与使用文档请看原项目 README:
https://github.com/PlutoKeating/dsh-lark-bot
🚀 dsh-f 改造内容(相对原项目的增强)
1. 🧵 话题分离 —— 完整思维链归纳话题,正式回复回到主会话
- 思考轨迹、工具调用全过程(完整思维链痕迹)→ 全部归纳到话题线程,一个任务一个话题,过程可回溯
- 最终正式回复结果 → 分离发送到主会话(不在话题里重复出现)
- 任务完成自动 Pin 主会话的正式回复(不是话题里的过程卡)
2. 📊 聊天框运行元数据(中文标签,横排展示)
每条任务结果自动附带:
deepseek-v4-pro · max · 上下文:2% · 缓存:99.5%
缓存 ¥0.0005 · 未 ¥0.0003 · 合计 ¥0.0012 · 余额:¥53.98
- 模型、推理强度(max/medium/low)、上下文占用%、缓存命中率%
- 费用缓存 / 未缓存拆分显示 + 合计
- DeepSeek 账户余额(任务完成时自动刷新)
3. 💰 峰谷计费
- 按 DeepSeek 官方峰谷定价实时估算(高峰 9-12 / 14-18 点,其余闲时)
- 缓存命中(cacheHit)与未缓存输入(cacheMiss)分开计费,与官方账单一致
4. 😀 表情互动
- 任务完成 / 失败:结果卡片自动 DONE / ERROR 表情
- 已读回执:你发消息后,你的消息上自动出现已读表情
- 表情快捷指令:对 bot 消息加表情触发 —— 💰 费用 / 📊 统计 / 👍 确认
5. 🛠️ 新命令
| 命令 | 功能 |
|---|
/stats | 当前会话统计(模型/任务数/tokens/缓存/上下文/累计费用) |
/cost | 当前会话累计费用(峰谷定价估算) |
/balance | DeepSeek 账户余额(自动读取 dsh 凭据,无需额外配置) |
6. 🔧 其他增强
- 全部新功能可用环境变量关闭(
DSH_LARK_THREAD_REPLY / DSH_LARK_REACTION_ON_SETTLE / DSH_LARK_AUTO_PIN / DSH_LARK_READ_RECEIPT)
- dsh 重启后会话恢复不报错(id collision 根治:启动自动清理失效绑定,transcript 保留)
快速开始 | Quick Start(普通用户先看这里 | for end users)
1. 安装(唯一路径)| Install (the only path)
本项目以 dsh 标准 profile bundle 交付:一行命令把它装进一个 dsh profile,dsh 启动时以
标准插件方式加载桥接引擎(dsh.bundle.patch 已声明,dsh plugin add 可直接安装)。
This project ships as a standard dsh profile bundle: one command installs it into a dsh
profile, and dsh loads the bridge engine as a standard plugin on boot (the package declares
dsh.bundle.patch, so dsh plugin add works directly).
# 唯一安装命令(无需先全局安装任何东西)| the only install command (no prior global install)
npx dsh-lark-bot@latest setup --profile dsh-lark
setup 会自动完成:发现本机 dsh → 预批准 pnpm 构建策略 → 执行标准的
dsh plugin --profile dsh-lark add dsh-lark-bot@<版本>(版本号由当前包固定,避免 pnpm
裸名解析到旧版本),并默认同时安装「安全网守护」——系统级
常驻、dsh 全部下线后仍保留飞书救援入口(核心能力之一,见下文「安全网守护」一节)。
一条命令即完成全部安装。
setup automatically: locates your dsh install → pre-approves pnpm's build policy → runs the
standard dsh plugin --profile dsh-lark add dsh-lark-bot@<version> (pinned to the running
package so pnpm never resolves an outdated bare-name release), and also installs the safety-net
guardian by default — a system-level resident process that keeps the Feishu rescue entrance
alive even when dsh is fully down (one of the core features; see "Safety-net guardian" below).
One command installs everything.
2. 启动并扫码绑定 | Start and bind with one scan
dsh --profile dsh-lark
首次启动会在终端打印二维码:用飞书 / Lark App 扫码创建或选择 PersonalAgent 应用,绑定后
dsh-lark-bot 的桥接引擎即在 dsh 进程内运行(飞书通道、会话/工作区、卡片、通知回调),
私聊直接发消息,群聊 / 话题里 @bot。常驻与守护由 dsh 自己负责。
On first boot the terminal prints a QR code: scan it with the Feishu / Lark app to create or
choose a PersonalAgent app. After binding, the bridge engine runs inside the dsh process
(Feishu channel, sessions/workspaces, cards, notify callback); message it directly in private
chat, or use @bot in groups/topics. dsh owns the daemon lifecycle.
已有 PersonalAgent 应用时可在 profile 环境变量中直接提供凭据跳过扫码(见「配置」):
With an existing PersonalAgent app, provide credentials via profile env to skip the QR step
(see Configuration):
DSH_LARK_APP_ID=cli_xxx DSH_LARK_APP_SECRET=<secret> DSH_LARK_TENANT=feishu \
dsh --profile dsh-lark
卸载:dsh plugin --profile dsh-lark remove dsh-lark-bot。
Uninstall: dsh plugin --profile dsh-lark remove dsh-lark-bot.
3. 基本使用 | Basic usage
在飞书里向 bot 发送普通消息即可开始工作,常用命令:
Just send a normal message to the bot in Feishu to get started. Common commands:
| 命令 Command | 作用 Description |
|---|
/new /reset | 开始新会话 Start a new session |
/cd <path> | 切换工作目录并重置会话 Change working directory and reset the session |
/ws list | 查看命名工作空间 List named workspaces |
/ws save <name> | 保存当前工作空间 Save the current workspace |
/ws use <name> | 切换到命名工作空间 Switch to a named workspace |
/ws remove <name> | 删除命名工作空间 Remove a named workspace |
/status | 查看当前状态 Show current status |
/resume | 查看当前会话最近上下文 Show the session's recent context |
/stop | 终止当前任务 Stop the current task |
/timeout [N|off|default] | 查看或设置当前会话运行超时 View or set the current session run timeout |
/concurrency [N|default] | 查看或设置当前 scope 并行任务数(默认 2) View or set the concurrent-run limit for this scope (default 2) |
/role list、/role show <id> | 查看角色列表 / 详情 List roles / show a role |
/role set <id>、/role clear | 为当前 scope 绑定 / 解除角色 Bind / unbind a role for this scope |
/role save <id> <name> [--persona 文案] [--model <id>] [--tools <csv>] [--rules 文案] | 创建 / 更新角色(管理员) Create / update a role (admin) |
/role remove <id> | 删除角色(管理员) Remove a role (admin) |
/notify <scope|chatId> <text> | 跨会话发送通知(管理员) Push a cross-session notification (admin) |
/notify list | 查看 bridge 已注册的 scope List scopes known to the bridge |
/retention [N|default] | 查看或设置保留消息条数(超出自动归档) View or set the live message retention window (overflow is archived) |
/archive [note]、/archive list [N]、/archive clean |
任务完成卡片尾部(每条任务结果自动附带,横排):
✅ 任务完成
─────────────────────────────
模型:deepseek-v4-pro · 推理:max · 上下文:45% · 缓存:62% · 费用:¥0.052
模型 / 推理强度来自 dsh 配置,上下文占用与缓存命中率来自 usage 事件,费用按 DeepSeek 官方峰谷定价实时估算(高峰 9-12 / 14-18 点)。
表情快捷指令(对任意 bot 消息加表情触发;需飞书后台权限与事件订阅,见「配置」):
| 表情 | 动作 |
|---|
| 💳 | 发送当前会话费用(同 /cost) |
| 📊 | 发送当前会话统计(同 /stats) |
| 👍 | 收到确认 |
对话增强(均可通过环境变量关闭,见「配置」):任务回复自动进入飞书话题(DSH_LARK_THREAD_REPLY);任务结束给触发消息加 ✅/❌/⏹ 表情(DSH_LARK_REACTION_ON_SETTLE);任务完成自动 Pin 结果卡片(DSH_LARK_AUTO_PIN);你继续发消息时自动给上一条 bot 消息加 👀 已读反馈(DSH_LARK_READ_RECEIPT)。
飞书消息中的图片会下载到本地 media 目录并传给 dsh;文本类文件会读取内容并注入任务上下文。
Images in Feishu messages are downloaded to the local media directory and passed to dsh; text files are read and their content is injected into the task context.
同一 scope(私聊 / 群聊 / 话题)默认允许 2 个任务并行(DSH_LARK_SCOPE_CONCURRENCY 或
/concurrency 调整):连续发来的多条消息会以独立 run 并行推进,每个 run 使用独立的 dsh
session 与独立 runId,/status 展示全部运行中的 run,/stop 一次性终止全部任务。
Each scope (DM / group / topic) runs up to 2 tasks in parallel by default (adjust with
DSH_LARK_SCOPE_CONCURRENCY or /concurrency): successive messages become independent runs,
each with its own dsh session and run id. /status lists every active run and /stop interrupts
them all.
多角色 Agent:管理员用 /role save <id> <name> --persona <文案> [--model <id>] [--tools <csv>] [--rules <文案>] 定义 PM / 开发 / 文档等角色(persona、模型偏好、工具指引、角色规则),
/role set <id> 把角色绑定到当前 scope:下一轮起该 scope 的每个 run 都携带角色 persona 与
规则,并优先使用角色模型(角色模型 < 每会话 /model use)。角色定义持久化在
~/.dsh-lark/profiles/<profile>/roles.json。
Multi-role agents: admins define roles (PM / dev / docs / …) with /role save <id> <name> --persona <text> [--model <id>] [--tools <csv>] [--rules <text>] — persona, model preference,
tool guidance and role rules — then bind one to the current scope with /role set <id>. Every
run in that scope carries the role instructions, and the role model wins below the per-session
/model use override. Role definitions persist in
~/.dsh-lark/profiles/<profile>/roles.json.
出站 @ 提及与跨会话通知:bridge 出站契约支持 mentions(@ 提及)与跨 chat/thread 发送;
/notify <scope|chatId> <text> 可向其他会话推送汇报(管理员)。agent 侧还内置 lark_notify
dsh 工具(SDK / ACP 两种 runtime 均可装配):agent 完成任务后可主动向其他群 / 话题发消息并
@ 指定成员,桥接进程通过 127.0.0.1 本地回调端口 + 随机 token 校验,不暴露公网。
任务中向你提问(问答卡):agent 需要你拍板、确认或补充缺失信息时,会通过
lark_ask_user 工具主动向当前会话弹一张问答卡(单选 / 多选 / 自由文本),
你回答后任务自动继续——无需额外命令。问答卡等待期间任务不会被运行超时打断。
(与 /ask 的“你主动发结构化问题”方向相反:这是 agent 主动来问你。)
Outbound mentions & cross-session notify: the outbound contract supports mentions and
cross-chat/thread sends; /notify <scope|chatId> <text> pushes a report to another session
(admin). The agent also gets a built-in lark_notify dsh tool (wired into both SDK and ACP
runtime profiles): after a task finishes it can push messages to other groups/topics and @mention
members. The bridge listens on 127.0.0.1 with a random per-boot token — nothing is exposed to the
public network.
Mid-task questions (question cards): when the agent needs a decision, confirmation, or
missing information, it proactively sends a question card to the current chat via the
lark_ask_user tool (single choice / multi choice / free text) and resumes automatically once
you answer — no extra command needed. The run-timeout watchdog pauses while a card is waiting.
(This is the opposite direction of /ask, which is you asking the agent.)
安全网守护(Safe-mode guardian):默认随 setup 一起安装的、独立于 dsh 进程、系统级常驻的
最小守护进程(Linux systemd user unit / macOS LaunchAgent / Windows 启动项)。dsh 正常运行时守护保持静默;
一旦 dsh 进程下线或无法 boot(例如某个第三方插件破坏了整个 profile 组合),守护自动接管飞书
通道,用户无需接触命令行即可发送控制信号自救:
/safemode:进入仅核心安全模式——守护创建 ~/.dsh/profiles/<profile>-safe(仅
dsh-base + dsh-headless 两个官方核心 bundle,不加载任何第三方插件),后续消息经
守护转发给该核心 dsh 逐条对话,配合代码执行能力定位 / 修复 / 禁用损坏插件;安全模式优先使用
官方 SDK 流式引擎(实时思考 / 工具调用 / web search / 打字机式文字输出,与正常模式同一张
流式卡),SDK runtime 不可用时自动回退 headless(任务期间卡片仍实时显示“正在思考 / 已运行 Ns /
无响应 Ns”活动状态);
/safemode plugins:列出故障 profile 已安装的插件清单(自愈诊断);
/safemode status:查看守护 / dsh / 安全模式状态;
/safemode stop:终止当前正在运行的安全模式任务(也可点击任务卡片上的 ⏹ 按钮);
/safemode exit:退出安全模式,守护重启完整 profile 并把飞书通道交还给正常形态;
安全模式任务有空闲超时(DSH_LARK_GUARDIAN_SAFE_TIMEOUT_MS,默认 10 分钟:任务持续无
活动事件才被终止,活跃的流式任务不会被误杀),超时或失败都会在卡片上给出明确终态,不会无声
挂起。全程不需要命令行;dsh 恢复后守护自动断开并回归静默。安装:
# 随 setup 默认安装(无需额外参数);已安装后也可单独安装 / 重装:
dsh-lark-bot guardian install --dsh-profile dsh-lark
不需要守护时,安装时加 --no-guardian 跳过;单独卸载用 dsh-lark-bot guardian uninstall。
Safety-net guardian: a minimal system-level resident process installed by default with
setup, independent of the dsh process. While dsh runs, the guardian stays silent; once dsh goes down or
fails to boot (e.g. a third-party plugin breaks the whole profile composition), the guardian
takes over the Feishu channel so you can self-heal without touching the command line:
/safemode: enter core-only safe mode — the guardian provisions
~/.dsh/profiles/<profile>-safe with only the two official core bundles (dsh-base +
dsh-headless, no third-party plugins) and proxies a restricted conversation to that core
dsh so you can locate / fix / disable the offending plugin. Safe mode prefers the official
SDK streaming engine (real-time reasoning / tool calls / web search / typewriter text on the
same streaming card as normal mode) and falls back to headless with a live activity card
("thinking / elapsed Ns / no response Ns") when the SDK runtime cannot be provisioned;
/safemode plugins: list the plugins installed into the broken profile;
/safemode status: show guardian / dsh / safe-mode state;
/safemode stop: interrupt the currently running safe-mode task (or use the ⏹ button on the card);
/safemode exit: leave safe mode — the guardian relaunches the full profile and hands the
Feishu channel back;
Safe-mode tasks are bounded by an idle timeout
(DSH_LARK_GUARDIAN_SAFE_TIMEOUT_MS, default 10 minutes: a task is stopped only after it has
been silent for the whole window, so active streaming work is never cut short); timeouts and failures always surface a
clear terminal state on the card instead of hanging silently. No command line is needed for the
whole rescue flow; once dsh is back, the guardian releases the channel automatically. Install:
# Installed by default with setup (no extra flag); can also be installed / refreshed later:
dsh-lark-bot guardian install --dsh-profile dsh-lark
Pass --no-guardian to setup to skip it; remove it later with dsh-lark-bot guardian uninstall.
模型 / Provider / 凭据管理 | Models / Providers / Credentials
模型与 provider 的配置以 dsh 官方方式持久化(与 dsh Web Settings → Models 页面完全相同的
存储协议),改动在下一个请求生效,无需重启 bot:
Model and provider configuration is persisted the official dsh way (the exact storage protocol
used by the dsh Web Settings → Models page); changes take effect on the next request without
restarting the bot:
-
/model use <id>:按会话热切换模型,下一轮消息即用新模型。
-
/model default <id>:写入 dsh 的 agent-default-model,作为新会话的默认模型。
-
/providers:展示 dsh 已配置的 provider、模型与凭据状态(DeepSeek 官方 + 自定义 pi-ai)。
-
/provider add|update|remove:管理自定义 provider(llm-pi-ai)或 deepseek-official;
自定义 provider 需要 --api(openai-completions / openai-responses / anthropic-messages)、
--base-url 与至少一个 --model,与官方 schema 一致。
-
/key set|remove|list:读写 ~/.dsh/.credentials.yaml(0600)。settings 只保存 apiKeyEnv
引用,字面密钥不进入 settings 或聊天记录。
-
/model use <id>: hot-switch the model for this session; the next message uses it.
-
/model default <id>: write the dsh agent-default-model as the default for new sessions.
-
/providers: show configured providers, models and credential status (official DeepSeek + custom pi-ai).
-
/provider add|update|remove: manage custom providers (llm-pi-ai) or deepseek-official;
a custom provider needs --api (openai-completions / openai-responses / anthropic-messages),
--base-url and at least one --model, matching the official schema.
-
/key set|remove|list: read / write ~/.dsh/.credentials.yaml (0600). Settings keep only
apiKeyEnv references; literal keys never enter settings or chat history.
安全提醒:在飞书会话里输入密钥会对该会话的可见成员暴露密钥,建议仅在私聊中使用,或优先用
--api-key-env 引用已配置的环境变量 / dsh Web 页面录入。bot 不会在任何回复中回显密钥值。
Security note: typing a key in a Feishu conversation exposes it to everyone who can see that
chat; prefer private chats, --api-key-env references to existing environment variables, or the
dsh Web UI. The bot never echoes key values in any reply.
安装与卸载 | Install & Uninstall
安装 | Install
唯一安装方式(标准 dsh profile bundle):
The only install path (a standard dsh profile bundle):
npx dsh-lark-bot@latest setup --profile dsh-lark
setup 自动完成:定位本机 dsh → 预批准 pnpm 构建策略(protobufjs)→ 执行标准
dsh plugin --profile dsh-lark add dsh-lark-bot,并默认同时安装「安全网守护」
(见「安全网守护」一节;不需要时加 --no-guardian 跳过)。已安装时重复执行即升级到最新版。
setup locates your dsh, pre-approves pnpm's build policy (protobufjs) and runs the standard
dsh plugin --profile dsh-lark add dsh-lark-bot. It also installs the safety-net guardian by
default (see "Safety-net guardian" above; pass --no-guardian to skip). Re-running it upgrades
to the latest version.
升级 | Upgrade
-
插件本体:重跑 setup(或 dsh plugin --profile <name> add dsh-lark-bot)拉取 npm 最新版。
-
安全网守护:随 setup 一起安装 / 升级(幂等重装),也可单独 dsh-lark-bot guardian install。
-
CLI 工具(可选):npm i -g dsh-lark-bot@latest;使用 npx 时无需全局安装。
-
升级后重启 profile:dsh --profile dsh-lark。
-
Plugin: re-run setup (or dsh plugin --profile <name> add dsh-lark-bot) to pull the latest
npm release.
-
Safety-net guardian: installed / upgraded together with setup (idempotent), or standalone via
dsh-lark-bot guardian install.
-
CLI tool (optional): npm i -g dsh-lark-bot@latest; not needed when using npx.
-
Restart the profile after upgrading: dsh --profile dsh-lark.
禁用 | Disable
保持插件加载但停止桥接引擎:启动 profile 前导出 DSH_LARK_DISABLED=1。彻底移除见下节。
Keep the plugin loaded but stop the bridge engine: export DSH_LARK_DISABLED=1 before booting
the profile. For full removal see the next subsection.
卸载 | Uninstall
dsh plugin --profile dsh-lark remove dsh-lark-bot
卸载后 profile 不再加载本插件。本地状态(配置 / 会话 / 归档 / 角色)保留在 ~/.dsh-lark;
如需清除,先备份再删除该目录。
Removal unloads the plugin from the profile. Local state (config / sessions / archives / roles)
stays in ~/.dsh-lark; back it up before deleting it.
更详细的安装、状态目录、日志和排障说明见 docs/QUICK_START.md。
See docs/QUICK_START.md for installation details, state directories,
logs and troubleshooting.
关键词 | Keywords
dsh · deepseek · deepseek harness · feishu · lark · bridge · bot
这是什么 | What it is
dsh-lark-bot 是一个轻量桥接工具,把本机的 DeepSeek Harness(dsh)接入飞书 / Lark,复刻当年 OpenCode Telegram Bot / MiMoCode Telegram Bot 的体验——在 IM 里与 coding agent 对话、收流式卡片、审阅 diff,并在此基础上叠加完整的项目工作区管理。
dsh-lark-bot is a lightweight bridge that connects your local DeepSeek Harness (dsh) into Feishu / Lark, recreating the beloved OpenCode / MiMoCode Telegram-bot experience — chat with your coding agent, receive streaming cards, review diffs — and adds full project workspace management on top.
适合谁 / Who it is for:在飞书 / Lark(私聊、群聊、话题)里指挥本机 dsh coding agent 的
开发者与团队,尤其是需要多项目隔离、角色分工、并行任务与会话归档的协作场景。
Developers and teams who drive a local dsh coding agent from Feishu / Lark (DMs, groups,
topics) — especially those needing multi-project isolation, role-based collaboration, parallel
tasks and session archival.
目标 | Goals
-
一条命令安装部署:npx dsh-lark-bot@latest setup --profile dsh-lark 装进 dsh profile,
随后 dsh --profile dsh-lark 启动并扫码,桥接引擎作为标准插件在 dsh 进程内运行。
-
飞书原生体验:流式卡片、交互按钮、图片 / 文件,全程双语(文档评论为规划中能力)。
-
完整工作区管理:多项目隔离、git worktree、项目级规则注入、上下文持久化。
-
One-command install & deploy: npx dsh-lark-bot@latest setup --profile dsh-lark, then
dsh --profile dsh-lark and scan once — the bridge engine runs as a standard plugin inside
the dsh process.
-
Native Feishu experience: streaming cards, interactive buttons, images / files, doc comments.
-
Full workspace management: multi-project isolation, git worktrees, per-project rules, persistent context.
兼容性 | Compatibility
-
DeepSeek Harness(dsh):已验证 dsh 0.1.0-rc.6(最后验证 2026-08-15:SDK JSON-RPC / ACP runtime 握手 +
真实任务流式验证),通过官方 @deepseek-ai/dsh-sdk-client / @deepseek-ai/dsh-acp 接入;
具体锁定版本、升级政策与自动化探测见 docs/COMPATIBILITY.md,
adapter 接入细节见 docs/adapter-notes.md。
-
运行时:Node.js ≥ 22.19(见 package.json engines)。
-
平台:Linux / macOS / Windows(飞书 WebSocket 出站长连接,免公网服务器 / 域名 / 内网穿透)。
-
默认 adapter 为官方 @deepseek-ai/dsh-sdk-client(SDK JSON-RPC runtime,原生 session 续跑 +
token 级流式事件);DSH_LARK_ADAPTER=acp 切到官方 ACP server(审批卡);headless 保留旧版
子进程 fallback;DSH_LARK_ADAPTER=web 驱动本地 dsh web agent(session.prompt +
/api/events.mux,网页端成为唯一写者,从根上消除多写者会话损坏)。首次启动自动在
~/.dsh/profiles/dsh-lark-sdk(或 dsh-lark-acp)创建 runtime profile。
-
DeepSeek Harness (dsh): verified against dsh 0.1.0-rc.6 (last verified 2026-08-15: SDK JSON-RPC / ACP
runtime handshake + real streaming task verification), connected through the official
@deepseek-ai/dsh-sdk-client / @deepseek-ai/dsh-acp; see
docs/COMPATIBILITY.md for pinned versions, the upgrade policy and
automated probing, and docs/adapter-notes.md for adapter details.
-
Runtime: Node.js ≥ 22.19 (see engines in package.json).
-
Platform: Linux / macOS / Windows (Feishu outbound WebSocket long connection; no public
server, domain or tunneling required).
-
The default adapter is the official @deepseek-ai/dsh-sdk-client (SDK JSON-RPC runtime with
native session continuation and token-level streaming events); DSH_LARK_ADAPTER=acp switches
to the official (approval cards); keeps the legacy subprocess
fallback; drives the ( +
— the web agent becomes the single writer, eliminating multi-writer
session-log corruption at the root). On first start the bot creates the runtime profile at
(or ).
已知限制 | Known limitations
-
ACP 模式会话每次全新(上游限制,无续跑);SDK 协议暂无 mid-turn cancel,/stop 会关闭
对应 runtime 并自动重建。
-
桥接引擎作为 dsh 插件在 dsh 进程内运行,agent 执行使用官方 dsh SDK runtime 子进程
(嵌套 runtime 是有意取舍,用于按工作区隔离的 runtime 池与 scope 内并行 run)。
唯一的进程级例外是默认安装的「安全网守护」——它独立于 dsh / Cordis 常驻,仅在 dsh
下线后接管飞书通道,正常运行时保持静默。
-
飞书文档评论、富文本回复为规划中能力,尚未实现。
-
pnpm ≥ 10 的构建脚本策略由 setup 自动处理;手动 dsh plugin add 时若报
ERR_PNPM_IGNORED_BUILDS,按官方指引在 profile 的 pnpm-workspace.yaml 加
allowBuilds: { protobufjs: true } 后重试。
-
ACP sessions are always fresh (an upstream limit); the SDK protocol has no mid-turn cancel,
so /stop closes and recreates the runtime.
-
The engine runs in-process as a dsh plugin; agent execution uses the official dsh SDK runtime
subprocess — a deliberate nested-runtime design for per-workspace runtime pools and parallel
runs. The one process-level exception is the optional safety-net guardian — a minimal
resident process independent of dsh / Cordis that only takes over the Feishu channel after
dsh goes down and stays silent otherwise.
-
Feishu doc comments and rich-text replies are planned, not yet implemented.
-
pnpm ≥ 10 build policy is handled by setup; when installing manually and
ERR_PNPM_IGNORED_BUILDS appears, add allowBuilds: { protobufjs: true } to the profile's
pnpm-workspace.yaml and retry.
配置 | Configuration
飞书后台一次性配置(使用者自行配置,与项目代码无关)
表情反馈(✅/❌/👀)、表情指令(💳/📊/👍)与自动 Pin 依赖飞书开放平台为你的应用开启以下权限与事件订阅(open.feishu.cn → 开发者后台 → 选择应用 → 权限管理 / 事件与回调 → 发布新版本生效):
| 类型 | 名称 | 作用 |
|---|
| 应用权限 | im:message.reaction | bot 添加 / 接收表情 |
| 应用权限 | im:pin | bot Pin 消息(任务完成自动固定结果) |
| 事件订阅 | im.message.reaction.created_v1 | 用户加表情时通知 bot(表情指令触发) |
不配置则表情相关功能静默失效(元数据、话题、计费、/stats 等其余功能不受影响)。
-
本地配置:~/.dsh-lark/config.json
-
状态根目录可用 DSH_LARK_HOME 覆盖
-
环境变量统一使用 DSH_LARK_* 前缀
-
模板见 .env.example
-
敏感项:DSH_LARK_APP_SECRET、DEEPSEEK_API_KEY 等凭据只保存在本机配置 / 环境中,日志与
卡片自动脱敏,仓库只提交 .env.example 模板。
-
Local config: ~/.dsh-lark/config.json
-
The state root can be overridden with DSH_LARK_HOME
-
Environment variables use the DSH_LARK_* prefix
-
Template: .env.example
-
Sensitive values: credentials (DSH_LARK_APP_SECRET, DEEPSEEK_API_KEY, …) stay in local
config/env only; logs and cards are redacted; only .env.example is committed.
会话运行在 Git 仓库中时,会自动在 ~/.dsh-lark/profiles/<profile>/worktrees/<scope>/ 创建隔离 worktree,并复制项目级 AGENTS.md。
When the session runs inside a Git repository, an isolated worktree is created at
~/.dsh-lark/profiles/<profile>/worktrees/<scope>/ and a project-level AGENTS.md is copied in.
每个飞书 scope 默认保存最近 40 条对话消息(可用 /retention 或 DSH_LARK_RETENTION_MSGS
调整);超出保留窗口的消息自动归档到 ~/.dsh-lark/profiles/<profile>/archives/(Markdown +
JSONL,目录本身是 Git 仓库,每次归档独立 commit),支持 /archive 手动归档与保留策略清理。
SDK 模式下 dsh 原生 session 续跑,headless 模式则把历史注入下一次 prompt 实现近似记忆。
Each Feishu scope keeps the last 40 conversation messages by default (adjustable with
/retention or DSH_LARK_RETENTION_MSGS); messages beyond the retention window are archived to
~/.dsh-lark/profiles/<profile>/archives/ (Markdown + JSONL inside a Git repository, one commit
per archive), and /archive exports the full session on demand. The SDK mode continues the native
dsh session, while headless mode approximates memory by injecting history into the next prompt.
当前核心环境变量:
Core environment variables:
| 变量 Variable | 默认值 Default | 说明 Description |
|---|
DSH_LARK_HOME | ~/.dsh-lark | 本地状态根目录 Local state root directory |
DSH_LARK_TENANT | feishu | feishu 或 lark
feishu or lark |
DSH_LARK_WORKSPACE | 未设置 | 新会话默认工作目录 Default working directory for new sessions |
DSH_LARK_DSH_COMMAND | 自动发现 | dsh 启动命令;通常无需设置 dsh launch command; usually not needed |
DSH_LARK_DSH_ARGS | 自动发现 | dsh 启动参数,逗号分隔;通常无需设置 dsh launch args, comma-separated; usually not needed |
DSH_LARK_ADAPTER | sdk | sdk(默认)/ acp(审批)/ headless(legacy)/ web(本地 dsh web agent,单写者)
sdk (default) / acp (approval) / headless (legacy) / web (local dsh web agent, single writer) |
DSH_LARK_PROVIDER | deepseek-official | 模型 provider Model provider |
DSH_LARK_MODEL | deepseek-v4-flash | 默认模型 Default model |
DSH_LARK_MAX_TOKENS | 未设置 | SDK agent 每请求输出 token 上限 Per-request output token cap for SDK agents |
DSH_LARK_WEB_URL | http://127.0.0.1:3080 | web 适配器:本地 dsh web agent 的 base URL
web adapter: base URL of the local dsh web agent |
启动时会自动查找本机常见的 @deepseek-ai/dsh 安装位置。只有自动发现失败或需要指定特殊 profile 时,才需要设置这两个变量。
On startup the bot auto-discovers common local @deepseek-ai/dsh installations. Set these two
variables only when auto-discovery fails or a special profile is required.
权限与数据 | Permissions & Data
本工具在本机运行,安装前请知悉它会访问:
This tool runs locally; before installing, be aware that it accesses:
-
飞书凭据:PersonalAgent 应用的 app_id / app_secret,明文写入本机 ~/.dsh-lark/config.json(文件权限 600)。
-
文件系统:读取 / 写入你通过 /cd、/ws 指定的工作目录(含执行 shell 命令、修改文件)。
-
网络:向飞书开放平台建立 WebSocket 出站长连接收发消息;向 DeepSeek API 发送任务上下文。
-
本地回调:运行 lark_notify 工具时,dsh runtime 子进程通过 127.0.0.1 随机端口 +
每启动随机 token 回调 bridge 进程(仅本机回环,不监听公网)。
-
进程:spawn 本机 dsh runtime 子进程(dsh-sdk-jsonrpc-server / dsh-acp profile)执行 agent 任务。
-
dsh 配置:/model /providers /provider /key 命令按 dsh 官方存储协议读写
~/.dsh/settings.yaml 与 ~/.dsh/.credentials.yaml(仅管理员可写;settings 只存 apiKeyEnv
引用,凭据文件权限 0600、目录 0700,字面密钥不进入 settings 或聊天记录)。
-
安全网守护(默认随 setup 安装):系统级常驻进程,读取 ~/.dsh-lark/config.json 中的飞书
凭据;dsh 下线时接管同一 bot 的飞书长连接并扫描本机进程(仅 ps 命令行,不读内存);
/safemode 时创建仅官方核心的 dsh profile(headless 或 SDK JSON-RPC runtime,均无第三方插件)
并逐条执行任务;SDK 引擎会以官方 dsh-sdk-jsonrpc-server 子进程提供实时流式事件。
-
Feishu credentials: the PersonalAgent app app_id / app_secret, stored in plaintext at
~/.dsh-lark/config.json (file mode 600).
-
File system: reads / writes the working directories you choose with /cd and /ws
(including running shell commands and modifying files).
-
Network: an outbound WebSocket long connection to the Feishu open platform for messages, and
task context sent to the DeepSeek API.
-
Local callback: when the lark_notify tool runs, the dsh runtime subprocess calls the
bridge process back over a random 127.0.0.1 port with a per-boot token (loopback only).
-
Processes: spawns local dsh runtime subprocesses (dsh-sdk-jsonrpc-server / dsh-acp
profiles) to run agent tasks.
-
dsh configuration: /model read / write
and using the official dsh storage protocol
(admin-only writes; settings keep only references; credentials file mode 0600,
directory 0700; literal keys never enter settings or chat history).
所有数据仅在本机与飞书、DeepSeek 之间流转,不收集、不上传任何遥测。密钥不会提交进仓库(见 .gitignore)。
All data flows only between this machine, Feishu and DeepSeek; nothing is collected or uploaded
as telemetry. Keys are never committed to the repository (see .gitignore).
排障 | Troubleshooting
先运行 dsh-lark-bot doctor,它会检查 profile、工作目录,并对当前 adapter 做真实可用性探测
(sdk / acp / headless 对应 runtime 的初始化握手)。
Run dsh-lark-bot doctor first; it checks the profile and working directory and performs a real
availability probe for the current adapter (sdk / acp / headless runtime handshake).
常见问题:
Common issues:
-
bot 静默 / 长连接失败:查看 stderr 上的 JSONL 日志,关注 channel 与 channel-command 类别;SDK 会自动重连。
-
agent 无响应:发送 /status 查看当前 scope、cwd 和 active run;发送 /stop 终止当前任务;持续无响应超过 DSH_LARK_RUN_TIMEOUT_MS 时看门狗会自动终止(空闲超时,活跃任务不会被误杀)。
-
首次扫码失败:确认本机时间准确、网络可访问飞书开放平台;已拿到 App ID/Secret 时可用 --app-id / --app-secret 跳过扫码。
-
Silent bot / long-connection failure: check the JSONL logs on stderr, focusing on the
channel and channel-command categories; the SDK reconnects automatically.
-
Unresponsive agent: send /status to view the scope, cwd and active run; send /stop to
terminate the current task; the idle watchdog terminates it automatically after it has been
silent for DSH_LARK_RUN_TIMEOUT_MS (active streaming work is never cut short).
-
First QR binding fails: make sure the local clock is accurate and the Feishu open platform
is reachable; with an existing App ID/Secret you can skip scanning via --app-id /
--app-secret.
桥接引擎日志以 JSON Lines 输出到 stderr(由 dsh 宿主进程捕获;logs/bot.log 是 0.6.0
独立服务时代的遗留路径,0.7.0 起不再写入);dsh 宿主日志走 dsh 自己的日志体系。
The bridge engine logs JSON Lines to stderr (captured by the dsh host; logs/bot.log is a
leftover path from the 0.6.0 standalone-service era and is no longer written since 0.7.0); the
dsh host uses its own logging.
回滚 / Rollback:dsh plugin --profile dsh-lark remove dsh-lark-bot 后重装固定版本即可
(如 dsh plugin --profile dsh-lark add dsh-lark-bot@0.6.0);~/.dsh-lark 状态独立于插件
本体,升级 / 回滚不会丢失配置与会话。
To roll back: remove the plugin and reinstall a pinned version (e.g.
dsh plugin --profile dsh-lark add dsh-lark-bot@0.6.0); ~/.dsh-lark state is independent of
the package, so config and sessions survive upgrades / rollbacks.
开发 | Development
pnpm install
pnpm typecheck
pnpm test
pnpm build
pnpm check:publish-bundle # 校验 dist 与全部 exports/bin 入口一致(发布前防线)| verifies dist matches every export & the CLI entry (release gate)
pnpm ci:local
pnpm release:check # ci:local + 上游一致性检查 | ci:local + upstream consistency check
pnpm compat:probe # 临时 DSH_HOME 安装锁定版 dsh,跑真实 SDK 握手 | installs pinned dsh into a temp DSH_HOME and runs a real SDK handshake
pnpm dsh:upstream # 对比 npm 上游 stable 与锁定矩阵 | compares npm upstream stable with the pinned matrix
开发规范见 AGENTS.md,模块契约见 docs/API.md,架构见 docs/ARCHITECTURE.md。
兼容矩阵的升级政策与自动化见 docs/COMPATIBILITY.md。
See AGENTS.md for the development workflow, docs/API.md for
module contracts, and docs/ARCHITECTURE.md for the architecture. See
docs/COMPATIBILITY.md for the compatibility matrix, upgrade policy
and automation.
贡献 / Contributing:欢迎 Issue 与 PR。开发流程见 AGENTS.md(必读文档、
提交规范与推送边界),生态交付标准见 docs/ECOSYSTEM.md。
Contributions are welcome via Issues and PRs; see AGENTS.md for the workflow
(required reading, commit conventions, push policy) and docs/ECOSYSTEM.md
for ecosystem delivery standards.
发布 dsh-f(先通过 pnpm ci:local 校验,再发布):
Publishing dsh-f (run pnpm ci:local first, then publish):
pnpm ci:local
npm publish --access public
scripts/check-publish-bundle.mjs 会在 ci:local 中校验 package.json 每个 exports 子路径
与 CLI 入口在 dist/ 产物中都存在——任何缺失(如 v0.9.0 的 ask 入口漏拷)都会直接中止发布。
GitHub tag v* 会触发 release.yml 自动发布 dsh-f 并创建
Release。
scripts/check-publish-bundle.mjs is run by ci:local to verify every package.json exports
subpath and the CLI entry actually exist in dist/ — any missing artifact (like the ask entry
in v0.9.0) aborts the publish. A GitHub tag v* triggers
release.yml to publish dsh-f and create a Release
automatically.
维护与支持 | Maintenance
-
状态:活跃维护(Active)。主维护者:PlutoKeating。
-
问题 / 建议:优先在 GitHub Issues 提交;安全漏洞请走 SECURITY.md 的私下报告渠道。
-
Status: active. Primary maintainer: PlutoKeating.
-
Bugs / feature requests: GitHub Issues; security issues via the private channel in
SECURITY.md.
社区收录情况见下节「社区收录情况 | Community Listings」。
See "Community Listings" in the next section for ecosystem registration status.
许可与安全 | License & Security
-
许可证:GNU Affero General Public License v3.0(见 LICENSE)。
-
版权归属:源码版权归项目维护者所有,按 AGPL-3.0 授权;「DeepSeek」「飞书 / Lark」等
商标归各自权利人所有。
-
安全报告:如发现安全漏洞,请通过 GitHub Security Advisory 私下报告,勿公开 issue。
-
安全模型:默认拒绝、密钥脱敏、路径 containment、SSRF 防护、过期事件拒绝与交互工具
默认禁用——详见 SECURITY.md。
-
License: GNU Affero General Public License v3.0 (see LICENSE).
-
Copyright: source is owned by the maintainers and licensed under AGPL-3.0; "DeepSeek" and
"Feishu / Lark" trademarks belong to their respective owners.
-
Security reports: report vulnerabilities privately via GitHub Security Advisory; do not
open a public issue.
-
Security model: default-deny, secret redaction, path containment, SSRF protection, stale
event rejection and default-disabled interactive tools — see SECURITY.md.
文档 | Documentation
接手本项目的工程师:先读 docs/REQUIREMENTS.md 和 docs/RESEARCH.md,即可完整理解项目诉求与来龙去脉,无需线下沟通。
Engineers taking over this project: read docs/REQUIREMENTS.md and docs/RESEARCH.md first.
架构 | Architecture
详见 docs/ARCHITECTURE.md | See docs/ARCHITECTURE.md for details.
飞书 / Lark ──WebSocket 长连接──▶ bridge/ ──▶ session/ ──▶ workspace/ ──▶ adapters/ ──▶ dsh ──▶ DeepSeek V4
核心思路:飞书通道与 agent 后端解耦。桥接层复刻 lark-channel-bridge 的成熟做法(WebSocket 长连接 + 流式卡片 + 会话路由),agent 后端通过 adapter 抽象,默认挂接官方 DeepSeek Harness SDK(DSH_LARK_ADAPTER=sdk),可选 ACP 审批模式与 legacy headless。
默认安装的「安全网守护」(src/guardian/)独立于 dsh 进程常驻:dsh 在线时静默,下线时接管飞书
通道接收 /safemode 控制信号,以仅核心 profile(dsh-base + dsh-headless)拉起受限对话
用于自愈,/safemode exit 重启完整 profile 并交还通道。
The core idea: decouple the Feishu channel from the agent backend. The bridge layer follows the battle-tested lark-channel-bridge approach (WebSocket long-connection + streaming cards + session routing); the agent backend is abstracted behind an adapter, defaulting to the official DeepSeek Harness SDK (DSH_LARK_ADAPTER=sdk), with an optional ACP approval mode and the legacy headless fallback.
The optional safety-net guardian (src/guardian/) runs as a separate resident process: silent
while dsh is up, it takes over the Feishu channel when dsh goes down, accepts /safemode control
signals, runs a restricted core-only conversation (dsh-base + dsh-headless) for self-healing,
and relaunches the full profile on /safemode exit.
目录结构 | Directory Structure
| 目录 Dir | 职责 Responsibility |
|---|
src/bridge/ | 飞书通道接入(消息、卡片、媒体) Feishu channel integration |
src/onboard/ | 首次扫码创建 / 绑定 PersonalAgent 应用 First-run QR onboarding |
src/session/ | 会话路由、排队、访问控制 Session routing, queueing, access control |
src/workspace/ | 项目工作区、git worktree 隔离与规则注入 Project workspace, git worktree isolation & rule injection |
src/adapters/ | agent 后端适配器(sdk 默认 / acp 审批 / headless legacy) Agent backend adapters (sdk / acp / headless) |
src/card/ | 流式卡片状态与渲染 Streaming card state & rendering |
src/bot/ | 运行注册、消息排队、审批/问答注册表 Run registry, queueing, approval/question registries |
src/commands/ | 斜杠命令(/cd /ws /new …) Slash commands |
src/cli/ | CLI 入口:setup(唯一安装命令)/ doctor(诊断)/ 隐藏 run CLI entry: setup / doctor / hidden run |
src/guardian/ | 安全网守护:心跳、进程观察、仅核心安全 profile、接管状态机、系统服务安装 Safety-net guardian: heartbeat, process watch, core-only safe profile, takeover state machine, service install |
src/config/ | profile / 配置 / 访问白名单 / dsh 配置管理 Profile, config, access & dsh config management |
src/core/ | 结构化日志 Structured logging |
src/media/ | 附件下载与文本注入 Attachment download & text injection |
src/platform/ | 跨平台原子写入 Cross-platform atomic writes |
docs/ | 架构、路线图等文档Architecture, roadmap & docs |
路线图 | Roadmap
见 docs/roadmap.md | See docs/roadmap.md.
参考项目 | References
社区收录情况 | Community Listings
本项目的社区收录 / 推荐状态,随提交的更新请求持续维护。截至 v0.10.2:
Community listing & recommendation status, kept current as update requests land. As of v0.10.2:
| 平台 Platform | 状态 Status | 说明 Notes |
|---|
| awesome-dsh-plugins | ✅ 已收录 · 运行级可用 Listed · runtime-verified | 社区榜单标注 ✅ 运行级可用,2026-08-14 agent 实测通过;收录条目更新至 v0.8.0(PR #127 已合并),v0.10.2 同步已跟进(#139 最新评论) Shown as ✅ 运行级可用 in the community leaderboard; agent-tested on 2026-08-14; v0.8.0 entry merged via PR #127; v0.10.2 sync requested in #139 |
| dshfind | ✅ 已收录 · 详情页已上线 Listed · detail page live | 中英日韩四语详情页已上线(含安装命令与亮点),条目名称正常(issue #2 已关闭);v0.10.2 数据刷新已提交(issue #6);顶部徽章 / 展示卡来自 dshfind Four-language detail page is live (install command & highlights), entry name fixed (issue #2 closed); v0.10.2 data refresh requested in issue #6; the header badge / card comes from dshfind |
| omdsh-dev/community | ✅ 已提交收录申请 Submission submitted | [Plugin] 收录申请(Discussion #12)已通过;v0.8.0 更新、六项独家亮点与 v0.10.1 / v0.10.2 稳定性修复说明均已发布在该讨论
[Plugin] submission (Discussion #12) accepted; v0.8.0 update, the six-exclusive-highlights summary and the v0.10.1 / v0.10.2 stability-fix notes are all posted there |
更新请求进度 / Update request status:
Update requests:
亮点跟进 / Highlights follow-ups(六项独家能力与 issue #6 设计实现):
- awesome-dsh-plugins 榜单行同步(仓库描述 → 最新)与 agent-test 报告名称异常:#139 — 📨 已提交(维护方已确认,等待渲染周期同步)
- dshfind 详情页补「对话内管理模型和密钥」亮点:#2 跟进评论 — 📨 已提交
- omdsh 六项独家亮点补充(含 Guardian 设计实现):Discussion #12 亮点评论 — 📨 已提交
Highlights follow-ups (six exclusive capabilities & the issue #6 design):
- awesome-dsh-plugins leaderboard row sync (repo description → latest) & agent-test name anomaly: #139 — 📨 submitted (maintainer confirmed; awaiting the snapshot/render cycle)
- dshfind detail page: add the in-chat model/key management highlight: #2 follow-up — 📨 submitted
- omdsh six-exclusive-highlights summary (incl. the Guardian design): Discussion #12 highlights comment — 📨 submitted
免责声明 | Disclaimer
[!NOTE]
本项目为非官方社区工具,与 DeepSeek、字节跳动 / 飞书(Lark)无关联,亦未获得其背书。DeepSeek Harness、Feishu / Lark 及相关商标归各自权利人所有。
This is an unofficial community tool, not affiliated with or endorsed by DeepSeek or ByteDance / Feishu (Lark). DeepSeek Harness, Feishu / Lark and related trademarks belong to their respective owners.