@realtimex/sdk 2.0.32 → 2.0.34
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 +5 -2
- package/index.d.ts +198 -0
- package/index.js +186 -1
- package/package.json +1 -1
- package/skills/realtimex-artifacts/SKILL.md +73 -0
- package/skills/realtimex-automation-flows/SKILL.md +73 -0
- package/skills/realtimex-browser-sessions/SKILL.md +69 -0
- package/skills/realtimex-channels/SKILL.md +81 -0
- package/skills/realtimex-heartbeat/SKILL.md +85 -0
- package/skills/realtimex-heartbeat/templates/HEARTBEAT.template.md +99 -0
- package/skills/realtimex-local-apps/SKILL.md +93 -0
- package/skills/realtimex-moderator-sdk/SKILL.md +29 -575
- package/skills/realtimex-plugin-and-skill/SKILL.md +105 -0
- package/skills/realtimex-terminal-agents/SKILL.md +89 -0
- package/skills/realtimex-webhooks/SKILL.md +77 -0
- package/skills/realtimex-workspaces/SKILL.md +117 -0
- package/skills/realtimex-workspaces/templates/AGENTS.template.md +49 -0
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: realtimex-moderator-sdk
|
|
3
|
-
description: "
|
|
4
|
-
author: ""
|
|
5
|
-
license: "Apache-2.0"
|
|
6
|
-
argument-hint: "<command> [args] | install cli"
|
|
3
|
+
description: "Route RealTimeX API work to the focused workspace, terminal-agent, browser-session, local-app, heartbeat, automation-flow, artifact, channel, webhook, or plugin-and-skill capability. Use when a request spans capabilities or the correct RealTimeX skill is unclear."
|
|
7
4
|
allowed-tools: "Read Bash"
|
|
8
5
|
metadata:
|
|
9
6
|
openclaw:
|
|
@@ -12,593 +9,50 @@ metadata:
|
|
|
12
9
|
- realtimex-pp-cli
|
|
13
10
|
---
|
|
14
11
|
|
|
15
|
-
#
|
|
12
|
+
# RealTimeX Moderator SDK Router
|
|
16
13
|
|
|
17
|
-
|
|
14
|
+
Use this router to select the smallest RealTimeX skill that owns the requested operation. Load more than one focused skill only when the request crosses domains.
|
|
18
15
|
|
|
19
|
-
|
|
16
|
+
## CLI setup
|
|
20
17
|
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
npm install -g @realtimex/pp-cli@2.0.32
|
|
24
|
-
```
|
|
25
|
-
2. Verify the exact version:
|
|
26
|
-
```bash
|
|
27
|
-
realtimex-pp-cli --version
|
|
28
|
-
```
|
|
29
|
-
The output must be `realtimex-pp-cli 2.0.32`.
|
|
30
|
-
|
|
31
|
-
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.32`, reinstall with the pinned npm command above. Do not proceed with skill commands until exact-version verification succeeds.
|
|
32
|
-
|
|
33
|
-
* Always run first:
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
realtimex-pp-cli prepare --agent
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Command Reference
|
|
40
|
-
|
|
41
|
-
**approve-channel-pairing-code** — Manage approve channel pairing code
|
|
42
|
-
|
|
43
|
-
- `realtimex-pp-cli approve-channel-pairing-code <code>` — Approve one pending channel pairing code by visible 6-digit code or database id.
|
|
44
|
-
|
|
45
|
-
**chat-with-terminal-agent** — Manage chat with terminal agent
|
|
46
|
-
|
|
47
|
-
- `realtimex-pp-cli chat-with-terminal-agent` — Guide a user through sending a chat message to the terminal agent.
|
|
48
|
-
|
|
49
|
-
**clear-workspace-default-agent** — Manage clear workspace default agent
|
|
50
|
-
|
|
51
|
-
- `realtimex-pp-cli clear-workspace-default-agent <workspaceSlug>` — Clear the default CLI agent from a workspace.
|
|
52
|
-
|
|
53
|
-
**configure-plugin** — Manage configure plugin
|
|
54
|
-
|
|
55
|
-
- `realtimex-pp-cli configure-plugin <pluginId>` — Set non-secret configuration values for one installed plugin. Use a plugin id, name, or displayName from list-plugins.
|
|
56
|
-
|
|
57
|
-
**create-browser-session** — Manage create browser session
|
|
58
|
-
|
|
59
|
-
- `realtimex-pp-cli create-browser-session` — Create an isolated named RealTimeX Browser session. When url is supplied, start the session and open that URL.
|
|
60
|
-
|
|
61
|
-
**create-channel** — Manage create channel
|
|
62
|
-
|
|
63
|
-
- `realtimex-pp-cli create-channel <workspaceSlug>` — Create a chat channel in one exact workspace. Defaults to Telegram when plugin_type, channelType, and type are omitted.
|
|
64
|
-
|
|
65
|
-
**create-thread** — Manage create thread
|
|
66
|
-
|
|
67
|
-
- `realtimex-pp-cli create-thread <workspaceSlug>` — Create a thread in one workspace. The name is optional but recommended.
|
|
68
|
-
|
|
69
|
-
**create-webhook-endpoint** — Manage create webhook endpoint
|
|
70
|
-
|
|
71
|
-
- `realtimex-pp-cli create-webhook-endpoint` — Create a webhook endpoint in an accessible workspace. secret is a write-only input.
|
|
72
|
-
|
|
73
|
-
**create-workspace** — Manage create workspace
|
|
74
|
-
|
|
75
|
-
- `realtimex-pp-cli create-workspace` — Create a workspace. Requires a human-readable workspace name.
|
|
76
|
-
|
|
77
|
-
**create-workspace-agent-skill** — Manage create workspace agent skill
|
|
78
|
-
|
|
79
|
-
- `realtimex-pp-cli create-workspace-agent-skill <workspaceSlug>` — Create a managed agent skill owned by one workspace.
|
|
80
|
-
|
|
81
|
-
**delete-browser-session** — Manage delete browser session
|
|
82
|
-
|
|
83
|
-
- `realtimex-pp-cli delete-browser-session <sessionName>` — Delete a stopped named RealTimeX Browser session and its isolated profile.
|
|
84
|
-
|
|
85
|
-
**delete-channel** — Manage delete channel
|
|
86
|
-
|
|
87
|
-
- `realtimex-pp-cli delete-channel <channelId>` — Delete one chat channel by exact channel id.
|
|
88
|
-
|
|
89
|
-
**delete-thread** — Manage delete thread
|
|
90
|
-
|
|
91
|
-
- `realtimex-pp-cli delete-thread <workspaceSlug> <threadSlug>` — Delete one thread by exact workspace slug and exact thread slug.
|
|
92
|
-
|
|
93
|
-
**delete-webhook-endpoint** — Manage delete webhook endpoint
|
|
94
|
-
|
|
95
|
-
- `realtimex-pp-cli delete-webhook-endpoint <endpointId>` — Permanently delete a visible webhook endpoint. confirmDestructive must be true.
|
|
96
|
-
|
|
97
|
-
**delete-workspace** — Manage delete workspace
|
|
98
|
-
|
|
99
|
-
- `realtimex-pp-cli delete-workspace <workspaceSlug>` — Delete one workspace by exact workspace slug.
|
|
100
|
-
|
|
101
|
-
**disable-plugin** — Manage disable plugin
|
|
102
|
-
|
|
103
|
-
- `realtimex-pp-cli disable-plugin <pluginId>` — Disable one installed plugin globally and unload it from runtime.
|
|
104
|
-
|
|
105
|
-
**disable-workspace-agent-skill** — Manage disable workspace agent skill
|
|
106
|
-
|
|
107
|
-
- `realtimex-pp-cli disable-workspace-agent-skill <workspaceSlug> <skillId>` — Disable one agent skill in a workspace. Use a skill id, name, or displayName from list-workspace-agent-skills.
|
|
108
|
-
|
|
109
|
-
**enable-plugin** — Manage enable plugin
|
|
110
|
-
|
|
111
|
-
- `realtimex-pp-cli enable-plugin <pluginId>` — Enable one installed plugin globally and load it into runtime. Use a plugin id, name, or displayName from list-plugins.
|
|
112
|
-
|
|
113
|
-
**enable-workspace-agent-skill** — Manage enable workspace agent skill
|
|
114
|
-
|
|
115
|
-
- `realtimex-pp-cli enable-workspace-agent-skill <workspaceSlug> <skillId>` — Enable one agent skill in a workspace. Use a skill id, name, or displayName from list-workspace-agent-skills.
|
|
116
|
-
|
|
117
|
-
**get-artifact** — Manage get artifact
|
|
118
|
-
|
|
119
|
-
- `realtimex-pp-cli get-artifact <artifactId>` — Get one public artifact by artifact id.
|
|
120
|
-
|
|
121
|
-
**get-plugin** — Manage get plugin
|
|
122
|
-
|
|
123
|
-
- `realtimex-pp-cli get-plugin <pluginId>` — Get one installed plugin with its config schema (keys, labels, types, defaults)
|
|
124
|
-
|
|
125
|
-
**get-terminal-session-context** — Manage get terminal session context
|
|
126
|
-
|
|
127
|
-
- `realtimex-pp-cli get-terminal-session-context <sessionId>` — Read a bounded, sanitized tail of the PTY output for one exact live terminal runtime session.
|
|
128
|
-
|
|
129
|
-
**get-thread** — Manage get thread
|
|
130
|
-
|
|
131
|
-
- `realtimex-pp-cli get-thread <workspaceSlug> <threadSlug>` — Get one thread by exact workspace slug and exact thread slug.
|
|
132
|
-
|
|
133
|
-
**get-webhook-endpoint** — Manage get webhook endpoint
|
|
134
|
-
|
|
135
|
-
- `realtimex-pp-cli get-webhook-endpoint <endpointId>` — Get one visible webhook endpoint by endpoint id. The response reports secretConfigured but never returns the secret.
|
|
136
|
-
|
|
137
|
-
**get-workspace** — Manage get workspace
|
|
138
|
-
|
|
139
|
-
- `realtimex-pp-cli get-workspace <workspaceSlug>` — Get one workspace by exact workspace slug.
|
|
140
|
-
|
|
141
|
-
**goal-kickoff-composer** — Manage goal kickoff composer
|
|
142
|
-
|
|
143
|
-
- `realtimex-pp-cli goal-kickoff-composer` — Verify the shared Project/global Goal kickoff composer, routing, attachment authorization, retry, preview
|
|
144
|
-
|
|
145
|
-
**install-plugin** — Manage install plugin
|
|
146
|
-
|
|
147
|
-
- `realtimex-pp-cli install-plugin` — Install a plugin from a local source directory on the same machine as the server.
|
|
148
|
-
|
|
149
|
-
**list-agent-skills** — Manage list agent skills
|
|
150
|
-
|
|
151
|
-
- `realtimex-pp-cli list-agent-skills` — List published agent skills. Use list-workspace-agent-skills to see enabled/disabled state for one workspace.
|
|
152
|
-
|
|
153
|
-
**list-artifacts** — Manage list artifacts
|
|
154
|
-
|
|
155
|
-
- `realtimex-pp-cli list-artifacts <workspaceSlug>` — List public artifacts for one exact workspace slug. Revoked artifacts are hidden unless includeRevoked=true is passed.
|
|
156
|
-
|
|
157
|
-
**list-browser-sessions** — Manage list browser sessions
|
|
158
|
-
|
|
159
|
-
- `realtimex-pp-cli list-browser-sessions` — List registered RealTimeX Browser sessions and their live runtime state.
|
|
160
|
-
|
|
161
|
-
**list-channels** — Manage list channels
|
|
162
|
-
|
|
163
|
-
- `realtimex-pp-cli list-channels` — List configured chat channels. Use returned channel ids with update-channel.
|
|
164
|
-
|
|
165
|
-
**list-llm-models** — Manage list llm models
|
|
166
|
-
|
|
167
|
-
- `realtimex-pp-cli list-llm-models <provider>` — List models for one provider id.
|
|
168
|
-
|
|
169
|
-
**list-llm-providers** — Manage list llm providers
|
|
170
|
-
|
|
171
|
-
- `realtimex-pp-cli list-llm-providers` — List supported LLM providers. Use provider ids from this response when configuring workspace or thread LLM settings.
|
|
172
|
-
|
|
173
|
-
**list-plugins** — Manage list plugins
|
|
174
|
-
|
|
175
|
-
- `realtimex-pp-cli list-plugins` — List installed plugins with enabled state and runtime load status.
|
|
176
|
-
|
|
177
|
-
**list-terminal-agents** — Manage list terminal agents
|
|
178
|
-
|
|
179
|
-
- `realtimex-pp-cli list-terminal-agents` — List terminal CLI agents that can be used with open-terminal-session.
|
|
180
|
-
|
|
181
|
-
**list-terminal-sessions** — Manage list terminal sessions
|
|
182
|
-
|
|
183
|
-
- `realtimex-pp-cli list-terminal-sessions` — List terminal runtime sessions known to the desktop app. Optionally filter by workspaceSlug and threadSlug.
|
|
184
|
-
|
|
185
|
-
**list-threads** — Manage list threads
|
|
186
|
-
|
|
187
|
-
- `realtimex-pp-cli list-threads <workspaceSlug>` — List threads for one exact workspace slug.
|
|
188
|
-
|
|
189
|
-
**list-webhook-deliveries** — Manage list webhook deliveries
|
|
190
|
-
|
|
191
|
-
- `realtimex-pp-cli list-webhook-deliveries` — List bounded delivery metadata for visible webhook endpoints.
|
|
192
|
-
|
|
193
|
-
**list-webhook-endpoints** — Manage list webhook endpoints
|
|
194
|
-
|
|
195
|
-
- `realtimex-pp-cli list-webhook-endpoints` — List webhook endpoints visible to the authenticated user. Secrets are never returned.
|
|
196
|
-
|
|
197
|
-
**list-workspace-agent-skills** — Manage list workspace agent skills
|
|
198
|
-
|
|
199
|
-
- `realtimex-pp-cli list-workspace-agent-skills <workspaceSlug>` — List published agent skills with enabled/disabled state for one exact workspace slug.
|
|
200
|
-
|
|
201
|
-
**list-workspaces** — Manage list workspaces
|
|
202
|
-
|
|
203
|
-
- `realtimex-pp-cli list-workspaces` — List all workspaces visible to the current API caller. Use this before choosing a workspace slug.
|
|
204
|
-
|
|
205
|
-
**open-terminal-session** — Manage open terminal session
|
|
206
|
-
|
|
207
|
-
- `realtimex-pp-cli open-terminal-session` — Open a new desktop terminal session for one terminal CLI agent. Use list-terminal-agents or prepare.
|
|
208
|
-
|
|
209
|
-
**pause-artifact** — Manage pause artifact
|
|
210
|
-
|
|
211
|
-
- `realtimex-pp-cli pause-artifact <artifactId>` — Pause one published artifact by artifact id. Paused artifacts remain listed but stop serving publicly.
|
|
212
|
-
|
|
213
|
-
**prepare** — Manage prepare
|
|
214
|
-
|
|
215
|
-
- `realtimex-pp-cli prepare` — Return compact workspace, thread, current workspace/thread, LLM provider, model
|
|
216
|
-
|
|
217
|
-
**promote-workspace-agent-skill** — Manage promote workspace agent skill
|
|
218
|
-
|
|
219
|
-
- `realtimex-pp-cli promote-workspace-agent-skill <workspaceSlug> <skillId>` — Promote one workspace-owned agent skill to a global managed skill by copying its files into a new global skill row.
|
|
220
|
-
|
|
221
|
-
**publish-artifact** — Manage publish artifact
|
|
222
|
-
|
|
223
|
-
- `realtimex-pp-cli publish-artifact <workspaceSlug>` — Publish a browser-viewable file or folder under a workspace artifacts directory.
|
|
224
|
-
|
|
225
|
-
**reload-agent-skills** — Manage reload agent skills
|
|
226
|
-
|
|
227
|
-
- `realtimex-pp-cli reload-agent-skills` — Force reload all enabled agent skills into one workspace working directory.
|
|
228
|
-
|
|
229
|
-
**reload-plugin** — Manage reload plugin
|
|
230
|
-
|
|
231
|
-
- `realtimex-pp-cli reload-plugin <pluginId>` — Reload one enabled plugin in runtime. Disabled plugins must be enabled before reload.
|
|
232
|
-
|
|
233
|
-
**rename-thread** — Manage rename thread
|
|
234
|
-
|
|
235
|
-
- `realtimex-pp-cli rename-thread <workspaceSlug> <threadSlug>` — Rename one thread by exact workspace slug and exact thread slug. Only the name is changed.
|
|
236
|
-
|
|
237
|
-
**rename-workspace** — Manage rename workspace
|
|
238
|
-
|
|
239
|
-
- `realtimex-pp-cli rename-workspace <workspaceSlug>` — Rename one workspace by exact workspace slug. Only the name is changed.
|
|
240
|
-
|
|
241
|
-
**respond-terminal-idle-prompt** — Manage respond terminal idle prompt
|
|
242
|
-
|
|
243
|
-
- `realtimex-pp-cli respond-terminal-idle-prompt <sessionId>` — Send one constrained response action to an exact idle terminal session only when its PTY event sequence is unchanged.
|
|
244
|
-
|
|
245
|
-
**resume-artifact** — Manage resume artifact
|
|
246
|
-
|
|
247
|
-
- `realtimex-pp-cli resume-artifact <artifactId>` — Resume one paused artifact by artifact id.
|
|
248
|
-
|
|
249
|
-
**resume-latest-terminal-session** — Manage resume latest terminal session
|
|
250
|
-
|
|
251
|
-
- `realtimex-pp-cli resume-latest-terminal-session` — Resume the latest terminal runtime session for one exact thread.
|
|
252
|
-
|
|
253
|
-
**resume-terminal-session** — Manage resume terminal session
|
|
254
|
-
|
|
255
|
-
- `realtimex-pp-cli resume-terminal-session <sessionId>` — Resume a terminal runtime session by attaching a CLI controller.
|
|
256
|
-
|
|
257
|
-
**revoke-artifact** — Manage revoke artifact
|
|
258
|
-
|
|
259
|
-
- `realtimex-pp-cli revoke-artifact <artifactId>` — Revoke one artifact by artifact id.
|
|
260
|
-
|
|
261
|
-
**run-automation-workflow** — Manage run automation workflow
|
|
262
|
-
|
|
263
|
-
- `realtimex-pp-cli run-automation-workflow` — Run any app automation flow or scenario exposed via flowMetadata.cli.enabled=true by passing workflowName.
|
|
264
|
-
|
|
265
|
-
**send-channel-file** — Manage send channel file
|
|
266
|
-
|
|
267
|
-
- `realtimex-pp-cli send-channel-file` — Send one local CLI file back to an external channel using an explicit channel delivery context id.
|
|
268
|
-
|
|
269
|
-
**send-message** — Manage send message
|
|
270
|
-
|
|
271
|
-
- `realtimex-pp-cli send-message <workspaceSlug> <threadSlug>` — Send one message to an exact thread using the same routing as channel replies.
|
|
272
|
-
|
|
273
|
-
**send-terminal-session-message** — Manage send terminal session message
|
|
274
|
-
|
|
275
|
-
- `realtimex-pp-cli send-terminal-session-message <sessionId>` — Send one message directly to an exact live terminal session.
|
|
276
|
-
|
|
277
|
-
**set-default-workspace-agent** — Manage set default workspace agent
|
|
278
|
-
|
|
279
|
-
- `realtimex-pp-cli set-default-workspace-agent` — Set a workspace default agent from the desktop workspace chat settings UI.
|
|
280
|
-
|
|
281
|
-
**set-heartbeat-active-hours** — Manage set heartbeat active hours
|
|
282
|
-
|
|
283
|
-
- `realtimex-pp-cli set-heartbeat-active-hours` — Set workspace or global ambient-agent active hours using HH:mm start and end values.
|
|
284
|
-
|
|
285
|
-
**set-heartbeat-auto-pilot** — Manage set heartbeat auto pilot
|
|
286
|
-
|
|
287
|
-
- `realtimex-pp-cli set-heartbeat-auto-pilot` — Turn workspace or global ambient-agent heartbeat auto pilot on or off.
|
|
288
|
-
|
|
289
|
-
**set-heartbeat-default-agent** — Manage set heartbeat default agent
|
|
290
|
-
|
|
291
|
-
- `realtimex-pp-cli set-heartbeat-default-agent` — Set workspace or global ambient-agent default terminal agent and optional model for heartbeat defaults and legacy
|
|
292
|
-
|
|
293
|
-
**set-heartbeat-enabled** — Manage set heartbeat enabled
|
|
294
|
-
|
|
295
|
-
- `realtimex-pp-cli set-heartbeat-enabled` — Turn workspace or global ambient-agent heartbeat on or off.
|
|
296
|
-
|
|
297
|
-
**set-heartbeat-interval** — Manage set heartbeat interval
|
|
298
|
-
|
|
299
|
-
- `realtimex-pp-cli set-heartbeat-interval` — Set workspace or global ambient-agent scheduler check interval.
|
|
300
|
-
|
|
301
|
-
**set-heartbeat-timezone** — Manage set heartbeat timezone
|
|
302
|
-
|
|
303
|
-
- `realtimex-pp-cli set-heartbeat-timezone` — Set workspace or global ambient-agent heartbeat timezone, for example Asia/Saigon or UTC.
|
|
304
|
-
|
|
305
|
-
**set-workspace-default-agent** — Manage set workspace default agent
|
|
306
|
-
|
|
307
|
-
- `realtimex-pp-cli set-workspace-default-agent <workspaceSlug>` — Set the default CLI agent for a workspace.
|
|
308
|
-
|
|
309
|
-
**setup-heartbeat-tasks** — Manage setup heartbeat tasks
|
|
310
|
-
|
|
311
|
-
- `realtimex-pp-cli setup-heartbeat-tasks` — Set up HEARTBEAT.md task instructions for a workspace or global ambient agent.
|
|
312
|
-
|
|
313
|
-
**setup-personality** — Manage setup personality
|
|
314
|
-
|
|
315
|
-
- `realtimex-pp-cli setup-personality` — Set up AGENTS.md and CLAUDE.md personality files for a workspace or global ambient agent.
|
|
316
|
-
|
|
317
|
-
**setup-working-dir** — Manage setup working dir
|
|
318
|
-
|
|
319
|
-
- `realtimex-pp-cli setup-working-dir` — Add or edit an agent working directory from the desktop settings UI.
|
|
320
|
-
|
|
321
|
-
**start-browser-session** — Manage start browser session
|
|
322
|
-
|
|
323
|
-
- `realtimex-pp-cli start-browser-session <sessionName>` — Start an existing named RealTimeX Browser session, optionally opening an absolute HTTP or HTTPS URL.
|
|
324
|
-
|
|
325
|
-
**start-channel** — Manage start channel
|
|
326
|
-
|
|
327
|
-
- `realtimex-pp-cli start-channel <channelId>` — Start one chat channel by exact channel id.
|
|
328
|
-
|
|
329
|
-
**stop-browser-session** — Manage stop browser session
|
|
330
|
-
|
|
331
|
-
- `realtimex-pp-cli stop-browser-session <sessionName>` — Gracefully stop an existing named RealTimeX Browser session.
|
|
332
|
-
|
|
333
|
-
**stop-channel** — Manage stop channel
|
|
334
|
-
|
|
335
|
-
- `realtimex-pp-cli stop-channel <channelId>` — Stop one chat channel by exact channel id.
|
|
336
|
-
|
|
337
|
-
**stop-thread-terminal-session** — Manage stop thread terminal session
|
|
338
|
-
|
|
339
|
-
- `realtimex-pp-cli stop-thread-terminal-session` — Interrupt the selected or current chat-linked terminal session for one exact thread without closing the underlying
|
|
340
|
-
|
|
341
|
-
**terminate-terminal-session** — Manage terminate terminal session
|
|
342
|
-
|
|
343
|
-
- `realtimex-pp-cli terminate-terminal-session <sessionId>` — Terminate a terminal runtime session by detaching any controller and closing the underlying PTY session.
|
|
344
|
-
|
|
345
|
-
**test-webhook-endpoint** — Manage test webhook endpoint
|
|
346
|
-
|
|
347
|
-
- `realtimex-pp-cli test-webhook-endpoint <endpointId>` — Submit an optional JSON payload as a signed test delivery through a visible webhook endpoint.
|
|
348
|
-
|
|
349
|
-
**trigger-workspace-heartbeat** — Manage trigger workspace heartbeat
|
|
350
|
-
|
|
351
|
-
- `realtimex-pp-cli trigger-workspace-heartbeat <workspaceSlug>` — Trigger the default HEARTBEAT.md task for a workspace immediately.
|
|
352
|
-
|
|
353
|
-
**trigger-workspace-heartbeat-tasks** — Manage trigger workspace heartbeat tasks
|
|
354
|
-
|
|
355
|
-
- `realtimex-pp-cli trigger-workspace-heartbeat-tasks <workspaceSlug>` — Trigger specified HEARTBEAT.md task names for a workspace immediately.
|
|
356
|
-
|
|
357
|
-
**update-channel** — Manage update channel
|
|
358
|
-
|
|
359
|
-
- `realtimex-pp-cli update-channel <channelId>` — Update one chat channel by exact channel id. Only channel writable fields are changed.
|
|
360
|
-
|
|
361
|
-
**update-webhook-endpoint** — Manage update webhook endpoint
|
|
362
|
-
|
|
363
|
-
- `realtimex-pp-cli update-webhook-endpoint <endpointId>` — Update a visible webhook endpoint. Passing secret rotates it; the value is never returned.
|
|
364
|
-
|
|
365
|
-
**workspace-shell-layout** — Manage workspace shell layout
|
|
366
|
-
|
|
367
|
-
- `realtimex-pp-cli workspace-shell-layout` — Verify workspace navigation, title-bar containment, Files dock behavior
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
### Finding the right command
|
|
371
|
-
|
|
372
|
-
When you know what you want to do but not which command does it, ask the CLI directly:
|
|
18
|
+
This skill uses `realtimex-pp-cli` version 2.0.34. Before using its commands:
|
|
373
19
|
|
|
374
20
|
```bash
|
|
375
|
-
realtimex-pp-cli
|
|
21
|
+
realtimex-pp-cli --version
|
|
376
22
|
```
|
|
377
23
|
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
## Auth Setup
|
|
381
|
-
Run `realtimex-pp-cli auth setup` to print the URL and steps for getting a key (add `--launch` to open the URL). Then set:
|
|
24
|
+
If it is missing or does not report `realtimex-pp-cli 2.0.34`, install the pinned version:
|
|
382
25
|
|
|
383
26
|
```bash
|
|
384
|
-
|
|
27
|
+
npm install -g @realtimex/pp-cli@2.0.34
|
|
385
28
|
```
|
|
386
29
|
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
Run `realtimex-pp-cli doctor` to verify setup.
|
|
390
|
-
|
|
391
|
-
## Agent Mode
|
|
392
|
-
|
|
393
|
-
Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color --yes`.
|
|
394
|
-
|
|
395
|
-
- **Pipeable** — JSON on stdout, errors on stderr
|
|
396
|
-
- **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:
|
|
397
|
-
|
|
398
|
-
```bash
|
|
399
|
-
realtimex-pp-cli approve-channel-pairing-code mock-value --agent --select id,name,status
|
|
400
|
-
```
|
|
401
|
-
- **Previewable** — `--dry-run` shows the request without sending
|
|
402
|
-
- **Offline-friendly** — sync/search commands can use the local SQLite store when available
|
|
403
|
-
- **Non-interactive** — never prompts, every input is a flag
|
|
404
|
-
- **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
|
|
405
|
-
|
|
406
|
-
### Response envelope
|
|
407
|
-
|
|
408
|
-
Commands that read from the local store or the API wrap output in a provenance envelope:
|
|
409
|
-
|
|
410
|
-
```json
|
|
411
|
-
{
|
|
412
|
-
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
|
|
413
|
-
"results": <data>
|
|
414
|
-
}
|
|
415
|
-
```
|
|
416
|
-
|
|
417
|
-
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.
|
|
418
|
-
|
|
419
|
-
## Agent Feedback
|
|
420
|
-
|
|
421
|
-
When you (or the agent) notice something off about this CLI, record it:
|
|
422
|
-
|
|
423
|
-
```
|
|
424
|
-
realtimex-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
|
|
425
|
-
realtimex-pp-cli feedback --stdin < notes.txt
|
|
426
|
-
realtimex-pp-cli feedback list --json --limit 10
|
|
427
|
-
```
|
|
428
|
-
|
|
429
|
-
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.
|
|
430
|
-
|
|
431
|
-
Write what *surprised* you, not a bug report. Short, specific, one line: that is the part that compounds.
|
|
432
|
-
|
|
433
|
-
## Output Delivery
|
|
434
|
-
|
|
435
|
-
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:
|
|
436
|
-
|
|
437
|
-
| Sink | Effect |
|
|
438
|
-
|------|--------|
|
|
439
|
-
| `stdout` | Default; write to stdout only |
|
|
440
|
-
| `file:<path>` | Atomically write output to `<path>` (tmp + rename) |
|
|
441
|
-
| `webhook:<url>` | POST the output body to the URL (`application/json` or `application/x-ndjson` when `--compact`) |
|
|
442
|
-
|
|
443
|
-
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.
|
|
444
|
-
|
|
445
|
-
## Named Profiles
|
|
446
|
-
|
|
447
|
-
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.
|
|
448
|
-
|
|
449
|
-
```
|
|
450
|
-
realtimex-pp-cli profile save briefing --json
|
|
451
|
-
realtimex-pp-cli --profile briefing approve-channel-pairing-code mock-value
|
|
452
|
-
realtimex-pp-cli profile list --json
|
|
453
|
-
realtimex-pp-cli profile show briefing
|
|
454
|
-
realtimex-pp-cli profile delete briefing --yes
|
|
455
|
-
```
|
|
456
|
-
|
|
457
|
-
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.
|
|
458
|
-
|
|
459
|
-
## Exit Codes
|
|
460
|
-
|
|
461
|
-
| Code | Meaning |
|
|
462
|
-
|------|---------|
|
|
463
|
-
| 0 | Success |
|
|
464
|
-
| 2 | Usage error (wrong arguments) |
|
|
465
|
-
| 3 | Resource not found |
|
|
466
|
-
| 4 | Authentication required |
|
|
467
|
-
| 5 | API error (upstream issue) |
|
|
468
|
-
| 7 | Rate limited (wait and retry) |
|
|
469
|
-
| 10 | Config error |
|
|
470
|
-
|
|
471
|
-
## Argument Parsing
|
|
472
|
-
|
|
473
|
-
Parse `$ARGUMENTS`:
|
|
474
|
-
|
|
475
|
-
1. **Empty, `help`, or `--help`** → show `realtimex-pp-cli --help` output
|
|
476
|
-
2. **Starts with `install`** → ends with `mcp` → MCP installation; otherwise → see Prerequisites above
|
|
477
|
-
3. **Anything else** → Direct Use (execute as CLI command with `--agent`)
|
|
478
|
-
|
|
479
|
-
## MCP Server Installation
|
|
480
|
-
|
|
481
|
-
Install the MCP binary from this CLI's published public-library entry or pre-built release, then register it:
|
|
30
|
+
For requests about the current workspace or thread, resolve context first:
|
|
482
31
|
|
|
483
32
|
```bash
|
|
484
|
-
|
|
33
|
+
realtimex-pp-cli prepare --agent
|
|
485
34
|
```
|
|
486
35
|
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
## Direct Use
|
|
490
|
-
|
|
491
|
-
1. Check whether the CLI is installed and version-matched:
|
|
492
|
-
```bash
|
|
493
|
-
realtimex-pp-cli --version
|
|
494
|
-
```
|
|
495
|
-
If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.32`, reinstall the pinned version:
|
|
496
|
-
```bash
|
|
497
|
-
npm install -g @realtimex/pp-cli@2.0.32
|
|
498
|
-
```
|
|
499
|
-
Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
|
|
500
|
-
2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
|
|
501
|
-
3. Execute with the `--agent` flag:
|
|
502
|
-
```bash
|
|
503
|
-
realtimex-pp-cli <command> [subcommand] [args] --agent
|
|
504
|
-
```
|
|
505
|
-
4. If ambiguous, drill into subcommand help: `realtimex-pp-cli <command> --help`.
|
|
506
|
-
|
|
507
|
-
## Constraints
|
|
508
|
-
|
|
509
|
-
This skill intentionally exposes a small action-first command set. Prefer these generated commands over older nested resource commands.
|
|
510
|
-
|
|
511
|
-
* Use only documented `realtimex-pp-cli` commands.
|
|
512
|
-
* Never call the RealTimeX API directly with `curl`, `fetch`, raw HTTP clients, or custom scripts.
|
|
513
|
-
* If the current CLI cannot do the requested task, say the feature is not available and will be added soon.
|
|
514
|
-
* Use `--agent` on every command.
|
|
515
|
-
* In a managed RealtimeX terminal, let `prepare` resolve the current workspace and thread from authenticated terminal-session context. Do not require or forward workspace/thread environment variables to `prepare`.
|
|
516
|
-
* Treat `prepare` as the resolved source of truth for requests that refer to "current workspace", "this workspace", "current thread", or "this thread".
|
|
517
|
-
* `RTX_AGENT_CONTEXT_JSON` and the legacy `$RTX_WORKSPACE_SLUG` and `$RTX_THREAD_SLUG` aliases may be present for runtime compatibility, but do not block on inspecting them or manually pass them to `prepare`.
|
|
518
|
-
* Call the following whenever you need the resolved current workspace/thread objects or related context:
|
|
519
|
-
|
|
520
|
-
```bash
|
|
521
|
-
realtimex-pp-cli prepare --agent
|
|
522
|
-
```
|
|
523
|
-
|
|
524
|
-
* For callers outside a managed RealtimeX terminal, `prepare` still accepts explicit `--workspace-slug` and `--thread-slug` compatibility inputs.
|
|
525
|
-
* Ask for a missing workspace or thread only when `prepare` cannot resolve the required current context or when the user intends to target a different context.
|
|
526
|
-
* Always run first:
|
|
527
|
-
|
|
528
|
-
```bash
|
|
529
|
-
realtimex-pp-cli prepare --agent
|
|
530
|
-
```
|
|
531
|
-
|
|
532
|
-
* Use exact workspace slugs, thread slugs, provider ids, model ids, agent `canonical`, and agent `modelId` values from `prepare`.
|
|
533
|
-
* Do not guess workspace, thread, model, provider, agent, message, target, or option values.
|
|
534
|
-
* If required context is missing or ambiguous, ask a concise clarification question before running a command.
|
|
535
|
-
* Never assume a workspace or thread that the user has not referenced.
|
|
536
|
-
* 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.
|
|
537
|
-
* 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.
|
|
538
|
-
* 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.
|
|
539
|
-
* If multiple plausible matches exist, ask the user to choose.
|
|
540
|
-
|
|
541
|
-
For `send-message`:
|
|
542
|
-
|
|
543
|
-
* Require these values to be explicitly named or explicitly referenced in the current request:
|
|
544
|
-
* workspace
|
|
545
|
-
* thread
|
|
546
|
-
* message
|
|
547
|
-
* If any of those values are missing or ambiguous, ask for the missing values before running the command.
|
|
548
|
-
* Do not provide LLM provider/model arguments to `send-message`; the server routes the message based on the thread/workspace configuration.
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
For `send-channel-file`:
|
|
552
|
-
|
|
553
|
-
* Use this command only from a channel-linked terminal session that has `REALTIMEX_CHANNEL_DELIVERY_CONTEXT_ID` in its environment, or when the user explicitly provides a `chdel_*` context id.
|
|
554
|
-
* Always pass the context explicitly. In channel-linked sessions use `--context "$REALTIMEX_CHANNEL_DELIVERY_CONTEXT_ID"`; use a literal `chdel_*` only when intentionally overriding for debugging.
|
|
555
|
-
* Do not infer a destination from workspace, thread, recent activity, or channel metadata.
|
|
556
|
-
* Send one file per command call. Repeat the command for multiple files.
|
|
557
|
-
* In desktop/local runtime, the CLI should send the absolute local `filePath` to the server. The server validates the path against allowed storage/temp roots before sending through the channel. Base64 upload is fallback transport, not the preferred path.
|
|
558
|
-
* The server validates the delivery context, active channel session, plugin state, runtime binding when supplied, and file size/type handling before delivery.
|
|
559
|
-
|
|
560
|
-
For webhook endpoint management:
|
|
561
|
-
|
|
562
|
-
* These operations require an authenticated, user-bound session credential.
|
|
563
|
-
* Treat `secret` as write-only input for creation or rotation. Never expect, request, print, or persist a plaintext secret from endpoint responses.
|
|
564
|
-
* Use `list-webhook-deliveries` for bounded metadata inspection. Raw request headers, signatures, bodies, and normalized payload fields are intentionally unavailable.
|
|
565
|
-
* Pass `confirmDestructive=true` only after the user has explicitly requested permanent endpoint deletion.
|
|
566
|
-
|
|
567
|
-
For workspace default-agent setup:
|
|
568
|
-
|
|
569
|
-
* Use `prepare.agents` only.
|
|
570
|
-
* Use exact agent `canonical` and optional agent `modelId` values from `prepare.agents`.
|
|
571
|
-
* Never use `prepare.models` for workspace default-agent setup.
|
|
572
|
-
|
|
573
|
-
For terminal agents and terminal sessions:
|
|
574
|
-
|
|
575
|
-
* Use `list-terminal-agents` when you only need available terminal agents. Use `prepare` when you also need workspace/thread/provider/model context.
|
|
576
|
-
* Use `open-terminal-session` to open a new desktop terminal session for a terminal agent. It auto-attaches the CLI controller through the desktop runtime launch request.
|
|
577
|
-
* Use exact `agentName`, `providerId`, and `modelId` values from `list-terminal-agents` or `prepare.agents`.
|
|
578
|
-
* When opening a terminal session for the current thread, pass the exact current workspace and thread slugs returned by `prepare`.
|
|
579
|
-
* Use `list-terminal-sessions` to inspect grouped terminal sessions by `workspaceSlug` and `threadSlug`. Each session includes compact identity fields and `attached` status.
|
|
580
|
-
* Use `resume-terminal-session` or `resume-latest-terminal-session` to resume + attach an existing session. Use `terminate-terminal-session` to close + detach a session.
|
|
581
|
-
|
|
582
|
-
For agent skills:
|
|
583
|
-
|
|
584
|
-
* Use `list-workspace-agent-skills` before enabling, disabling, or reloading workspace skills.
|
|
585
|
-
* For `reload-agent-skills`, always pass a workspace slug.
|
|
586
|
-
* If the user asks to reload skills for the current workspace, pass the exact current workspace slug returned by `prepare`.
|
|
587
|
-
* After `reload-agent-skills` succeeds, reload your own skill context before relying on updated skill instructions.
|
|
588
|
-
|
|
589
|
-
For personality and heartbeat setup:
|
|
590
|
-
|
|
591
|
-
* Use `setup-personality` to get the target directory for workspace or global personality files.
|
|
592
|
-
* Start from `templates/AGENTS.template.md` when creating `AGENTS.md`.
|
|
593
|
-
* Make `CLAUDE.md` a symlink to `AGENTS.md`.
|
|
594
|
-
* Use `setup-heartbeat-tasks` to get the target `HEARTBEAT.md` path.
|
|
595
|
-
* Start from `templates/HEARTBEAT.template.md` when creating `HEARTBEAT.md`.
|
|
596
|
-
* Keep heartbeat instructions separate from personality files.
|
|
36
|
+
## Skill routing
|
|
597
37
|
|
|
598
|
-
|
|
38
|
+
| Skill | Use for |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| `realtimex-workspaces` | Manage RealTimeX workspaces, threads, messages, workspace personality, LLM configuration, and default agents. Use for workspace and conversation operations. |
|
|
41
|
+
| `realtimex-terminal-agents` | Manage RealTimeX terminal agents, terminal sessions, session messages, and idle prompts. Use for desktop terminal-agent runtime and terminal-session lifecycle work. |
|
|
42
|
+
| `realtimex-browser-sessions` | List, create, start, stop, and delete isolated RealTimeX browser sessions. Use for named browser runtime and profile lifecycle work. |
|
|
43
|
+
| `realtimex-local-apps` | Create, inspect, configure, start, stop, restart, and delete RealTimeX Local Apps. Use for local source, npx, uvx, webhook-trigger, status, log, and lifecycle operations. |
|
|
44
|
+
| `realtimex-heartbeat` | Configure RealTimeX heartbeat scheduling, agents, active hours, timezone, autopilot, and immediate workspace heartbeat runs. Use for recurring HEARTBEAT.md task execution. |
|
|
45
|
+
| `realtimex-automation-flows` | Run RealTimeX automation workflows and guided automation-flow commands, including working-directory setup and workspace layout. Use for explicit multi-step automation execution. |
|
|
46
|
+
| `realtimex-artifacts` | List, publish, inspect, pause, resume, and revoke RealTimeX workspace artifacts. Use for browser-viewable artifact publication and lifecycle management. |
|
|
47
|
+
| `realtimex-channels` | Create, configure, start, stop, and delete RealTimeX chat channels, approve pairing codes, and deliver channel files. Use for Telegram, Zalo, Discord, and other channel integrations. |
|
|
48
|
+
| `realtimex-webhooks` | Create, inspect, update, test, and delete RealTimeX public webhook endpoints and inspect bounded delivery metadata. Use for inbound public webhook trigger configuration. |
|
|
49
|
+
| `realtimex-plugin-and-skill` | Manage RealTimeX plugins and agent skills, including configuration, enablement, reload, installation, promotion, and workspace skill state. Use for plugin and skill administration. |
|
|
599
50
|
|
|
600
|
-
|
|
51
|
+
## Cross-domain requests
|
|
601
52
|
|
|
602
|
-
|
|
53
|
+
1. Resolve the current workspace or thread with `prepare --agent` when needed.
|
|
54
|
+
2. Execute read/discovery operations before dependent mutations.
|
|
55
|
+
3. Pass exact server-returned identifiers between focused skills.
|
|
56
|
+
4. Keep destructive actions explicit and confirm the target before execution.
|
|
603
57
|
|
|
604
|
-
|
|
58
|
+
The focused skills contain the command references and domain-specific safety rules. This router intentionally does not duplicate their full command inventory.
|