@realtimex/sdk 2.0.3 → 2.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@realtimex/sdk",
-    "version": "2.0.3",
+    "version": "2.0.5",
     "description": "SDK for building Local Apps that integrate with RealtimeX",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
@@ -25,9 +25,10 @@
         "sdk:generate:force": "node ../scripts/generate-v1-sdk.mjs --force",
         "sdk:diff": "node ../scripts/generate-v1-sdk.mjs --dry-run",
         "skill:generate": "node ../scripts/generate-skill.mjs --force",
+        "skill:local-test": "node ../scripts/local-test-realtimex-skill.mjs",
         "pp-cli:build": "node ../scripts/build-pp-cli-packages.mjs",
         "pp-cli:publish": "node ../scripts/publish-pp-cli-packages.mjs",
-        "prepublishOnly": "npm run build"
+        "prepublishOnly": "npm run build && npm run skill:generate"
     },
     "keywords": [
         "realtimex",

package/skills/realtimex-moderator-sdk/SKILL.md

@@ -0,0 +1,281 @@
+---
+name: realtimex-moderator-sdk
+description: "Use the RealTimeX API through the generated CLI for workspace, thread, and chat operations."
+author: ""
+license: "Apache-2.0"
+argument-hint: "<command> [args] | install cli"
+allowed-tools: "Read Bash"
+metadata:
+  openclaw:
+    requires:
+      bins:
+        - realtimex-pp-cli
+---
+
+# Realtimex — Printing Press CLI
+
+## Prerequisites: Install the CLI
+
+This skill drives the `realtimex-pp-cli` binary. Verify the CLI is installed and exactly matches this skill's SDK version before invoking any command from this skill. If it is missing or the version does not match, reinstall the pinned version first:
+
+1. Install or reinstall the pinned version via npm:
+   ```bash
+   npm install -g @realtimex/pp-cli@2.0.5
+   ```
+2. Verify the exact version:
+   ```bash
+   realtimex-pp-cli --version
+   ```
+   The output must be `realtimex-pp-cli 2.0.5`.
+
+If `--version` reports "command not found" after install, the npm global bin directory is not on `$PATH`. If it reports any version other than `2.0.5`, reinstall with the pinned npm command above. Do not proceed with skill commands until exact-version verification succeeds.
+
+## Command Reference
+
+**clear-workspace-default-agent** — Manage clear workspace default agent
+
+- `realtimex-pp-cli clear-workspace-default-agent <workspaceSlug>` — Clear the default CLI agent from a workspace.
+
+**create-thread** — Manage create thread
+
+- `realtimex-pp-cli create-thread <workspaceSlug>` — Create a thread in one workspace. The name is optional but recommended.
+
+**create-workspace** — Manage create workspace
+
+- `realtimex-pp-cli create-workspace` — Create a workspace. Requires a human-readable workspace name.
+
+**delete-thread** — Manage delete thread
+
+- `realtimex-pp-cli delete-thread <workspaceSlug> <threadSlug>` — Delete one thread by exact workspace slug and exact thread slug.
+
+**delete-workspace** — Manage delete workspace
+
+- `realtimex-pp-cli delete-workspace <workspaceSlug>` — Delete one workspace by exact workspace slug.
+
+**get-thread** — Manage get thread
+
+- `realtimex-pp-cli get-thread <workspaceSlug> <threadSlug>` — Get one thread by exact workspace slug and exact thread slug.
+
+**get-workspace** — Manage get workspace
+
+- `realtimex-pp-cli get-workspace <workspaceSlug>` — Get one workspace by exact workspace slug.
+
+**list-llm-models** — Manage list llm models
+
+- `realtimex-pp-cli list-llm-models <provider>` — List models for one provider id. Use an exact model id from this response with send-llm-message.
+
+**list-llm-providers** — Manage list llm providers
+
+- `realtimex-pp-cli list-llm-providers` — List supported LLM providers. Use provider ids from this response with list-llm-models and send-llm-message.
+
+**list-threads** — Manage list threads
+
+- `realtimex-pp-cli list-threads <workspaceSlug>` — List threads for one exact workspace slug.
+
+**list-workspaces** — Manage list workspaces
+
+- `realtimex-pp-cli list-workspaces` — List all workspaces visible to the current API caller. Use this before choosing a workspace slug.
+
+**prepare** — Manage prepare
+
+- `realtimex-pp-cli prepare` — Return compact workspace, thread, LLM provider, model, and CLI agent context for agents before choosing arguments.
+
+**rename-thread** — Manage rename thread
+
+- `realtimex-pp-cli rename-thread <workspaceSlug> <threadSlug>` — Rename one thread by exact workspace slug and exact thread slug. Only the name is changed.
+
+**rename-workspace** — Manage rename workspace
+
+- `realtimex-pp-cli rename-workspace <workspaceSlug>` — Rename one workspace by exact workspace slug. Only the name is changed.
+
+**send-llm-message** — Manage send llm message
+
+- `realtimex-pp-cli send-llm-message <workspaceSlug> <threadSlug>` — Send one non-streaming LLM message to an exact thread.
+
+**set-workspace-default-agent** — Manage set workspace default agent
+
+- `realtimex-pp-cli set-workspace-default-agent <workspaceSlug>` — Set the default CLI agent for a workspace.
+
+
+### Finding the right command
+
+When you know what you want to do but not which command does it, ask the CLI directly:
+
+```bash
+realtimex-pp-cli which "<capability in your own words>"
+```
+
+`which` resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code `0` means at least one match; exit code `2` means no confident match — fall back to `--help` or use a narrower query.
+
+## Auth Setup
+Run `realtimex-pp-cli auth setup` to print the URL and steps for getting a key (add `--launch` to open the URL). Then set:
+
+```bash
+export REALTIMEX_APP_ID_AUTH="<your-key>"
+```
+
+Or persist it in `~/.config/realtimex-developer-pp-cli/config.toml`.
+
+Run `realtimex-pp-cli doctor` to verify setup.
+
+## Agent Mode
+
+Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color --yes`.
+
+- **Pipeable** — JSON on stdout, errors on stderr
+- **Filterable** — `--select` keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
+
+  ```bash
+  realtimex-pp-cli clear-workspace-default-agent mock-value --agent --select id,name,status
+  ```
+- **Previewable** — `--dry-run` shows the request without sending
+- **Offline-friendly** — sync/search commands can use the local SQLite store when available
+- **Non-interactive** — never prompts, every input is a flag
+- **Explicit retries** — use `--idempotent` only when an already-existing create should count as success, and `--ignore-missing` only when a missing delete target should count as success
+
+### Response envelope
+
+Commands that read from the local store or the API wrap output in a provenance envelope:
+
+```json
+{
+  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
+  "results": <data>
+}
+```
+
+Parse `.results` for data and `.meta.source` to know whether it's live or local. A human-readable `N results (live)` summary is printed to stderr only when stdout is a terminal AND no machine-format flag (`--json`, `--csv`, `--compact`, `--quiet`, `--plain`, `--select`) is set — piped/agent consumers and explicit-format runs get pure JSON on stdout.
+
+## Agent Feedback
+
+When you (or the agent) notice something off about this CLI, record it:
+
+```
+realtimex-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
+realtimex-pp-cli feedback --stdin < notes.txt
+realtimex-pp-cli feedback list --json --limit 10
+```
+
+Entries are stored locally at `~/.local/share/realtimex-pp-cli/feedback.jsonl`. They are never POSTed unless `REALTIMEX_FEEDBACK_ENDPOINT` is set AND either `--send` is passed or `REALTIMEX_FEEDBACK_AUTO_SEND=true`. Default behavior is local-only.
+
+Write what *surprised* you, not a bug report. Short, specific, one line: that is the part that compounds.
+
+## Output Delivery
+
+Every command accepts `--deliver <sink>`. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
+
+| Sink | Effect |
+|------|--------|
+| `stdout` | Default; write to stdout only |
+| `file:<path>` | Atomically write output to `<path>` (tmp + rename) |
+| `webhook:<url>` | POST the output body to the URL (`application/json` or `application/x-ndjson` when `--compact`) |
+
+Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
+
+## Named Profiles
+
+A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.
+
+```
+realtimex-pp-cli profile save briefing --json
+realtimex-pp-cli --profile briefing clear-workspace-default-agent mock-value
+realtimex-pp-cli profile list --json
+realtimex-pp-cli profile show briefing
+realtimex-pp-cli profile delete briefing --yes
+```
+
+Explicit flags always win over profile values; profile values win over defaults. `agent-context` lists all available profiles under `available_profiles` so introspecting agents discover them at runtime.
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 2 | Usage error (wrong arguments) |
+| 3 | Resource not found |
+| 4 | Authentication required |
+| 5 | API error (upstream issue) |
+| 7 | Rate limited (wait and retry) |
+| 10 | Config error |
+
+## Argument Parsing
+
+Parse `$ARGUMENTS`:
+
+1. **Empty, `help`, or `--help`** → show `realtimex-pp-cli --help` output
+2. **Starts with `install`** → ends with `mcp` → MCP installation; otherwise → see Prerequisites above
+3. **Anything else** → Direct Use (execute as CLI command with `--agent`)
+
+## MCP Server Installation
+
+Install the MCP binary from this CLI's published public-library entry or pre-built release, then register it:
+
+```bash
+claude mcp add realtimex-pp-mcp -- realtimex-pp-mcp
+```
+
+Verify: `claude mcp list`
+
+## Direct Use
+
+1. Check whether the CLI is installed and version-matched:
+   ```bash
+   realtimex-pp-cli --version
+   ```
+   If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.5`, reinstall the pinned version:
+   ```bash
+   npm install -g @realtimex/pp-cli@2.0.5
+   ```
+   Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
+2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
+3. Execute with the `--agent` flag:
+   ```bash
+   realtimex-pp-cli <command> [subcommand] [args] --agent
+   ```
+4. If ambiguous, drill into subcommand help: `realtimex-pp-cli <command> --help`.
+
+## Constraints
+
+This skill intentionally exposes a small action-first command set. Prefer these generated commands over older nested resource commands.
+
+* Use only documented `realtimex-pp-cli` commands.
+* Never call the RealTimeX API directly with `curl`, `fetch`, raw HTTP clients, or custom scripts.
+* If the current CLI cannot do the requested task, say the feature is not available and will be added soon.
+* Use `--agent` on every command.
+* Always run first:
+
+  ```bash
+  realtimex-pp-cli prepare --agent
+  ```
+
+* Use exact workspace slugs, thread slugs, provider ids, model ids, agent `canonical`, and agent `modelId` values from `prepare`.
+* Do not guess workspace, thread, model, provider, agent, message, target, or option values.
+* If required context is missing or ambiguous, ask a concise clarification question before running a command.
+* Never assume a workspace or thread that the user has not referenced.
+* If the user does not name or contextually reference a workspace for a workspace/thread/message operation, ask which workspace to use before running a command.
+* If the user names or contextually references a thread but does not name or contextually reference its workspace, ask which workspace contains that thread before running a command.
+* When the user explicitly uses contextual references such as "current workspace", "this thread", "the thread just created", "that workspace", or similar references, resolve them from the available conversation context only when the reference is unambiguous.
+* If multiple plausible matches exist, ask the user to choose.
+
+For `send-llm-message`:
+
+* Require all four values to be explicitly named or explicitly referenced in the current request:
+  * workspace
+  * thread
+  * LLM provider
+  * LLM model
+* If any of those four values are missing or ambiguous, ask for the missing values before running the command.
+* Use provider/model only from:
+  * `prepare.models`
+  * `list-llm-providers`
+  * `list-llm-models`
+* Never use `prepare.agents[].models` for `send-llm-message`.
+* Prefer provider `realtimexai` unless the user explicitly asks for local `nodellama`.
+* Only choose a model id that exists in the selected provider's LLM model list.
+* If the requested model is unavailable, ask which available model to use instead.
+
+For workspace default-agent setup:
+
+* Use `prepare.agents` only.
+* Use exact agent `canonical` and optional agent `modelId` values from `prepare.agents`.
+* Never use `prepare.models` for workspace default-agent setup.