一句话定位

dsh-harmony 主仓库 .impeccable/fixtures/ 目录下随包发布的私有测试夹具，仅用于演示"同一目标被多个 Patch 按卡片堆顺序加载"的 Harmony 运行场景，不面向终端用户提供功能。

核心能力

• 在 @deepseek-ai/dsh-client-ui-sidebar 的 lib/client.js 上注册 3 个空 Patches：alpha-header、alpha-navigation、alpha-footer
• 通过 dsh.harmony.before 声明自身 Patch 排在 dsh-harmony-motion-beta 之前，为上游顺序测试提供基线
• 借助 harmony.patch.yml 中的 inject: [harmony] 注入 Harmony 运行时，使夹具随 WebUI 启动即可被加载

技术实现

• 语言: JavaScript（CommonJS）
• 关键依赖: @deepseek-ai/dsh-client-ui-sidebar（Patch 目标），dsh-harmony（同仓库宿主 Patch 引擎）
• 架构模式: 以 DSH harmony Bundle Patch 形式注入宿主，index.cjs 仅暴露 inject 与空 apply
• 入口文件: .impeccable/fixtures/stack-alpha/index.cjs、patches.cjs、harmony.patch.yml

适用场景

供 dsh-harmony 上游开发者验证"Patches 加载顺序 + expect 匹配计数"行为，普通用户在生产环境安装它不会得到任何视觉或功能上的改变。

前置依赖与兼容性

安装方式

dsh plugin --profile web add github:memorax-ai/dsh-harmony/.impeccable/fixtures/stack-alpha

配置项

本插件无需额外配置。

常见问题

Q: 这个插件和 npm 上的 dsh-harmony 是什么关系？

A: 它是 dsh-harmony 主仓库的子目录夹具，package.json 中 name 是 dsh-harmony-motion-alpha、private: true，与 npm 发布的 dsh-harmony 不是同一个包。

Q: 安装后会在 WebUI 上看到新的卡片或菜单吗？

A: 不会。patches.cjs 中的 3 个 Patches 都使用空 apply()，目标选择器也只是占位用 SourceFile，因此不会改写任何 UI。

Q: expect: 2 的 Patch 是干什么的？

A: 这是夹具刻意制造的不一致：alpha-footer 期望 2 个匹配而源文件中实际只产生 1 个，用来观察 Harmony 在状态页面上如何报告 matches 与 state。

Q: 单独启用会报错吗？

A: 不会硬报错，但 dsh.harmony.before 引用了 dsh-harmony-motion-beta，在未安装 beta 时 Harmony 的顺序校验会输出告警，status 命令会以非零状态退出。

上手难度

入门 — 仓库自带 demo 形态，没有自定义配置，但要理解它需要先熟悉 dsh-harmony 的 Patch 加载与顺序机制。

已知问题与限制

• package.json 中 private: true、version: 0.0.0，标识为仓库内部测试物料，不应作为生产插件发布或对外分发
• patches.cjs 内 3 个 Patches 的 apply() 均为空函数，无法对宿主产生任何真实修改
• dsh.harmony.before 依赖同仓库不存在的 dsh-harmony-motion-beta，单独启用会触发顺序校验告警
• 包内未提供 README、注释或 TODO 标记，源码中未发现额外限制声明

Usage

Just type "What about we use dsh-harmony" when vibe coding your DSH plugin.

Introduction

Use Harmony when one DeepSeek Harness plugin needs to change another without maintaining a fork. Harmony loads Patches before the target runs, changes its compiled code in memory, and starts Harness with the result.

Source Patches find TypeScript AST nodes with TSQuery and rewrite their source ranges with MagicString. They run one after another, each reading the source left by the previous Patch. This lets several plugins change the same target while leaving installed files untouched.

A provider can place its Patches before or after another provider. One Patch may override that rule, and users may interleave Patches from different providers. When several changes must succeed together, a composite Patch gives them one position and one switch; if a member fails, Harmony applies none of them.

For browser plugins, Harmony also keeps provider-owned <style data-plugin> tags in Patch order. A provider owns one style group, so its last enabled Patch decides where that group appears in the CSS cascade. Harmony repeats the ordering after a Patch reload.

Harmony adds modification to the ways DeepSeek Harness plugins can work together.

Why Harmony

Ordinary DSH extension points remain the first choice when the target exposes the behavior you need. Harmony is for the gap between those APIs and maintaining a fork: changing an internal component, loader entry, or compiled behavior that the target does not expose.

Harmony does not turn compiled internals into a stable public API. It makes that dependency explicit, ordered, inspectable, and reversible.

Respect

Inspired by Harmony, the project of the same name created by Andreas Pardeike and other contributors for C#.

AI agents: use the repository skill

Load use-dsh-harmony for installation, Patch selection and authoring, runtime operations, and troubleshooting.

Install

Requires Node.js ^22.22.3 or >=24.11.1 and @deepseek-ai/[email protected].

npm install -g @deepseek-ai/[email protected]
npm install -g dsh-harmony
dsh web

Open Settings → Harmony after starting the WebUI. For profiles, Desktop integration, updates, and removal, see the installation guide.

Use the terminal UI or non-interactive commands against any profile. Commands contact a running Host transactionally and report live; stopped profiles are validated and updated atomically as offline.

Multiple Hosts may use the same profile. Harmony follows DSH Settings' write model: whole-profile writes are serialized by a file lock and committed atomically; a stale UI save is rejected and refreshed, while concurrent processes use last-complete-write-wins semantics.

dsh harmony --profile web
dsh harmony status --json --profile web
dsh harmony disable my-provider/optional-patch --profile web
dsh harmony enable-provider my-provider --profile web
dsh harmony patch-order show --profile web
dsh harmony patch-order move my-provider/optional-patch --before other-provider/base --profile web
dsh harmony patch-order auto --profile web
dsh harmony provider-order move my-provider --after base-provider --profile web
dsh harmony inspect target-package --patch my-provider/optional-patch --summary --profile web
dsh harmony reload my-provider --profile web

Press Tab in the TUI to switch between Provider and Patch views. The Patch view supports individual and Provider-wide enablement, Patch ordering, automatic sorting, runtime details, and concise inspection. Both views keep the selection visible when a profile is larger than the terminal.

status, patch-order show, and provider-order show exit with status 1 when their health or order constraints fail. patch-order auto and provider-order auto minimize violations while preserving the current order where possible. inspect --summary omits transformed source, while --patch <key> limits inspection to targets touched by one Patch. reload requires a running Host.

Patch model

Harmony runs every Patch from one global patchOrder. Provider-level before and after rules set the usual order. A Patch that declares either rule uses its own rules instead. In Settings → Harmony, users can move a whole provider or place one Patch between Patches from another provider. Plugin and Patch details provide their enable and disable actions, while the Patch status page is a read-only runtime monitor. Harmony checks that the saved list contains every registered Patch exactly once.

Plugin-wide disablement is an independent provider/* flag. It never clears or creates individual Patch flags. Re-enabling a plugin therefore restores only the Patches that were individually enabled before the plugin was disabled.

Every Patch may declare a human-readable description. Harmony exposes it through Patch status and JSON output, and displays it in Settings so users can understand the Patch before changing its order or enablement.

A composite Patch groups several Patches under one order position and switch. Members keep their declared order and apply only when every member succeeds. A failed standalone Patch is reported and skipped; later Patches and the Host continue to run.

Plugin compatibility

Any DSH plugin package can describe its relationships with other plugins under dsh.plugin.compatibility, whether or not it provides Harmony Patches:

{
  "dsh": {
    "plugin": {
      "compatibility": {
        "requires": {
          "base-plugin": "^2.0.0"
        },
        "conflicts": {
          "legacy-plugin": "*"
        },
        "integrates": {
          "optional-renderer": "^1.0.0"
        }
      }
    }
  }
}

requires reports a missing, inactive, or incompatible dependency; conflicts warns when an incompatible pair is active; and integrates reports an available optional integration. These declarations never install, enable, disable, or block plugins. Targets are package names and values are semver ranges. Reciprocal conflict declarations produce one warning, and disabling a Harmony Patch does not disable its owning plugin.

Live reports use the plugins active in Loader. When the profile is stopped, Harmony can only inspect its installation and therefore treats installed profile packages as active.

React-aware patches

Install dsh-harmony-react in a Patch provider when the target is compiled React:

npm install dsh-harmony-react

Use element() to change selected compiled jsx / jsxs calls. Use component() to change the shared component definition. Harmony applies both in the same Patch order as every other Source Patch.

To let later Component Patches modify the same definition, Harmony rewrites a function declaration as an initialized const. The new binding is not hoisted. If the file reads the component before its declaration, use a core Source Patch instead. React integration covers selectors, Inspect traces, and Studio.

Documentation

Powered by Harmony

If your plugin uses Harmony, you’re welcome to use this badge to show your support!

[![Powered by Harmony](https://memorax-ai.github.io/dsh-harmony/harmony-powered.svg)](https://memorax-ai.github.io/dsh-harmony/)

Development

All maintained implementation code uses TypeScript. Build artifacts are generated for packaging and are not tracked by Git.

Documentation sources and local preview tooling live on the docs branch.

npm test

Set DSH_HARMONY_PERF=1 when starting DSH to log one structured timing record for each Harmony startup, plugin update, profile update, and manual reload:

DSH_HARMONY_PERF=1 dsh web --no-open

Each record separates Patch preparation, source transformation, Host reload, browser rebuild, and total time. The probe stays inactive by default. Node.js diagnostic tools can instead subscribe to the diagnostics_channel channel dsh-harmony:load without enabling log output.

License

MIT