@realtimex/sdk 2.0.11 → 2.0.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,6 +1,6 @@
1
1
  {
2
2
  "name": "@realtimex/sdk",
3
- "version": "2.0.11",
3
+ "version": "2.0.13",
4
4
  "description": "SDK for building Local Apps that integrate with RealtimeX",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -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.11
23
+ npm install -g @realtimex/pp-cli@2.0.13
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.11`.
29
+ The output must be `realtimex-pp-cli 2.0.13`.
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.11`, reinstall with the pinned npm command above. Do not proceed with skill commands until exact-version verification succeeds.
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.13`, 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 main executor default terminal agent and optional model.
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 main executor interval.
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
 
@@ -218,6 +218,14 @@ If `--version` reports "command not found" after install, the npm global bin dir
218
218
 
219
219
  - `realtimex-pp-cli terminate-terminal-session <sessionId>` — Terminate a terminal runtime session by detaching any controller and closing the underlying PTY session.
220
220
 
221
+ **trigger-workspace-heartbeat** — Manage trigger workspace heartbeat
222
+
223
+ - `realtimex-pp-cli trigger-workspace-heartbeat <workspaceSlug>` — Trigger the default HEARTBEAT.md task for a workspace immediately.
224
+
225
+ **trigger-workspace-heartbeat-tasks** — Manage trigger workspace heartbeat tasks
226
+
227
+ - `realtimex-pp-cli trigger-workspace-heartbeat-tasks <workspaceSlug>` — Trigger specified HEARTBEAT.md task names for a workspace immediately.
228
+
221
229
  **update-channel** — Manage update channel
222
230
 
223
231
  - `realtimex-pp-cli update-channel <channelId>` — Update one chat channel by exact channel id. Only channel writable fields are changed.
@@ -348,9 +356,9 @@ Verify: `claude mcp list`
348
356
  ```bash
349
357
  realtimex-pp-cli --version
350
358
  ```
351
- If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.11`, reinstall the pinned version:
359
+ If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.13`, reinstall the pinned version:
352
360
  ```bash
353
- npm install -g @realtimex/pp-cli@2.0.11
361
+ npm install -g @realtimex/pp-cli@2.0.13
354
362
  ```
355
363
  Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
356
364
  2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
@@ -4,31 +4,69 @@
4
4
 
5
5
  Describe the ambient agent's standing responsibility.
6
6
 
7
- ## Scheduled tasks (optional)
7
+ ## Tasks
8
8
 
9
- Remove this section if you don't need recurring tasks.
10
- When present, the scheduler runs only tasks that are due on each tick.
11
- Tasks without an interval inherit the main check interval.
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
- Use `agent` to run a task with a specific terminal agent, for example `@codex-terminal`.
15
- Use `model` to run a task with a specific model, for example `gpt-5.5-medium`.
16
- Use `skills` to prefer skills for the task, for example `agent-browser, realtimex-moderator-sdk`.
17
- `agent`, `model`, `skills`, `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`.
21
+ When a shell command prints valid JSON, it can trigger additional tasks. Use one of these forms:
22
+
23
+ ```json
24
+ ["task-name-1", "task-name-2"]
25
+ ```
26
+
27
+ ```json
28
+ {
29
+ "tasks": ["task-name-1", "task-name-2"],
30
+ "reason": "metrics changed"
31
+ }
32
+ ```
33
+
34
+ To trigger tasks in another workspace, include `workspace`:
35
+
36
+ ```json
37
+ {
38
+ "workspace": "other-workspace-slug",
39
+ "tasks": ["task-name-1"],
40
+ "reason": "shared dependency changed"
41
+ }
42
+ ```
43
+
44
+ Only valid JSON triggers task dispatch. If the shell output is not valid JSON, no extra tasks are run.
18
45
 
19
46
  tasks:
20
47
 
21
- - name: example-task
48
+ - name: default-review
49
+ default: true
22
50
  interval: 30m
23
51
  agent: @codex-terminal
24
52
  model: gpt-5.5-medium
25
53
  skills: agent-browser, realtimex-moderator-sdk
26
- prompt: Describe what the agent should do for this task
54
+ prompt: Review the workspace context and respond HEARTBEAT_OK when no action is needed
27
55
  - name: weekday-morning-task
28
56
  cron: 0 9 * * 1-5
57
+ agent: @codex-terminal
29
58
  prompt: Describe what should run on a cron schedule
59
+ - name: sync-metrics
60
+ interval: 30m
61
+ executor: shell
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
30
67
  - name: another-task
31
- prompt: Tasks without interval run at the main check interval
68
+ agent: @codex-terminal
69
+ prompt: Tasks without interval or cron run on every scheduler check interval
32
70
 
33
71
  ## Check for
34
72