@shadowob/connector 1.1.6 → 1.1.8

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.md CHANGED
@@ -1,11 +1,23 @@
1
1
  # Shadow Connector
2
2
 
3
- Connection helpers for attaching a Shadow Buddy token to OpenClaw, Hermes Agent, or cc-connect.
3
+ Connection helpers for attaching Shadow Buddies to local OpenClaw and CLI runtimes.
4
4
 
5
- The package exports pure plan builders for app UIs and a `shadowob-connector` CLI for terminal setup.
5
+ The package exports pure plan builders for legacy app UIs and a `shadowob-connector` CLI for terminal setup.
6
6
 
7
7
  ## CLI
8
8
 
9
+ Run the daemon flow used by the Buddy creation panel:
10
+
11
+ ```bash
12
+ npx @shadowob/connector@latest --daemon \
13
+ --server-url https://shadowob.com \
14
+ --api-key sk_machine_...
15
+ ```
16
+
17
+ The daemon connects this computer once, scans supported runtimes, sends heartbeats to Shadow, claims Buddy setup jobs, and configures the selected runtime. Supported runtime detection currently includes OpenClaw, Hermes Agent, Claude Code, Codex CLI, OpenCode, Gemini CLI, Cursor CLI, Kimi CLI, Copilot CLI, and Antigravity CLI.
18
+
19
+ Use `--once` to run one heartbeat/job pass for debugging, and `--poll-interval-ms` to tune the loop interval.
20
+
9
21
  Print a plan:
10
22
 
11
23
  ```bash
@@ -24,11 +36,31 @@ npx @shadowob/connector@latest connect \
24
36
  --token buddy-token
25
37
  ```
26
38
 
27
- Use `--dry-run` to preview writes and commands. Use `--json` with `plan` when embedding the plan in another tool.
39
+ `--server-url` defaults to `https://shadowob.com`. Use `--dry-run` to preview writes and commands. Use `--json` with `plan`, `scan`, `status`, or `doctor` when embedding output in another tool.
40
+
41
+ Operational commands:
42
+
43
+ ```bash
44
+ npx @shadowob/connector@latest scan
45
+ npx @shadowob/connector@latest status --target cc-connect
46
+ npx @shadowob/connector@latest doctor --target hermes
47
+ npx @shadowob/connector@latest fix --target openclaw --server-url https://shadowob.com --token buddy-token
48
+ npx @shadowob/connector@latest update --target cc-connect --server-url https://shadowob.com --token buddy-token
49
+ ```
50
+
51
+ - `scan` probes local OpenClaw, Hermes Agent, and cc-connect installs/config files, then prints connection instructions for each target.
52
+ - `status` checks local connector health and exits successfully.
53
+ - `doctor` prints the same checks with fix guidance and exits non-zero when required config is broken.
54
+ - `fix` reinstalls common Shadow CLI/skill assets and repairs the target connector config.
55
+ - `update` refreshes the same assets/config and installs target runtime dependencies by default.
28
56
 
29
- `connect` merges existing configuration instead of replacing it:
57
+ `connect`, `fix`, and `update` merge existing configuration instead of replacing it:
30
58
 
31
- - OpenClaw JSON defaults to `~/.shadowob/openclaw.json` or `--openclaw-config`.
59
+ - Shadow CLI access is installed/configured for the Buddy: if `shadowob` is not
60
+ on `PATH`, the connector writes a `~/.local/bin/shadowob` shim; it installs
61
+ the official Shadow skill files into common agent skill directories; and it
62
+ writes a Buddy profile to `~/.shadowob/shadowob.config.json`.
63
+ - OpenClaw JSON defaults to `~/.openclaw/openclaw.json` or `--openclaw-config`.
32
64
  - Hermes updates `~/.hermes/.env` and merges `~/.hermes/config.yaml`.
33
65
  - cc-connect merges the ShadowOB platform into `~/.cc-connect/config.toml`.
34
66
 
@@ -178,6 +210,6 @@ The tests cover plan generation, config merging for OpenClaw/Hermes/cc-connect,
178
210
 
179
211
  ## Capability Coverage
180
212
 
181
- - OpenClaw: channel messages, DMs, threads, mentions, attachments/images, interactive components, slash commands, online status, typing/activity, reactions, edits/deletes, status checks, usage/cost telemetry, multi-Agent Buddy binding, Shadow CLI login/notifications, official skills, cron tasks.
182
- - Hermes Agent: channel messages, DMs, threads, attachments/images, interactive components, slash commands, online status, typing/activity, cron delivery, status checks, usage/cost telemetry, Shadow CLI login/notifications, official skills.
213
+ - OpenClaw: channel messages, DMs, threads, mentions, attachments/images/voice messages, voice playback/transcript metadata, interactive components, slash commands, online status, typing/activity, reactions, edits/deletes, status checks, usage/cost telemetry, multi-Agent Buddy binding, Shadow CLI login/notifications, official skills, cron tasks.
214
+ - Hermes Agent: channel messages, DMs, threads, attachments/images/voice messages, voice playback/transcript metadata, interactive components, slash commands, online status, typing/activity, cron delivery, status checks, usage/cost telemetry, Shadow CLI login/notifications, official skills.
183
215
  - cc-connect: channel messages, DMs, attachments/images, interactive components, slash commands, typing, streaming previews, forms, status checks, usage/cost telemetry, multi-Agent Buddy binding, Shadow CLI login/notifications.