@formant/formant-cli 0.3.1 → 0.4.3
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 +193 -142
- package/dist/commands/{commands → command}/for-device.js +2 -2
- package/dist/commands/command/for-device.js.map +1 -0
- package/dist/commands/{commands → command}/get.js +2 -2
- package/dist/commands/command/get.js.map +1 -0
- package/dist/commands/{commands → command}/history.js +3 -3
- package/dist/commands/command/history.js.map +1 -0
- package/dist/commands/{commands → command}/list.js +2 -2
- package/dist/commands/command/list.js.map +1 -0
- package/dist/commands/{commands → command}/send.js +5 -5
- package/dist/commands/command/send.js.map +1 -0
- package/dist/commands/{devices → device}/config.js +2 -2
- package/dist/commands/device/config.js.map +1 -0
- package/dist/commands/{devices → device}/create.js +3 -3
- package/dist/commands/device/create.js.map +1 -0
- package/dist/commands/{devices → device}/delete.js +2 -2
- package/dist/commands/device/delete.js.map +1 -0
- package/dist/commands/{devices → device}/get.js +2 -2
- package/dist/commands/device/get.js.map +1 -0
- package/dist/commands/{devices → device}/list.d.ts +7 -1
- package/dist/commands/{devices → device}/list.js +67 -13
- package/dist/commands/device/list.js.map +1 -0
- package/dist/commands/{devices → device}/rename.js +2 -2
- package/dist/commands/device/rename.js.map +1 -0
- package/dist/commands/{devices → device}/streams.d.ts +1 -0
- package/dist/commands/device/streams.js +155 -0
- package/dist/commands/device/streams.js.map +1 -0
- package/dist/commands/{devices → device}/tag.js +3 -3
- package/dist/commands/device/tag.js.map +1 -0
- package/dist/commands/{devices → device}/untag.js +3 -3
- package/dist/commands/device/untag.js.map +1 -0
- package/dist/commands/{events → event}/get.js +2 -2
- package/dist/commands/event/get.js.map +1 -0
- package/dist/commands/{events → event}/list.js +4 -4
- package/dist/commands/event/list.js.map +1 -0
- package/dist/commands/{event-triggers → event-trigger}/get.js +2 -2
- package/dist/commands/event-trigger/get.js.map +1 -0
- package/dist/commands/{event-triggers → event-trigger}/list.js +2 -2
- package/dist/commands/event-trigger/list.js.map +1 -0
- package/dist/commands/{fleets → fleet}/get.js +2 -2
- package/dist/commands/fleet/get.js.map +1 -0
- package/dist/commands/{fleets → fleet}/list.js +2 -2
- package/dist/commands/fleet/list.js.map +1 -0
- package/dist/commands/{investigations → investigation}/analytics.js +3 -3
- package/dist/commands/investigation/analytics.js.map +1 -0
- package/dist/commands/{investigations → investigation}/get.js +2 -2
- package/dist/commands/investigation/get.js.map +1 -0
- package/dist/commands/{investigations → investigation}/list.js +3 -3
- package/dist/commands/investigation/list.js.map +1 -0
- package/dist/commands/{investigations → investigation}/run.js +3 -3
- package/dist/commands/investigation/run.js.map +1 -0
- package/dist/commands/{investigations → investigation}/runs-list.js +3 -3
- package/dist/commands/investigation/runs-list.js.map +1 -0
- package/dist/commands/{investigations → investigation}/runs.js +2 -2
- package/dist/commands/investigation/runs.js.map +1 -0
- package/dist/commands/{investigations → investigation}/stats.js +2 -2
- package/dist/commands/investigation/stats.js.map +1 -0
- package/dist/commands/{investigations → investigation}/trigger.js +2 -2
- package/dist/commands/investigation/trigger.js.map +1 -0
- package/dist/commands/persona/delegate-task.d.ts +14 -0
- package/dist/commands/persona/delegate-task.js +50 -0
- package/dist/commands/persona/delegate-task.js.map +1 -0
- package/dist/commands/persona/get.d.ts +10 -0
- package/dist/commands/persona/get.js +98 -0
- package/dist/commands/persona/get.js.map +1 -0
- package/dist/commands/{signals → persona}/list.d.ts +1 -1
- package/dist/commands/persona/list.js +31 -0
- package/dist/commands/persona/list.js.map +1 -0
- package/dist/commands/persona/task-status.d.ts +12 -0
- package/dist/commands/persona/task-status.js +57 -0
- package/dist/commands/persona/task-status.js.map +1 -0
- package/dist/commands/{schedules → schedule}/get.js +2 -2
- package/dist/commands/schedule/get.js.map +1 -0
- package/dist/commands/{schedules → schedule}/list.js +2 -2
- package/dist/commands/schedule/list.js.map +1 -0
- package/dist/commands/{signals → signal}/count.js +3 -3
- package/dist/commands/signal/count.js.map +1 -0
- package/dist/commands/signal/create.d.ts +16 -0
- package/dist/commands/signal/create.js +95 -0
- package/dist/commands/signal/create.js.map +1 -0
- package/dist/commands/{signals → signal}/get.js +3 -3
- package/dist/commands/signal/get.js.map +1 -0
- package/dist/commands/signal/list.d.ts +12 -0
- package/dist/commands/signal/list.js +85 -0
- package/dist/commands/signal/list.js.map +1 -0
- package/dist/commands/{signals → signal}/query.d.ts +1 -0
- package/dist/commands/signal/query.js +100 -0
- package/dist/commands/signal/query.js.map +1 -0
- package/dist/commands/signal/set-ground-truth.d.ts +12 -0
- package/dist/commands/signal/set-ground-truth.js +46 -0
- package/dist/commands/signal/set-ground-truth.js.map +1 -0
- package/dist/commands/{users → user}/get.js +2 -2
- package/dist/commands/user/get.js.map +1 -0
- package/dist/commands/{users → user}/list.js +2 -2
- package/dist/commands/user/list.js.map +1 -0
- package/dist/help.js +53 -47
- package/dist/help.js.map +1 -1
- package/dist/lib/api.d.ts +1 -1
- package/dist/lib/api.js +3 -0
- package/dist/lib/api.js.map +1 -1
- package/dist/lib/config.d.ts +1 -0
- package/dist/lib/config.js +3 -0
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/presence.d.ts +46 -0
- package/dist/lib/presence.js +95 -0
- package/dist/lib/presence.js.map +1 -0
- package/oclif.manifest.json +1192 -790
- package/package.json +28 -25
- package/dist/commands/commands/for-device.js.map +0 -1
- package/dist/commands/commands/get.js.map +0 -1
- package/dist/commands/commands/history.js.map +0 -1
- package/dist/commands/commands/list.js.map +0 -1
- package/dist/commands/commands/send.js.map +0 -1
- package/dist/commands/devices/config.js.map +0 -1
- package/dist/commands/devices/create.js.map +0 -1
- package/dist/commands/devices/delete.js.map +0 -1
- package/dist/commands/devices/get.js.map +0 -1
- package/dist/commands/devices/last-seen.d.ts +0 -10
- package/dist/commands/devices/last-seen.js +0 -25
- package/dist/commands/devices/last-seen.js.map +0 -1
- package/dist/commands/devices/list.js.map +0 -1
- package/dist/commands/devices/rename.js.map +0 -1
- package/dist/commands/devices/streams.js +0 -100
- package/dist/commands/devices/streams.js.map +0 -1
- package/dist/commands/devices/tag.js.map +0 -1
- package/dist/commands/devices/untag.js.map +0 -1
- package/dist/commands/event-triggers/get.js.map +0 -1
- package/dist/commands/event-triggers/list.js.map +0 -1
- package/dist/commands/events/get.js.map +0 -1
- package/dist/commands/events/list.js.map +0 -1
- package/dist/commands/fleets/get.js.map +0 -1
- package/dist/commands/fleets/list.js.map +0 -1
- package/dist/commands/investigations/analytics.js.map +0 -1
- package/dist/commands/investigations/get.js.map +0 -1
- package/dist/commands/investigations/list.js.map +0 -1
- package/dist/commands/investigations/run.js.map +0 -1
- package/dist/commands/investigations/runs-list.js.map +0 -1
- package/dist/commands/investigations/runs.js.map +0 -1
- package/dist/commands/investigations/stats.js.map +0 -1
- package/dist/commands/investigations/trigger.js.map +0 -1
- package/dist/commands/schedules/get.js.map +0 -1
- package/dist/commands/schedules/list.js.map +0 -1
- package/dist/commands/signals/count.js.map +0 -1
- package/dist/commands/signals/get.js.map +0 -1
- package/dist/commands/signals/list.js +0 -30
- package/dist/commands/signals/list.js.map +0 -1
- package/dist/commands/signals/query.js +0 -52
- package/dist/commands/signals/query.js.map +0 -1
- package/dist/commands/users/get.js.map +0 -1
- package/dist/commands/users/list.js.map +0 -1
- /package/dist/commands/{commands → command}/for-device.d.ts +0 -0
- /package/dist/commands/{commands → command}/get.d.ts +0 -0
- /package/dist/commands/{commands → command}/history.d.ts +0 -0
- /package/dist/commands/{commands → command}/list.d.ts +0 -0
- /package/dist/commands/{commands → command}/send.d.ts +0 -0
- /package/dist/commands/{devices → device}/config.d.ts +0 -0
- /package/dist/commands/{devices → device}/create.d.ts +0 -0
- /package/dist/commands/{devices → device}/delete.d.ts +0 -0
- /package/dist/commands/{devices → device}/get.d.ts +0 -0
- /package/dist/commands/{devices → device}/rename.d.ts +0 -0
- /package/dist/commands/{devices → device}/tag.d.ts +0 -0
- /package/dist/commands/{devices → device}/untag.d.ts +0 -0
- /package/dist/commands/{events → event}/get.d.ts +0 -0
- /package/dist/commands/{events → event}/list.d.ts +0 -0
- /package/dist/commands/{event-triggers → event-trigger}/get.d.ts +0 -0
- /package/dist/commands/{event-triggers → event-trigger}/list.d.ts +0 -0
- /package/dist/commands/{fleets → fleet}/get.d.ts +0 -0
- /package/dist/commands/{fleets → fleet}/list.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/analytics.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/get.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/list.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/run.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/runs-list.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/runs.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/stats.d.ts +0 -0
- /package/dist/commands/{investigations → investigation}/trigger.d.ts +0 -0
- /package/dist/commands/{schedules → schedule}/get.d.ts +0 -0
- /package/dist/commands/{schedules → schedule}/list.d.ts +0 -0
- /package/dist/commands/{signals → signal}/count.d.ts +0 -0
- /package/dist/commands/{signals → signal}/get.d.ts +0 -0
- /package/dist/commands/{users → user}/get.d.ts +0 -0
- /package/dist/commands/{users → user}/list.d.ts +0 -0
package/oclif.manifest.json
CHANGED
|
@@ -140,19 +140,19 @@
|
|
|
140
140
|
"tables.js"
|
|
141
141
|
]
|
|
142
142
|
},
|
|
143
|
-
"
|
|
143
|
+
"event-trigger:get": {
|
|
144
144
|
"aliases": [],
|
|
145
145
|
"args": {
|
|
146
|
-
"
|
|
147
|
-
"description": "
|
|
148
|
-
"name": "
|
|
146
|
+
"id": {
|
|
147
|
+
"description": "Event trigger ID (UUID)",
|
|
148
|
+
"name": "id",
|
|
149
149
|
"required": true
|
|
150
150
|
}
|
|
151
151
|
},
|
|
152
|
-
"description": "
|
|
152
|
+
"description": "Get detailed information about an event trigger.\n\nShows the full trigger configuration including conditions, exit conditions, commands\nit executes, and device targeting filters.",
|
|
153
153
|
"examples": [
|
|
154
|
-
"<%= config.bin %>
|
|
155
|
-
"<%= config.bin %>
|
|
154
|
+
"<%= config.bin %> event-trigger get <trigger-id>",
|
|
155
|
+
"<%= config.bin %> event-trigger get <trigger-id> --json"
|
|
156
156
|
],
|
|
157
157
|
"flags": {
|
|
158
158
|
"json": {
|
|
@@ -185,34 +185,28 @@
|
|
|
185
185
|
},
|
|
186
186
|
"hasDynamicHelp": false,
|
|
187
187
|
"hiddenAliases": [],
|
|
188
|
-
"id": "
|
|
188
|
+
"id": "event-trigger:get",
|
|
189
189
|
"pluginAlias": "@formant/formant-cli",
|
|
190
190
|
"pluginName": "@formant/formant-cli",
|
|
191
191
|
"pluginType": "core",
|
|
192
192
|
"strict": true,
|
|
193
|
-
"summary": "
|
|
193
|
+
"summary": "Get event trigger details",
|
|
194
194
|
"enableJsonFlag": true,
|
|
195
195
|
"isESM": true,
|
|
196
196
|
"relativePath": [
|
|
197
197
|
"dist",
|
|
198
198
|
"commands",
|
|
199
|
-
"
|
|
200
|
-
"
|
|
199
|
+
"event-trigger",
|
|
200
|
+
"get.js"
|
|
201
201
|
]
|
|
202
202
|
},
|
|
203
|
-
"
|
|
203
|
+
"event-trigger:list": {
|
|
204
204
|
"aliases": [],
|
|
205
|
-
"args": {
|
|
206
|
-
|
|
207
|
-
"description": "Command template ID (UUID)",
|
|
208
|
-
"name": "id",
|
|
209
|
-
"required": true
|
|
210
|
-
}
|
|
211
|
-
},
|
|
212
|
-
"description": "Get detailed information about a command template.\n\nShows the full template configuration including command string, parameter schema,\ndevice targeting filters, and delivery settings. If the template has structured\nparameters (schema), they are displayed in a readable format.",
|
|
205
|
+
"args": {},
|
|
206
|
+
"description": "List all event trigger rules in your organization.\n\nEvent triggers monitor device data and generate events/signals when conditions are met.\nThey can trigger investigations, send notifications, or execute commands.",
|
|
213
207
|
"examples": [
|
|
214
|
-
"<%= config.bin %>
|
|
215
|
-
"<%= config.bin %>
|
|
208
|
+
"<%= config.bin %> event-trigger list",
|
|
209
|
+
"<%= config.bin %> event-trigger list --json"
|
|
216
210
|
],
|
|
217
211
|
"flags": {
|
|
218
212
|
"json": {
|
|
@@ -245,29 +239,34 @@
|
|
|
245
239
|
},
|
|
246
240
|
"hasDynamicHelp": false,
|
|
247
241
|
"hiddenAliases": [],
|
|
248
|
-
"id": "
|
|
242
|
+
"id": "event-trigger:list",
|
|
249
243
|
"pluginAlias": "@formant/formant-cli",
|
|
250
244
|
"pluginName": "@formant/formant-cli",
|
|
251
245
|
"pluginType": "core",
|
|
252
246
|
"strict": true,
|
|
253
|
-
"summary": "
|
|
247
|
+
"summary": "List event trigger rules",
|
|
254
248
|
"enableJsonFlag": true,
|
|
255
249
|
"isESM": true,
|
|
256
250
|
"relativePath": [
|
|
257
251
|
"dist",
|
|
258
252
|
"commands",
|
|
259
|
-
"
|
|
260
|
-
"
|
|
253
|
+
"event-trigger",
|
|
254
|
+
"list.js"
|
|
261
255
|
]
|
|
262
256
|
},
|
|
263
|
-
"
|
|
257
|
+
"fleet:get": {
|
|
264
258
|
"aliases": [],
|
|
265
|
-
"args": {
|
|
266
|
-
|
|
259
|
+
"args": {
|
|
260
|
+
"id": {
|
|
261
|
+
"description": "Fleet (group) ID (UUID)",
|
|
262
|
+
"name": "id",
|
|
263
|
+
"required": true
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.",
|
|
267
267
|
"examples": [
|
|
268
|
-
"<%= config.bin %>
|
|
269
|
-
"<%= config.bin %>
|
|
270
|
-
"<%= config.bin %> commands history --device <device-id> --json"
|
|
268
|
+
"<%= config.bin %> fleet get <fleet-id>",
|
|
269
|
+
"<%= config.bin %> fleet get <fleet-id> --json"
|
|
271
270
|
],
|
|
272
271
|
"flags": {
|
|
273
272
|
"json": {
|
|
@@ -296,50 +295,32 @@
|
|
|
296
295
|
"name": "stage",
|
|
297
296
|
"allowNo": false,
|
|
298
297
|
"type": "boolean"
|
|
299
|
-
},
|
|
300
|
-
"device": {
|
|
301
|
-
"char": "d",
|
|
302
|
-
"description": "Device ID (UUID)",
|
|
303
|
-
"name": "device",
|
|
304
|
-
"required": true,
|
|
305
|
-
"hasDynamicHelp": false,
|
|
306
|
-
"multiple": false,
|
|
307
|
-
"type": "option"
|
|
308
|
-
},
|
|
309
|
-
"limit": {
|
|
310
|
-
"char": "l",
|
|
311
|
-
"description": "Maximum number of commands to return",
|
|
312
|
-
"name": "limit",
|
|
313
|
-
"default": 25,
|
|
314
|
-
"hasDynamicHelp": false,
|
|
315
|
-
"multiple": false,
|
|
316
|
-
"type": "option"
|
|
317
298
|
}
|
|
318
299
|
},
|
|
319
300
|
"hasDynamicHelp": false,
|
|
320
301
|
"hiddenAliases": [],
|
|
321
|
-
"id": "
|
|
302
|
+
"id": "fleet:get",
|
|
322
303
|
"pluginAlias": "@formant/formant-cli",
|
|
323
304
|
"pluginName": "@formant/formant-cli",
|
|
324
305
|
"pluginType": "core",
|
|
325
306
|
"strict": true,
|
|
326
|
-
"summary": "
|
|
307
|
+
"summary": "Get fleet details",
|
|
327
308
|
"enableJsonFlag": true,
|
|
328
309
|
"isESM": true,
|
|
329
310
|
"relativePath": [
|
|
330
311
|
"dist",
|
|
331
312
|
"commands",
|
|
332
|
-
"
|
|
333
|
-
"
|
|
313
|
+
"fleet",
|
|
314
|
+
"get.js"
|
|
334
315
|
]
|
|
335
316
|
},
|
|
336
|
-
"
|
|
317
|
+
"fleet:list": {
|
|
337
318
|
"aliases": [],
|
|
338
319
|
"args": {},
|
|
339
|
-
"description": "List all
|
|
320
|
+
"description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.",
|
|
340
321
|
"examples": [
|
|
341
|
-
"<%= config.bin %>
|
|
342
|
-
"<%= config.bin %>
|
|
322
|
+
"<%= config.bin %> fleet list",
|
|
323
|
+
"<%= config.bin %> fleet list --json"
|
|
343
324
|
],
|
|
344
325
|
"flags": {
|
|
345
326
|
"json": {
|
|
@@ -372,42 +353,34 @@
|
|
|
372
353
|
},
|
|
373
354
|
"hasDynamicHelp": false,
|
|
374
355
|
"hiddenAliases": [],
|
|
375
|
-
"id": "
|
|
356
|
+
"id": "fleet:list",
|
|
376
357
|
"pluginAlias": "@formant/formant-cli",
|
|
377
358
|
"pluginName": "@formant/formant-cli",
|
|
378
359
|
"pluginType": "core",
|
|
379
360
|
"strict": true,
|
|
380
|
-
"summary": "List
|
|
361
|
+
"summary": "List device groups",
|
|
381
362
|
"enableJsonFlag": true,
|
|
382
363
|
"isESM": true,
|
|
383
364
|
"relativePath": [
|
|
384
365
|
"dist",
|
|
385
366
|
"commands",
|
|
386
|
-
"
|
|
367
|
+
"fleet",
|
|
387
368
|
"list.js"
|
|
388
369
|
]
|
|
389
370
|
},
|
|
390
|
-
"
|
|
371
|
+
"command:for-device": {
|
|
391
372
|
"aliases": [],
|
|
392
373
|
"args": {
|
|
393
374
|
"deviceId": {
|
|
394
375
|
"description": "Device ID (UUID)",
|
|
395
376
|
"name": "deviceId",
|
|
396
377
|
"required": true
|
|
397
|
-
},
|
|
398
|
-
"templateId": {
|
|
399
|
-
"description": "Command template ID (UUID)",
|
|
400
|
-
"name": "templateId",
|
|
401
|
-
"required": true
|
|
402
378
|
}
|
|
403
379
|
},
|
|
404
|
-
"description": "
|
|
380
|
+
"description": "List command templates available for a specific device.\n\nReturns commands that match the device's tags and filters. Only enabled commands\nthat apply to this device are shown.",
|
|
405
381
|
"examples": [
|
|
406
|
-
"<%= config.bin %>
|
|
407
|
-
"<%= config.bin %>
|
|
408
|
-
"<%= config.bin %> commands send <device-id> <template-id> --dry-run",
|
|
409
|
-
"<%= config.bin %> commands send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
|
|
410
|
-
"<%= config.bin %> commands send <device-id> <template-id> --json"
|
|
382
|
+
"<%= config.bin %> command for-device <device-id>",
|
|
383
|
+
"<%= config.bin %> command for-device <device-id> --json"
|
|
411
384
|
],
|
|
412
385
|
"flags": {
|
|
413
386
|
"json": {
|
|
@@ -436,59 +409,38 @@
|
|
|
436
409
|
"name": "stage",
|
|
437
410
|
"allowNo": false,
|
|
438
411
|
"type": "boolean"
|
|
439
|
-
},
|
|
440
|
-
"dry-run": {
|
|
441
|
-
"description": "Preview the command payload without sending",
|
|
442
|
-
"name": "dry-run",
|
|
443
|
-
"allowNo": false,
|
|
444
|
-
"type": "boolean"
|
|
445
|
-
},
|
|
446
|
-
"param": {
|
|
447
|
-
"char": "p",
|
|
448
|
-
"description": "Parameter override (name=value), can be specified multiple times",
|
|
449
|
-
"name": "param",
|
|
450
|
-
"hasDynamicHelp": false,
|
|
451
|
-
"multiple": true,
|
|
452
|
-
"type": "option"
|
|
453
|
-
},
|
|
454
|
-
"raw-value": {
|
|
455
|
-
"description": "Send a raw parameter value string (bypasses schema validation)",
|
|
456
|
-
"name": "raw-value",
|
|
457
|
-
"hasDynamicHelp": false,
|
|
458
|
-
"multiple": false,
|
|
459
|
-
"type": "option"
|
|
460
412
|
}
|
|
461
413
|
},
|
|
462
414
|
"hasDynamicHelp": false,
|
|
463
415
|
"hiddenAliases": [],
|
|
464
|
-
"id": "
|
|
416
|
+
"id": "command:for-device",
|
|
465
417
|
"pluginAlias": "@formant/formant-cli",
|
|
466
418
|
"pluginName": "@formant/formant-cli",
|
|
467
419
|
"pluginType": "core",
|
|
468
420
|
"strict": true,
|
|
469
|
-
"summary": "
|
|
421
|
+
"summary": "List commands available for a device",
|
|
470
422
|
"enableJsonFlag": true,
|
|
471
423
|
"isESM": true,
|
|
472
424
|
"relativePath": [
|
|
473
425
|
"dist",
|
|
474
426
|
"commands",
|
|
475
|
-
"
|
|
476
|
-
"
|
|
427
|
+
"command",
|
|
428
|
+
"for-device.js"
|
|
477
429
|
]
|
|
478
430
|
},
|
|
479
|
-
"
|
|
431
|
+
"command:get": {
|
|
480
432
|
"aliases": [],
|
|
481
433
|
"args": {
|
|
482
434
|
"id": {
|
|
483
|
-
"description": "
|
|
435
|
+
"description": "Command template ID (UUID)",
|
|
484
436
|
"name": "id",
|
|
485
437
|
"required": true
|
|
486
438
|
}
|
|
487
439
|
},
|
|
488
|
-
"description": "Get
|
|
440
|
+
"description": "Get detailed information about a command template.\n\nShows the full template configuration including command string, parameter schema,\ndevice targeting filters, and delivery settings. If the template has structured\nparameters (schema), they are displayed in a readable format.",
|
|
489
441
|
"examples": [
|
|
490
|
-
"<%= config.bin %>
|
|
491
|
-
"<%= config.bin %>
|
|
442
|
+
"<%= config.bin %> command get <template-id>",
|
|
443
|
+
"<%= config.bin %> command get <template-id> --json"
|
|
492
444
|
],
|
|
493
445
|
"flags": {
|
|
494
446
|
"json": {
|
|
@@ -521,35 +473,29 @@
|
|
|
521
473
|
},
|
|
522
474
|
"hasDynamicHelp": false,
|
|
523
475
|
"hiddenAliases": [],
|
|
524
|
-
"id": "
|
|
476
|
+
"id": "command:get",
|
|
525
477
|
"pluginAlias": "@formant/formant-cli",
|
|
526
478
|
"pluginName": "@formant/formant-cli",
|
|
527
479
|
"pluginType": "core",
|
|
528
480
|
"strict": true,
|
|
529
|
-
"summary": "Get
|
|
481
|
+
"summary": "Get command template details",
|
|
530
482
|
"enableJsonFlag": true,
|
|
531
483
|
"isESM": true,
|
|
532
484
|
"relativePath": [
|
|
533
485
|
"dist",
|
|
534
486
|
"commands",
|
|
535
|
-
"
|
|
536
|
-
"
|
|
487
|
+
"command",
|
|
488
|
+
"get.js"
|
|
537
489
|
]
|
|
538
490
|
},
|
|
539
|
-
"
|
|
491
|
+
"command:history": {
|
|
540
492
|
"aliases": [],
|
|
541
|
-
"args": {
|
|
542
|
-
|
|
543
|
-
"description": "Name for the new device",
|
|
544
|
-
"name": "name",
|
|
545
|
-
"required": true
|
|
546
|
-
}
|
|
547
|
-
},
|
|
548
|
-
"description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
|
|
493
|
+
"args": {},
|
|
494
|
+
"description": "Query command history for a device.\n\nShows commands that have been sent to a device, including delivery status and responses.\nUse this to check if commands were delivered and executed successfully.",
|
|
549
495
|
"examples": [
|
|
550
|
-
"<%= config.bin %>
|
|
551
|
-
"<%= config.bin %>
|
|
552
|
-
"<%= config.bin %>
|
|
496
|
+
"<%= config.bin %> command history --device <device-id>",
|
|
497
|
+
"<%= config.bin %> command history --device <device-id> --limit 50",
|
|
498
|
+
"<%= config.bin %> command history --device <device-id> --json"
|
|
553
499
|
],
|
|
554
500
|
"flags": {
|
|
555
501
|
"json": {
|
|
@@ -579,45 +525,49 @@
|
|
|
579
525
|
"allowNo": false,
|
|
580
526
|
"type": "boolean"
|
|
581
527
|
},
|
|
582
|
-
"
|
|
583
|
-
"char": "
|
|
584
|
-
"description": "
|
|
585
|
-
"name": "
|
|
528
|
+
"device": {
|
|
529
|
+
"char": "d",
|
|
530
|
+
"description": "Device ID (UUID)",
|
|
531
|
+
"name": "device",
|
|
532
|
+
"required": true,
|
|
586
533
|
"hasDynamicHelp": false,
|
|
587
|
-
"multiple":
|
|
534
|
+
"multiple": false,
|
|
535
|
+
"type": "option"
|
|
536
|
+
},
|
|
537
|
+
"limit": {
|
|
538
|
+
"char": "l",
|
|
539
|
+
"description": "Maximum number of commands to return",
|
|
540
|
+
"name": "limit",
|
|
541
|
+
"default": 25,
|
|
542
|
+
"hasDynamicHelp": false,
|
|
543
|
+
"multiple": false,
|
|
588
544
|
"type": "option"
|
|
589
545
|
}
|
|
590
546
|
},
|
|
591
547
|
"hasDynamicHelp": false,
|
|
592
548
|
"hiddenAliases": [],
|
|
593
|
-
"id": "
|
|
549
|
+
"id": "command:history",
|
|
594
550
|
"pluginAlias": "@formant/formant-cli",
|
|
595
551
|
"pluginName": "@formant/formant-cli",
|
|
596
552
|
"pluginType": "core",
|
|
597
553
|
"strict": true,
|
|
598
|
-
"summary": "
|
|
554
|
+
"summary": "Query command history",
|
|
599
555
|
"enableJsonFlag": true,
|
|
600
556
|
"isESM": true,
|
|
601
557
|
"relativePath": [
|
|
602
558
|
"dist",
|
|
603
559
|
"commands",
|
|
604
|
-
"
|
|
605
|
-
"
|
|
560
|
+
"command",
|
|
561
|
+
"history.js"
|
|
606
562
|
]
|
|
607
563
|
},
|
|
608
|
-
"
|
|
564
|
+
"command:list": {
|
|
609
565
|
"aliases": [],
|
|
610
|
-
"args": {
|
|
611
|
-
|
|
612
|
-
"description": "Device ID (UUID)",
|
|
613
|
-
"name": "id",
|
|
614
|
-
"required": true
|
|
615
|
-
}
|
|
616
|
-
},
|
|
617
|
-
"description": "Delete (disable) a device from your fleet.\n\nThis performs a soft-delete by disabling the device. The device and its telemetry\nhistory are preserved but it will no longer appear in device listings.",
|
|
566
|
+
"args": {},
|
|
567
|
+
"description": "List all command templates defined in your organization.\n\nCommand templates define the commands that can be sent to devices. Each template\nspecifies the command string, parameters, delivery settings, and device targeting.",
|
|
618
568
|
"examples": [
|
|
619
|
-
"<%= config.bin %>
|
|
620
|
-
"<%= config.bin %>
|
|
569
|
+
"<%= config.bin %> command list",
|
|
570
|
+
"<%= config.bin %> command list --json"
|
|
621
571
|
],
|
|
622
572
|
"flags": {
|
|
623
573
|
"json": {
|
|
@@ -650,34 +600,42 @@
|
|
|
650
600
|
},
|
|
651
601
|
"hasDynamicHelp": false,
|
|
652
602
|
"hiddenAliases": [],
|
|
653
|
-
"id": "
|
|
603
|
+
"id": "command:list",
|
|
654
604
|
"pluginAlias": "@formant/formant-cli",
|
|
655
605
|
"pluginName": "@formant/formant-cli",
|
|
656
606
|
"pluginType": "core",
|
|
657
607
|
"strict": true,
|
|
658
|
-
"summary": "
|
|
608
|
+
"summary": "List command templates",
|
|
659
609
|
"enableJsonFlag": true,
|
|
660
610
|
"isESM": true,
|
|
661
611
|
"relativePath": [
|
|
662
612
|
"dist",
|
|
663
613
|
"commands",
|
|
664
|
-
"
|
|
665
|
-
"
|
|
614
|
+
"command",
|
|
615
|
+
"list.js"
|
|
666
616
|
]
|
|
667
617
|
},
|
|
668
|
-
"
|
|
618
|
+
"command:send": {
|
|
669
619
|
"aliases": [],
|
|
670
620
|
"args": {
|
|
671
|
-
"
|
|
621
|
+
"deviceId": {
|
|
672
622
|
"description": "Device ID (UUID)",
|
|
673
|
-
"name": "
|
|
623
|
+
"name": "deviceId",
|
|
624
|
+
"required": true
|
|
625
|
+
},
|
|
626
|
+
"templateId": {
|
|
627
|
+
"description": "Command template ID (UUID)",
|
|
628
|
+
"name": "templateId",
|
|
674
629
|
"required": true
|
|
675
630
|
}
|
|
676
631
|
},
|
|
677
|
-
"description": "
|
|
632
|
+
"description": "Send a command to a device using a command template.\n\nFetches the template, validates parameters against its schema, and sends the command\nto the specified device. Use --param flags to override parameter values.\n\nFor templates with structured parameters (schema), parameter names and types are\nvalidated. For unstructured parameters, the raw value is sent as-is.\n\nUse --dry-run to preview the payload without actually sending.",
|
|
678
633
|
"examples": [
|
|
679
|
-
"<%= config.bin %>
|
|
680
|
-
"<%= config.bin %>
|
|
634
|
+
"<%= config.bin %> command send <device-id> <template-id>",
|
|
635
|
+
"<%= config.bin %> command send <device-id> <template-id> --param speed=5 --param mode=fast",
|
|
636
|
+
"<%= config.bin %> command send <device-id> <template-id> --dry-run",
|
|
637
|
+
"<%= config.bin %> command send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
|
|
638
|
+
"<%= config.bin %> command send <device-id> <template-id> --json"
|
|
681
639
|
],
|
|
682
640
|
"flags": {
|
|
683
641
|
"json": {
|
|
@@ -706,26 +664,47 @@
|
|
|
706
664
|
"name": "stage",
|
|
707
665
|
"allowNo": false,
|
|
708
666
|
"type": "boolean"
|
|
667
|
+
},
|
|
668
|
+
"dry-run": {
|
|
669
|
+
"description": "Preview the command payload without sending",
|
|
670
|
+
"name": "dry-run",
|
|
671
|
+
"allowNo": false,
|
|
672
|
+
"type": "boolean"
|
|
673
|
+
},
|
|
674
|
+
"param": {
|
|
675
|
+
"char": "p",
|
|
676
|
+
"description": "Parameter override (name=value), can be specified multiple times",
|
|
677
|
+
"name": "param",
|
|
678
|
+
"hasDynamicHelp": false,
|
|
679
|
+
"multiple": true,
|
|
680
|
+
"type": "option"
|
|
681
|
+
},
|
|
682
|
+
"raw-value": {
|
|
683
|
+
"description": "Send a raw parameter value string (bypasses schema validation)",
|
|
684
|
+
"name": "raw-value",
|
|
685
|
+
"hasDynamicHelp": false,
|
|
686
|
+
"multiple": false,
|
|
687
|
+
"type": "option"
|
|
709
688
|
}
|
|
710
689
|
},
|
|
711
690
|
"hasDynamicHelp": false,
|
|
712
691
|
"hiddenAliases": [],
|
|
713
|
-
"id": "
|
|
692
|
+
"id": "command:send",
|
|
714
693
|
"pluginAlias": "@formant/formant-cli",
|
|
715
694
|
"pluginName": "@formant/formant-cli",
|
|
716
695
|
"pluginType": "core",
|
|
717
696
|
"strict": true,
|
|
718
|
-
"summary": "
|
|
697
|
+
"summary": "Send a command to a device",
|
|
719
698
|
"enableJsonFlag": true,
|
|
720
699
|
"isESM": true,
|
|
721
700
|
"relativePath": [
|
|
722
701
|
"dist",
|
|
723
702
|
"commands",
|
|
724
|
-
"
|
|
725
|
-
"
|
|
703
|
+
"command",
|
|
704
|
+
"send.js"
|
|
726
705
|
]
|
|
727
706
|
},
|
|
728
|
-
"
|
|
707
|
+
"device:config": {
|
|
729
708
|
"aliases": [],
|
|
730
709
|
"args": {
|
|
731
710
|
"id": {
|
|
@@ -734,10 +713,10 @@
|
|
|
734
713
|
"required": true
|
|
735
714
|
}
|
|
736
715
|
},
|
|
737
|
-
"description": "Get
|
|
716
|
+
"description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
|
|
738
717
|
"examples": [
|
|
739
|
-
"<%= config.bin %>
|
|
740
|
-
"<%= config.bin %>
|
|
718
|
+
"<%= config.bin %> device config <device-id>",
|
|
719
|
+
"<%= config.bin %> device config <device-id> --json"
|
|
741
720
|
],
|
|
742
721
|
"flags": {
|
|
743
722
|
"json": {
|
|
@@ -770,31 +749,35 @@
|
|
|
770
749
|
},
|
|
771
750
|
"hasDynamicHelp": false,
|
|
772
751
|
"hiddenAliases": [],
|
|
773
|
-
"id": "
|
|
752
|
+
"id": "device:config",
|
|
774
753
|
"pluginAlias": "@formant/formant-cli",
|
|
775
754
|
"pluginName": "@formant/formant-cli",
|
|
776
755
|
"pluginType": "core",
|
|
777
756
|
"strict": true,
|
|
778
|
-
"summary": "Get device
|
|
757
|
+
"summary": "Get device configuration",
|
|
779
758
|
"enableJsonFlag": true,
|
|
780
759
|
"isESM": true,
|
|
781
760
|
"relativePath": [
|
|
782
761
|
"dist",
|
|
783
762
|
"commands",
|
|
784
|
-
"
|
|
785
|
-
"
|
|
763
|
+
"device",
|
|
764
|
+
"config.js"
|
|
786
765
|
]
|
|
787
766
|
},
|
|
788
|
-
"
|
|
767
|
+
"device:create": {
|
|
789
768
|
"aliases": [],
|
|
790
|
-
"args": {
|
|
791
|
-
|
|
769
|
+
"args": {
|
|
770
|
+
"name": {
|
|
771
|
+
"description": "Name for the new device",
|
|
772
|
+
"name": "name",
|
|
773
|
+
"required": true
|
|
774
|
+
}
|
|
775
|
+
},
|
|
776
|
+
"description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
|
|
792
777
|
"examples": [
|
|
793
|
-
"<%= config.bin %>
|
|
794
|
-
"<%= config.bin %>
|
|
795
|
-
"<%= config.bin %>
|
|
796
|
-
"<%= config.bin %> devices list --tag location=warehouse",
|
|
797
|
-
"<%= config.bin %> devices list --name robot --dev --json"
|
|
778
|
+
"<%= config.bin %> device create my-robot",
|
|
779
|
+
"<%= config.bin %> device create my-robot --tag location=warehouse --tag env=prod",
|
|
780
|
+
"<%= config.bin %> device create my-robot --json"
|
|
798
781
|
],
|
|
799
782
|
"flags": {
|
|
800
783
|
"json": {
|
|
@@ -824,33 +807,9 @@
|
|
|
824
807
|
"allowNo": false,
|
|
825
808
|
"type": "boolean"
|
|
826
809
|
},
|
|
827
|
-
"all": {
|
|
828
|
-
"char": "a",
|
|
829
|
-
"description": "Show all devices (online and offline)",
|
|
830
|
-
"name": "all",
|
|
831
|
-
"allowNo": false,
|
|
832
|
-
"type": "boolean"
|
|
833
|
-
},
|
|
834
|
-
"limit": {
|
|
835
|
-
"char": "l",
|
|
836
|
-
"description": "Maximum number of devices to return",
|
|
837
|
-
"name": "limit",
|
|
838
|
-
"default": 50,
|
|
839
|
-
"hasDynamicHelp": false,
|
|
840
|
-
"multiple": false,
|
|
841
|
-
"type": "option"
|
|
842
|
-
},
|
|
843
|
-
"name": {
|
|
844
|
-
"char": "n",
|
|
845
|
-
"description": "Filter devices by name (search)",
|
|
846
|
-
"name": "name",
|
|
847
|
-
"hasDynamicHelp": false,
|
|
848
|
-
"multiple": false,
|
|
849
|
-
"type": "option"
|
|
850
|
-
},
|
|
851
810
|
"tag": {
|
|
852
811
|
"char": "t",
|
|
853
|
-
"description": "
|
|
812
|
+
"description": "Tag to apply (key=value), can be specified multiple times",
|
|
854
813
|
"name": "tag",
|
|
855
814
|
"hasDynamicHelp": false,
|
|
856
815
|
"multiple": true,
|
|
@@ -859,39 +818,34 @@
|
|
|
859
818
|
},
|
|
860
819
|
"hasDynamicHelp": false,
|
|
861
820
|
"hiddenAliases": [],
|
|
862
|
-
"id": "
|
|
821
|
+
"id": "device:create",
|
|
863
822
|
"pluginAlias": "@formant/formant-cli",
|
|
864
823
|
"pluginName": "@formant/formant-cli",
|
|
865
824
|
"pluginType": "core",
|
|
866
825
|
"strict": true,
|
|
867
|
-
"summary": "
|
|
826
|
+
"summary": "Create a new device",
|
|
868
827
|
"enableJsonFlag": true,
|
|
869
828
|
"isESM": true,
|
|
870
829
|
"relativePath": [
|
|
871
830
|
"dist",
|
|
872
831
|
"commands",
|
|
873
|
-
"
|
|
874
|
-
"
|
|
832
|
+
"device",
|
|
833
|
+
"create.js"
|
|
875
834
|
]
|
|
876
835
|
},
|
|
877
|
-
"
|
|
836
|
+
"device:delete": {
|
|
878
837
|
"aliases": [],
|
|
879
838
|
"args": {
|
|
880
839
|
"id": {
|
|
881
840
|
"description": "Device ID (UUID)",
|
|
882
841
|
"name": "id",
|
|
883
842
|
"required": true
|
|
884
|
-
},
|
|
885
|
-
"name": {
|
|
886
|
-
"description": "New name for the device",
|
|
887
|
-
"name": "name",
|
|
888
|
-
"required": true
|
|
889
843
|
}
|
|
890
844
|
},
|
|
891
|
-
"description": "
|
|
845
|
+
"description": "Delete (disable) a device from your fleet.\n\nThis performs a soft-delete by disabling the device. The device and its telemetry\nhistory are preserved but it will no longer appear in device listings.",
|
|
892
846
|
"examples": [
|
|
893
|
-
"<%= config.bin %>
|
|
894
|
-
"<%= config.bin %>
|
|
847
|
+
"<%= config.bin %> device delete <device-id>",
|
|
848
|
+
"<%= config.bin %> device delete <device-id> --json"
|
|
895
849
|
],
|
|
896
850
|
"flags": {
|
|
897
851
|
"json": {
|
|
@@ -924,22 +878,22 @@
|
|
|
924
878
|
},
|
|
925
879
|
"hasDynamicHelp": false,
|
|
926
880
|
"hiddenAliases": [],
|
|
927
|
-
"id": "
|
|
881
|
+
"id": "device:delete",
|
|
928
882
|
"pluginAlias": "@formant/formant-cli",
|
|
929
883
|
"pluginName": "@formant/formant-cli",
|
|
930
884
|
"pluginType": "core",
|
|
931
885
|
"strict": true,
|
|
932
|
-
"summary": "
|
|
886
|
+
"summary": "Delete (disable) a device",
|
|
933
887
|
"enableJsonFlag": true,
|
|
934
888
|
"isESM": true,
|
|
935
889
|
"relativePath": [
|
|
936
890
|
"dist",
|
|
937
891
|
"commands",
|
|
938
|
-
"
|
|
939
|
-
"
|
|
892
|
+
"device",
|
|
893
|
+
"delete.js"
|
|
940
894
|
]
|
|
941
895
|
},
|
|
942
|
-
"
|
|
896
|
+
"device:get": {
|
|
943
897
|
"aliases": [],
|
|
944
898
|
"args": {
|
|
945
899
|
"id": {
|
|
@@ -948,11 +902,10 @@
|
|
|
948
902
|
"required": true
|
|
949
903
|
}
|
|
950
904
|
},
|
|
951
|
-
"description": "
|
|
905
|
+
"description": "Get detailed information about a specific device by its ID.",
|
|
952
906
|
"examples": [
|
|
953
|
-
"<%= config.bin %>
|
|
954
|
-
"<%= config.bin %>
|
|
955
|
-
"<%= config.bin %> devices streams <device-id> --days 30"
|
|
907
|
+
"<%= config.bin %> device get <device-id>",
|
|
908
|
+
"<%= config.bin %> device get <device-id> --json"
|
|
956
909
|
],
|
|
957
910
|
"flags": {
|
|
958
911
|
"json": {
|
|
@@ -981,47 +934,37 @@
|
|
|
981
934
|
"name": "stage",
|
|
982
935
|
"allowNo": false,
|
|
983
936
|
"type": "boolean"
|
|
984
|
-
},
|
|
985
|
-
"days": {
|
|
986
|
-
"description": "How many days back to look for unconfigured streams in ingested data",
|
|
987
|
-
"name": "days",
|
|
988
|
-
"default": 14,
|
|
989
|
-
"hasDynamicHelp": false,
|
|
990
|
-
"multiple": false,
|
|
991
|
-
"type": "option"
|
|
992
937
|
}
|
|
993
938
|
},
|
|
994
939
|
"hasDynamicHelp": false,
|
|
995
940
|
"hiddenAliases": [],
|
|
996
|
-
"id": "
|
|
941
|
+
"id": "device:get",
|
|
997
942
|
"pluginAlias": "@formant/formant-cli",
|
|
998
943
|
"pluginName": "@formant/formant-cli",
|
|
999
944
|
"pluginType": "core",
|
|
1000
945
|
"strict": true,
|
|
1001
|
-
"summary": "
|
|
946
|
+
"summary": "Get a device by ID",
|
|
1002
947
|
"enableJsonFlag": true,
|
|
1003
948
|
"isESM": true,
|
|
1004
949
|
"relativePath": [
|
|
1005
950
|
"dist",
|
|
1006
951
|
"commands",
|
|
1007
|
-
"
|
|
1008
|
-
"
|
|
952
|
+
"device",
|
|
953
|
+
"get.js"
|
|
1009
954
|
]
|
|
1010
955
|
},
|
|
1011
|
-
"
|
|
956
|
+
"device:list": {
|
|
1012
957
|
"aliases": [],
|
|
1013
|
-
"args": {
|
|
1014
|
-
|
|
1015
|
-
"description": "Device ID (UUID)",
|
|
1016
|
-
"name": "id",
|
|
1017
|
-
"required": true
|
|
1018
|
-
}
|
|
1019
|
-
},
|
|
1020
|
-
"description": "Add or update tags on a device.\n\nTags are key-value pairs. If a tag key already exists, its value will be updated.\nSpecify one or more tags with --tag key=value.",
|
|
958
|
+
"args": {},
|
|
959
|
+
"description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --include-offline to include offline devices. Use --with-data to show only\ndevices that have ingested data. Each device is enriched with data-based last\nseen timestamp and datapoint count from analytics.",
|
|
1021
960
|
"examples": [
|
|
1022
|
-
"<%= config.bin %>
|
|
1023
|
-
"<%= config.bin %>
|
|
1024
|
-
"<%= config.bin %>
|
|
961
|
+
"<%= config.bin %> device list",
|
|
962
|
+
"<%= config.bin %> device list --include-offline",
|
|
963
|
+
"<%= config.bin %> device list --with-data",
|
|
964
|
+
"<%= config.bin %> device list --with-data --days 90",
|
|
965
|
+
"<%= config.bin %> device list --include-offline --limit 100",
|
|
966
|
+
"<%= config.bin %> device list --tag location=warehouse",
|
|
967
|
+
"<%= config.bin %> device list --name robot --dev --json"
|
|
1025
968
|
],
|
|
1026
969
|
"flags": {
|
|
1027
970
|
"json": {
|
|
@@ -1051,11 +994,49 @@
|
|
|
1051
994
|
"allowNo": false,
|
|
1052
995
|
"type": "boolean"
|
|
1053
996
|
},
|
|
997
|
+
"include-offline": {
|
|
998
|
+
"char": "a",
|
|
999
|
+
"description": "Include offline devices",
|
|
1000
|
+
"name": "include-offline",
|
|
1001
|
+
"allowNo": false,
|
|
1002
|
+
"type": "boolean"
|
|
1003
|
+
},
|
|
1004
|
+
"days": {
|
|
1005
|
+
"description": "How many days back to search for last seen data",
|
|
1006
|
+
"name": "days",
|
|
1007
|
+
"default": 30,
|
|
1008
|
+
"hasDynamicHelp": false,
|
|
1009
|
+
"multiple": false,
|
|
1010
|
+
"type": "option"
|
|
1011
|
+
},
|
|
1012
|
+
"limit": {
|
|
1013
|
+
"char": "l",
|
|
1014
|
+
"description": "Maximum number of devices to return",
|
|
1015
|
+
"name": "limit",
|
|
1016
|
+
"default": 50,
|
|
1017
|
+
"hasDynamicHelp": false,
|
|
1018
|
+
"multiple": false,
|
|
1019
|
+
"type": "option"
|
|
1020
|
+
},
|
|
1021
|
+
"name": {
|
|
1022
|
+
"char": "n",
|
|
1023
|
+
"description": "Filter devices by name (search)",
|
|
1024
|
+
"name": "name",
|
|
1025
|
+
"hasDynamicHelp": false,
|
|
1026
|
+
"multiple": false,
|
|
1027
|
+
"type": "option"
|
|
1028
|
+
},
|
|
1029
|
+
"with-data": {
|
|
1030
|
+
"char": "w",
|
|
1031
|
+
"description": "Only show devices that have data in the last --days window",
|
|
1032
|
+
"name": "with-data",
|
|
1033
|
+
"allowNo": false,
|
|
1034
|
+
"type": "boolean"
|
|
1035
|
+
},
|
|
1054
1036
|
"tag": {
|
|
1055
1037
|
"char": "t",
|
|
1056
|
-
"description": "
|
|
1038
|
+
"description": "Filter by tag (key=value), can be specified multiple times",
|
|
1057
1039
|
"name": "tag",
|
|
1058
|
-
"required": true,
|
|
1059
1040
|
"hasDynamicHelp": false,
|
|
1060
1041
|
"multiple": true,
|
|
1061
1042
|
"type": "option"
|
|
@@ -1063,35 +1044,101 @@
|
|
|
1063
1044
|
},
|
|
1064
1045
|
"hasDynamicHelp": false,
|
|
1065
1046
|
"hiddenAliases": [],
|
|
1066
|
-
"id": "
|
|
1047
|
+
"id": "device:list",
|
|
1067
1048
|
"pluginAlias": "@formant/formant-cli",
|
|
1068
1049
|
"pluginName": "@formant/formant-cli",
|
|
1069
1050
|
"pluginType": "core",
|
|
1070
1051
|
"strict": true,
|
|
1071
|
-
"summary": "
|
|
1052
|
+
"summary": "List robots and sensors in your fleet",
|
|
1072
1053
|
"enableJsonFlag": true,
|
|
1073
1054
|
"isESM": true,
|
|
1074
1055
|
"relativePath": [
|
|
1075
1056
|
"dist",
|
|
1076
1057
|
"commands",
|
|
1077
|
-
"
|
|
1078
|
-
"
|
|
1058
|
+
"device",
|
|
1059
|
+
"list.js"
|
|
1079
1060
|
]
|
|
1080
1061
|
},
|
|
1081
|
-
"
|
|
1062
|
+
"device:rename": {
|
|
1082
1063
|
"aliases": [],
|
|
1083
1064
|
"args": {
|
|
1084
1065
|
"id": {
|
|
1085
1066
|
"description": "Device ID (UUID)",
|
|
1086
1067
|
"name": "id",
|
|
1087
1068
|
"required": true
|
|
1069
|
+
},
|
|
1070
|
+
"name": {
|
|
1071
|
+
"description": "New name for the device",
|
|
1072
|
+
"name": "name",
|
|
1073
|
+
"required": true
|
|
1088
1074
|
}
|
|
1089
1075
|
},
|
|
1090
|
-
"description": "
|
|
1076
|
+
"description": "Rename a device by updating its name.",
|
|
1077
|
+
"examples": [
|
|
1078
|
+
"<%= config.bin %> device rename <device-id> new-robot-name",
|
|
1079
|
+
"<%= config.bin %> device rename <device-id> new-robot-name --json"
|
|
1080
|
+
],
|
|
1081
|
+
"flags": {
|
|
1082
|
+
"json": {
|
|
1083
|
+
"description": "Format output as json.",
|
|
1084
|
+
"helpGroup": "GLOBAL",
|
|
1085
|
+
"name": "json",
|
|
1086
|
+
"allowNo": false,
|
|
1087
|
+
"type": "boolean"
|
|
1088
|
+
},
|
|
1089
|
+
"dev": {
|
|
1090
|
+
"description": "Target the dev environment",
|
|
1091
|
+
"exclusive": [
|
|
1092
|
+
"stage"
|
|
1093
|
+
],
|
|
1094
|
+
"helpGroup": "GLOBAL",
|
|
1095
|
+
"name": "dev",
|
|
1096
|
+
"allowNo": false,
|
|
1097
|
+
"type": "boolean"
|
|
1098
|
+
},
|
|
1099
|
+
"stage": {
|
|
1100
|
+
"description": "Target the stage environment",
|
|
1101
|
+
"exclusive": [
|
|
1102
|
+
"dev"
|
|
1103
|
+
],
|
|
1104
|
+
"helpGroup": "GLOBAL",
|
|
1105
|
+
"name": "stage",
|
|
1106
|
+
"allowNo": false,
|
|
1107
|
+
"type": "boolean"
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
"hasDynamicHelp": false,
|
|
1111
|
+
"hiddenAliases": [],
|
|
1112
|
+
"id": "device:rename",
|
|
1113
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1114
|
+
"pluginName": "@formant/formant-cli",
|
|
1115
|
+
"pluginType": "core",
|
|
1116
|
+
"strict": true,
|
|
1117
|
+
"summary": "Rename a device",
|
|
1118
|
+
"enableJsonFlag": true,
|
|
1119
|
+
"isESM": true,
|
|
1120
|
+
"relativePath": [
|
|
1121
|
+
"dist",
|
|
1122
|
+
"commands",
|
|
1123
|
+
"device",
|
|
1124
|
+
"rename.js"
|
|
1125
|
+
]
|
|
1126
|
+
},
|
|
1127
|
+
"device:streams": {
|
|
1128
|
+
"aliases": [],
|
|
1129
|
+
"args": {
|
|
1130
|
+
"id": {
|
|
1131
|
+
"description": "Device ID (UUID)",
|
|
1132
|
+
"name": "id",
|
|
1133
|
+
"required": true
|
|
1134
|
+
}
|
|
1135
|
+
},
|
|
1136
|
+
"description": "List telemetry streams for a device with data presence.\n\nShows streams from the device configuration and any streams discovered from\ningested data. Each stream is enriched with presence info from the analytics\nbackend: data point count, last seen time, and a freshness indicator\n(active/recent/stale/dormant).\n\nUnconfigured streams (discovered from data only) are marked with SOURCE \"data\".",
|
|
1091
1137
|
"examples": [
|
|
1092
|
-
"<%= config.bin %>
|
|
1093
|
-
"<%= config.bin %>
|
|
1094
|
-
"<%= config.bin %>
|
|
1138
|
+
"<%= config.bin %> device streams <device-id>",
|
|
1139
|
+
"<%= config.bin %> device streams <device-id> --with-data",
|
|
1140
|
+
"<%= config.bin %> device streams <device-id> --with-data --days 30",
|
|
1141
|
+
"<%= config.bin %> device streams <device-id> --json"
|
|
1095
1142
|
],
|
|
1096
1143
|
"flags": {
|
|
1097
1144
|
"json": {
|
|
@@ -1121,46 +1168,53 @@
|
|
|
1121
1168
|
"allowNo": false,
|
|
1122
1169
|
"type": "boolean"
|
|
1123
1170
|
},
|
|
1124
|
-
"
|
|
1125
|
-
"
|
|
1126
|
-
"
|
|
1127
|
-
"
|
|
1128
|
-
"required": true,
|
|
1171
|
+
"days": {
|
|
1172
|
+
"description": "How many days back to look for stream data presence",
|
|
1173
|
+
"name": "days",
|
|
1174
|
+
"default": 7,
|
|
1129
1175
|
"hasDynamicHelp": false,
|
|
1130
|
-
"multiple":
|
|
1176
|
+
"multiple": false,
|
|
1131
1177
|
"type": "option"
|
|
1178
|
+
},
|
|
1179
|
+
"with-data": {
|
|
1180
|
+
"char": "w",
|
|
1181
|
+
"description": "Only show streams that have data in the --days window",
|
|
1182
|
+
"name": "with-data",
|
|
1183
|
+
"allowNo": false,
|
|
1184
|
+
"type": "boolean"
|
|
1132
1185
|
}
|
|
1133
1186
|
},
|
|
1134
1187
|
"hasDynamicHelp": false,
|
|
1135
1188
|
"hiddenAliases": [],
|
|
1136
|
-
"id": "
|
|
1189
|
+
"id": "device:streams",
|
|
1137
1190
|
"pluginAlias": "@formant/formant-cli",
|
|
1138
1191
|
"pluginName": "@formant/formant-cli",
|
|
1139
1192
|
"pluginType": "core",
|
|
1140
1193
|
"strict": true,
|
|
1141
|
-
"summary": "
|
|
1194
|
+
"summary": "List device streams with data presence",
|
|
1142
1195
|
"enableJsonFlag": true,
|
|
1143
1196
|
"isESM": true,
|
|
1144
1197
|
"relativePath": [
|
|
1145
1198
|
"dist",
|
|
1146
1199
|
"commands",
|
|
1147
|
-
"
|
|
1148
|
-
"
|
|
1200
|
+
"device",
|
|
1201
|
+
"streams.js"
|
|
1149
1202
|
]
|
|
1150
1203
|
},
|
|
1151
|
-
"
|
|
1204
|
+
"device:tag": {
|
|
1152
1205
|
"aliases": [],
|
|
1153
1206
|
"args": {
|
|
1154
1207
|
"id": {
|
|
1155
|
-
"description": "
|
|
1208
|
+
"description": "Device ID (UUID)",
|
|
1156
1209
|
"name": "id",
|
|
1157
1210
|
"required": true
|
|
1158
1211
|
}
|
|
1159
1212
|
},
|
|
1160
|
-
"description": "
|
|
1213
|
+
"description": "Add or update tags on a device.\n\nTags are key-value pairs. If a tag key already exists, its value will be updated.\nSpecify one or more tags with --tag key=value.",
|
|
1161
1214
|
"examples": [
|
|
1162
|
-
"<%= config.bin %>
|
|
1163
|
-
"<%= config.bin %>
|
|
1215
|
+
"<%= config.bin %> device tag <device-id> --tag location=warehouse",
|
|
1216
|
+
"<%= config.bin %> device tag <device-id> --tag env=prod --tag region=us-east",
|
|
1217
|
+
"<%= config.bin %> device tag <device-id> --tag location=factory --json"
|
|
1164
1218
|
],
|
|
1165
1219
|
"flags": {
|
|
1166
1220
|
"json": {
|
|
@@ -1189,32 +1243,48 @@
|
|
|
1189
1243
|
"name": "stage",
|
|
1190
1244
|
"allowNo": false,
|
|
1191
1245
|
"type": "boolean"
|
|
1246
|
+
},
|
|
1247
|
+
"tag": {
|
|
1248
|
+
"char": "t",
|
|
1249
|
+
"description": "Tag to add or update (key=value), can be specified multiple times",
|
|
1250
|
+
"name": "tag",
|
|
1251
|
+
"required": true,
|
|
1252
|
+
"hasDynamicHelp": false,
|
|
1253
|
+
"multiple": true,
|
|
1254
|
+
"type": "option"
|
|
1192
1255
|
}
|
|
1193
1256
|
},
|
|
1194
1257
|
"hasDynamicHelp": false,
|
|
1195
1258
|
"hiddenAliases": [],
|
|
1196
|
-
"id": "
|
|
1259
|
+
"id": "device:tag",
|
|
1197
1260
|
"pluginAlias": "@formant/formant-cli",
|
|
1198
1261
|
"pluginName": "@formant/formant-cli",
|
|
1199
1262
|
"pluginType": "core",
|
|
1200
1263
|
"strict": true,
|
|
1201
|
-
"summary": "
|
|
1264
|
+
"summary": "Add or update tags on a device",
|
|
1202
1265
|
"enableJsonFlag": true,
|
|
1203
1266
|
"isESM": true,
|
|
1204
1267
|
"relativePath": [
|
|
1205
1268
|
"dist",
|
|
1206
1269
|
"commands",
|
|
1207
|
-
"
|
|
1208
|
-
"
|
|
1270
|
+
"device",
|
|
1271
|
+
"tag.js"
|
|
1209
1272
|
]
|
|
1210
1273
|
},
|
|
1211
|
-
"
|
|
1274
|
+
"device:untag": {
|
|
1212
1275
|
"aliases": [],
|
|
1213
|
-
"args": {
|
|
1214
|
-
|
|
1276
|
+
"args": {
|
|
1277
|
+
"id": {
|
|
1278
|
+
"description": "Device ID (UUID)",
|
|
1279
|
+
"name": "id",
|
|
1280
|
+
"required": true
|
|
1281
|
+
}
|
|
1282
|
+
},
|
|
1283
|
+
"description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.",
|
|
1215
1284
|
"examples": [
|
|
1216
|
-
"<%= config.bin %>
|
|
1217
|
-
"<%= config.bin %>
|
|
1285
|
+
"<%= config.bin %> device untag <device-id> --key location",
|
|
1286
|
+
"<%= config.bin %> device untag <device-id> --key env --key region",
|
|
1287
|
+
"<%= config.bin %> device untag <device-id> --key location --json"
|
|
1218
1288
|
],
|
|
1219
1289
|
"flags": {
|
|
1220
1290
|
"json": {
|
|
@@ -1243,26 +1313,35 @@
|
|
|
1243
1313
|
"name": "stage",
|
|
1244
1314
|
"allowNo": false,
|
|
1245
1315
|
"type": "boolean"
|
|
1316
|
+
},
|
|
1317
|
+
"key": {
|
|
1318
|
+
"char": "k",
|
|
1319
|
+
"description": "Tag key to remove, can be specified multiple times",
|
|
1320
|
+
"name": "key",
|
|
1321
|
+
"required": true,
|
|
1322
|
+
"hasDynamicHelp": false,
|
|
1323
|
+
"multiple": true,
|
|
1324
|
+
"type": "option"
|
|
1246
1325
|
}
|
|
1247
1326
|
},
|
|
1248
1327
|
"hasDynamicHelp": false,
|
|
1249
1328
|
"hiddenAliases": [],
|
|
1250
|
-
"id": "
|
|
1329
|
+
"id": "device:untag",
|
|
1251
1330
|
"pluginAlias": "@formant/formant-cli",
|
|
1252
1331
|
"pluginName": "@formant/formant-cli",
|
|
1253
1332
|
"pluginType": "core",
|
|
1254
1333
|
"strict": true,
|
|
1255
|
-
"summary": "
|
|
1334
|
+
"summary": "Remove tags from a device",
|
|
1256
1335
|
"enableJsonFlag": true,
|
|
1257
1336
|
"isESM": true,
|
|
1258
1337
|
"relativePath": [
|
|
1259
1338
|
"dist",
|
|
1260
1339
|
"commands",
|
|
1261
|
-
"
|
|
1262
|
-
"
|
|
1340
|
+
"device",
|
|
1341
|
+
"untag.js"
|
|
1263
1342
|
]
|
|
1264
1343
|
},
|
|
1265
|
-
"
|
|
1344
|
+
"event:get": {
|
|
1266
1345
|
"aliases": [],
|
|
1267
1346
|
"args": {
|
|
1268
1347
|
"id": {
|
|
@@ -1273,8 +1352,8 @@
|
|
|
1273
1352
|
},
|
|
1274
1353
|
"description": "Get detailed information about a specific event by its ID.",
|
|
1275
1354
|
"examples": [
|
|
1276
|
-
"<%= config.bin %>
|
|
1277
|
-
"<%= config.bin %>
|
|
1355
|
+
"<%= config.bin %> event get <event-id>",
|
|
1356
|
+
"<%= config.bin %> event get <event-id> --json"
|
|
1278
1357
|
],
|
|
1279
1358
|
"flags": {
|
|
1280
1359
|
"json": {
|
|
@@ -1307,7 +1386,7 @@
|
|
|
1307
1386
|
},
|
|
1308
1387
|
"hasDynamicHelp": false,
|
|
1309
1388
|
"hiddenAliases": [],
|
|
1310
|
-
"id": "
|
|
1389
|
+
"id": "event:get",
|
|
1311
1390
|
"pluginAlias": "@formant/formant-cli",
|
|
1312
1391
|
"pluginName": "@formant/formant-cli",
|
|
1313
1392
|
"pluginType": "core",
|
|
@@ -1318,19 +1397,19 @@
|
|
|
1318
1397
|
"relativePath": [
|
|
1319
1398
|
"dist",
|
|
1320
1399
|
"commands",
|
|
1321
|
-
"
|
|
1400
|
+
"event",
|
|
1322
1401
|
"get.js"
|
|
1323
1402
|
]
|
|
1324
1403
|
},
|
|
1325
|
-
"
|
|
1404
|
+
"event:list": {
|
|
1326
1405
|
"aliases": [],
|
|
1327
1406
|
"args": {},
|
|
1328
1407
|
"description": "View important events emitted by devices with optional filters.\n\nEvents are significant occurrences from robots and sensors (e.g., device online/offline,\nerrors, state changes, commands). They can trigger signals for investigation.\n\nEvent types include: triggered-event, datapoint-event, device-online, device-offline,\nintervention-request, intervention-response, teleop-session-record, command-request,\ncommand-response, custom, comment, system, annotation, task-summary, stateful.\n\nSeverities: info, warning, error, critical.",
|
|
1329
1408
|
"examples": [
|
|
1330
|
-
"<%= config.bin %>
|
|
1331
|
-
"<%= config.bin %>
|
|
1332
|
-
"<%= config.bin %>
|
|
1333
|
-
"<%= config.bin %>
|
|
1409
|
+
"<%= config.bin %> event list",
|
|
1410
|
+
"<%= config.bin %> event list --device <id> --severity critical",
|
|
1411
|
+
"<%= config.bin %> event list --type device-offline --start 2026-01-01 --end 2026-01-02",
|
|
1412
|
+
"<%= config.bin %> event list --limit 100 --json"
|
|
1334
1413
|
],
|
|
1335
1414
|
"flags": {
|
|
1336
1415
|
"json": {
|
|
@@ -1414,7 +1493,7 @@
|
|
|
1414
1493
|
},
|
|
1415
1494
|
"hasDynamicHelp": false,
|
|
1416
1495
|
"hiddenAliases": [],
|
|
1417
|
-
"id": "
|
|
1496
|
+
"id": "event:list",
|
|
1418
1497
|
"pluginAlias": "@formant/formant-cli",
|
|
1419
1498
|
"pluginName": "@formant/formant-cli",
|
|
1420
1499
|
"pluginType": "core",
|
|
@@ -1425,19 +1504,17 @@
|
|
|
1425
1504
|
"relativePath": [
|
|
1426
1505
|
"dist",
|
|
1427
1506
|
"commands",
|
|
1428
|
-
"
|
|
1507
|
+
"event",
|
|
1429
1508
|
"list.js"
|
|
1430
1509
|
]
|
|
1431
1510
|
},
|
|
1432
|
-
"
|
|
1511
|
+
"org:get": {
|
|
1433
1512
|
"aliases": [],
|
|
1434
1513
|
"args": {},
|
|
1435
|
-
"description": "
|
|
1514
|
+
"description": "Get information about your organization.\n\nDisplays the organization associated with your authenticated account.\nNo ID is needed — it is resolved automatically from your credentials.",
|
|
1436
1515
|
"examples": [
|
|
1437
|
-
"<%= config.bin %>
|
|
1438
|
-
"<%= config.bin %>
|
|
1439
|
-
"cat payload.json | <%= config.bin %> ingest batch --stdin",
|
|
1440
|
-
"# Example payload.json with multiple types:\n{\n \"items\": [\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"battery_level\",\n \"type\": \"numeric\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, 42.5], [1708272060000, 41.8]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"status\",\n \"type\": \"text\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, \"operational\"]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"health\",\n \"type\": \"health\",\n \"tags\": {},\n \"points\": [[1708272000000, {\"status\": \"operational\"}]]\n }\n ]\n}"
|
|
1516
|
+
"<%= config.bin %> org get",
|
|
1517
|
+
"<%= config.bin %> org get --json"
|
|
1441
1518
|
],
|
|
1442
1519
|
"flags": {
|
|
1443
1520
|
"json": {
|
|
@@ -1466,53 +1543,34 @@
|
|
|
1466
1543
|
"name": "stage",
|
|
1467
1544
|
"allowNo": false,
|
|
1468
1545
|
"type": "boolean"
|
|
1469
|
-
},
|
|
1470
|
-
"file": {
|
|
1471
|
-
"char": "f",
|
|
1472
|
-
"description": "Path to JSON file containing batch payload",
|
|
1473
|
-
"exclusive": [
|
|
1474
|
-
"stdin"
|
|
1475
|
-
],
|
|
1476
|
-
"name": "file",
|
|
1477
|
-
"hasDynamicHelp": false,
|
|
1478
|
-
"multiple": false,
|
|
1479
|
-
"type": "option"
|
|
1480
|
-
},
|
|
1481
|
-
"stdin": {
|
|
1482
|
-
"description": "Read JSON payload from stdin",
|
|
1483
|
-
"exclusive": [
|
|
1484
|
-
"file"
|
|
1485
|
-
],
|
|
1486
|
-
"name": "stdin",
|
|
1487
|
-
"allowNo": false,
|
|
1488
|
-
"type": "boolean"
|
|
1489
1546
|
}
|
|
1490
1547
|
},
|
|
1491
1548
|
"hasDynamicHelp": false,
|
|
1492
1549
|
"hiddenAliases": [],
|
|
1493
|
-
"id": "
|
|
1550
|
+
"id": "org:get",
|
|
1494
1551
|
"pluginAlias": "@formant/formant-cli",
|
|
1495
1552
|
"pluginName": "@formant/formant-cli",
|
|
1496
1553
|
"pluginType": "core",
|
|
1497
1554
|
"strict": true,
|
|
1498
|
-
"summary": "
|
|
1555
|
+
"summary": "Get your organization",
|
|
1499
1556
|
"enableJsonFlag": true,
|
|
1500
1557
|
"isESM": true,
|
|
1501
1558
|
"relativePath": [
|
|
1502
1559
|
"dist",
|
|
1503
1560
|
"commands",
|
|
1504
|
-
"
|
|
1505
|
-
"
|
|
1561
|
+
"org",
|
|
1562
|
+
"get.js"
|
|
1506
1563
|
]
|
|
1507
1564
|
},
|
|
1508
|
-
"
|
|
1565
|
+
"org:update": {
|
|
1509
1566
|
"aliases": [],
|
|
1510
1567
|
"args": {},
|
|
1511
|
-
"description": "
|
|
1568
|
+
"description": "Update your organization's details.\n\nAt least one of --name or --description must be provided.",
|
|
1512
1569
|
"examples": [
|
|
1513
|
-
"<%= config.bin %>
|
|
1514
|
-
"<%= config.bin %>
|
|
1515
|
-
"<%= config.bin %>
|
|
1570
|
+
"<%= config.bin %> org update --name \"My Fleet\"",
|
|
1571
|
+
"<%= config.bin %> org update --description \"Production robot fleet\"",
|
|
1572
|
+
"<%= config.bin %> org update --name \"My Fleet\" --description \"Production robot fleet\"",
|
|
1573
|
+
"<%= config.bin %> org update --name \"My Fleet\" --json"
|
|
1516
1574
|
],
|
|
1517
1575
|
"flags": {
|
|
1518
1576
|
"json": {
|
|
@@ -1542,53 +1600,18 @@
|
|
|
1542
1600
|
"allowNo": false,
|
|
1543
1601
|
"type": "boolean"
|
|
1544
1602
|
},
|
|
1545
|
-
"
|
|
1603
|
+
"description": {
|
|
1546
1604
|
"char": "d",
|
|
1547
|
-
"description": "
|
|
1548
|
-
"name": "
|
|
1549
|
-
"required": true,
|
|
1550
|
-
"hasDynamicHelp": false,
|
|
1551
|
-
"multiple": false,
|
|
1552
|
-
"type": "option"
|
|
1553
|
-
},
|
|
1554
|
-
"stream": {
|
|
1555
|
-
"char": "s",
|
|
1556
|
-
"description": "Stream name",
|
|
1557
|
-
"name": "stream",
|
|
1558
|
-
"required": true,
|
|
1559
|
-
"hasDynamicHelp": false,
|
|
1560
|
-
"multiple": false,
|
|
1561
|
-
"type": "option"
|
|
1562
|
-
},
|
|
1563
|
-
"keys": {
|
|
1564
|
-
"char": "k",
|
|
1565
|
-
"description": "Comma-separated list of key names (1-1000 keys, max 255 chars each)",
|
|
1566
|
-
"name": "keys",
|
|
1567
|
-
"required": true,
|
|
1568
|
-
"hasDynamicHelp": false,
|
|
1569
|
-
"multiple": false,
|
|
1570
|
-
"type": "option"
|
|
1571
|
-
},
|
|
1572
|
-
"values": {
|
|
1573
|
-
"char": "v",
|
|
1574
|
-
"description": "Comma-separated list of boolean values (true/false, must match key count)",
|
|
1575
|
-
"name": "values",
|
|
1576
|
-
"required": true,
|
|
1605
|
+
"description": "New description for the organization",
|
|
1606
|
+
"name": "description",
|
|
1577
1607
|
"hasDynamicHelp": false,
|
|
1578
1608
|
"multiple": false,
|
|
1579
1609
|
"type": "option"
|
|
1580
1610
|
},
|
|
1581
|
-
"
|
|
1582
|
-
"char": "
|
|
1583
|
-
"description": "
|
|
1584
|
-
"name": "
|
|
1585
|
-
"hasDynamicHelp": false,
|
|
1586
|
-
"multiple": true,
|
|
1587
|
-
"type": "option"
|
|
1588
|
-
},
|
|
1589
|
-
"timestamp": {
|
|
1590
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1591
|
-
"name": "timestamp",
|
|
1611
|
+
"name": {
|
|
1612
|
+
"char": "n",
|
|
1613
|
+
"description": "New name for the organization",
|
|
1614
|
+
"name": "name",
|
|
1592
1615
|
"hasDynamicHelp": false,
|
|
1593
1616
|
"multiple": false,
|
|
1594
1617
|
"type": "option"
|
|
@@ -1596,29 +1619,34 @@
|
|
|
1596
1619
|
},
|
|
1597
1620
|
"hasDynamicHelp": false,
|
|
1598
1621
|
"hiddenAliases": [],
|
|
1599
|
-
"id": "
|
|
1622
|
+
"id": "org:update",
|
|
1600
1623
|
"pluginAlias": "@formant/formant-cli",
|
|
1601
1624
|
"pluginName": "@formant/formant-cli",
|
|
1602
1625
|
"pluginType": "core",
|
|
1603
1626
|
"strict": true,
|
|
1604
|
-
"summary": "
|
|
1627
|
+
"summary": "Update your organization",
|
|
1605
1628
|
"enableJsonFlag": true,
|
|
1606
1629
|
"isESM": true,
|
|
1607
1630
|
"relativePath": [
|
|
1608
1631
|
"dist",
|
|
1609
1632
|
"commands",
|
|
1610
|
-
"
|
|
1611
|
-
"
|
|
1633
|
+
"org",
|
|
1634
|
+
"update.js"
|
|
1612
1635
|
]
|
|
1613
1636
|
},
|
|
1614
|
-
"
|
|
1637
|
+
"kv:get": {
|
|
1615
1638
|
"aliases": [],
|
|
1616
|
-
"args": {
|
|
1617
|
-
|
|
1639
|
+
"args": {
|
|
1640
|
+
"key": {
|
|
1641
|
+
"description": "Key to retrieve",
|
|
1642
|
+
"name": "key",
|
|
1643
|
+
"required": true
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
1618
1647
|
"examples": [
|
|
1619
|
-
"<%= config.bin %>
|
|
1620
|
-
"<%= config.bin %>
|
|
1621
|
-
"<%= config.bin %> ingest health --device <device-id> --stream sync --status operational --clock-skew 150"
|
|
1648
|
+
"<%= config.bin %> kv get my-key",
|
|
1649
|
+
"<%= config.bin %> kv get my-key --json"
|
|
1622
1650
|
],
|
|
1623
1651
|
"flags": {
|
|
1624
1652
|
"json": {
|
|
@@ -1647,87 +1675,34 @@
|
|
|
1647
1675
|
"name": "stage",
|
|
1648
1676
|
"allowNo": false,
|
|
1649
1677
|
"type": "boolean"
|
|
1650
|
-
},
|
|
1651
|
-
"device": {
|
|
1652
|
-
"char": "d",
|
|
1653
|
-
"description": "Device ID (UUID)",
|
|
1654
|
-
"name": "device",
|
|
1655
|
-
"required": true,
|
|
1656
|
-
"hasDynamicHelp": false,
|
|
1657
|
-
"multiple": false,
|
|
1658
|
-
"type": "option"
|
|
1659
|
-
},
|
|
1660
|
-
"stream": {
|
|
1661
|
-
"char": "s",
|
|
1662
|
-
"description": "Stream name",
|
|
1663
|
-
"name": "stream",
|
|
1664
|
-
"required": true,
|
|
1665
|
-
"hasDynamicHelp": false,
|
|
1666
|
-
"multiple": false,
|
|
1667
|
-
"type": "option"
|
|
1668
|
-
},
|
|
1669
|
-
"status": {
|
|
1670
|
-
"description": "Health status (unknown, operational, offline, or error)",
|
|
1671
|
-
"name": "status",
|
|
1672
|
-
"required": true,
|
|
1673
|
-
"hasDynamicHelp": false,
|
|
1674
|
-
"multiple": false,
|
|
1675
|
-
"options": [
|
|
1676
|
-
"unknown",
|
|
1677
|
-
"operational",
|
|
1678
|
-
"offline",
|
|
1679
|
-
"error"
|
|
1680
|
-
],
|
|
1681
|
-
"type": "option"
|
|
1682
|
-
},
|
|
1683
|
-
"clock-skew": {
|
|
1684
|
-
"description": "Clock skew in milliseconds (optional)",
|
|
1685
|
-
"name": "clock-skew",
|
|
1686
|
-
"hasDynamicHelp": false,
|
|
1687
|
-
"multiple": false,
|
|
1688
|
-
"type": "option"
|
|
1689
|
-
},
|
|
1690
|
-
"tag": {
|
|
1691
|
-
"char": "t",
|
|
1692
|
-
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1693
|
-
"name": "tag",
|
|
1694
|
-
"hasDynamicHelp": false,
|
|
1695
|
-
"multiple": true,
|
|
1696
|
-
"type": "option"
|
|
1697
|
-
},
|
|
1698
|
-
"timestamp": {
|
|
1699
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1700
|
-
"name": "timestamp",
|
|
1701
|
-
"hasDynamicHelp": false,
|
|
1702
|
-
"multiple": false,
|
|
1703
|
-
"type": "option"
|
|
1704
1678
|
}
|
|
1705
1679
|
},
|
|
1706
1680
|
"hasDynamicHelp": false,
|
|
1707
1681
|
"hiddenAliases": [],
|
|
1708
|
-
"id": "
|
|
1682
|
+
"id": "kv:get",
|
|
1709
1683
|
"pluginAlias": "@formant/formant-cli",
|
|
1710
1684
|
"pluginName": "@formant/formant-cli",
|
|
1711
1685
|
"pluginType": "core",
|
|
1712
1686
|
"strict": true,
|
|
1713
|
-
"summary": "
|
|
1687
|
+
"summary": "Get key-value",
|
|
1714
1688
|
"enableJsonFlag": true,
|
|
1715
1689
|
"isESM": true,
|
|
1716
1690
|
"relativePath": [
|
|
1717
1691
|
"dist",
|
|
1718
1692
|
"commands",
|
|
1719
|
-
"
|
|
1720
|
-
"
|
|
1693
|
+
"kv",
|
|
1694
|
+
"get.js"
|
|
1721
1695
|
]
|
|
1722
1696
|
},
|
|
1723
|
-
"
|
|
1697
|
+
"kv:list": {
|
|
1724
1698
|
"aliases": [],
|
|
1725
1699
|
"args": {},
|
|
1726
|
-
"description": "
|
|
1700
|
+
"description": "List all keys in the key-value store.\n\nShows all stored keys in the organization's key-value store. Use --prefix to filter\nkeys that start with a specific prefix, or --keys to query specific keys.",
|
|
1727
1701
|
"examples": [
|
|
1728
|
-
"<%= config.bin %>
|
|
1729
|
-
"<%= config.bin %>
|
|
1730
|
-
"<%= config.bin %>
|
|
1702
|
+
"<%= config.bin %> kv list",
|
|
1703
|
+
"<%= config.bin %> kv list --prefix config",
|
|
1704
|
+
"<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
|
|
1705
|
+
"<%= config.bin %> kv list --json"
|
|
1731
1706
|
],
|
|
1732
1707
|
"flags": {
|
|
1733
1708
|
"json": {
|
|
@@ -1757,51 +1732,18 @@
|
|
|
1757
1732
|
"allowNo": false,
|
|
1758
1733
|
"type": "boolean"
|
|
1759
1734
|
},
|
|
1760
|
-
"
|
|
1761
|
-
"char": "
|
|
1762
|
-
"description": "
|
|
1763
|
-
"name": "
|
|
1764
|
-
"required": true,
|
|
1765
|
-
"hasDynamicHelp": false,
|
|
1766
|
-
"multiple": false,
|
|
1767
|
-
"type": "option"
|
|
1768
|
-
},
|
|
1769
|
-
"stream": {
|
|
1770
|
-
"char": "s",
|
|
1771
|
-
"description": "Stream name",
|
|
1772
|
-
"name": "stream",
|
|
1773
|
-
"required": true,
|
|
1774
|
-
"hasDynamicHelp": false,
|
|
1775
|
-
"multiple": false,
|
|
1776
|
-
"type": "option"
|
|
1777
|
-
},
|
|
1778
|
-
"url": {
|
|
1779
|
-
"char": "u",
|
|
1780
|
-
"description": "Image URL (must be http:// or https://)",
|
|
1781
|
-
"name": "url",
|
|
1782
|
-
"required": true,
|
|
1783
|
-
"hasDynamicHelp": false,
|
|
1784
|
-
"multiple": false,
|
|
1785
|
-
"type": "option"
|
|
1786
|
-
},
|
|
1787
|
-
"size": {
|
|
1788
|
-
"description": "Image size in bytes (optional)",
|
|
1789
|
-
"name": "size",
|
|
1790
|
-
"hasDynamicHelp": false,
|
|
1791
|
-
"multiple": false,
|
|
1792
|
-
"type": "option"
|
|
1793
|
-
},
|
|
1794
|
-
"tag": {
|
|
1795
|
-
"char": "t",
|
|
1796
|
-
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1797
|
-
"name": "tag",
|
|
1735
|
+
"keys": {
|
|
1736
|
+
"char": "k",
|
|
1737
|
+
"description": "Specific keys to query (can be specified multiple times)",
|
|
1738
|
+
"name": "keys",
|
|
1798
1739
|
"hasDynamicHelp": false,
|
|
1799
1740
|
"multiple": true,
|
|
1800
1741
|
"type": "option"
|
|
1801
1742
|
},
|
|
1802
|
-
"
|
|
1803
|
-
"
|
|
1804
|
-
"
|
|
1743
|
+
"prefix": {
|
|
1744
|
+
"char": "p",
|
|
1745
|
+
"description": "Filter keys by prefix",
|
|
1746
|
+
"name": "prefix",
|
|
1805
1747
|
"hasDynamicHelp": false,
|
|
1806
1748
|
"multiple": false,
|
|
1807
1749
|
"type": "option"
|
|
@@ -1809,35 +1751,39 @@
|
|
|
1809
1751
|
},
|
|
1810
1752
|
"hasDynamicHelp": false,
|
|
1811
1753
|
"hiddenAliases": [],
|
|
1812
|
-
"id": "
|
|
1754
|
+
"id": "kv:list",
|
|
1813
1755
|
"pluginAlias": "@formant/formant-cli",
|
|
1814
1756
|
"pluginName": "@formant/formant-cli",
|
|
1815
1757
|
"pluginType": "core",
|
|
1816
1758
|
"strict": true,
|
|
1817
|
-
"summary": "
|
|
1759
|
+
"summary": "List key-value keys",
|
|
1818
1760
|
"enableJsonFlag": true,
|
|
1819
1761
|
"isESM": true,
|
|
1820
1762
|
"relativePath": [
|
|
1821
1763
|
"dist",
|
|
1822
1764
|
"commands",
|
|
1823
|
-
"
|
|
1824
|
-
"
|
|
1765
|
+
"kv",
|
|
1766
|
+
"list.js"
|
|
1825
1767
|
]
|
|
1826
1768
|
},
|
|
1827
|
-
"
|
|
1769
|
+
"kv:set": {
|
|
1828
1770
|
"aliases": [],
|
|
1829
1771
|
"args": {
|
|
1772
|
+
"key": {
|
|
1773
|
+
"description": "Key to set",
|
|
1774
|
+
"name": "key",
|
|
1775
|
+
"required": true
|
|
1776
|
+
},
|
|
1830
1777
|
"value": {
|
|
1831
|
-
"description": "
|
|
1778
|
+
"description": "Value to store (JSON string)",
|
|
1832
1779
|
"name": "value",
|
|
1833
1780
|
"required": true
|
|
1834
1781
|
}
|
|
1835
1782
|
},
|
|
1836
|
-
"description": "
|
|
1783
|
+
"description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
|
|
1837
1784
|
"examples": [
|
|
1838
|
-
"<%= config.bin %>
|
|
1839
|
-
"<%= config.bin %>
|
|
1840
|
-
"<%= config.bin %> ingest json '[1,2,3,4,5]' --device <device-id> --stream array_data"
|
|
1785
|
+
"<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
|
|
1786
|
+
"<%= config.bin %> kv set config '{\"setting\": true}'"
|
|
1841
1787
|
],
|
|
1842
1788
|
"flags": {
|
|
1843
1789
|
"json": {
|
|
@@ -1866,72 +1812,34 @@
|
|
|
1866
1812
|
"name": "stage",
|
|
1867
1813
|
"allowNo": false,
|
|
1868
1814
|
"type": "boolean"
|
|
1869
|
-
},
|
|
1870
|
-
"device": {
|
|
1871
|
-
"char": "d",
|
|
1872
|
-
"description": "Device ID (UUID)",
|
|
1873
|
-
"name": "device",
|
|
1874
|
-
"required": true,
|
|
1875
|
-
"hasDynamicHelp": false,
|
|
1876
|
-
"multiple": false,
|
|
1877
|
-
"type": "option"
|
|
1878
|
-
},
|
|
1879
|
-
"stream": {
|
|
1880
|
-
"char": "s",
|
|
1881
|
-
"description": "Stream name",
|
|
1882
|
-
"name": "stream",
|
|
1883
|
-
"required": true,
|
|
1884
|
-
"hasDynamicHelp": false,
|
|
1885
|
-
"multiple": false,
|
|
1886
|
-
"type": "option"
|
|
1887
|
-
},
|
|
1888
|
-
"tag": {
|
|
1889
|
-
"char": "t",
|
|
1890
|
-
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1891
|
-
"name": "tag",
|
|
1892
|
-
"hasDynamicHelp": false,
|
|
1893
|
-
"multiple": true,
|
|
1894
|
-
"type": "option"
|
|
1895
|
-
},
|
|
1896
|
-
"timestamp": {
|
|
1897
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1898
|
-
"name": "timestamp",
|
|
1899
|
-
"hasDynamicHelp": false,
|
|
1900
|
-
"multiple": false,
|
|
1901
|
-
"type": "option"
|
|
1902
1815
|
}
|
|
1903
1816
|
},
|
|
1904
1817
|
"hasDynamicHelp": false,
|
|
1905
1818
|
"hiddenAliases": [],
|
|
1906
|
-
"id": "
|
|
1819
|
+
"id": "kv:set",
|
|
1907
1820
|
"pluginAlias": "@formant/formant-cli",
|
|
1908
1821
|
"pluginName": "@formant/formant-cli",
|
|
1909
1822
|
"pluginType": "core",
|
|
1910
1823
|
"strict": true,
|
|
1911
|
-
"summary": "
|
|
1824
|
+
"summary": "Set key-value",
|
|
1912
1825
|
"enableJsonFlag": true,
|
|
1913
1826
|
"isESM": true,
|
|
1914
1827
|
"relativePath": [
|
|
1915
1828
|
"dist",
|
|
1916
1829
|
"commands",
|
|
1917
|
-
"
|
|
1918
|
-
"
|
|
1830
|
+
"kv",
|
|
1831
|
+
"set.js"
|
|
1919
1832
|
]
|
|
1920
1833
|
},
|
|
1921
|
-
"ingest:
|
|
1834
|
+
"ingest:batch": {
|
|
1922
1835
|
"aliases": [],
|
|
1923
|
-
"args": {
|
|
1924
|
-
"value": {
|
|
1925
|
-
"description": "Numeric value to ingest",
|
|
1926
|
-
"name": "value",
|
|
1927
|
-
"required": true
|
|
1928
|
-
}
|
|
1929
|
-
},
|
|
1930
|
-
"description": "Ingest a numeric data point to a device stream.\n\nSends a single numeric value to the specified device stream. The value must be a valid number.\nNumeric streams are commonly used for sensor readings like battery level, temperature, speed, etc.",
|
|
1836
|
+
"args": {},
|
|
1837
|
+
"description": "Ingest multiple data points in a single batch request.\n\nReads a JSON file (or stdin) containing a batch ingestion payload and sends all data points\nin a single API request. This is more efficient than sending individual data points when you\nhave multiple values to ingest.\n\nINPUT FORMAT:\nThe input JSON must have the following structure:\n{\n \"items\": [\n {\n \"deviceId\": \"device-uuid\", // Required: Device ID (UUID)\n \"name\": \"stream-name\", // Required: Stream name\n \"type\": \"numeric|text|json|...\", // Required: Data type (see below)\n \"tags\": {\"key\": \"value\"}, // Optional: Tags object (string key-value pairs)\n \"points\": [[timestamp_ms, value]] // Required: Array of [timestamp, value] pairs\n }\n ]\n}\n\nSUPPORTED TYPES AND VALUE FORMATS:\n- numeric: Number value\n Example: \"points\": [[1708272000000, 42.5]]\n\n- text: String value\n Example: \"points\": [[1708272000000, \"hello world\"]]\n\n- json: JSON object encoded as string\n Example: \"points\": [[1708272000000, \"{\\\"x\\\":10,\\\"y\\\":20}\"]]\n\n- image: Object with url (required), size and annotations (optional)\n Example: \"points\": [[1708272000000, {\"url\": \"https://example.com/img.jpg\", \"size\": 102400}]]\n\n- video: Object with url, duration, mimeType (required), size (optional)\n Example: \"points\": [[1708272000000, {\"url\": \"https://example.com/vid.mp4\", \"duration\": 30000, \"mimeType\": \"video/mp4\"}]]\n\n- bitset: Object with keys array and values array (1-1000 pairs)\n Example: \"points\": [[1708272000000, {\"keys\": [\"door\", \"window\"], \"values\": [true, false]}]]\n\n- health: Object with status (required) and clockSkewMs (optional)\n Example: \"points\": [[1708272000000, {\"status\": \"operational\", \"clockSkewMs\": 150}]]\n Valid status values: \"unknown\", \"operational\", \"offline\", \"error\"\n\nEach item can have multiple points (timestamp/value pairs) for the same stream.\nTimestamps are Unix milliseconds (use Date.now() for current time).",
|
|
1931
1838
|
"examples": [
|
|
1932
|
-
"<%= config.bin %> ingest
|
|
1933
|
-
"<%= config.bin %> ingest
|
|
1934
|
-
"<%= config.bin %> ingest
|
|
1839
|
+
"<%= config.bin %> ingest batch --file data.json",
|
|
1840
|
+
"<%= config.bin %> ingest batch --stdin < data.json",
|
|
1841
|
+
"cat payload.json | <%= config.bin %> ingest batch --stdin",
|
|
1842
|
+
"# Example payload.json with multiple types:\n{\n \"items\": [\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"battery_level\",\n \"type\": \"numeric\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, 42.5], [1708272060000, 41.8]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"status\",\n \"type\": \"text\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, \"operational\"]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"health\",\n \"type\": \"health\",\n \"tags\": {},\n \"points\": [[1708272000000, {\"status\": \"operational\"}]]\n }\n ]\n}"
|
|
1935
1843
|
],
|
|
1936
1844
|
"flags": {
|
|
1937
1845
|
"json": {
|
|
@@ -1961,71 +1869,52 @@
|
|
|
1961
1869
|
"allowNo": false,
|
|
1962
1870
|
"type": "boolean"
|
|
1963
1871
|
},
|
|
1964
|
-
"
|
|
1965
|
-
"char": "
|
|
1966
|
-
"description": "
|
|
1967
|
-
"
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
"
|
|
1971
|
-
"type": "option"
|
|
1972
|
-
},
|
|
1973
|
-
"stream": {
|
|
1974
|
-
"char": "s",
|
|
1975
|
-
"description": "Stream name",
|
|
1976
|
-
"name": "stream",
|
|
1977
|
-
"required": true,
|
|
1872
|
+
"file": {
|
|
1873
|
+
"char": "f",
|
|
1874
|
+
"description": "Path to JSON file containing batch payload",
|
|
1875
|
+
"exclusive": [
|
|
1876
|
+
"stdin"
|
|
1877
|
+
],
|
|
1878
|
+
"name": "file",
|
|
1978
1879
|
"hasDynamicHelp": false,
|
|
1979
1880
|
"multiple": false,
|
|
1980
1881
|
"type": "option"
|
|
1981
1882
|
},
|
|
1982
|
-
"
|
|
1983
|
-
"
|
|
1984
|
-
"
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
1989
|
-
|
|
1990
|
-
"timestamp": {
|
|
1991
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1992
|
-
"name": "timestamp",
|
|
1993
|
-
"hasDynamicHelp": false,
|
|
1994
|
-
"multiple": false,
|
|
1995
|
-
"type": "option"
|
|
1883
|
+
"stdin": {
|
|
1884
|
+
"description": "Read JSON payload from stdin",
|
|
1885
|
+
"exclusive": [
|
|
1886
|
+
"file"
|
|
1887
|
+
],
|
|
1888
|
+
"name": "stdin",
|
|
1889
|
+
"allowNo": false,
|
|
1890
|
+
"type": "boolean"
|
|
1996
1891
|
}
|
|
1997
1892
|
},
|
|
1998
1893
|
"hasDynamicHelp": false,
|
|
1999
1894
|
"hiddenAliases": [],
|
|
2000
|
-
"id": "ingest:
|
|
1895
|
+
"id": "ingest:batch",
|
|
2001
1896
|
"pluginAlias": "@formant/formant-cli",
|
|
2002
1897
|
"pluginName": "@formant/formant-cli",
|
|
2003
1898
|
"pluginType": "core",
|
|
2004
1899
|
"strict": true,
|
|
2005
|
-
"summary": "Ingest
|
|
1900
|
+
"summary": "Ingest batch data from file or stdin",
|
|
2006
1901
|
"enableJsonFlag": true,
|
|
2007
1902
|
"isESM": true,
|
|
2008
1903
|
"relativePath": [
|
|
2009
1904
|
"dist",
|
|
2010
1905
|
"commands",
|
|
2011
1906
|
"ingest",
|
|
2012
|
-
"
|
|
1907
|
+
"batch.js"
|
|
2013
1908
|
]
|
|
2014
1909
|
},
|
|
2015
|
-
"ingest:
|
|
1910
|
+
"ingest:bitset": {
|
|
2016
1911
|
"aliases": [],
|
|
2017
|
-
"args": {
|
|
2018
|
-
|
|
2019
|
-
"description": "Text value to ingest",
|
|
2020
|
-
"name": "value",
|
|
2021
|
-
"required": true
|
|
2022
|
-
}
|
|
2023
|
-
},
|
|
2024
|
-
"description": "Ingest a text data point to a device stream.\n\nSends a single text/string value to the specified device stream. Text streams are commonly\nused for logs, status messages, error messages, and other string data.",
|
|
1912
|
+
"args": {},
|
|
1913
|
+
"description": "Ingest a bitset data point to a device stream.\n\nSends a bitset (array of named boolean values) to the specified device stream. A bitset\nconsists of parallel arrays of keys (strings) and values (booleans).\n\nBitsets are useful for representing sets of binary states, flags, or boolean sensor readings\nwhere you have multiple named on/off states.\n\nConstraints:\n- Must have 1-1000 key/value pairs\n- Keys must be max 255 characters each\n- Keys and values arrays must have the same length",
|
|
2025
1914
|
"examples": [
|
|
2026
|
-
"<%= config.bin %> ingest
|
|
2027
|
-
"<%= config.bin %> ingest
|
|
2028
|
-
"<%= config.bin %> ingest
|
|
1915
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream sensors --keys \"door,window,motion\" --values \"true,false,true\"",
|
|
1916
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream flags --keys \"active,paused,error\" --values \"true,false,false\" --tag system=main",
|
|
1917
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream states --keys \"a,b\" --values \"false,true\""
|
|
2029
1918
|
],
|
|
2030
1919
|
"flags": {
|
|
2031
1920
|
"json": {
|
|
@@ -2073,6 +1962,24 @@
|
|
|
2073
1962
|
"multiple": false,
|
|
2074
1963
|
"type": "option"
|
|
2075
1964
|
},
|
|
1965
|
+
"keys": {
|
|
1966
|
+
"char": "k",
|
|
1967
|
+
"description": "Comma-separated list of key names (1-1000 keys, max 255 chars each)",
|
|
1968
|
+
"name": "keys",
|
|
1969
|
+
"required": true,
|
|
1970
|
+
"hasDynamicHelp": false,
|
|
1971
|
+
"multiple": false,
|
|
1972
|
+
"type": "option"
|
|
1973
|
+
},
|
|
1974
|
+
"values": {
|
|
1975
|
+
"char": "v",
|
|
1976
|
+
"description": "Comma-separated list of boolean values (true/false, must match key count)",
|
|
1977
|
+
"name": "values",
|
|
1978
|
+
"required": true,
|
|
1979
|
+
"hasDynamicHelp": false,
|
|
1980
|
+
"multiple": false,
|
|
1981
|
+
"type": "option"
|
|
1982
|
+
},
|
|
2076
1983
|
"tag": {
|
|
2077
1984
|
"char": "t",
|
|
2078
1985
|
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
@@ -2091,29 +1998,29 @@
|
|
|
2091
1998
|
},
|
|
2092
1999
|
"hasDynamicHelp": false,
|
|
2093
2000
|
"hiddenAliases": [],
|
|
2094
|
-
"id": "ingest:
|
|
2001
|
+
"id": "ingest:bitset",
|
|
2095
2002
|
"pluginAlias": "@formant/formant-cli",
|
|
2096
2003
|
"pluginName": "@formant/formant-cli",
|
|
2097
2004
|
"pluginType": "core",
|
|
2098
2005
|
"strict": true,
|
|
2099
|
-
"summary": "Ingest
|
|
2006
|
+
"summary": "Ingest bitset data",
|
|
2100
2007
|
"enableJsonFlag": true,
|
|
2101
2008
|
"isESM": true,
|
|
2102
2009
|
"relativePath": [
|
|
2103
2010
|
"dist",
|
|
2104
2011
|
"commands",
|
|
2105
2012
|
"ingest",
|
|
2106
|
-
"
|
|
2013
|
+
"bitset.js"
|
|
2107
2014
|
]
|
|
2108
2015
|
},
|
|
2109
|
-
"ingest:
|
|
2016
|
+
"ingest:health": {
|
|
2110
2017
|
"aliases": [],
|
|
2111
2018
|
"args": {},
|
|
2112
|
-
"description": "Ingest a
|
|
2019
|
+
"description": "Ingest a health status data point to a device stream.\n\nSends device health status information to the specified stream. Health data consists of:\n- status: One of \"unknown\", \"operational\", \"offline\", or \"error\"\n- clockSkewMs (optional): Clock skew in milliseconds between device and server\n\nHealth streams are used to track device operational state, system health, and time synchronization.",
|
|
2113
2020
|
"examples": [
|
|
2114
|
-
"<%= config.bin %> ingest
|
|
2115
|
-
"<%= config.bin %> ingest
|
|
2116
|
-
"<%= config.bin %> ingest
|
|
2021
|
+
"<%= config.bin %> ingest health --device <device-id> --stream system_health --status operational",
|
|
2022
|
+
"<%= config.bin %> ingest health --device <device-id> --stream health --status error --tag component=motor",
|
|
2023
|
+
"<%= config.bin %> ingest health --device <device-id> --stream sync --status operational --clock-skew 150"
|
|
2117
2024
|
],
|
|
2118
2025
|
"flags": {
|
|
2119
2026
|
"json": {
|
|
@@ -2161,26 +2068,23 @@
|
|
|
2161
2068
|
"multiple": false,
|
|
2162
2069
|
"type": "option"
|
|
2163
2070
|
},
|
|
2164
|
-
"
|
|
2165
|
-
"
|
|
2166
|
-
"
|
|
2167
|
-
"name": "url",
|
|
2168
|
-
"required": true,
|
|
2169
|
-
"hasDynamicHelp": false,
|
|
2170
|
-
"multiple": false,
|
|
2171
|
-
"type": "option"
|
|
2172
|
-
},
|
|
2173
|
-
"duration": {
|
|
2174
|
-
"description": "Video duration in milliseconds (required)",
|
|
2175
|
-
"name": "duration",
|
|
2071
|
+
"status": {
|
|
2072
|
+
"description": "Health status (unknown, operational, offline, or error)",
|
|
2073
|
+
"name": "status",
|
|
2176
2074
|
"required": true,
|
|
2177
2075
|
"hasDynamicHelp": false,
|
|
2178
2076
|
"multiple": false,
|
|
2077
|
+
"options": [
|
|
2078
|
+
"unknown",
|
|
2079
|
+
"operational",
|
|
2080
|
+
"offline",
|
|
2081
|
+
"error"
|
|
2082
|
+
],
|
|
2179
2083
|
"type": "option"
|
|
2180
2084
|
},
|
|
2181
|
-
"
|
|
2182
|
-
"description": "
|
|
2183
|
-
"name": "
|
|
2085
|
+
"clock-skew": {
|
|
2086
|
+
"description": "Clock skew in milliseconds (optional)",
|
|
2087
|
+
"name": "clock-skew",
|
|
2184
2088
|
"hasDynamicHelp": false,
|
|
2185
2089
|
"multiple": false,
|
|
2186
2090
|
"type": "option"
|
|
@@ -2203,34 +2107,29 @@
|
|
|
2203
2107
|
},
|
|
2204
2108
|
"hasDynamicHelp": false,
|
|
2205
2109
|
"hiddenAliases": [],
|
|
2206
|
-
"id": "ingest:
|
|
2110
|
+
"id": "ingest:health",
|
|
2207
2111
|
"pluginAlias": "@formant/formant-cli",
|
|
2208
2112
|
"pluginName": "@formant/formant-cli",
|
|
2209
2113
|
"pluginType": "core",
|
|
2210
2114
|
"strict": true,
|
|
2211
|
-
"summary": "Ingest
|
|
2115
|
+
"summary": "Ingest health status data",
|
|
2212
2116
|
"enableJsonFlag": true,
|
|
2213
2117
|
"isESM": true,
|
|
2214
2118
|
"relativePath": [
|
|
2215
2119
|
"dist",
|
|
2216
2120
|
"commands",
|
|
2217
2121
|
"ingest",
|
|
2218
|
-
"
|
|
2122
|
+
"health.js"
|
|
2219
2123
|
]
|
|
2220
2124
|
},
|
|
2221
|
-
"
|
|
2125
|
+
"ingest:image": {
|
|
2222
2126
|
"aliases": [],
|
|
2223
|
-
"args": {
|
|
2224
|
-
|
|
2225
|
-
"description": "Key to retrieve",
|
|
2226
|
-
"name": "key",
|
|
2227
|
-
"required": true
|
|
2228
|
-
}
|
|
2229
|
-
},
|
|
2230
|
-
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
2127
|
+
"args": {},
|
|
2128
|
+
"description": "Ingest an image URL to a device stream.\n\nSends an image reference (by URL) to the specified device stream. The image must be accessible\nvia HTTP/HTTPS. Formant will fetch and store the image from the provided URL.\n\nImage streams are used for camera feeds, snapshots, diagnostic images, etc.",
|
|
2231
2129
|
"examples": [
|
|
2232
|
-
"<%= config.bin %>
|
|
2233
|
-
"<%= config.bin %>
|
|
2130
|
+
"<%= config.bin %> ingest image --device <device-id> --stream camera_front --url https://example.com/image.jpg",
|
|
2131
|
+
"<%= config.bin %> ingest image --device <device-id> --stream snapshot --url https://example.com/snap.png --size 1024000",
|
|
2132
|
+
"<%= config.bin %> ingest image --device <device-id> --stream detection --url https://example.com/detect.jpg --tag frame=123"
|
|
2234
2133
|
],
|
|
2235
2134
|
"flags": {
|
|
2236
2135
|
"json": {
|
|
@@ -2259,34 +2158,88 @@
|
|
|
2259
2158
|
"name": "stage",
|
|
2260
2159
|
"allowNo": false,
|
|
2261
2160
|
"type": "boolean"
|
|
2161
|
+
},
|
|
2162
|
+
"device": {
|
|
2163
|
+
"char": "d",
|
|
2164
|
+
"description": "Device ID (UUID)",
|
|
2165
|
+
"name": "device",
|
|
2166
|
+
"required": true,
|
|
2167
|
+
"hasDynamicHelp": false,
|
|
2168
|
+
"multiple": false,
|
|
2169
|
+
"type": "option"
|
|
2170
|
+
},
|
|
2171
|
+
"stream": {
|
|
2172
|
+
"char": "s",
|
|
2173
|
+
"description": "Stream name",
|
|
2174
|
+
"name": "stream",
|
|
2175
|
+
"required": true,
|
|
2176
|
+
"hasDynamicHelp": false,
|
|
2177
|
+
"multiple": false,
|
|
2178
|
+
"type": "option"
|
|
2179
|
+
},
|
|
2180
|
+
"url": {
|
|
2181
|
+
"char": "u",
|
|
2182
|
+
"description": "Image URL (must be http:// or https://)",
|
|
2183
|
+
"name": "url",
|
|
2184
|
+
"required": true,
|
|
2185
|
+
"hasDynamicHelp": false,
|
|
2186
|
+
"multiple": false,
|
|
2187
|
+
"type": "option"
|
|
2188
|
+
},
|
|
2189
|
+
"size": {
|
|
2190
|
+
"description": "Image size in bytes (optional)",
|
|
2191
|
+
"name": "size",
|
|
2192
|
+
"hasDynamicHelp": false,
|
|
2193
|
+
"multiple": false,
|
|
2194
|
+
"type": "option"
|
|
2195
|
+
},
|
|
2196
|
+
"tag": {
|
|
2197
|
+
"char": "t",
|
|
2198
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2199
|
+
"name": "tag",
|
|
2200
|
+
"hasDynamicHelp": false,
|
|
2201
|
+
"multiple": true,
|
|
2202
|
+
"type": "option"
|
|
2203
|
+
},
|
|
2204
|
+
"timestamp": {
|
|
2205
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2206
|
+
"name": "timestamp",
|
|
2207
|
+
"hasDynamicHelp": false,
|
|
2208
|
+
"multiple": false,
|
|
2209
|
+
"type": "option"
|
|
2262
2210
|
}
|
|
2263
2211
|
},
|
|
2264
2212
|
"hasDynamicHelp": false,
|
|
2265
2213
|
"hiddenAliases": [],
|
|
2266
|
-
"id": "
|
|
2214
|
+
"id": "ingest:image",
|
|
2267
2215
|
"pluginAlias": "@formant/formant-cli",
|
|
2268
2216
|
"pluginName": "@formant/formant-cli",
|
|
2269
2217
|
"pluginType": "core",
|
|
2270
2218
|
"strict": true,
|
|
2271
|
-
"summary": "
|
|
2219
|
+
"summary": "Ingest image data",
|
|
2272
2220
|
"enableJsonFlag": true,
|
|
2273
2221
|
"isESM": true,
|
|
2274
2222
|
"relativePath": [
|
|
2275
2223
|
"dist",
|
|
2276
2224
|
"commands",
|
|
2277
|
-
"
|
|
2278
|
-
"
|
|
2225
|
+
"ingest",
|
|
2226
|
+
"image.js"
|
|
2279
2227
|
]
|
|
2280
2228
|
},
|
|
2281
|
-
"
|
|
2229
|
+
"ingest:json": {
|
|
2282
2230
|
"aliases": [],
|
|
2283
|
-
"args": {
|
|
2284
|
-
|
|
2231
|
+
"args": {
|
|
2232
|
+
"value": {
|
|
2233
|
+
"description": "JSON value to ingest (as a JSON string)",
|
|
2234
|
+
"name": "value",
|
|
2235
|
+
"required": true
|
|
2236
|
+
}
|
|
2237
|
+
},
|
|
2238
|
+
"description": "Ingest a JSON data point to a device stream.\n\nSends structured JSON data to the specified device stream. The value must be valid JSON.\nJSON streams are used for complex structured data like configuration objects, state machines,\nnested telemetry, etc.\n\nNote: The JSON is sent as a JSON-encoded string to Formant.",
|
|
2285
2239
|
"examples": [
|
|
2286
|
-
"<%= config.bin %>
|
|
2287
|
-
"<%= config.bin %>
|
|
2288
|
-
"<%= config.bin %>
|
|
2289
|
-
"<%= config.bin %> kv list --json"
|
|
2240
|
+
"<%= config.bin %> ingest json '{\"x\":1,\"y\":2}' --device <device-id> --stream position",
|
|
2241
|
+
"<%= config.bin %> ingest json '{\"status\":\"active\",\"mode\":\"auto\"}' --device <device-id> --stream config",
|
|
2242
|
+
"<%= config.bin %> ingest json '[1,2,3,4,5]' --device <device-id> --stream array_data"
|
|
2290
2243
|
],
|
|
2291
2244
|
"flags": {
|
|
2292
2245
|
"json": {
|
|
@@ -2316,18 +2269,35 @@
|
|
|
2316
2269
|
"allowNo": false,
|
|
2317
2270
|
"type": "boolean"
|
|
2318
2271
|
},
|
|
2319
|
-
"
|
|
2320
|
-
"char": "
|
|
2321
|
-
"description": "
|
|
2322
|
-
"name": "
|
|
2272
|
+
"device": {
|
|
2273
|
+
"char": "d",
|
|
2274
|
+
"description": "Device ID (UUID)",
|
|
2275
|
+
"name": "device",
|
|
2276
|
+
"required": true,
|
|
2277
|
+
"hasDynamicHelp": false,
|
|
2278
|
+
"multiple": false,
|
|
2279
|
+
"type": "option"
|
|
2280
|
+
},
|
|
2281
|
+
"stream": {
|
|
2282
|
+
"char": "s",
|
|
2283
|
+
"description": "Stream name",
|
|
2284
|
+
"name": "stream",
|
|
2285
|
+
"required": true,
|
|
2286
|
+
"hasDynamicHelp": false,
|
|
2287
|
+
"multiple": false,
|
|
2288
|
+
"type": "option"
|
|
2289
|
+
},
|
|
2290
|
+
"tag": {
|
|
2291
|
+
"char": "t",
|
|
2292
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2293
|
+
"name": "tag",
|
|
2323
2294
|
"hasDynamicHelp": false,
|
|
2324
2295
|
"multiple": true,
|
|
2325
2296
|
"type": "option"
|
|
2326
2297
|
},
|
|
2327
|
-
"
|
|
2328
|
-
"
|
|
2329
|
-
"
|
|
2330
|
-
"name": "prefix",
|
|
2298
|
+
"timestamp": {
|
|
2299
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2300
|
+
"name": "timestamp",
|
|
2331
2301
|
"hasDynamicHelp": false,
|
|
2332
2302
|
"multiple": false,
|
|
2333
2303
|
"type": "option"
|
|
@@ -2335,39 +2305,35 @@
|
|
|
2335
2305
|
},
|
|
2336
2306
|
"hasDynamicHelp": false,
|
|
2337
2307
|
"hiddenAliases": [],
|
|
2338
|
-
"id": "
|
|
2308
|
+
"id": "ingest:json",
|
|
2339
2309
|
"pluginAlias": "@formant/formant-cli",
|
|
2340
2310
|
"pluginName": "@formant/formant-cli",
|
|
2341
2311
|
"pluginType": "core",
|
|
2342
2312
|
"strict": true,
|
|
2343
|
-
"summary": "
|
|
2313
|
+
"summary": "Ingest JSON data",
|
|
2344
2314
|
"enableJsonFlag": true,
|
|
2345
2315
|
"isESM": true,
|
|
2346
2316
|
"relativePath": [
|
|
2347
2317
|
"dist",
|
|
2348
2318
|
"commands",
|
|
2349
|
-
"
|
|
2350
|
-
"
|
|
2319
|
+
"ingest",
|
|
2320
|
+
"json.js"
|
|
2351
2321
|
]
|
|
2352
2322
|
},
|
|
2353
|
-
"
|
|
2323
|
+
"ingest:numeric": {
|
|
2354
2324
|
"aliases": [],
|
|
2355
2325
|
"args": {
|
|
2356
|
-
"key": {
|
|
2357
|
-
"description": "Key to set",
|
|
2358
|
-
"name": "key",
|
|
2359
|
-
"required": true
|
|
2360
|
-
},
|
|
2361
2326
|
"value": {
|
|
2362
|
-
"description": "
|
|
2327
|
+
"description": "Numeric value to ingest",
|
|
2363
2328
|
"name": "value",
|
|
2364
2329
|
"required": true
|
|
2365
2330
|
}
|
|
2366
2331
|
},
|
|
2367
|
-
"description": "
|
|
2332
|
+
"description": "Ingest a numeric data point to a device stream.\n\nSends a single numeric value to the specified device stream. The value must be a valid number.\nNumeric streams are commonly used for sensor readings like battery level, temperature, speed, etc.",
|
|
2368
2333
|
"examples": [
|
|
2369
|
-
"<%= config.bin %>
|
|
2370
|
-
"<%= config.bin %>
|
|
2334
|
+
"<%= config.bin %> ingest numeric 42.5 --device <device-id> --stream battery_level",
|
|
2335
|
+
"<%= config.bin %> ingest numeric 98.6 --device <device-id> --stream temperature --tag unit=fahrenheit",
|
|
2336
|
+
"<%= config.bin %> ingest numeric 1500 --device <device-id> --stream rpm --timestamp 1700000000000"
|
|
2371
2337
|
],
|
|
2372
2338
|
"flags": {
|
|
2373
2339
|
"json": {
|
|
@@ -2396,32 +2362,72 @@
|
|
|
2396
2362
|
"name": "stage",
|
|
2397
2363
|
"allowNo": false,
|
|
2398
2364
|
"type": "boolean"
|
|
2365
|
+
},
|
|
2366
|
+
"device": {
|
|
2367
|
+
"char": "d",
|
|
2368
|
+
"description": "Device ID (UUID)",
|
|
2369
|
+
"name": "device",
|
|
2370
|
+
"required": true,
|
|
2371
|
+
"hasDynamicHelp": false,
|
|
2372
|
+
"multiple": false,
|
|
2373
|
+
"type": "option"
|
|
2374
|
+
},
|
|
2375
|
+
"stream": {
|
|
2376
|
+
"char": "s",
|
|
2377
|
+
"description": "Stream name",
|
|
2378
|
+
"name": "stream",
|
|
2379
|
+
"required": true,
|
|
2380
|
+
"hasDynamicHelp": false,
|
|
2381
|
+
"multiple": false,
|
|
2382
|
+
"type": "option"
|
|
2383
|
+
},
|
|
2384
|
+
"tag": {
|
|
2385
|
+
"char": "t",
|
|
2386
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2387
|
+
"name": "tag",
|
|
2388
|
+
"hasDynamicHelp": false,
|
|
2389
|
+
"multiple": true,
|
|
2390
|
+
"type": "option"
|
|
2391
|
+
},
|
|
2392
|
+
"timestamp": {
|
|
2393
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2394
|
+
"name": "timestamp",
|
|
2395
|
+
"hasDynamicHelp": false,
|
|
2396
|
+
"multiple": false,
|
|
2397
|
+
"type": "option"
|
|
2399
2398
|
}
|
|
2400
2399
|
},
|
|
2401
2400
|
"hasDynamicHelp": false,
|
|
2402
2401
|
"hiddenAliases": [],
|
|
2403
|
-
"id": "
|
|
2402
|
+
"id": "ingest:numeric",
|
|
2404
2403
|
"pluginAlias": "@formant/formant-cli",
|
|
2405
2404
|
"pluginName": "@formant/formant-cli",
|
|
2406
2405
|
"pluginType": "core",
|
|
2407
2406
|
"strict": true,
|
|
2408
|
-
"summary": "
|
|
2407
|
+
"summary": "Ingest numeric data",
|
|
2409
2408
|
"enableJsonFlag": true,
|
|
2410
2409
|
"isESM": true,
|
|
2411
2410
|
"relativePath": [
|
|
2412
2411
|
"dist",
|
|
2413
2412
|
"commands",
|
|
2414
|
-
"
|
|
2415
|
-
"
|
|
2413
|
+
"ingest",
|
|
2414
|
+
"numeric.js"
|
|
2416
2415
|
]
|
|
2417
2416
|
},
|
|
2418
|
-
"
|
|
2417
|
+
"ingest:text": {
|
|
2419
2418
|
"aliases": [],
|
|
2420
|
-
"args": {
|
|
2421
|
-
|
|
2419
|
+
"args": {
|
|
2420
|
+
"value": {
|
|
2421
|
+
"description": "Text value to ingest",
|
|
2422
|
+
"name": "value",
|
|
2423
|
+
"required": true
|
|
2424
|
+
}
|
|
2425
|
+
},
|
|
2426
|
+
"description": "Ingest a text data point to a device stream.\n\nSends a single text/string value to the specified device stream. Text streams are commonly\nused for logs, status messages, error messages, and other string data.",
|
|
2422
2427
|
"examples": [
|
|
2423
|
-
"<%= config.bin %>
|
|
2424
|
-
"<%= config.bin %>
|
|
2428
|
+
"<%= config.bin %> ingest text \"Robot started successfully\" --device <device-id> --stream status",
|
|
2429
|
+
"<%= config.bin %> ingest text \"Error: sensor offline\" --device <device-id> --stream errors --tag severity=high",
|
|
2430
|
+
"<%= config.bin %> ingest text \"Checkpoint A reached\" --device <device-id> --stream waypoints"
|
|
2425
2431
|
],
|
|
2426
2432
|
"flags": {
|
|
2427
2433
|
"json": {
|
|
@@ -2450,34 +2456,66 @@
|
|
|
2450
2456
|
"name": "stage",
|
|
2451
2457
|
"allowNo": false,
|
|
2452
2458
|
"type": "boolean"
|
|
2459
|
+
},
|
|
2460
|
+
"device": {
|
|
2461
|
+
"char": "d",
|
|
2462
|
+
"description": "Device ID (UUID)",
|
|
2463
|
+
"name": "device",
|
|
2464
|
+
"required": true,
|
|
2465
|
+
"hasDynamicHelp": false,
|
|
2466
|
+
"multiple": false,
|
|
2467
|
+
"type": "option"
|
|
2468
|
+
},
|
|
2469
|
+
"stream": {
|
|
2470
|
+
"char": "s",
|
|
2471
|
+
"description": "Stream name",
|
|
2472
|
+
"name": "stream",
|
|
2473
|
+
"required": true,
|
|
2474
|
+
"hasDynamicHelp": false,
|
|
2475
|
+
"multiple": false,
|
|
2476
|
+
"type": "option"
|
|
2477
|
+
},
|
|
2478
|
+
"tag": {
|
|
2479
|
+
"char": "t",
|
|
2480
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2481
|
+
"name": "tag",
|
|
2482
|
+
"hasDynamicHelp": false,
|
|
2483
|
+
"multiple": true,
|
|
2484
|
+
"type": "option"
|
|
2485
|
+
},
|
|
2486
|
+
"timestamp": {
|
|
2487
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2488
|
+
"name": "timestamp",
|
|
2489
|
+
"hasDynamicHelp": false,
|
|
2490
|
+
"multiple": false,
|
|
2491
|
+
"type": "option"
|
|
2453
2492
|
}
|
|
2454
2493
|
},
|
|
2455
2494
|
"hasDynamicHelp": false,
|
|
2456
2495
|
"hiddenAliases": [],
|
|
2457
|
-
"id": "
|
|
2496
|
+
"id": "ingest:text",
|
|
2458
2497
|
"pluginAlias": "@formant/formant-cli",
|
|
2459
2498
|
"pluginName": "@formant/formant-cli",
|
|
2460
2499
|
"pluginType": "core",
|
|
2461
2500
|
"strict": true,
|
|
2462
|
-
"summary": "
|
|
2501
|
+
"summary": "Ingest text data",
|
|
2463
2502
|
"enableJsonFlag": true,
|
|
2464
2503
|
"isESM": true,
|
|
2465
2504
|
"relativePath": [
|
|
2466
2505
|
"dist",
|
|
2467
2506
|
"commands",
|
|
2468
|
-
"
|
|
2469
|
-
"
|
|
2507
|
+
"ingest",
|
|
2508
|
+
"text.js"
|
|
2470
2509
|
]
|
|
2471
2510
|
},
|
|
2472
|
-
"
|
|
2511
|
+
"ingest:video": {
|
|
2473
2512
|
"aliases": [],
|
|
2474
2513
|
"args": {},
|
|
2475
|
-
"description": "
|
|
2514
|
+
"description": "Ingest a video URL to a device stream.\n\nSends a video reference (by URL) to the specified device stream. The video must be accessible\nvia HTTP/HTTPS. You must provide the video duration in milliseconds.\n\nVideo streams are used for recorded video clips, timelapse videos, event recordings, etc.\n\nThe MIME type is auto-detected from the file extension (.mp4, .webm, .mov).",
|
|
2476
2515
|
"examples": [
|
|
2477
|
-
"<%= config.bin %>
|
|
2478
|
-
"<%= config.bin %>
|
|
2479
|
-
"<%= config.bin %>
|
|
2480
|
-
"<%= config.bin %> org update --name \"My Fleet\" --json"
|
|
2516
|
+
"<%= config.bin %> ingest video --device <device-id> --stream recordings --url https://example.com/video.mp4 --duration 5000",
|
|
2517
|
+
"<%= config.bin %> ingest video --device <device-id> --stream clips --url https://example.com/clip.webm --duration 3500 --size 2048000",
|
|
2518
|
+
"<%= config.bin %> ingest video --device <device-id> --stream event_video --url https://example.com/event.mov --duration 10000 --tag event=collision"
|
|
2481
2519
|
],
|
|
2482
2520
|
"flags": {
|
|
2483
2521
|
"json": {
|
|
@@ -2507,18 +2545,59 @@
|
|
|
2507
2545
|
"allowNo": false,
|
|
2508
2546
|
"type": "boolean"
|
|
2509
2547
|
},
|
|
2510
|
-
"
|
|
2548
|
+
"device": {
|
|
2511
2549
|
"char": "d",
|
|
2512
|
-
"description": "
|
|
2513
|
-
"name": "
|
|
2550
|
+
"description": "Device ID (UUID)",
|
|
2551
|
+
"name": "device",
|
|
2552
|
+
"required": true,
|
|
2514
2553
|
"hasDynamicHelp": false,
|
|
2515
2554
|
"multiple": false,
|
|
2516
2555
|
"type": "option"
|
|
2517
2556
|
},
|
|
2518
|
-
"
|
|
2519
|
-
"char": "
|
|
2520
|
-
"description": "
|
|
2521
|
-
"name": "
|
|
2557
|
+
"stream": {
|
|
2558
|
+
"char": "s",
|
|
2559
|
+
"description": "Stream name",
|
|
2560
|
+
"name": "stream",
|
|
2561
|
+
"required": true,
|
|
2562
|
+
"hasDynamicHelp": false,
|
|
2563
|
+
"multiple": false,
|
|
2564
|
+
"type": "option"
|
|
2565
|
+
},
|
|
2566
|
+
"url": {
|
|
2567
|
+
"char": "u",
|
|
2568
|
+
"description": "Video URL (must be http:// or https://)",
|
|
2569
|
+
"name": "url",
|
|
2570
|
+
"required": true,
|
|
2571
|
+
"hasDynamicHelp": false,
|
|
2572
|
+
"multiple": false,
|
|
2573
|
+
"type": "option"
|
|
2574
|
+
},
|
|
2575
|
+
"duration": {
|
|
2576
|
+
"description": "Video duration in milliseconds (required)",
|
|
2577
|
+
"name": "duration",
|
|
2578
|
+
"required": true,
|
|
2579
|
+
"hasDynamicHelp": false,
|
|
2580
|
+
"multiple": false,
|
|
2581
|
+
"type": "option"
|
|
2582
|
+
},
|
|
2583
|
+
"size": {
|
|
2584
|
+
"description": "Video size in bytes (optional)",
|
|
2585
|
+
"name": "size",
|
|
2586
|
+
"hasDynamicHelp": false,
|
|
2587
|
+
"multiple": false,
|
|
2588
|
+
"type": "option"
|
|
2589
|
+
},
|
|
2590
|
+
"tag": {
|
|
2591
|
+
"char": "t",
|
|
2592
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2593
|
+
"name": "tag",
|
|
2594
|
+
"hasDynamicHelp": false,
|
|
2595
|
+
"multiple": true,
|
|
2596
|
+
"type": "option"
|
|
2597
|
+
},
|
|
2598
|
+
"timestamp": {
|
|
2599
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2600
|
+
"name": "timestamp",
|
|
2522
2601
|
"hasDynamicHelp": false,
|
|
2523
2602
|
"multiple": false,
|
|
2524
2603
|
"type": "option"
|
|
@@ -2526,29 +2605,29 @@
|
|
|
2526
2605
|
},
|
|
2527
2606
|
"hasDynamicHelp": false,
|
|
2528
2607
|
"hiddenAliases": [],
|
|
2529
|
-
"id": "
|
|
2608
|
+
"id": "ingest:video",
|
|
2530
2609
|
"pluginAlias": "@formant/formant-cli",
|
|
2531
2610
|
"pluginName": "@formant/formant-cli",
|
|
2532
2611
|
"pluginType": "core",
|
|
2533
2612
|
"strict": true,
|
|
2534
|
-
"summary": "
|
|
2613
|
+
"summary": "Ingest video data",
|
|
2535
2614
|
"enableJsonFlag": true,
|
|
2536
2615
|
"isESM": true,
|
|
2537
2616
|
"relativePath": [
|
|
2538
2617
|
"dist",
|
|
2539
|
-
"commands",
|
|
2540
|
-
"
|
|
2541
|
-
"
|
|
2618
|
+
"commands",
|
|
2619
|
+
"ingest",
|
|
2620
|
+
"video.js"
|
|
2542
2621
|
]
|
|
2543
2622
|
},
|
|
2544
|
-
"
|
|
2623
|
+
"investigation:analytics": {
|
|
2545
2624
|
"aliases": [],
|
|
2546
2625
|
"args": {},
|
|
2547
2626
|
"description": "Get investigation analytics with time-series data.\n\nReturns aggregated analytics about investigation runs over a time range,\noptionally grouped by result type or signal type.",
|
|
2548
2627
|
"examples": [
|
|
2549
|
-
"<%= config.bin %>
|
|
2550
|
-
"<%= config.bin %>
|
|
2551
|
-
"<%= config.bin %>
|
|
2628
|
+
"<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01",
|
|
2629
|
+
"<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
|
|
2630
|
+
"<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
|
|
2552
2631
|
],
|
|
2553
2632
|
"flags": {
|
|
2554
2633
|
"json": {
|
|
@@ -2620,7 +2699,7 @@
|
|
|
2620
2699
|
},
|
|
2621
2700
|
"hasDynamicHelp": false,
|
|
2622
2701
|
"hiddenAliases": [],
|
|
2623
|
-
"id": "
|
|
2702
|
+
"id": "investigation:analytics",
|
|
2624
2703
|
"pluginAlias": "@formant/formant-cli",
|
|
2625
2704
|
"pluginName": "@formant/formant-cli",
|
|
2626
2705
|
"pluginType": "core",
|
|
@@ -2631,11 +2710,11 @@
|
|
|
2631
2710
|
"relativePath": [
|
|
2632
2711
|
"dist",
|
|
2633
2712
|
"commands",
|
|
2634
|
-
"
|
|
2713
|
+
"investigation",
|
|
2635
2714
|
"analytics.js"
|
|
2636
2715
|
]
|
|
2637
2716
|
},
|
|
2638
|
-
"
|
|
2717
|
+
"investigation:get": {
|
|
2639
2718
|
"aliases": [],
|
|
2640
2719
|
"args": {
|
|
2641
2720
|
"id": {
|
|
@@ -2646,8 +2725,8 @@
|
|
|
2646
2725
|
},
|
|
2647
2726
|
"description": "Get detailed information about a specific investigation by ID.",
|
|
2648
2727
|
"examples": [
|
|
2649
|
-
"<%= config.bin %>
|
|
2650
|
-
"<%= config.bin %>
|
|
2728
|
+
"<%= config.bin %> investigation get <id>",
|
|
2729
|
+
"<%= config.bin %> investigation get <id> --json"
|
|
2651
2730
|
],
|
|
2652
2731
|
"flags": {
|
|
2653
2732
|
"json": {
|
|
@@ -2680,7 +2759,7 @@
|
|
|
2680
2759
|
},
|
|
2681
2760
|
"hasDynamicHelp": false,
|
|
2682
2761
|
"hiddenAliases": [],
|
|
2683
|
-
"id": "
|
|
2762
|
+
"id": "investigation:get",
|
|
2684
2763
|
"pluginAlias": "@formant/formant-cli",
|
|
2685
2764
|
"pluginName": "@formant/formant-cli",
|
|
2686
2765
|
"pluginType": "core",
|
|
@@ -2691,18 +2770,18 @@
|
|
|
2691
2770
|
"relativePath": [
|
|
2692
2771
|
"dist",
|
|
2693
2772
|
"commands",
|
|
2694
|
-
"
|
|
2773
|
+
"investigation",
|
|
2695
2774
|
"get.js"
|
|
2696
2775
|
]
|
|
2697
2776
|
},
|
|
2698
|
-
"
|
|
2777
|
+
"investigation:list": {
|
|
2699
2778
|
"aliases": [],
|
|
2700
2779
|
"args": {},
|
|
2701
2780
|
"description": "List investigations (AI-powered analysis workflows) in your organization.\n\nInvestigations are automated AI workflows that analyze signals, diagnose problems,\nand produce reports. Use --signal-handler to filter for investigations that are\ntriggered automatically by signals.",
|
|
2702
2781
|
"examples": [
|
|
2703
|
-
"<%= config.bin %>
|
|
2704
|
-
"<%= config.bin %>
|
|
2705
|
-
"<%= config.bin %>
|
|
2782
|
+
"<%= config.bin %> investigation list",
|
|
2783
|
+
"<%= config.bin %> investigation list --signal-handler",
|
|
2784
|
+
"<%= config.bin %> investigation list --json"
|
|
2706
2785
|
],
|
|
2707
2786
|
"flags": {
|
|
2708
2787
|
"json": {
|
|
@@ -2741,7 +2820,7 @@
|
|
|
2741
2820
|
},
|
|
2742
2821
|
"hasDynamicHelp": false,
|
|
2743
2822
|
"hiddenAliases": [],
|
|
2744
|
-
"id": "
|
|
2823
|
+
"id": "investigation:list",
|
|
2745
2824
|
"pluginAlias": "@formant/formant-cli",
|
|
2746
2825
|
"pluginName": "@formant/formant-cli",
|
|
2747
2826
|
"pluginType": "core",
|
|
@@ -2752,11 +2831,11 @@
|
|
|
2752
2831
|
"relativePath": [
|
|
2753
2832
|
"dist",
|
|
2754
2833
|
"commands",
|
|
2755
|
-
"
|
|
2834
|
+
"investigation",
|
|
2756
2835
|
"list.js"
|
|
2757
2836
|
]
|
|
2758
2837
|
},
|
|
2759
|
-
"
|
|
2838
|
+
"investigation:run": {
|
|
2760
2839
|
"aliases": [],
|
|
2761
2840
|
"args": {
|
|
2762
2841
|
"investigationId": {
|
|
@@ -2772,9 +2851,9 @@
|
|
|
2772
2851
|
},
|
|
2773
2852
|
"description": "Get detailed information about a specific investigation run.\n\nShows run details including status, signal information, events, and the complete execution \nlog with node inputs/outputs, task messages, tool usage, and results.\n\nUse this to trace the investigation run back to its signal and triggering event.",
|
|
2774
2853
|
"examples": [
|
|
2775
|
-
"<%= config.bin %>
|
|
2776
|
-
"<%= config.bin %>
|
|
2777
|
-
"<%= config.bin %>
|
|
2854
|
+
"<%= config.bin %> investigation run <investigation-id> <run-id>",
|
|
2855
|
+
"<%= config.bin %> investigation run <investigation-id> <run-id> --log-only",
|
|
2856
|
+
"<%= config.bin %> investigation run <investigation-id> <run-id> --json"
|
|
2778
2857
|
],
|
|
2779
2858
|
"flags": {
|
|
2780
2859
|
"json": {
|
|
@@ -2819,7 +2898,7 @@
|
|
|
2819
2898
|
},
|
|
2820
2899
|
"hasDynamicHelp": false,
|
|
2821
2900
|
"hiddenAliases": [],
|
|
2822
|
-
"id": "
|
|
2901
|
+
"id": "investigation:run",
|
|
2823
2902
|
"pluginAlias": "@formant/formant-cli",
|
|
2824
2903
|
"pluginName": "@formant/formant-cli",
|
|
2825
2904
|
"pluginType": "core",
|
|
@@ -2830,11 +2909,11 @@
|
|
|
2830
2909
|
"relativePath": [
|
|
2831
2910
|
"dist",
|
|
2832
2911
|
"commands",
|
|
2833
|
-
"
|
|
2912
|
+
"investigation",
|
|
2834
2913
|
"run.js"
|
|
2835
2914
|
]
|
|
2836
2915
|
},
|
|
2837
|
-
"
|
|
2916
|
+
"investigation:runs-list": {
|
|
2838
2917
|
"aliases": [],
|
|
2839
2918
|
"args": {
|
|
2840
2919
|
"id": {
|
|
@@ -2845,9 +2924,9 @@
|
|
|
2845
2924
|
},
|
|
2846
2925
|
"description": "List actual investigation runs (not evaluation runs) for a specific investigation.\n\nShows runs with their status, signal IDs, and timestamps. Use 'investigations run' to see\ndetailed execution logs for a specific run.",
|
|
2847
2926
|
"examples": [
|
|
2848
|
-
"<%= config.bin %>
|
|
2849
|
-
"<%= config.bin %>
|
|
2850
|
-
"<%= config.bin %>
|
|
2927
|
+
"<%= config.bin %> investigation runs-list <id>",
|
|
2928
|
+
"<%= config.bin %> investigation runs-list <id> --limit 50",
|
|
2929
|
+
"<%= config.bin %> investigation runs-list <id> --details --json"
|
|
2851
2930
|
],
|
|
2852
2931
|
"flags": {
|
|
2853
2932
|
"json": {
|
|
@@ -2904,7 +2983,7 @@
|
|
|
2904
2983
|
},
|
|
2905
2984
|
"hasDynamicHelp": false,
|
|
2906
2985
|
"hiddenAliases": [],
|
|
2907
|
-
"id": "
|
|
2986
|
+
"id": "investigation:runs-list",
|
|
2908
2987
|
"pluginAlias": "@formant/formant-cli",
|
|
2909
2988
|
"pluginName": "@formant/formant-cli",
|
|
2910
2989
|
"pluginType": "core",
|
|
@@ -2915,11 +2994,11 @@
|
|
|
2915
2994
|
"relativePath": [
|
|
2916
2995
|
"dist",
|
|
2917
2996
|
"commands",
|
|
2918
|
-
"
|
|
2997
|
+
"investigation",
|
|
2919
2998
|
"runs-list.js"
|
|
2920
2999
|
]
|
|
2921
3000
|
},
|
|
2922
|
-
"
|
|
3001
|
+
"investigation:runs": {
|
|
2923
3002
|
"aliases": [],
|
|
2924
3003
|
"args": {
|
|
2925
3004
|
"id": {
|
|
@@ -2930,8 +3009,8 @@
|
|
|
2930
3009
|
},
|
|
2931
3010
|
"description": "List evaluation runs for a specific investigation.",
|
|
2932
3011
|
"examples": [
|
|
2933
|
-
"<%= config.bin %>
|
|
2934
|
-
"<%= config.bin %>
|
|
3012
|
+
"<%= config.bin %> investigation runs <id>",
|
|
3013
|
+
"<%= config.bin %> investigation runs <id> --json"
|
|
2935
3014
|
],
|
|
2936
3015
|
"flags": {
|
|
2937
3016
|
"json": {
|
|
@@ -2964,7 +3043,7 @@
|
|
|
2964
3043
|
},
|
|
2965
3044
|
"hasDynamicHelp": false,
|
|
2966
3045
|
"hiddenAliases": [],
|
|
2967
|
-
"id": "
|
|
3046
|
+
"id": "investigation:runs",
|
|
2968
3047
|
"pluginAlias": "@formant/formant-cli",
|
|
2969
3048
|
"pluginName": "@formant/formant-cli",
|
|
2970
3049
|
"pluginType": "core",
|
|
@@ -2975,17 +3054,17 @@
|
|
|
2975
3054
|
"relativePath": [
|
|
2976
3055
|
"dist",
|
|
2977
3056
|
"commands",
|
|
2978
|
-
"
|
|
3057
|
+
"investigation",
|
|
2979
3058
|
"runs.js"
|
|
2980
3059
|
]
|
|
2981
3060
|
},
|
|
2982
|
-
"
|
|
3061
|
+
"investigation:stats": {
|
|
2983
3062
|
"aliases": [],
|
|
2984
3063
|
"args": {},
|
|
2985
3064
|
"description": "Get investigation statistics for a time range.",
|
|
2986
3065
|
"examples": [
|
|
2987
|
-
"<%= config.bin %>
|
|
2988
|
-
"<%= config.bin %>
|
|
3066
|
+
"<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01",
|
|
3067
|
+
"<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01 --json"
|
|
2989
3068
|
],
|
|
2990
3069
|
"flags": {
|
|
2991
3070
|
"json": {
|
|
@@ -3034,7 +3113,7 @@
|
|
|
3034
3113
|
},
|
|
3035
3114
|
"hasDynamicHelp": false,
|
|
3036
3115
|
"hiddenAliases": [],
|
|
3037
|
-
"id": "
|
|
3116
|
+
"id": "investigation:stats",
|
|
3038
3117
|
"pluginAlias": "@formant/formant-cli",
|
|
3039
3118
|
"pluginName": "@formant/formant-cli",
|
|
3040
3119
|
"pluginType": "core",
|
|
@@ -3045,11 +3124,11 @@
|
|
|
3045
3124
|
"relativePath": [
|
|
3046
3125
|
"dist",
|
|
3047
3126
|
"commands",
|
|
3048
|
-
"
|
|
3127
|
+
"investigation",
|
|
3049
3128
|
"stats.js"
|
|
3050
3129
|
]
|
|
3051
3130
|
},
|
|
3052
|
-
"
|
|
3131
|
+
"investigation:trigger": {
|
|
3053
3132
|
"aliases": [],
|
|
3054
3133
|
"args": {
|
|
3055
3134
|
"id": {
|
|
@@ -3060,8 +3139,8 @@
|
|
|
3060
3139
|
},
|
|
3061
3140
|
"description": "Trigger an investigation to run. Provide input text describing the problem\nor context for the investigation. The investigation runs asynchronously and\nreturns a run ID you can use to check results.",
|
|
3062
3141
|
"examples": [
|
|
3063
|
-
"<%= config.bin %>
|
|
3064
|
-
"<%= config.bin %>
|
|
3142
|
+
"<%= config.bin %> investigation trigger <id> --input \"Robot stopped responding\"",
|
|
3143
|
+
"<%= config.bin %> investigation trigger <id> --input \"Battery draining fast on device X\" --json"
|
|
3065
3144
|
],
|
|
3066
3145
|
"flags": {
|
|
3067
3146
|
"json": {
|
|
@@ -3110,7 +3189,7 @@
|
|
|
3110
3189
|
},
|
|
3111
3190
|
"hasDynamicHelp": false,
|
|
3112
3191
|
"hiddenAliases": [],
|
|
3113
|
-
"id": "
|
|
3192
|
+
"id": "investigation:trigger",
|
|
3114
3193
|
"pluginAlias": "@formant/formant-cli",
|
|
3115
3194
|
"pluginName": "@formant/formant-cli",
|
|
3116
3195
|
"pluginType": "core",
|
|
@@ -3121,7 +3200,7 @@
|
|
|
3121
3200
|
"relativePath": [
|
|
3122
3201
|
"dist",
|
|
3123
3202
|
"commands",
|
|
3124
|
-
"
|
|
3203
|
+
"investigation",
|
|
3125
3204
|
"trigger.js"
|
|
3126
3205
|
]
|
|
3127
3206
|
},
|
|
@@ -3329,19 +3408,25 @@
|
|
|
3329
3408
|
"latest-values.js"
|
|
3330
3409
|
]
|
|
3331
3410
|
},
|
|
3332
|
-
"
|
|
3411
|
+
"persona:delegate-task": {
|
|
3333
3412
|
"aliases": [],
|
|
3334
3413
|
"args": {
|
|
3335
3414
|
"id": {
|
|
3336
|
-
"description": "
|
|
3415
|
+
"description": "Persona ID (UUID)",
|
|
3337
3416
|
"name": "id",
|
|
3338
3417
|
"required": true
|
|
3418
|
+
},
|
|
3419
|
+
"goal": {
|
|
3420
|
+
"description": "The task goal / instruction for the persona",
|
|
3421
|
+
"name": "goal",
|
|
3422
|
+
"required": true
|
|
3339
3423
|
}
|
|
3340
3424
|
},
|
|
3341
|
-
"description": "
|
|
3425
|
+
"description": "Delegate a task to a persona for async execution.\n\nCreates a task with the given goal, assigns it to the persona, and queues it to run in the background. Returns immediately with a task ID you can use to check status later via \"persona task-status\".",
|
|
3342
3426
|
"examples": [
|
|
3343
|
-
"<%= config.bin %>
|
|
3344
|
-
"<%= config.bin %>
|
|
3427
|
+
"<%= config.bin %> persona delegate-task <persona-id> \"Analyze recent device failures and summarize findings\"",
|
|
3428
|
+
"<%= config.bin %> persona delegate-task <persona-id> \"Generate a daily report of fleet health\" --name \"Daily Fleet Report\"",
|
|
3429
|
+
"<%= config.bin %> persona delegate-task <persona-id> \"Check all offline devices\" --dev"
|
|
3345
3430
|
],
|
|
3346
3431
|
"flags": {
|
|
3347
3432
|
"json": {
|
|
@@ -3370,32 +3455,102 @@
|
|
|
3370
3455
|
"name": "stage",
|
|
3371
3456
|
"allowNo": false,
|
|
3372
3457
|
"type": "boolean"
|
|
3458
|
+
},
|
|
3459
|
+
"name": {
|
|
3460
|
+
"char": "n",
|
|
3461
|
+
"description": "Task name (defaults to first 50 chars of goal)",
|
|
3462
|
+
"name": "name",
|
|
3463
|
+
"hasDynamicHelp": false,
|
|
3464
|
+
"multiple": false,
|
|
3465
|
+
"type": "option"
|
|
3373
3466
|
}
|
|
3374
3467
|
},
|
|
3375
3468
|
"hasDynamicHelp": false,
|
|
3376
3469
|
"hiddenAliases": [],
|
|
3377
|
-
"id": "
|
|
3470
|
+
"id": "persona:delegate-task",
|
|
3378
3471
|
"pluginAlias": "@formant/formant-cli",
|
|
3379
3472
|
"pluginName": "@formant/formant-cli",
|
|
3380
3473
|
"pluginType": "core",
|
|
3381
3474
|
"strict": true,
|
|
3382
|
-
"summary": "
|
|
3475
|
+
"summary": "Delegate an async task to a persona",
|
|
3476
|
+
"enableJsonFlag": true,
|
|
3477
|
+
"isESM": true,
|
|
3478
|
+
"relativePath": [
|
|
3479
|
+
"dist",
|
|
3480
|
+
"commands",
|
|
3481
|
+
"persona",
|
|
3482
|
+
"delegate-task.js"
|
|
3483
|
+
]
|
|
3484
|
+
},
|
|
3485
|
+
"persona:get": {
|
|
3486
|
+
"aliases": [],
|
|
3487
|
+
"args": {
|
|
3488
|
+
"id": {
|
|
3489
|
+
"description": "Persona ID (UUID)",
|
|
3490
|
+
"name": "id",
|
|
3491
|
+
"required": true
|
|
3492
|
+
}
|
|
3493
|
+
},
|
|
3494
|
+
"description": "Get detailed information about a persona including its integrations and available tools.\n\nUses the user-level persona endpoint which merges org, persona, and user configurations.",
|
|
3495
|
+
"examples": [
|
|
3496
|
+
"<%= config.bin %> personas get <persona-id>",
|
|
3497
|
+
"<%= config.bin %> personas get <persona-id> --json",
|
|
3498
|
+
"<%= config.bin %> personas get <persona-id> --dev"
|
|
3499
|
+
],
|
|
3500
|
+
"flags": {
|
|
3501
|
+
"json": {
|
|
3502
|
+
"description": "Format output as json.",
|
|
3503
|
+
"helpGroup": "GLOBAL",
|
|
3504
|
+
"name": "json",
|
|
3505
|
+
"allowNo": false,
|
|
3506
|
+
"type": "boolean"
|
|
3507
|
+
},
|
|
3508
|
+
"dev": {
|
|
3509
|
+
"description": "Target the dev environment",
|
|
3510
|
+
"exclusive": [
|
|
3511
|
+
"stage"
|
|
3512
|
+
],
|
|
3513
|
+
"helpGroup": "GLOBAL",
|
|
3514
|
+
"name": "dev",
|
|
3515
|
+
"allowNo": false,
|
|
3516
|
+
"type": "boolean"
|
|
3517
|
+
},
|
|
3518
|
+
"stage": {
|
|
3519
|
+
"description": "Target the stage environment",
|
|
3520
|
+
"exclusive": [
|
|
3521
|
+
"dev"
|
|
3522
|
+
],
|
|
3523
|
+
"helpGroup": "GLOBAL",
|
|
3524
|
+
"name": "stage",
|
|
3525
|
+
"allowNo": false,
|
|
3526
|
+
"type": "boolean"
|
|
3527
|
+
}
|
|
3528
|
+
},
|
|
3529
|
+
"hasDynamicHelp": false,
|
|
3530
|
+
"hiddenAliases": [],
|
|
3531
|
+
"id": "persona:get",
|
|
3532
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3533
|
+
"pluginName": "@formant/formant-cli",
|
|
3534
|
+
"pluginType": "core",
|
|
3535
|
+
"strict": true,
|
|
3536
|
+
"summary": "Get persona details and tools",
|
|
3383
3537
|
"enableJsonFlag": true,
|
|
3384
3538
|
"isESM": true,
|
|
3385
3539
|
"relativePath": [
|
|
3386
3540
|
"dist",
|
|
3387
3541
|
"commands",
|
|
3388
|
-
"
|
|
3542
|
+
"persona",
|
|
3389
3543
|
"get.js"
|
|
3390
3544
|
]
|
|
3391
3545
|
},
|
|
3392
|
-
"
|
|
3546
|
+
"persona:list": {
|
|
3393
3547
|
"aliases": [],
|
|
3394
3548
|
"args": {},
|
|
3395
|
-
"description": "List
|
|
3549
|
+
"description": "List AI personas available in your organization.\n\nShows both built-in and custom personas with their ID, name, and description.",
|
|
3396
3550
|
"examples": [
|
|
3397
|
-
"<%= config.bin %>
|
|
3398
|
-
"<%= config.bin %>
|
|
3551
|
+
"<%= config.bin %> personas list",
|
|
3552
|
+
"<%= config.bin %> personas list --json",
|
|
3553
|
+
"<%= config.bin %> personas list --dev"
|
|
3399
3554
|
],
|
|
3400
3555
|
"flags": {
|
|
3401
3556
|
"json": {
|
|
@@ -3428,22 +3583,83 @@
|
|
|
3428
3583
|
},
|
|
3429
3584
|
"hasDynamicHelp": false,
|
|
3430
3585
|
"hiddenAliases": [],
|
|
3431
|
-
"id": "
|
|
3586
|
+
"id": "persona:list",
|
|
3432
3587
|
"pluginAlias": "@formant/formant-cli",
|
|
3433
3588
|
"pluginName": "@formant/formant-cli",
|
|
3434
3589
|
"pluginType": "core",
|
|
3435
3590
|
"strict": true,
|
|
3436
|
-
"summary": "List
|
|
3591
|
+
"summary": "List AI personas",
|
|
3437
3592
|
"enableJsonFlag": true,
|
|
3438
3593
|
"isESM": true,
|
|
3439
3594
|
"relativePath": [
|
|
3440
3595
|
"dist",
|
|
3441
3596
|
"commands",
|
|
3442
|
-
"
|
|
3597
|
+
"persona",
|
|
3443
3598
|
"list.js"
|
|
3444
3599
|
]
|
|
3445
3600
|
},
|
|
3446
|
-
"
|
|
3601
|
+
"persona:task-status": {
|
|
3602
|
+
"aliases": [],
|
|
3603
|
+
"args": {
|
|
3604
|
+
"taskId": {
|
|
3605
|
+
"description": "Task ID (from delegate-task output)",
|
|
3606
|
+
"name": "taskId",
|
|
3607
|
+
"required": true
|
|
3608
|
+
}
|
|
3609
|
+
},
|
|
3610
|
+
"description": "Check the status and results of a delegated task.\n\nShows all runs for a task including their status, result summary, and timestamps.",
|
|
3611
|
+
"examples": [
|
|
3612
|
+
"<%= config.bin %> persona task-status <task-id>",
|
|
3613
|
+
"<%= config.bin %> persona task-status <task-id> --json",
|
|
3614
|
+
"<%= config.bin %> persona task-status <task-id> --dev"
|
|
3615
|
+
],
|
|
3616
|
+
"flags": {
|
|
3617
|
+
"json": {
|
|
3618
|
+
"description": "Format output as json.",
|
|
3619
|
+
"helpGroup": "GLOBAL",
|
|
3620
|
+
"name": "json",
|
|
3621
|
+
"allowNo": false,
|
|
3622
|
+
"type": "boolean"
|
|
3623
|
+
},
|
|
3624
|
+
"dev": {
|
|
3625
|
+
"description": "Target the dev environment",
|
|
3626
|
+
"exclusive": [
|
|
3627
|
+
"stage"
|
|
3628
|
+
],
|
|
3629
|
+
"helpGroup": "GLOBAL",
|
|
3630
|
+
"name": "dev",
|
|
3631
|
+
"allowNo": false,
|
|
3632
|
+
"type": "boolean"
|
|
3633
|
+
},
|
|
3634
|
+
"stage": {
|
|
3635
|
+
"description": "Target the stage environment",
|
|
3636
|
+
"exclusive": [
|
|
3637
|
+
"dev"
|
|
3638
|
+
],
|
|
3639
|
+
"helpGroup": "GLOBAL",
|
|
3640
|
+
"name": "stage",
|
|
3641
|
+
"allowNo": false,
|
|
3642
|
+
"type": "boolean"
|
|
3643
|
+
}
|
|
3644
|
+
},
|
|
3645
|
+
"hasDynamicHelp": false,
|
|
3646
|
+
"hiddenAliases": [],
|
|
3647
|
+
"id": "persona:task-status",
|
|
3648
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3649
|
+
"pluginName": "@formant/formant-cli",
|
|
3650
|
+
"pluginType": "core",
|
|
3651
|
+
"strict": true,
|
|
3652
|
+
"summary": "Check status of a delegated task",
|
|
3653
|
+
"enableJsonFlag": true,
|
|
3654
|
+
"isESM": true,
|
|
3655
|
+
"relativePath": [
|
|
3656
|
+
"dist",
|
|
3657
|
+
"commands",
|
|
3658
|
+
"persona",
|
|
3659
|
+
"task-status.js"
|
|
3660
|
+
]
|
|
3661
|
+
},
|
|
3662
|
+
"schedule:get": {
|
|
3447
3663
|
"aliases": [],
|
|
3448
3664
|
"args": {
|
|
3449
3665
|
"id": {
|
|
@@ -3454,8 +3670,8 @@
|
|
|
3454
3670
|
},
|
|
3455
3671
|
"description": "Get detailed information about a schedule.\n\nShows the full schedule configuration including cron expression, command template,\ninvestigation link, and execution settings.",
|
|
3456
3672
|
"examples": [
|
|
3457
|
-
"<%= config.bin %>
|
|
3458
|
-
"<%= config.bin %>
|
|
3673
|
+
"<%= config.bin %> schedule get <schedule-id>",
|
|
3674
|
+
"<%= config.bin %> schedule get <schedule-id> --json"
|
|
3459
3675
|
],
|
|
3460
3676
|
"flags": {
|
|
3461
3677
|
"json": {
|
|
@@ -3488,7 +3704,7 @@
|
|
|
3488
3704
|
},
|
|
3489
3705
|
"hasDynamicHelp": false,
|
|
3490
3706
|
"hiddenAliases": [],
|
|
3491
|
-
"id": "
|
|
3707
|
+
"id": "schedule:get",
|
|
3492
3708
|
"pluginAlias": "@formant/formant-cli",
|
|
3493
3709
|
"pluginName": "@formant/formant-cli",
|
|
3494
3710
|
"pluginType": "core",
|
|
@@ -3499,17 +3715,17 @@
|
|
|
3499
3715
|
"relativePath": [
|
|
3500
3716
|
"dist",
|
|
3501
3717
|
"commands",
|
|
3502
|
-
"
|
|
3718
|
+
"schedule",
|
|
3503
3719
|
"get.js"
|
|
3504
3720
|
]
|
|
3505
3721
|
},
|
|
3506
|
-
"
|
|
3722
|
+
"schedule:list": {
|
|
3507
3723
|
"aliases": [],
|
|
3508
3724
|
"args": {},
|
|
3509
3725
|
"description": "List all schedules in your organization.\n\nSchedules can trigger commands or investigations on a recurring (cron) or one-time basis.",
|
|
3510
3726
|
"examples": [
|
|
3511
|
-
"<%= config.bin %>
|
|
3512
|
-
"<%= config.bin %>
|
|
3727
|
+
"<%= config.bin %> schedule list",
|
|
3728
|
+
"<%= config.bin %> schedule list --json"
|
|
3513
3729
|
],
|
|
3514
3730
|
"flags": {
|
|
3515
3731
|
"json": {
|
|
@@ -3542,7 +3758,7 @@
|
|
|
3542
3758
|
},
|
|
3543
3759
|
"hasDynamicHelp": false,
|
|
3544
3760
|
"hiddenAliases": [],
|
|
3545
|
-
"id": "
|
|
3761
|
+
"id": "schedule:list",
|
|
3546
3762
|
"pluginAlias": "@formant/formant-cli",
|
|
3547
3763
|
"pluginName": "@formant/formant-cli",
|
|
3548
3764
|
"pluginType": "core",
|
|
@@ -3553,11 +3769,11 @@
|
|
|
3553
3769
|
"relativePath": [
|
|
3554
3770
|
"dist",
|
|
3555
3771
|
"commands",
|
|
3556
|
-
"
|
|
3772
|
+
"schedule",
|
|
3557
3773
|
"list.js"
|
|
3558
3774
|
]
|
|
3559
3775
|
},
|
|
3560
|
-
"
|
|
3776
|
+
"user:get": {
|
|
3561
3777
|
"aliases": [],
|
|
3562
3778
|
"args": {
|
|
3563
3779
|
"id": {
|
|
@@ -3568,8 +3784,8 @@
|
|
|
3568
3784
|
},
|
|
3569
3785
|
"description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.",
|
|
3570
3786
|
"examples": [
|
|
3571
|
-
"<%= config.bin %>
|
|
3572
|
-
"<%= config.bin %>
|
|
3787
|
+
"<%= config.bin %> user get <user-id>",
|
|
3788
|
+
"<%= config.bin %> user get <user-id> --json"
|
|
3573
3789
|
],
|
|
3574
3790
|
"flags": {
|
|
3575
3791
|
"json": {
|
|
@@ -3602,7 +3818,7 @@
|
|
|
3602
3818
|
},
|
|
3603
3819
|
"hasDynamicHelp": false,
|
|
3604
3820
|
"hiddenAliases": [],
|
|
3605
|
-
"id": "
|
|
3821
|
+
"id": "user:get",
|
|
3606
3822
|
"pluginAlias": "@formant/formant-cli",
|
|
3607
3823
|
"pluginName": "@formant/formant-cli",
|
|
3608
3824
|
"pluginType": "core",
|
|
@@ -3613,17 +3829,17 @@
|
|
|
3613
3829
|
"relativePath": [
|
|
3614
3830
|
"dist",
|
|
3615
3831
|
"commands",
|
|
3616
|
-
"
|
|
3832
|
+
"user",
|
|
3617
3833
|
"get.js"
|
|
3618
3834
|
]
|
|
3619
3835
|
},
|
|
3620
|
-
"
|
|
3836
|
+
"user:list": {
|
|
3621
3837
|
"aliases": [],
|
|
3622
3838
|
"args": {},
|
|
3623
3839
|
"description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.",
|
|
3624
3840
|
"examples": [
|
|
3625
|
-
"<%= config.bin %>
|
|
3626
|
-
"<%= config.bin %>
|
|
3841
|
+
"<%= config.bin %> user list",
|
|
3842
|
+
"<%= config.bin %> user list --json"
|
|
3627
3843
|
],
|
|
3628
3844
|
"flags": {
|
|
3629
3845
|
"json": {
|
|
@@ -3656,7 +3872,7 @@
|
|
|
3656
3872
|
},
|
|
3657
3873
|
"hasDynamicHelp": false,
|
|
3658
3874
|
"hiddenAliases": [],
|
|
3659
|
-
"id": "
|
|
3875
|
+
"id": "user:list",
|
|
3660
3876
|
"pluginAlias": "@formant/formant-cli",
|
|
3661
3877
|
"pluginName": "@formant/formant-cli",
|
|
3662
3878
|
"pluginType": "core",
|
|
@@ -3667,18 +3883,18 @@
|
|
|
3667
3883
|
"relativePath": [
|
|
3668
3884
|
"dist",
|
|
3669
3885
|
"commands",
|
|
3670
|
-
"
|
|
3886
|
+
"user",
|
|
3671
3887
|
"list.js"
|
|
3672
3888
|
]
|
|
3673
3889
|
},
|
|
3674
|
-
"
|
|
3890
|
+
"signal:count": {
|
|
3675
3891
|
"aliases": [],
|
|
3676
3892
|
"args": {},
|
|
3677
3893
|
"description": "Get counts of signals grouped by type.\n\nReturns total counts and per-type breakdowns (manual, eventTrigger, schedule, slack).",
|
|
3678
3894
|
"examples": [
|
|
3679
|
-
"<%= config.bin %>
|
|
3680
|
-
"<%= config.bin %>
|
|
3681
|
-
"<%= config.bin %>
|
|
3895
|
+
"<%= config.bin %> signal count",
|
|
3896
|
+
"<%= config.bin %> signal count --start 2026-01-01 --end 2026-02-01",
|
|
3897
|
+
"<%= config.bin %> signal count --json"
|
|
3682
3898
|
],
|
|
3683
3899
|
"flags": {
|
|
3684
3900
|
"json": {
|
|
@@ -3725,7 +3941,7 @@
|
|
|
3725
3941
|
},
|
|
3726
3942
|
"hasDynamicHelp": false,
|
|
3727
3943
|
"hiddenAliases": [],
|
|
3728
|
-
"id": "
|
|
3944
|
+
"id": "signal:count",
|
|
3729
3945
|
"pluginAlias": "@formant/formant-cli",
|
|
3730
3946
|
"pluginName": "@formant/formant-cli",
|
|
3731
3947
|
"pluginType": "core",
|
|
@@ -3736,11 +3952,109 @@
|
|
|
3736
3952
|
"relativePath": [
|
|
3737
3953
|
"dist",
|
|
3738
3954
|
"commands",
|
|
3739
|
-
"
|
|
3955
|
+
"signal",
|
|
3740
3956
|
"count.js"
|
|
3741
3957
|
]
|
|
3742
3958
|
},
|
|
3743
|
-
"
|
|
3959
|
+
"signal:create": {
|
|
3960
|
+
"aliases": [],
|
|
3961
|
+
"args": {
|
|
3962
|
+
"goal": {
|
|
3963
|
+
"description": "Goal or description for the signal",
|
|
3964
|
+
"name": "goal",
|
|
3965
|
+
"required": true
|
|
3966
|
+
}
|
|
3967
|
+
},
|
|
3968
|
+
"description": "Create a manual signal.\n\nSignals are points of interest that can trigger AI-powered investigations. Use this to\nmanually create a signal with a goal description, optionally targeting a specific device\nor persona.",
|
|
3969
|
+
"examples": [
|
|
3970
|
+
"<%= config.bin %> signal create \"Robot arm jammed at joint 3\"",
|
|
3971
|
+
"<%= config.bin %> signal create \"Battery draining fast\" --device <device-id>",
|
|
3972
|
+
"<%= config.bin %> signal create \"Investigate sensor anomaly\" --persona <persona-id>",
|
|
3973
|
+
"<%= config.bin %> signal create \"Test alarm scenario\" --investigation <taskflow-id>",
|
|
3974
|
+
"<%= config.bin %> signal create \"Motor overheated\" --investigation <id> --ground-truth \"Should identify motor thermal fault\""
|
|
3975
|
+
],
|
|
3976
|
+
"flags": {
|
|
3977
|
+
"json": {
|
|
3978
|
+
"description": "Format output as json.",
|
|
3979
|
+
"helpGroup": "GLOBAL",
|
|
3980
|
+
"name": "json",
|
|
3981
|
+
"allowNo": false,
|
|
3982
|
+
"type": "boolean"
|
|
3983
|
+
},
|
|
3984
|
+
"dev": {
|
|
3985
|
+
"description": "Target the dev environment",
|
|
3986
|
+
"exclusive": [
|
|
3987
|
+
"stage"
|
|
3988
|
+
],
|
|
3989
|
+
"helpGroup": "GLOBAL",
|
|
3990
|
+
"name": "dev",
|
|
3991
|
+
"allowNo": false,
|
|
3992
|
+
"type": "boolean"
|
|
3993
|
+
},
|
|
3994
|
+
"stage": {
|
|
3995
|
+
"description": "Target the stage environment",
|
|
3996
|
+
"exclusive": [
|
|
3997
|
+
"dev"
|
|
3998
|
+
],
|
|
3999
|
+
"helpGroup": "GLOBAL",
|
|
4000
|
+
"name": "stage",
|
|
4001
|
+
"allowNo": false,
|
|
4002
|
+
"type": "boolean"
|
|
4003
|
+
},
|
|
4004
|
+
"device": {
|
|
4005
|
+
"char": "d",
|
|
4006
|
+
"description": "Device ID to associate with this signal",
|
|
4007
|
+
"name": "device",
|
|
4008
|
+
"hasDynamicHelp": false,
|
|
4009
|
+
"multiple": false,
|
|
4010
|
+
"type": "option"
|
|
4011
|
+
},
|
|
4012
|
+
"ground-truth": {
|
|
4013
|
+
"char": "g",
|
|
4014
|
+
"dependsOn": [
|
|
4015
|
+
"investigation"
|
|
4016
|
+
],
|
|
4017
|
+
"description": "Expected outcome (ground truth) for this signal — requires --investigation",
|
|
4018
|
+
"name": "ground-truth",
|
|
4019
|
+
"hasDynamicHelp": false,
|
|
4020
|
+
"multiple": false,
|
|
4021
|
+
"type": "option"
|
|
4022
|
+
},
|
|
4023
|
+
"investigation": {
|
|
4024
|
+
"char": "i",
|
|
4025
|
+
"description": "Investigation (taskflow) ID this signal targets",
|
|
4026
|
+
"name": "investigation",
|
|
4027
|
+
"hasDynamicHelp": false,
|
|
4028
|
+
"multiple": false,
|
|
4029
|
+
"type": "option"
|
|
4030
|
+
},
|
|
4031
|
+
"persona": {
|
|
4032
|
+
"char": "p",
|
|
4033
|
+
"description": "Persona ID to handle this signal",
|
|
4034
|
+
"name": "persona",
|
|
4035
|
+
"hasDynamicHelp": false,
|
|
4036
|
+
"multiple": false,
|
|
4037
|
+
"type": "option"
|
|
4038
|
+
}
|
|
4039
|
+
},
|
|
4040
|
+
"hasDynamicHelp": false,
|
|
4041
|
+
"hiddenAliases": [],
|
|
4042
|
+
"id": "signal:create",
|
|
4043
|
+
"pluginAlias": "@formant/formant-cli",
|
|
4044
|
+
"pluginName": "@formant/formant-cli",
|
|
4045
|
+
"pluginType": "core",
|
|
4046
|
+
"strict": true,
|
|
4047
|
+
"summary": "Create a manual signal",
|
|
4048
|
+
"enableJsonFlag": true,
|
|
4049
|
+
"isESM": true,
|
|
4050
|
+
"relativePath": [
|
|
4051
|
+
"dist",
|
|
4052
|
+
"commands",
|
|
4053
|
+
"signal",
|
|
4054
|
+
"create.js"
|
|
4055
|
+
]
|
|
4056
|
+
},
|
|
4057
|
+
"signal:get": {
|
|
3744
4058
|
"aliases": [],
|
|
3745
4059
|
"args": {
|
|
3746
4060
|
"id": {
|
|
@@ -3751,9 +4065,9 @@
|
|
|
3751
4065
|
},
|
|
3752
4066
|
"description": "Get detailed information about a specific signal by its ID.\n\nShows signal details including the triggering event, goal, status, and type (manual, \neventTrigger, schedule, slack). Use --trace to also fetch the event and event trigger \ninformation.",
|
|
3753
4067
|
"examples": [
|
|
3754
|
-
"<%= config.bin %>
|
|
3755
|
-
"<%= config.bin %>
|
|
3756
|
-
"<%= config.bin %>
|
|
4068
|
+
"<%= config.bin %> signal get <signal-id>",
|
|
4069
|
+
"<%= config.bin %> signal get <signal-id> --trace",
|
|
4070
|
+
"<%= config.bin %> signal get <signal-id> --json"
|
|
3757
4071
|
],
|
|
3758
4072
|
"flags": {
|
|
3759
4073
|
"json": {
|
|
@@ -3792,7 +4106,7 @@
|
|
|
3792
4106
|
},
|
|
3793
4107
|
"hasDynamicHelp": false,
|
|
3794
4108
|
"hiddenAliases": [],
|
|
3795
|
-
"id": "
|
|
4109
|
+
"id": "signal:get",
|
|
3796
4110
|
"pluginAlias": "@formant/formant-cli",
|
|
3797
4111
|
"pluginName": "@formant/formant-cli",
|
|
3798
4112
|
"pluginType": "core",
|
|
@@ -3803,17 +4117,18 @@
|
|
|
3803
4117
|
"relativePath": [
|
|
3804
4118
|
"dist",
|
|
3805
4119
|
"commands",
|
|
3806
|
-
"
|
|
4120
|
+
"signal",
|
|
3807
4121
|
"get.js"
|
|
3808
4122
|
]
|
|
3809
4123
|
},
|
|
3810
|
-
"
|
|
4124
|
+
"signal:list": {
|
|
3811
4125
|
"aliases": [],
|
|
3812
4126
|
"args": {},
|
|
3813
|
-
"description": "List all signals in your organization.\n\nSignals are points of interest that trigger AI-powered investigations. They can be\ncreated manually, generated from device events, scheduled, or from Slack/Teams integrations.",
|
|
4127
|
+
"description": "List all signals in your organization.\n\nSignals are points of interest that trigger AI-powered investigations. They can be\ncreated manually, generated from device events, scheduled, or from Slack/Teams integrations.\n\nUse --investigation to also show ground truth (expected outcome) for each signal\nthat has one assigned for that investigation.",
|
|
3814
4128
|
"examples": [
|
|
3815
|
-
"<%= config.bin %>
|
|
3816
|
-
"<%= config.bin %>
|
|
4129
|
+
"<%= config.bin %> signal list",
|
|
4130
|
+
"<%= config.bin %> signal list --investigation <taskflow-id>",
|
|
4131
|
+
"<%= config.bin %> signal list --json"
|
|
3817
4132
|
],
|
|
3818
4133
|
"flags": {
|
|
3819
4134
|
"json": {
|
|
@@ -3842,11 +4157,19 @@
|
|
|
3842
4157
|
"name": "stage",
|
|
3843
4158
|
"allowNo": false,
|
|
3844
4159
|
"type": "boolean"
|
|
4160
|
+
},
|
|
4161
|
+
"investigation": {
|
|
4162
|
+
"char": "i",
|
|
4163
|
+
"description": "Investigation (taskflow) ID — shows ground truth for signals that have one",
|
|
4164
|
+
"name": "investigation",
|
|
4165
|
+
"hasDynamicHelp": false,
|
|
4166
|
+
"multiple": false,
|
|
4167
|
+
"type": "option"
|
|
3845
4168
|
}
|
|
3846
4169
|
},
|
|
3847
4170
|
"hasDynamicHelp": false,
|
|
3848
4171
|
"hiddenAliases": [],
|
|
3849
|
-
"id": "
|
|
4172
|
+
"id": "signal:list",
|
|
3850
4173
|
"pluginAlias": "@formant/formant-cli",
|
|
3851
4174
|
"pluginName": "@formant/formant-cli",
|
|
3852
4175
|
"pluginType": "core",
|
|
@@ -3857,18 +4180,19 @@
|
|
|
3857
4180
|
"relativePath": [
|
|
3858
4181
|
"dist",
|
|
3859
4182
|
"commands",
|
|
3860
|
-
"
|
|
4183
|
+
"signal",
|
|
3861
4184
|
"list.js"
|
|
3862
4185
|
]
|
|
3863
4186
|
},
|
|
3864
|
-
"
|
|
4187
|
+
"signal:query": {
|
|
3865
4188
|
"aliases": [],
|
|
3866
4189
|
"args": {},
|
|
3867
|
-
"description": "Query signals by time range and type.\n\nSignal types: manual, eventTrigger, schedule, slack.",
|
|
4190
|
+
"description": "Query signals by time range and type.\n\nSignal types: manual, eventTrigger, schedule, slack.\n\nUse --investigation to also show ground truth (expected outcome) for each signal.",
|
|
3868
4191
|
"examples": [
|
|
3869
|
-
"<%= config.bin %>
|
|
3870
|
-
"<%= config.bin %>
|
|
3871
|
-
"<%= config.bin %>
|
|
4192
|
+
"<%= config.bin %> signal query --start 2026-01-01",
|
|
4193
|
+
"<%= config.bin %> signal query --start 2026-01-01 --end 2026-02-01 --type eventTrigger",
|
|
4194
|
+
"<%= config.bin %> signal query --start 2026-01-01 --investigation <taskflow-id>",
|
|
4195
|
+
"<%= config.bin %> signal query --start 2026-01-01 --json"
|
|
3872
4196
|
],
|
|
3873
4197
|
"flags": {
|
|
3874
4198
|
"json": {
|
|
@@ -3905,6 +4229,14 @@
|
|
|
3905
4229
|
"multiple": false,
|
|
3906
4230
|
"type": "option"
|
|
3907
4231
|
},
|
|
4232
|
+
"investigation": {
|
|
4233
|
+
"char": "i",
|
|
4234
|
+
"description": "Investigation (taskflow) ID — shows ground truth for signals that have one",
|
|
4235
|
+
"name": "investigation",
|
|
4236
|
+
"hasDynamicHelp": false,
|
|
4237
|
+
"multiple": false,
|
|
4238
|
+
"type": "option"
|
|
4239
|
+
},
|
|
3908
4240
|
"start": {
|
|
3909
4241
|
"description": "Start time (ISO 8601)",
|
|
3910
4242
|
"name": "start",
|
|
@@ -3929,7 +4261,7 @@
|
|
|
3929
4261
|
},
|
|
3930
4262
|
"hasDynamicHelp": false,
|
|
3931
4263
|
"hiddenAliases": [],
|
|
3932
|
-
"id": "
|
|
4264
|
+
"id": "signal:query",
|
|
3933
4265
|
"pluginAlias": "@formant/formant-cli",
|
|
3934
4266
|
"pluginName": "@formant/formant-cli",
|
|
3935
4267
|
"pluginType": "core",
|
|
@@ -3940,10 +4272,80 @@
|
|
|
3940
4272
|
"relativePath": [
|
|
3941
4273
|
"dist",
|
|
3942
4274
|
"commands",
|
|
3943
|
-
"
|
|
4275
|
+
"signal",
|
|
3944
4276
|
"query.js"
|
|
3945
4277
|
]
|
|
4278
|
+
},
|
|
4279
|
+
"signal:set-ground-truth": {
|
|
4280
|
+
"aliases": [],
|
|
4281
|
+
"args": {
|
|
4282
|
+
"signalId": {
|
|
4283
|
+
"description": "Signal ID (UUID)",
|
|
4284
|
+
"name": "signalId",
|
|
4285
|
+
"required": true
|
|
4286
|
+
},
|
|
4287
|
+
"investigationId": {
|
|
4288
|
+
"description": "Investigation (taskflow) ID",
|
|
4289
|
+
"name": "investigationId",
|
|
4290
|
+
"required": true
|
|
4291
|
+
},
|
|
4292
|
+
"expectedOutcome": {
|
|
4293
|
+
"description": "The expected outcome / ground truth for this signal",
|
|
4294
|
+
"name": "expectedOutcome",
|
|
4295
|
+
"required": true
|
|
4296
|
+
}
|
|
4297
|
+
},
|
|
4298
|
+
"description": "Assign a ground truth (expected outcome) to a signal for an investigation.\n\nGround truths define what the correct outcome should be when an investigation processes\na given signal. They are used for evaluation and quality measurement of investigation\nworkflows.",
|
|
4299
|
+
"examples": [
|
|
4300
|
+
"<%= config.bin %> signal set-ground-truth <signal-id> <investigation-id> \"The alarm should be dismissed as a false positive\"",
|
|
4301
|
+
"<%= config.bin %> signal set-ground-truth <signal-id> <investigation-id> \"Root cause: overheated motor in joint 3\" --json"
|
|
4302
|
+
],
|
|
4303
|
+
"flags": {
|
|
4304
|
+
"json": {
|
|
4305
|
+
"description": "Format output as json.",
|
|
4306
|
+
"helpGroup": "GLOBAL",
|
|
4307
|
+
"name": "json",
|
|
4308
|
+
"allowNo": false,
|
|
4309
|
+
"type": "boolean"
|
|
4310
|
+
},
|
|
4311
|
+
"dev": {
|
|
4312
|
+
"description": "Target the dev environment",
|
|
4313
|
+
"exclusive": [
|
|
4314
|
+
"stage"
|
|
4315
|
+
],
|
|
4316
|
+
"helpGroup": "GLOBAL",
|
|
4317
|
+
"name": "dev",
|
|
4318
|
+
"allowNo": false,
|
|
4319
|
+
"type": "boolean"
|
|
4320
|
+
},
|
|
4321
|
+
"stage": {
|
|
4322
|
+
"description": "Target the stage environment",
|
|
4323
|
+
"exclusive": [
|
|
4324
|
+
"dev"
|
|
4325
|
+
],
|
|
4326
|
+
"helpGroup": "GLOBAL",
|
|
4327
|
+
"name": "stage",
|
|
4328
|
+
"allowNo": false,
|
|
4329
|
+
"type": "boolean"
|
|
4330
|
+
}
|
|
4331
|
+
},
|
|
4332
|
+
"hasDynamicHelp": false,
|
|
4333
|
+
"hiddenAliases": [],
|
|
4334
|
+
"id": "signal:set-ground-truth",
|
|
4335
|
+
"pluginAlias": "@formant/formant-cli",
|
|
4336
|
+
"pluginName": "@formant/formant-cli",
|
|
4337
|
+
"pluginType": "core",
|
|
4338
|
+
"strict": true,
|
|
4339
|
+
"summary": "Assign ground truth to a signal",
|
|
4340
|
+
"enableJsonFlag": true,
|
|
4341
|
+
"isESM": true,
|
|
4342
|
+
"relativePath": [
|
|
4343
|
+
"dist",
|
|
4344
|
+
"commands",
|
|
4345
|
+
"signal",
|
|
4346
|
+
"set-ground-truth.js"
|
|
4347
|
+
]
|
|
3946
4348
|
}
|
|
3947
4349
|
},
|
|
3948
|
-
"version": "0.3
|
|
4350
|
+
"version": "0.4.3"
|
|
3949
4351
|
}
|