@botim/mp-debug-sdk 0.6.1 → 0.6.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.
Files changed (2) hide show
  1. package/README.md +16 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -13,10 +13,15 @@ Mini-programs run on user devices in environments you can't easily attach a debu
13
13
 
14
14
  ## Install
15
15
 
16
+ > **Heads-up — registry override required in BOTIM repos.**
17
+ > Most BOTIM mini-program repos pin the `@botim` scope to the internal Artifactory mirror (`@botim:registry=https://artifactory.corp.algento.com/artifactory/api/npm/bot-npm/`). This SDK is **published to public npm**, so a plain `npm install @botim/mp-debug-sdk` in those repos will hit Artifactory, not find the package, and 404. Use the public registry explicitly for this one package:
18
+
16
19
  ```bash
17
- npm install @botim/mp-debug-sdk
20
+ npm install @botim/mp-debug-sdk --registry=https://registry.npmjs.org/
18
21
  ```
19
22
 
23
+ If your repo doesn't have an `@botim` scope override (rare), the flag is harmless — npm uses `registry.npmjs.org` by default. **Don't** add `@botim:registry=https://registry.npmjs.org/` to your `.npmrc`: it would shadow the internal Artifactory registry that other `@botim/*` packages (mp-framework, etc.) need.
24
+
20
25
  ## 1. Add the env config files
21
26
 
22
27
  Each environment of your mini-program ships with one config file at the project root, in the standard BOTIM mini-program schema:
@@ -237,6 +242,16 @@ Once your build is wired and shipped, see **[`docs/live-debugging.md`](./docs/li
237
242
  | `RemoteDebugHandle.flush()` | Force-flush the in-memory buffer. |
238
243
  | `RemoteDebugHandle.stop()` | Uninstall and drain the queue. |
239
244
 
245
+ ## AI debug skill (Claude Code)
246
+
247
+ A Claude Code skill that teaches AI agents how to wire and consume this SDK lives at `.claude/skills/botim-debug-relay/SKILL.md`. Open Claude Code from this repo and the skill auto-loads — no setup needed. To use it from anywhere on your machine:
248
+
249
+ ```bash
250
+ cp -r .claude/skills/botim-debug-relay ~/.claude/skills/
251
+ ```
252
+
253
+ > **The file in this repo is a mirror.** The canonical copy lives in `botim-debug-relay/.claude/skills/botim-debug-relay/SKILL.md`. **Do not edit the SDK-side copy directly** — your changes will be overwritten by the next sync. Edit in the relay repo, then run `bash bin/sync-skill.sh` from that repo to propagate here.
254
+
240
255
  ## License
241
256
 
242
257
  [ISC](./LICENSE) © BOTIM
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botim/mp-debug-sdk",
3
- "version": "0.6.1",
3
+ "version": "0.6.2",
4
4
  "description": "Remote-debug SDK for BOTIM mini-programs — streams console, network, and error events to a BOTIM debug-relay for live inspection, with an AI-observable command channel.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",