dsh-plugin-guide 0.1.0 → 0.1.2
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 +180 -165
- package/README.pt.md +126 -86
- package/README.zh.md +179 -0
- package/package.json +4 -4
- package/references/official-docs/CLAUDE.md +1 -1
- package/references/official-docs/SNAPSHOT.md +16 -16
- package/scripts/verify-kit.ps1 +1 -1
- package/README.zh-CN.md +0 -164
package/README.pt.md
CHANGED
|
@@ -2,138 +2,178 @@
|
|
|
2
2
|
|
|
3
3
|
# 🐳 dsh-plugin-guide
|
|
4
4
|
|
|
5
|
-
**Tudo o que você precisa para
|
|
5
|
+
**Tudo o que você precisa para construir plugins do [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness).**
|
|
6
6
|
|
|
7
|
-
Arquivo
|
|
7
|
+
*Arquivo de documentação oficial · primer de Cordis · deep-dives da comunidade · armadilhas testadas em batalha · agent skill*
|
|
8
8
|
|
|
9
|
-
[
|
|
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)
|
|
10
16
|
|
|
11
|
-
[
|
|
12
|
-
[](https://github.com/PerryLink/dsh-plugin-guide/network/members)
|
|
13
|
-
[](https://github.com/PerryLink/dsh-plugin-guide/actions/workflows/verify.yml)
|
|
14
|
-
[](https://www.npmjs.com/package/dsh-plugin-guide)
|
|
15
|
-
[](https://www.npmjs.com/package/dsh-plugin-guide)
|
|
16
|
-
[](LICENSE)
|
|
17
|
-
[](https://github.com/topics/dsh)
|
|
18
|
-
[](https://github.com/topics/dsh-plugin)
|
|
19
|
-
[](references/official-docs/)
|
|
17
|
+
[English](README.md) · [简体中文](README.zh.md) · [Español](README.es.md) · [Português](README.pt.md) · [हिन्दी](README.hi.md)
|
|
20
18
|
|
|
21
19
|
</div>
|
|
22
20
|
|
|
23
|
-
|
|
24
|
-
>
|
|
25
|
-
> ⏱️ **Última verificação em 2026-08-15** — documentação oficial idêntica byte a byte ao `master` upstream (47f9438, veja [SNAPSHOT.md](references/official-docs/SNAPSHOT.md)); tags npm e o tópico `dsh-plugin` (API total_count subiu **2668 → 2671** durante o snapshot de 08-15; 998 repositórios capturados, veja [sources.md](references/sources.md) §D.2) re-verificados ao vivo; HEAD upstream (47f9438) e npm `@deepseek-ai/dsh` (0.1.0-rc.6) sem mudanças.
|
|
21
|
+
---
|
|
26
22
|
|
|
27
|
-
##
|
|
23
|
+
## Compatibility
|
|
28
24
|
|
|
29
|
-
|
|
|
30
|
-
|
|
31
|
-
|
|
|
25
|
+
| Surface | Status |
|
|
26
|
+
|---|---|
|
|
27
|
+
| Harness | DeepSeek Harness `0.1.1-rc.2` |
|
|
28
|
+
| Node | `^22.19.0 || >=24.0.0` (runtime do DeepSeek Harness) |
|
|
29
|
+
| Platforms | Todas (bundle ESM puro; sem código nativo, sem rede) |
|
|
30
|
+
| Model | Qualquer (sem interação com o modelo) |
|
|
31
|
+
|
|
32
|
+
## What you get
|
|
33
|
+
|
|
34
|
+
O `dsh-plugin-guide` é a base de conhecimento de desenvolvimento de plugins DSH, empacotada como um bundle instalável que registra tudo como a agent skill `dsh-plugin-guide`. A skill permanece visível no catálogo de toda sessão e carrega seus passos de fluxo de trabalho, documentação oficial e deep-dives da comunidade sob demanda.
|
|
32
35
|
|
|
33
|
-
|
|
36
|
+
- **Contrato de plugin e regras rígidas** — effects/disposers, waterfall `next()`, visível para o modelo ⟺ registrado, configuração Schemastery.
|
|
37
|
+
- **Arquivo de documentação oficial** — uma cópia textual da documentação oficial do repo (EN + ZH), byte-idêntica ao upstream na última instantânea verificada.
|
|
38
|
+
- **Primer de Cordis** — os cinco conceitos e a linha do tempo de mecanismos (repository-plugin introduzido 0809, removido 0811; os dois canais de instalação).
|
|
39
|
+
- **20+ armadilhas do mundo real** com causa raiz + correção (cópias duplas de cordis, trio tsconfig, sessões zstd multi-frame, junctions do Windows, `latest` obsoleto do npm, …).
|
|
40
|
+
- **Deep-dives da comunidade** — 114 repositórios da comunidade arquivados (15 com deep-dive), mais um índice fonte completo onde cada fato aponta para sua origem.
|
|
34
41
|
|
|
35
|
-
|
|
42
|
+
## Knowledge base
|
|
43
|
+
|
|
44
|
+
| Path | O que é |
|
|
45
|
+
|---|---|
|
|
46
|
+
| `SKILL.md` | A agent skill `dsh-plugin-guide`: regras rígidas + caminhos de desenvolvimento por tarefa |
|
|
47
|
+
| `package.json` · `cordis.patch.yml` · `index.js` | O bundle DSH instalável: manifesto `dsh.bundle.patch` + ponto de entrada que registra a skill |
|
|
48
|
+
| `guide/plugin-dev-guide.md` | O guia de desenvolvimento completo (10 capítulos) |
|
|
49
|
+
| `guide/quick-reference.md` | Folha de referência de uma página (5 idiomas) |
|
|
50
|
+
| `guide/links.md` | Índice de URL curado: docs oficiais de desenvolvimento (site ↔ cópias locais) + links de docs da comunidade |
|
|
51
|
+
| `references/official-docs/` | Cópia textual da documentação oficial do repo (EN + ZH) |
|
|
52
|
+
| `references/*.md` | Relatórios de pesquisa: docs do repo, site, Cordis, o paper, ecossistema da comunidade, arquivo de 114 repos (15 com deep-dive) |
|
|
53
|
+
| `scripts/` | Scripts de download idempotentes + verificador de integridade + gerador de instantânea de tópico |
|
|
54
|
+
| `downloads/` | Instantâneas cruas — geradas por `scripts/`, não commitadas |
|
|
36
55
|
|
|
37
|
-
|
|
56
|
+
## Quick start
|
|
38
57
|
|
|
39
58
|
```sh
|
|
40
|
-
|
|
41
|
-
|
|
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'
|
|
42
67
|
```
|
|
43
68
|
|
|
44
|
-
|
|
69
|
+
Depois é só pedir ao seu agente: *"Use a skill dsh-plugin-guide para me construir um plugin de …."*
|
|
70
|
+
|
|
71
|
+
## Install & uninstall
|
|
45
72
|
|
|
46
|
-
|
|
73
|
+
- **canal git** (último `main`): `dsh plugin --profile web add github:PerryLink/dsh-plugin-guide#<sha>` — fixe um commit para reprodutibilidade; o ponto de entrada é JS ESM puro, sem etapa de build.
|
|
74
|
+
- **canal npm** (versões publicadas): `dsh plugin --profile web add dsh-plugin-guide`.
|
|
75
|
+
- **canal tarball**: `pnpm pack` neste repo, depois `dsh plugin --profile web add ./dsh-plugin-guide-<version>.tgz`.
|
|
76
|
+
- **desinstalar**: `dsh plugin --profile web remove dsh-plugin-guide`.
|
|
47
77
|
|
|
48
|
-
|
|
78
|
+
## Copy as a plain agent skill
|
|
49
79
|
|
|
50
|
-
|
|
80
|
+
Você também pode copiar a pasta inteira para o diretório de skills do seu agente (os caminhos relativos permanecem intactos):
|
|
51
81
|
|
|
52
82
|
```powershell
|
|
83
|
+
# Windows (PowerShell)
|
|
53
84
|
pwsh -File scripts/install-skill.ps1 `
|
|
54
|
-
-Target "$env:USERPROFILE\.deepseek\skills\dsh-plugin-guide" # ou <
|
|
85
|
+
-Target "$env:USERPROFILE\.deepseek\skills\dsh-plugin-guide" # ou <project>\.agents\skills\dsh-plugin-guide
|
|
55
86
|
```
|
|
56
87
|
|
|
57
|
-
**macOS / Linux**
|
|
58
|
-
|
|
59
88
|
```bash
|
|
60
|
-
|
|
89
|
+
# macOS / Linux
|
|
90
|
+
pwsh -File scripts/install-skill.ps1 -Target ~/.deepseek/skills/dsh-plugin-guide # ou <project>/.agents/skills/dsh-plugin-guide
|
|
61
91
|
```
|
|
62
92
|
|
|
63
|
-
O instalador pula `downloads/` (gerado) e `.github/`, e verifica byte a byte
|
|
93
|
+
O instalador pula `downloads/` (gerado) e `.github/`, e então verifica cada arquivo copiado byte a byte. Um `Copy-Item -Recurse` manual da pasta inteira também funciona.
|
|
64
94
|
|
|
65
|
-
|
|
95
|
+
## Configuration
|
|
66
96
|
|
|
67
|
-
|
|
97
|
+
O `dsh-plugin-guide` não expõe nenhum `Config` de Schemastery — ele registra a base de conhecimento como uma agent skill sem chaves ajustáveis.
|
|
68
98
|
|
|
69
|
-
|
|
70
|
-
|---|---|
|
|
71
|
-
| A folha de consulta de uma página | [`guide/quick-reference.md`](guide/quick-reference.md) |
|
|
72
|
-
| O caminho completo de 10 capítulos | [`guide/plugin-dev-guide.md`](guide/plugin-dev-guide.md) |
|
|
73
|
-
| Links de documentação oficial e comunitária | [`guide/links.md`](guide/links.md) · [`references/community-ecosystem.md`](references/community-ecosystem.md) |
|
|
74
|
-
| APIs exatas de serviços/eventos | `references/official-docs/docs/subsystems/` e `docs/cordis-api/` |
|
|
99
|
+
## Tools & surfaces
|
|
75
100
|
|
|
76
|
-
|
|
101
|
+
| Surface | Kind | Notes |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| `dsh-plugin-guide` | skill | Registrada via `ctx.skills`; carrega `SKILL.md` + `./guide/` + `./references/` sob demanda |
|
|
77
104
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
105
|
+
## Permissions & data
|
|
106
|
+
|
|
107
|
+
- **Permissions**: declara `filesystem:read` em seu manifesto de workshop.
|
|
108
|
+
- **Data**: somente leitura — lê seus próprios arquivos empacotados `guide/` e `references/`. Sem solicitações de rede, sem escritas, sem chamadas de modelo.
|
|
109
|
+
|
|
110
|
+
## Security boundaries
|
|
111
|
+
|
|
112
|
+
- **Base de conhecimento somente leitura.** O bundle apenas lê seus próprios arquivos; nunca escreve, nunca usa a rede e nunca invoca um modelo.
|
|
113
|
+
- **A documentação oficial são cópias textuais.** `references/official-docs/` nunca é editada aqui; reporte problemas ao upstream e ressincronize apenas com `scripts/sync-official-docs.ps1`.
|
|
114
|
+
- **Limites de distribuição.** O conteúdo de terceiros empacotado mantém sua licença de upstream; consulte [NOTICE.md](NOTICE.md) (ex.: `downloads/` é somente local; `awesome-dsh-plugins` não deve ser redistribuído).
|
|
88
115
|
|
|
89
|
-
##
|
|
116
|
+
## Known limitations
|
|
90
117
|
|
|
91
|
-
-
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
- 🔬 **114 repositórios comunitários arquivados** (15 analisados) — modelos, scaffolds, arquivos de armadilhas, regras do plugin-check, camada Fabric, ponte MCP, mais um guia em 15 idiomas, um curso s01–s23, manuais, SDKs TS/Rust e o lote 08-15 (shells de desktop, ponte QQ, PoCs de segurança, port Python).
|
|
95
|
-
- 🔗 **Índice de fontes completo** — cada fato aponta para sua origem (docs oficiais, repos upstream, repos comunitários).
|
|
96
|
-
- 🗃️ **1654 Discussions oficiais arquivadas** (com comentários de threads selecionadas) + 100+ artigos comunitários (zh/en/HN) — atualize com `scripts/archive-discussions.ps1` / `scripts/download-community-articles.ps1`.
|
|
97
|
-
- 🆕 **Selo de atualidade** — re-verificado contra o `master` upstream, npm e o tópico `dsh-plugin` ao vivo em 2026-08-15.
|
|
118
|
+
- **A documentação oficial é uma instantânea.** Ressincronize com `scripts/sync-official-docs.ps1` quando o upstream mudar; o selo de atualidade e o hash de commit referenciam `references/official-docs/SNAPSHOT.md`.
|
|
119
|
+
- **`downloads/` é gerado, não commitado.** As instantâneas cruas (arquivos de repos da comunidade, Discussions, artigos) devem ser geradas com os scripts antes do uso.
|
|
120
|
+
- **O conteúdo de `awesome-dsh-plugins` é somente local.** Seu upstream declara uma restrição de uso interno, então não é redistribuído com o repo.
|
|
98
121
|
|
|
99
|
-
##
|
|
122
|
+
## Keeping it fresh
|
|
100
123
|
|
|
101
124
|
```sh
|
|
102
|
-
pwsh -File scripts/sync-official-docs.ps1 # cópia
|
|
125
|
+
pwsh -File scripts/sync-official-docs.ps1 # cópia textual de docs a partir de um checkout local
|
|
103
126
|
pwsh -File scripts/download-sources.ps1 # site/docs oficiais, Cordis, paper
|
|
104
|
-
pwsh -File scripts/download-community-repos.ps1 #
|
|
105
|
-
pwsh -File scripts/download-community-articles.ps1 # artigos
|
|
106
|
-
pwsh -File scripts/archive-discussions.ps1 # Discussions oficiais (
|
|
127
|
+
pwsh -File scripts/download-community-repos.ps1 # repositórios da comunidade (tarballs codeload)
|
|
128
|
+
pwsh -File scripts/download-community-articles.ps1 # artigos da comunidade zh/en/HN
|
|
129
|
+
pwsh -File scripts/archive-discussions.ps1 # Discussions oficiais (precisa de $env:GH_TOKEN)
|
|
107
130
|
pwsh -File scripts/gen-topic-snapshot.ps1 -OutDir <dir> # censo do tópico dsh-plugin
|
|
108
|
-
pwsh -File scripts/verify-kit.ps1 -Checkout <checkout> # caminhos críticos + links
|
|
131
|
+
pwsh -File scripts/verify-kit.ps1 -Checkout <checkout> # caminhos críticos + varredura de links + deriva de docs
|
|
109
132
|
```
|
|
110
133
|
|
|
111
|
-
|
|
134
|
+
## Development
|
|
112
135
|
|
|
113
|
-
|
|
136
|
+
O bundle é ESM puro — sem etapa de build. O CI executa a porta de integridade em cada push e pull request:
|
|
114
137
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
- ⭐ **Dê uma estrela** — ajuda outros autores de plugins DSH a encontrá-lo.
|
|
120
|
-
- Encontrou um erro, uma nova armadilha ou um repo que merece análise? Abra uma [issue](https://github.com/PerryLink/dsh-plugin-guide/issues) ou um pull request — veja [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
121
|
-
- Junte-se à comunidade: [Discord do DeepSeek Harness](https://discord.gg/Ycq5dCaS4) · [discussões oficiais](https://github.com/deepseek-ai/deepseek-harness/discussions) · [topic `dsh-plugin`](https://github.com/topics/dsh-plugin).
|
|
138
|
+
```sh
|
|
139
|
+
pwsh -File scripts/verify-kit.ps1 # caminhos críticos + varredura de links (+ deriva de docs com -Checkout <checkout>)
|
|
140
|
+
```
|
|
122
141
|
|
|
123
|
-
##
|
|
142
|
+
## Topics
|
|
124
143
|
|
|
125
|
-
-
|
|
126
|
-
- A manutenção diária conta com a assistência de agentes do DeepSeek Harness (eles não têm conta no GitHub e são listados aqui apenas por transparência, não como contribuidores).
|
|
144
|
+
`dsh`, `deepseek-harness`, `dsh-plugin`, `cordis`, `agent-skill`, `plugin-development`, `knowledge-base`
|
|
127
145
|
|
|
146
|
+
## Contributors
|
|
128
147
|
|
|
129
|
-
|
|
148
|
+
- [PerryLink](https://github.com/PerryLink) — criador e mantenedor: conteúdo da base de conhecimento, a transformação para bundle instalável, envios ao ecossistema e engenharia de comunidade.
|
|
149
|
+
- A manutenção diária é assistida por agentes do DeepSeek Harness (eles não têm conta no GitHub e são listados aqui por transparência, não como contribuidores).
|
|
130
150
|
|
|
131
|
-
|
|
132
|
-
- O conteúdo de terceiros incluído está documentado em [NOTICE.md](NOTICE.md), com seus limites de distribuição
|
|
133
|
-
(ex.: `downloads/` é apenas local; `awesome-dsh-plugins` não deve ser redistribuído).
|
|
151
|
+
## PerryLink DSH Plugin Family
|
|
134
152
|
|
|
135
|
-
|
|
153
|
+
Este projeto é um dos [15 plugins do DeepSeek Harness](https://github.com/PerryLink) mantidos por [PerryLink](https://github.com/PerryLink). Se este te ajuda, os demais provavelmente também:
|
|
136
154
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
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
|
+
Mantido pela comunidade, **não** é um produto oficial da DeepSeek. O DeepSeek Harness está em preview de desenvolvedor e publica mudanças quebradoras; na dúvida, a documentação oficial em `references/official-docs/` é a fonte da verdade.
|
|
176
|
+
|
|
177
|
+
## License
|
|
178
|
+
|
|
179
|
+
[Apache License 2.0](LICENSE) © 2026 dsh-plugin-guide contributors — nosso próprio texto (`SKILL.md`, `guide/`, `references/`, `scripts/`, este README) é Apache-2.0; o conteúdo de terceiros empacotado é documentado em [NOTICE.md](NOTICE.md).
|
package/README.zh.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# 🐳 dsh-plugin-guide
|
|
4
|
+
|
|
5
|
+
**构建 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) 插件所需的一切。**
|
|
6
|
+
|
|
7
|
+
*官方文档档案 · Cordis 入门 · 社区深读 · 实战踩坑 · agent 技能*
|
|
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.1-rc.2` |
|
|
28
|
+
| Node | `^22.19.0 || >=24.0.0`（DeepSeek Harness 运行时） |
|
|
29
|
+
| Platforms | 全部（纯 ESM bundle；无原生代码、无网络） |
|
|
30
|
+
| Model | 任意（无模型交互） |
|
|
31
|
+
|
|
32
|
+
## What you get
|
|
33
|
+
|
|
34
|
+
`dsh-plugin-guide` 是 DSH 插件开发知识库，打包为可安装 bundle，把整份内容注册为 `dsh-plugin-guide` agent 技能。该技能在每个会话目录中都可见，并按需加载其工作流步骤、官方文档与社区深读。
|
|
35
|
+
|
|
36
|
+
- **插件契约与红线** —— effect/disposer、waterfall `next()`、模型可见 ⟺ 已记录、Schemastery 配置。
|
|
37
|
+
- **官方文档档案** —— 官方仓库文档（英 + 中）逐字副本，在最近核验快照处与上游逐字节一致。
|
|
38
|
+
- **Cordis 入门** —— 五个概念与机制时间线（repository-plugin 0809 引入、0811 移除；两条安装通道）。
|
|
39
|
+
- **20+ 个实战踩坑** —— 附根因 + 修法（cordis 双副本、tsconfig 三件套、多帧 zstd 会话、Windows junction、过期 npm `latest`…）。
|
|
40
|
+
- **社区深读** —— 归档 114 个社区仓库（15 个深读），外加每条事实都链回出处的完整来源索引。
|
|
41
|
+
|
|
42
|
+
## Knowledge base
|
|
43
|
+
|
|
44
|
+
| Path | 是什么 |
|
|
45
|
+
|---|---|
|
|
46
|
+
| `SKILL.md` | `dsh-plugin-guide` agent 技能：红线 + 按任务类型的开发路径 |
|
|
47
|
+
| `package.json` · `cordis.patch.yml` · `index.js` | 可安装 DSH bundle：`dsh.bundle.patch` 清单 + 注册技能的入口 |
|
|
48
|
+
| `guide/plugin-dev-guide.md` | 完整开发指南（10 章） |
|
|
49
|
+
| `guide/quick-reference.md` | 一页速查表（5 语言） |
|
|
50
|
+
| `guide/links.md` | 精选 URL 索引：官方开发文档（站点 ↔ 本地副本）+ 社区文档链接 |
|
|
51
|
+
| `references/official-docs/` | 官方仓库文档逐字副本（英 + 中） |
|
|
52
|
+
| `references/*.md` | 调研报告：仓库文档、网站、Cordis、论文、社区生态、114 仓库归档（15 个深读） |
|
|
53
|
+
| `scripts/` | 幂等下载脚本 + 完整性检查器 + 话题快照生成器 |
|
|
54
|
+
| `downloads/` | 原始快照 —— 由 `scripts/` 生成、不入库 |
|
|
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
|
+
然后直接问你的 agent：*"用 dsh-plugin-guide 技能帮我构建一个 … 插件。"*
|
|
70
|
+
|
|
71
|
+
## Install & uninstall
|
|
72
|
+
|
|
73
|
+
- **git channel**（最新 `main`）：`dsh plugin --profile web add github:PerryLink/dsh-plugin-guide#<sha>` —— 固定提交以可复现；入口是纯 ESM JS，无构建步骤。
|
|
74
|
+
- **npm channel**（发布版本）：`dsh plugin --profile web add dsh-plugin-guide`。
|
|
75
|
+
- **tarball channel**：在本仓库执行 `pnpm pack`，然后 `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
|
+
你也可以把整个文件夹复制到 agent 的技能目录（相对路径保持完好）：
|
|
81
|
+
|
|
82
|
+
```powershell
|
|
83
|
+
# Windows (PowerShell)
|
|
84
|
+
pwsh -File scripts/install-skill.ps1 `
|
|
85
|
+
-Target "$env:USERPROFILE\.deepseek\skills\dsh-plugin-guide" # 或 <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 # 或 <project>/.agents/skills/dsh-plugin-guide
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
安装器跳过 `downloads/`（生成的）与 `.github/`，然后逐字节校验每个复制的文件。手动 `Copy-Item -Recurse` 整个文件夹也可以。
|
|
94
|
+
|
|
95
|
+
## Configuration
|
|
96
|
+
|
|
97
|
+
`dsh-plugin-guide` 不暴露任何 Schemastery `Config` —— 它把知识库注册为 agent 技能，无可调键。
|
|
98
|
+
|
|
99
|
+
## Tools & surfaces
|
|
100
|
+
|
|
101
|
+
| Surface | Kind | Notes |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| `dsh-plugin-guide` | skill | 经 `ctx.skills` 注册；按需加载 `SKILL.md` + `./guide/` + `./references/` |
|
|
104
|
+
|
|
105
|
+
## Permissions & data
|
|
106
|
+
|
|
107
|
+
- **Permissions**：workshop 清单声明 `filesystem:read`。
|
|
108
|
+
- **Data**：只读 —— 仅读取自身打包的 `guide/` 与 `references/` 文件。无网络请求、无写入、无模型调用。
|
|
109
|
+
|
|
110
|
+
## Security boundaries
|
|
111
|
+
|
|
112
|
+
- **只读知识库。** bundle 只读取自身文件；绝不写入、绝不联网、绝不调用模型。
|
|
113
|
+
- **官方文档是逐字副本。** `references/official-docs/` 从不在本仓库修改；问题反馈给上游，且只经 `scripts/sync-official-docs.ps1` 重新同步。
|
|
114
|
+
- **分发边界。** 打包的第三方内容保留其上游许可；见 [NOTICE.md](NOTICE.md)（如 `downloads/` 仅本地、`awesome-dsh-plugins` 不得再分发）。
|
|
115
|
+
|
|
116
|
+
## Known limitations
|
|
117
|
+
|
|
118
|
+
- **官方文档是快照。** 上游变化时用 `scripts/sync-official-docs.ps1` 重新同步；新鲜度戳与提交号引用 `references/official-docs/SNAPSHOT.md`。
|
|
119
|
+
- **`downloads/` 由脚本生成、不入库。** 原始快照（社区仓库归档、Discussions、文章）使用前需用脚本生成。
|
|
120
|
+
- **`awesome-dsh-plugins` 内容仅本地。** 其上游声明内部使用约束，故不随仓库再分发。
|
|
121
|
+
|
|
122
|
+
## Keeping it fresh
|
|
123
|
+
|
|
124
|
+
```sh
|
|
125
|
+
pwsh -File scripts/sync-official-docs.ps1 # 从本地 checkout 取逐字文档副本
|
|
126
|
+
pwsh -File scripts/download-sources.ps1 # 官方站点/文档、Cordis、论文
|
|
127
|
+
pwsh -File scripts/download-community-repos.ps1 # 社区仓库（codeload tarballs）
|
|
128
|
+
pwsh -File scripts/download-community-articles.ps1 # zh/en/HN 社区文章
|
|
129
|
+
pwsh -File scripts/archive-discussions.ps1 # 官方 Discussions（需 $env:GH_TOKEN）
|
|
130
|
+
pwsh -File scripts/gen-topic-snapshot.ps1 -OutDir <dir> # dsh-plugin 话题普查
|
|
131
|
+
pwsh -File scripts/verify-kit.ps1 -Checkout <checkout> # 关键路径 + 链接扫描 + 文档漂移
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Development
|
|
135
|
+
|
|
136
|
+
bundle 是纯 ESM —— 无构建步骤。CI 在每次 push 与 pull request 运行完整性门禁：
|
|
137
|
+
|
|
138
|
+
```sh
|
|
139
|
+
pwsh -File scripts/verify-kit.ps1 # 关键路径 + 链接扫描（加 -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) —— 创建者与维护者：知识库内容、可安装 bundle 改造、生态提交与社区工程。
|
|
149
|
+
- 日常维护由 DeepSeek Harness agents 辅助（它们无 GitHub 账号，为透明起见列于此，不作贡献者）。
|
|
150
|
+
|
|
151
|
+
## PerryLink DSH Plugin Family
|
|
152
|
+
|
|
153
|
+
本项目是 [PerryLink](https://github.com/PerryLink) 维护的 [15 个 DeepSeek Harness 插件](https://github.com/PerryLink) 之一。如果这个对你有用，其他插件多半也有用：
|
|
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
|
+
社区维护，**非** DeepSeek 官方产品。DeepSeek Harness 处于开发者预览期并发布破坏性变更；有疑问时，以 `references/official-docs/` 中的官方文档为准。
|
|
176
|
+
|
|
177
|
+
## License
|
|
178
|
+
|
|
179
|
+
[Apache License 2.0](LICENSE) © 2026 dsh-plugin-guide contributors —— 自有文本（`SKILL.md`、`guide/`、`references/`、`scripts/`、本 README）按 Apache-2.0；打包的第三方内容见 [NOTICE.md](NOTICE.md)。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dsh-plugin-guide",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "The dsh-plugin-guide knowledge base as an installable DeepSeek Harness plugin: official docs, Cordis primer, community deep-dives, and battle-tested pitfalls registered as an on-demand agent skill.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"LICENSE",
|
|
15
15
|
"NOTICE.md",
|
|
16
16
|
"README.md",
|
|
17
|
-
"README.zh
|
|
17
|
+
"README.zh.md",
|
|
18
18
|
"README.es.md",
|
|
19
19
|
"README.pt.md",
|
|
20
20
|
"README.hi.md"
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"url": "git+https://github.com/PerryLink/dsh-plugin-guide.git"
|
|
35
35
|
},
|
|
36
36
|
"peerDependencies": {
|
|
37
|
-
"@deepseek-ai/dsh": "0.1.0-rc.
|
|
37
|
+
"@deepseek-ai/dsh": ">=0.1.0-rc.8 <0.2.0"
|
|
38
38
|
},
|
|
39
39
|
"peerDependenciesMeta": {
|
|
40
40
|
"@deepseek-ai/dsh": {
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
},
|
|
66
66
|
"permissions": ["filesystem:read"],
|
|
67
67
|
"compatibility": {
|
|
68
|
-
"dshVersions": ["0.1.
|
|
68
|
+
"dshVersions": ["0.1.1-rc.2"]
|
|
69
69
|
},
|
|
70
70
|
"capability": {
|
|
71
71
|
"id": "dsh-plugin-guide",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
AGENTS.md
|
|
1
|
+
AGENTS.md
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
# official-docs snapshot (SNAPSHOT.md)
|
|
2
|
-
|
|
3
|
-
> Generated by `scripts/sync-official-docs.ps1`. This file is the single authority for how `references/official-docs/` lines up with upstream deepseek-harness.
|
|
4
|
-
> The "last verified" dates and commit SHAs in README/guide must cite this file; do not hand-edit them.
|
|
5
|
-
|
|
6
|
-
| Item | Value |
|
|
7
|
-
|---|---|
|
|
8
|
-
| Source checkout | `D:\deepseek-harness` |
|
|
9
|
-
| Source ref | `origin/master` |
|
|
10
|
-
| Source commit | `47f943859bef60e4160492346772ded9b24f765a` |
|
|
11
|
-
| Synced at (UTC) | 2026-08-14T15:13:50Z |
|
|
12
|
-
| Scope | tracked files at the ref: `docs/`, root `AGENTS.md`, `BENCHMARK.md`, `CLAUDE.md`(symlink 目标文本), `CONTRIBUTING.md`/`.zh.md`/`.i18n.yaml`, `README.zh.md`/`.i18n.yaml`（上游英文 `README.md` 不在本目录，快照见 `downloads/github/harness/README.md`）, `THIRD_PARTY_NOTICES.md`, `LICENSE`, `packages/AGENTS.md`, `examples/AGENTS.md`, `packages/README.md`, `vendor/README.md`, `website/docs.ts` |
|
|
13
|
-
| File counts | docs/: 215 md files (105 .zh.md pairs) |
|
|
14
|
-
| Pruned this run | 107 个不在范围内/上游已删除的条目 |
|
|
15
|
-
|
|
16
|
-
Drift check: `pwsh -File scripts/verify-kit.ps1 -Checkout <checkout>` (tracked files only).
|
|
1
|
+
# official-docs snapshot (SNAPSHOT.md)
|
|
2
|
+
|
|
3
|
+
> Generated by `scripts/sync-official-docs.ps1`. This file is the single authority for how `references/official-docs/` lines up with upstream deepseek-harness.
|
|
4
|
+
> The "last verified" dates and commit SHAs in README/guide must cite this file; do not hand-edit them.
|
|
5
|
+
|
|
6
|
+
| Item | Value |
|
|
7
|
+
|---|---|
|
|
8
|
+
| Source checkout | `D:\deepseek-harness` |
|
|
9
|
+
| Source ref | `origin/master` |
|
|
10
|
+
| Source commit | `47f943859bef60e4160492346772ded9b24f765a` |
|
|
11
|
+
| Synced at (UTC) | 2026-08-14T15:13:50Z |
|
|
12
|
+
| Scope | tracked files at the ref: `docs/`, root `AGENTS.md`, `BENCHMARK.md`, `CLAUDE.md`(symlink 目标文本), `CONTRIBUTING.md`/`.zh.md`/`.i18n.yaml`, `README.zh.md`/`.i18n.yaml`（上游英文 `README.md` 不在本目录，快照见 `downloads/github/harness/README.md`）, `THIRD_PARTY_NOTICES.md`, `LICENSE`, `packages/AGENTS.md`, `examples/AGENTS.md`, `packages/README.md`, `vendor/README.md`, `website/docs.ts` |
|
|
13
|
+
| File counts | docs/: 215 md files (105 .zh.md pairs) |
|
|
14
|
+
| Pruned this run | 107 个不在范围内/上游已删除的条目 |
|
|
15
|
+
|
|
16
|
+
Drift check: `pwsh -File scripts/verify-kit.ps1 -Checkout <checkout>` (tracked files only).
|
package/scripts/verify-kit.ps1
CHANGED
|
@@ -10,7 +10,7 @@ $info = New-Object System.Collections.Generic.List[string]
|
|
|
10
10
|
|
|
11
11
|
# ---- 1) 关键路径 ----
|
|
12
12
|
$critical = @(
|
|
13
|
-
'SKILL.md','README.md','README.zh
|
|
13
|
+
'SKILL.md','README.md','README.zh.md','README.es.md','README.pt.md','README.hi.md','LICENSE','NOTICE.md','.gitignore',
|
|
14
14
|
'CONTRIBUTING.md','SECURITY.md','.github/ISSUE_TEMPLATE/bug_report.yml','.github/ISSUE_TEMPLATE/feature_request.yml','.github/PULL_REQUEST_TEMPLATE.md',
|
|
15
15
|
'guide/plugin-dev-guide.md','guide/quick-reference.md','guide/links.md','guide/quick-reference.zh-CN.md','guide/quick-reference.es.md','guide/quick-reference.pt.md','guide/quick-reference.hi.md',
|
|
16
16
|
'references/sources.md','references/harness-repo.md','references/website-pages.md',
|