@realtimex/sdk 2.0.12 → 2.0.14
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,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: realtimex-moderator-sdk
|
|
3
|
-
description: "Use the RealTimeX API through the generated CLI for workspace, thread, terminal-agent sessions, channel (Telegram, Zalo, Discord), skills, plugins and send messages, setup personality, heartbeat tasks operations."
|
|
3
|
+
description: "Use the RealTimeX API through the generated CLI for workspace, thread, terminal-agent sessions, channel (Telegram, Zalo, Discord), skills, plugins and send messages, setup personality, heartbeat tasks operations, run tour guide to setup working dir."
|
|
4
4
|
author: ""
|
|
5
5
|
license: "Apache-2.0"
|
|
6
6
|
argument-hint: "<command> [args] | install cli"
|
|
@@ -20,15 +20,15 @@ This skill drives the `realtimex-pp-cli` binary. Verify the CLI is installed and
|
|
|
20
20
|
|
|
21
21
|
1. Install or reinstall the pinned version via npm:
|
|
22
22
|
```bash
|
|
23
|
-
npm install -g @realtimex/pp-cli@2.0.
|
|
23
|
+
npm install -g @realtimex/pp-cli@2.0.14
|
|
24
24
|
```
|
|
25
25
|
2. Verify the exact version:
|
|
26
26
|
```bash
|
|
27
27
|
realtimex-pp-cli --version
|
|
28
28
|
```
|
|
29
|
-
The output must be `realtimex-pp-cli 2.0.
|
|
29
|
+
The output must be `realtimex-pp-cli 2.0.14`.
|
|
30
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.
|
|
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.14`, reinstall with the pinned npm command above. Do not proceed with skill commands until exact-version verification succeeds.
|
|
32
32
|
|
|
33
33
|
* Always run first:
|
|
34
34
|
|
|
@@ -180,7 +180,7 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
180
180
|
|
|
181
181
|
**set-heartbeat-default-agent** — Manage set heartbeat default agent
|
|
182
182
|
|
|
183
|
-
- `realtimex-pp-cli set-heartbeat-default-agent` — Set workspace or global ambient-agent
|
|
183
|
+
- `realtimex-pp-cli set-heartbeat-default-agent` — Set workspace or global ambient-agent default terminal agent and optional model for heartbeat defaults and legacy
|
|
184
184
|
|
|
185
185
|
**set-heartbeat-enabled** — Manage set heartbeat enabled
|
|
186
186
|
|
|
@@ -188,7 +188,7 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
188
188
|
|
|
189
189
|
**set-heartbeat-interval** — Manage set heartbeat interval
|
|
190
190
|
|
|
191
|
-
- `realtimex-pp-cli set-heartbeat-interval` — Set workspace or global ambient-agent
|
|
191
|
+
- `realtimex-pp-cli set-heartbeat-interval` — Set workspace or global ambient-agent scheduler check interval.
|
|
192
192
|
|
|
193
193
|
**set-heartbeat-timezone** — Manage set heartbeat timezone
|
|
194
194
|
|
|
@@ -206,6 +206,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
206
206
|
|
|
207
207
|
- `realtimex-pp-cli setup-personality` — Set up AGENTS.md and CLAUDE.md personality files for a workspace or global ambient agent.
|
|
208
208
|
|
|
209
|
+
**setup-working-dir** — Manage setup working dir
|
|
210
|
+
|
|
211
|
+
- `realtimex-pp-cli setup-working-dir` — Add or edit an agent working directory from the desktop settings UI.
|
|
212
|
+
|
|
209
213
|
**start-channel** — Manage start channel
|
|
210
214
|
|
|
211
215
|
- `realtimex-pp-cli start-channel <channelId>` — Start one chat channel by exact channel id.
|
|
@@ -214,13 +218,17 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
214
218
|
|
|
215
219
|
- `realtimex-pp-cli stop-channel <channelId>` — Stop one chat channel by exact channel id.
|
|
216
220
|
|
|
221
|
+
**stop-thread-terminal-session** — Manage stop thread terminal session
|
|
222
|
+
|
|
223
|
+
- `realtimex-pp-cli stop-thread-terminal-session` — Interrupt the selected or current chat-linked terminal session for one exact thread without closing the underlying
|
|
224
|
+
|
|
217
225
|
**terminate-terminal-session** — Manage terminate terminal session
|
|
218
226
|
|
|
219
227
|
- `realtimex-pp-cli terminate-terminal-session <sessionId>` — Terminate a terminal runtime session by detaching any controller and closing the underlying PTY session.
|
|
220
228
|
|
|
221
229
|
**trigger-workspace-heartbeat** — Manage trigger workspace heartbeat
|
|
222
230
|
|
|
223
|
-
- `realtimex-pp-cli trigger-workspace-heartbeat <workspaceSlug>` — Trigger the
|
|
231
|
+
- `realtimex-pp-cli trigger-workspace-heartbeat <workspaceSlug>` — Trigger the default HEARTBEAT.md task for a workspace immediately.
|
|
224
232
|
|
|
225
233
|
**trigger-workspace-heartbeat-tasks** — Manage trigger workspace heartbeat tasks
|
|
226
234
|
|
|
@@ -230,6 +238,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
230
238
|
|
|
231
239
|
- `realtimex-pp-cli update-channel <channelId>` — Update one chat channel by exact channel id. Only channel writable fields are changed.
|
|
232
240
|
|
|
241
|
+
**workspace-message** — Manage workspace message
|
|
242
|
+
|
|
243
|
+
- `realtimex-pp-cli workspace-message` — Send a message in a workspace/thread through the desktop UI.
|
|
244
|
+
|
|
233
245
|
|
|
234
246
|
### Finding the right command
|
|
235
247
|
|
|
@@ -356,9 +368,9 @@ Verify: `claude mcp list`
|
|
|
356
368
|
```bash
|
|
357
369
|
realtimex-pp-cli --version
|
|
358
370
|
```
|
|
359
|
-
If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.
|
|
371
|
+
If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.14`, reinstall the pinned version:
|
|
360
372
|
```bash
|
|
361
|
-
npm install -g @realtimex/pp-cli@2.0.
|
|
373
|
+
npm install -g @realtimex/pp-cli@2.0.14
|
|
362
374
|
```
|
|
363
375
|
Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
|
|
364
376
|
2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
|
|
@@ -4,18 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Describe the ambient agent's standing responsibility.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Tasks
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
The scheduler evaluates this `tasks:` block on every heartbeat tick and runs only tasks that are due.
|
|
10
|
+
The first task is treated as the default task unless another task has `default: true`.
|
|
11
|
+
Use `default: true` on exactly one task to make it the default manual heartbeat target.
|
|
12
|
+
Use `default: false` on the first task if you do not want any task to be auto-selected as default.
|
|
12
13
|
Use `interval` for simple timing. Supported units are `m`, `h`, and `d`, for example `3m`, `1h`, or `1d`.
|
|
14
|
+
Omit `interval` and `cron` to run on every scheduler check interval.
|
|
15
|
+
Use `interval: disabled` to keep a task in the file but skip it during scheduled heartbeat checks. Manual triggers can still run the task.
|
|
13
16
|
Use `cron` for complex schedules, for example `0 9 * * *`.
|
|
14
|
-
|
|
15
|
-
Use `model` to run
|
|
16
|
-
Use `skills` to prefer skills for
|
|
17
|
-
Use `executor: shell` and `command` to run a shell command instead of an agent.
|
|
18
|
-
`agent`, `model`, `skills`, `executor`, `command`, `interval`, and `cron` are optional. If omitted, the task inherits from the main heartbeat executor.
|
|
17
|
+
Agent tasks require `agent`, for example `@codex-terminal`.
|
|
18
|
+
Use `model` to run an agent task with a specific model, for example `gpt-5.5-medium`.
|
|
19
|
+
Use `skills` to prefer skills for an agent task, for example `agent-browser, realtimex-moderator-sdk`.
|
|
20
|
+
Use `executor: shell` and `command` to run a shell command instead of an agent. Shell tasks do not use `prompt`.
|
|
19
21
|
When a shell command prints valid JSON, it can trigger additional tasks. Use one of these forms:
|
|
20
22
|
|
|
21
23
|
```json
|
|
@@ -43,21 +45,28 @@ Only valid JSON triggers task dispatch. If the shell output is not valid JSON, n
|
|
|
43
45
|
|
|
44
46
|
tasks:
|
|
45
47
|
|
|
46
|
-
- name:
|
|
48
|
+
- name: default-review
|
|
49
|
+
default: true
|
|
47
50
|
interval: 30m
|
|
48
51
|
agent: @codex-terminal
|
|
49
52
|
model: gpt-5.5-medium
|
|
50
53
|
skills: agent-browser, realtimex-moderator-sdk
|
|
51
|
-
prompt:
|
|
54
|
+
prompt: Review the workspace context and respond HEARTBEAT_OK when no action is needed
|
|
52
55
|
- name: weekday-morning-task
|
|
53
56
|
cron: 0 9 * * 1-5
|
|
57
|
+
agent: @codex-terminal
|
|
54
58
|
prompt: Describe what should run on a cron schedule
|
|
55
59
|
- name: sync-metrics
|
|
56
60
|
interval: 30m
|
|
57
61
|
executor: shell
|
|
58
62
|
command: bash ./scripts/sync-metrics.sh
|
|
63
|
+
- name: paused-task
|
|
64
|
+
interval: disabled
|
|
65
|
+
agent: @codex-terminal
|
|
66
|
+
prompt: This task is skipped by scheduled heartbeat checks until re-enabled
|
|
59
67
|
- name: another-task
|
|
60
|
-
|
|
68
|
+
agent: @codex-terminal
|
|
69
|
+
prompt: Tasks without interval or cron run on every scheduler check interval
|
|
61
70
|
|
|
62
71
|
## Check for
|
|
63
72
|
|