@realtimex/sdk 2.0.7 → 2.0.9

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.7",
3
+ "version": "2.0.9",
4
4
  "description": "SDK for building Local Apps that integrate with RealtimeX",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -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, channel (Telegram, Zalo, Discord) and chat operations."
3
+ description: "Use the RealTimeX API through the generated CLI for workspace, thread, channel (Telegram, Zalo, Discord), skills, plugins and send messages, setup personality, heartbeat tasks operations."
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.7
23
+ npm install -g @realtimex/pp-cli@2.0.9
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.7`.
29
+ The output must be `realtimex-pp-cli 2.0.9`.
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.7`, 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.9`, 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
 
@@ -70,6 +70,22 @@ If `--version` reports "command not found" after install, the npm global bin dir
70
70
 
71
71
  - `realtimex-pp-cli delete-workspace <workspaceSlug>` — Delete one workspace by exact workspace slug.
72
72
 
73
+ **disable-plugin** — Manage disable plugin
74
+
75
+ - `realtimex-pp-cli disable-plugin <pluginId>` — Disable one installed plugin globally and unload it from runtime.
76
+
77
+ **disable-workspace-agent-skill** — Manage disable workspace agent skill
78
+
79
+ - `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.
80
+
81
+ **enable-plugin** — Manage enable plugin
82
+
83
+ - `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.
84
+
85
+ **enable-workspace-agent-skill** — Manage enable workspace agent skill
86
+
87
+ - `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.
88
+
73
89
  **get-thread** — Manage get thread
74
90
 
75
91
  - `realtimex-pp-cli get-thread <workspaceSlug> <threadSlug>` — Get one thread by exact workspace slug and exact thread slug.
@@ -78,6 +94,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
78
94
 
79
95
  - `realtimex-pp-cli get-workspace <workspaceSlug>` — Get one workspace by exact workspace slug.
80
96
 
97
+ **list-agent-skills** — Manage list agent skills
98
+
99
+ - `realtimex-pp-cli list-agent-skills` — List published agent skills. Use list-workspace-agent-skills to see enabled/disabled state for one workspace.
100
+
81
101
  **list-channels** — Manage list channels
82
102
 
83
103
  - `realtimex-pp-cli list-channels` — List configured chat channels. Use returned channel ids with update-channel.
@@ -90,10 +110,18 @@ If `--version` reports "command not found" after install, the npm global bin dir
90
110
 
91
111
  - `realtimex-pp-cli list-llm-providers` — List supported LLM providers. Use provider ids from this response when configuring workspace or thread LLM settings.
92
112
 
113
+ **list-plugins** — Manage list plugins
114
+
115
+ - `realtimex-pp-cli list-plugins` — List installed plugins with enabled state and runtime load status.
116
+
93
117
  **list-threads** — Manage list threads
94
118
 
95
119
  - `realtimex-pp-cli list-threads <workspaceSlug>` — List threads for one exact workspace slug.
96
120
 
121
+ **list-workspace-agent-skills** — Manage list workspace agent skills
122
+
123
+ - `realtimex-pp-cli list-workspace-agent-skills <workspaceSlug>` — List published agent skills with enabled/disabled state for one exact workspace slug.
124
+
97
125
  **list-workspaces** — Manage list workspaces
98
126
 
99
127
  - `realtimex-pp-cli list-workspaces` — List all workspaces visible to the current API caller. Use this before choosing a workspace slug.
@@ -102,6 +130,14 @@ If `--version` reports "command not found" after install, the npm global bin dir
102
130
 
103
131
  - `realtimex-pp-cli prepare` — Return compact workspace, thread, current workspace/thread from explicit workspaceSlug and threadSlug query parameters
104
132
 
133
+ **reload-agent-skills** — Manage reload agent skills
134
+
135
+ - `realtimex-pp-cli reload-agent-skills` — Force reload all enabled agent skills into one workspace working directory.
136
+
137
+ **reload-plugin** — Manage reload plugin
138
+
139
+ - `realtimex-pp-cli reload-plugin <pluginId>` — Reload one enabled plugin in runtime. Disabled plugins must be enabled before reload.
140
+
105
141
  **rename-thread** — Manage rename thread
106
142
 
107
143
  - `realtimex-pp-cli rename-thread <workspaceSlug> <threadSlug>` — Rename one thread by exact workspace slug and exact thread slug. Only the name is changed.
@@ -114,10 +150,42 @@ If `--version` reports "command not found" after install, the npm global bin dir
114
150
 
115
151
  - `realtimex-pp-cli send-message <workspaceSlug> <threadSlug>` — Send one message to an exact thread using the same routing as channel replies.
116
152
 
153
+ **set-heartbeat-active-hours** — Manage set heartbeat active hours
154
+
155
+ - `realtimex-pp-cli set-heartbeat-active-hours` — Set workspace or global ambient-agent active hours using HH:mm start and end values.
156
+
157
+ **set-heartbeat-auto-pilot** — Manage set heartbeat auto pilot
158
+
159
+ - `realtimex-pp-cli set-heartbeat-auto-pilot` — Turn workspace or global ambient-agent heartbeat auto pilot on or off.
160
+
161
+ **set-heartbeat-default-agent** — Manage set heartbeat default agent
162
+
163
+ - `realtimex-pp-cli set-heartbeat-default-agent` — Set workspace or global ambient-agent main executor default terminal agent and optional model.
164
+
165
+ **set-heartbeat-enabled** — Manage set heartbeat enabled
166
+
167
+ - `realtimex-pp-cli set-heartbeat-enabled` — Turn workspace or global ambient-agent heartbeat on or off.
168
+
169
+ **set-heartbeat-interval** — Manage set heartbeat interval
170
+
171
+ - `realtimex-pp-cli set-heartbeat-interval` — Set workspace or global ambient-agent main executor interval.
172
+
173
+ **set-heartbeat-timezone** — Manage set heartbeat timezone
174
+
175
+ - `realtimex-pp-cli set-heartbeat-timezone` — Set workspace or global ambient-agent heartbeat timezone, for example Asia/Saigon or UTC.
176
+
117
177
  **set-workspace-default-agent** — Manage set workspace default agent
118
178
 
119
179
  - `realtimex-pp-cli set-workspace-default-agent <workspaceSlug>` — Set the default CLI agent for a workspace.
120
180
 
181
+ **setup-heartbeat-tasks** — Manage setup heartbeat tasks
182
+
183
+ - `realtimex-pp-cli setup-heartbeat-tasks` — Set up HEARTBEAT.md task instructions for a workspace or global ambient agent.
184
+
185
+ **setup-personality** — Manage setup personality
186
+
187
+ - `realtimex-pp-cli setup-personality` — Set up AGENTS.md and CLAUDE.md personality files for a workspace or global ambient agent.
188
+
121
189
  **start-channel** — Manage start channel
122
190
 
123
191
  - `realtimex-pp-cli start-channel <channelId>` — Start one chat channel by exact channel id.
@@ -256,9 +324,9 @@ Verify: `claude mcp list`
256
324
  ```bash
257
325
  realtimex-pp-cli --version
258
326
  ```
259
- If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.7`, reinstall the pinned version:
327
+ If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.9`, reinstall the pinned version:
260
328
  ```bash
261
- npm install -g @realtimex/pp-cli@2.0.7
329
+ npm install -g @realtimex/pp-cli@2.0.9
262
330
  ```
263
331
  Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
264
332
  2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
@@ -305,3 +373,19 @@ For workspace default-agent setup:
305
373
  * Use `prepare.agents` only.
306
374
  * Use exact agent `canonical` and optional agent `modelId` values from `prepare.agents`.
307
375
  * Never use `prepare.models` for workspace default-agent setup.
376
+
377
+ For agent skills:
378
+
379
+ * Use `list-workspace-agent-skills` before enabling, disabling, or reloading workspace skills.
380
+ * For `reload-agent-skills`, always pass a workspace slug.
381
+ * If the user asks to reload skills for the current workspace, pass `--workspace-slug "$RTX_WORKSPACE_SLUG"`.
382
+ * After `reload-agent-skills` succeeds, reload your own skill context before relying on updated skill instructions.
383
+
384
+ For personality and heartbeat setup:
385
+
386
+ * Use `setup-personality` to get the target directory for workspace or global personality files.
387
+ * Start from `templates/AGENTS.template.md` when creating `AGENTS.md`.
388
+ * Make `CLAUDE.md` a symlink to `AGENTS.md`.
389
+ * Use `setup-heartbeat-tasks` to get the target `HEARTBEAT.md` path.
390
+ * Start from `templates/HEARTBEAT.template.md` when creating `HEARTBEAT.md`.
391
+ * Keep heartbeat instructions separate from personality files.
@@ -0,0 +1,49 @@
1
+ # Agent Instructions
2
+
3
+ ## Mission
4
+
5
+ Describe the workspace or global personality that agents should follow.
6
+
7
+ You are working inside the RealTimeX app.
8
+
9
+ ## Role
10
+
11
+ - State who the agent is for this workspace.
12
+ - Define the agent's primary responsibility.
13
+ - Define what the agent should avoid doing.
14
+
15
+ ## Boundaries
16
+
17
+ - Ask for clarification when instructions are ambiguous.
18
+ - Do not fabricate facts.
19
+ - Do not take destructive actions without explicit approval.
20
+ - Do not store secrets in personality files.
21
+
22
+ ## Tools
23
+
24
+ - Describe which tools the agent may use.
25
+ - Describe any tool-specific constraints.
26
+ - Prefer using the `realtimex-moderator-sdk` skill for work related to RealTimeX workspaces, threads, channels (Telegram, Zalo, Discord), sending messages, setup personality, and heartbeat operations.
27
+ - Prefer documented RealTimeX CLI commands when interacting with RealTimeX.
28
+
29
+ ## Memory
30
+
31
+ - Record only durable preferences or facts that should affect future work.
32
+ - Keep memory concise and verifiable.
33
+ - Do not store credentials, tokens, or private secrets.
34
+
35
+ ## Style
36
+
37
+ - Be concise.
38
+ - Prefer concrete updates over speculation.
39
+ - Explain blockers clearly.
40
+
41
+ ## Child Files
42
+
43
+ Reference child markdown files here if used:
44
+
45
+ - SOUL.md
46
+ - USER.md
47
+ - IDENTITY.md
48
+ - TOOLS.md
49
+ - MEMORY.md
@@ -0,0 +1,61 @@
1
+ # Heartbeat Instructions
2
+
3
+ ## Mission
4
+
5
+ Describe the ambient agent's standing responsibility.
6
+
7
+ ## Scheduled tasks (optional)
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.
12
+ Use `interval` for simple timing. Supported units are `m`, `h`, and `d`, for example `3m`, `1h`, or `1d`.
13
+ 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.
18
+
19
+ tasks:
20
+
21
+ - name: example-task
22
+ interval: 30m
23
+ agent: @codex-terminal
24
+ model: gpt-5.5-medium
25
+ skills: agent-browser, realtimex-moderator-sdk
26
+ prompt: Describe what the agent should do for this task
27
+ - name: weekday-morning-task
28
+ cron: 0 9 * * 1-5
29
+ prompt: Describe what should run on a cron schedule
30
+ - name: another-task
31
+ prompt: Tasks without interval run at the main check interval
32
+
33
+ ## Check for
34
+
35
+ - Pending tasks that require follow-up
36
+ - New events that need awareness
37
+
38
+ ## When action is needed
39
+
40
+ - State what should trigger action
41
+ - Describe the preferred next step
42
+ - If calendar routine context is provided, use it only when a concise update would help
43
+
44
+ ## When nothing is needed
45
+
46
+ - Reply exactly HEARTBEAT_OK
47
+
48
+ ## Allowed actions
49
+
50
+ - Review the current workspace context
51
+ - Create or update relevant artifacts when necessary
52
+
53
+ ## Never do
54
+
55
+ - Do not repeat old work without a clear reason
56
+ - Do not take destructive actions without explicit approval
57
+
58
+ ## Style
59
+
60
+ - Be concise
61
+ - Prefer concrete updates over speculation