dsh-plugin-guide 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.es.md +127 -87
- package/README.hi.md +128 -87
- package/README.md +179 -165
- package/README.pt.md +126 -86
- package/README.zh.md +179 -0
- package/package.json +4 -4
- package/scripts/verify-kit.ps1 +1 -1
- package/README.zh-CN.md +0 -164
package/README.md
CHANGED
|
@@ -1,165 +1,179 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
|
|
3
|
-
# 🐳 dsh-plugin-guide
|
|
4
|
-
|
|
5
|
-
**Everything you need to build [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) plugins.**
|
|
6
|
-
|
|
7
|
-
Official docs archive · Cordis primer · community deep-dives · battle-tested pitfalls · agent skill
|
|
8
|
-
|
|
9
|
-
[
|
|
10
|
-
|
|
11
|
-
[![
|
|
12
|
-
[![
|
|
13
|
-
[![
|
|
14
|
-
[![npm version](https://img.shields.io/npm/v/dsh-plugin-guide
|
|
15
|
-
[![npm downloads](https://img.shields.io/npm/dm/dsh-plugin-guide
|
|
16
|
-
|
|
17
|
-
[
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
Then just ask your agent: *"Use the dsh-plugin-guide skill to build me a … plugin."*
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
##
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
-
|
|
131
|
-
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
##
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
|
156
|
-
|
|
157
|
-
| [dsh-
|
|
158
|
-
| [dsh-
|
|
159
|
-
| [dsh-
|
|
160
|
-
| [dsh-
|
|
161
|
-
| [dsh-
|
|
162
|
-
| [dsh-
|
|
163
|
-
| [dsh-
|
|
164
|
-
|
|
|
165
|
-
| [dsh-
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# 🐳 dsh-plugin-guide
|
|
4
|
+
|
|
5
|
+
**Everything you need to build [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) plugins.**
|
|
6
|
+
|
|
7
|
+
*Official docs archive · Cordis primer · community deep-dives · battle-tested pitfalls · agent skill*
|
|
8
|
+
|
|
9
|
+
[](LICENSE)
|
|
10
|
+
[](https://github.com/topics/dsh-plugin)
|
|
11
|
+
[](#)
|
|
12
|
+
[](https://github.com/PerryLink/dsh-plugin-guide/actions)
|
|
13
|
+
[](https://github.com/PerryLink/dsh-plugin-guide/releases)
|
|
14
|
+
[](https://www.npmjs.com/package/dsh-plugin-guide)
|
|
15
|
+
[](https://www.npmjs.com/package/dsh-plugin-guide)
|
|
16
|
+
|
|
17
|
+
[English](README.md) · [简体中文](README.zh.md) · [Español](README.es.md) · [Português](README.pt.md) · [हिन्दी](README.hi.md)
|
|
18
|
+
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Compatibility
|
|
24
|
+
|
|
25
|
+
| Surface | Status |
|
|
26
|
+
|---|---|
|
|
27
|
+
| Harness | DeepSeek Harness `0.1.0-rc.8` |
|
|
28
|
+
| Node | `^22.19.0 || >=24.0.0` (DeepSeek Harness runtime) |
|
|
29
|
+
| Platforms | All (plain ESM bundle; no native code, no network) |
|
|
30
|
+
| Model | Any (no model interaction) |
|
|
31
|
+
|
|
32
|
+
## What you get
|
|
33
|
+
|
|
34
|
+
`dsh-plugin-guide` is the DSH plugin-development knowledge base, packaged as an installable bundle that registers the whole thing as the `dsh-plugin-guide` agent skill. The skill stays visible in every session catalog and loads its workflow steps, official docs, and community deep-dives on demand.
|
|
35
|
+
|
|
36
|
+
- **Plugin contract & hard rules** — effects/disposers, waterfall `next()`, model-visible ⟺ logged, Schemastery config.
|
|
37
|
+
- **Official docs archive** — a verbatim copy of the official repo docs (EN + ZH), byte-identical to upstream at the last verified snapshot.
|
|
38
|
+
- **Cordis primer** — the five concepts and the mechanism timeline (repository-plugin introduced 0809, removed 0811; the two install channels).
|
|
39
|
+
- **20+ real-world pitfalls** with root cause + fix (cordis dual copies, tsconfig trio, multi-frame zstd sessions, Windows junctions, stale npm `latest`, …).
|
|
40
|
+
- **Community deep-dives** — 114 community repositories archived (15 deep-dived), plus a full source index where every fact links to its origin.
|
|
41
|
+
|
|
42
|
+
## Knowledge base
|
|
43
|
+
|
|
44
|
+
| Path | What it is |
|
|
45
|
+
|---|---|
|
|
46
|
+
| `SKILL.md` | The `dsh-plugin-guide` agent skill: hard rules + task-based development paths |
|
|
47
|
+
| `package.json` · `cordis.patch.yml` · `index.js` | The installable DSH bundle: `dsh.bundle.patch` manifest + entry point that registers the skill |
|
|
48
|
+
| `guide/plugin-dev-guide.md` | The complete development guide (10 chapters) |
|
|
49
|
+
| `guide/quick-reference.md` | One-page cheat sheet (5 languages) |
|
|
50
|
+
| `guide/links.md` | Curated URL index: official dev docs (site ↔ local copies) + community doc links |
|
|
51
|
+
| `references/official-docs/` | Verbatim copy of the official repo docs (EN + ZH) |
|
|
52
|
+
| `references/*.md` | Research reports: repo docs, website, Cordis, the paper, community ecosystem, 114-repo archive (15 deep-dived) |
|
|
53
|
+
| `scripts/` | Idempotent download scripts + integrity checker + topic snapshot generator |
|
|
54
|
+
| `downloads/` | Raw snapshots — generated by `scripts/`, not committed |
|
|
55
|
+
|
|
56
|
+
## Quick start
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
# 1. install the bundle into your profile
|
|
60
|
+
dsh plugin --profile web add "github:PerryLink/dsh-plugin-guide#main"
|
|
61
|
+
|
|
62
|
+
# or from npm (published releases)
|
|
63
|
+
dsh plugin --profile web add dsh-plugin-guide
|
|
64
|
+
|
|
65
|
+
# 2. restart and verify the row
|
|
66
|
+
dsh --profile web --dump-config | grep -A3 'id: dsh-plugin-guide'
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Then just ask your agent: *"Use the dsh-plugin-guide skill to build me a … plugin."*
|
|
70
|
+
|
|
71
|
+
## Install & uninstall
|
|
72
|
+
|
|
73
|
+
- **git channel** (latest `main`): `dsh plugin --profile web add github:PerryLink/dsh-plugin-guide#<sha>` — pin a commit for reproducibility; the entry point is plain ESM JS, no build step.
|
|
74
|
+
- **npm channel** (published releases): `dsh plugin --profile web add dsh-plugin-guide`.
|
|
75
|
+
- **tarball channel**: `pnpm pack` in this repo, then `dsh plugin --profile web add ./dsh-plugin-guide-<version>.tgz`.
|
|
76
|
+
- **uninstall**: `dsh plugin --profile web remove dsh-plugin-guide`.
|
|
77
|
+
|
|
78
|
+
## Copy as a plain agent skill
|
|
79
|
+
|
|
80
|
+
You can also copy the whole folder into your agent's skill directory (relative paths stay intact):
|
|
81
|
+
|
|
82
|
+
```powershell
|
|
83
|
+
# Windows (PowerShell)
|
|
84
|
+
pwsh -File scripts/install-skill.ps1 `
|
|
85
|
+
-Target "$env:USERPROFILE\.deepseek\skills\dsh-plugin-guide" # or <project>\.agents\skills\dsh-plugin-guide
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# macOS / Linux
|
|
90
|
+
pwsh -File scripts/install-skill.ps1 -Target ~/.deepseek/skills/dsh-plugin-guide # or <project>/.agents/skills/dsh-plugin-guide
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The installer skips `downloads/` (generated) and `.github/`, then verifies every copied file byte-for-byte. A manual `Copy-Item -Recurse` of the whole folder also works.
|
|
94
|
+
|
|
95
|
+
## Configuration
|
|
96
|
+
|
|
97
|
+
`dsh-plugin-guide` exposes no Schemastery `Config` — it registers the knowledge base as an agent skill with no tunable keys.
|
|
98
|
+
|
|
99
|
+
## Tools & surfaces
|
|
100
|
+
|
|
101
|
+
| Surface | Kind | Notes |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| `dsh-plugin-guide` | skill | Registered via `ctx.skills`; loads `SKILL.md` + `./guide/` + `./references/` on demand |
|
|
104
|
+
|
|
105
|
+
## Permissions & data
|
|
106
|
+
|
|
107
|
+
- **Permissions**: declares `filesystem:read` in its workshop manifest.
|
|
108
|
+
- **Data**: read-only — reads its own bundled `guide/` and `references/` files. No network requests, no writes, no model calls.
|
|
109
|
+
|
|
110
|
+
## Security boundaries
|
|
111
|
+
|
|
112
|
+
- **Read-only knowledge base.** The bundle only reads its own files; it never writes, never calls the network, and never invokes a model.
|
|
113
|
+
- **Official docs are verbatim copies.** `references/official-docs/` is never edited here; report issues upstream and re-sync only with `scripts/sync-official-docs.ps1`.
|
|
114
|
+
- **Distribution boundaries.** Bundled third-party content keeps its upstream license; see [NOTICE.md](NOTICE.md) (e.g. `downloads/` is local-only; `awesome-dsh-plugins` must not be redistributed).
|
|
115
|
+
|
|
116
|
+
## Known limitations
|
|
117
|
+
|
|
118
|
+
- **Official docs are a snapshot.** Re-sync with `scripts/sync-official-docs.ps1` when upstream moves; the freshness stamp and commit hash reference `references/official-docs/SNAPSHOT.md`.
|
|
119
|
+
- **`downloads/` is generated, not committed.** Raw snapshots (community repo archives, Discussions, articles) must be generated with the scripts before use.
|
|
120
|
+
- **`awesome-dsh-plugins` content is local-only.** Its upstream declares an internal-use constraint, so it is not redistributed with the repo.
|
|
121
|
+
|
|
122
|
+
## Keeping it fresh
|
|
123
|
+
|
|
124
|
+
```sh
|
|
125
|
+
pwsh -File scripts/sync-official-docs.ps1 # verbatim docs copy from a local checkout
|
|
126
|
+
pwsh -File scripts/download-sources.ps1 # official site/docs, Cordis, paper
|
|
127
|
+
pwsh -File scripts/download-community-repos.ps1 # community repositories (codeload tarballs)
|
|
128
|
+
pwsh -File scripts/download-community-articles.ps1 # zh/en/HN community articles
|
|
129
|
+
pwsh -File scripts/archive-discussions.ps1 # official Discussions (needs $env:GH_TOKEN)
|
|
130
|
+
pwsh -File scripts/gen-topic-snapshot.ps1 -OutDir <dir> # dsh-plugin topic census
|
|
131
|
+
pwsh -File scripts/verify-kit.ps1 -Checkout <checkout> # critical paths + link scan + docs drift
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Development
|
|
135
|
+
|
|
136
|
+
The bundle is plain ESM — no build step. CI runs the integrity gate on every push and pull request:
|
|
137
|
+
|
|
138
|
+
```sh
|
|
139
|
+
pwsh -File scripts/verify-kit.ps1 # critical paths + link scan (+ docs drift with -Checkout <checkout>)
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Topics
|
|
143
|
+
|
|
144
|
+
`dsh`, `deepseek-harness`, `dsh-plugin`, `cordis`, `agent-skill`, `plugin-development`, `knowledge-base`
|
|
145
|
+
|
|
146
|
+
## Contributors
|
|
147
|
+
|
|
148
|
+
- [PerryLink](https://github.com/PerryLink) — creator and maintainer: knowledge-base content, the installable-bundle transformation, ecosystem submissions, and community engineering.
|
|
149
|
+
- Day-to-day maintenance is assisted by DeepSeek Harness agents (they hold no GitHub account and are listed here for transparency, not as contributors).
|
|
150
|
+
|
|
151
|
+
## PerryLink DSH Plugin Family
|
|
152
|
+
|
|
153
|
+
This project is one of the [15 DeepSeek Harness plugins](https://github.com/PerryLink) maintained by [PerryLink](https://github.com/PerryLink). If this one helps you, the others likely will too:
|
|
154
|
+
|
|
155
|
+
| Plugin | One-liner |
|
|
156
|
+
|---|---|
|
|
157
|
+
| [dsh-mcp-panel](https://github.com/PerryLink/dsh-mcp-panel) | Read-only MCP runtime panel: /mcp command + Settings tab with status, tools and errors |
|
|
158
|
+
| [dsh-doublecheck](https://github.com/PerryLink/dsh-doublecheck) | Engineering-discipline guard: requirements grill, test gates, adversary review |
|
|
159
|
+
| [dsh-background-agents](https://github.com/PerryLink/dsh-background-agents) | Durable background child agents with a Web UI sidebar, messaging and interrupt |
|
|
160
|
+
| [dsh-lsp-actions](https://github.com/PerryLink/dsh-lsp-actions) | LSP diagnostics, formatting, completion, code actions and rename over language servers |
|
|
161
|
+
| [dsh-output-styles](https://github.com/PerryLink/dsh-output-styles) | Claude Code outputStyles-equivalent runtime style switching |
|
|
162
|
+
| [dsh-checkpoint-rewind](https://github.com/PerryLink/dsh-checkpoint-rewind) | Claude Code /rewind-equivalent: snapshots, session forks, one-shot restore |
|
|
163
|
+
| [dsh-permission-rules](https://github.com/PerryLink/dsh-permission-rules) | Claude Code-style declarative allow/deny/ask permission rules with audit |
|
|
164
|
+
| [dsh-auto-review](https://github.com/PerryLink/dsh-auto-review) | Second-model auto-review on the approval chain, fail-closed by default |
|
|
165
|
+
| [dsh-memento](https://github.com/PerryLink/dsh-memento) | Approval-gated cross-session memory: ctx.memory seam + SQLite + memory tool |
|
|
166
|
+
| [dsh-skill-pack-security](https://github.com/PerryLink/dsh-skill-pack-security) | Security-audit skill pack: secret scan, dependency and supply-chain review |
|
|
167
|
+
| [dsh-session-pin](https://github.com/PerryLink/dsh-session-pin) | Pin sessions in the Web sidebar with durable ordering |
|
|
168
|
+
| [dsh-composer-history](https://github.com/PerryLink/dsh-composer-history) | Terminal-style input history for the web composer: arrows, Ctrl+R search |
|
|
169
|
+
| [dsh-github](https://github.com/PerryLink/dsh-github) | GitHub PR/issues integration for DSH, every write gated by approval |
|
|
170
|
+
| **[dsh-plugin-guide](https://github.com/PerryLink/dsh-plugin-guide)** | Plugin-development knowledge base as an on-demand agent skill |
|
|
171
|
+
| [dsh-claude-move](https://github.com/PerryLink/dsh-claude-move) | Migrate Claude Code sessions, memory, skills and CLAUDE.md into DSH |
|
|
172
|
+
|
|
173
|
+
## Disclaimer
|
|
174
|
+
|
|
175
|
+
Community-maintained, **not** an official DeepSeek product. DeepSeek Harness is in developer preview and ships breaking changes; when in doubt, the official docs in `references/official-docs/` are the source of truth.
|
|
176
|
+
|
|
177
|
+
## License
|
|
178
|
+
|
|
179
|
+
[Apache License 2.0](LICENSE) © 2026 dsh-plugin-guide contributors — our own text (`SKILL.md`, `guide/`, `references/`, `scripts/`, this README) is Apache-2.0; bundled third-party content is documented in [NOTICE.md](NOTICE.md).
|