Quick start

Requirements

Node 24+, pnpm 12 (npm fallback).

Create

pnpm

pnpm create dsh-kit my-plugin

npm

npm create dsh-kit@latest my-plugin

Non-interactive:

pnpm

pnpm create dsh-kit my-plugin --author your-handle --title-zh "我的插件" --title-en "My Plugin"

npm

npm create dsh-kit@latest my-plugin -- --author your-handle --title-zh "我的插件" --title-en "My Plugin"

Verify

pnpm

cd my-plugin
pnpm install
pnpm verify

npm

cd my-plugin
npm install
npm run verify

pnpm verify runs, in order: oxfmt --check → oxlint → tsc --noEmit → vitest run → tsdown → npm pack → scripts/check.mjs (package name, patch row, constants and the built bundle id must agree).

Install into DSH

dsh plugin --profile web add link:$PWD
dsh --profile web --dump-config | grep -A2 "id: my-plugin"

link: installs the working copy for development; a published plugin is installed by package name.

For the desktop app, use the in-app plugin page. The desktop profile is app-managed and cannot be modified by dsh plugin.

What you get

src/host/        # Node half: services, tools, routes
src/client/      # browser half: slots, components
src/shared/      # constants both halves import
tests/           # one suite per half
lib/             # generated and committed
AGENTS.md        # agent rules
llms.txt         # machine index

Read Toolchain for why these tools, and Contributing before opening a pull request.

---

Why the template looks like this: Why dsh-kit. Maintainer details: Toolchain.