@formant/formant-cli 0.3.0 → 0.4.2
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 +152 -124
- 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}/last-seen.js +2 -2
- package/dist/commands/device/last-seen.js.map +1 -0
- package/dist/commands/{devices → device}/list.js +5 -5
- 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 +3 -0
- package/dist/commands/device/streams.js +100 -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/query/latest-values.d.ts +1 -0
- package/dist/commands/query/latest-values.js +41 -15
- package/dist/commands/query/latest-values.js.map +1 -1
- 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/oclif.manifest.json +1288 -834
- 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.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 -56
- 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}/last-seen.d.ts +0 -0
- /package/dist/commands/{devices → device}/list.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,7 +140,7 @@
|
|
|
140
140
|
"tables.js"
|
|
141
141
|
]
|
|
142
142
|
},
|
|
143
|
-
"
|
|
143
|
+
"event:get": {
|
|
144
144
|
"aliases": [],
|
|
145
145
|
"args": {
|
|
146
146
|
"id": {
|
|
@@ -151,8 +151,8 @@
|
|
|
151
151
|
},
|
|
152
152
|
"description": "Get detailed information about a specific event by its ID.",
|
|
153
153
|
"examples": [
|
|
154
|
-
"<%= config.bin %>
|
|
155
|
-
"<%= config.bin %>
|
|
154
|
+
"<%= config.bin %> event get <event-id>",
|
|
155
|
+
"<%= config.bin %> event get <event-id> --json"
|
|
156
156
|
],
|
|
157
157
|
"flags": {
|
|
158
158
|
"json": {
|
|
@@ -185,7 +185,7 @@
|
|
|
185
185
|
},
|
|
186
186
|
"hasDynamicHelp": false,
|
|
187
187
|
"hiddenAliases": [],
|
|
188
|
-
"id": "
|
|
188
|
+
"id": "event:get",
|
|
189
189
|
"pluginAlias": "@formant/formant-cli",
|
|
190
190
|
"pluginName": "@formant/formant-cli",
|
|
191
191
|
"pluginType": "core",
|
|
@@ -196,19 +196,19 @@
|
|
|
196
196
|
"relativePath": [
|
|
197
197
|
"dist",
|
|
198
198
|
"commands",
|
|
199
|
-
"
|
|
199
|
+
"event",
|
|
200
200
|
"get.js"
|
|
201
201
|
]
|
|
202
202
|
},
|
|
203
|
-
"
|
|
203
|
+
"event:list": {
|
|
204
204
|
"aliases": [],
|
|
205
205
|
"args": {},
|
|
206
206
|
"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.",
|
|
207
207
|
"examples": [
|
|
208
|
-
"<%= config.bin %>
|
|
209
|
-
"<%= config.bin %>
|
|
210
|
-
"<%= config.bin %>
|
|
211
|
-
"<%= config.bin %>
|
|
208
|
+
"<%= config.bin %> event list",
|
|
209
|
+
"<%= config.bin %> event list --device <id> --severity critical",
|
|
210
|
+
"<%= config.bin %> event list --type device-offline --start 2026-01-01 --end 2026-01-02",
|
|
211
|
+
"<%= config.bin %> event list --limit 100 --json"
|
|
212
212
|
],
|
|
213
213
|
"flags": {
|
|
214
214
|
"json": {
|
|
@@ -292,7 +292,7 @@
|
|
|
292
292
|
},
|
|
293
293
|
"hasDynamicHelp": false,
|
|
294
294
|
"hiddenAliases": [],
|
|
295
|
-
"id": "
|
|
295
|
+
"id": "event:list",
|
|
296
296
|
"pluginAlias": "@formant/formant-cli",
|
|
297
297
|
"pluginName": "@formant/formant-cli",
|
|
298
298
|
"pluginType": "core",
|
|
@@ -303,23 +303,23 @@
|
|
|
303
303
|
"relativePath": [
|
|
304
304
|
"dist",
|
|
305
305
|
"commands",
|
|
306
|
-
"
|
|
306
|
+
"event",
|
|
307
307
|
"list.js"
|
|
308
308
|
]
|
|
309
309
|
},
|
|
310
|
-
"
|
|
310
|
+
"event-trigger:get": {
|
|
311
311
|
"aliases": [],
|
|
312
312
|
"args": {
|
|
313
|
-
"
|
|
314
|
-
"description": "
|
|
315
|
-
"name": "
|
|
313
|
+
"id": {
|
|
314
|
+
"description": "Event trigger ID (UUID)",
|
|
315
|
+
"name": "id",
|
|
316
316
|
"required": true
|
|
317
317
|
}
|
|
318
318
|
},
|
|
319
|
-
"description": "
|
|
319
|
+
"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.",
|
|
320
320
|
"examples": [
|
|
321
|
-
"<%= config.bin %>
|
|
322
|
-
"<%= config.bin %>
|
|
321
|
+
"<%= config.bin %> event-trigger get <trigger-id>",
|
|
322
|
+
"<%= config.bin %> event-trigger get <trigger-id> --json"
|
|
323
323
|
],
|
|
324
324
|
"flags": {
|
|
325
325
|
"json": {
|
|
@@ -352,34 +352,28 @@
|
|
|
352
352
|
},
|
|
353
353
|
"hasDynamicHelp": false,
|
|
354
354
|
"hiddenAliases": [],
|
|
355
|
-
"id": "
|
|
355
|
+
"id": "event-trigger:get",
|
|
356
356
|
"pluginAlias": "@formant/formant-cli",
|
|
357
357
|
"pluginName": "@formant/formant-cli",
|
|
358
358
|
"pluginType": "core",
|
|
359
359
|
"strict": true,
|
|
360
|
-
"summary": "
|
|
360
|
+
"summary": "Get event trigger details",
|
|
361
361
|
"enableJsonFlag": true,
|
|
362
362
|
"isESM": true,
|
|
363
363
|
"relativePath": [
|
|
364
364
|
"dist",
|
|
365
365
|
"commands",
|
|
366
|
-
"
|
|
367
|
-
"
|
|
366
|
+
"event-trigger",
|
|
367
|
+
"get.js"
|
|
368
368
|
]
|
|
369
369
|
},
|
|
370
|
-
"
|
|
370
|
+
"event-trigger:list": {
|
|
371
371
|
"aliases": [],
|
|
372
|
-
"args": {
|
|
373
|
-
|
|
374
|
-
"description": "Command template ID (UUID)",
|
|
375
|
-
"name": "id",
|
|
376
|
-
"required": true
|
|
377
|
-
}
|
|
378
|
-
},
|
|
379
|
-
"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.",
|
|
372
|
+
"args": {},
|
|
373
|
+
"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.",
|
|
380
374
|
"examples": [
|
|
381
|
-
"<%= config.bin %>
|
|
382
|
-
"<%= config.bin %>
|
|
375
|
+
"<%= config.bin %> event-trigger list",
|
|
376
|
+
"<%= config.bin %> event-trigger list --json"
|
|
383
377
|
],
|
|
384
378
|
"flags": {
|
|
385
379
|
"json": {
|
|
@@ -412,29 +406,34 @@
|
|
|
412
406
|
},
|
|
413
407
|
"hasDynamicHelp": false,
|
|
414
408
|
"hiddenAliases": [],
|
|
415
|
-
"id": "
|
|
409
|
+
"id": "event-trigger:list",
|
|
416
410
|
"pluginAlias": "@formant/formant-cli",
|
|
417
411
|
"pluginName": "@formant/formant-cli",
|
|
418
412
|
"pluginType": "core",
|
|
419
413
|
"strict": true,
|
|
420
|
-
"summary": "
|
|
414
|
+
"summary": "List event trigger rules",
|
|
421
415
|
"enableJsonFlag": true,
|
|
422
416
|
"isESM": true,
|
|
423
417
|
"relativePath": [
|
|
424
418
|
"dist",
|
|
425
419
|
"commands",
|
|
426
|
-
"
|
|
427
|
-
"
|
|
420
|
+
"event-trigger",
|
|
421
|
+
"list.js"
|
|
428
422
|
]
|
|
429
423
|
},
|
|
430
|
-
"
|
|
424
|
+
"fleet:get": {
|
|
431
425
|
"aliases": [],
|
|
432
|
-
"args": {
|
|
433
|
-
|
|
426
|
+
"args": {
|
|
427
|
+
"id": {
|
|
428
|
+
"description": "Fleet (group) ID (UUID)",
|
|
429
|
+
"name": "id",
|
|
430
|
+
"required": true
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
"description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.",
|
|
434
434
|
"examples": [
|
|
435
|
-
"<%= config.bin %>
|
|
436
|
-
"<%= config.bin %>
|
|
437
|
-
"<%= config.bin %> commands history --device <device-id> --json"
|
|
435
|
+
"<%= config.bin %> fleet get <fleet-id>",
|
|
436
|
+
"<%= config.bin %> fleet get <fleet-id> --json"
|
|
438
437
|
],
|
|
439
438
|
"flags": {
|
|
440
439
|
"json": {
|
|
@@ -463,50 +462,32 @@
|
|
|
463
462
|
"name": "stage",
|
|
464
463
|
"allowNo": false,
|
|
465
464
|
"type": "boolean"
|
|
466
|
-
},
|
|
467
|
-
"device": {
|
|
468
|
-
"char": "d",
|
|
469
|
-
"description": "Device ID (UUID)",
|
|
470
|
-
"name": "device",
|
|
471
|
-
"required": true,
|
|
472
|
-
"hasDynamicHelp": false,
|
|
473
|
-
"multiple": false,
|
|
474
|
-
"type": "option"
|
|
475
|
-
},
|
|
476
|
-
"limit": {
|
|
477
|
-
"char": "l",
|
|
478
|
-
"description": "Maximum number of commands to return",
|
|
479
|
-
"name": "limit",
|
|
480
|
-
"default": 25,
|
|
481
|
-
"hasDynamicHelp": false,
|
|
482
|
-
"multiple": false,
|
|
483
|
-
"type": "option"
|
|
484
465
|
}
|
|
485
466
|
},
|
|
486
467
|
"hasDynamicHelp": false,
|
|
487
468
|
"hiddenAliases": [],
|
|
488
|
-
"id": "
|
|
469
|
+
"id": "fleet:get",
|
|
489
470
|
"pluginAlias": "@formant/formant-cli",
|
|
490
471
|
"pluginName": "@formant/formant-cli",
|
|
491
472
|
"pluginType": "core",
|
|
492
473
|
"strict": true,
|
|
493
|
-
"summary": "
|
|
474
|
+
"summary": "Get fleet details",
|
|
494
475
|
"enableJsonFlag": true,
|
|
495
476
|
"isESM": true,
|
|
496
477
|
"relativePath": [
|
|
497
478
|
"dist",
|
|
498
479
|
"commands",
|
|
499
|
-
"
|
|
500
|
-
"
|
|
480
|
+
"fleet",
|
|
481
|
+
"get.js"
|
|
501
482
|
]
|
|
502
483
|
},
|
|
503
|
-
"
|
|
484
|
+
"fleet:list": {
|
|
504
485
|
"aliases": [],
|
|
505
486
|
"args": {},
|
|
506
|
-
"description": "List all
|
|
487
|
+
"description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.",
|
|
507
488
|
"examples": [
|
|
508
|
-
"<%= config.bin %>
|
|
509
|
-
"<%= config.bin %>
|
|
489
|
+
"<%= config.bin %> fleet list",
|
|
490
|
+
"<%= config.bin %> fleet list --json"
|
|
510
491
|
],
|
|
511
492
|
"flags": {
|
|
512
493
|
"json": {
|
|
@@ -539,42 +520,34 @@
|
|
|
539
520
|
},
|
|
540
521
|
"hasDynamicHelp": false,
|
|
541
522
|
"hiddenAliases": [],
|
|
542
|
-
"id": "
|
|
523
|
+
"id": "fleet:list",
|
|
543
524
|
"pluginAlias": "@formant/formant-cli",
|
|
544
525
|
"pluginName": "@formant/formant-cli",
|
|
545
526
|
"pluginType": "core",
|
|
546
527
|
"strict": true,
|
|
547
|
-
"summary": "List
|
|
528
|
+
"summary": "List device groups",
|
|
548
529
|
"enableJsonFlag": true,
|
|
549
530
|
"isESM": true,
|
|
550
531
|
"relativePath": [
|
|
551
532
|
"dist",
|
|
552
533
|
"commands",
|
|
553
|
-
"
|
|
534
|
+
"fleet",
|
|
554
535
|
"list.js"
|
|
555
536
|
]
|
|
556
537
|
},
|
|
557
|
-
"
|
|
538
|
+
"command:for-device": {
|
|
558
539
|
"aliases": [],
|
|
559
540
|
"args": {
|
|
560
541
|
"deviceId": {
|
|
561
542
|
"description": "Device ID (UUID)",
|
|
562
543
|
"name": "deviceId",
|
|
563
544
|
"required": true
|
|
564
|
-
},
|
|
565
|
-
"templateId": {
|
|
566
|
-
"description": "Command template ID (UUID)",
|
|
567
|
-
"name": "templateId",
|
|
568
|
-
"required": true
|
|
569
545
|
}
|
|
570
546
|
},
|
|
571
|
-
"description": "
|
|
547
|
+
"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.",
|
|
572
548
|
"examples": [
|
|
573
|
-
"<%= config.bin %>
|
|
574
|
-
"<%= config.bin %>
|
|
575
|
-
"<%= config.bin %> commands send <device-id> <template-id> --dry-run",
|
|
576
|
-
"<%= config.bin %> commands send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
|
|
577
|
-
"<%= config.bin %> commands send <device-id> <template-id> --json"
|
|
549
|
+
"<%= config.bin %> command for-device <device-id>",
|
|
550
|
+
"<%= config.bin %> command for-device <device-id> --json"
|
|
578
551
|
],
|
|
579
552
|
"flags": {
|
|
580
553
|
"json": {
|
|
@@ -603,59 +576,38 @@
|
|
|
603
576
|
"name": "stage",
|
|
604
577
|
"allowNo": false,
|
|
605
578
|
"type": "boolean"
|
|
606
|
-
},
|
|
607
|
-
"dry-run": {
|
|
608
|
-
"description": "Preview the command payload without sending",
|
|
609
|
-
"name": "dry-run",
|
|
610
|
-
"allowNo": false,
|
|
611
|
-
"type": "boolean"
|
|
612
|
-
},
|
|
613
|
-
"param": {
|
|
614
|
-
"char": "p",
|
|
615
|
-
"description": "Parameter override (name=value), can be specified multiple times",
|
|
616
|
-
"name": "param",
|
|
617
|
-
"hasDynamicHelp": false,
|
|
618
|
-
"multiple": true,
|
|
619
|
-
"type": "option"
|
|
620
|
-
},
|
|
621
|
-
"raw-value": {
|
|
622
|
-
"description": "Send a raw parameter value string (bypasses schema validation)",
|
|
623
|
-
"name": "raw-value",
|
|
624
|
-
"hasDynamicHelp": false,
|
|
625
|
-
"multiple": false,
|
|
626
|
-
"type": "option"
|
|
627
579
|
}
|
|
628
580
|
},
|
|
629
581
|
"hasDynamicHelp": false,
|
|
630
582
|
"hiddenAliases": [],
|
|
631
|
-
"id": "
|
|
583
|
+
"id": "command:for-device",
|
|
632
584
|
"pluginAlias": "@formant/formant-cli",
|
|
633
585
|
"pluginName": "@formant/formant-cli",
|
|
634
586
|
"pluginType": "core",
|
|
635
587
|
"strict": true,
|
|
636
|
-
"summary": "
|
|
588
|
+
"summary": "List commands available for a device",
|
|
637
589
|
"enableJsonFlag": true,
|
|
638
590
|
"isESM": true,
|
|
639
591
|
"relativePath": [
|
|
640
592
|
"dist",
|
|
641
593
|
"commands",
|
|
642
|
-
"
|
|
643
|
-
"
|
|
594
|
+
"command",
|
|
595
|
+
"for-device.js"
|
|
644
596
|
]
|
|
645
597
|
},
|
|
646
|
-
"
|
|
598
|
+
"command:get": {
|
|
647
599
|
"aliases": [],
|
|
648
600
|
"args": {
|
|
649
601
|
"id": {
|
|
650
|
-
"description": "
|
|
602
|
+
"description": "Command template ID (UUID)",
|
|
651
603
|
"name": "id",
|
|
652
604
|
"required": true
|
|
653
605
|
}
|
|
654
606
|
},
|
|
655
|
-
"description": "Get detailed information about a
|
|
607
|
+
"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.",
|
|
656
608
|
"examples": [
|
|
657
|
-
"<%= config.bin %>
|
|
658
|
-
"<%= config.bin %>
|
|
609
|
+
"<%= config.bin %> command get <template-id>",
|
|
610
|
+
"<%= config.bin %> command get <template-id> --json"
|
|
659
611
|
],
|
|
660
612
|
"flags": {
|
|
661
613
|
"json": {
|
|
@@ -688,28 +640,29 @@
|
|
|
688
640
|
},
|
|
689
641
|
"hasDynamicHelp": false,
|
|
690
642
|
"hiddenAliases": [],
|
|
691
|
-
"id": "
|
|
643
|
+
"id": "command:get",
|
|
692
644
|
"pluginAlias": "@formant/formant-cli",
|
|
693
645
|
"pluginName": "@formant/formant-cli",
|
|
694
646
|
"pluginType": "core",
|
|
695
647
|
"strict": true,
|
|
696
|
-
"summary": "Get
|
|
648
|
+
"summary": "Get command template details",
|
|
697
649
|
"enableJsonFlag": true,
|
|
698
650
|
"isESM": true,
|
|
699
651
|
"relativePath": [
|
|
700
652
|
"dist",
|
|
701
653
|
"commands",
|
|
702
|
-
"
|
|
654
|
+
"command",
|
|
703
655
|
"get.js"
|
|
704
656
|
]
|
|
705
657
|
},
|
|
706
|
-
"
|
|
658
|
+
"command:history": {
|
|
707
659
|
"aliases": [],
|
|
708
660
|
"args": {},
|
|
709
|
-
"description": "
|
|
661
|
+
"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.",
|
|
710
662
|
"examples": [
|
|
711
|
-
"<%= config.bin %>
|
|
712
|
-
"<%= config.bin %>
|
|
663
|
+
"<%= config.bin %> command history --device <device-id>",
|
|
664
|
+
"<%= config.bin %> command history --device <device-id> --limit 50",
|
|
665
|
+
"<%= config.bin %> command history --device <device-id> --json"
|
|
713
666
|
],
|
|
714
667
|
"flags": {
|
|
715
668
|
"json": {
|
|
@@ -738,38 +691,50 @@
|
|
|
738
691
|
"name": "stage",
|
|
739
692
|
"allowNo": false,
|
|
740
693
|
"type": "boolean"
|
|
694
|
+
},
|
|
695
|
+
"device": {
|
|
696
|
+
"char": "d",
|
|
697
|
+
"description": "Device ID (UUID)",
|
|
698
|
+
"name": "device",
|
|
699
|
+
"required": true,
|
|
700
|
+
"hasDynamicHelp": false,
|
|
701
|
+
"multiple": false,
|
|
702
|
+
"type": "option"
|
|
703
|
+
},
|
|
704
|
+
"limit": {
|
|
705
|
+
"char": "l",
|
|
706
|
+
"description": "Maximum number of commands to return",
|
|
707
|
+
"name": "limit",
|
|
708
|
+
"default": 25,
|
|
709
|
+
"hasDynamicHelp": false,
|
|
710
|
+
"multiple": false,
|
|
711
|
+
"type": "option"
|
|
741
712
|
}
|
|
742
713
|
},
|
|
743
714
|
"hasDynamicHelp": false,
|
|
744
715
|
"hiddenAliases": [],
|
|
745
|
-
"id": "
|
|
716
|
+
"id": "command:history",
|
|
746
717
|
"pluginAlias": "@formant/formant-cli",
|
|
747
718
|
"pluginName": "@formant/formant-cli",
|
|
748
719
|
"pluginType": "core",
|
|
749
720
|
"strict": true,
|
|
750
|
-
"summary": "
|
|
721
|
+
"summary": "Query command history",
|
|
751
722
|
"enableJsonFlag": true,
|
|
752
723
|
"isESM": true,
|
|
753
724
|
"relativePath": [
|
|
754
725
|
"dist",
|
|
755
726
|
"commands",
|
|
756
|
-
"
|
|
757
|
-
"
|
|
727
|
+
"command",
|
|
728
|
+
"history.js"
|
|
758
729
|
]
|
|
759
730
|
},
|
|
760
|
-
"
|
|
731
|
+
"command:list": {
|
|
761
732
|
"aliases": [],
|
|
762
|
-
"args": {
|
|
763
|
-
|
|
764
|
-
"description": "Event trigger ID (UUID)",
|
|
765
|
-
"name": "id",
|
|
766
|
-
"required": true
|
|
767
|
-
}
|
|
768
|
-
},
|
|
769
|
-
"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.",
|
|
733
|
+
"args": {},
|
|
734
|
+
"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.",
|
|
770
735
|
"examples": [
|
|
771
|
-
"<%= config.bin %>
|
|
772
|
-
"<%= config.bin %>
|
|
736
|
+
"<%= config.bin %> command list",
|
|
737
|
+
"<%= config.bin %> command list --json"
|
|
773
738
|
],
|
|
774
739
|
"flags": {
|
|
775
740
|
"json": {
|
|
@@ -802,28 +767,42 @@
|
|
|
802
767
|
},
|
|
803
768
|
"hasDynamicHelp": false,
|
|
804
769
|
"hiddenAliases": [],
|
|
805
|
-
"id": "
|
|
770
|
+
"id": "command:list",
|
|
806
771
|
"pluginAlias": "@formant/formant-cli",
|
|
807
772
|
"pluginName": "@formant/formant-cli",
|
|
808
773
|
"pluginType": "core",
|
|
809
774
|
"strict": true,
|
|
810
|
-
"summary": "
|
|
775
|
+
"summary": "List command templates",
|
|
811
776
|
"enableJsonFlag": true,
|
|
812
777
|
"isESM": true,
|
|
813
778
|
"relativePath": [
|
|
814
779
|
"dist",
|
|
815
780
|
"commands",
|
|
816
|
-
"
|
|
817
|
-
"
|
|
781
|
+
"command",
|
|
782
|
+
"list.js"
|
|
818
783
|
]
|
|
819
784
|
},
|
|
820
|
-
"
|
|
785
|
+
"command:send": {
|
|
821
786
|
"aliases": [],
|
|
822
|
-
"args": {
|
|
823
|
-
|
|
787
|
+
"args": {
|
|
788
|
+
"deviceId": {
|
|
789
|
+
"description": "Device ID (UUID)",
|
|
790
|
+
"name": "deviceId",
|
|
791
|
+
"required": true
|
|
792
|
+
},
|
|
793
|
+
"templateId": {
|
|
794
|
+
"description": "Command template ID (UUID)",
|
|
795
|
+
"name": "templateId",
|
|
796
|
+
"required": true
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
"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.",
|
|
824
800
|
"examples": [
|
|
825
|
-
"<%= config.bin %>
|
|
826
|
-
"<%= config.bin %>
|
|
801
|
+
"<%= config.bin %> command send <device-id> <template-id>",
|
|
802
|
+
"<%= config.bin %> command send <device-id> <template-id> --param speed=5 --param mode=fast",
|
|
803
|
+
"<%= config.bin %> command send <device-id> <template-id> --dry-run",
|
|
804
|
+
"<%= config.bin %> command send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
|
|
805
|
+
"<%= config.bin %> command send <device-id> <template-id> --json"
|
|
827
806
|
],
|
|
828
807
|
"flags": {
|
|
829
808
|
"json": {
|
|
@@ -852,34 +831,59 @@
|
|
|
852
831
|
"name": "stage",
|
|
853
832
|
"allowNo": false,
|
|
854
833
|
"type": "boolean"
|
|
834
|
+
},
|
|
835
|
+
"dry-run": {
|
|
836
|
+
"description": "Preview the command payload without sending",
|
|
837
|
+
"name": "dry-run",
|
|
838
|
+
"allowNo": false,
|
|
839
|
+
"type": "boolean"
|
|
840
|
+
},
|
|
841
|
+
"param": {
|
|
842
|
+
"char": "p",
|
|
843
|
+
"description": "Parameter override (name=value), can be specified multiple times",
|
|
844
|
+
"name": "param",
|
|
845
|
+
"hasDynamicHelp": false,
|
|
846
|
+
"multiple": true,
|
|
847
|
+
"type": "option"
|
|
848
|
+
},
|
|
849
|
+
"raw-value": {
|
|
850
|
+
"description": "Send a raw parameter value string (bypasses schema validation)",
|
|
851
|
+
"name": "raw-value",
|
|
852
|
+
"hasDynamicHelp": false,
|
|
853
|
+
"multiple": false,
|
|
854
|
+
"type": "option"
|
|
855
855
|
}
|
|
856
856
|
},
|
|
857
857
|
"hasDynamicHelp": false,
|
|
858
858
|
"hiddenAliases": [],
|
|
859
|
-
"id": "
|
|
859
|
+
"id": "command:send",
|
|
860
860
|
"pluginAlias": "@formant/formant-cli",
|
|
861
861
|
"pluginName": "@formant/formant-cli",
|
|
862
862
|
"pluginType": "core",
|
|
863
863
|
"strict": true,
|
|
864
|
-
"summary": "
|
|
864
|
+
"summary": "Send a command to a device",
|
|
865
865
|
"enableJsonFlag": true,
|
|
866
866
|
"isESM": true,
|
|
867
867
|
"relativePath": [
|
|
868
868
|
"dist",
|
|
869
869
|
"commands",
|
|
870
|
-
"
|
|
871
|
-
"
|
|
870
|
+
"command",
|
|
871
|
+
"send.js"
|
|
872
872
|
]
|
|
873
873
|
},
|
|
874
|
-
"
|
|
874
|
+
"kv:get": {
|
|
875
875
|
"aliases": [],
|
|
876
|
-
"args": {
|
|
877
|
-
|
|
876
|
+
"args": {
|
|
877
|
+
"key": {
|
|
878
|
+
"description": "Key to retrieve",
|
|
879
|
+
"name": "key",
|
|
880
|
+
"required": true
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
878
884
|
"examples": [
|
|
879
|
-
"<%= config.bin %>
|
|
880
|
-
"<%= config.bin %>
|
|
881
|
-
"cat payload.json | <%= config.bin %> ingest batch --stdin",
|
|
882
|
-
"# 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}"
|
|
885
|
+
"<%= config.bin %> kv get my-key",
|
|
886
|
+
"<%= config.bin %> kv get my-key --json"
|
|
883
887
|
],
|
|
884
888
|
"flags": {
|
|
885
889
|
"json": {
|
|
@@ -908,53 +912,34 @@
|
|
|
908
912
|
"name": "stage",
|
|
909
913
|
"allowNo": false,
|
|
910
914
|
"type": "boolean"
|
|
911
|
-
},
|
|
912
|
-
"file": {
|
|
913
|
-
"char": "f",
|
|
914
|
-
"description": "Path to JSON file containing batch payload",
|
|
915
|
-
"exclusive": [
|
|
916
|
-
"stdin"
|
|
917
|
-
],
|
|
918
|
-
"name": "file",
|
|
919
|
-
"hasDynamicHelp": false,
|
|
920
|
-
"multiple": false,
|
|
921
|
-
"type": "option"
|
|
922
|
-
},
|
|
923
|
-
"stdin": {
|
|
924
|
-
"description": "Read JSON payload from stdin",
|
|
925
|
-
"exclusive": [
|
|
926
|
-
"file"
|
|
927
|
-
],
|
|
928
|
-
"name": "stdin",
|
|
929
|
-
"allowNo": false,
|
|
930
|
-
"type": "boolean"
|
|
931
915
|
}
|
|
932
916
|
},
|
|
933
917
|
"hasDynamicHelp": false,
|
|
934
918
|
"hiddenAliases": [],
|
|
935
|
-
"id": "
|
|
919
|
+
"id": "kv:get",
|
|
936
920
|
"pluginAlias": "@formant/formant-cli",
|
|
937
921
|
"pluginName": "@formant/formant-cli",
|
|
938
922
|
"pluginType": "core",
|
|
939
923
|
"strict": true,
|
|
940
|
-
"summary": "
|
|
924
|
+
"summary": "Get key-value",
|
|
941
925
|
"enableJsonFlag": true,
|
|
942
926
|
"isESM": true,
|
|
943
927
|
"relativePath": [
|
|
944
928
|
"dist",
|
|
945
929
|
"commands",
|
|
946
|
-
"
|
|
947
|
-
"
|
|
930
|
+
"kv",
|
|
931
|
+
"get.js"
|
|
948
932
|
]
|
|
949
933
|
},
|
|
950
|
-
"
|
|
934
|
+
"kv:list": {
|
|
951
935
|
"aliases": [],
|
|
952
936
|
"args": {},
|
|
953
|
-
"description": "
|
|
937
|
+
"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.",
|
|
954
938
|
"examples": [
|
|
955
|
-
"<%= config.bin %>
|
|
956
|
-
"<%= config.bin %>
|
|
957
|
-
"<%= config.bin %>
|
|
939
|
+
"<%= config.bin %> kv list",
|
|
940
|
+
"<%= config.bin %> kv list --prefix config",
|
|
941
|
+
"<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
|
|
942
|
+
"<%= config.bin %> kv list --json"
|
|
958
943
|
],
|
|
959
944
|
"flags": {
|
|
960
945
|
"json": {
|
|
@@ -984,20 +969,232 @@
|
|
|
984
969
|
"allowNo": false,
|
|
985
970
|
"type": "boolean"
|
|
986
971
|
},
|
|
987
|
-
"
|
|
988
|
-
"char": "
|
|
989
|
-
"description": "
|
|
990
|
-
"name": "
|
|
991
|
-
"required": true,
|
|
972
|
+
"keys": {
|
|
973
|
+
"char": "k",
|
|
974
|
+
"description": "Specific keys to query (can be specified multiple times)",
|
|
975
|
+
"name": "keys",
|
|
992
976
|
"hasDynamicHelp": false,
|
|
993
|
-
"multiple":
|
|
977
|
+
"multiple": true,
|
|
994
978
|
"type": "option"
|
|
995
979
|
},
|
|
996
|
-
"
|
|
997
|
-
"char": "
|
|
998
|
-
"description": "
|
|
999
|
-
"name": "
|
|
1000
|
-
"
|
|
980
|
+
"prefix": {
|
|
981
|
+
"char": "p",
|
|
982
|
+
"description": "Filter keys by prefix",
|
|
983
|
+
"name": "prefix",
|
|
984
|
+
"hasDynamicHelp": false,
|
|
985
|
+
"multiple": false,
|
|
986
|
+
"type": "option"
|
|
987
|
+
}
|
|
988
|
+
},
|
|
989
|
+
"hasDynamicHelp": false,
|
|
990
|
+
"hiddenAliases": [],
|
|
991
|
+
"id": "kv:list",
|
|
992
|
+
"pluginAlias": "@formant/formant-cli",
|
|
993
|
+
"pluginName": "@formant/formant-cli",
|
|
994
|
+
"pluginType": "core",
|
|
995
|
+
"strict": true,
|
|
996
|
+
"summary": "List key-value keys",
|
|
997
|
+
"enableJsonFlag": true,
|
|
998
|
+
"isESM": true,
|
|
999
|
+
"relativePath": [
|
|
1000
|
+
"dist",
|
|
1001
|
+
"commands",
|
|
1002
|
+
"kv",
|
|
1003
|
+
"list.js"
|
|
1004
|
+
]
|
|
1005
|
+
},
|
|
1006
|
+
"kv:set": {
|
|
1007
|
+
"aliases": [],
|
|
1008
|
+
"args": {
|
|
1009
|
+
"key": {
|
|
1010
|
+
"description": "Key to set",
|
|
1011
|
+
"name": "key",
|
|
1012
|
+
"required": true
|
|
1013
|
+
},
|
|
1014
|
+
"value": {
|
|
1015
|
+
"description": "Value to store (JSON string)",
|
|
1016
|
+
"name": "value",
|
|
1017
|
+
"required": true
|
|
1018
|
+
}
|
|
1019
|
+
},
|
|
1020
|
+
"description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
|
|
1021
|
+
"examples": [
|
|
1022
|
+
"<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
|
|
1023
|
+
"<%= config.bin %> kv set config '{\"setting\": true}'"
|
|
1024
|
+
],
|
|
1025
|
+
"flags": {
|
|
1026
|
+
"json": {
|
|
1027
|
+
"description": "Format output as json.",
|
|
1028
|
+
"helpGroup": "GLOBAL",
|
|
1029
|
+
"name": "json",
|
|
1030
|
+
"allowNo": false,
|
|
1031
|
+
"type": "boolean"
|
|
1032
|
+
},
|
|
1033
|
+
"dev": {
|
|
1034
|
+
"description": "Target the dev environment",
|
|
1035
|
+
"exclusive": [
|
|
1036
|
+
"stage"
|
|
1037
|
+
],
|
|
1038
|
+
"helpGroup": "GLOBAL",
|
|
1039
|
+
"name": "dev",
|
|
1040
|
+
"allowNo": false,
|
|
1041
|
+
"type": "boolean"
|
|
1042
|
+
},
|
|
1043
|
+
"stage": {
|
|
1044
|
+
"description": "Target the stage environment",
|
|
1045
|
+
"exclusive": [
|
|
1046
|
+
"dev"
|
|
1047
|
+
],
|
|
1048
|
+
"helpGroup": "GLOBAL",
|
|
1049
|
+
"name": "stage",
|
|
1050
|
+
"allowNo": false,
|
|
1051
|
+
"type": "boolean"
|
|
1052
|
+
}
|
|
1053
|
+
},
|
|
1054
|
+
"hasDynamicHelp": false,
|
|
1055
|
+
"hiddenAliases": [],
|
|
1056
|
+
"id": "kv:set",
|
|
1057
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1058
|
+
"pluginName": "@formant/formant-cli",
|
|
1059
|
+
"pluginType": "core",
|
|
1060
|
+
"strict": true,
|
|
1061
|
+
"summary": "Set key-value",
|
|
1062
|
+
"enableJsonFlag": true,
|
|
1063
|
+
"isESM": true,
|
|
1064
|
+
"relativePath": [
|
|
1065
|
+
"dist",
|
|
1066
|
+
"commands",
|
|
1067
|
+
"kv",
|
|
1068
|
+
"set.js"
|
|
1069
|
+
]
|
|
1070
|
+
},
|
|
1071
|
+
"ingest:batch": {
|
|
1072
|
+
"aliases": [],
|
|
1073
|
+
"args": {},
|
|
1074
|
+
"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).",
|
|
1075
|
+
"examples": [
|
|
1076
|
+
"<%= config.bin %> ingest batch --file data.json",
|
|
1077
|
+
"<%= config.bin %> ingest batch --stdin < data.json",
|
|
1078
|
+
"cat payload.json | <%= config.bin %> ingest batch --stdin",
|
|
1079
|
+
"# 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}"
|
|
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
|
+
"file": {
|
|
1110
|
+
"char": "f",
|
|
1111
|
+
"description": "Path to JSON file containing batch payload",
|
|
1112
|
+
"exclusive": [
|
|
1113
|
+
"stdin"
|
|
1114
|
+
],
|
|
1115
|
+
"name": "file",
|
|
1116
|
+
"hasDynamicHelp": false,
|
|
1117
|
+
"multiple": false,
|
|
1118
|
+
"type": "option"
|
|
1119
|
+
},
|
|
1120
|
+
"stdin": {
|
|
1121
|
+
"description": "Read JSON payload from stdin",
|
|
1122
|
+
"exclusive": [
|
|
1123
|
+
"file"
|
|
1124
|
+
],
|
|
1125
|
+
"name": "stdin",
|
|
1126
|
+
"allowNo": false,
|
|
1127
|
+
"type": "boolean"
|
|
1128
|
+
}
|
|
1129
|
+
},
|
|
1130
|
+
"hasDynamicHelp": false,
|
|
1131
|
+
"hiddenAliases": [],
|
|
1132
|
+
"id": "ingest:batch",
|
|
1133
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1134
|
+
"pluginName": "@formant/formant-cli",
|
|
1135
|
+
"pluginType": "core",
|
|
1136
|
+
"strict": true,
|
|
1137
|
+
"summary": "Ingest batch data from file or stdin",
|
|
1138
|
+
"enableJsonFlag": true,
|
|
1139
|
+
"isESM": true,
|
|
1140
|
+
"relativePath": [
|
|
1141
|
+
"dist",
|
|
1142
|
+
"commands",
|
|
1143
|
+
"ingest",
|
|
1144
|
+
"batch.js"
|
|
1145
|
+
]
|
|
1146
|
+
},
|
|
1147
|
+
"ingest:bitset": {
|
|
1148
|
+
"aliases": [],
|
|
1149
|
+
"args": {},
|
|
1150
|
+
"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",
|
|
1151
|
+
"examples": [
|
|
1152
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream sensors --keys \"door,window,motion\" --values \"true,false,true\"",
|
|
1153
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream flags --keys \"active,paused,error\" --values \"true,false,false\" --tag system=main",
|
|
1154
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream states --keys \"a,b\" --values \"false,true\""
|
|
1155
|
+
],
|
|
1156
|
+
"flags": {
|
|
1157
|
+
"json": {
|
|
1158
|
+
"description": "Format output as json.",
|
|
1159
|
+
"helpGroup": "GLOBAL",
|
|
1160
|
+
"name": "json",
|
|
1161
|
+
"allowNo": false,
|
|
1162
|
+
"type": "boolean"
|
|
1163
|
+
},
|
|
1164
|
+
"dev": {
|
|
1165
|
+
"description": "Target the dev environment",
|
|
1166
|
+
"exclusive": [
|
|
1167
|
+
"stage"
|
|
1168
|
+
],
|
|
1169
|
+
"helpGroup": "GLOBAL",
|
|
1170
|
+
"name": "dev",
|
|
1171
|
+
"allowNo": false,
|
|
1172
|
+
"type": "boolean"
|
|
1173
|
+
},
|
|
1174
|
+
"stage": {
|
|
1175
|
+
"description": "Target the stage environment",
|
|
1176
|
+
"exclusive": [
|
|
1177
|
+
"dev"
|
|
1178
|
+
],
|
|
1179
|
+
"helpGroup": "GLOBAL",
|
|
1180
|
+
"name": "stage",
|
|
1181
|
+
"allowNo": false,
|
|
1182
|
+
"type": "boolean"
|
|
1183
|
+
},
|
|
1184
|
+
"device": {
|
|
1185
|
+
"char": "d",
|
|
1186
|
+
"description": "Device ID (UUID)",
|
|
1187
|
+
"name": "device",
|
|
1188
|
+
"required": true,
|
|
1189
|
+
"hasDynamicHelp": false,
|
|
1190
|
+
"multiple": false,
|
|
1191
|
+
"type": "option"
|
|
1192
|
+
},
|
|
1193
|
+
"stream": {
|
|
1194
|
+
"char": "s",
|
|
1195
|
+
"description": "Stream name",
|
|
1196
|
+
"name": "stream",
|
|
1197
|
+
"required": true,
|
|
1001
1198
|
"hasDynamicHelp": false,
|
|
1002
1199
|
"multiple": false,
|
|
1003
1200
|
"type": "option"
|
|
@@ -1786,211 +1983,14 @@
|
|
|
1786
1983
|
"update.js"
|
|
1787
1984
|
]
|
|
1788
1985
|
},
|
|
1789
|
-
"
|
|
1986
|
+
"investigation:analytics": {
|
|
1790
1987
|
"aliases": [],
|
|
1791
|
-
"args": {
|
|
1792
|
-
|
|
1793
|
-
"description": "Key to retrieve",
|
|
1794
|
-
"name": "key",
|
|
1795
|
-
"required": true
|
|
1796
|
-
}
|
|
1797
|
-
},
|
|
1798
|
-
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
1988
|
+
"args": {},
|
|
1989
|
+
"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.",
|
|
1799
1990
|
"examples": [
|
|
1800
|
-
"<%= config.bin %>
|
|
1801
|
-
"<%= config.bin %>
|
|
1802
|
-
|
|
1803
|
-
"flags": {
|
|
1804
|
-
"json": {
|
|
1805
|
-
"description": "Format output as json.",
|
|
1806
|
-
"helpGroup": "GLOBAL",
|
|
1807
|
-
"name": "json",
|
|
1808
|
-
"allowNo": false,
|
|
1809
|
-
"type": "boolean"
|
|
1810
|
-
},
|
|
1811
|
-
"dev": {
|
|
1812
|
-
"description": "Target the dev environment",
|
|
1813
|
-
"exclusive": [
|
|
1814
|
-
"stage"
|
|
1815
|
-
],
|
|
1816
|
-
"helpGroup": "GLOBAL",
|
|
1817
|
-
"name": "dev",
|
|
1818
|
-
"allowNo": false,
|
|
1819
|
-
"type": "boolean"
|
|
1820
|
-
},
|
|
1821
|
-
"stage": {
|
|
1822
|
-
"description": "Target the stage environment",
|
|
1823
|
-
"exclusive": [
|
|
1824
|
-
"dev"
|
|
1825
|
-
],
|
|
1826
|
-
"helpGroup": "GLOBAL",
|
|
1827
|
-
"name": "stage",
|
|
1828
|
-
"allowNo": false,
|
|
1829
|
-
"type": "boolean"
|
|
1830
|
-
}
|
|
1831
|
-
},
|
|
1832
|
-
"hasDynamicHelp": false,
|
|
1833
|
-
"hiddenAliases": [],
|
|
1834
|
-
"id": "kv:get",
|
|
1835
|
-
"pluginAlias": "@formant/formant-cli",
|
|
1836
|
-
"pluginName": "@formant/formant-cli",
|
|
1837
|
-
"pluginType": "core",
|
|
1838
|
-
"strict": true,
|
|
1839
|
-
"summary": "Get key-value",
|
|
1840
|
-
"enableJsonFlag": true,
|
|
1841
|
-
"isESM": true,
|
|
1842
|
-
"relativePath": [
|
|
1843
|
-
"dist",
|
|
1844
|
-
"commands",
|
|
1845
|
-
"kv",
|
|
1846
|
-
"get.js"
|
|
1847
|
-
]
|
|
1848
|
-
},
|
|
1849
|
-
"kv:list": {
|
|
1850
|
-
"aliases": [],
|
|
1851
|
-
"args": {},
|
|
1852
|
-
"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.",
|
|
1853
|
-
"examples": [
|
|
1854
|
-
"<%= config.bin %> kv list",
|
|
1855
|
-
"<%= config.bin %> kv list --prefix config",
|
|
1856
|
-
"<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
|
|
1857
|
-
"<%= config.bin %> kv list --json"
|
|
1858
|
-
],
|
|
1859
|
-
"flags": {
|
|
1860
|
-
"json": {
|
|
1861
|
-
"description": "Format output as json.",
|
|
1862
|
-
"helpGroup": "GLOBAL",
|
|
1863
|
-
"name": "json",
|
|
1864
|
-
"allowNo": false,
|
|
1865
|
-
"type": "boolean"
|
|
1866
|
-
},
|
|
1867
|
-
"dev": {
|
|
1868
|
-
"description": "Target the dev environment",
|
|
1869
|
-
"exclusive": [
|
|
1870
|
-
"stage"
|
|
1871
|
-
],
|
|
1872
|
-
"helpGroup": "GLOBAL",
|
|
1873
|
-
"name": "dev",
|
|
1874
|
-
"allowNo": false,
|
|
1875
|
-
"type": "boolean"
|
|
1876
|
-
},
|
|
1877
|
-
"stage": {
|
|
1878
|
-
"description": "Target the stage environment",
|
|
1879
|
-
"exclusive": [
|
|
1880
|
-
"dev"
|
|
1881
|
-
],
|
|
1882
|
-
"helpGroup": "GLOBAL",
|
|
1883
|
-
"name": "stage",
|
|
1884
|
-
"allowNo": false,
|
|
1885
|
-
"type": "boolean"
|
|
1886
|
-
},
|
|
1887
|
-
"keys": {
|
|
1888
|
-
"char": "k",
|
|
1889
|
-
"description": "Specific keys to query (can be specified multiple times)",
|
|
1890
|
-
"name": "keys",
|
|
1891
|
-
"hasDynamicHelp": false,
|
|
1892
|
-
"multiple": true,
|
|
1893
|
-
"type": "option"
|
|
1894
|
-
},
|
|
1895
|
-
"prefix": {
|
|
1896
|
-
"char": "p",
|
|
1897
|
-
"description": "Filter keys by prefix",
|
|
1898
|
-
"name": "prefix",
|
|
1899
|
-
"hasDynamicHelp": false,
|
|
1900
|
-
"multiple": false,
|
|
1901
|
-
"type": "option"
|
|
1902
|
-
}
|
|
1903
|
-
},
|
|
1904
|
-
"hasDynamicHelp": false,
|
|
1905
|
-
"hiddenAliases": [],
|
|
1906
|
-
"id": "kv:list",
|
|
1907
|
-
"pluginAlias": "@formant/formant-cli",
|
|
1908
|
-
"pluginName": "@formant/formant-cli",
|
|
1909
|
-
"pluginType": "core",
|
|
1910
|
-
"strict": true,
|
|
1911
|
-
"summary": "List key-value keys",
|
|
1912
|
-
"enableJsonFlag": true,
|
|
1913
|
-
"isESM": true,
|
|
1914
|
-
"relativePath": [
|
|
1915
|
-
"dist",
|
|
1916
|
-
"commands",
|
|
1917
|
-
"kv",
|
|
1918
|
-
"list.js"
|
|
1919
|
-
]
|
|
1920
|
-
},
|
|
1921
|
-
"kv:set": {
|
|
1922
|
-
"aliases": [],
|
|
1923
|
-
"args": {
|
|
1924
|
-
"key": {
|
|
1925
|
-
"description": "Key to set",
|
|
1926
|
-
"name": "key",
|
|
1927
|
-
"required": true
|
|
1928
|
-
},
|
|
1929
|
-
"value": {
|
|
1930
|
-
"description": "Value to store (JSON string)",
|
|
1931
|
-
"name": "value",
|
|
1932
|
-
"required": true
|
|
1933
|
-
}
|
|
1934
|
-
},
|
|
1935
|
-
"description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
|
|
1936
|
-
"examples": [
|
|
1937
|
-
"<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
|
|
1938
|
-
"<%= config.bin %> kv set config '{\"setting\": true}'"
|
|
1939
|
-
],
|
|
1940
|
-
"flags": {
|
|
1941
|
-
"json": {
|
|
1942
|
-
"description": "Format output as json.",
|
|
1943
|
-
"helpGroup": "GLOBAL",
|
|
1944
|
-
"name": "json",
|
|
1945
|
-
"allowNo": false,
|
|
1946
|
-
"type": "boolean"
|
|
1947
|
-
},
|
|
1948
|
-
"dev": {
|
|
1949
|
-
"description": "Target the dev environment",
|
|
1950
|
-
"exclusive": [
|
|
1951
|
-
"stage"
|
|
1952
|
-
],
|
|
1953
|
-
"helpGroup": "GLOBAL",
|
|
1954
|
-
"name": "dev",
|
|
1955
|
-
"allowNo": false,
|
|
1956
|
-
"type": "boolean"
|
|
1957
|
-
},
|
|
1958
|
-
"stage": {
|
|
1959
|
-
"description": "Target the stage environment",
|
|
1960
|
-
"exclusive": [
|
|
1961
|
-
"dev"
|
|
1962
|
-
],
|
|
1963
|
-
"helpGroup": "GLOBAL",
|
|
1964
|
-
"name": "stage",
|
|
1965
|
-
"allowNo": false,
|
|
1966
|
-
"type": "boolean"
|
|
1967
|
-
}
|
|
1968
|
-
},
|
|
1969
|
-
"hasDynamicHelp": false,
|
|
1970
|
-
"hiddenAliases": [],
|
|
1971
|
-
"id": "kv:set",
|
|
1972
|
-
"pluginAlias": "@formant/formant-cli",
|
|
1973
|
-
"pluginName": "@formant/formant-cli",
|
|
1974
|
-
"pluginType": "core",
|
|
1975
|
-
"strict": true,
|
|
1976
|
-
"summary": "Set key-value",
|
|
1977
|
-
"enableJsonFlag": true,
|
|
1978
|
-
"isESM": true,
|
|
1979
|
-
"relativePath": [
|
|
1980
|
-
"dist",
|
|
1981
|
-
"commands",
|
|
1982
|
-
"kv",
|
|
1983
|
-
"set.js"
|
|
1984
|
-
]
|
|
1985
|
-
},
|
|
1986
|
-
"investigations:analytics": {
|
|
1987
|
-
"aliases": [],
|
|
1988
|
-
"args": {},
|
|
1989
|
-
"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.",
|
|
1990
|
-
"examples": [
|
|
1991
|
-
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01",
|
|
1992
|
-
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
|
|
1993
|
-
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
|
|
1991
|
+
"<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01",
|
|
1992
|
+
"<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
|
|
1993
|
+
"<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
|
|
1994
1994
|
],
|
|
1995
1995
|
"flags": {
|
|
1996
1996
|
"json": {
|
|
@@ -2062,7 +2062,7 @@
|
|
|
2062
2062
|
},
|
|
2063
2063
|
"hasDynamicHelp": false,
|
|
2064
2064
|
"hiddenAliases": [],
|
|
2065
|
-
"id": "
|
|
2065
|
+
"id": "investigation:analytics",
|
|
2066
2066
|
"pluginAlias": "@formant/formant-cli",
|
|
2067
2067
|
"pluginName": "@formant/formant-cli",
|
|
2068
2068
|
"pluginType": "core",
|
|
@@ -2073,11 +2073,11 @@
|
|
|
2073
2073
|
"relativePath": [
|
|
2074
2074
|
"dist",
|
|
2075
2075
|
"commands",
|
|
2076
|
-
"
|
|
2076
|
+
"investigation",
|
|
2077
2077
|
"analytics.js"
|
|
2078
2078
|
]
|
|
2079
2079
|
},
|
|
2080
|
-
"
|
|
2080
|
+
"investigation:get": {
|
|
2081
2081
|
"aliases": [],
|
|
2082
2082
|
"args": {
|
|
2083
2083
|
"id": {
|
|
@@ -2088,8 +2088,8 @@
|
|
|
2088
2088
|
},
|
|
2089
2089
|
"description": "Get detailed information about a specific investigation by ID.",
|
|
2090
2090
|
"examples": [
|
|
2091
|
-
"<%= config.bin %>
|
|
2092
|
-
"<%= config.bin %>
|
|
2091
|
+
"<%= config.bin %> investigation get <id>",
|
|
2092
|
+
"<%= config.bin %> investigation get <id> --json"
|
|
2093
2093
|
],
|
|
2094
2094
|
"flags": {
|
|
2095
2095
|
"json": {
|
|
@@ -2122,7 +2122,7 @@
|
|
|
2122
2122
|
},
|
|
2123
2123
|
"hasDynamicHelp": false,
|
|
2124
2124
|
"hiddenAliases": [],
|
|
2125
|
-
"id": "
|
|
2125
|
+
"id": "investigation:get",
|
|
2126
2126
|
"pluginAlias": "@formant/formant-cli",
|
|
2127
2127
|
"pluginName": "@formant/formant-cli",
|
|
2128
2128
|
"pluginType": "core",
|
|
@@ -2133,18 +2133,18 @@
|
|
|
2133
2133
|
"relativePath": [
|
|
2134
2134
|
"dist",
|
|
2135
2135
|
"commands",
|
|
2136
|
-
"
|
|
2136
|
+
"investigation",
|
|
2137
2137
|
"get.js"
|
|
2138
2138
|
]
|
|
2139
2139
|
},
|
|
2140
|
-
"
|
|
2140
|
+
"investigation:list": {
|
|
2141
2141
|
"aliases": [],
|
|
2142
2142
|
"args": {},
|
|
2143
2143
|
"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.",
|
|
2144
2144
|
"examples": [
|
|
2145
|
-
"<%= config.bin %>
|
|
2146
|
-
"<%= config.bin %>
|
|
2147
|
-
"<%= config.bin %>
|
|
2145
|
+
"<%= config.bin %> investigation list",
|
|
2146
|
+
"<%= config.bin %> investigation list --signal-handler",
|
|
2147
|
+
"<%= config.bin %> investigation list --json"
|
|
2148
2148
|
],
|
|
2149
2149
|
"flags": {
|
|
2150
2150
|
"json": {
|
|
@@ -2183,7 +2183,7 @@
|
|
|
2183
2183
|
},
|
|
2184
2184
|
"hasDynamicHelp": false,
|
|
2185
2185
|
"hiddenAliases": [],
|
|
2186
|
-
"id": "
|
|
2186
|
+
"id": "investigation:list",
|
|
2187
2187
|
"pluginAlias": "@formant/formant-cli",
|
|
2188
2188
|
"pluginName": "@formant/formant-cli",
|
|
2189
2189
|
"pluginType": "core",
|
|
@@ -2194,11 +2194,11 @@
|
|
|
2194
2194
|
"relativePath": [
|
|
2195
2195
|
"dist",
|
|
2196
2196
|
"commands",
|
|
2197
|
-
"
|
|
2197
|
+
"investigation",
|
|
2198
2198
|
"list.js"
|
|
2199
2199
|
]
|
|
2200
2200
|
},
|
|
2201
|
-
"
|
|
2201
|
+
"investigation:run": {
|
|
2202
2202
|
"aliases": [],
|
|
2203
2203
|
"args": {
|
|
2204
2204
|
"investigationId": {
|
|
@@ -2214,9 +2214,9 @@
|
|
|
2214
2214
|
},
|
|
2215
2215
|
"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.",
|
|
2216
2216
|
"examples": [
|
|
2217
|
-
"<%= config.bin %>
|
|
2218
|
-
"<%= config.bin %>
|
|
2219
|
-
"<%= config.bin %>
|
|
2217
|
+
"<%= config.bin %> investigation run <investigation-id> <run-id>",
|
|
2218
|
+
"<%= config.bin %> investigation run <investigation-id> <run-id> --log-only",
|
|
2219
|
+
"<%= config.bin %> investigation run <investigation-id> <run-id> --json"
|
|
2220
2220
|
],
|
|
2221
2221
|
"flags": {
|
|
2222
2222
|
"json": {
|
|
@@ -2261,7 +2261,7 @@
|
|
|
2261
2261
|
},
|
|
2262
2262
|
"hasDynamicHelp": false,
|
|
2263
2263
|
"hiddenAliases": [],
|
|
2264
|
-
"id": "
|
|
2264
|
+
"id": "investigation:run",
|
|
2265
2265
|
"pluginAlias": "@formant/formant-cli",
|
|
2266
2266
|
"pluginName": "@formant/formant-cli",
|
|
2267
2267
|
"pluginType": "core",
|
|
@@ -2272,11 +2272,11 @@
|
|
|
2272
2272
|
"relativePath": [
|
|
2273
2273
|
"dist",
|
|
2274
2274
|
"commands",
|
|
2275
|
-
"
|
|
2275
|
+
"investigation",
|
|
2276
2276
|
"run.js"
|
|
2277
2277
|
]
|
|
2278
2278
|
},
|
|
2279
|
-
"
|
|
2279
|
+
"investigation:runs-list": {
|
|
2280
2280
|
"aliases": [],
|
|
2281
2281
|
"args": {
|
|
2282
2282
|
"id": {
|
|
@@ -2287,9 +2287,9 @@
|
|
|
2287
2287
|
},
|
|
2288
2288
|
"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.",
|
|
2289
2289
|
"examples": [
|
|
2290
|
-
"<%= config.bin %>
|
|
2291
|
-
"<%= config.bin %>
|
|
2292
|
-
"<%= config.bin %>
|
|
2290
|
+
"<%= config.bin %> investigation runs-list <id>",
|
|
2291
|
+
"<%= config.bin %> investigation runs-list <id> --limit 50",
|
|
2292
|
+
"<%= config.bin %> investigation runs-list <id> --details --json"
|
|
2293
2293
|
],
|
|
2294
2294
|
"flags": {
|
|
2295
2295
|
"json": {
|
|
@@ -2346,7 +2346,7 @@
|
|
|
2346
2346
|
},
|
|
2347
2347
|
"hasDynamicHelp": false,
|
|
2348
2348
|
"hiddenAliases": [],
|
|
2349
|
-
"id": "
|
|
2349
|
+
"id": "investigation:runs-list",
|
|
2350
2350
|
"pluginAlias": "@formant/formant-cli",
|
|
2351
2351
|
"pluginName": "@formant/formant-cli",
|
|
2352
2352
|
"pluginType": "core",
|
|
@@ -2357,11 +2357,11 @@
|
|
|
2357
2357
|
"relativePath": [
|
|
2358
2358
|
"dist",
|
|
2359
2359
|
"commands",
|
|
2360
|
-
"
|
|
2360
|
+
"investigation",
|
|
2361
2361
|
"runs-list.js"
|
|
2362
2362
|
]
|
|
2363
2363
|
},
|
|
2364
|
-
"
|
|
2364
|
+
"investigation:runs": {
|
|
2365
2365
|
"aliases": [],
|
|
2366
2366
|
"args": {
|
|
2367
2367
|
"id": {
|
|
@@ -2372,8 +2372,8 @@
|
|
|
2372
2372
|
},
|
|
2373
2373
|
"description": "List evaluation runs for a specific investigation.",
|
|
2374
2374
|
"examples": [
|
|
2375
|
-
"<%= config.bin %>
|
|
2376
|
-
"<%= config.bin %>
|
|
2375
|
+
"<%= config.bin %> investigation runs <id>",
|
|
2376
|
+
"<%= config.bin %> investigation runs <id> --json"
|
|
2377
2377
|
],
|
|
2378
2378
|
"flags": {
|
|
2379
2379
|
"json": {
|
|
@@ -2406,7 +2406,7 @@
|
|
|
2406
2406
|
},
|
|
2407
2407
|
"hasDynamicHelp": false,
|
|
2408
2408
|
"hiddenAliases": [],
|
|
2409
|
-
"id": "
|
|
2409
|
+
"id": "investigation:runs",
|
|
2410
2410
|
"pluginAlias": "@formant/formant-cli",
|
|
2411
2411
|
"pluginName": "@formant/formant-cli",
|
|
2412
2412
|
"pluginType": "core",
|
|
@@ -2417,17 +2417,17 @@
|
|
|
2417
2417
|
"relativePath": [
|
|
2418
2418
|
"dist",
|
|
2419
2419
|
"commands",
|
|
2420
|
-
"
|
|
2420
|
+
"investigation",
|
|
2421
2421
|
"runs.js"
|
|
2422
2422
|
]
|
|
2423
2423
|
},
|
|
2424
|
-
"
|
|
2424
|
+
"investigation:stats": {
|
|
2425
2425
|
"aliases": [],
|
|
2426
2426
|
"args": {},
|
|
2427
2427
|
"description": "Get investigation statistics for a time range.",
|
|
2428
2428
|
"examples": [
|
|
2429
|
-
"<%= config.bin %>
|
|
2430
|
-
"<%= config.bin %>
|
|
2429
|
+
"<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01",
|
|
2430
|
+
"<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01 --json"
|
|
2431
2431
|
],
|
|
2432
2432
|
"flags": {
|
|
2433
2433
|
"json": {
|
|
@@ -2476,7 +2476,7 @@
|
|
|
2476
2476
|
},
|
|
2477
2477
|
"hasDynamicHelp": false,
|
|
2478
2478
|
"hiddenAliases": [],
|
|
2479
|
-
"id": "
|
|
2479
|
+
"id": "investigation:stats",
|
|
2480
2480
|
"pluginAlias": "@formant/formant-cli",
|
|
2481
2481
|
"pluginName": "@formant/formant-cli",
|
|
2482
2482
|
"pluginType": "core",
|
|
@@ -2487,11 +2487,11 @@
|
|
|
2487
2487
|
"relativePath": [
|
|
2488
2488
|
"dist",
|
|
2489
2489
|
"commands",
|
|
2490
|
-
"
|
|
2490
|
+
"investigation",
|
|
2491
2491
|
"stats.js"
|
|
2492
2492
|
]
|
|
2493
2493
|
},
|
|
2494
|
-
"
|
|
2494
|
+
"investigation:trigger": {
|
|
2495
2495
|
"aliases": [],
|
|
2496
2496
|
"args": {
|
|
2497
2497
|
"id": {
|
|
@@ -2502,8 +2502,8 @@
|
|
|
2502
2502
|
},
|
|
2503
2503
|
"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.",
|
|
2504
2504
|
"examples": [
|
|
2505
|
-
"<%= config.bin %>
|
|
2506
|
-
"<%= config.bin %>
|
|
2505
|
+
"<%= config.bin %> investigation trigger <id> --input \"Robot stopped responding\"",
|
|
2506
|
+
"<%= config.bin %> investigation trigger <id> --input \"Battery draining fast on device X\" --json"
|
|
2507
2507
|
],
|
|
2508
2508
|
"flags": {
|
|
2509
2509
|
"json": {
|
|
@@ -2552,7 +2552,7 @@
|
|
|
2552
2552
|
},
|
|
2553
2553
|
"hasDynamicHelp": false,
|
|
2554
2554
|
"hiddenAliases": [],
|
|
2555
|
-
"id": "
|
|
2555
|
+
"id": "investigation:trigger",
|
|
2556
2556
|
"pluginAlias": "@formant/formant-cli",
|
|
2557
2557
|
"pluginName": "@formant/formant-cli",
|
|
2558
2558
|
"pluginType": "core",
|
|
@@ -2563,19 +2563,23 @@
|
|
|
2563
2563
|
"relativePath": [
|
|
2564
2564
|
"dist",
|
|
2565
2565
|
"commands",
|
|
2566
|
-
"
|
|
2566
|
+
"investigation",
|
|
2567
2567
|
"trigger.js"
|
|
2568
2568
|
]
|
|
2569
2569
|
},
|
|
2570
|
-
"
|
|
2570
|
+
"device:config": {
|
|
2571
2571
|
"aliases": [],
|
|
2572
|
-
"args": {
|
|
2573
|
-
|
|
2572
|
+
"args": {
|
|
2573
|
+
"id": {
|
|
2574
|
+
"description": "Device ID (UUID)",
|
|
2575
|
+
"name": "id",
|
|
2576
|
+
"required": true
|
|
2577
|
+
}
|
|
2578
|
+
},
|
|
2579
|
+
"description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
|
|
2574
2580
|
"examples": [
|
|
2575
|
-
"<%= config.bin %>
|
|
2576
|
-
"<%= config.bin %>
|
|
2577
|
-
"<%= config.bin %> query --device <id> --stream battery_level --latest",
|
|
2578
|
-
"<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
|
|
2581
|
+
"<%= config.bin %> device config <device-id>",
|
|
2582
|
+
"<%= config.bin %> device config <device-id> --json"
|
|
2579
2583
|
],
|
|
2580
2584
|
"flags": {
|
|
2581
2585
|
"json": {
|
|
@@ -2604,95 +2608,39 @@
|
|
|
2604
2608
|
"name": "stage",
|
|
2605
2609
|
"allowNo": false,
|
|
2606
2610
|
"type": "boolean"
|
|
2607
|
-
},
|
|
2608
|
-
"aggregate": {
|
|
2609
|
-
"char": "a",
|
|
2610
|
-
"description": "Aggregation level for downsampling",
|
|
2611
|
-
"name": "aggregate",
|
|
2612
|
-
"hasDynamicHelp": false,
|
|
2613
|
-
"multiple": false,
|
|
2614
|
-
"type": "option"
|
|
2615
|
-
},
|
|
2616
|
-
"device": {
|
|
2617
|
-
"char": "d",
|
|
2618
|
-
"description": "Device ID (UUID)",
|
|
2619
|
-
"name": "device",
|
|
2620
|
-
"required": true,
|
|
2621
|
-
"hasDynamicHelp": false,
|
|
2622
|
-
"multiple": false,
|
|
2623
|
-
"type": "option"
|
|
2624
|
-
},
|
|
2625
|
-
"end": {
|
|
2626
|
-
"description": "End time (ISO 8601)",
|
|
2627
|
-
"name": "end",
|
|
2628
|
-
"hasDynamicHelp": false,
|
|
2629
|
-
"multiple": false,
|
|
2630
|
-
"type": "option"
|
|
2631
|
-
},
|
|
2632
|
-
"latest": {
|
|
2633
|
-
"description": "Only return the most recent value per stream",
|
|
2634
|
-
"name": "latest",
|
|
2635
|
-
"allowNo": false,
|
|
2636
|
-
"type": "boolean"
|
|
2637
|
-
},
|
|
2638
|
-
"limit": {
|
|
2639
|
-
"char": "l",
|
|
2640
|
-
"description": "Maximum number of datapoints",
|
|
2641
|
-
"name": "limit",
|
|
2642
|
-
"hasDynamicHelp": false,
|
|
2643
|
-
"multiple": false,
|
|
2644
|
-
"type": "option"
|
|
2645
|
-
},
|
|
2646
|
-
"start": {
|
|
2647
|
-
"description": "Start time (ISO 8601)",
|
|
2648
|
-
"name": "start",
|
|
2649
|
-
"hasDynamicHelp": false,
|
|
2650
|
-
"multiple": false,
|
|
2651
|
-
"type": "option"
|
|
2652
|
-
},
|
|
2653
|
-
"stream": {
|
|
2654
|
-
"char": "s",
|
|
2655
|
-
"description": "Stream name(s), can be specified multiple times",
|
|
2656
|
-
"name": "stream",
|
|
2657
|
-
"required": true,
|
|
2658
|
-
"hasDynamicHelp": false,
|
|
2659
|
-
"multiple": true,
|
|
2660
|
-
"type": "option"
|
|
2661
|
-
},
|
|
2662
|
-
"type": {
|
|
2663
|
-
"description": "Filter by stream type",
|
|
2664
|
-
"name": "type",
|
|
2665
|
-
"hasDynamicHelp": false,
|
|
2666
|
-
"multiple": false,
|
|
2667
|
-
"type": "option"
|
|
2668
2611
|
}
|
|
2669
2612
|
},
|
|
2670
2613
|
"hasDynamicHelp": false,
|
|
2671
2614
|
"hiddenAliases": [],
|
|
2672
|
-
"id": "
|
|
2615
|
+
"id": "device:config",
|
|
2673
2616
|
"pluginAlias": "@formant/formant-cli",
|
|
2674
2617
|
"pluginName": "@formant/formant-cli",
|
|
2675
2618
|
"pluginType": "core",
|
|
2676
2619
|
"strict": true,
|
|
2677
|
-
"summary": "
|
|
2620
|
+
"summary": "Get device configuration",
|
|
2678
2621
|
"enableJsonFlag": true,
|
|
2679
2622
|
"isESM": true,
|
|
2680
2623
|
"relativePath": [
|
|
2681
2624
|
"dist",
|
|
2682
2625
|
"commands",
|
|
2683
|
-
"
|
|
2684
|
-
"
|
|
2626
|
+
"device",
|
|
2627
|
+
"config.js"
|
|
2685
2628
|
]
|
|
2686
2629
|
},
|
|
2687
|
-
"
|
|
2630
|
+
"device:create": {
|
|
2688
2631
|
"aliases": [],
|
|
2689
|
-
"args": {
|
|
2690
|
-
|
|
2632
|
+
"args": {
|
|
2633
|
+
"name": {
|
|
2634
|
+
"description": "Name for the new device",
|
|
2635
|
+
"name": "name",
|
|
2636
|
+
"required": true
|
|
2637
|
+
}
|
|
2638
|
+
},
|
|
2639
|
+
"description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
|
|
2691
2640
|
"examples": [
|
|
2692
|
-
"<%= config.bin %>
|
|
2693
|
-
"<%= config.bin %>
|
|
2694
|
-
"<%= config.bin %>
|
|
2695
|
-
"<%= config.bin %> query latest-values --device <id> --all-streams --json"
|
|
2641
|
+
"<%= config.bin %> device create my-robot",
|
|
2642
|
+
"<%= config.bin %> device create my-robot --tag location=warehouse --tag env=prod",
|
|
2643
|
+
"<%= config.bin %> device create my-robot --json"
|
|
2696
2644
|
],
|
|
2697
2645
|
"flags": {
|
|
2698
2646
|
"json": {
|
|
@@ -2722,25 +2670,10 @@
|
|
|
2722
2670
|
"allowNo": false,
|
|
2723
2671
|
"type": "boolean"
|
|
2724
2672
|
},
|
|
2725
|
-
"
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2728
|
-
"
|
|
2729
|
-
"type": "boolean"
|
|
2730
|
-
},
|
|
2731
|
-
"device": {
|
|
2732
|
-
"char": "d",
|
|
2733
|
-
"description": "Device ID (UUID)",
|
|
2734
|
-
"name": "device",
|
|
2735
|
-
"required": true,
|
|
2736
|
-
"hasDynamicHelp": false,
|
|
2737
|
-
"multiple": true,
|
|
2738
|
-
"type": "option"
|
|
2739
|
-
},
|
|
2740
|
-
"stream": {
|
|
2741
|
-
"char": "s",
|
|
2742
|
-
"description": "Stream name(s), can be specified multiple times",
|
|
2743
|
-
"name": "stream",
|
|
2673
|
+
"tag": {
|
|
2674
|
+
"char": "t",
|
|
2675
|
+
"description": "Tag to apply (key=value), can be specified multiple times",
|
|
2676
|
+
"name": "tag",
|
|
2744
2677
|
"hasDynamicHelp": false,
|
|
2745
2678
|
"multiple": true,
|
|
2746
2679
|
"type": "option"
|
|
@@ -2748,34 +2681,34 @@
|
|
|
2748
2681
|
},
|
|
2749
2682
|
"hasDynamicHelp": false,
|
|
2750
2683
|
"hiddenAliases": [],
|
|
2751
|
-
"id": "
|
|
2684
|
+
"id": "device:create",
|
|
2752
2685
|
"pluginAlias": "@formant/formant-cli",
|
|
2753
2686
|
"pluginName": "@formant/formant-cli",
|
|
2754
2687
|
"pluginType": "core",
|
|
2755
2688
|
"strict": true,
|
|
2756
|
-
"summary": "
|
|
2689
|
+
"summary": "Create a new device",
|
|
2757
2690
|
"enableJsonFlag": true,
|
|
2758
2691
|
"isESM": true,
|
|
2759
2692
|
"relativePath": [
|
|
2760
2693
|
"dist",
|
|
2761
2694
|
"commands",
|
|
2762
|
-
"
|
|
2763
|
-
"
|
|
2695
|
+
"device",
|
|
2696
|
+
"create.js"
|
|
2764
2697
|
]
|
|
2765
2698
|
},
|
|
2766
|
-
"
|
|
2699
|
+
"device:delete": {
|
|
2767
2700
|
"aliases": [],
|
|
2768
2701
|
"args": {
|
|
2769
2702
|
"id": {
|
|
2770
|
-
"description": "
|
|
2703
|
+
"description": "Device ID (UUID)",
|
|
2771
2704
|
"name": "id",
|
|
2772
2705
|
"required": true
|
|
2773
2706
|
}
|
|
2774
2707
|
},
|
|
2775
|
-
"description": "
|
|
2708
|
+
"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.",
|
|
2776
2709
|
"examples": [
|
|
2777
|
-
"<%= config.bin %>
|
|
2778
|
-
"<%= config.bin %>
|
|
2710
|
+
"<%= config.bin %> device delete <device-id>",
|
|
2711
|
+
"<%= config.bin %> device delete <device-id> --json"
|
|
2779
2712
|
],
|
|
2780
2713
|
"flags": {
|
|
2781
2714
|
"json": {
|
|
@@ -2808,28 +2741,34 @@
|
|
|
2808
2741
|
},
|
|
2809
2742
|
"hasDynamicHelp": false,
|
|
2810
2743
|
"hiddenAliases": [],
|
|
2811
|
-
"id": "
|
|
2744
|
+
"id": "device:delete",
|
|
2812
2745
|
"pluginAlias": "@formant/formant-cli",
|
|
2813
2746
|
"pluginName": "@formant/formant-cli",
|
|
2814
2747
|
"pluginType": "core",
|
|
2815
2748
|
"strict": true,
|
|
2816
|
-
"summary": "
|
|
2749
|
+
"summary": "Delete (disable) a device",
|
|
2817
2750
|
"enableJsonFlag": true,
|
|
2818
2751
|
"isESM": true,
|
|
2819
2752
|
"relativePath": [
|
|
2820
2753
|
"dist",
|
|
2821
2754
|
"commands",
|
|
2822
|
-
"
|
|
2823
|
-
"
|
|
2755
|
+
"device",
|
|
2756
|
+
"delete.js"
|
|
2824
2757
|
]
|
|
2825
2758
|
},
|
|
2826
|
-
"
|
|
2759
|
+
"device:get": {
|
|
2827
2760
|
"aliases": [],
|
|
2828
|
-
"args": {
|
|
2829
|
-
|
|
2761
|
+
"args": {
|
|
2762
|
+
"id": {
|
|
2763
|
+
"description": "Device ID (UUID)",
|
|
2764
|
+
"name": "id",
|
|
2765
|
+
"required": true
|
|
2766
|
+
}
|
|
2767
|
+
},
|
|
2768
|
+
"description": "Get detailed information about a specific device by its ID.",
|
|
2830
2769
|
"examples": [
|
|
2831
|
-
"<%= config.bin %>
|
|
2832
|
-
"<%= config.bin %>
|
|
2770
|
+
"<%= config.bin %> device get <device-id>",
|
|
2771
|
+
"<%= config.bin %> device get <device-id> --json"
|
|
2833
2772
|
],
|
|
2834
2773
|
"flags": {
|
|
2835
2774
|
"json": {
|
|
@@ -2862,34 +2801,34 @@
|
|
|
2862
2801
|
},
|
|
2863
2802
|
"hasDynamicHelp": false,
|
|
2864
2803
|
"hiddenAliases": [],
|
|
2865
|
-
"id": "
|
|
2804
|
+
"id": "device:get",
|
|
2866
2805
|
"pluginAlias": "@formant/formant-cli",
|
|
2867
2806
|
"pluginName": "@formant/formant-cli",
|
|
2868
2807
|
"pluginType": "core",
|
|
2869
2808
|
"strict": true,
|
|
2870
|
-
"summary": "
|
|
2809
|
+
"summary": "Get a device by ID",
|
|
2871
2810
|
"enableJsonFlag": true,
|
|
2872
2811
|
"isESM": true,
|
|
2873
2812
|
"relativePath": [
|
|
2874
2813
|
"dist",
|
|
2875
2814
|
"commands",
|
|
2876
|
-
"
|
|
2877
|
-
"
|
|
2815
|
+
"device",
|
|
2816
|
+
"get.js"
|
|
2878
2817
|
]
|
|
2879
2818
|
},
|
|
2880
|
-
"
|
|
2819
|
+
"device:last-seen": {
|
|
2881
2820
|
"aliases": [],
|
|
2882
2821
|
"args": {
|
|
2883
2822
|
"id": {
|
|
2884
|
-
"description": "
|
|
2823
|
+
"description": "Device ID (UUID)",
|
|
2885
2824
|
"name": "id",
|
|
2886
2825
|
"required": true
|
|
2887
2826
|
}
|
|
2888
2827
|
},
|
|
2889
|
-
"description": "Get
|
|
2828
|
+
"description": "Get when a device was last seen online.\n\nShows the most recent timestamp when the device was detected as online.",
|
|
2890
2829
|
"examples": [
|
|
2891
|
-
"<%= config.bin %>
|
|
2892
|
-
"<%= config.bin %>
|
|
2830
|
+
"<%= config.bin %> device last-seen <device-id>",
|
|
2831
|
+
"<%= config.bin %> device last-seen <device-id> --json"
|
|
2893
2832
|
],
|
|
2894
2833
|
"flags": {
|
|
2895
2834
|
"json": {
|
|
@@ -2922,28 +2861,31 @@
|
|
|
2922
2861
|
},
|
|
2923
2862
|
"hasDynamicHelp": false,
|
|
2924
2863
|
"hiddenAliases": [],
|
|
2925
|
-
"id": "
|
|
2864
|
+
"id": "device:last-seen",
|
|
2926
2865
|
"pluginAlias": "@formant/formant-cli",
|
|
2927
2866
|
"pluginName": "@formant/formant-cli",
|
|
2928
2867
|
"pluginType": "core",
|
|
2929
2868
|
"strict": true,
|
|
2930
|
-
"summary": "Get
|
|
2869
|
+
"summary": "Get device last seen timestamp",
|
|
2931
2870
|
"enableJsonFlag": true,
|
|
2932
2871
|
"isESM": true,
|
|
2933
2872
|
"relativePath": [
|
|
2934
2873
|
"dist",
|
|
2935
2874
|
"commands",
|
|
2936
|
-
"
|
|
2937
|
-
"
|
|
2875
|
+
"device",
|
|
2876
|
+
"last-seen.js"
|
|
2938
2877
|
]
|
|
2939
2878
|
},
|
|
2940
|
-
"
|
|
2879
|
+
"device:list": {
|
|
2941
2880
|
"aliases": [],
|
|
2942
2881
|
"args": {},
|
|
2943
|
-
"description": "List
|
|
2882
|
+
"description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --all to include offline devices.",
|
|
2944
2883
|
"examples": [
|
|
2945
|
-
"<%= config.bin %>
|
|
2946
|
-
"<%= config.bin %>
|
|
2884
|
+
"<%= config.bin %> device list",
|
|
2885
|
+
"<%= config.bin %> device list --all",
|
|
2886
|
+
"<%= config.bin %> device list --all --limit 100",
|
|
2887
|
+
"<%= config.bin %> device list --tag location=warehouse",
|
|
2888
|
+
"<%= config.bin %> device list --name robot --dev --json"
|
|
2947
2889
|
],
|
|
2948
2890
|
"flags": {
|
|
2949
2891
|
"json": {
|
|
@@ -2972,33 +2914,75 @@
|
|
|
2972
2914
|
"name": "stage",
|
|
2973
2915
|
"allowNo": false,
|
|
2974
2916
|
"type": "boolean"
|
|
2917
|
+
},
|
|
2918
|
+
"all": {
|
|
2919
|
+
"char": "a",
|
|
2920
|
+
"description": "Show all devices (online and offline)",
|
|
2921
|
+
"name": "all",
|
|
2922
|
+
"allowNo": false,
|
|
2923
|
+
"type": "boolean"
|
|
2924
|
+
},
|
|
2925
|
+
"limit": {
|
|
2926
|
+
"char": "l",
|
|
2927
|
+
"description": "Maximum number of devices to return",
|
|
2928
|
+
"name": "limit",
|
|
2929
|
+
"default": 50,
|
|
2930
|
+
"hasDynamicHelp": false,
|
|
2931
|
+
"multiple": false,
|
|
2932
|
+
"type": "option"
|
|
2933
|
+
},
|
|
2934
|
+
"name": {
|
|
2935
|
+
"char": "n",
|
|
2936
|
+
"description": "Filter devices by name (search)",
|
|
2937
|
+
"name": "name",
|
|
2938
|
+
"hasDynamicHelp": false,
|
|
2939
|
+
"multiple": false,
|
|
2940
|
+
"type": "option"
|
|
2941
|
+
},
|
|
2942
|
+
"tag": {
|
|
2943
|
+
"char": "t",
|
|
2944
|
+
"description": "Filter by tag (key=value), can be specified multiple times",
|
|
2945
|
+
"name": "tag",
|
|
2946
|
+
"hasDynamicHelp": false,
|
|
2947
|
+
"multiple": true,
|
|
2948
|
+
"type": "option"
|
|
2975
2949
|
}
|
|
2976
2950
|
},
|
|
2977
2951
|
"hasDynamicHelp": false,
|
|
2978
2952
|
"hiddenAliases": [],
|
|
2979
|
-
"id": "
|
|
2953
|
+
"id": "device:list",
|
|
2980
2954
|
"pluginAlias": "@formant/formant-cli",
|
|
2981
2955
|
"pluginName": "@formant/formant-cli",
|
|
2982
2956
|
"pluginType": "core",
|
|
2983
2957
|
"strict": true,
|
|
2984
|
-
"summary": "List
|
|
2958
|
+
"summary": "List robots and sensors in your fleet",
|
|
2985
2959
|
"enableJsonFlag": true,
|
|
2986
2960
|
"isESM": true,
|
|
2987
2961
|
"relativePath": [
|
|
2988
2962
|
"dist",
|
|
2989
2963
|
"commands",
|
|
2990
|
-
"
|
|
2964
|
+
"device",
|
|
2991
2965
|
"list.js"
|
|
2992
2966
|
]
|
|
2993
2967
|
},
|
|
2994
|
-
"
|
|
2968
|
+
"device:rename": {
|
|
2995
2969
|
"aliases": [],
|
|
2996
|
-
"args": {
|
|
2997
|
-
|
|
2970
|
+
"args": {
|
|
2971
|
+
"id": {
|
|
2972
|
+
"description": "Device ID (UUID)",
|
|
2973
|
+
"name": "id",
|
|
2974
|
+
"required": true
|
|
2975
|
+
},
|
|
2976
|
+
"name": {
|
|
2977
|
+
"description": "New name for the device",
|
|
2978
|
+
"name": "name",
|
|
2979
|
+
"required": true
|
|
2980
|
+
}
|
|
2981
|
+
},
|
|
2982
|
+
"description": "Rename a device by updating its name.",
|
|
2998
2983
|
"examples": [
|
|
2999
|
-
"<%= config.bin %>
|
|
3000
|
-
"<%= config.bin %>
|
|
3001
|
-
"<%= config.bin %> signals count --json"
|
|
2984
|
+
"<%= config.bin %> device rename <device-id> new-robot-name",
|
|
2985
|
+
"<%= config.bin %> device rename <device-id> new-robot-name --json"
|
|
3002
2986
|
],
|
|
3003
2987
|
"flags": {
|
|
3004
2988
|
"json": {
|
|
@@ -3027,17 +3011,72 @@
|
|
|
3027
3011
|
"name": "stage",
|
|
3028
3012
|
"allowNo": false,
|
|
3029
3013
|
"type": "boolean"
|
|
3014
|
+
}
|
|
3015
|
+
},
|
|
3016
|
+
"hasDynamicHelp": false,
|
|
3017
|
+
"hiddenAliases": [],
|
|
3018
|
+
"id": "device:rename",
|
|
3019
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3020
|
+
"pluginName": "@formant/formant-cli",
|
|
3021
|
+
"pluginType": "core",
|
|
3022
|
+
"strict": true,
|
|
3023
|
+
"summary": "Rename a device",
|
|
3024
|
+
"enableJsonFlag": true,
|
|
3025
|
+
"isESM": true,
|
|
3026
|
+
"relativePath": [
|
|
3027
|
+
"dist",
|
|
3028
|
+
"commands",
|
|
3029
|
+
"device",
|
|
3030
|
+
"rename.js"
|
|
3031
|
+
]
|
|
3032
|
+
},
|
|
3033
|
+
"device:streams": {
|
|
3034
|
+
"aliases": [],
|
|
3035
|
+
"args": {
|
|
3036
|
+
"id": {
|
|
3037
|
+
"description": "Device ID (UUID)",
|
|
3038
|
+
"name": "id",
|
|
3039
|
+
"required": true
|
|
3040
|
+
}
|
|
3041
|
+
},
|
|
3042
|
+
"description": "List telemetry streams for a device.\n\nShows streams parsed from the device configuration as well as any streams\ndiscovered from actual ingested data (even if not explicitly configured).\nUnconfigured streams are marked with a SOURCE of \"data\" in the output.",
|
|
3043
|
+
"examples": [
|
|
3044
|
+
"<%= config.bin %> device streams <device-id>",
|
|
3045
|
+
"<%= config.bin %> device streams <device-id> --json",
|
|
3046
|
+
"<%= config.bin %> device streams <device-id> --days 30"
|
|
3047
|
+
],
|
|
3048
|
+
"flags": {
|
|
3049
|
+
"json": {
|
|
3050
|
+
"description": "Format output as json.",
|
|
3051
|
+
"helpGroup": "GLOBAL",
|
|
3052
|
+
"name": "json",
|
|
3053
|
+
"allowNo": false,
|
|
3054
|
+
"type": "boolean"
|
|
3030
3055
|
},
|
|
3031
|
-
"
|
|
3032
|
-
"description": "
|
|
3033
|
-
"
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
"
|
|
3056
|
+
"dev": {
|
|
3057
|
+
"description": "Target the dev environment",
|
|
3058
|
+
"exclusive": [
|
|
3059
|
+
"stage"
|
|
3060
|
+
],
|
|
3061
|
+
"helpGroup": "GLOBAL",
|
|
3062
|
+
"name": "dev",
|
|
3063
|
+
"allowNo": false,
|
|
3064
|
+
"type": "boolean"
|
|
3037
3065
|
},
|
|
3038
|
-
"
|
|
3039
|
-
"description": "
|
|
3040
|
-
"
|
|
3066
|
+
"stage": {
|
|
3067
|
+
"description": "Target the stage environment",
|
|
3068
|
+
"exclusive": [
|
|
3069
|
+
"dev"
|
|
3070
|
+
],
|
|
3071
|
+
"helpGroup": "GLOBAL",
|
|
3072
|
+
"name": "stage",
|
|
3073
|
+
"allowNo": false,
|
|
3074
|
+
"type": "boolean"
|
|
3075
|
+
},
|
|
3076
|
+
"days": {
|
|
3077
|
+
"description": "How many days back to look for unconfigured streams in ingested data",
|
|
3078
|
+
"name": "days",
|
|
3079
|
+
"default": 14,
|
|
3041
3080
|
"hasDynamicHelp": false,
|
|
3042
3081
|
"multiple": false,
|
|
3043
3082
|
"type": "option"
|
|
@@ -3045,35 +3084,35 @@
|
|
|
3045
3084
|
},
|
|
3046
3085
|
"hasDynamicHelp": false,
|
|
3047
3086
|
"hiddenAliases": [],
|
|
3048
|
-
"id": "
|
|
3087
|
+
"id": "device:streams",
|
|
3049
3088
|
"pluginAlias": "@formant/formant-cli",
|
|
3050
3089
|
"pluginName": "@formant/formant-cli",
|
|
3051
3090
|
"pluginType": "core",
|
|
3052
3091
|
"strict": true,
|
|
3053
|
-
"summary": "
|
|
3092
|
+
"summary": "List device streams",
|
|
3054
3093
|
"enableJsonFlag": true,
|
|
3055
3094
|
"isESM": true,
|
|
3056
3095
|
"relativePath": [
|
|
3057
3096
|
"dist",
|
|
3058
3097
|
"commands",
|
|
3059
|
-
"
|
|
3060
|
-
"
|
|
3098
|
+
"device",
|
|
3099
|
+
"streams.js"
|
|
3061
3100
|
]
|
|
3062
3101
|
},
|
|
3063
|
-
"
|
|
3102
|
+
"device:tag": {
|
|
3064
3103
|
"aliases": [],
|
|
3065
3104
|
"args": {
|
|
3066
3105
|
"id": {
|
|
3067
|
-
"description": "
|
|
3106
|
+
"description": "Device ID (UUID)",
|
|
3068
3107
|
"name": "id",
|
|
3069
3108
|
"required": true
|
|
3070
3109
|
}
|
|
3071
3110
|
},
|
|
3072
|
-
"description": "
|
|
3111
|
+
"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.",
|
|
3073
3112
|
"examples": [
|
|
3074
|
-
"<%= config.bin %>
|
|
3075
|
-
"<%= config.bin %>
|
|
3076
|
-
"<%= config.bin %>
|
|
3113
|
+
"<%= config.bin %> device tag <device-id> --tag location=warehouse",
|
|
3114
|
+
"<%= config.bin %> device tag <device-id> --tag env=prod --tag region=us-east",
|
|
3115
|
+
"<%= config.bin %> device tag <device-id> --tag location=factory --json"
|
|
3077
3116
|
],
|
|
3078
3117
|
"flags": {
|
|
3079
3118
|
"json": {
|
|
@@ -3103,37 +3142,47 @@
|
|
|
3103
3142
|
"allowNo": false,
|
|
3104
3143
|
"type": "boolean"
|
|
3105
3144
|
},
|
|
3106
|
-
"
|
|
3107
|
-
"
|
|
3108
|
-
"
|
|
3109
|
-
"
|
|
3110
|
-
"
|
|
3145
|
+
"tag": {
|
|
3146
|
+
"char": "t",
|
|
3147
|
+
"description": "Tag to add or update (key=value), can be specified multiple times",
|
|
3148
|
+
"name": "tag",
|
|
3149
|
+
"required": true,
|
|
3150
|
+
"hasDynamicHelp": false,
|
|
3151
|
+
"multiple": true,
|
|
3152
|
+
"type": "option"
|
|
3111
3153
|
}
|
|
3112
3154
|
},
|
|
3113
3155
|
"hasDynamicHelp": false,
|
|
3114
3156
|
"hiddenAliases": [],
|
|
3115
|
-
"id": "
|
|
3157
|
+
"id": "device:tag",
|
|
3116
3158
|
"pluginAlias": "@formant/formant-cli",
|
|
3117
3159
|
"pluginName": "@formant/formant-cli",
|
|
3118
3160
|
"pluginType": "core",
|
|
3119
3161
|
"strict": true,
|
|
3120
|
-
"summary": "
|
|
3162
|
+
"summary": "Add or update tags on a device",
|
|
3121
3163
|
"enableJsonFlag": true,
|
|
3122
3164
|
"isESM": true,
|
|
3123
3165
|
"relativePath": [
|
|
3124
3166
|
"dist",
|
|
3125
3167
|
"commands",
|
|
3126
|
-
"
|
|
3127
|
-
"
|
|
3168
|
+
"device",
|
|
3169
|
+
"tag.js"
|
|
3128
3170
|
]
|
|
3129
3171
|
},
|
|
3130
|
-
"
|
|
3172
|
+
"device:untag": {
|
|
3131
3173
|
"aliases": [],
|
|
3132
|
-
"args": {
|
|
3133
|
-
|
|
3174
|
+
"args": {
|
|
3175
|
+
"id": {
|
|
3176
|
+
"description": "Device ID (UUID)",
|
|
3177
|
+
"name": "id",
|
|
3178
|
+
"required": true
|
|
3179
|
+
}
|
|
3180
|
+
},
|
|
3181
|
+
"description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.",
|
|
3134
3182
|
"examples": [
|
|
3135
|
-
"<%= config.bin %>
|
|
3136
|
-
"<%= config.bin %>
|
|
3183
|
+
"<%= config.bin %> device untag <device-id> --key location",
|
|
3184
|
+
"<%= config.bin %> device untag <device-id> --key env --key region",
|
|
3185
|
+
"<%= config.bin %> device untag <device-id> --key location --json"
|
|
3137
3186
|
],
|
|
3138
3187
|
"flags": {
|
|
3139
3188
|
"json": {
|
|
@@ -3162,33 +3211,440 @@
|
|
|
3162
3211
|
"name": "stage",
|
|
3163
3212
|
"allowNo": false,
|
|
3164
3213
|
"type": "boolean"
|
|
3214
|
+
},
|
|
3215
|
+
"key": {
|
|
3216
|
+
"char": "k",
|
|
3217
|
+
"description": "Tag key to remove, can be specified multiple times",
|
|
3218
|
+
"name": "key",
|
|
3219
|
+
"required": true,
|
|
3220
|
+
"hasDynamicHelp": false,
|
|
3221
|
+
"multiple": true,
|
|
3222
|
+
"type": "option"
|
|
3165
3223
|
}
|
|
3166
3224
|
},
|
|
3167
3225
|
"hasDynamicHelp": false,
|
|
3168
3226
|
"hiddenAliases": [],
|
|
3169
|
-
"id": "
|
|
3227
|
+
"id": "device:untag",
|
|
3170
3228
|
"pluginAlias": "@formant/formant-cli",
|
|
3171
3229
|
"pluginName": "@formant/formant-cli",
|
|
3172
3230
|
"pluginType": "core",
|
|
3173
3231
|
"strict": true,
|
|
3174
|
-
"summary": "
|
|
3232
|
+
"summary": "Remove tags from a device",
|
|
3175
3233
|
"enableJsonFlag": true,
|
|
3176
3234
|
"isESM": true,
|
|
3177
3235
|
"relativePath": [
|
|
3178
3236
|
"dist",
|
|
3179
3237
|
"commands",
|
|
3180
|
-
"
|
|
3181
|
-
"
|
|
3238
|
+
"device",
|
|
3239
|
+
"untag.js"
|
|
3182
3240
|
]
|
|
3183
3241
|
},
|
|
3184
|
-
"
|
|
3242
|
+
"query": {
|
|
3185
3243
|
"aliases": [],
|
|
3186
3244
|
"args": {},
|
|
3187
|
-
"description": "Query
|
|
3245
|
+
"description": "Query telemetry stream data for a device over a time range.\n\nReturns time-series datapoints for the specified stream(s). Supports aggregation\nfor downsampling large datasets, and --latest to get only the most recent value.\n\nStream types: numeric, text, image, video, location, json, bitset, battery, health,\n\"numeric set\", \"point cloud\", localization, \"transform tree\", file.\n\nAggregate levels: second, 5 seconds, 30 seconds, minute, 5 minutes, 30 minutes,\nhour, 4 hours, 12 hours, day, week, month, year.",
|
|
3246
|
+
"examples": [
|
|
3247
|
+
"<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-01-02",
|
|
3248
|
+
"<%= config.bin %> query --device <id> --stream speed --aggregate hour --start 2026-01-01 --end 2026-02-01",
|
|
3249
|
+
"<%= config.bin %> query --device <id> --stream battery_level --latest",
|
|
3250
|
+
"<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
|
|
3251
|
+
],
|
|
3252
|
+
"flags": {
|
|
3253
|
+
"json": {
|
|
3254
|
+
"description": "Format output as json.",
|
|
3255
|
+
"helpGroup": "GLOBAL",
|
|
3256
|
+
"name": "json",
|
|
3257
|
+
"allowNo": false,
|
|
3258
|
+
"type": "boolean"
|
|
3259
|
+
},
|
|
3260
|
+
"dev": {
|
|
3261
|
+
"description": "Target the dev environment",
|
|
3262
|
+
"exclusive": [
|
|
3263
|
+
"stage"
|
|
3264
|
+
],
|
|
3265
|
+
"helpGroup": "GLOBAL",
|
|
3266
|
+
"name": "dev",
|
|
3267
|
+
"allowNo": false,
|
|
3268
|
+
"type": "boolean"
|
|
3269
|
+
},
|
|
3270
|
+
"stage": {
|
|
3271
|
+
"description": "Target the stage environment",
|
|
3272
|
+
"exclusive": [
|
|
3273
|
+
"dev"
|
|
3274
|
+
],
|
|
3275
|
+
"helpGroup": "GLOBAL",
|
|
3276
|
+
"name": "stage",
|
|
3277
|
+
"allowNo": false,
|
|
3278
|
+
"type": "boolean"
|
|
3279
|
+
},
|
|
3280
|
+
"aggregate": {
|
|
3281
|
+
"char": "a",
|
|
3282
|
+
"description": "Aggregation level for downsampling",
|
|
3283
|
+
"name": "aggregate",
|
|
3284
|
+
"hasDynamicHelp": false,
|
|
3285
|
+
"multiple": false,
|
|
3286
|
+
"type": "option"
|
|
3287
|
+
},
|
|
3288
|
+
"device": {
|
|
3289
|
+
"char": "d",
|
|
3290
|
+
"description": "Device ID (UUID)",
|
|
3291
|
+
"name": "device",
|
|
3292
|
+
"required": true,
|
|
3293
|
+
"hasDynamicHelp": false,
|
|
3294
|
+
"multiple": false,
|
|
3295
|
+
"type": "option"
|
|
3296
|
+
},
|
|
3297
|
+
"end": {
|
|
3298
|
+
"description": "End time (ISO 8601)",
|
|
3299
|
+
"name": "end",
|
|
3300
|
+
"hasDynamicHelp": false,
|
|
3301
|
+
"multiple": false,
|
|
3302
|
+
"type": "option"
|
|
3303
|
+
},
|
|
3304
|
+
"latest": {
|
|
3305
|
+
"description": "Only return the most recent value per stream",
|
|
3306
|
+
"name": "latest",
|
|
3307
|
+
"allowNo": false,
|
|
3308
|
+
"type": "boolean"
|
|
3309
|
+
},
|
|
3310
|
+
"limit": {
|
|
3311
|
+
"char": "l",
|
|
3312
|
+
"description": "Maximum number of datapoints",
|
|
3313
|
+
"name": "limit",
|
|
3314
|
+
"hasDynamicHelp": false,
|
|
3315
|
+
"multiple": false,
|
|
3316
|
+
"type": "option"
|
|
3317
|
+
},
|
|
3318
|
+
"start": {
|
|
3319
|
+
"description": "Start time (ISO 8601)",
|
|
3320
|
+
"name": "start",
|
|
3321
|
+
"hasDynamicHelp": false,
|
|
3322
|
+
"multiple": false,
|
|
3323
|
+
"type": "option"
|
|
3324
|
+
},
|
|
3325
|
+
"stream": {
|
|
3326
|
+
"char": "s",
|
|
3327
|
+
"description": "Stream name(s), can be specified multiple times",
|
|
3328
|
+
"name": "stream",
|
|
3329
|
+
"required": true,
|
|
3330
|
+
"hasDynamicHelp": false,
|
|
3331
|
+
"multiple": true,
|
|
3332
|
+
"type": "option"
|
|
3333
|
+
},
|
|
3334
|
+
"type": {
|
|
3335
|
+
"description": "Filter by stream type",
|
|
3336
|
+
"name": "type",
|
|
3337
|
+
"hasDynamicHelp": false,
|
|
3338
|
+
"multiple": false,
|
|
3339
|
+
"type": "option"
|
|
3340
|
+
}
|
|
3341
|
+
},
|
|
3342
|
+
"hasDynamicHelp": false,
|
|
3343
|
+
"hiddenAliases": [],
|
|
3344
|
+
"id": "query",
|
|
3345
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3346
|
+
"pluginName": "@formant/formant-cli",
|
|
3347
|
+
"pluginType": "core",
|
|
3348
|
+
"strict": true,
|
|
3349
|
+
"summary": "Query telemetry stream data",
|
|
3350
|
+
"enableJsonFlag": true,
|
|
3351
|
+
"isESM": true,
|
|
3352
|
+
"relativePath": [
|
|
3353
|
+
"dist",
|
|
3354
|
+
"commands",
|
|
3355
|
+
"query",
|
|
3356
|
+
"index.js"
|
|
3357
|
+
]
|
|
3358
|
+
},
|
|
3359
|
+
"query:latest-values": {
|
|
3360
|
+
"aliases": [],
|
|
3361
|
+
"args": {},
|
|
3362
|
+
"description": "Get the latest values for streams across devices.\n\nReturns the most recent value for specified streams without needing to specify\na time range. Useful for checking current sensor readings.\n\nUse --all-streams with a single device to automatically discover and query all\nstreams — both from the device configuration and from actual ingested data\n(unconfigured streams included).",
|
|
3363
|
+
"examples": [
|
|
3364
|
+
"<%= config.bin %> query latest-values --device <id> --stream battery_level",
|
|
3365
|
+
"<%= config.bin %> query latest-values --device <id> --stream temperature --stream humidity",
|
|
3366
|
+
"<%= config.bin %> query latest-values --device <id> --all-streams",
|
|
3367
|
+
"<%= config.bin %> query latest-values --device <id> --all-streams --json"
|
|
3368
|
+
],
|
|
3369
|
+
"flags": {
|
|
3370
|
+
"json": {
|
|
3371
|
+
"description": "Format output as json.",
|
|
3372
|
+
"helpGroup": "GLOBAL",
|
|
3373
|
+
"name": "json",
|
|
3374
|
+
"allowNo": false,
|
|
3375
|
+
"type": "boolean"
|
|
3376
|
+
},
|
|
3377
|
+
"dev": {
|
|
3378
|
+
"description": "Target the dev environment",
|
|
3379
|
+
"exclusive": [
|
|
3380
|
+
"stage"
|
|
3381
|
+
],
|
|
3382
|
+
"helpGroup": "GLOBAL",
|
|
3383
|
+
"name": "dev",
|
|
3384
|
+
"allowNo": false,
|
|
3385
|
+
"type": "boolean"
|
|
3386
|
+
},
|
|
3387
|
+
"stage": {
|
|
3388
|
+
"description": "Target the stage environment",
|
|
3389
|
+
"exclusive": [
|
|
3390
|
+
"dev"
|
|
3391
|
+
],
|
|
3392
|
+
"helpGroup": "GLOBAL",
|
|
3393
|
+
"name": "stage",
|
|
3394
|
+
"allowNo": false,
|
|
3395
|
+
"type": "boolean"
|
|
3396
|
+
},
|
|
3397
|
+
"all-streams": {
|
|
3398
|
+
"description": "Query all streams for the device — from config and from ingested data (requires single --device)",
|
|
3399
|
+
"name": "all-streams",
|
|
3400
|
+
"allowNo": false,
|
|
3401
|
+
"type": "boolean"
|
|
3402
|
+
},
|
|
3403
|
+
"days": {
|
|
3404
|
+
"description": "How many days back to look for unconfigured streams when using --all-streams",
|
|
3405
|
+
"name": "days",
|
|
3406
|
+
"default": 14,
|
|
3407
|
+
"hasDynamicHelp": false,
|
|
3408
|
+
"multiple": false,
|
|
3409
|
+
"type": "option"
|
|
3410
|
+
},
|
|
3411
|
+
"device": {
|
|
3412
|
+
"char": "d",
|
|
3413
|
+
"description": "Device ID (UUID)",
|
|
3414
|
+
"name": "device",
|
|
3415
|
+
"required": true,
|
|
3416
|
+
"hasDynamicHelp": false,
|
|
3417
|
+
"multiple": true,
|
|
3418
|
+
"type": "option"
|
|
3419
|
+
},
|
|
3420
|
+
"stream": {
|
|
3421
|
+
"char": "s",
|
|
3422
|
+
"description": "Stream name(s), can be specified multiple times",
|
|
3423
|
+
"name": "stream",
|
|
3424
|
+
"hasDynamicHelp": false,
|
|
3425
|
+
"multiple": true,
|
|
3426
|
+
"type": "option"
|
|
3427
|
+
}
|
|
3428
|
+
},
|
|
3429
|
+
"hasDynamicHelp": false,
|
|
3430
|
+
"hiddenAliases": [],
|
|
3431
|
+
"id": "query:latest-values",
|
|
3432
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3433
|
+
"pluginName": "@formant/formant-cli",
|
|
3434
|
+
"pluginType": "core",
|
|
3435
|
+
"strict": true,
|
|
3436
|
+
"summary": "Get latest stream values",
|
|
3437
|
+
"enableJsonFlag": true,
|
|
3438
|
+
"isESM": true,
|
|
3439
|
+
"relativePath": [
|
|
3440
|
+
"dist",
|
|
3441
|
+
"commands",
|
|
3442
|
+
"query",
|
|
3443
|
+
"latest-values.js"
|
|
3444
|
+
]
|
|
3445
|
+
},
|
|
3446
|
+
"schedule:get": {
|
|
3447
|
+
"aliases": [],
|
|
3448
|
+
"args": {
|
|
3449
|
+
"id": {
|
|
3450
|
+
"description": "Schedule ID (UUID)",
|
|
3451
|
+
"name": "id",
|
|
3452
|
+
"required": true
|
|
3453
|
+
}
|
|
3454
|
+
},
|
|
3455
|
+
"description": "Get detailed information about a schedule.\n\nShows the full schedule configuration including cron expression, command template,\ninvestigation link, and execution settings.",
|
|
3456
|
+
"examples": [
|
|
3457
|
+
"<%= config.bin %> schedule get <schedule-id>",
|
|
3458
|
+
"<%= config.bin %> schedule get <schedule-id> --json"
|
|
3459
|
+
],
|
|
3460
|
+
"flags": {
|
|
3461
|
+
"json": {
|
|
3462
|
+
"description": "Format output as json.",
|
|
3463
|
+
"helpGroup": "GLOBAL",
|
|
3464
|
+
"name": "json",
|
|
3465
|
+
"allowNo": false,
|
|
3466
|
+
"type": "boolean"
|
|
3467
|
+
},
|
|
3468
|
+
"dev": {
|
|
3469
|
+
"description": "Target the dev environment",
|
|
3470
|
+
"exclusive": [
|
|
3471
|
+
"stage"
|
|
3472
|
+
],
|
|
3473
|
+
"helpGroup": "GLOBAL",
|
|
3474
|
+
"name": "dev",
|
|
3475
|
+
"allowNo": false,
|
|
3476
|
+
"type": "boolean"
|
|
3477
|
+
},
|
|
3478
|
+
"stage": {
|
|
3479
|
+
"description": "Target the stage environment",
|
|
3480
|
+
"exclusive": [
|
|
3481
|
+
"dev"
|
|
3482
|
+
],
|
|
3483
|
+
"helpGroup": "GLOBAL",
|
|
3484
|
+
"name": "stage",
|
|
3485
|
+
"allowNo": false,
|
|
3486
|
+
"type": "boolean"
|
|
3487
|
+
}
|
|
3488
|
+
},
|
|
3489
|
+
"hasDynamicHelp": false,
|
|
3490
|
+
"hiddenAliases": [],
|
|
3491
|
+
"id": "schedule:get",
|
|
3492
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3493
|
+
"pluginName": "@formant/formant-cli",
|
|
3494
|
+
"pluginType": "core",
|
|
3495
|
+
"strict": true,
|
|
3496
|
+
"summary": "Get schedule details",
|
|
3497
|
+
"enableJsonFlag": true,
|
|
3498
|
+
"isESM": true,
|
|
3499
|
+
"relativePath": [
|
|
3500
|
+
"dist",
|
|
3501
|
+
"commands",
|
|
3502
|
+
"schedule",
|
|
3503
|
+
"get.js"
|
|
3504
|
+
]
|
|
3505
|
+
},
|
|
3506
|
+
"schedule:list": {
|
|
3507
|
+
"aliases": [],
|
|
3508
|
+
"args": {},
|
|
3509
|
+
"description": "List all schedules in your organization.\n\nSchedules can trigger commands or investigations on a recurring (cron) or one-time basis.",
|
|
3510
|
+
"examples": [
|
|
3511
|
+
"<%= config.bin %> schedule list",
|
|
3512
|
+
"<%= config.bin %> schedule list --json"
|
|
3513
|
+
],
|
|
3514
|
+
"flags": {
|
|
3515
|
+
"json": {
|
|
3516
|
+
"description": "Format output as json.",
|
|
3517
|
+
"helpGroup": "GLOBAL",
|
|
3518
|
+
"name": "json",
|
|
3519
|
+
"allowNo": false,
|
|
3520
|
+
"type": "boolean"
|
|
3521
|
+
},
|
|
3522
|
+
"dev": {
|
|
3523
|
+
"description": "Target the dev environment",
|
|
3524
|
+
"exclusive": [
|
|
3525
|
+
"stage"
|
|
3526
|
+
],
|
|
3527
|
+
"helpGroup": "GLOBAL",
|
|
3528
|
+
"name": "dev",
|
|
3529
|
+
"allowNo": false,
|
|
3530
|
+
"type": "boolean"
|
|
3531
|
+
},
|
|
3532
|
+
"stage": {
|
|
3533
|
+
"description": "Target the stage environment",
|
|
3534
|
+
"exclusive": [
|
|
3535
|
+
"dev"
|
|
3536
|
+
],
|
|
3537
|
+
"helpGroup": "GLOBAL",
|
|
3538
|
+
"name": "stage",
|
|
3539
|
+
"allowNo": false,
|
|
3540
|
+
"type": "boolean"
|
|
3541
|
+
}
|
|
3542
|
+
},
|
|
3543
|
+
"hasDynamicHelp": false,
|
|
3544
|
+
"hiddenAliases": [],
|
|
3545
|
+
"id": "schedule:list",
|
|
3546
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3547
|
+
"pluginName": "@formant/formant-cli",
|
|
3548
|
+
"pluginType": "core",
|
|
3549
|
+
"strict": true,
|
|
3550
|
+
"summary": "List schedules",
|
|
3551
|
+
"enableJsonFlag": true,
|
|
3552
|
+
"isESM": true,
|
|
3553
|
+
"relativePath": [
|
|
3554
|
+
"dist",
|
|
3555
|
+
"commands",
|
|
3556
|
+
"schedule",
|
|
3557
|
+
"list.js"
|
|
3558
|
+
]
|
|
3559
|
+
},
|
|
3560
|
+
"persona:delegate-task": {
|
|
3561
|
+
"aliases": [],
|
|
3562
|
+
"args": {
|
|
3563
|
+
"id": {
|
|
3564
|
+
"description": "Persona ID (UUID)",
|
|
3565
|
+
"name": "id",
|
|
3566
|
+
"required": true
|
|
3567
|
+
},
|
|
3568
|
+
"goal": {
|
|
3569
|
+
"description": "The task goal / instruction for the persona",
|
|
3570
|
+
"name": "goal",
|
|
3571
|
+
"required": true
|
|
3572
|
+
}
|
|
3573
|
+
},
|
|
3574
|
+
"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\".",
|
|
3575
|
+
"examples": [
|
|
3576
|
+
"<%= config.bin %> persona delegate-task <persona-id> \"Analyze recent device failures and summarize findings\"",
|
|
3577
|
+
"<%= config.bin %> persona delegate-task <persona-id> \"Generate a daily report of fleet health\" --name \"Daily Fleet Report\"",
|
|
3578
|
+
"<%= config.bin %> persona delegate-task <persona-id> \"Check all offline devices\" --dev"
|
|
3579
|
+
],
|
|
3580
|
+
"flags": {
|
|
3581
|
+
"json": {
|
|
3582
|
+
"description": "Format output as json.",
|
|
3583
|
+
"helpGroup": "GLOBAL",
|
|
3584
|
+
"name": "json",
|
|
3585
|
+
"allowNo": false,
|
|
3586
|
+
"type": "boolean"
|
|
3587
|
+
},
|
|
3588
|
+
"dev": {
|
|
3589
|
+
"description": "Target the dev environment",
|
|
3590
|
+
"exclusive": [
|
|
3591
|
+
"stage"
|
|
3592
|
+
],
|
|
3593
|
+
"helpGroup": "GLOBAL",
|
|
3594
|
+
"name": "dev",
|
|
3595
|
+
"allowNo": false,
|
|
3596
|
+
"type": "boolean"
|
|
3597
|
+
},
|
|
3598
|
+
"stage": {
|
|
3599
|
+
"description": "Target the stage environment",
|
|
3600
|
+
"exclusive": [
|
|
3601
|
+
"dev"
|
|
3602
|
+
],
|
|
3603
|
+
"helpGroup": "GLOBAL",
|
|
3604
|
+
"name": "stage",
|
|
3605
|
+
"allowNo": false,
|
|
3606
|
+
"type": "boolean"
|
|
3607
|
+
},
|
|
3608
|
+
"name": {
|
|
3609
|
+
"char": "n",
|
|
3610
|
+
"description": "Task name (defaults to first 50 chars of goal)",
|
|
3611
|
+
"name": "name",
|
|
3612
|
+
"hasDynamicHelp": false,
|
|
3613
|
+
"multiple": false,
|
|
3614
|
+
"type": "option"
|
|
3615
|
+
}
|
|
3616
|
+
},
|
|
3617
|
+
"hasDynamicHelp": false,
|
|
3618
|
+
"hiddenAliases": [],
|
|
3619
|
+
"id": "persona:delegate-task",
|
|
3620
|
+
"pluginAlias": "@formant/formant-cli",
|
|
3621
|
+
"pluginName": "@formant/formant-cli",
|
|
3622
|
+
"pluginType": "core",
|
|
3623
|
+
"strict": true,
|
|
3624
|
+
"summary": "Delegate an async task to a persona",
|
|
3625
|
+
"enableJsonFlag": true,
|
|
3626
|
+
"isESM": true,
|
|
3627
|
+
"relativePath": [
|
|
3628
|
+
"dist",
|
|
3629
|
+
"commands",
|
|
3630
|
+
"persona",
|
|
3631
|
+
"delegate-task.js"
|
|
3632
|
+
]
|
|
3633
|
+
},
|
|
3634
|
+
"persona:get": {
|
|
3635
|
+
"aliases": [],
|
|
3636
|
+
"args": {
|
|
3637
|
+
"id": {
|
|
3638
|
+
"description": "Persona ID (UUID)",
|
|
3639
|
+
"name": "id",
|
|
3640
|
+
"required": true
|
|
3641
|
+
}
|
|
3642
|
+
},
|
|
3643
|
+
"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.",
|
|
3188
3644
|
"examples": [
|
|
3189
|
-
"<%= config.bin %>
|
|
3190
|
-
"<%= config.bin %>
|
|
3191
|
-
"<%= config.bin %>
|
|
3645
|
+
"<%= config.bin %> personas get <persona-id>",
|
|
3646
|
+
"<%= config.bin %> personas get <persona-id> --json",
|
|
3647
|
+
"<%= config.bin %> personas get <persona-id> --dev"
|
|
3192
3648
|
],
|
|
3193
3649
|
"flags": {
|
|
3194
3650
|
"json": {
|
|
@@ -3217,66 +3673,33 @@
|
|
|
3217
3673
|
"name": "stage",
|
|
3218
3674
|
"allowNo": false,
|
|
3219
3675
|
"type": "boolean"
|
|
3220
|
-
},
|
|
3221
|
-
"end": {
|
|
3222
|
-
"description": "End time (ISO 8601)",
|
|
3223
|
-
"name": "end",
|
|
3224
|
-
"hasDynamicHelp": false,
|
|
3225
|
-
"multiple": false,
|
|
3226
|
-
"type": "option"
|
|
3227
|
-
},
|
|
3228
|
-
"start": {
|
|
3229
|
-
"description": "Start time (ISO 8601)",
|
|
3230
|
-
"name": "start",
|
|
3231
|
-
"required": true,
|
|
3232
|
-
"hasDynamicHelp": false,
|
|
3233
|
-
"multiple": false,
|
|
3234
|
-
"type": "option"
|
|
3235
|
-
},
|
|
3236
|
-
"type": {
|
|
3237
|
-
"description": "Filter by signal type",
|
|
3238
|
-
"name": "type",
|
|
3239
|
-
"hasDynamicHelp": false,
|
|
3240
|
-
"multiple": false,
|
|
3241
|
-
"options": [
|
|
3242
|
-
"manual",
|
|
3243
|
-
"eventTrigger",
|
|
3244
|
-
"schedule",
|
|
3245
|
-
"slack"
|
|
3246
|
-
],
|
|
3247
|
-
"type": "option"
|
|
3248
3676
|
}
|
|
3249
3677
|
},
|
|
3250
3678
|
"hasDynamicHelp": false,
|
|
3251
3679
|
"hiddenAliases": [],
|
|
3252
|
-
"id": "
|
|
3680
|
+
"id": "persona:get",
|
|
3253
3681
|
"pluginAlias": "@formant/formant-cli",
|
|
3254
3682
|
"pluginName": "@formant/formant-cli",
|
|
3255
3683
|
"pluginType": "core",
|
|
3256
3684
|
"strict": true,
|
|
3257
|
-
"summary": "
|
|
3685
|
+
"summary": "Get persona details and tools",
|
|
3258
3686
|
"enableJsonFlag": true,
|
|
3259
3687
|
"isESM": true,
|
|
3260
3688
|
"relativePath": [
|
|
3261
3689
|
"dist",
|
|
3262
3690
|
"commands",
|
|
3263
|
-
"
|
|
3264
|
-
"
|
|
3691
|
+
"persona",
|
|
3692
|
+
"get.js"
|
|
3265
3693
|
]
|
|
3266
3694
|
},
|
|
3267
|
-
"
|
|
3695
|
+
"persona:list": {
|
|
3268
3696
|
"aliases": [],
|
|
3269
|
-
"args": {
|
|
3270
|
-
|
|
3271
|
-
"description": "Device ID (UUID)",
|
|
3272
|
-
"name": "id",
|
|
3273
|
-
"required": true
|
|
3274
|
-
}
|
|
3275
|
-
},
|
|
3276
|
-
"description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
|
|
3697
|
+
"args": {},
|
|
3698
|
+
"description": "List AI personas available in your organization.\n\nShows both built-in and custom personas with their ID, name, and description.",
|
|
3277
3699
|
"examples": [
|
|
3278
|
-
"<%= config.bin %>
|
|
3279
|
-
"<%= config.bin %>
|
|
3700
|
+
"<%= config.bin %> personas list",
|
|
3701
|
+
"<%= config.bin %> personas list --json",
|
|
3702
|
+
"<%= config.bin %> personas list --dev"
|
|
3280
3703
|
],
|
|
3281
3704
|
"flags": {
|
|
3282
3705
|
"json": {
|
|
@@ -3309,35 +3732,35 @@
|
|
|
3309
3732
|
},
|
|
3310
3733
|
"hasDynamicHelp": false,
|
|
3311
3734
|
"hiddenAliases": [],
|
|
3312
|
-
"id": "
|
|
3735
|
+
"id": "persona:list",
|
|
3313
3736
|
"pluginAlias": "@formant/formant-cli",
|
|
3314
3737
|
"pluginName": "@formant/formant-cli",
|
|
3315
3738
|
"pluginType": "core",
|
|
3316
3739
|
"strict": true,
|
|
3317
|
-
"summary": "
|
|
3740
|
+
"summary": "List AI personas",
|
|
3318
3741
|
"enableJsonFlag": true,
|
|
3319
3742
|
"isESM": true,
|
|
3320
3743
|
"relativePath": [
|
|
3321
3744
|
"dist",
|
|
3322
3745
|
"commands",
|
|
3323
|
-
"
|
|
3324
|
-
"
|
|
3746
|
+
"persona",
|
|
3747
|
+
"list.js"
|
|
3325
3748
|
]
|
|
3326
3749
|
},
|
|
3327
|
-
"
|
|
3750
|
+
"persona:task-status": {
|
|
3328
3751
|
"aliases": [],
|
|
3329
3752
|
"args": {
|
|
3330
|
-
"
|
|
3331
|
-
"description": "
|
|
3332
|
-
"name": "
|
|
3753
|
+
"taskId": {
|
|
3754
|
+
"description": "Task ID (from delegate-task output)",
|
|
3755
|
+
"name": "taskId",
|
|
3333
3756
|
"required": true
|
|
3334
3757
|
}
|
|
3335
3758
|
},
|
|
3336
|
-
"description": "
|
|
3759
|
+
"description": "Check the status and results of a delegated task.\n\nShows all runs for a task including their status, result summary, and timestamps.",
|
|
3337
3760
|
"examples": [
|
|
3338
|
-
"<%= config.bin %>
|
|
3339
|
-
"<%= config.bin %>
|
|
3340
|
-
"<%= config.bin %>
|
|
3761
|
+
"<%= config.bin %> persona task-status <task-id>",
|
|
3762
|
+
"<%= config.bin %> persona task-status <task-id> --json",
|
|
3763
|
+
"<%= config.bin %> persona task-status <task-id> --dev"
|
|
3341
3764
|
],
|
|
3342
3765
|
"flags": {
|
|
3343
3766
|
"json": {
|
|
@@ -3366,46 +3789,38 @@
|
|
|
3366
3789
|
"name": "stage",
|
|
3367
3790
|
"allowNo": false,
|
|
3368
3791
|
"type": "boolean"
|
|
3369
|
-
},
|
|
3370
|
-
"tag": {
|
|
3371
|
-
"char": "t",
|
|
3372
|
-
"description": "Tag to apply (key=value), can be specified multiple times",
|
|
3373
|
-
"name": "tag",
|
|
3374
|
-
"hasDynamicHelp": false,
|
|
3375
|
-
"multiple": true,
|
|
3376
|
-
"type": "option"
|
|
3377
3792
|
}
|
|
3378
3793
|
},
|
|
3379
3794
|
"hasDynamicHelp": false,
|
|
3380
3795
|
"hiddenAliases": [],
|
|
3381
|
-
"id": "
|
|
3796
|
+
"id": "persona:task-status",
|
|
3382
3797
|
"pluginAlias": "@formant/formant-cli",
|
|
3383
3798
|
"pluginName": "@formant/formant-cli",
|
|
3384
3799
|
"pluginType": "core",
|
|
3385
3800
|
"strict": true,
|
|
3386
|
-
"summary": "
|
|
3801
|
+
"summary": "Check status of a delegated task",
|
|
3387
3802
|
"enableJsonFlag": true,
|
|
3388
3803
|
"isESM": true,
|
|
3389
3804
|
"relativePath": [
|
|
3390
3805
|
"dist",
|
|
3391
3806
|
"commands",
|
|
3392
|
-
"
|
|
3393
|
-
"
|
|
3807
|
+
"persona",
|
|
3808
|
+
"task-status.js"
|
|
3394
3809
|
]
|
|
3395
3810
|
},
|
|
3396
|
-
"
|
|
3811
|
+
"user:get": {
|
|
3397
3812
|
"aliases": [],
|
|
3398
3813
|
"args": {
|
|
3399
3814
|
"id": {
|
|
3400
|
-
"description": "
|
|
3815
|
+
"description": "User ID (UUID)",
|
|
3401
3816
|
"name": "id",
|
|
3402
3817
|
"required": true
|
|
3403
3818
|
}
|
|
3404
3819
|
},
|
|
3405
|
-
"description": "
|
|
3820
|
+
"description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.",
|
|
3406
3821
|
"examples": [
|
|
3407
|
-
"<%= config.bin %>
|
|
3408
|
-
"<%= config.bin %>
|
|
3822
|
+
"<%= config.bin %> user get <user-id>",
|
|
3823
|
+
"<%= config.bin %> user get <user-id> --json"
|
|
3409
3824
|
],
|
|
3410
3825
|
"flags": {
|
|
3411
3826
|
"json": {
|
|
@@ -3438,34 +3853,28 @@
|
|
|
3438
3853
|
},
|
|
3439
3854
|
"hasDynamicHelp": false,
|
|
3440
3855
|
"hiddenAliases": [],
|
|
3441
|
-
"id": "
|
|
3856
|
+
"id": "user:get",
|
|
3442
3857
|
"pluginAlias": "@formant/formant-cli",
|
|
3443
3858
|
"pluginName": "@formant/formant-cli",
|
|
3444
3859
|
"pluginType": "core",
|
|
3445
3860
|
"strict": true,
|
|
3446
|
-
"summary": "
|
|
3861
|
+
"summary": "Get user details",
|
|
3447
3862
|
"enableJsonFlag": true,
|
|
3448
3863
|
"isESM": true,
|
|
3449
3864
|
"relativePath": [
|
|
3450
3865
|
"dist",
|
|
3451
3866
|
"commands",
|
|
3452
|
-
"
|
|
3453
|
-
"
|
|
3867
|
+
"user",
|
|
3868
|
+
"get.js"
|
|
3454
3869
|
]
|
|
3455
3870
|
},
|
|
3456
|
-
"
|
|
3871
|
+
"user:list": {
|
|
3457
3872
|
"aliases": [],
|
|
3458
|
-
"args": {
|
|
3459
|
-
|
|
3460
|
-
"description": "Device ID (UUID)",
|
|
3461
|
-
"name": "id",
|
|
3462
|
-
"required": true
|
|
3463
|
-
}
|
|
3464
|
-
},
|
|
3465
|
-
"description": "Get detailed information about a specific device by its ID.",
|
|
3873
|
+
"args": {},
|
|
3874
|
+
"description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.",
|
|
3466
3875
|
"examples": [
|
|
3467
|
-
"<%= config.bin %>
|
|
3468
|
-
"<%= config.bin %>
|
|
3876
|
+
"<%= config.bin %> user list",
|
|
3877
|
+
"<%= config.bin %> user list --json"
|
|
3469
3878
|
],
|
|
3470
3879
|
"flags": {
|
|
3471
3880
|
"json": {
|
|
@@ -3498,34 +3907,29 @@
|
|
|
3498
3907
|
},
|
|
3499
3908
|
"hasDynamicHelp": false,
|
|
3500
3909
|
"hiddenAliases": [],
|
|
3501
|
-
"id": "
|
|
3910
|
+
"id": "user:list",
|
|
3502
3911
|
"pluginAlias": "@formant/formant-cli",
|
|
3503
3912
|
"pluginName": "@formant/formant-cli",
|
|
3504
3913
|
"pluginType": "core",
|
|
3505
3914
|
"strict": true,
|
|
3506
|
-
"summary": "
|
|
3915
|
+
"summary": "List users",
|
|
3507
3916
|
"enableJsonFlag": true,
|
|
3508
3917
|
"isESM": true,
|
|
3509
3918
|
"relativePath": [
|
|
3510
3919
|
"dist",
|
|
3511
3920
|
"commands",
|
|
3512
|
-
"
|
|
3513
|
-
"
|
|
3921
|
+
"user",
|
|
3922
|
+
"list.js"
|
|
3514
3923
|
]
|
|
3515
3924
|
},
|
|
3516
|
-
"
|
|
3925
|
+
"signal:count": {
|
|
3517
3926
|
"aliases": [],
|
|
3518
|
-
"args": {
|
|
3519
|
-
|
|
3520
|
-
"description": "Device ID (UUID)",
|
|
3521
|
-
"name": "id",
|
|
3522
|
-
"required": true
|
|
3523
|
-
}
|
|
3524
|
-
},
|
|
3525
|
-
"description": "Get when a device was last seen online.\n\nShows the most recent timestamp when the device was detected as online.",
|
|
3927
|
+
"args": {},
|
|
3928
|
+
"description": "Get counts of signals grouped by type.\n\nReturns total counts and per-type breakdowns (manual, eventTrigger, schedule, slack).",
|
|
3526
3929
|
"examples": [
|
|
3527
|
-
"<%= config.bin %>
|
|
3528
|
-
"<%= config.bin %>
|
|
3930
|
+
"<%= config.bin %> signal count",
|
|
3931
|
+
"<%= config.bin %> signal count --start 2026-01-01 --end 2026-02-01",
|
|
3932
|
+
"<%= config.bin %> signal count --json"
|
|
3529
3933
|
],
|
|
3530
3934
|
"flags": {
|
|
3531
3935
|
"json": {
|
|
@@ -3554,35 +3958,55 @@
|
|
|
3554
3958
|
"name": "stage",
|
|
3555
3959
|
"allowNo": false,
|
|
3556
3960
|
"type": "boolean"
|
|
3961
|
+
},
|
|
3962
|
+
"end": {
|
|
3963
|
+
"description": "End time (ISO 8601)",
|
|
3964
|
+
"name": "end",
|
|
3965
|
+
"hasDynamicHelp": false,
|
|
3966
|
+
"multiple": false,
|
|
3967
|
+
"type": "option"
|
|
3968
|
+
},
|
|
3969
|
+
"start": {
|
|
3970
|
+
"description": "Start time (ISO 8601)",
|
|
3971
|
+
"name": "start",
|
|
3972
|
+
"hasDynamicHelp": false,
|
|
3973
|
+
"multiple": false,
|
|
3974
|
+
"type": "option"
|
|
3557
3975
|
}
|
|
3558
3976
|
},
|
|
3559
3977
|
"hasDynamicHelp": false,
|
|
3560
3978
|
"hiddenAliases": [],
|
|
3561
|
-
"id": "
|
|
3979
|
+
"id": "signal:count",
|
|
3562
3980
|
"pluginAlias": "@formant/formant-cli",
|
|
3563
3981
|
"pluginName": "@formant/formant-cli",
|
|
3564
3982
|
"pluginType": "core",
|
|
3565
3983
|
"strict": true,
|
|
3566
|
-
"summary": "Get
|
|
3984
|
+
"summary": "Get signal counts by type",
|
|
3567
3985
|
"enableJsonFlag": true,
|
|
3568
3986
|
"isESM": true,
|
|
3569
3987
|
"relativePath": [
|
|
3570
3988
|
"dist",
|
|
3571
3989
|
"commands",
|
|
3572
|
-
"
|
|
3573
|
-
"
|
|
3990
|
+
"signal",
|
|
3991
|
+
"count.js"
|
|
3574
3992
|
]
|
|
3575
3993
|
},
|
|
3576
|
-
"
|
|
3994
|
+
"signal:create": {
|
|
3577
3995
|
"aliases": [],
|
|
3578
|
-
"args": {
|
|
3579
|
-
|
|
3996
|
+
"args": {
|
|
3997
|
+
"goal": {
|
|
3998
|
+
"description": "Goal or description for the signal",
|
|
3999
|
+
"name": "goal",
|
|
4000
|
+
"required": true
|
|
4001
|
+
}
|
|
4002
|
+
},
|
|
4003
|
+
"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.",
|
|
3580
4004
|
"examples": [
|
|
3581
|
-
"<%= config.bin %>
|
|
3582
|
-
"<%= config.bin %>
|
|
3583
|
-
"<%= config.bin %>
|
|
3584
|
-
"<%= config.bin %>
|
|
3585
|
-
"<%= config.bin %>
|
|
4005
|
+
"<%= config.bin %> signal create \"Robot arm jammed at joint 3\"",
|
|
4006
|
+
"<%= config.bin %> signal create \"Battery draining fast\" --device <device-id>",
|
|
4007
|
+
"<%= config.bin %> signal create \"Investigate sensor anomaly\" --persona <persona-id>",
|
|
4008
|
+
"<%= config.bin %> signal create \"Test alarm scenario\" --investigation <taskflow-id>",
|
|
4009
|
+
"<%= config.bin %> signal create \"Motor overheated\" --investigation <id> --ground-truth \"Should identify motor thermal fault\""
|
|
3586
4010
|
],
|
|
3587
4011
|
"flags": {
|
|
3588
4012
|
"json": {
|
|
@@ -3612,74 +4036,73 @@
|
|
|
3612
4036
|
"allowNo": false,
|
|
3613
4037
|
"type": "boolean"
|
|
3614
4038
|
},
|
|
3615
|
-
"
|
|
3616
|
-
"char": "
|
|
3617
|
-
"description": "
|
|
3618
|
-
"name": "
|
|
3619
|
-
"
|
|
3620
|
-
"
|
|
4039
|
+
"device": {
|
|
4040
|
+
"char": "d",
|
|
4041
|
+
"description": "Device ID to associate with this signal",
|
|
4042
|
+
"name": "device",
|
|
4043
|
+
"hasDynamicHelp": false,
|
|
4044
|
+
"multiple": false,
|
|
4045
|
+
"type": "option"
|
|
3621
4046
|
},
|
|
3622
|
-
"
|
|
3623
|
-
"char": "
|
|
3624
|
-
"
|
|
3625
|
-
|
|
3626
|
-
|
|
4047
|
+
"ground-truth": {
|
|
4048
|
+
"char": "g",
|
|
4049
|
+
"dependsOn": [
|
|
4050
|
+
"investigation"
|
|
4051
|
+
],
|
|
4052
|
+
"description": "Expected outcome (ground truth) for this signal — requires --investigation",
|
|
4053
|
+
"name": "ground-truth",
|
|
3627
4054
|
"hasDynamicHelp": false,
|
|
3628
4055
|
"multiple": false,
|
|
3629
4056
|
"type": "option"
|
|
3630
4057
|
},
|
|
3631
|
-
"
|
|
3632
|
-
"char": "
|
|
3633
|
-
"description": "
|
|
3634
|
-
"name": "
|
|
4058
|
+
"investigation": {
|
|
4059
|
+
"char": "i",
|
|
4060
|
+
"description": "Investigation (taskflow) ID this signal targets",
|
|
4061
|
+
"name": "investigation",
|
|
3635
4062
|
"hasDynamicHelp": false,
|
|
3636
4063
|
"multiple": false,
|
|
3637
4064
|
"type": "option"
|
|
3638
4065
|
},
|
|
3639
|
-
"
|
|
3640
|
-
"char": "
|
|
3641
|
-
"description": "
|
|
3642
|
-
"name": "
|
|
4066
|
+
"persona": {
|
|
4067
|
+
"char": "p",
|
|
4068
|
+
"description": "Persona ID to handle this signal",
|
|
4069
|
+
"name": "persona",
|
|
3643
4070
|
"hasDynamicHelp": false,
|
|
3644
|
-
"multiple":
|
|
4071
|
+
"multiple": false,
|
|
3645
4072
|
"type": "option"
|
|
3646
4073
|
}
|
|
3647
4074
|
},
|
|
3648
4075
|
"hasDynamicHelp": false,
|
|
3649
4076
|
"hiddenAliases": [],
|
|
3650
|
-
"id": "
|
|
4077
|
+
"id": "signal:create",
|
|
3651
4078
|
"pluginAlias": "@formant/formant-cli",
|
|
3652
4079
|
"pluginName": "@formant/formant-cli",
|
|
3653
4080
|
"pluginType": "core",
|
|
3654
4081
|
"strict": true,
|
|
3655
|
-
"summary": "
|
|
4082
|
+
"summary": "Create a manual signal",
|
|
3656
4083
|
"enableJsonFlag": true,
|
|
3657
4084
|
"isESM": true,
|
|
3658
4085
|
"relativePath": [
|
|
3659
4086
|
"dist",
|
|
3660
4087
|
"commands",
|
|
3661
|
-
"
|
|
3662
|
-
"
|
|
4088
|
+
"signal",
|
|
4089
|
+
"create.js"
|
|
3663
4090
|
]
|
|
3664
4091
|
},
|
|
3665
|
-
"
|
|
4092
|
+
"signal:get": {
|
|
3666
4093
|
"aliases": [],
|
|
3667
4094
|
"args": {
|
|
3668
4095
|
"id": {
|
|
3669
|
-
"description": "
|
|
4096
|
+
"description": "Signal ID (UUID)",
|
|
3670
4097
|
"name": "id",
|
|
3671
4098
|
"required": true
|
|
3672
|
-
},
|
|
3673
|
-
"name": {
|
|
3674
|
-
"description": "New name for the device",
|
|
3675
|
-
"name": "name",
|
|
3676
|
-
"required": true
|
|
3677
4099
|
}
|
|
3678
4100
|
},
|
|
3679
|
-
"description": "
|
|
4101
|
+
"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.",
|
|
3680
4102
|
"examples": [
|
|
3681
|
-
"<%= config.bin %>
|
|
3682
|
-
"<%= config.bin %>
|
|
4103
|
+
"<%= config.bin %> signal get <signal-id>",
|
|
4104
|
+
"<%= config.bin %> signal get <signal-id> --trace",
|
|
4105
|
+
"<%= config.bin %> signal get <signal-id> --json"
|
|
3683
4106
|
],
|
|
3684
4107
|
"flags": {
|
|
3685
4108
|
"json": {
|
|
@@ -3708,38 +4131,39 @@
|
|
|
3708
4131
|
"name": "stage",
|
|
3709
4132
|
"allowNo": false,
|
|
3710
4133
|
"type": "boolean"
|
|
4134
|
+
},
|
|
4135
|
+
"trace": {
|
|
4136
|
+
"description": "Fetch and display the triggering event and event trigger information",
|
|
4137
|
+
"name": "trace",
|
|
4138
|
+
"allowNo": false,
|
|
4139
|
+
"type": "boolean"
|
|
3711
4140
|
}
|
|
3712
4141
|
},
|
|
3713
4142
|
"hasDynamicHelp": false,
|
|
3714
4143
|
"hiddenAliases": [],
|
|
3715
|
-
"id": "
|
|
4144
|
+
"id": "signal:get",
|
|
3716
4145
|
"pluginAlias": "@formant/formant-cli",
|
|
3717
4146
|
"pluginName": "@formant/formant-cli",
|
|
3718
4147
|
"pluginType": "core",
|
|
3719
4148
|
"strict": true,
|
|
3720
|
-
"summary": "
|
|
4149
|
+
"summary": "Get a signal by ID",
|
|
3721
4150
|
"enableJsonFlag": true,
|
|
3722
4151
|
"isESM": true,
|
|
3723
4152
|
"relativePath": [
|
|
3724
4153
|
"dist",
|
|
3725
4154
|
"commands",
|
|
3726
|
-
"
|
|
3727
|
-
"
|
|
4155
|
+
"signal",
|
|
4156
|
+
"get.js"
|
|
3728
4157
|
]
|
|
3729
4158
|
},
|
|
3730
|
-
"
|
|
4159
|
+
"signal:list": {
|
|
3731
4160
|
"aliases": [],
|
|
3732
|
-
"args": {
|
|
3733
|
-
|
|
3734
|
-
"description": "Device ID (UUID)",
|
|
3735
|
-
"name": "id",
|
|
3736
|
-
"required": true
|
|
3737
|
-
}
|
|
3738
|
-
},
|
|
3739
|
-
"description": "List telemetry streams configured on a device.\n\nShows a clean view of stream definitions parsed from the device configuration,\nincluding stream names, types, topics, and quality settings.",
|
|
4161
|
+
"args": {},
|
|
4162
|
+
"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.",
|
|
3740
4163
|
"examples": [
|
|
3741
|
-
"<%= config.bin %>
|
|
3742
|
-
"<%= config.bin %>
|
|
4164
|
+
"<%= config.bin %> signal list",
|
|
4165
|
+
"<%= config.bin %> signal list --investigation <taskflow-id>",
|
|
4166
|
+
"<%= config.bin %> signal list --json"
|
|
3743
4167
|
],
|
|
3744
4168
|
"flags": {
|
|
3745
4169
|
"json": {
|
|
@@ -3768,39 +4192,42 @@
|
|
|
3768
4192
|
"name": "stage",
|
|
3769
4193
|
"allowNo": false,
|
|
3770
4194
|
"type": "boolean"
|
|
4195
|
+
},
|
|
4196
|
+
"investigation": {
|
|
4197
|
+
"char": "i",
|
|
4198
|
+
"description": "Investigation (taskflow) ID — shows ground truth for signals that have one",
|
|
4199
|
+
"name": "investigation",
|
|
4200
|
+
"hasDynamicHelp": false,
|
|
4201
|
+
"multiple": false,
|
|
4202
|
+
"type": "option"
|
|
3771
4203
|
}
|
|
3772
4204
|
},
|
|
3773
4205
|
"hasDynamicHelp": false,
|
|
3774
4206
|
"hiddenAliases": [],
|
|
3775
|
-
"id": "
|
|
4207
|
+
"id": "signal:list",
|
|
3776
4208
|
"pluginAlias": "@formant/formant-cli",
|
|
3777
4209
|
"pluginName": "@formant/formant-cli",
|
|
3778
4210
|
"pluginType": "core",
|
|
3779
4211
|
"strict": true,
|
|
3780
|
-
"summary": "List
|
|
4212
|
+
"summary": "List all signals",
|
|
3781
4213
|
"enableJsonFlag": true,
|
|
3782
4214
|
"isESM": true,
|
|
3783
4215
|
"relativePath": [
|
|
3784
4216
|
"dist",
|
|
3785
4217
|
"commands",
|
|
3786
|
-
"
|
|
3787
|
-
"
|
|
4218
|
+
"signal",
|
|
4219
|
+
"list.js"
|
|
3788
4220
|
]
|
|
3789
4221
|
},
|
|
3790
|
-
"
|
|
4222
|
+
"signal:query": {
|
|
3791
4223
|
"aliases": [],
|
|
3792
|
-
"args": {
|
|
3793
|
-
|
|
3794
|
-
"description": "Device ID (UUID)",
|
|
3795
|
-
"name": "id",
|
|
3796
|
-
"required": true
|
|
3797
|
-
}
|
|
3798
|
-
},
|
|
3799
|
-
"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.",
|
|
4224
|
+
"args": {},
|
|
4225
|
+
"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.",
|
|
3800
4226
|
"examples": [
|
|
3801
|
-
"<%= config.bin %>
|
|
3802
|
-
"<%= config.bin %>
|
|
3803
|
-
"<%= config.bin %>
|
|
4227
|
+
"<%= config.bin %> signal query --start 2026-01-01",
|
|
4228
|
+
"<%= config.bin %> signal query --start 2026-01-01 --end 2026-02-01 --type eventTrigger",
|
|
4229
|
+
"<%= config.bin %> signal query --start 2026-01-01 --investigation <taskflow-id>",
|
|
4230
|
+
"<%= config.bin %> signal query --start 2026-01-01 --json"
|
|
3804
4231
|
],
|
|
3805
4232
|
"flags": {
|
|
3806
4233
|
"json": {
|
|
@@ -3830,47 +4257,83 @@
|
|
|
3830
4257
|
"allowNo": false,
|
|
3831
4258
|
"type": "boolean"
|
|
3832
4259
|
},
|
|
3833
|
-
"
|
|
3834
|
-
"
|
|
3835
|
-
"
|
|
3836
|
-
"
|
|
4260
|
+
"end": {
|
|
4261
|
+
"description": "End time (ISO 8601)",
|
|
4262
|
+
"name": "end",
|
|
4263
|
+
"hasDynamicHelp": false,
|
|
4264
|
+
"multiple": false,
|
|
4265
|
+
"type": "option"
|
|
4266
|
+
},
|
|
4267
|
+
"investigation": {
|
|
4268
|
+
"char": "i",
|
|
4269
|
+
"description": "Investigation (taskflow) ID — shows ground truth for signals that have one",
|
|
4270
|
+
"name": "investigation",
|
|
4271
|
+
"hasDynamicHelp": false,
|
|
4272
|
+
"multiple": false,
|
|
4273
|
+
"type": "option"
|
|
4274
|
+
},
|
|
4275
|
+
"start": {
|
|
4276
|
+
"description": "Start time (ISO 8601)",
|
|
4277
|
+
"name": "start",
|
|
3837
4278
|
"required": true,
|
|
3838
4279
|
"hasDynamicHelp": false,
|
|
3839
|
-
"multiple":
|
|
4280
|
+
"multiple": false,
|
|
4281
|
+
"type": "option"
|
|
4282
|
+
},
|
|
4283
|
+
"type": {
|
|
4284
|
+
"description": "Filter by signal type",
|
|
4285
|
+
"name": "type",
|
|
4286
|
+
"hasDynamicHelp": false,
|
|
4287
|
+
"multiple": false,
|
|
4288
|
+
"options": [
|
|
4289
|
+
"manual",
|
|
4290
|
+
"eventTrigger",
|
|
4291
|
+
"schedule",
|
|
4292
|
+
"slack"
|
|
4293
|
+
],
|
|
3840
4294
|
"type": "option"
|
|
3841
4295
|
}
|
|
3842
4296
|
},
|
|
3843
4297
|
"hasDynamicHelp": false,
|
|
3844
4298
|
"hiddenAliases": [],
|
|
3845
|
-
"id": "
|
|
4299
|
+
"id": "signal:query",
|
|
3846
4300
|
"pluginAlias": "@formant/formant-cli",
|
|
3847
4301
|
"pluginName": "@formant/formant-cli",
|
|
3848
4302
|
"pluginType": "core",
|
|
3849
4303
|
"strict": true,
|
|
3850
|
-
"summary": "
|
|
4304
|
+
"summary": "Query signals by time range",
|
|
3851
4305
|
"enableJsonFlag": true,
|
|
3852
4306
|
"isESM": true,
|
|
3853
4307
|
"relativePath": [
|
|
3854
4308
|
"dist",
|
|
3855
4309
|
"commands",
|
|
3856
|
-
"
|
|
3857
|
-
"
|
|
4310
|
+
"signal",
|
|
4311
|
+
"query.js"
|
|
3858
4312
|
]
|
|
3859
4313
|
},
|
|
3860
|
-
"
|
|
4314
|
+
"signal:set-ground-truth": {
|
|
3861
4315
|
"aliases": [],
|
|
3862
4316
|
"args": {
|
|
3863
|
-
"
|
|
3864
|
-
"description": "
|
|
3865
|
-
"name": "
|
|
4317
|
+
"signalId": {
|
|
4318
|
+
"description": "Signal ID (UUID)",
|
|
4319
|
+
"name": "signalId",
|
|
4320
|
+
"required": true
|
|
4321
|
+
},
|
|
4322
|
+
"investigationId": {
|
|
4323
|
+
"description": "Investigation (taskflow) ID",
|
|
4324
|
+
"name": "investigationId",
|
|
4325
|
+
"required": true
|
|
4326
|
+
},
|
|
4327
|
+
"expectedOutcome": {
|
|
4328
|
+
"description": "The expected outcome / ground truth for this signal",
|
|
4329
|
+
"name": "expectedOutcome",
|
|
3866
4330
|
"required": true
|
|
3867
4331
|
}
|
|
3868
4332
|
},
|
|
3869
|
-
"description": "
|
|
4333
|
+
"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.",
|
|
3870
4334
|
"examples": [
|
|
3871
|
-
"<%= config.bin %>
|
|
3872
|
-
"<%= config.bin %>
|
|
3873
|
-
"<%= config.bin %> devices untag <device-id> --key location --json"
|
|
4335
|
+
"<%= config.bin %> signal set-ground-truth <signal-id> <investigation-id> \"The alarm should be dismissed as a false positive\"",
|
|
4336
|
+
"<%= config.bin %> signal set-ground-truth <signal-id> <investigation-id> \"Root cause: overheated motor in joint 3\" --json"
|
|
3874
4337
|
],
|
|
3875
4338
|
"flags": {
|
|
3876
4339
|
"json": {
|
|
@@ -3899,34 +4362,25 @@
|
|
|
3899
4362
|
"name": "stage",
|
|
3900
4363
|
"allowNo": false,
|
|
3901
4364
|
"type": "boolean"
|
|
3902
|
-
},
|
|
3903
|
-
"key": {
|
|
3904
|
-
"char": "k",
|
|
3905
|
-
"description": "Tag key to remove, can be specified multiple times",
|
|
3906
|
-
"name": "key",
|
|
3907
|
-
"required": true,
|
|
3908
|
-
"hasDynamicHelp": false,
|
|
3909
|
-
"multiple": true,
|
|
3910
|
-
"type": "option"
|
|
3911
4365
|
}
|
|
3912
4366
|
},
|
|
3913
4367
|
"hasDynamicHelp": false,
|
|
3914
4368
|
"hiddenAliases": [],
|
|
3915
|
-
"id": "
|
|
4369
|
+
"id": "signal:set-ground-truth",
|
|
3916
4370
|
"pluginAlias": "@formant/formant-cli",
|
|
3917
4371
|
"pluginName": "@formant/formant-cli",
|
|
3918
4372
|
"pluginType": "core",
|
|
3919
4373
|
"strict": true,
|
|
3920
|
-
"summary": "
|
|
4374
|
+
"summary": "Assign ground truth to a signal",
|
|
3921
4375
|
"enableJsonFlag": true,
|
|
3922
4376
|
"isESM": true,
|
|
3923
4377
|
"relativePath": [
|
|
3924
4378
|
"dist",
|
|
3925
4379
|
"commands",
|
|
3926
|
-
"
|
|
3927
|
-
"
|
|
4380
|
+
"signal",
|
|
4381
|
+
"set-ground-truth.js"
|
|
3928
4382
|
]
|
|
3929
4383
|
}
|
|
3930
4384
|
},
|
|
3931
|
-
"version": "0.
|
|
4385
|
+
"version": "0.4.2"
|
|
3932
4386
|
}
|