@realtimex/sdk 1.7.11 → 1.7.13
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/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: realtimex-moderator-sdk
|
|
3
3
|
description: Control and interact with the RealTimeX application through its Node.js SDK. This skill should be used when users want to manage workspaces, threads, agents, activities, LLM chat, vector store, MCP tools, ACP agent sessions, TTS/STT, or any other RealTimeX platform feature via the API. All method signatures are verified against the SDK source code.
|
|
4
|
-
generated: 2026-05-
|
|
5
|
-
sdk_version: 1.7.
|
|
4
|
+
generated: 2026-05-08
|
|
5
|
+
sdk_version: 1.7.13
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# RealTimeX Moderator (SDK Source-Verified)
|
|
9
9
|
|
|
10
|
-
Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.
|
|
10
|
+
Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.13**. Authentication is automatic when running inside RealtimeX.
|
|
11
11
|
|
|
12
12
|
`<SKILL_DIR>` below refers to the directory containing this SKILL.md.
|
|
13
13
|
|
|
@@ -140,6 +140,10 @@ await sdk.desktopRuntimeSessions.launchTerminalShell({
|
|
|
140
140
|
});
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
+
Rule:
|
|
144
|
+
- If you launch a shell with `initialCommand` and the user did not explicitly ask to prefill only, use `initialCommandMode: "direct"`.
|
|
145
|
+
- Use `prefill` only when the user specifically wants the command staged without execution.
|
|
146
|
+
|
|
143
147
|
Manage existing terminal sessions:
|
|
144
148
|
|
|
145
149
|
```js
|
|
@@ -349,6 +353,52 @@ It covers:
|
|
|
349
353
|
- **Agent Skills** — types (`repo`/`zip`), scopes, status values
|
|
350
354
|
- **Data Models** — all database models with fields and defaults
|
|
351
355
|
|
|
356
|
+
### Heartbeat Task Blocks
|
|
357
|
+
|
|
358
|
+
When working with `HEARTBEAT.md`, check whether it uses a top-level `tasks:` block.
|
|
359
|
+
|
|
360
|
+
Example:
|
|
361
|
+
|
|
362
|
+
```yaml
|
|
363
|
+
tasks:
|
|
364
|
+
- name: audit-fetch
|
|
365
|
+
interval: 4h
|
|
366
|
+
prompt: Fetch origin/realtimex-dev and diff against tmp/frontend-audit-cursor.txt.
|
|
367
|
+
|
|
368
|
+
- name: audit-ui-design
|
|
369
|
+
interval: 4h
|
|
370
|
+
prompt: Review changed frontend files for UI design violations. If none, reply HEARTBEAT_OK.
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
Rules:
|
|
374
|
+
- A top-level `tasks:` list means the heartbeat is split into separate scheduled tasks, not one monolithic prompt.
|
|
375
|
+
- Each `- name:` item is its own task definition.
|
|
376
|
+
- `name` is the stable task id. Keep it concise and stable when editing.
|
|
377
|
+
- `interval` is the cadence for that specific task.
|
|
378
|
+
- `prompt` is the full instruction body for that task.
|
|
379
|
+
- `HEARTBEAT_OK` means the task ran successfully but had nothing actionable to do.
|
|
380
|
+
- Preserve task order unless the user explicitly wants a reordering.
|
|
381
|
+
- If one task refers to another task's output, that dependency is described in the prompt text. Do not invent hidden YAML dependency fields.
|
|
382
|
+
|
|
383
|
+
When editing heartbeat files:
|
|
384
|
+
- If the file already uses `tasks:`, add or edit individual task items instead of collapsing them into one large prompt.
|
|
385
|
+
- If the file is a single long heartbeat prompt and the user wants separate scheduled jobs, rewrite it into a `tasks:` list with one item per independent workflow.
|
|
386
|
+
- When splitting a single heartbeat into tasks, preserve the original intent, move each discrete workflow into its own `prompt`, and keep shared context text only where needed.
|
|
387
|
+
- Keep YAML formatting simple: top-level `tasks:`, then `- name`, `interval`, `prompt`.
|
|
388
|
+
|
|
389
|
+
When a user asks how to convert a heartbeat into task-block form, produce or edit it into this shape:
|
|
390
|
+
|
|
391
|
+
```yaml
|
|
392
|
+
tasks:
|
|
393
|
+
- name: task-one
|
|
394
|
+
interval: 4h
|
|
395
|
+
prompt: First workflow instructions.
|
|
396
|
+
|
|
397
|
+
- name: task-two
|
|
398
|
+
interval: 12h
|
|
399
|
+
prompt: Second workflow instructions.
|
|
400
|
+
```
|
|
401
|
+
|
|
352
402
|
---
|
|
353
403
|
|
|
354
404
|
## References
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# RealTimeX SDK — API Reference
|
|
2
2
|
|
|
3
|
-
> Auto-generated from `@realtimex/sdk` source · v**1.7.
|
|
3
|
+
> Auto-generated from `@realtimex/sdk` source · v**1.7.13** · 2026-05-08
|
|
4
4
|
|
|
5
5
|
**Package:** `@realtimex/sdk` (CJS) · **Server:** `http://localhost:3001`
|
|
6
6
|
**Developer Mode auth:** `Authorization: Bearer <apiKey>`
|
|
@@ -84,6 +84,8 @@ await sdk.desktopRuntimeSessions.launchTerminalShell({
|
|
|
84
84
|
});
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
+
Default rule: when launching a shell with an initial command, prefer `initialCommandMode: 'direct'` unless the user explicitly wants prefill-only behavior.
|
|
88
|
+
|
|
87
89
|
Common mistake:
|
|
88
90
|
|
|
89
91
|
```js
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Known Issues — Source-Detected
|
|
2
2
|
|
|
3
|
-
> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.
|
|
3
|
+
> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.13** · 2026-05-08
|
|
4
4
|
|
|
5
5
|
Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
|
|
6
6
|
|
|
@@ -365,7 +365,11 @@ CMD['terminal-launch-shell'] = async () => {
|
|
|
365
365
|
if (flags.thread) body.threadSlug = flags.thread;
|
|
366
366
|
if (flags.presentation) body.presentationMode = flags.presentation;
|
|
367
367
|
if (flags.command) body.initialCommand = flags.command;
|
|
368
|
-
if (flags['command-mode'])
|
|
368
|
+
if (flags['command-mode']) {
|
|
369
|
+
body.initialCommandMode = flags['command-mode'];
|
|
370
|
+
} else if (flags.command) {
|
|
371
|
+
body.initialCommandMode = 'direct';
|
|
372
|
+
}
|
|
369
373
|
if (flags.title) body.title = flags.title;
|
|
370
374
|
if (flags.subtitle) body.subtitle = flags.subtitle;
|
|
371
375
|
print(await terminal.launchTerminalShell(body));
|
|
@@ -953,6 +957,7 @@ sdk.desktopRuntimeSessions.* — Desktop terminal sessions:
|
|
|
953
957
|
[--workspace=<slug>] [--thread=<slug>] [--presentation=panel|tab]
|
|
954
958
|
[--command="pwd"] [--command-mode=direct|prefill|shell]
|
|
955
959
|
Launch a visible shell terminal.
|
|
960
|
+
Default: when --command is provided, it runs in direct mode unless --command-mode is explicitly set.
|
|
956
961
|
|
|
957
962
|
terminal-launch-cli-agent <agent-name> [<provider-id>] [<message>]
|
|
958
963
|
[--workspace=<slug>] [--thread=<slug>] [--presentation=panel|tab] [--model=<id>]
|