@realtimex/sdk 2.0.15 → 2.0.17
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, run tour guide to setup working dir."
|
|
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, publish and manage artifacts, 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.17
|
|
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.17`.
|
|
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.17`, 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
|
|
|
@@ -86,6 +86,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
86
86
|
|
|
87
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
88
|
|
|
89
|
+
**get-artifact** — Manage get artifact
|
|
90
|
+
|
|
91
|
+
- `realtimex-pp-cli get-artifact <artifactId>` — Get one public artifact by artifact id.
|
|
92
|
+
|
|
89
93
|
**get-thread** — Manage get thread
|
|
90
94
|
|
|
91
95
|
- `realtimex-pp-cli get-thread <workspaceSlug> <threadSlug>` — Get one thread by exact workspace slug and exact thread slug.
|
|
@@ -98,6 +102,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
98
102
|
|
|
99
103
|
- `realtimex-pp-cli list-agent-skills` — List published agent skills. Use list-workspace-agent-skills to see enabled/disabled state for one workspace.
|
|
100
104
|
|
|
105
|
+
**list-artifacts** — Manage list artifacts
|
|
106
|
+
|
|
107
|
+
- `realtimex-pp-cli list-artifacts <workspaceSlug>` — List public artifacts for one exact workspace slug. Revoked artifacts are hidden unless includeRevoked=true is passed.
|
|
108
|
+
|
|
101
109
|
**list-channels** — Manage list channels
|
|
102
110
|
|
|
103
111
|
- `realtimex-pp-cli list-channels` — List configured chat channels. Use returned channel ids with update-channel.
|
|
@@ -138,10 +146,18 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
138
146
|
|
|
139
147
|
- `realtimex-pp-cli open-terminal-session` — Open a new desktop terminal session for one terminal CLI agent. Use list-terminal-agents or prepare.
|
|
140
148
|
|
|
149
|
+
**pause-artifact** — Manage pause artifact
|
|
150
|
+
|
|
151
|
+
- `realtimex-pp-cli pause-artifact <artifactId>` — Pause one published artifact by artifact id. Paused artifacts remain listed but stop serving publicly.
|
|
152
|
+
|
|
141
153
|
**prepare** — Manage prepare
|
|
142
154
|
|
|
143
155
|
- `realtimex-pp-cli prepare` — Return compact workspace, thread, current workspace/thread from explicit workspaceSlug and threadSlug query parameters
|
|
144
156
|
|
|
157
|
+
**publish-artifact** — Manage publish artifact
|
|
158
|
+
|
|
159
|
+
- `realtimex-pp-cli publish-artifact <workspaceSlug>` — Publish a browser-viewable file or folder under a workspace artifacts directory.
|
|
160
|
+
|
|
145
161
|
**reload-agent-skills** — Manage reload agent skills
|
|
146
162
|
|
|
147
163
|
- `realtimex-pp-cli reload-agent-skills` — Force reload all enabled agent skills into one workspace working directory.
|
|
@@ -158,6 +174,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
158
174
|
|
|
159
175
|
- `realtimex-pp-cli rename-workspace <workspaceSlug>` — Rename one workspace by exact workspace slug. Only the name is changed.
|
|
160
176
|
|
|
177
|
+
**resume-artifact** — Manage resume artifact
|
|
178
|
+
|
|
179
|
+
- `realtimex-pp-cli resume-artifact <artifactId>` — Resume one paused artifact by artifact id.
|
|
180
|
+
|
|
161
181
|
**resume-latest-terminal-session** — Manage resume latest terminal session
|
|
162
182
|
|
|
163
183
|
- `realtimex-pp-cli resume-latest-terminal-session` — Resume the latest terminal runtime session for one exact thread.
|
|
@@ -166,10 +186,18 @@ If `--version` reports "command not found" after install, the npm global bin dir
|
|
|
166
186
|
|
|
167
187
|
- `realtimex-pp-cli resume-terminal-session <sessionId>` — Resume a terminal runtime session by attaching a CLI controller.
|
|
168
188
|
|
|
189
|
+
**revoke-artifact** — Manage revoke artifact
|
|
190
|
+
|
|
191
|
+
- `realtimex-pp-cli revoke-artifact <artifactId>` — Revoke one artifact by artifact id.
|
|
192
|
+
|
|
169
193
|
**run-automation-workflow** — Manage run automation workflow
|
|
170
194
|
|
|
171
195
|
- `realtimex-pp-cli run-automation-workflow` — Run any app automation flow or scenario exposed via flowMetadata.cli.enabled=true by passing workflowName.
|
|
172
196
|
|
|
197
|
+
**send-channel-file** — Manage send channel file
|
|
198
|
+
|
|
199
|
+
- `realtimex-pp-cli send-channel-file` — Send one local CLI file back to an external channel using an explicit channel delivery context id.
|
|
200
|
+
|
|
173
201
|
**send-message** — Manage send message
|
|
174
202
|
|
|
175
203
|
- `realtimex-pp-cli send-message <workspaceSlug> <threadSlug>` — Send one message to an exact thread using the same routing as channel replies.
|
|
@@ -368,9 +396,9 @@ Verify: `claude mcp list`
|
|
|
368
396
|
```bash
|
|
369
397
|
realtimex-pp-cli --version
|
|
370
398
|
```
|
|
371
|
-
If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.
|
|
399
|
+
If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.17`, reinstall the pinned version:
|
|
372
400
|
```bash
|
|
373
|
-
npm install -g @realtimex/pp-cli@2.0.
|
|
401
|
+
npm install -g @realtimex/pp-cli@2.0.17
|
|
374
402
|
```
|
|
375
403
|
Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
|
|
376
404
|
2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
|
|
@@ -421,6 +449,16 @@ For `send-message`:
|
|
|
421
449
|
* If any of those values are missing or ambiguous, ask for the missing values before running the command.
|
|
422
450
|
* Do not provide LLM provider/model arguments to `send-message`; the server routes the message based on the thread/workspace configuration.
|
|
423
451
|
|
|
452
|
+
|
|
453
|
+
For `send-channel-file`:
|
|
454
|
+
|
|
455
|
+
* 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.
|
|
456
|
+
* 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.
|
|
457
|
+
* Do not infer a destination from workspace, thread, recent activity, or channel metadata.
|
|
458
|
+
* Send one file per command call. Repeat the command for multiple files.
|
|
459
|
+
* 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.
|
|
460
|
+
* The server validates the delivery context, active channel session, plugin state, runtime binding when supplied, and file size/type handling before delivery.
|
|
461
|
+
|
|
424
462
|
For workspace default-agent setup:
|
|
425
463
|
|
|
426
464
|
* Use `prepare.agents` only.
|