dsh-plugin-template

English | 中文

A minimal, runnable Host + Client plugin template for DeepSeek Harness.

What is included

• Host Cordis plugin entry in src/index.ts;
• Client web bundle entry in src/client/index.ts;
• one shared Typert Remote, template/ping, to verify Host/Client wiring;
• dsh.plugin.json plugin metadata;
• cordis.patch.yml bundle composition patch;
• TypeScript, ESLint, Vitest, and esbuild configuration;
• checked-in lib/ output, so a direct Git installation can load without a build step.

The template deliberately has no model-facing tools, settings page, filesystem access, or arbitrary subprocess execution. Add only the capability your plugin needs.

Install locally

dsh plugin --profile web add /absolute/path/to/dsh-plugin-template

Restart the Web profile and refresh the page. The Host entry is mounted by cordis.patch.yml; the Client bundle is served through the dsh.client declaration in package.json.

Verify the Remote

After the plugin is loaded, the Host endpoint is:

template/ping

It returns { ok: true }. Use the running Harness Web API or a small Client contribution to exercise it.

Development

The repository uses the DSH 0.1.0-rc.6 package layout and local profile dependencies for development:

pnpm install
pnpm run check

pnpm run check runs type checking, linting, tests, and both Host and Client builds. The generated lib/ files are intentionally committed because package consumers may install directly from Git.

Discoverability

DeepSeek Harness asks community plugin authors to add the GitHub topic dsh-plugin. This repository is marked with that topic. To apply it to a fork or another repository:

gh api --method PUT repos/OWNER/REPO/topics \
  -H 'Accept: application/vnd.github+json' \
  -f 'names[]=dsh-plugin'

The npm keywords also include dsh-plugin, but the GitHub topic is the marker used by the official topic page.

License

MIT