dsh-lark-bot
plutokeating/dsh-lark-bot
Bridge DeepSeek Harness (dsh) into Feishu / Lark with streaming cards, project workspaces, approvals and scheduling
Install
dsh plugin --profile web add github:plutokeating/dsh-lark-botREADME
dsh-lark-bot
把 DeepSeek Harness 接入飞书 | Bridge DeepSeek Harness into Feishu / Lark
让 DeepSeek Harness(dsh) 成为你飞书里的一员:在手机、群聊、话题里指挥本机 coding agent,把对话、任务、卡片和项目工作区都收进同一个协作流。
Turn DeepSeek Harness (dsh) into a member of your Feishu / Lark workspace — drive your local coding agent from mobile, group chats and topics, and fold conversations, tasks, cards and project workspaces into one collaborative flow.
快速开始 | 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。
setup automatically: locates your dsh install → pre-approves pnpm's build policy → runs the
standard dsh plugin --profile dsh-lark add dsh-lark-bot.
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.
4. 基本使用 | 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 | 手动归档 / 查看 / 清理会话记录 Archive / list / clean session transcripts |
/density [compact|standard|detailed] | 查看或设置卡片密度 View or set card density |
/model | 查看当前模型、dsh 默认模型与可用模型列表 View current model, dsh default model and available models |
/model use <id> | 热切换当前会话模型(下一轮生效,无需重启) Hot-switch the current session model (effective next message, no restart) |
/model default <id> | 写入 dsh 默认模型 agent-default-model(管理员)Write the dsh default model agent-default-model (admin) |
/model add|remove <provider> <modelId> | 添加 / 删除 provider 的模型(管理员) Add / remove a provider model (admin) |
/providers | 查看 dsh 已配置 providers、模型与凭据状态 View configured dsh providers, models and credential status |
/provider add|update|remove <id> | 管理 provider(管理员;deepseek-official 与自定义 pi-ai) Manage providers (admin; deepseek-official and custom pi-ai) |
/key set|remove|list <引用名> | 管理 dsh 凭据(set / remove 需管理员) Manage dsh credentials (set / remove require admin) |
/ask <问题> | 发送问答卡,回答写入会话上下文 Send a Q&A card; the answer is written back to session context |
/invite user|admin|group <id>、/invite list、/invite remove user|group <id> | 管理访问白名单 Manage the access allowlist |
/help | 查看帮助 Show help |
飞书消息中的图片会下载到本地 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 校验,不暴露公网。
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.
安全网守护(Safe-mode guardian):可选安装一个独立于 dsh 进程、系统级常驻的最小守护进程 (Linux systemd user unit / macOS LaunchAgent / Windows 启动项)。dsh 正常运行时守护保持静默; 一旦 dsh 进程下线或无法 boot(例如某个第三方插件破坏了整个 profile 组合),守护自动接管飞书 通道,用户无需接触命令行即可发送控制信号自救:
/safemode:进入仅核心安全模式——守护创建~/.dsh/profiles/<profile>-safe(仅dsh-base+dsh-headless两个官方核心 bundle,不加载任何第三方插件),后续消息经 守护转发给该核心 dsh 逐条对话,配合代码执行能力定位 / 修复 / 禁用损坏插件;/safemode plugins:列出故障 profile 已安装的插件清单(自愈诊断);/safemode status:查看守护 / dsh / 安全模式状态;/safemode exit:退出安全模式,守护重启完整 profile 并把飞书通道交还给正常形态;
全程不需要命令行;dsh 恢复后守护自动断开并回归静默。安装:
npx dsh-lark-bot@latest setup --profile dsh-lark --guardian
# 或已安装后单独安装:dsh-lark-bot guardian install
Safety-net guardian: optionally install a minimal system-level resident process that is 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>-safewith 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;/safemode plugins: list the plugins installed into the broken profile;/safemode status: show guardian / dsh / safe-mode state;/safemode exit: leave safe mode — the guardian relaunches the full profile and hands the Feishu channel back;
No command line is needed for the whole rescue flow; once dsh is back, the guardian releases the channel automatically. Install:
npx dsh-lark-bot@latest setup --profile dsh-lark --guardian
# or later: dsh-lark-bot guardian install
模型 / 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 dshagent-default-modelas 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) ordeepseek-official; a custom provider needs--api(openai-completions/openai-responses/anthropic-messages),--base-urland at least one--model, matching the official schema. -
/key set|remove|list: read / write~/.dsh/.credentials.yaml(0600). Settings keep onlyapiKeyEnvreferences; 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。加 --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. Adding --guardian also installs the
safety-net guardian (see "Safety-net guardian" above). Re-running it upgrades to the latest version.
升级 | Upgrade
-
插件本体:重跑
setup(或dsh plugin --profile <name> add dsh-lark-bot)拉取 npm 最新版。 -
CLI 工具(可选):
npm i -g dsh-lark-bot@latest;使用npx时无需全局安装。 -
升级后重启 profile:
dsh --profile dsh-lark。 -
Plugin: re-run
setup(ordsh plugin --profile <name> add dsh-lark-bot) to pull the latest npm release. -
CLI tool (optional):
npm i -g dsh-lark-bot@latest; not needed when usingnpx. -
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, thendsh --profile dsh-larkand 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.jsonengines)。 -
平台: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/profiles/dsh-lark(或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; seedocs/COMPATIBILITY.mdfor pinned versions, the upgrade policy and automated probing, anddocs/adapter-notes.mdfor adapter details. -
Runtime: Node.js ≥ 22.19 (see
enginesinpackage.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=acpswitches to the official ACP server (approval cards);headlesskeeps the legacy subprocess fallback. On first start the bot creates the runtime profile at~/.dsh/profiles/dsh-lark(ordsh-lark-acp).
已知限制 | 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
/stopcloses 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 andERR_PNPM_IGNORED_BUILDSappears, addallowBuilds: { protobufjs: true }to the profile'spnpm-workspace.yamland retry.
配置 | Configuration
-
本地配置:
~/.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.exampleis 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 或 larkfeishu 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)sdk (default) / acp (approval) / headless (legacy) |
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_ACCESS_DEFAULT_DENY | false | 无白名单时拒绝私聊 Reject private chats when no allowlist is configured |
DSH_LARK_EVENT_FRESHNESS_MS | 600000 | 过期消息拒绝窗口(0 关闭) Stale-message rejection window (0 disables) |
DSH_LARK_RUN_TIMEOUT_MS | 300000 | 单次运行墙钟超时 Wall-clock timeout for a single run |
DSH_LARK_STOP_GRACE_MS | 5000 | SIGTERM 后等待优雅退出再 SIGKILL 的宽限期 Grace period after SIGTERM before SIGKILL |
DSH_LARK_SCOPE_CONCURRENCY | 2 | 每个 scope 的并行任务数(1=严格串行) Concurrent runs per scope (1 = strictly serial) |
DSH_LARK_RETENTION_MSGS | 40 | 每个 scope 保留的消息条数(0=全部保留) Messages kept per scope (0 keeps everything) |
DSH_LARK_ARCHIVE_MAX | 50 | 每个 scope 最多保留的归档数(0=不清理) Max archives kept per scope (0 disables pruning) |
DSH_LARK_ARCHIVE_MAX_AGE_DAYS | 90 | 归档最大保留天数(0=不清理) Max archive age in days (0 disables pruning) |
DSH_LARK_HEARTBEAT_MS | 5000 | 桥接引擎心跳写入间隔(守护存活信号) Bridge heartbeat write interval (guardian liveness signal) |
DSH_LARK_GUARDIAN_DISABLED | false | 1 时安全网守护进程保持停止1 keeps the safety-net guardian stopped |
DSH_LARK_GUARDIAN_PROFILE | dsh-lark | 守护监视 / 重启的 dsh profile(首次安装时写入状态) dsh profile the guardian watches / relaunches (persisted on install) |
DSH_LARK_GUARDIAN_BRIDGE_PROFILE | default | 提供飞书凭据与白名单的桥接状态 profile Bridge state profile providing Feishu credentials / allowlist |
DSH_LARK_GUARDIAN_POLL_MS | 2000 | 守护看门狗轮询间隔 Guardian watchdog poll interval |
DSH_LARK_GUARDIAN_STALE_MS | 15000 | 心跳超时阈值,超过且无 dsh 进程则接管飞书通道 Heartbeat staleness threshold before channel takeover |
DSH_LARK_GUARDIAN_ENGINE_DEAD_MS | 120000 | dsh 进程存活但心跳持续超时该时长,判定桥接引擎已死并接管 Live dsh process with heartbeat stale this long is treated as engine-dead (takeover) |
启动时会自动查找本机常见的 @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 本机
dshruntime 子进程(dsh-sdk-jsonrpc-server/dsh-acpprofile)执行 agent 任务。 -
dsh 配置:
/model/providers/provider/key命令按 dsh 官方存储协议读写~/.dsh/settings.yaml与~/.dsh/.credentials.yaml(仅管理员可写;settings 只存apiKeyEnv引用,凭据文件权限 0600、目录 0700,字面密钥不进入 settings 或聊天记录)。 -
安全网守护(可选):安装后为系统级常驻进程,读取
~/.dsh-lark/config.json中的飞书 凭据;dsh 下线时接管同一 bot 的飞书长连接并扫描本机进程(仅ps命令行,不读内存);/safemode时在~/.dsh/profiles/<profile>-safe创建仅核心的 dsh profile 并逐条执行dsh --profile <safe> "<prompt>"子进程。 -
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
/cdand/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_notifytool 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
dshruntime subprocesses (dsh-sdk-jsonrpc-server/dsh-acpprofiles) to run agent tasks. -
dsh configuration:
/model/providers/provider/keyread / write~/.dsh/settings.yamland~/.dsh/.credentials.yamlusing the official dsh storage protocol (admin-only writes; settings keep onlyapiKeyEnvreferences; credentials file mode 0600, directory 0700; literal keys never enter settings or chat history). -
Safety-net guardian (optional): when installed, a system-level resident process reads the Feishu credentials from
~/.dsh-lark/config.json; it takes over the same bot's Feishu long connection only after dsh goes down and scans local processes (command lines viapsonly, no memory access). On/safemodeit provisions a core-only dsh profile at~/.dsh/profiles/<profile>-safeand runsdsh --profile <safe> "<prompt>"per message.
所有数据仅在本机与飞书、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
channelandchannel-commandcategories; the SDK reconnects automatically. -
Unresponsive agent: send
/statusto view the scope, cwd and active run; send/stopto terminate the current task; the watchdog terminates it automatically afterDSH_LARK_RUN_TIMEOUT_MS. -
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.
桥接引擎日志写入 ~/.dsh-lark/profiles/<profile>/logs/bot.log(JSON Lines);dsh 宿主日志走
dsh 自己的日志体系。
The bridge engine logs to ~/.dsh-lark/profiles/<profile>/logs/bot.log (JSON Lines); 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 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-lark-bot 与 dsh-feishu-bot 共享同一份 dist / 版本 / 依赖):
Publishing both packages (dsh-lark-bot and dsh-feishu-bot share the same dist / version /
dependencies):
pnpm publish:dual:dry-run
pnpm publish:dual
scripts/publish-dual-packages.mjs 从根 package.json 生成两份仅 name / bin 不同的发布清单,避免两份源码漂移。GitHub tag v* 会触发 release.yml 自动发布两个 npm 包并创建 Release。
scripts/publish-dual-packages.mjs generates two publish manifests from the root
package.json, differing only in name / bin, so the two copies never drift. A GitHub tag
v* triggers release.yml to publish both npm packages and
create a Release automatically.
同一份 dist 还会以 @plutokeating/dsh-lark-bot 和 @plutokeating/dsh-feishu-bot 发布到 GitHub Packages,便于在 GitHub Packages 页面查看。
The same dist is also published to GitHub Packages as @plutokeating/dsh-lark-bot and
@plutokeating/dsh-feishu-bot, viewable on the GitHub Packages page.
维护与支持 | 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: readdocs/REQUIREMENTS.mdanddocs/RESEARCH.mdfirst.
| 文档 Doc | 内容 Content |
|---|---|
docs/REQUIREMENTS.md | 完整项目诉求、产出预期、规范与约束 Complete requirements, outputs & specifications |
docs/RESEARCH.md | 调研报告:官方现状、参考项目、可行性、技术差异 Research: official status, references, feasibility |
docs/ARCHITECTURE.md | 架构分层与目录映射 Architecture layering & directory mapping |
docs/API.md | 模块接口与契约 Module interfaces & contracts |
docs/QUICK_START.md | 安装与快速开始 Install & quick start |
docs/COMPATIBILITY.md | 兼容矩阵、升级政策与自动化 Compatibility matrix, upgrade policy & automation |
docs/MANUAL.md | 完整用户手册 Complete user manual |
docs/adapter-notes.md | dsh adapter 接入说明(接口 / 落点 / 路线) How to plug the dsh adapter |
docs/ECOSYSTEM.md | 生态兼容与交付标准(实现工程师必读) Ecosystem & delivery standards (for engineers) |
docs/roadmap.md | 路线图与里程碑 Roadmap & milestones |
docs/PLAN.md | 主线开发计划与验收标准 Development plan & acceptance criteria |
SECURITY.md | 安全模型与报告渠道 Security model & reporting |
AGENTS.md | AI Agent 开发工作流规范 AI agent workflow spec |
架构 | Architecture
详见
docs/ARCHITECTURE.md| Seedocs/ARCHITECTURE.mdfor 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(诊断)/ 隐藏 runCLI 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 |
reference/ | 参考研究用的克隆仓库(不提交) Cloned reference repos (not committed) |
路线图 | Roadmap
见 docs/roadmap.md | See docs/roadmap.md.
参考项目 | References
| 项目 Project | 说明 About |
|---|---|
zarazhangrui/lark-coding-agent-bridge | 飞书 ↔ Claude Code / Codex 桥接,本项目的直接参照 Feishu ↔ Claude Code / Codex bridge; the direct reference for this project |
deepseek-ai/deepseek-harness | DeepSeek Harness(dsh),agent 后端DeepSeek Harness ( dsh), the agent backend |
grinev/opencode-telegram-bot | OpenCode 的 Telegram 手机端,另一参照 Telegram mobile client for OpenCode; another reference |
社区收录情况 | Community Listings
本项目的社区收录 / 推荐状态,随提交的更新请求持续维护。截至 v0.8.0: Community listing & recommendation status, kept current as update requests land. As of v0.8.0:
| 平台 Platform | 状态 Status | 说明 Notes |
|---|---|---|
| awesome-dsh-plugins | ✅ 已收录 · 运行级可用 Listed · runtime-verified | 社区榜单标注 ✅ 运行级可用,2026-08-14 agent 实测通过;v0.8.0 更新已提交(见下文链接)Shown as ✅ 运行级可用 in the community leaderboard; agent-tested on 2026-08-14; v0.8.0 update submitted (see below) |
| dshfind | ✅ 已收录(自动聚合) Listed (auto-aggregated) | 插件市场从 GitHub dsh-plugin topic 自动聚合;本仓库已带该 topic,刷新后展示最新版本与数据Marketplace auto-aggregates from the GitHub dsh-plugin topic; this repo carries the topic, so the latest version shows after the next refresh |
| omdsh-dev/community | ✅ 已提交收录申请 Submission submitted | [Plugin] 收录申请(Discussion #12)已通过;v0.8.0 更新说明已发布在该讨论[Plugin] submission (Discussion #12) accepted; v0.8.0 update posted there |
更新请求 / Update requests:
- awesome-dsh-plugins 收录条目更新:#127(v0.8.0 描述同步)
- dshfind 数据刷新请求(含快照条目名称异常修正):#2
- omdsh-dev/community 收录讨论更新:Discussion #12 更新评论
Update requests:
- awesome-dsh-plugins entry refresh: #127 (v0.8.0 description)
- dshfind data-refresh request (incl. fixing the snapshot entry name): #2
- omdsh-dev/community listing update: Discussion #12 update comment
免责声明 | 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.
Related plugins
dsh-notification
omdsh-dev/dsh-notification
dsh-open-in-vscode
omdsh-dev/dsh-open-in-vscode
dsh-suite (plugin-notify)
whyihaveyou/dsh-suite
dsh-web-ui-notify
bill9109/dsh-web-ui-notify