@realtimex/sdk 1.7.10 → 1.7.12
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
|
@@ -2,12 +2,12 @@
|
|
|
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
4
|
generated: 2026-05-07
|
|
5
|
-
sdk_version: 1.7.
|
|
5
|
+
sdk_version: 1.7.12
|
|
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.12**. Authentication is automatic when running inside RealtimeX.
|
|
11
11
|
|
|
12
12
|
`<SKILL_DIR>` below refers to the directory containing this SKILL.md.
|
|
13
13
|
|
|
@@ -20,6 +20,7 @@ SKILL=<SKILL_DIR>/scripts/rtx.js
|
|
|
20
20
|
ENV=--env-dir=<cwd>
|
|
21
21
|
|
|
22
22
|
node "$SKILL" ping $ENV
|
|
23
|
+
node "$SKILL" context $ENV
|
|
23
24
|
node "$SKILL" agents $ENV
|
|
24
25
|
node "$SKILL" workspaces $ENV
|
|
25
26
|
node "$SKILL" threads <workspace-slug> $ENV
|
|
@@ -52,6 +53,21 @@ When the skill runs inside a spawned ACP or desktop terminal session, RealtimeX
|
|
|
52
53
|
|
|
53
54
|
The bundled `sdk-init` and `rtx.js` helpers use those env vars as default context for terminal actions and thread listing. Explicit arguments still win.
|
|
54
55
|
|
|
56
|
+
## Workspace And Thread Rule
|
|
57
|
+
|
|
58
|
+
When the skill is used and a task needs workspace/thread context:
|
|
59
|
+
|
|
60
|
+
1. Check current context first.
|
|
61
|
+
Use `const { sdk, context } = await initSDK()` or `node "$SKILL" context`.
|
|
62
|
+
2. If `context.workspaceSlug` or `context.threadSlug` exists, use it as the default.
|
|
63
|
+
3. If the user explicitly provided workspace/thread, those values override the default context.
|
|
64
|
+
4. If no current context is available:
|
|
65
|
+
- list workspaces first
|
|
66
|
+
- list threads for the chosen workspace if a thread is needed
|
|
67
|
+
- ask the user only when still ambiguous
|
|
68
|
+
|
|
69
|
+
Do not guess a workspace or thread if the current context is unknown.
|
|
70
|
+
|
|
55
71
|
---
|
|
56
72
|
|
|
57
73
|
## Desktop Terminal Sessions
|
|
@@ -124,6 +140,10 @@ await sdk.desktopRuntimeSessions.launchTerminalShell({
|
|
|
124
140
|
});
|
|
125
141
|
```
|
|
126
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
|
+
|
|
127
147
|
Manage existing terminal sessions:
|
|
128
148
|
|
|
129
149
|
```js
|
|
@@ -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.12** · 2026-05-07
|
|
4
4
|
|
|
5
5
|
**Package:** `@realtimex/sdk` (CJS) · **Server:** `http://localhost:3001`
|
|
6
6
|
**Developer Mode auth:** `Authorization: Bearer <apiKey>`
|
|
@@ -42,6 +42,7 @@ Use this module for visible Electron terminal sessions. This is the correct path
|
|
|
42
42
|
|
|
43
43
|
Do not use ACP for these unless the user explicitly asks for ACP/headless mode.
|
|
44
44
|
If the current process was spawned by RealtimeX, prefer `process.env.RTX_WORKSPACE_SLUG` and `process.env.RTX_THREAD_SLUG` as default context before guessing or asking the user.
|
|
45
|
+
Always resolve current workspace/thread context first when a terminal action needs it: explicit user input > spawned-process env > list workspaces/threads > ask user if still ambiguous.
|
|
45
46
|
|
|
46
47
|
### `V1DesktopRuntimeSessionsModule`
|
|
47
48
|
|
|
@@ -83,6 +84,8 @@ await sdk.desktopRuntimeSessions.launchTerminalShell({
|
|
|
83
84
|
});
|
|
84
85
|
```
|
|
85
86
|
|
|
87
|
+
Default rule: when launching a shell with an initial command, prefer `initialCommandMode: 'direct'` unless the user explicitly wants prefill-only behavior.
|
|
88
|
+
|
|
86
89
|
Common mistake:
|
|
87
90
|
|
|
88
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.12** · 2026-05-07
|
|
4
4
|
|
|
5
5
|
Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
|
|
6
6
|
|
|
@@ -73,6 +73,15 @@ function resolveWorkspaceFlagOrContext(context = {}) {
|
|
|
73
73
|
// ---------------------------------------------------------------------------
|
|
74
74
|
const CMD = {};
|
|
75
75
|
|
|
76
|
+
CMD.context = async () => {
|
|
77
|
+
const { context } = await getSDK();
|
|
78
|
+
print({
|
|
79
|
+
workspaceSlug: context?.workspaceSlug || null,
|
|
80
|
+
threadSlug: context?.threadSlug || null,
|
|
81
|
+
hasContext: Boolean(context?.workspaceSlug || context?.threadSlug),
|
|
82
|
+
});
|
|
83
|
+
};
|
|
84
|
+
|
|
76
85
|
// -- ping -------------------------------------------------------------------
|
|
77
86
|
// Source: index.ts → sdk.ping() → { success, mode, appId, timestamp }
|
|
78
87
|
CMD.ping = async () => { const { sdk } = await getSDK(); print(await sdk.ping()); };
|
|
@@ -356,7 +365,11 @@ CMD['terminal-launch-shell'] = async () => {
|
|
|
356
365
|
if (flags.thread) body.threadSlug = flags.thread;
|
|
357
366
|
if (flags.presentation) body.presentationMode = flags.presentation;
|
|
358
367
|
if (flags.command) body.initialCommand = flags.command;
|
|
359
|
-
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
|
+
}
|
|
360
373
|
if (flags.title) body.title = flags.title;
|
|
361
374
|
if (flags.subtitle) body.subtitle = flags.subtitle;
|
|
362
375
|
print(await terminal.launchTerminalShell(body));
|
|
@@ -892,6 +905,7 @@ Connection:
|
|
|
892
905
|
|
|
893
906
|
sdk.api.*:
|
|
894
907
|
agents / workspaces / threads <slug> / task <uuid>
|
|
908
|
+
context
|
|
895
909
|
|
|
896
910
|
sdk.activities.*:
|
|
897
911
|
activities [--status --limit --offset]
|
|
@@ -943,6 +957,7 @@ sdk.desktopRuntimeSessions.* — Desktop terminal sessions:
|
|
|
943
957
|
[--workspace=<slug>] [--thread=<slug>] [--presentation=panel|tab]
|
|
944
958
|
[--command="pwd"] [--command-mode=direct|prefill|shell]
|
|
945
959
|
Launch a visible shell terminal.
|
|
960
|
+
Default: when --command is provided, it runs in direct mode unless --command-mode is explicitly set.
|
|
946
961
|
|
|
947
962
|
terminal-launch-cli-agent <agent-name> [<provider-id>] [<message>]
|
|
948
963
|
[--workspace=<slug>] [--thread=<slug>] [--presentation=panel|tab] [--model=<id>]
|