dsh-agora 0.2.3 → 0.2.4

package/README.md

@@ -1,96 +1,50 @@
 # dsh-agora
 
-DSH (DeepSeek Harness) skill plugin: a **thin shell** that ships the Agora
-skill — RTC, RTM, ConvoAI, CLI, Cloud Recording, Server, Server Gateway,
-tokens — synced **verbatim** from
-[`AgoraIO/skills`](https://github.com/AgoraIO/skills) at a pinned release tag.
+**A DeepSeek Harness (DSH) plugin that adds the official Agora skill to your agent.** One install gives you voice AI agents, RTC video/voice calls, RTM chat & signaling, Cloud Recording, Agora CLI acceleration, and server-side token generation — driven from natural language.
 
-The plugin registers one bundled skill, `agora`, into DSH's skill registry —
-the same name and content as the Claude Code / Cursor ecosystems.
+The skill is synced verbatim from the official [AgoraIO/skills](https://github.com/AgoraIO/skills) repository, so it always matches the Agora docs and quickstarts.
 
-## Install
-
-```sh
-dsh plugin --profile web add dsh-agora
-```
+## Prerequisites
 
-Then restart the web profile. The `agora` skill appears in the skill catalog.
+- DeepSeek Harness (DSH) installed and running
+- An [Agora](https://console.agora.io) account (for tokens/App ID when you build a real app)
 
-From a local checkout (development):
+## Install
 
 ```sh
-dsh plugin --profile web add /path/to/dsh-agora
+dsh plugin --profile web add dsh-agora
 ```
 
-> **pnpm workspace-root gotcha**: with pnpm ≥ 8.15 the profile's workspace
-> root rejects a bare `add` (`ERR_PNPM_ADDING_TO_ROOT`). The clean fix is to
-> disable the check once per profile so plain `dsh plugin add` just works:
+> **Note**: with pnpm ≥ 8.15 (e.g. 9.15) the profile workspace root rejects a
+> bare `add` with `ERR_PNPM_ADDING_TO_ROOT`. If you hit that, pass `-w`:
 >
 > ```sh
-> echo "ignore-workspace-root-check=true" > ~/.dsh/profiles/web/.npmrc
-> dsh plugin --profile web add dsh-agora
+> dsh plugin --profile web add -w dsh-agora
 > ```
->
-> (Alternative: add `-w` to the command: `dsh plugin --profile web add -w dsh-agora`.
-> The root cause is dsh's `plugin` subcommand forwarding verbatim to pnpm with
-> no package-manager switch — worth an upstream issue if it bites more users.)
->
-> **link: dev mode**: the profile must resolve the runtime peer
-> `@deepseek-ai/dsh-skill`. Install it in the repo checkout first
-> (`pnpm install`); otherwise `index.js` fails with
-> `ERR_MODULE_NOT_FOUND` at load time (decision D-09).
-
-## What it contains
 
-```
-dsh-agora/
-├── package.json            # dsh.bundle.patch declaration (bundle form)
-├── cordis.patch.yml        # inserts the provider row into the profile tree
-├── index.js                # Cordis entry: registers the bundled agora provider
-├── scripts/sync-deps.sh    # ★ the only automation: tag-sync from AgoraIO/skills
-└── assets/agora/           # synced output (gitignored, not committed)
-    ├── SKILL.md            # upstream verbatim, zero rewrite
-    └── references/         # full reference set (54 files)
-```
-
-## How content stays in sync
-
-`npm publish` runs `prepack` → `scripts/sync-deps.sh`, which:
-
-1. resolves the release tag (`$TAG` env → GitHub latest release → pinned
-   fallback `v1.8.1`),
-2. pulls the `AgoraIO/skills` tarball for that tag,
-3. `rsync -a --delete`s `skills/agora/` → `assets/agora/` — **zero rewrite**,
-   so the two copies can never drift.
+Restart the web profile, and the `agora` skill appears in the skill catalog.
 
-The repo keeps no permanent copy of the skill content; `assets/` is
-gitignored and rebuilt at release time. Run it manually with
-`npm run sync:deps`.
+## What the skill covers
 
-## Skill: `agora`
+| Area | What you can do |
+|---|---|
+| **Voice AI agents** (ConvoAI) | Build voice agents / voicebots |
+| **RTC** | Video & voice calls, live streaming, screen sharing |
+| **RTM** | Chat, presence, signaling |
+| **Cloud Recording** | Record calls and streams |
+| **Server** | Generate tokens & App IDs server-side |
+| **Server Gateway** | Cross-product server coordination |
+| **Agora CLI** | CLI acceleration (auto-detected if installed) |
 
-Upstream routing: RTC (video/voice calls), RTM (chat/signaling), ConvoAI
-(voice AI agents), Agora CLI, Cloud Recording, Server (tokens), Server
-Gateway, and cross-product coordination. ConvoAI follows the upstream
-"proven baseline first" rule (run the official quickstart before scaffolding
-from memory); CLI acceleration is runtime-detected (`agora` on `PATH`), never
-bundled.
+## Using the skill
 
-Design rules and decisions (D-01…D-10) and the ROADMAP are kept local-only
-under `docs/` — not committed to this public repo.
+Describe what you want in natural language — e.g. *"set up a voice AI agent with Agora"* or *"build an RTC video call app"*. The skill routes to the official quickstarts and guides you through setup, including auth and token flows.
 
-## Verify locally
+## FAQ
 
-```sh
-dsh --profile web --dump-config --patch ./cordis.patch.yml   # row composes
-```
-
-For a real mount test, install into a throwaway profile:
+**Does this repo contain the skill itself?** No — the skill ships inside the plugin bundle, synced from the official Agora skill repo at each release.
 
-```sh
-dsh plugin --profile agoratest add .
-dsh --profile agoratest --dump-config | grep agora-skills
-```
+**Do I need the Agora CLI installed?** No. It's optional; if it's on your `PATH`, the skill uses it for faster workflows.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-agora",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "DSH skill bundle: the Agora skill (RTC, RTM, ConvoAI, CLI, Cloud Recording, tokens) synced verbatim from AgoraIO/skills at a pinned release tag. Install to add the `agora` skill to DeepSeek Harness.",
   "type": "module",
   "main": "index.js",