prompt-skill-armory 0.5.5 → 0.7.0

package/README.en.md

@@ -0,0 +1,207 @@
+# Prompt•Skill-Armory
+
+> **A CCswitch-style prompt + skill manager for the DeepSeek Harness**
+> Manage globally injected prompts, install skills from `.md`/directory/zip, and browse agent presets — one panel with enable/disable switches.
+
+[**中文**](./README.md) · **English**
+
+![version](https://img.shields.io/badge/version-0.5.6-00ff9c)
+![license](https://img.shields.io/badge/license-MIT-blue)
+![platform](https://img.shields.io/badge/platform-web%20%2B%20desktop-00ff9c)
+![CI](https://github.com/Qian-Ning/prompt-skill-armory/actions/workflows/ci.yml/badge.svg)
+
+```
+✦ Prompt•Skill-Armory [v0.5.6]
+┌────────────┬──────────────────┬──────────────┐
+│ 提示词      │ 技能              │ Agent预设     │
+│ (全局生效)  │ (合并管理)        │ (roster)     │
+└────────────┴──────────────────┴──────────────┘
+```
+
+---
+
+## 📑 Table of contents
+
+- [🚀 Quick start](#-quick-start)
+- [✨ Features](#-features)
+- [🖥️ Platform support](#️-platform-support)
+- [🧰 Using a skill in chat](#-using-a-skill-in-chat)
+- [🏗️ Architecture](#️-architecture)
+- [📦 Packages](#-packages)
+- [🗂️ Repository layout](#️-repository-layout)
+- [🛠️ Development](#️-development)
+- [❓ FAQ](#-faq)
+- [📚 Docs](#-docs)
+- [🤝 Contributing / Upstream](#-contributing--upstream)
+- [📄 License](#-license)
+
+---
+
+## 🚀 Quick start
+
+### Install
+
+```bash
+npx prompt-skill-armory
+```
+
+The installer automatically:
+
+1. Locates DSH home
+2. Ensures `web` + `desktop` profiles exist
+3. Installs both plugin packages (Host + Web panel)
+4. Configures the Host bundle
+5. Mounts the panel (profile `cordis.patch.yml`)
+6. Health-checks settings (prevents 4MB bloat)
+
+### Launch
+
+```bash
+cd deepseek-harness
+pnpm run build
+pnpm dsh web
+```
+
+(Or simply relaunch the DSH Desktop client.)
+
+Open **Settings → Prompt•Skill-Armory** (book icon).
+
+> **Requirement**: DeepSeek Harness runtime already installed (`dsh web` or the Desktop client). This is a plugin for DSH — it does not bundle the runtime itself.
+
+---
+
+## ✨ Features
+
+- **Prompts (global)** — CRUD, enable/disable, set default. Enabled prompts are injected into **every agent's system prompt** via `ctx.systemPrompt.section`.
+- **Skills (merged)** — one list: panel-installed (edit/toggle/uninstall) + locally scanned (managed), with invoke hint `/name`.
+- **Skill install paths**
+  - Manual entry
+  - `.md` file picker
+  - CLI in a session: `/armory-skill-dir <dir>`, `/armory-install-zip <zip>`
+- **Agent presets** — browse the roster, set default.
+- **Bilingual UI** (Simplified Chinese / English).
+- **Book icon** in the settings sidebar.
+
+## 🖥️ Platform support
+
+| Environment | Panel | `/armory` commands |
+|---|---|---|
+| `dsh web` (official) | ✅ | ✅ |
+| DSH Desktop client | ✅ | ✅ |
+
+Works via profile composition (the installer mounts the panel into each profile's `cordis.patch.yml`) — no fork of the client needed.
+
+## 🧰 Using a skill in chat
+
+Type `/` then the skill name:
+
+```
+/code-review
+/mission-keeper
+```
+
+The skill body is injected; the agent follows it. Model-invocable skills are also visible to the model.
+
+## 🏗️ Architecture
+
+```
+┌──────────────────────────────────────────────────────┐
+│                    DSH runtime                       │
+│                                                      │
+│  ┌─────────────┐   RPC/connection   ┌─────────────┐  │
+│  │  Web panel   │◄──────────────────►│  Host service│  │
+│  │ ui-switchblade│   api.skills.*    │ switchblade │  │
+│  │  (settings)  │   api.settings.*  │  (bundle)   │  │
+│  └─────────────┘                    └──────┬──────┘  │
+│                                            │         │
+│                              ctx.systemPrompt.section│
+│                              ctx.skills.register     │
+│                                            │         │
+│                              ┌─────────────┴──────┐  │
+│                              │ each agent's system │  │
+│                              │ prompt / skill      │  │
+│                              │ registry / presets  │  │
+│                              └────────────────────┘  │
+└──────────────────────────────────────────────────────┘
+```
+
+- **Host service** (`switchblade` bundle) owns prompt/skill/preset CRUD + persistence, injecting globally via `ctx.systemPrompt.section` and registering skills via `ctx.skills.register`.
+- **Web panel** (`ui-switchblade`) talks to the Host over connection RPC (`api.skills.list`, `api.agentPresets.list`, `api.settings.mutate/describe`) — never touches DSH internals directly.
+- **Installer** wires both into DSH via profile composition — web and desktop share the same mechanism.
+
+## 📦 Packages
+
+| Package | Role |
+|---|---|
+| `prompt-skill-armory` | npm installer (CLI) |
+| `@deepseek-ai/dsh-switchblade` | Host service (prompts/skills/commands) |
+| `@deepseek-ai/dsh-client-ui-switchblade` | Web panel |
+
+## 🗂️ Repository layout
+
+```
+prompt-skill-armory/
+├── cli.cjs                  # one-command install CLI
+├── package.json             # npm installer package
+├── packages/                # shipped plugin builds (lib+src+manifest)
+│   ├── switchblade/         # @deepseek-ai/dsh-switchblade (Host)
+│   └── client-ui-switchblade/ # @deepseek-ai/dsh-client-ui-switchblade (Web)
+├── plugin-src/              # plugin source mirrors
+├── scripts/build-shipped.mjs # sync builds from a DSH checkout
+├── demo/demo.html           # UI preview (mock data)
+├── README.md                # this file (中文) · README.en.md (English)
+├── UPSTREAM.md              # upstream integration guide
+├── CHANGELOG.md             # version history
+├── PUBLISHING.md            # publishing guide
+├── TESTING.md               # testing guide
+├── LICENSE                  # MIT
+└── .github/workflows/ci.yml # CI quality gate
+```
+
+## 🛠️ Development
+
+After editing source, rebuild shipped packages:
+
+```bash
+node scripts/build-shipped.mjs <path-to-deepseek-harness>
+```
+
+Version bumps touch three places:
+
+1. `packages/*/package.json` `version`
+2. `ARMORY_VERSION` (panel constant)
+3. `CHANGELOG.md`
+
+Then rebuild the client bundle so the badge updates.
+
+## ❓ FAQ
+
+**Q: Why is my client sidebar icon a gear instead of a book?**
+A: The desktop client's packaged `SettingsRoot` hardcodes the icon mapping. Via the npm installer's profile composition the panel works fine, but the book icon requires upstream integration (see [`UPSTREAM.md`](./UPSTREAM.md)).
+
+**Q: Will this affect my existing config / sessions?**
+A: No. The plugin only adds a `switchblade` settings namespace and leaves everything else untouched. The installer also health-checks settings to prevent bloat.
+
+**Q: Does it work offline?**
+A: Yes. Copy the npm tarball to the target machine and `npm install <tarball>`; or `file:`-install a local build (see [`TESTING.md`](./TESTING.md)).
+
+**Q: Where do skills come from?**
+A: Three ways: manual entry, `.md` file picker, or in-session `/armory-skill-dir` (directory) / `/armory-install-zip` (zip). All land in the merged Skills tab for management.
+
+## 📚 Docs
+
+| Doc | Description |
+|---|---|
+| [`README.md`](./README.md) | Chinese readme |
+| [`TESTING.md`](./TESTING.md) | Local functional testing (no publish needed) |
+| [`PUBLISHING.md`](./PUBLISHING.md) | Publishing a new version |
+| [`UPSTREAM.md`](./UPSTREAM.md) | Upstream integration (book-icon PR) |
+| [`CHANGELOG.md`](./CHANGELOG.md) | Full version history |
+
+## 🤝 Contributing / Upstream
+
+See [`UPSTREAM.md`](./UPSTREAM.md) — how to upstream the panel natively into `deepseek-ai/deepseek-harness` and `anywhere-labs/dsh-desktop` (book icon in the desktop sidebar).
+
+## 📄 License
+
+MIT

package/README.md

@@ -1,33 +1,60 @@
-# Prompt-SkillArmory
+# Prompt•Skill-Armory
 
-CCswitch-style **prompt + skill manager** for the DeepSeek Harness web UI:
-globally injected prompts, skill install (manual / `.md` / directory / zip via
-CLI), agent-preset browsing — all in one panel with enable/disable switches.
+> **DeepSeek Harness 的提示词与技能管理器（CCswitch 风格）**
+> 管理全局生效的提示词、从 `.md`/目录/zip 安装技能、浏览 Agent 预设——一个面板，带启用/停用开关。
+
+**中文** · [**English**](./README.en.md)
+
+![version](https://img.shields.io/badge/version-0.5.6-00ff9c)
+![license](https://img.shields.io/badge/license-MIT-blue)
+![platform](https://img.shields.io/badge/platform-web%20%2B%20desktop-00ff9c)
+![CI](https://github.com/Qian-Ning/prompt-skill-armory/actions/workflows/ci.yml/badge.svg)
 
 ```
-✦ Prompt-SkillArmory [v0.4.0]
-┌────────────┬─────────────────┬──────────────┐
-│ 提示词      │ 技能             │ Agent预设     │
-│ (全局生效)  │ (合并管理)       │ (roster)     │
-└────────────┴─────────────────┴──────────────┘
+✦ Prompt•Skill-Armory [v0.5.6]
+┌────────────┬──────────────────┬──────────────┐
+│ 提示词      │ 技能              │ Agent预设     │
+│ (全局生效)  │ (合并管理)        │ (roster)     │
+└────────────┴──────────────────┴──────────────┘
 ```
 
 ---
 
-## One-command install
+## 📑 目录
+
+- [🚀 快速开始](#-快速开始)
+- [✨ 功能](#-功能)
+- [🖥️ 平台支持](#️-平台支持)
+- [🧰 在聊天中使用技能](#-在聊天中使用技能)
+- [🏗️ 架构](#️-架构)
+- [📦 包含的包](#-包含的包)
+- [🗂️ 仓库结构](#️-仓库结构)
+- [🛠️ 开发](#️-开发)
+- [❓ FAQ](#-faq)
+- [📚 文档](#-文档)
+- [🤝 贡献 / 官方合入](#-贡献--官方合入)
+- [📄 许可](#-许可)
+
+---
+
+## 🚀 快速开始
+
+### 安装
 
 ```bash
 npx prompt-skill-armory
 ```
 
-The installer:
-1. locates the harness home (`~/.dsh` or `$DSH_HOME`),
-2. copies the two plugin packages into
-   `~/.dsh/profiles/web/node_modules/@deepseek-ai/`,
-3. adds the Host bundle to the web profile's `dsh.profile.bundles`,
-4. prints next steps.
+安装器自动完成：
+
+1. 定位 DSH home
+2. 确保 `web` + `desktop` profile 存在
+3. 安装两个插件包（Host + Web 面板）
+4. 配置 Host bundle
+5. 挂载面板（profile `cordis.patch.yml`）
+6. 体检 settings（防 4MB 膨胀）
 
-Then, in your DeepSeek Harness checkout:
+### 启动
 
 ```bash
 cd deepseek-harness
@@ -35,78 +62,145 @@ pnpm run build
 pnpm dsh web
 ```
 
-Open **Settings** → **Prompt-SkillArmory** (book icon).
+（或直接重启 DSH Desktop 客户端。）
 
-> **Requirement**: a working DeepSeek Harness runtime (`dsh web`). The plugin
-> plugs into DSH; it does not bundle the runtime.
+打开 **设置 → Prompt•Skill-Armory**（书图标）。
+
+> **要求**：已安装 DeepSeek Harness 运行时（`dsh web` 或桌面客户端）。插件是 DSH 的插件，不打包运行时本身。
 
 ---
 
-## Features
+## ✨ 功能
+
+- **提示词（全局生效）** — 增删改查、启用/停用、设默认。启用后经 `ctx.systemPrompt.section` 注入**每个 agent** 的系统提示词。
+- **技能（合并管理）** — 一个列表：面板安装的（编辑/开关/卸载）+ 本地扫描的（托管），带调用提示 `/name`。
+- **技能安装方式**
+  - 手动填写
+  - `.md` 文件选择
+  - 会话内命令：`/armory-skill-dir <dir>`、`/armory-install-zip <zip>`
+- **Agent 预设** — 浏览名册、设默认。
+- **中英双语 UI**（简体中文 / English）。
+- **设置侧边栏书图标**。
 
-- **Prompts (global)** — add / edit / enable / disable / set default / delete.
-  Enabled prompts are injected into every agent's system prompt via
-  `ctx.systemPrompt.section`.
-- **Skills** — one merged list: panel-installed (edit / toggle / uninstall)
-  and locally scanned (adopt). Per-card invoke hint: `/skill-name`.
-- **Skill install paths**
-  - Manual entry (name / description / content)
-  - `.md` file picker (browser)
-  - CLI in a session:
-    - `/armory-skill-dir <dir>` — directory skill (SKILL.md + references)
-    - `/armory-install-zip <zip>` — zip bundle
-- **Agent presets** — browse the roster, set default.
-- Bilingual (简体中文 / English).
-- Book icon in the settings sidebar.
+## 🖥️ 平台支持
 
-> Legacy `/sw-*` command aliases still work.
+| 环境 | 面板 | `/armory` 命令 |
+|---|---|---|
+| `dsh web`（官方） | ✅ | ✅ |
+| DSH Desktop 客户端 | ✅ | ✅ |
 
-## Using a skill in chat
+通过 profile 组合实现（安装器把面板挂进每个 profile 的 `cordis.patch.yml`）——无需 fork 客户端。
 
-Type `/` then the skill name in the chat input, e.g.:
+## 🧰 在聊天中使用技能
+
+在输入框打 `/` + 技能名：
 
 ```
 /code-review
 /mission-keeper
 ```
 
-The skill body is injected and the agent follows it. Skills are also visible
-to the model when `modelInvocable`.
+技能体被注入，agent 按它执行。`modelInvocable` 的技能模型也可自主调用。
 
----
+## 🏗️ 架构
+
+```
+┌──────────────────────────────────────────────────────┐
+│                    DSH 运行时                         │
+│                                                      │
+│  ┌─────────────┐   RPC/connection   ┌─────────────┐  │
+│  │  Web 面板    │◄──────────────────►│  Host 服务    │  │
+│  │ ui-switchblade│   api.skills.*    │ switchblade │  │
+│  │  (settings)  │   api.settings.*  │  (bundle)   │  │
+│  └─────────────┘                    └──────┬──────┘  │
+│                                            │         │
+│                              ctx.systemPrompt.section│
+│                              ctx.skills.register     │
+│                                            │         │
+│                              ┌─────────────┴──────┐  │
+│                              │ 每个 agent 系统提示词 │  │
+│                              │ 技能注册表 / 预设     │  │
+│                              └────────────────────┘  │
+└──────────────────────────────────────────────────────┘
+```
 
-## Repository layout
+- **Host 服务**（`switchblade` bundle）持有提示词/技能/预设的 CRUD 与持久化，通过 `ctx.systemPrompt.section` 全局注入、`ctx.skills.register` 注册技能。
+- **Web 面板**（`ui-switchblade`）通过 connection RPC 调用 Host（`api.skills.list`、`api.agentPresets.list`、`api.settings.mutate/describe`），不直接碰 DSH 内部。
+- **安装器**把两者通过 profile 组合装进 DSH——web 和 desktop 共用同一套机制。
+
+## 📦 包含的包
+
+| 包 | 作用 |
+|---|---|
+| `prompt-skill-armory` | npm 安装器（CLI） |
+| `@deepseek-ai/dsh-switchblade` | Host 服务（提示词/技能/命令） |
+| `@deepseek-ai/dsh-client-ui-switchblade` | Web 面板 |
+
+## 🗂️ 仓库结构
 
 ```
 prompt-skill-armory/
-├── package.json         # npm installer package (bin: armory)
-├── cli.mjs              # one-command install CLI
-├── packages/            # shipped plugin builds (lib + src + manifests)
-│   ├── switchblade/              @deepseek-ai/dsh-switchblade (Host)
-│   └── client-ui-switchblade/    @deepseek-ai/dsh-client-ui-switchblade (Web panel)
-├── plugin-src/          # plugin source mirrors (dev reference)
-├── scripts/             # dev helpers (link, build)
-├── demo/demo.html       # standalone UI preview (mock data)
-├── CHANGELOG.md         # version history
-└── PUBLISHING.md        # npm publish walkthrough
+├── cli.cjs                  # 一键安装 CLI
+├── package.json             # npm 安装器包
+├── packages/                # 构建好的插件（lib+src+manifest）
+│   ├── switchblade/         # @deepseek-ai/dsh-switchblade (Host)
+│   └── client-ui-switchblade/ # @deepseek-ai/dsh-client-ui-switchblade (Web)
+├── plugin-src/              # 插件源码镜像
+├── scripts/build-shipped.mjs # 从 DSH checkout 同步构建产物
+├── demo/demo.html           # UI 预览（mock 数据）
+├── README.md                # 本文（中文）· README.en.md 英文版
+├── UPSTREAM.md              # 官方合入指南
+├── CHANGELOG.md             # 版本历史
+├── PUBLISHING.md            # 发布指南
+├── TESTING.md               # 测试指南
+├── LICENSE                  # MIT
+└── .github/workflows/ci.yml # CI 质量门禁
 ```
 
-## Development
+## 🛠️ 开发
+
+改源码后重建发布包：
 
 ```bash
-# after editing plugin-src, rebuild the shipped packages
-node scripts/build-shipped.mjs
+node scripts/build-shipped.mjs <path-to-deepseek-harness>
 ```
 
-Version bumps touch **three places** together:
+版本更新三处同步：
+
 1. `packages/*/package.json` `version`
-2. panel `ARMORY_VERSION` in `plugin-src/client/src/client/SwitchbladeSection.tsx`
+2. `ARMORY_VERSION`（面板常量）
 3. `CHANGELOG.md`
 
-## Version history
+然后重建 client bundle 让版本徽章更新。
+
+## ❓ FAQ
+
+**Q: 为什么我的客户端侧边栏图标是齿轮而不是书？**
+A: 桌面客户端打包版的 `SettingsRoot` 硬编码了图标映射。通过 npm 安装器的 profile 组合，面板能正常工作，但书图标需要官方合入（见 [`UPSTREAM.md`](./UPSTREAM.md)）。
+
+**Q: 会不会影响我已有的配置/会话？**
+A: 不会。插件只新增 `switchblade` settings 命名空间，不动其他配置。安装器还会体检 settings，防止膨胀。
+
+**Q: 支持离线安装吗？**
+A: 可以。把 npm 包拷到目标机器，`npm install <tarball>` 即可；或用 `file:` 安装本地构建产物（见 [`TESTING.md`](./TESTING.md)）。
+
+**Q: 技能从哪里来？**
+A: 三种：手动填写、`.md` 文件选择、会话内 `/armory-skill-dir`（目录）或 `/armory-install-zip`（zip）。安装后统一进"技能"tab 管理。
+
+## 📚 文档
+
+| 文档 | 说明 |
+|---|---|
+| [`README.en.md`](./README.en.md) | 英文版自述 |
+| [`TESTING.md`](./TESTING.md) | 本地功能测试（无需发布） |
+| [`PUBLISHING.md`](./PUBLISHING.md) | 发布新版本指南 |
+| [`UPSTREAM.md`](./UPSTREAM.md) | 官方合入指南（书图标 PR） |
+| [`CHANGELOG.md`](./CHANGELOG.md) | 完整版本历史 |
+
+## 🤝 贡献 / 官方合入
 
-See `CHANGELOG.md`. Current: **0.4.0**.
+见 [`UPSTREAM.md`](./UPSTREAM.md) —— 如何让面板原生内置进 `deepseek-ai/deepseek-harness` 与 `anywhere-labs/dsh-desktop`（客户端侧边栏书图标）。
 
-## License
+## 📄 许可
 
 MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "prompt-skill-armory",
-  "version": "0.5.5",
-  "description": "One-command installer for Prompt-SkillArmory (prompts + skills manager) into a DeepSeek Harness web profile",
+  "version": "0.7.0",
+  "description": "One-command installer for Prompt-SkillArmory (prompts + skills manager) into the DeepSeek Harness (web + desktop)",
   "type": "module",
   "bin": {
     "armory": "./cli.cjs"
@@ -11,6 +11,9 @@
     "packages/"
   ],
   "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "postinstall": "node ./cli.cjs --postinstall",
     "build:shipped": "node scripts/build-shipped.mjs"
@@ -21,6 +24,16 @@
     "dsh",
     "prompt",
     "skill",
-    "ccswitch"
-  ]
-}
+    "ccswitch",
+    "agent",
+    "desktop"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Qian-Ning/prompt-skill-armory.git"
+  },
+  "homepage": "https://github.com/Qian-Ning/prompt-skill-armory",
+  "bugs": {
+    "url": "https://github.com/Qian-Ning/prompt-skill-armory/issues"
+  }
+}