@formant/formant-cli 0.5.0 → 0.5.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.
Files changed (6) hide show
  1. package/README.md +7 -0
  2. package/dist/commands/device/list.d.ts +1 -1
  3. package/dist/commands/device/list.js +32 -6
  4. package/dist/commands/device/list.js.map +1 -1
  5. package/oclif.manifest.json +1337 -1336
  6. package/package.json +1 -1
package/oclif.manifest.json CHANGED
@@ -160,19 +160,19 @@
160
160
  "tables.js"
161
161
  ]
162
162
  },
163
- "command:for-device": {
163
+ "event:get": {
164
164
  "aliases": [],
165
165
  "args": {
166
- "deviceId": {
167
- "description": "Device ID (UUID)",
168
- "name": "deviceId",
166
+ "id": {
167
+ "description": "Event ID (UUID)",
168
+ "name": "id",
169
169
  "required": true
170
170
  }
171
171
  },
172
- "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.",
172
+ "description": "Get detailed information about a specific event by its ID.",
173
173
  "examples": [
174
- "<%= config.bin %> command for-device <device-id>",
175
- "<%= config.bin %> command for-device <device-id> --json"
174
+ "<%= config.bin %> event get <event-id>",
175
+ "<%= config.bin %> event get <event-id> --json"
176
176
  ],
177
177
  "flags": {
178
178
  "json": {
@@ -215,34 +215,30 @@
215
215
  },
216
216
  "hasDynamicHelp": false,
217
217
  "hiddenAliases": [],
218
- "id": "command:for-device",
218
+ "id": "event:get",
219
219
  "pluginAlias": "@formant/formant-cli",
220
220
  "pluginName": "@formant/formant-cli",
221
221
  "pluginType": "core",
222
222
  "strict": true,
223
- "summary": "List commands available for a device",
223
+ "summary": "Get an event by ID",
224
224
  "enableJsonFlag": true,
225
225
  "isESM": true,
226
226
  "relativePath": [
227
227
  "dist",
228
228
  "commands",
229
- "command",
230
- "for-device.js"
229
+ "event",
230
+ "get.js"
231
231
  ]
232
232
  },
233
- "command:get": {
233
+ "event:list": {
234
234
  "aliases": [],
235
- "args": {
236
- "id": {
237
- "description": "Command template ID (UUID)",
238
- "name": "id",
239
- "required": true
240
- }
241
- },
242
- "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.",
235
+ "args": {},
236
+ "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.",
243
237
  "examples": [
244
- "<%= config.bin %> command get <template-id>",
245
- "<%= config.bin %> command get <template-id> --json"
238
+ "<%= config.bin %> event list",
239
+ "<%= config.bin %> event list --device <id> --severity critical",
240
+ "<%= config.bin %> event list --type device-offline --start 2026-01-01 --end 2026-01-02",
241
+ "<%= config.bin %> event list --limit 100 --json"
246
242
  ],
247
243
  "flags": {
248
244
  "json": {
@@ -281,33 +277,89 @@
281
277
  "name": "toon",
282
278
  "allowNo": false,
283
279
  "type": "boolean"
280
+ },
281
+ "device": {
282
+ "char": "d",
283
+ "description": "Filter by device ID",
284
+ "name": "device",
285
+ "hasDynamicHelp": false,
286
+ "multiple": false,
287
+ "type": "option"
288
+ },
289
+ "end": {
290
+ "description": "End time (ISO 8601)",
291
+ "name": "end",
292
+ "hasDynamicHelp": false,
293
+ "multiple": false,
294
+ "type": "option"
295
+ },
296
+ "limit": {
297
+ "char": "l",
298
+ "description": "Maximum number of events to return",
299
+ "name": "limit",
300
+ "default": 25,
301
+ "hasDynamicHelp": false,
302
+ "multiple": false,
303
+ "type": "option"
304
+ },
305
+ "severity": {
306
+ "description": "Filter by severity",
307
+ "name": "severity",
308
+ "hasDynamicHelp": false,
309
+ "multiple": false,
310
+ "options": [
311
+ "info",
312
+ "warning",
313
+ "error",
314
+ "critical"
315
+ ],
316
+ "type": "option"
317
+ },
318
+ "start": {
319
+ "description": "Start time (ISO 8601)",
320
+ "name": "start",
321
+ "hasDynamicHelp": false,
322
+ "multiple": false,
323
+ "type": "option"
324
+ },
325
+ "type": {
326
+ "description": "Filter by event type",
327
+ "name": "type",
328
+ "hasDynamicHelp": false,
329
+ "multiple": false,
330
+ "type": "option"
284
331
  }
285
332
  },
286
333
  "hasDynamicHelp": false,
287
334
  "hiddenAliases": [],
288
- "id": "command:get",
335
+ "id": "event:list",
289
336
  "pluginAlias": "@formant/formant-cli",
290
337
  "pluginName": "@formant/formant-cli",
291
338
  "pluginType": "core",
292
339
  "strict": true,
293
- "summary": "Get command template details",
340
+ "summary": "View events emitted by devices",
294
341
  "enableJsonFlag": true,
295
342
  "isESM": true,
296
343
  "relativePath": [
297
344
  "dist",
298
345
  "commands",
299
- "command",
300
- "get.js"
346
+ "event",
347
+ "list.js"
301
348
  ]
302
349
  },
303
- "command:history": {
350
+ "event-trigger:get": {
304
351
  "aliases": [],
305
- "args": {},
306
- "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.",
352
+ "args": {
353
+ "id": {
354
+ "description": "Event trigger ID (UUID)",
355
+ "name": "id",
356
+ "required": true
357
+ }
358
+ },
359
+ "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.",
307
360
  "examples": [
308
- "<%= config.bin %> command history --device <device-id>",
309
- "<%= config.bin %> command history --device <device-id> --limit 50",
310
- "<%= config.bin %> command history --device <device-id> --json"
361
+ "<%= config.bin %> event-trigger get <trigger-id>",
362
+ "<%= config.bin %> event-trigger get <trigger-id> --json"
311
363
  ],
312
364
  "flags": {
313
365
  "json": {
@@ -346,50 +398,32 @@
346
398
  "name": "toon",
347
399
  "allowNo": false,
348
400
  "type": "boolean"
349
- },
350
- "device": {
351
- "char": "d",
352
- "description": "Device ID (UUID)",
353
- "name": "device",
354
- "required": true,
355
- "hasDynamicHelp": false,
356
- "multiple": false,
357
- "type": "option"
358
- },
359
- "limit": {
360
- "char": "l",
361
- "description": "Maximum number of commands to return",
362
- "name": "limit",
363
- "default": 25,
364
- "hasDynamicHelp": false,
365
- "multiple": false,
366
- "type": "option"
367
401
  }
368
402
  },
369
403
  "hasDynamicHelp": false,
370
404
  "hiddenAliases": [],
371
- "id": "command:history",
405
+ "id": "event-trigger:get",
372
406
  "pluginAlias": "@formant/formant-cli",
373
407
  "pluginName": "@formant/formant-cli",
374
408
  "pluginType": "core",
375
409
  "strict": true,
376
- "summary": "Query command history",
410
+ "summary": "Get event trigger details",
377
411
  "enableJsonFlag": true,
378
412
  "isESM": true,
379
413
  "relativePath": [
380
414
  "dist",
381
415
  "commands",
382
- "command",
383
- "history.js"
416
+ "event-trigger",
417
+ "get.js"
384
418
  ]
385
419
  },
386
- "command:list": {
420
+ "event-trigger:list": {
387
421
  "aliases": [],
388
422
  "args": {},
389
- "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.",
423
+ "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.",
390
424
  "examples": [
391
- "<%= config.bin %> command list",
392
- "<%= config.bin %> command list --json"
425
+ "<%= config.bin %> event-trigger list",
426
+ "<%= config.bin %> event-trigger list --json"
393
427
  ],
394
428
  "flags": {
395
429
  "json": {
@@ -432,42 +466,34 @@
432
466
  },
433
467
  "hasDynamicHelp": false,
434
468
  "hiddenAliases": [],
435
- "id": "command:list",
469
+ "id": "event-trigger:list",
436
470
  "pluginAlias": "@formant/formant-cli",
437
471
  "pluginName": "@formant/formant-cli",
438
472
  "pluginType": "core",
439
473
  "strict": true,
440
- "summary": "List command templates",
474
+ "summary": "List event trigger rules",
441
475
  "enableJsonFlag": true,
442
476
  "isESM": true,
443
477
  "relativePath": [
444
478
  "dist",
445
479
  "commands",
446
- "command",
480
+ "event-trigger",
447
481
  "list.js"
448
482
  ]
449
483
  },
450
- "command:send": {
484
+ "fleet:get": {
451
485
  "aliases": [],
452
486
  "args": {
453
- "deviceId": {
454
- "description": "Device ID (UUID)",
455
- "name": "deviceId",
456
- "required": true
457
- },
458
- "templateId": {
459
- "description": "Command template ID (UUID)",
460
- "name": "templateId",
487
+ "id": {
488
+ "description": "Fleet (group) ID (UUID)",
489
+ "name": "id",
461
490
  "required": true
462
491
  }
463
492
  },
464
- "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.",
493
+ "description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.",
465
494
  "examples": [
466
- "<%= config.bin %> command send <device-id> <template-id>",
467
- "<%= config.bin %> command send <device-id> <template-id> --param speed=5 --param mode=fast",
468
- "<%= config.bin %> command send <device-id> <template-id> --dry-run",
469
- "<%= config.bin %> command send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
470
- "<%= config.bin %> command send <device-id> <template-id> --json"
495
+ "<%= config.bin %> fleet get <fleet-id>",
496
+ "<%= config.bin %> fleet get <fleet-id> --json"
471
497
  ],
472
498
  "flags": {
473
499
  "json": {
@@ -506,59 +532,32 @@
506
532
  "name": "toon",
507
533
  "allowNo": false,
508
534
  "type": "boolean"
509
- },
510
- "dry-run": {
511
- "description": "Preview the command payload without sending",
512
- "name": "dry-run",
513
- "allowNo": false,
514
- "type": "boolean"
515
- },
516
- "param": {
517
- "char": "p",
518
- "description": "Parameter override (name=value), can be specified multiple times",
519
- "name": "param",
520
- "hasDynamicHelp": false,
521
- "multiple": true,
522
- "type": "option"
523
- },
524
- "raw-value": {
525
- "description": "Send a raw parameter value string (bypasses schema validation)",
526
- "name": "raw-value",
527
- "hasDynamicHelp": false,
528
- "multiple": false,
529
- "type": "option"
530
535
  }
531
536
  },
532
537
  "hasDynamicHelp": false,
533
538
  "hiddenAliases": [],
534
- "id": "command:send",
539
+ "id": "fleet:get",
535
540
  "pluginAlias": "@formant/formant-cli",
536
541
  "pluginName": "@formant/formant-cli",
537
542
  "pluginType": "core",
538
543
  "strict": true,
539
- "summary": "Send a command to a device",
544
+ "summary": "Get fleet details",
540
545
  "enableJsonFlag": true,
541
546
  "isESM": true,
542
547
  "relativePath": [
543
548
  "dist",
544
549
  "commands",
545
- "command",
546
- "send.js"
550
+ "fleet",
551
+ "get.js"
547
552
  ]
548
553
  },
549
- "event:get": {
554
+ "fleet:list": {
550
555
  "aliases": [],
551
- "args": {
552
- "id": {
553
- "description": "Event ID (UUID)",
554
- "name": "id",
555
- "required": true
556
- }
557
- },
558
- "description": "Get detailed information about a specific event by its ID.",
556
+ "args": {},
557
+ "description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.",
559
558
  "examples": [
560
- "<%= config.bin %> event get <event-id>",
561
- "<%= config.bin %> event get <event-id> --json"
559
+ "<%= config.bin %> fleet list",
560
+ "<%= config.bin %> fleet list --json"
562
561
  ],
563
562
  "flags": {
564
563
  "json": {
@@ -601,30 +600,34 @@
601
600
  },
602
601
  "hasDynamicHelp": false,
603
602
  "hiddenAliases": [],
604
- "id": "event:get",
603
+ "id": "fleet:list",
605
604
  "pluginAlias": "@formant/formant-cli",
606
605
  "pluginName": "@formant/formant-cli",
607
606
  "pluginType": "core",
608
607
  "strict": true,
609
- "summary": "Get an event by ID",
608
+ "summary": "List device groups",
610
609
  "enableJsonFlag": true,
611
610
  "isESM": true,
612
611
  "relativePath": [
613
612
  "dist",
614
613
  "commands",
615
- "event",
616
- "get.js"
614
+ "fleet",
615
+ "list.js"
617
616
  ]
618
617
  },
619
- "event:list": {
618
+ "command:for-device": {
620
619
  "aliases": [],
621
- "args": {},
622
- "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.",
620
+ "args": {
621
+ "deviceId": {
622
+ "description": "Device ID (UUID)",
623
+ "name": "deviceId",
624
+ "required": true
625
+ }
626
+ },
627
+ "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.",
623
628
  "examples": [
624
- "<%= config.bin %> event list",
625
- "<%= config.bin %> event list --device <id> --severity critical",
626
- "<%= config.bin %> event list --type device-offline --start 2026-01-01 --end 2026-01-02",
627
- "<%= config.bin %> event list --limit 100 --json"
629
+ "<%= config.bin %> command for-device <device-id>",
630
+ "<%= config.bin %> command for-device <device-id> --json"
628
631
  ],
629
632
  "flags": {
630
633
  "json": {
@@ -663,89 +666,38 @@
663
666
  "name": "toon",
664
667
  "allowNo": false,
665
668
  "type": "boolean"
666
- },
667
- "device": {
668
- "char": "d",
669
- "description": "Filter by device ID",
670
- "name": "device",
671
- "hasDynamicHelp": false,
672
- "multiple": false,
673
- "type": "option"
674
- },
675
- "end": {
676
- "description": "End time (ISO 8601)",
677
- "name": "end",
678
- "hasDynamicHelp": false,
679
- "multiple": false,
680
- "type": "option"
681
- },
682
- "limit": {
683
- "char": "l",
684
- "description": "Maximum number of events to return",
685
- "name": "limit",
686
- "default": 25,
687
- "hasDynamicHelp": false,
688
- "multiple": false,
689
- "type": "option"
690
- },
691
- "severity": {
692
- "description": "Filter by severity",
693
- "name": "severity",
694
- "hasDynamicHelp": false,
695
- "multiple": false,
696
- "options": [
697
- "info",
698
- "warning",
699
- "error",
700
- "critical"
701
- ],
702
- "type": "option"
703
- },
704
- "start": {
705
- "description": "Start time (ISO 8601)",
706
- "name": "start",
707
- "hasDynamicHelp": false,
708
- "multiple": false,
709
- "type": "option"
710
- },
711
- "type": {
712
- "description": "Filter by event type",
713
- "name": "type",
714
- "hasDynamicHelp": false,
715
- "multiple": false,
716
- "type": "option"
717
669
  }
718
670
  },
719
671
  "hasDynamicHelp": false,
720
672
  "hiddenAliases": [],
721
- "id": "event:list",
673
+ "id": "command:for-device",
722
674
  "pluginAlias": "@formant/formant-cli",
723
675
  "pluginName": "@formant/formant-cli",
724
676
  "pluginType": "core",
725
677
  "strict": true,
726
- "summary": "View events emitted by devices",
678
+ "summary": "List commands available for a device",
727
679
  "enableJsonFlag": true,
728
680
  "isESM": true,
729
681
  "relativePath": [
730
682
  "dist",
731
683
  "commands",
732
- "event",
733
- "list.js"
684
+ "command",
685
+ "for-device.js"
734
686
  ]
735
687
  },
736
- "event-trigger:get": {
688
+ "command:get": {
737
689
  "aliases": [],
738
690
  "args": {
739
691
  "id": {
740
- "description": "Event trigger ID (UUID)",
692
+ "description": "Command template ID (UUID)",
741
693
  "name": "id",
742
694
  "required": true
743
695
  }
744
696
  },
745
- "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.",
697
+ "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.",
746
698
  "examples": [
747
- "<%= config.bin %> event-trigger get <trigger-id>",
748
- "<%= config.bin %> event-trigger get <trigger-id> --json"
699
+ "<%= config.bin %> command get <template-id>",
700
+ "<%= config.bin %> command get <template-id> --json"
749
701
  ],
750
702
  "flags": {
751
703
  "json": {
@@ -788,28 +740,29 @@
788
740
  },
789
741
  "hasDynamicHelp": false,
790
742
  "hiddenAliases": [],
791
- "id": "event-trigger:get",
743
+ "id": "command:get",
792
744
  "pluginAlias": "@formant/formant-cli",
793
745
  "pluginName": "@formant/formant-cli",
794
746
  "pluginType": "core",
795
747
  "strict": true,
796
- "summary": "Get event trigger details",
748
+ "summary": "Get command template details",
797
749
  "enableJsonFlag": true,
798
750
  "isESM": true,
799
751
  "relativePath": [
800
752
  "dist",
801
753
  "commands",
802
- "event-trigger",
754
+ "command",
803
755
  "get.js"
804
756
  ]
805
757
  },
806
- "event-trigger:list": {
758
+ "command:history": {
807
759
  "aliases": [],
808
760
  "args": {},
809
- "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.",
761
+ "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.",
810
762
  "examples": [
811
- "<%= config.bin %> event-trigger list",
812
- "<%= config.bin %> event-trigger list --json"
763
+ "<%= config.bin %> command history --device <device-id>",
764
+ "<%= config.bin %> command history --device <device-id> --limit 50",
765
+ "<%= config.bin %> command history --device <device-id> --json"
813
766
  ],
814
767
  "flags": {
815
768
  "json": {
@@ -848,38 +801,50 @@
848
801
  "name": "toon",
849
802
  "allowNo": false,
850
803
  "type": "boolean"
804
+ },
805
+ "device": {
806
+ "char": "d",
807
+ "description": "Device ID (UUID)",
808
+ "name": "device",
809
+ "required": true,
810
+ "hasDynamicHelp": false,
811
+ "multiple": false,
812
+ "type": "option"
813
+ },
814
+ "limit": {
815
+ "char": "l",
816
+ "description": "Maximum number of commands to return",
817
+ "name": "limit",
818
+ "default": 25,
819
+ "hasDynamicHelp": false,
820
+ "multiple": false,
821
+ "type": "option"
851
822
  }
852
823
  },
853
824
  "hasDynamicHelp": false,
854
825
  "hiddenAliases": [],
855
- "id": "event-trigger:list",
826
+ "id": "command:history",
856
827
  "pluginAlias": "@formant/formant-cli",
857
828
  "pluginName": "@formant/formant-cli",
858
829
  "pluginType": "core",
859
830
  "strict": true,
860
- "summary": "List event trigger rules",
831
+ "summary": "Query command history",
861
832
  "enableJsonFlag": true,
862
833
  "isESM": true,
863
834
  "relativePath": [
864
835
  "dist",
865
836
  "commands",
866
- "event-trigger",
867
- "list.js"
837
+ "command",
838
+ "history.js"
868
839
  ]
869
840
  },
870
- "fleet:get": {
841
+ "command:list": {
871
842
  "aliases": [],
872
- "args": {
873
- "id": {
874
- "description": "Fleet (group) ID (UUID)",
875
- "name": "id",
876
- "required": true
877
- }
878
- },
879
- "description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.",
843
+ "args": {},
844
+ "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.",
880
845
  "examples": [
881
- "<%= config.bin %> fleet get <fleet-id>",
882
- "<%= config.bin %> fleet get <fleet-id> --json"
846
+ "<%= config.bin %> command list",
847
+ "<%= config.bin %> command list --json"
883
848
  ],
884
849
  "flags": {
885
850
  "json": {
@@ -922,28 +887,42 @@
922
887
  },
923
888
  "hasDynamicHelp": false,
924
889
  "hiddenAliases": [],
925
- "id": "fleet:get",
890
+ "id": "command:list",
926
891
  "pluginAlias": "@formant/formant-cli",
927
892
  "pluginName": "@formant/formant-cli",
928
893
  "pluginType": "core",
929
894
  "strict": true,
930
- "summary": "Get fleet details",
895
+ "summary": "List command templates",
931
896
  "enableJsonFlag": true,
932
897
  "isESM": true,
933
898
  "relativePath": [
934
899
  "dist",
935
900
  "commands",
936
- "fleet",
937
- "get.js"
901
+ "command",
902
+ "list.js"
938
903
  ]
939
904
  },
940
- "fleet:list": {
905
+ "command:send": {
941
906
  "aliases": [],
942
- "args": {},
943
- "description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.",
907
+ "args": {
908
+ "deviceId": {
909
+ "description": "Device ID (UUID)",
910
+ "name": "deviceId",
911
+ "required": true
912
+ },
913
+ "templateId": {
914
+ "description": "Command template ID (UUID)",
915
+ "name": "templateId",
916
+ "required": true
917
+ }
918
+ },
919
+ "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.",
944
920
  "examples": [
945
- "<%= config.bin %> fleet list",
946
- "<%= config.bin %> fleet list --json"
921
+ "<%= config.bin %> command send <device-id> <template-id>",
922
+ "<%= config.bin %> command send <device-id> <template-id> --param speed=5 --param mode=fast",
923
+ "<%= config.bin %> command send <device-id> <template-id> --dry-run",
924
+ "<%= config.bin %> command send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
925
+ "<%= config.bin %> command send <device-id> <template-id> --json"
947
926
  ],
948
927
  "flags": {
949
928
  "json": {
@@ -982,38 +961,55 @@
982
961
  "name": "toon",
983
962
  "allowNo": false,
984
963
  "type": "boolean"
964
+ },
965
+ "dry-run": {
966
+ "description": "Preview the command payload without sending",
967
+ "name": "dry-run",
968
+ "allowNo": false,
969
+ "type": "boolean"
970
+ },
971
+ "param": {
972
+ "char": "p",
973
+ "description": "Parameter override (name=value), can be specified multiple times",
974
+ "name": "param",
975
+ "hasDynamicHelp": false,
976
+ "multiple": true,
977
+ "type": "option"
978
+ },
979
+ "raw-value": {
980
+ "description": "Send a raw parameter value string (bypasses schema validation)",
981
+ "name": "raw-value",
982
+ "hasDynamicHelp": false,
983
+ "multiple": false,
984
+ "type": "option"
985
985
  }
986
986
  },
987
987
  "hasDynamicHelp": false,
988
988
  "hiddenAliases": [],
989
- "id": "fleet:list",
989
+ "id": "command:send",
990
990
  "pluginAlias": "@formant/formant-cli",
991
991
  "pluginName": "@formant/formant-cli",
992
992
  "pluginType": "core",
993
993
  "strict": true,
994
- "summary": "List device groups",
994
+ "summary": "Send a command to a device",
995
995
  "enableJsonFlag": true,
996
996
  "isESM": true,
997
997
  "relativePath": [
998
998
  "dist",
999
999
  "commands",
1000
- "fleet",
1001
- "list.js"
1000
+ "command",
1001
+ "send.js"
1002
1002
  ]
1003
1003
  },
1004
- "device:config": {
1004
+ "ingest:batch": {
1005
1005
  "aliases": [],
1006
- "args": {
1007
- "id": {
1008
- "description": "Device ID (UUID)",
1009
- "name": "id",
1010
- "required": true
1011
- }
1012
- },
1013
- "description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
1006
+ "args": {},
1007
+ "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).",
1014
1008
  "examples": [
1015
- "<%= config.bin %> device config <device-id>",
1016
- "<%= config.bin %> device config <device-id> --json"
1009
+ "<%= config.bin %> ingest batch --file data.json",
1010
+ "<%= config.bin %> ingest batch --stdin < data.json",
1011
+ "cat payload.json | <%= config.bin %> ingest batch --stdin",
1012
+ "# 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}"
1017
1013
  ],
1018
1014
  "flags": {
1019
1015
  "json": {
@@ -1052,39 +1048,53 @@
1052
1048
  "name": "toon",
1053
1049
  "allowNo": false,
1054
1050
  "type": "boolean"
1051
+ },
1052
+ "file": {
1053
+ "char": "f",
1054
+ "description": "Path to JSON file containing batch payload",
1055
+ "exclusive": [
1056
+ "stdin"
1057
+ ],
1058
+ "name": "file",
1059
+ "hasDynamicHelp": false,
1060
+ "multiple": false,
1061
+ "type": "option"
1062
+ },
1063
+ "stdin": {
1064
+ "description": "Read JSON payload from stdin",
1065
+ "exclusive": [
1066
+ "file"
1067
+ ],
1068
+ "name": "stdin",
1069
+ "allowNo": false,
1070
+ "type": "boolean"
1055
1071
  }
1056
1072
  },
1057
1073
  "hasDynamicHelp": false,
1058
1074
  "hiddenAliases": [],
1059
- "id": "device:config",
1075
+ "id": "ingest:batch",
1060
1076
  "pluginAlias": "@formant/formant-cli",
1061
1077
  "pluginName": "@formant/formant-cli",
1062
1078
  "pluginType": "core",
1063
1079
  "strict": true,
1064
- "summary": "Get device configuration",
1080
+ "summary": "Ingest batch data from file or stdin",
1065
1081
  "enableJsonFlag": true,
1066
1082
  "isESM": true,
1067
1083
  "relativePath": [
1068
1084
  "dist",
1069
1085
  "commands",
1070
- "device",
1071
- "config.js"
1086
+ "ingest",
1087
+ "batch.js"
1072
1088
  ]
1073
1089
  },
1074
- "device:create": {
1090
+ "ingest:bitset": {
1075
1091
  "aliases": [],
1076
- "args": {
1077
- "name": {
1078
- "description": "Name for the new device",
1079
- "name": "name",
1080
- "required": true
1081
- }
1082
- },
1083
- "description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
1092
+ "args": {},
1093
+ "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",
1084
1094
  "examples": [
1085
- "<%= config.bin %> device create my-robot",
1086
- "<%= config.bin %> device create my-robot --tag location=warehouse --tag env=prod",
1087
- "<%= config.bin %> device create my-robot --json"
1095
+ "<%= config.bin %> ingest bitset --device <device-id> --stream sensors --keys \"door,window,motion\" --values \"true,false,true\"",
1096
+ "<%= config.bin %> ingest bitset --device <device-id> --stream flags --keys \"active,paused,error\" --values \"true,false,false\" --tag system=main",
1097
+ "<%= config.bin %> ingest bitset --device <device-id> --stream states --keys \"a,b\" --values \"false,true\""
1088
1098
  ],
1089
1099
  "flags": {
1090
1100
  "json": {
@@ -1124,184 +1134,83 @@
1124
1134
  "allowNo": false,
1125
1135
  "type": "boolean"
1126
1136
  },
1127
- "tag": {
1128
- "char": "t",
1129
- "description": "Tag to apply (key=value), can be specified multiple times",
1130
- "name": "tag",
1137
+ "device": {
1138
+ "char": "d",
1139
+ "description": "Device ID (UUID)",
1140
+ "name": "device",
1141
+ "required": true,
1131
1142
  "hasDynamicHelp": false,
1132
- "multiple": true,
1143
+ "multiple": false,
1133
1144
  "type": "option"
1134
- }
1135
- },
1136
- "hasDynamicHelp": false,
1137
- "hiddenAliases": [],
1138
- "id": "device:create",
1139
- "pluginAlias": "@formant/formant-cli",
1140
- "pluginName": "@formant/formant-cli",
1141
- "pluginType": "core",
1142
- "strict": true,
1143
- "summary": "Create a new device",
1144
- "enableJsonFlag": true,
1145
- "isESM": true,
1146
- "relativePath": [
1147
- "dist",
1148
- "commands",
1149
- "device",
1150
- "create.js"
1151
- ]
1152
- },
1153
- "device:delete": {
1154
- "aliases": [],
1155
- "args": {
1156
- "id": {
1157
- "description": "Device ID (UUID)",
1158
- "name": "id",
1159
- "required": true
1160
- }
1161
- },
1162
- "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.",
1163
- "examples": [
1164
- "<%= config.bin %> device delete <device-id>",
1165
- "<%= config.bin %> device delete <device-id> --json"
1166
- ],
1167
- "flags": {
1168
- "json": {
1169
- "description": "Format output as json.",
1170
- "helpGroup": "GLOBAL",
1171
- "name": "json",
1172
- "allowNo": false,
1173
- "type": "boolean"
1174
1145
  },
1175
- "dev": {
1176
- "description": "Target the dev environment",
1177
- "exclusive": [
1178
- "stage"
1179
- ],
1180
- "helpGroup": "GLOBAL",
1181
- "name": "dev",
1182
- "allowNo": false,
1183
- "type": "boolean"
1184
- },
1185
- "stage": {
1186
- "description": "Target the stage environment",
1187
- "exclusive": [
1188
- "dev"
1189
- ],
1190
- "helpGroup": "GLOBAL",
1191
- "name": "stage",
1192
- "allowNo": false,
1193
- "type": "boolean"
1146
+ "stream": {
1147
+ "char": "s",
1148
+ "description": "Stream name",
1149
+ "name": "stream",
1150
+ "required": true,
1151
+ "hasDynamicHelp": false,
1152
+ "multiple": false,
1153
+ "type": "option"
1194
1154
  },
1195
- "toon": {
1196
- "description": "Output data in TOON (Token-Oriented Object Notation) format",
1197
- "exclusive": [
1198
- "json"
1199
- ],
1200
- "helpGroup": "GLOBAL",
1201
- "name": "toon",
1202
- "allowNo": false,
1203
- "type": "boolean"
1204
- }
1205
- },
1206
- "hasDynamicHelp": false,
1207
- "hiddenAliases": [],
1208
- "id": "device:delete",
1209
- "pluginAlias": "@formant/formant-cli",
1210
- "pluginName": "@formant/formant-cli",
1211
- "pluginType": "core",
1212
- "strict": true,
1213
- "summary": "Delete (disable) a device",
1214
- "enableJsonFlag": true,
1215
- "isESM": true,
1216
- "relativePath": [
1217
- "dist",
1218
- "commands",
1219
- "device",
1220
- "delete.js"
1221
- ]
1222
- },
1223
- "device:get": {
1224
- "aliases": [],
1225
- "args": {
1226
- "id": {
1227
- "description": "Device ID (UUID)",
1228
- "name": "id",
1229
- "required": true
1230
- }
1231
- },
1232
- "description": "Get detailed information about a specific device by its ID.",
1233
- "examples": [
1234
- "<%= config.bin %> device get <device-id>",
1235
- "<%= config.bin %> device get <device-id> --json"
1236
- ],
1237
- "flags": {
1238
- "json": {
1239
- "description": "Format output as json.",
1240
- "helpGroup": "GLOBAL",
1241
- "name": "json",
1242
- "allowNo": false,
1243
- "type": "boolean"
1155
+ "keys": {
1156
+ "char": "k",
1157
+ "description": "Comma-separated list of key names (1-1000 keys, max 255 chars each)",
1158
+ "name": "keys",
1159
+ "required": true,
1160
+ "hasDynamicHelp": false,
1161
+ "multiple": false,
1162
+ "type": "option"
1244
1163
  },
1245
- "dev": {
1246
- "description": "Target the dev environment",
1247
- "exclusive": [
1248
- "stage"
1249
- ],
1250
- "helpGroup": "GLOBAL",
1251
- "name": "dev",
1252
- "allowNo": false,
1253
- "type": "boolean"
1164
+ "values": {
1165
+ "char": "v",
1166
+ "description": "Comma-separated list of boolean values (true/false, must match key count)",
1167
+ "name": "values",
1168
+ "required": true,
1169
+ "hasDynamicHelp": false,
1170
+ "multiple": false,
1171
+ "type": "option"
1254
1172
  },
1255
- "stage": {
1256
- "description": "Target the stage environment",
1257
- "exclusive": [
1258
- "dev"
1259
- ],
1260
- "helpGroup": "GLOBAL",
1261
- "name": "stage",
1262
- "allowNo": false,
1263
- "type": "boolean"
1173
+ "tag": {
1174
+ "char": "t",
1175
+ "description": "Tag as key=value where both are strings (can be specified multiple times)",
1176
+ "name": "tag",
1177
+ "hasDynamicHelp": false,
1178
+ "multiple": true,
1179
+ "type": "option"
1264
1180
  },
1265
- "toon": {
1266
- "description": "Output data in TOON (Token-Oriented Object Notation) format",
1267
- "exclusive": [
1268
- "json"
1269
- ],
1270
- "helpGroup": "GLOBAL",
1271
- "name": "toon",
1272
- "allowNo": false,
1273
- "type": "boolean"
1181
+ "timestamp": {
1182
+ "description": "Unix timestamp in milliseconds (defaults to now)",
1183
+ "name": "timestamp",
1184
+ "hasDynamicHelp": false,
1185
+ "multiple": false,
1186
+ "type": "option"
1274
1187
  }
1275
1188
  },
1276
1189
  "hasDynamicHelp": false,
1277
1190
  "hiddenAliases": [],
1278
- "id": "device:get",
1191
+ "id": "ingest:bitset",
1279
1192
  "pluginAlias": "@formant/formant-cli",
1280
1193
  "pluginName": "@formant/formant-cli",
1281
1194
  "pluginType": "core",
1282
1195
  "strict": true,
1283
- "summary": "Get a device by ID",
1196
+ "summary": "Ingest bitset data",
1284
1197
  "enableJsonFlag": true,
1285
1198
  "isESM": true,
1286
1199
  "relativePath": [
1287
1200
  "dist",
1288
1201
  "commands",
1289
- "device",
1290
- "get.js"
1202
+ "ingest",
1203
+ "bitset.js"
1291
1204
  ]
1292
1205
  },
1293
- "device:list": {
1206
+ "ingest:health": {
1294
1207
  "aliases": [],
1295
1208
  "args": {},
1296
- "description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --include-offline to include offline devices. Use --with-data to show only\ndevices that have ingested data. Each device is enriched with data-based last\nseen timestamp and datapoint count from analytics.",
1209
+ "description": "Ingest a health status data point to a device stream.\n\nSends device health status information to the specified stream. Health data consists of:\n- status: One of \"unknown\", \"operational\", \"offline\", or \"error\"\n- clockSkewMs (optional): Clock skew in milliseconds between device and server\n\nHealth streams are used to track device operational state, system health, and time synchronization.",
1297
1210
  "examples": [
1298
- "<%= config.bin %> device list",
1299
- "<%= config.bin %> device list --include-offline",
1300
- "<%= config.bin %> device list --with-data",
1301
- "<%= config.bin %> device list --with-data --days 90",
1302
- "<%= config.bin %> device list --include-offline --limit 100",
1303
- "<%= config.bin %> device list --tag location=warehouse",
1304
- "<%= config.bin %> device list --name robot --dev --json"
1211
+ "<%= config.bin %> ingest health --device <device-id> --stream system_health --status operational",
1212
+ "<%= config.bin %> ingest health --device <device-id> --stream health --status error --tag component=motor",
1213
+ "<%= config.bin %> ingest health --device <device-id> --stream sync --status operational --clock-skew 150"
1305
1214
  ],
1306
1215
  "flags": {
1307
1216
  "json": {
@@ -1341,89 +1250,86 @@
1341
1250
  "allowNo": false,
1342
1251
  "type": "boolean"
1343
1252
  },
1344
- "include-offline": {
1345
- "char": "a",
1346
- "description": "Include offline devices",
1347
- "name": "include-offline",
1348
- "allowNo": false,
1349
- "type": "boolean"
1350
- },
1351
- "days": {
1352
- "description": "How many days back to search for last seen data",
1353
- "name": "days",
1354
- "default": 30,
1253
+ "device": {
1254
+ "char": "d",
1255
+ "description": "Device ID (UUID)",
1256
+ "name": "device",
1257
+ "required": true,
1355
1258
  "hasDynamicHelp": false,
1356
1259
  "multiple": false,
1357
1260
  "type": "option"
1358
1261
  },
1359
- "limit": {
1360
- "char": "l",
1361
- "description": "Maximum number of devices to return",
1362
- "name": "limit",
1363
- "default": 50,
1262
+ "stream": {
1263
+ "char": "s",
1264
+ "description": "Stream name",
1265
+ "name": "stream",
1266
+ "required": true,
1364
1267
  "hasDynamicHelp": false,
1365
1268
  "multiple": false,
1366
1269
  "type": "option"
1367
1270
  },
1368
- "name": {
1369
- "char": "n",
1370
- "description": "Filter devices by name (search)",
1371
- "name": "name",
1271
+ "status": {
1272
+ "description": "Health status (unknown, operational, offline, or error)",
1273
+ "name": "status",
1274
+ "required": true,
1372
1275
  "hasDynamicHelp": false,
1373
1276
  "multiple": false,
1277
+ "options": [
1278
+ "unknown",
1279
+ "operational",
1280
+ "offline",
1281
+ "error"
1282
+ ],
1374
1283
  "type": "option"
1375
1284
  },
1376
- "with-data": {
1377
- "char": "w",
1378
- "description": "Only show devices that have data in the last --days window",
1379
- "name": "with-data",
1380
- "allowNo": false,
1381
- "type": "boolean"
1285
+ "clock-skew": {
1286
+ "description": "Clock skew in milliseconds (optional)",
1287
+ "name": "clock-skew",
1288
+ "hasDynamicHelp": false,
1289
+ "multiple": false,
1290
+ "type": "option"
1382
1291
  },
1383
1292
  "tag": {
1384
1293
  "char": "t",
1385
- "description": "Filter by tag (key=value), can be specified multiple times",
1294
+ "description": "Tag as key=value where both are strings (can be specified multiple times)",
1386
1295
  "name": "tag",
1387
1296
  "hasDynamicHelp": false,
1388
1297
  "multiple": true,
1389
1298
  "type": "option"
1299
+ },
1300
+ "timestamp": {
1301
+ "description": "Unix timestamp in milliseconds (defaults to now)",
1302
+ "name": "timestamp",
1303
+ "hasDynamicHelp": false,
1304
+ "multiple": false,
1305
+ "type": "option"
1390
1306
  }
1391
1307
  },
1392
1308
  "hasDynamicHelp": false,
1393
1309
  "hiddenAliases": [],
1394
- "id": "device:list",
1310
+ "id": "ingest:health",
1395
1311
  "pluginAlias": "@formant/formant-cli",
1396
1312
  "pluginName": "@formant/formant-cli",
1397
1313
  "pluginType": "core",
1398
1314
  "strict": true,
1399
- "summary": "List robots and sensors in your fleet",
1315
+ "summary": "Ingest health status data",
1400
1316
  "enableJsonFlag": true,
1401
1317
  "isESM": true,
1402
1318
  "relativePath": [
1403
1319
  "dist",
1404
1320
  "commands",
1405
- "device",
1406
- "list.js"
1321
+ "ingest",
1322
+ "health.js"
1407
1323
  ]
1408
1324
  },
1409
- "device:rename": {
1325
+ "ingest:image": {
1410
1326
  "aliases": [],
1411
- "args": {
1412
- "id": {
1413
- "description": "Device ID (UUID)",
1414
- "name": "id",
1415
- "required": true
1416
- },
1417
- "name": {
1418
- "description": "New name for the device",
1419
- "name": "name",
1420
- "required": true
1421
- }
1422
- },
1423
- "description": "Rename a device by updating its name.",
1327
+ "args": {},
1328
+ "description": "Ingest an image URL to a device stream.\n\nSends an image reference (by URL) to the specified device stream. The image must be accessible\nvia HTTP/HTTPS. Formant will fetch and store the image from the provided URL.\n\nImage streams are used for camera feeds, snapshots, diagnostic images, etc.",
1424
1329
  "examples": [
1425
- "<%= config.bin %> device rename <device-id> new-robot-name",
1426
- "<%= config.bin %> device rename <device-id> new-robot-name --json"
1330
+ "<%= config.bin %> ingest image --device <device-id> --stream camera_front --url https://example.com/image.jpg",
1331
+ "<%= config.bin %> ingest image --device <device-id> --stream snapshot --url https://example.com/snap.png --size 1024000",
1332
+ "<%= config.bin %> ingest image --device <device-id> --stream detection --url https://example.com/detect.jpg --tag frame=123"
1427
1333
  ],
1428
1334
  "flags": {
1429
1335
  "json": {
@@ -1462,126 +1368,88 @@
1462
1368
  "name": "toon",
1463
1369
  "allowNo": false,
1464
1370
  "type": "boolean"
1465
- }
1466
- },
1467
- "hasDynamicHelp": false,
1468
- "hiddenAliases": [],
1469
- "id": "device:rename",
1470
- "pluginAlias": "@formant/formant-cli",
1471
- "pluginName": "@formant/formant-cli",
1472
- "pluginType": "core",
1473
- "strict": true,
1474
- "summary": "Rename a device",
1475
- "enableJsonFlag": true,
1476
- "isESM": true,
1477
- "relativePath": [
1478
- "dist",
1479
- "commands",
1480
- "device",
1481
- "rename.js"
1482
- ]
1483
- },
1484
- "device:streams": {
1485
- "aliases": [],
1486
- "args": {
1487
- "id": {
1488
- "description": "Device ID (UUID)",
1489
- "name": "id",
1490
- "required": true
1491
- }
1492
- },
1493
- "description": "List telemetry streams for a device with data presence.\n\nShows streams from the device configuration and any streams discovered from\ningested data. Each stream is enriched with presence info from the analytics\nbackend: data point count, last seen time, and a freshness indicator\n(active/recent/stale/dormant).\n\nUnconfigured streams (discovered from data only) are marked with SOURCE \"data\".",
1494
- "examples": [
1495
- "<%= config.bin %> device streams <device-id>",
1496
- "<%= config.bin %> device streams <device-id> --with-data",
1497
- "<%= config.bin %> device streams <device-id> --with-data --days 30",
1498
- "<%= config.bin %> device streams <device-id> --json"
1499
- ],
1500
- "flags": {
1501
- "json": {
1502
- "description": "Format output as json.",
1503
- "helpGroup": "GLOBAL",
1504
- "name": "json",
1505
- "allowNo": false,
1506
- "type": "boolean"
1507
1371
  },
1508
- "dev": {
1509
- "description": "Target the dev environment",
1510
- "exclusive": [
1511
- "stage"
1512
- ],
1513
- "helpGroup": "GLOBAL",
1514
- "name": "dev",
1515
- "allowNo": false,
1516
- "type": "boolean"
1517
- },
1518
- "stage": {
1519
- "description": "Target the stage environment",
1520
- "exclusive": [
1521
- "dev"
1522
- ],
1523
- "helpGroup": "GLOBAL",
1524
- "name": "stage",
1525
- "allowNo": false,
1526
- "type": "boolean"
1372
+ "device": {
1373
+ "char": "d",
1374
+ "description": "Device ID (UUID)",
1375
+ "name": "device",
1376
+ "required": true,
1377
+ "hasDynamicHelp": false,
1378
+ "multiple": false,
1379
+ "type": "option"
1527
1380
  },
1528
- "toon": {
1529
- "description": "Output data in TOON (Token-Oriented Object Notation) format",
1530
- "exclusive": [
1531
- "json"
1532
- ],
1533
- "helpGroup": "GLOBAL",
1534
- "name": "toon",
1535
- "allowNo": false,
1536
- "type": "boolean"
1381
+ "stream": {
1382
+ "char": "s",
1383
+ "description": "Stream name",
1384
+ "name": "stream",
1385
+ "required": true,
1386
+ "hasDynamicHelp": false,
1387
+ "multiple": false,
1388
+ "type": "option"
1537
1389
  },
1538
- "days": {
1539
- "description": "How many days back to look for stream data presence",
1540
- "name": "days",
1541
- "default": 7,
1390
+ "url": {
1391
+ "char": "u",
1392
+ "description": "Image URL (must be http:// or https://)",
1393
+ "name": "url",
1394
+ "required": true,
1542
1395
  "hasDynamicHelp": false,
1543
1396
  "multiple": false,
1544
1397
  "type": "option"
1545
1398
  },
1546
- "with-data": {
1547
- "char": "w",
1548
- "description": "Only show streams that have data in the --days window",
1549
- "name": "with-data",
1550
- "allowNo": false,
1551
- "type": "boolean"
1399
+ "size": {
1400
+ "description": "Image size in bytes (optional)",
1401
+ "name": "size",
1402
+ "hasDynamicHelp": false,
1403
+ "multiple": false,
1404
+ "type": "option"
1405
+ },
1406
+ "tag": {
1407
+ "char": "t",
1408
+ "description": "Tag as key=value where both are strings (can be specified multiple times)",
1409
+ "name": "tag",
1410
+ "hasDynamicHelp": false,
1411
+ "multiple": true,
1412
+ "type": "option"
1413
+ },
1414
+ "timestamp": {
1415
+ "description": "Unix timestamp in milliseconds (defaults to now)",
1416
+ "name": "timestamp",
1417
+ "hasDynamicHelp": false,
1418
+ "multiple": false,
1419
+ "type": "option"
1552
1420
  }
1553
1421
  },
1554
1422
  "hasDynamicHelp": false,
1555
1423
  "hiddenAliases": [],
1556
- "id": "device:streams",
1424
+ "id": "ingest:image",
1557
1425
  "pluginAlias": "@formant/formant-cli",
1558
1426
  "pluginName": "@formant/formant-cli",
1559
1427
  "pluginType": "core",
1560
1428
  "strict": true,
1561
- "summary": "List device streams with data presence",
1429
+ "summary": "Ingest image data",
1562
1430
  "enableJsonFlag": true,
1563
1431
  "isESM": true,
1564
1432
  "relativePath": [
1565
1433
  "dist",
1566
1434
  "commands",
1567
- "device",
1568
- "streams.js"
1435
+ "ingest",
1436
+ "image.js"
1569
1437
  ]
1570
1438
  },
1571
- "device:tag": {
1439
+ "ingest:json": {
1572
1440
  "aliases": [],
1573
1441
  "args": {
1574
- "id": {
1575
- "description": "Device ID (UUID)",
1576
- "name": "id",
1442
+ "value": {
1443
+ "description": "JSON value to ingest (as a JSON string)",
1444
+ "name": "value",
1577
1445
  "required": true
1578
1446
  }
1579
1447
  },
1580
- "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.",
1448
+ "description": "Ingest a JSON data point to a device stream.\n\nSends structured JSON data to the specified device stream. The value must be valid JSON.\nJSON streams are used for complex structured data like configuration objects, state machines,\nnested telemetry, etc.\n\nNote: The JSON is sent as a JSON-encoded string to Formant.",
1581
1449
  "examples": [
1582
- "<%= config.bin %> device tag <device-id> --tag location=warehouse",
1583
- "<%= config.bin %> device tag <device-id> --tag env=prod --tag region=us-east",
1584
- "<%= config.bin %> device tag <device-id> --tag location=factory --json"
1450
+ "<%= config.bin %> ingest json '{\"x\":1,\"y\":2}' --device <device-id> --stream position",
1451
+ "<%= config.bin %> ingest json '{\"status\":\"active\",\"mode\":\"auto\"}' --device <device-id> --stream config",
1452
+ "<%= config.bin %> ingest json '[1,2,3,4,5]' --device <device-id> --stream array_data"
1585
1453
  ],
1586
1454
  "flags": {
1587
1455
  "json": {
@@ -1621,47 +1489,71 @@
1621
1489
  "allowNo": false,
1622
1490
  "type": "boolean"
1623
1491
  },
1492
+ "device": {
1493
+ "char": "d",
1494
+ "description": "Device ID (UUID)",
1495
+ "name": "device",
1496
+ "required": true,
1497
+ "hasDynamicHelp": false,
1498
+ "multiple": false,
1499
+ "type": "option"
1500
+ },
1501
+ "stream": {
1502
+ "char": "s",
1503
+ "description": "Stream name",
1504
+ "name": "stream",
1505
+ "required": true,
1506
+ "hasDynamicHelp": false,
1507
+ "multiple": false,
1508
+ "type": "option"
1509
+ },
1624
1510
  "tag": {
1625
1511
  "char": "t",
1626
- "description": "Tag to add or update (key=value), can be specified multiple times",
1512
+ "description": "Tag as key=value where both are strings (can be specified multiple times)",
1627
1513
  "name": "tag",
1628
- "required": true,
1629
1514
  "hasDynamicHelp": false,
1630
1515
  "multiple": true,
1631
1516
  "type": "option"
1517
+ },
1518
+ "timestamp": {
1519
+ "description": "Unix timestamp in milliseconds (defaults to now)",
1520
+ "name": "timestamp",
1521
+ "hasDynamicHelp": false,
1522
+ "multiple": false,
1523
+ "type": "option"
1632
1524
  }
1633
1525
  },
1634
1526
  "hasDynamicHelp": false,
1635
1527
  "hiddenAliases": [],
1636
- "id": "device:tag",
1528
+ "id": "ingest:json",
1637
1529
  "pluginAlias": "@formant/formant-cli",
1638
1530
  "pluginName": "@formant/formant-cli",
1639
1531
  "pluginType": "core",
1640
1532
  "strict": true,
1641
- "summary": "Add or update tags on a device",
1533
+ "summary": "Ingest JSON data",
1642
1534
  "enableJsonFlag": true,
1643
1535
  "isESM": true,
1644
1536
  "relativePath": [
1645
1537
  "dist",
1646
1538
  "commands",
1647
- "device",
1648
- "tag.js"
1539
+ "ingest",
1540
+ "json.js"
1649
1541
  ]
1650
1542
  },
1651
- "device:untag": {
1543
+ "ingest:numeric": {
1652
1544
  "aliases": [],
1653
1545
  "args": {
1654
- "id": {
1655
- "description": "Device ID (UUID)",
1656
- "name": "id",
1546
+ "value": {
1547
+ "description": "Numeric value to ingest",
1548
+ "name": "value",
1657
1549
  "required": true
1658
1550
  }
1659
1551
  },
1660
- "description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.",
1552
+ "description": "Ingest a numeric data point to a device stream.\n\nSends a single numeric value to the specified device stream. The value must be a valid number.\nNumeric streams are commonly used for sensor readings like battery level, temperature, speed, etc.",
1661
1553
  "examples": [
1662
- "<%= config.bin %> device untag <device-id> --key location",
1663
- "<%= config.bin %> device untag <device-id> --key env --key region",
1664
- "<%= config.bin %> device untag <device-id> --key location --json"
1554
+ "<%= config.bin %> ingest numeric 42.5 --device <device-id> --stream battery_level",
1555
+ "<%= config.bin %> ingest numeric 98.6 --device <device-id> --stream temperature --tag unit=fahrenheit",
1556
+ "<%= config.bin %> ingest numeric 1500 --device <device-id> --stream rpm --timestamp 1700000000000"
1665
1557
  ],
1666
1558
  "flags": {
1667
1559
  "json": {
@@ -1701,42 +1593,71 @@
1701
1593
  "allowNo": false,
1702
1594
  "type": "boolean"
1703
1595
  },
1704
- "key": {
1705
- "char": "k",
1706
- "description": "Tag key to remove, can be specified multiple times",
1707
- "name": "key",
1596
+ "device": {
1597
+ "char": "d",
1598
+ "description": "Device ID (UUID)",
1599
+ "name": "device",
1600
+ "required": true,
1601
+ "hasDynamicHelp": false,
1602
+ "multiple": false,
1603
+ "type": "option"
1604
+ },
1605
+ "stream": {
1606
+ "char": "s",
1607
+ "description": "Stream name",
1608
+ "name": "stream",
1708
1609
  "required": true,
1709
1610
  "hasDynamicHelp": false,
1611
+ "multiple": false,
1612
+ "type": "option"
1613
+ },
1614
+ "tag": {
1615
+ "char": "t",
1616
+ "description": "Tag as key=value where both are strings (can be specified multiple times)",
1617
+ "name": "tag",
1618
+ "hasDynamicHelp": false,
1710
1619
  "multiple": true,
1711
1620
  "type": "option"
1621
+ },
1622
+ "timestamp": {
1623
+ "description": "Unix timestamp in milliseconds (defaults to now)",
1624
+ "name": "timestamp",
1625
+ "hasDynamicHelp": false,
1626
+ "multiple": false,
1627
+ "type": "option"
1712
1628
  }
1713
1629
  },
1714
1630
  "hasDynamicHelp": false,
1715
1631
  "hiddenAliases": [],
1716
- "id": "device:untag",
1632
+ "id": "ingest:numeric",
1717
1633
  "pluginAlias": "@formant/formant-cli",
1718
1634
  "pluginName": "@formant/formant-cli",
1719
1635
  "pluginType": "core",
1720
1636
  "strict": true,
1721
- "summary": "Remove tags from a device",
1637
+ "summary": "Ingest numeric data",
1722
1638
  "enableJsonFlag": true,
1723
1639
  "isESM": true,
1724
1640
  "relativePath": [
1725
1641
  "dist",
1726
1642
  "commands",
1727
- "device",
1728
- "untag.js"
1643
+ "ingest",
1644
+ "numeric.js"
1729
1645
  ]
1730
1646
  },
1731
- "ingest:batch": {
1647
+ "ingest:text": {
1732
1648
  "aliases": [],
1733
- "args": {},
1734
- "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).",
1649
+ "args": {
1650
+ "value": {
1651
+ "description": "Text value to ingest",
1652
+ "name": "value",
1653
+ "required": true
1654
+ }
1655
+ },
1656
+ "description": "Ingest a text data point to a device stream.\n\nSends a single text/string value to the specified device stream. Text streams are commonly\nused for logs, status messages, error messages, and other string data.",
1735
1657
  "examples": [
1736
- "<%= config.bin %> ingest batch --file data.json",
1737
- "<%= config.bin %> ingest batch --stdin < data.json",
1738
- "cat payload.json | <%= config.bin %> ingest batch --stdin",
1739
- "# 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}"
1658
+ "<%= config.bin %> ingest text \"Robot started successfully\" --device <device-id> --stream status",
1659
+ "<%= config.bin %> ingest text \"Error: sensor offline\" --device <device-id> --stream errors --tag severity=high",
1660
+ "<%= config.bin %> ingest text \"Checkpoint A reached\" --device <device-id> --stream waypoints"
1740
1661
  ],
1741
1662
  "flags": {
1742
1663
  "json": {
@@ -1776,52 +1697,65 @@
1776
1697
  "allowNo": false,
1777
1698
  "type": "boolean"
1778
1699
  },
1779
- "file": {
1780
- "char": "f",
1781
- "description": "Path to JSON file containing batch payload",
1782
- "exclusive": [
1783
- "stdin"
1784
- ],
1785
- "name": "file",
1700
+ "device": {
1701
+ "char": "d",
1702
+ "description": "Device ID (UUID)",
1703
+ "name": "device",
1704
+ "required": true,
1786
1705
  "hasDynamicHelp": false,
1787
1706
  "multiple": false,
1788
1707
  "type": "option"
1789
1708
  },
1790
- "stdin": {
1791
- "description": "Read JSON payload from stdin",
1792
- "exclusive": [
1793
- "file"
1794
- ],
1795
- "name": "stdin",
1796
- "allowNo": false,
1797
- "type": "boolean"
1709
+ "stream": {
1710
+ "char": "s",
1711
+ "description": "Stream name",
1712
+ "name": "stream",
1713
+ "required": true,
1714
+ "hasDynamicHelp": false,
1715
+ "multiple": false,
1716
+ "type": "option"
1717
+ },
1718
+ "tag": {
1719
+ "char": "t",
1720
+ "description": "Tag as key=value where both are strings (can be specified multiple times)",
1721
+ "name": "tag",
1722
+ "hasDynamicHelp": false,
1723
+ "multiple": true,
1724
+ "type": "option"
1725
+ },
1726
+ "timestamp": {
1727
+ "description": "Unix timestamp in milliseconds (defaults to now)",
1728
+ "name": "timestamp",
1729
+ "hasDynamicHelp": false,
1730
+ "multiple": false,
1731
+ "type": "option"
1798
1732
  }
1799
1733
  },
1800
1734
  "hasDynamicHelp": false,
1801
1735
  "hiddenAliases": [],
1802
- "id": "ingest:batch",
1736
+ "id": "ingest:text",
1803
1737
  "pluginAlias": "@formant/formant-cli",
1804
1738
  "pluginName": "@formant/formant-cli",
1805
1739
  "pluginType": "core",
1806
1740
  "strict": true,
1807
- "summary": "Ingest batch data from file or stdin",
1741
+ "summary": "Ingest text data",
1808
1742
  "enableJsonFlag": true,
1809
1743
  "isESM": true,
1810
1744
  "relativePath": [
1811
1745
  "dist",
1812
1746
  "commands",
1813
1747
  "ingest",
1814
- "batch.js"
1748
+ "text.js"
1815
1749
  ]
1816
1750
  },
1817
- "ingest:bitset": {
1751
+ "ingest:video": {
1818
1752
  "aliases": [],
1819
1753
  "args": {},
1820
- "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",
1754
+ "description": "Ingest a video URL to a device stream.\n\nSends a video reference (by URL) to the specified device stream. The video must be accessible\nvia HTTP/HTTPS. You must provide the video duration in milliseconds.\n\nVideo streams are used for recorded video clips, timelapse videos, event recordings, etc.\n\nThe MIME type is auto-detected from the file extension (.mp4, .webm, .mov).",
1821
1755
  "examples": [
1822
- "<%= config.bin %> ingest bitset --device <device-id> --stream sensors --keys \"door,window,motion\" --values \"true,false,true\"",
1823
- "<%= config.bin %> ingest bitset --device <device-id> --stream flags --keys \"active,paused,error\" --values \"true,false,false\" --tag system=main",
1824
- "<%= config.bin %> ingest bitset --device <device-id> --stream states --keys \"a,b\" --values \"false,true\""
1756
+ "<%= config.bin %> ingest video --device <device-id> --stream recordings --url https://example.com/video.mp4 --duration 5000",
1757
+ "<%= config.bin %> ingest video --device <device-id> --stream clips --url https://example.com/clip.webm --duration 3500 --size 2048000",
1758
+ "<%= config.bin %> ingest video --device <device-id> --stream event_video --url https://example.com/event.mov --duration 10000 --tag event=collision"
1825
1759
  ],
1826
1760
  "flags": {
1827
1761
  "json": {
@@ -1879,24 +1813,30 @@
1879
1813
  "multiple": false,
1880
1814
  "type": "option"
1881
1815
  },
1882
- "keys": {
1883
- "char": "k",
1884
- "description": "Comma-separated list of key names (1-1000 keys, max 255 chars each)",
1885
- "name": "keys",
1816
+ "url": {
1817
+ "char": "u",
1818
+ "description": "Video URL (must be http:// or https://)",
1819
+ "name": "url",
1886
1820
  "required": true,
1887
1821
  "hasDynamicHelp": false,
1888
1822
  "multiple": false,
1889
1823
  "type": "option"
1890
1824
  },
1891
- "values": {
1892
- "char": "v",
1893
- "description": "Comma-separated list of boolean values (true/false, must match key count)",
1894
- "name": "values",
1825
+ "duration": {
1826
+ "description": "Video duration in milliseconds (required)",
1827
+ "name": "duration",
1895
1828
  "required": true,
1896
1829
  "hasDynamicHelp": false,
1897
1830
  "multiple": false,
1898
1831
  "type": "option"
1899
1832
  },
1833
+ "size": {
1834
+ "description": "Video size in bytes (optional)",
1835
+ "name": "size",
1836
+ "hasDynamicHelp": false,
1837
+ "multiple": false,
1838
+ "type": "option"
1839
+ },
1900
1840
  "tag": {
1901
1841
  "char": "t",
1902
1842
  "description": "Tag as key=value where both are strings (can be specified multiple times)",
@@ -1915,29 +1855,28 @@
1915
1855
  },
1916
1856
  "hasDynamicHelp": false,
1917
1857
  "hiddenAliases": [],
1918
- "id": "ingest:bitset",
1858
+ "id": "ingest:video",
1919
1859
  "pluginAlias": "@formant/formant-cli",
1920
1860
  "pluginName": "@formant/formant-cli",
1921
1861
  "pluginType": "core",
1922
1862
  "strict": true,
1923
- "summary": "Ingest bitset data",
1863
+ "summary": "Ingest video data",
1924
1864
  "enableJsonFlag": true,
1925
1865
  "isESM": true,
1926
1866
  "relativePath": [
1927
1867
  "dist",
1928
1868
  "commands",
1929
1869
  "ingest",
1930
- "bitset.js"
1870
+ "video.js"
1931
1871
  ]
1932
1872
  },
1933
- "ingest:health": {
1873
+ "org:get": {
1934
1874
  "aliases": [],
1935
1875
  "args": {},
1936
- "description": "Ingest a health status data point to a device stream.\n\nSends device health status information to the specified stream. Health data consists of:\n- status: One of \"unknown\", \"operational\", \"offline\", or \"error\"\n- clockSkewMs (optional): Clock skew in milliseconds between device and server\n\nHealth streams are used to track device operational state, system health, and time synchronization.",
1876
+ "description": "Get information about your organization.\n\nDisplays the organization associated with your authenticated account.\nNo ID is needed — it is resolved automatically from your credentials.",
1937
1877
  "examples": [
1938
- "<%= config.bin %> ingest health --device <device-id> --stream system_health --status operational",
1939
- "<%= config.bin %> ingest health --device <device-id> --stream health --status error --tag component=motor",
1940
- "<%= config.bin %> ingest health --device <device-id> --stream sync --status operational --clock-skew 150"
1878
+ "<%= config.bin %> org get",
1879
+ "<%= config.bin %> org get --json"
1941
1880
  ],
1942
1881
  "flags": {
1943
1882
  "json": {
@@ -1976,87 +1915,34 @@
1976
1915
  "name": "toon",
1977
1916
  "allowNo": false,
1978
1917
  "type": "boolean"
1979
- },
1980
- "device": {
1981
- "char": "d",
1982
- "description": "Device ID (UUID)",
1983
- "name": "device",
1984
- "required": true,
1985
- "hasDynamicHelp": false,
1986
- "multiple": false,
1987
- "type": "option"
1988
- },
1989
- "stream": {
1990
- "char": "s",
1991
- "description": "Stream name",
1992
- "name": "stream",
1993
- "required": true,
1994
- "hasDynamicHelp": false,
1995
- "multiple": false,
1996
- "type": "option"
1997
- },
1998
- "status": {
1999
- "description": "Health status (unknown, operational, offline, or error)",
2000
- "name": "status",
2001
- "required": true,
2002
- "hasDynamicHelp": false,
2003
- "multiple": false,
2004
- "options": [
2005
- "unknown",
2006
- "operational",
2007
- "offline",
2008
- "error"
2009
- ],
2010
- "type": "option"
2011
- },
2012
- "clock-skew": {
2013
- "description": "Clock skew in milliseconds (optional)",
2014
- "name": "clock-skew",
2015
- "hasDynamicHelp": false,
2016
- "multiple": false,
2017
- "type": "option"
2018
- },
2019
- "tag": {
2020
- "char": "t",
2021
- "description": "Tag as key=value where both are strings (can be specified multiple times)",
2022
- "name": "tag",
2023
- "hasDynamicHelp": false,
2024
- "multiple": true,
2025
- "type": "option"
2026
- },
2027
- "timestamp": {
2028
- "description": "Unix timestamp in milliseconds (defaults to now)",
2029
- "name": "timestamp",
2030
- "hasDynamicHelp": false,
2031
- "multiple": false,
2032
- "type": "option"
2033
1918
  }
2034
1919
  },
2035
1920
  "hasDynamicHelp": false,
2036
1921
  "hiddenAliases": [],
2037
- "id": "ingest:health",
1922
+ "id": "org:get",
2038
1923
  "pluginAlias": "@formant/formant-cli",
2039
1924
  "pluginName": "@formant/formant-cli",
2040
1925
  "pluginType": "core",
2041
1926
  "strict": true,
2042
- "summary": "Ingest health status data",
1927
+ "summary": "Get your organization",
2043
1928
  "enableJsonFlag": true,
2044
1929
  "isESM": true,
2045
1930
  "relativePath": [
2046
1931
  "dist",
2047
1932
  "commands",
2048
- "ingest",
2049
- "health.js"
1933
+ "org",
1934
+ "get.js"
2050
1935
  ]
2051
1936
  },
2052
- "ingest:image": {
1937
+ "org:update": {
2053
1938
  "aliases": [],
2054
1939
  "args": {},
2055
- "description": "Ingest an image URL to a device stream.\n\nSends an image reference (by URL) to the specified device stream. The image must be accessible\nvia HTTP/HTTPS. Formant will fetch and store the image from the provided URL.\n\nImage streams are used for camera feeds, snapshots, diagnostic images, etc.",
1940
+ "description": "Update your organization's details.\n\nAt least one of --name or --description must be provided.",
2056
1941
  "examples": [
2057
- "<%= config.bin %> ingest image --device <device-id> --stream camera_front --url https://example.com/image.jpg",
2058
- "<%= config.bin %> ingest image --device <device-id> --stream snapshot --url https://example.com/snap.png --size 1024000",
2059
- "<%= config.bin %> ingest image --device <device-id> --stream detection --url https://example.com/detect.jpg --tag frame=123"
1942
+ "<%= config.bin %> org update --name \"My Fleet\"",
1943
+ "<%= config.bin %> org update --description \"Production robot fleet\"",
1944
+ "<%= config.bin %> org update --name \"My Fleet\" --description \"Production robot fleet\"",
1945
+ "<%= config.bin %> org update --name \"My Fleet\" --json"
2060
1946
  ],
2061
1947
  "flags": {
2062
1948
  "json": {
@@ -2096,51 +1982,18 @@
2096
1982
  "allowNo": false,
2097
1983
  "type": "boolean"
2098
1984
  },
2099
- "device": {
1985
+ "description": {
2100
1986
  "char": "d",
2101
- "description": "Device ID (UUID)",
2102
- "name": "device",
2103
- "required": true,
2104
- "hasDynamicHelp": false,
2105
- "multiple": false,
2106
- "type": "option"
2107
- },
2108
- "stream": {
2109
- "char": "s",
2110
- "description": "Stream name",
2111
- "name": "stream",
2112
- "required": true,
2113
- "hasDynamicHelp": false,
2114
- "multiple": false,
2115
- "type": "option"
2116
- },
2117
- "url": {
2118
- "char": "u",
2119
- "description": "Image URL (must be http:// or https://)",
2120
- "name": "url",
2121
- "required": true,
2122
- "hasDynamicHelp": false,
2123
- "multiple": false,
2124
- "type": "option"
2125
- },
2126
- "size": {
2127
- "description": "Image size in bytes (optional)",
2128
- "name": "size",
1987
+ "description": "New description for the organization",
1988
+ "name": "description",
2129
1989
  "hasDynamicHelp": false,
2130
1990
  "multiple": false,
2131
1991
  "type": "option"
2132
1992
  },
2133
- "tag": {
2134
- "char": "t",
2135
- "description": "Tag as key=value where both are strings (can be specified multiple times)",
2136
- "name": "tag",
2137
- "hasDynamicHelp": false,
2138
- "multiple": true,
2139
- "type": "option"
2140
- },
2141
- "timestamp": {
2142
- "description": "Unix timestamp in milliseconds (defaults to now)",
2143
- "name": "timestamp",
1993
+ "name": {
1994
+ "char": "n",
1995
+ "description": "New name for the organization",
1996
+ "name": "name",
2144
1997
  "hasDynamicHelp": false,
2145
1998
  "multiple": false,
2146
1999
  "type": "option"
@@ -2148,35 +2001,34 @@
2148
2001
  },
2149
2002
  "hasDynamicHelp": false,
2150
2003
  "hiddenAliases": [],
2151
- "id": "ingest:image",
2004
+ "id": "org:update",
2152
2005
  "pluginAlias": "@formant/formant-cli",
2153
2006
  "pluginName": "@formant/formant-cli",
2154
2007
  "pluginType": "core",
2155
2008
  "strict": true,
2156
- "summary": "Ingest image data",
2009
+ "summary": "Update your organization",
2157
2010
  "enableJsonFlag": true,
2158
2011
  "isESM": true,
2159
2012
  "relativePath": [
2160
2013
  "dist",
2161
2014
  "commands",
2162
- "ingest",
2163
- "image.js"
2015
+ "org",
2016
+ "update.js"
2164
2017
  ]
2165
2018
  },
2166
- "ingest:json": {
2019
+ "kv:get": {
2167
2020
  "aliases": [],
2168
2021
  "args": {
2169
- "value": {
2170
- "description": "JSON value to ingest (as a JSON string)",
2171
- "name": "value",
2022
+ "key": {
2023
+ "description": "Key to retrieve",
2024
+ "name": "key",
2172
2025
  "required": true
2173
2026
  }
2174
2027
  },
2175
- "description": "Ingest a JSON data point to a device stream.\n\nSends structured JSON data to the specified device stream. The value must be valid JSON.\nJSON streams are used for complex structured data like configuration objects, state machines,\nnested telemetry, etc.\n\nNote: The JSON is sent as a JSON-encoded string to Formant.",
2028
+ "description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
2176
2029
  "examples": [
2177
- "<%= config.bin %> ingest json '{\"x\":1,\"y\":2}' --device <device-id> --stream position",
2178
- "<%= config.bin %> ingest json '{\"status\":\"active\",\"mode\":\"auto\"}' --device <device-id> --stream config",
2179
- "<%= config.bin %> ingest json '[1,2,3,4,5]' --device <device-id> --stream array_data"
2030
+ "<%= config.bin %> kv get my-key",
2031
+ "<%= config.bin %> kv get my-key --json"
2180
2032
  ],
2181
2033
  "flags": {
2182
2034
  "json": {
@@ -2215,36 +2067,85 @@
2215
2067
  "name": "toon",
2216
2068
  "allowNo": false,
2217
2069
  "type": "boolean"
2070
+ }
2071
+ },
2072
+ "hasDynamicHelp": false,
2073
+ "hiddenAliases": [],
2074
+ "id": "kv:get",
2075
+ "pluginAlias": "@formant/formant-cli",
2076
+ "pluginName": "@formant/formant-cli",
2077
+ "pluginType": "core",
2078
+ "strict": true,
2079
+ "summary": "Get key-value",
2080
+ "enableJsonFlag": true,
2081
+ "isESM": true,
2082
+ "relativePath": [
2083
+ "dist",
2084
+ "commands",
2085
+ "kv",
2086
+ "get.js"
2087
+ ]
2088
+ },
2089
+ "kv:list": {
2090
+ "aliases": [],
2091
+ "args": {},
2092
+ "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.",
2093
+ "examples": [
2094
+ "<%= config.bin %> kv list",
2095
+ "<%= config.bin %> kv list --prefix config",
2096
+ "<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
2097
+ "<%= config.bin %> kv list --json"
2098
+ ],
2099
+ "flags": {
2100
+ "json": {
2101
+ "description": "Format output as json.",
2102
+ "helpGroup": "GLOBAL",
2103
+ "name": "json",
2104
+ "allowNo": false,
2105
+ "type": "boolean"
2218
2106
  },
2219
- "device": {
2220
- "char": "d",
2221
- "description": "Device ID (UUID)",
2222
- "name": "device",
2223
- "required": true,
2224
- "hasDynamicHelp": false,
2225
- "multiple": false,
2226
- "type": "option"
2107
+ "dev": {
2108
+ "description": "Target the dev environment",
2109
+ "exclusive": [
2110
+ "stage"
2111
+ ],
2112
+ "helpGroup": "GLOBAL",
2113
+ "name": "dev",
2114
+ "allowNo": false,
2115
+ "type": "boolean"
2227
2116
  },
2228
- "stream": {
2229
- "char": "s",
2230
- "description": "Stream name",
2231
- "name": "stream",
2232
- "required": true,
2233
- "hasDynamicHelp": false,
2234
- "multiple": false,
2235
- "type": "option"
2117
+ "stage": {
2118
+ "description": "Target the stage environment",
2119
+ "exclusive": [
2120
+ "dev"
2121
+ ],
2122
+ "helpGroup": "GLOBAL",
2123
+ "name": "stage",
2124
+ "allowNo": false,
2125
+ "type": "boolean"
2236
2126
  },
2237
- "tag": {
2238
- "char": "t",
2239
- "description": "Tag as key=value where both are strings (can be specified multiple times)",
2240
- "name": "tag",
2127
+ "toon": {
2128
+ "description": "Output data in TOON (Token-Oriented Object Notation) format",
2129
+ "exclusive": [
2130
+ "json"
2131
+ ],
2132
+ "helpGroup": "GLOBAL",
2133
+ "name": "toon",
2134
+ "allowNo": false,
2135
+ "type": "boolean"
2136
+ },
2137
+ "keys": {
2138
+ "char": "k",
2139
+ "description": "Specific keys to query (can be specified multiple times)",
2140
+ "name": "keys",
2241
2141
  "hasDynamicHelp": false,
2242
2142
  "multiple": true,
2243
2143
  "type": "option"
2244
2144
  },
2245
- "timestamp": {
2246
- "description": "Unix timestamp in milliseconds (defaults to now)",
2247
- "name": "timestamp",
2145
+ "prefix": {
2146
+ "char": "p",
2147
+ "description": "Filter keys by prefix",
2148
+ "name": "prefix",
2248
2149
  "hasDynamicHelp": false,
2249
2150
  "multiple": false,
2250
2151
  "type": "option"
@@ -2252,35 +2153,39 @@
2252
2153
  },
2253
2154
  "hasDynamicHelp": false,
2254
2155
  "hiddenAliases": [],
2255
- "id": "ingest:json",
2156
+ "id": "kv:list",
2256
2157
  "pluginAlias": "@formant/formant-cli",
2257
2158
  "pluginName": "@formant/formant-cli",
2258
2159
  "pluginType": "core",
2259
2160
  "strict": true,
2260
- "summary": "Ingest JSON data",
2161
+ "summary": "List key-value keys",
2261
2162
  "enableJsonFlag": true,
2262
2163
  "isESM": true,
2263
2164
  "relativePath": [
2264
2165
  "dist",
2265
2166
  "commands",
2266
- "ingest",
2267
- "json.js"
2167
+ "kv",
2168
+ "list.js"
2268
2169
  ]
2269
2170
  },
2270
- "ingest:numeric": {
2171
+ "kv:set": {
2271
2172
  "aliases": [],
2272
2173
  "args": {
2174
+ "key": {
2175
+ "description": "Key to set",
2176
+ "name": "key",
2177
+ "required": true
2178
+ },
2273
2179
  "value": {
2274
- "description": "Numeric value to ingest",
2180
+ "description": "Value to store (JSON string)",
2275
2181
  "name": "value",
2276
2182
  "required": true
2277
2183
  }
2278
2184
  },
2279
- "description": "Ingest a numeric data point to a device stream.\n\nSends a single numeric value to the specified device stream. The value must be a valid number.\nNumeric streams are commonly used for sensor readings like battery level, temperature, speed, etc.",
2185
+ "description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
2280
2186
  "examples": [
2281
- "<%= config.bin %> ingest numeric 42.5 --device <device-id> --stream battery_level",
2282
- "<%= config.bin %> ingest numeric 98.6 --device <device-id> --stream temperature --tag unit=fahrenheit",
2283
- "<%= config.bin %> ingest numeric 1500 --device <device-id> --stream rpm --timestamp 1700000000000"
2187
+ "<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
2188
+ "<%= config.bin %> kv set config '{\"setting\": true}'"
2284
2189
  ],
2285
2190
  "flags": {
2286
2191
  "json": {
@@ -2319,72 +2224,33 @@
2319
2224
  "name": "toon",
2320
2225
  "allowNo": false,
2321
2226
  "type": "boolean"
2322
- },
2323
- "device": {
2324
- "char": "d",
2325
- "description": "Device ID (UUID)",
2326
- "name": "device",
2327
- "required": true,
2328
- "hasDynamicHelp": false,
2329
- "multiple": false,
2330
- "type": "option"
2331
- },
2332
- "stream": {
2333
- "char": "s",
2334
- "description": "Stream name",
2335
- "name": "stream",
2336
- "required": true,
2337
- "hasDynamicHelp": false,
2338
- "multiple": false,
2339
- "type": "option"
2340
- },
2341
- "tag": {
2342
- "char": "t",
2343
- "description": "Tag as key=value where both are strings (can be specified multiple times)",
2344
- "name": "tag",
2345
- "hasDynamicHelp": false,
2346
- "multiple": true,
2347
- "type": "option"
2348
- },
2349
- "timestamp": {
2350
- "description": "Unix timestamp in milliseconds (defaults to now)",
2351
- "name": "timestamp",
2352
- "hasDynamicHelp": false,
2353
- "multiple": false,
2354
- "type": "option"
2355
2227
  }
2356
2228
  },
2357
2229
  "hasDynamicHelp": false,
2358
2230
  "hiddenAliases": [],
2359
- "id": "ingest:numeric",
2231
+ "id": "kv:set",
2360
2232
  "pluginAlias": "@formant/formant-cli",
2361
2233
  "pluginName": "@formant/formant-cli",
2362
2234
  "pluginType": "core",
2363
2235
  "strict": true,
2364
- "summary": "Ingest numeric data",
2236
+ "summary": "Set key-value",
2365
2237
  "enableJsonFlag": true,
2366
2238
  "isESM": true,
2367
2239
  "relativePath": [
2368
2240
  "dist",
2369
2241
  "commands",
2370
- "ingest",
2371
- "numeric.js"
2242
+ "kv",
2243
+ "set.js"
2372
2244
  ]
2373
2245
  },
2374
- "ingest:text": {
2246
+ "investigation:analytics": {
2375
2247
  "aliases": [],
2376
- "args": {
2377
- "value": {
2378
- "description": "Text value to ingest",
2379
- "name": "value",
2380
- "required": true
2381
- }
2382
- },
2383
- "description": "Ingest a text data point to a device stream.\n\nSends a single text/string value to the specified device stream. Text streams are commonly\nused for logs, status messages, error messages, and other string data.",
2248
+ "args": {},
2249
+ "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.",
2384
2250
  "examples": [
2385
- "<%= config.bin %> ingest text \"Robot started successfully\" --device <device-id> --stream status",
2386
- "<%= config.bin %> ingest text \"Error: sensor offline\" --device <device-id> --stream errors --tag severity=high",
2387
- "<%= config.bin %> ingest text \"Checkpoint A reached\" --device <device-id> --stream waypoints"
2251
+ "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01",
2252
+ "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
2253
+ "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
2388
2254
  ],
2389
2255
  "flags": {
2390
2256
  "json": {
@@ -2424,35 +2290,41 @@
2424
2290
  "allowNo": false,
2425
2291
  "type": "boolean"
2426
2292
  },
2427
- "device": {
2428
- "char": "d",
2429
- "description": "Device ID (UUID)",
2430
- "name": "device",
2293
+ "end": {
2294
+ "description": "End time (ISO 8601)",
2295
+ "name": "end",
2431
2296
  "required": true,
2432
2297
  "hasDynamicHelp": false,
2433
2298
  "multiple": false,
2434
2299
  "type": "option"
2435
2300
  },
2436
- "stream": {
2437
- "char": "s",
2438
- "description": "Stream name",
2439
- "name": "stream",
2440
- "required": true,
2301
+ "group-by": {
2302
+ "description": "Group results by",
2303
+ "name": "group-by",
2441
2304
  "hasDynamicHelp": false,
2442
2305
  "multiple": false,
2306
+ "options": [
2307
+ "resultType",
2308
+ "signalType"
2309
+ ],
2443
2310
  "type": "option"
2444
2311
  },
2445
- "tag": {
2446
- "char": "t",
2447
- "description": "Tag as key=value where both are strings (can be specified multiple times)",
2448
- "name": "tag",
2312
+ "interval": {
2313
+ "description": "Time interval for aggregation",
2314
+ "name": "interval",
2315
+ "default": "daily",
2449
2316
  "hasDynamicHelp": false,
2450
- "multiple": true,
2317
+ "multiple": false,
2318
+ "options": [
2319
+ "daily",
2320
+ "hourly"
2321
+ ],
2451
2322
  "type": "option"
2452
2323
  },
2453
- "timestamp": {
2454
- "description": "Unix timestamp in milliseconds (defaults to now)",
2455
- "name": "timestamp",
2324
+ "start": {
2325
+ "description": "Start time (ISO 8601)",
2326
+ "name": "start",
2327
+ "required": true,
2456
2328
  "hasDynamicHelp": false,
2457
2329
  "multiple": false,
2458
2330
  "type": "option"
@@ -2460,29 +2332,34 @@
2460
2332
  },
2461
2333
  "hasDynamicHelp": false,
2462
2334
  "hiddenAliases": [],
2463
- "id": "ingest:text",
2335
+ "id": "investigation:analytics",
2464
2336
  "pluginAlias": "@formant/formant-cli",
2465
2337
  "pluginName": "@formant/formant-cli",
2466
2338
  "pluginType": "core",
2467
2339
  "strict": true,
2468
- "summary": "Ingest text data",
2340
+ "summary": "Get investigation analytics",
2469
2341
  "enableJsonFlag": true,
2470
2342
  "isESM": true,
2471
2343
  "relativePath": [
2472
2344
  "dist",
2473
2345
  "commands",
2474
- "ingest",
2475
- "text.js"
2346
+ "investigation",
2347
+ "analytics.js"
2476
2348
  ]
2477
2349
  },
2478
- "ingest:video": {
2350
+ "investigation:get": {
2479
2351
  "aliases": [],
2480
- "args": {},
2481
- "description": "Ingest a video URL to a device stream.\n\nSends a video reference (by URL) to the specified device stream. The video must be accessible\nvia HTTP/HTTPS. You must provide the video duration in milliseconds.\n\nVideo streams are used for recorded video clips, timelapse videos, event recordings, etc.\n\nThe MIME type is auto-detected from the file extension (.mp4, .webm, .mov).",
2352
+ "args": {
2353
+ "id": {
2354
+ "description": "Investigation (taskflow) ID",
2355
+ "name": "id",
2356
+ "required": true
2357
+ }
2358
+ },
2359
+ "description": "Get detailed information about a specific investigation by ID.",
2482
2360
  "examples": [
2483
- "<%= config.bin %> ingest video --device <device-id> --stream recordings --url https://example.com/video.mp4 --duration 5000",
2484
- "<%= config.bin %> ingest video --device <device-id> --stream clips --url https://example.com/clip.webm --duration 3500 --size 2048000",
2485
- "<%= config.bin %> ingest video --device <device-id> --stream event_video --url https://example.com/event.mov --duration 10000 --tag event=collision"
2361
+ "<%= config.bin %> investigation get <id>",
2362
+ "<%= config.bin %> investigation get <id> --json"
2486
2363
  ],
2487
2364
  "flags": {
2488
2365
  "json": {
@@ -2521,89 +2398,33 @@
2521
2398
  "name": "toon",
2522
2399
  "allowNo": false,
2523
2400
  "type": "boolean"
2524
- },
2525
- "device": {
2526
- "char": "d",
2527
- "description": "Device ID (UUID)",
2528
- "name": "device",
2529
- "required": true,
2530
- "hasDynamicHelp": false,
2531
- "multiple": false,
2532
- "type": "option"
2533
- },
2534
- "stream": {
2535
- "char": "s",
2536
- "description": "Stream name",
2537
- "name": "stream",
2538
- "required": true,
2539
- "hasDynamicHelp": false,
2540
- "multiple": false,
2541
- "type": "option"
2542
- },
2543
- "url": {
2544
- "char": "u",
2545
- "description": "Video URL (must be http:// or https://)",
2546
- "name": "url",
2547
- "required": true,
2548
- "hasDynamicHelp": false,
2549
- "multiple": false,
2550
- "type": "option"
2551
- },
2552
- "duration": {
2553
- "description": "Video duration in milliseconds (required)",
2554
- "name": "duration",
2555
- "required": true,
2556
- "hasDynamicHelp": false,
2557
- "multiple": false,
2558
- "type": "option"
2559
- },
2560
- "size": {
2561
- "description": "Video size in bytes (optional)",
2562
- "name": "size",
2563
- "hasDynamicHelp": false,
2564
- "multiple": false,
2565
- "type": "option"
2566
- },
2567
- "tag": {
2568
- "char": "t",
2569
- "description": "Tag as key=value where both are strings (can be specified multiple times)",
2570
- "name": "tag",
2571
- "hasDynamicHelp": false,
2572
- "multiple": true,
2573
- "type": "option"
2574
- },
2575
- "timestamp": {
2576
- "description": "Unix timestamp in milliseconds (defaults to now)",
2577
- "name": "timestamp",
2578
- "hasDynamicHelp": false,
2579
- "multiple": false,
2580
- "type": "option"
2581
2401
  }
2582
2402
  },
2583
2403
  "hasDynamicHelp": false,
2584
2404
  "hiddenAliases": [],
2585
- "id": "ingest:video",
2405
+ "id": "investigation:get",
2586
2406
  "pluginAlias": "@formant/formant-cli",
2587
2407
  "pluginName": "@formant/formant-cli",
2588
2408
  "pluginType": "core",
2589
2409
  "strict": true,
2590
- "summary": "Ingest video data",
2410
+ "summary": "Get an investigation by ID",
2591
2411
  "enableJsonFlag": true,
2592
2412
  "isESM": true,
2593
2413
  "relativePath": [
2594
2414
  "dist",
2595
2415
  "commands",
2596
- "ingest",
2597
- "video.js"
2416
+ "investigation",
2417
+ "get.js"
2598
2418
  ]
2599
2419
  },
2600
- "org:get": {
2420
+ "investigation:list": {
2601
2421
  "aliases": [],
2602
2422
  "args": {},
2603
- "description": "Get information about your organization.\n\nDisplays the organization associated with your authenticated account.\nNo ID is needed — it is resolved automatically from your credentials.",
2423
+ "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.",
2604
2424
  "examples": [
2605
- "<%= config.bin %> org get",
2606
- "<%= config.bin %> org get --json"
2425
+ "<%= config.bin %> investigation list",
2426
+ "<%= config.bin %> investigation list --signal-handler",
2427
+ "<%= config.bin %> investigation list --json"
2607
2428
  ],
2608
2429
  "flags": {
2609
2430
  "json": {
@@ -2642,34 +2463,50 @@
2642
2463
  "name": "toon",
2643
2464
  "allowNo": false,
2644
2465
  "type": "boolean"
2466
+ },
2467
+ "signal-handler": {
2468
+ "description": "Only show investigations that handle signals",
2469
+ "name": "signal-handler",
2470
+ "allowNo": false,
2471
+ "type": "boolean"
2645
2472
  }
2646
2473
  },
2647
2474
  "hasDynamicHelp": false,
2648
2475
  "hiddenAliases": [],
2649
- "id": "org:get",
2476
+ "id": "investigation:list",
2650
2477
  "pluginAlias": "@formant/formant-cli",
2651
2478
  "pluginName": "@formant/formant-cli",
2652
2479
  "pluginType": "core",
2653
2480
  "strict": true,
2654
- "summary": "Get your organization",
2481
+ "summary": "List investigations",
2655
2482
  "enableJsonFlag": true,
2656
2483
  "isESM": true,
2657
2484
  "relativePath": [
2658
2485
  "dist",
2659
2486
  "commands",
2660
- "org",
2661
- "get.js"
2487
+ "investigation",
2488
+ "list.js"
2662
2489
  ]
2663
2490
  },
2664
- "org:update": {
2491
+ "investigation:run": {
2665
2492
  "aliases": [],
2666
- "args": {},
2667
- "description": "Update your organization's details.\n\nAt least one of --name or --description must be provided.",
2668
- "examples": [
2669
- "<%= config.bin %> org update --name \"My Fleet\"",
2670
- "<%= config.bin %> org update --description \"Production robot fleet\"",
2671
- "<%= config.bin %> org update --name \"My Fleet\" --description \"Production robot fleet\"",
2672
- "<%= config.bin %> org update --name \"My Fleet\" --json"
2493
+ "args": {
2494
+ "investigationId": {
2495
+ "description": "Investigation (taskflow) ID",
2496
+ "name": "investigationId",
2497
+ "required": true
2498
+ },
2499
+ "runId": {
2500
+ "description": "Run ID",
2501
+ "name": "runId",
2502
+ "required": true
2503
+ }
2504
+ },
2505
+ "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.",
2506
+ "examples": [
2507
+ "<%= config.bin %> investigation run <investigation-id> <run-id>",
2508
+ "<%= config.bin %> investigation run <investigation-id> <run-id> --log-only",
2509
+ "<%= config.bin %> investigation run <investigation-id> <run-id> --json"
2673
2510
  ],
2674
2511
  "flags": {
2675
2512
  "json": {
@@ -2709,53 +2546,50 @@
2709
2546
  "allowNo": false,
2710
2547
  "type": "boolean"
2711
2548
  },
2712
- "description": {
2713
- "char": "d",
2714
- "description": "New description for the organization",
2715
- "name": "description",
2716
- "hasDynamicHelp": false,
2717
- "multiple": false,
2718
- "type": "option"
2549
+ "log-only": {
2550
+ "description": "Only show the execution log (skip run details)",
2551
+ "name": "log-only",
2552
+ "allowNo": false,
2553
+ "type": "boolean"
2719
2554
  },
2720
- "name": {
2721
- "char": "n",
2722
- "description": "New name for the organization",
2723
- "name": "name",
2724
- "hasDynamicHelp": false,
2725
- "multiple": false,
2726
- "type": "option"
2555
+ "trace-signal": {
2556
+ "description": "Fetch and display the signal and event information for this run",
2557
+ "name": "trace-signal",
2558
+ "allowNo": false,
2559
+ "type": "boolean"
2727
2560
  }
2728
2561
  },
2729
2562
  "hasDynamicHelp": false,
2730
2563
  "hiddenAliases": [],
2731
- "id": "org:update",
2564
+ "id": "investigation:run",
2732
2565
  "pluginAlias": "@formant/formant-cli",
2733
2566
  "pluginName": "@formant/formant-cli",
2734
2567
  "pluginType": "core",
2735
2568
  "strict": true,
2736
- "summary": "Update your organization",
2569
+ "summary": "Get investigation run details and execution log",
2737
2570
  "enableJsonFlag": true,
2738
2571
  "isESM": true,
2739
2572
  "relativePath": [
2740
2573
  "dist",
2741
2574
  "commands",
2742
- "org",
2743
- "update.js"
2575
+ "investigation",
2576
+ "run.js"
2744
2577
  ]
2745
2578
  },
2746
- "kv:get": {
2579
+ "investigation:runs-list": {
2747
2580
  "aliases": [],
2748
2581
  "args": {
2749
- "key": {
2750
- "description": "Key to retrieve",
2751
- "name": "key",
2582
+ "id": {
2583
+ "description": "Investigation (taskflow) ID",
2584
+ "name": "id",
2752
2585
  "required": true
2753
2586
  }
2754
2587
  },
2755
- "description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
2588
+ "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.",
2756
2589
  "examples": [
2757
- "<%= config.bin %> kv get my-key",
2758
- "<%= config.bin %> kv get my-key --json"
2590
+ "<%= config.bin %> investigation runs-list <id>",
2591
+ "<%= config.bin %> investigation runs-list <id> --limit 50",
2592
+ "<%= config.bin %> investigation runs-list <id> --details --json"
2759
2593
  ],
2760
2594
  "flags": {
2761
2595
  "json": {
@@ -2794,34 +2628,62 @@
2794
2628
  "name": "toon",
2795
2629
  "allowNo": false,
2796
2630
  "type": "boolean"
2631
+ },
2632
+ "details": {
2633
+ "description": "Include detailed information about each run",
2634
+ "name": "details",
2635
+ "allowNo": false,
2636
+ "type": "boolean"
2637
+ },
2638
+ "limit": {
2639
+ "char": "l",
2640
+ "description": "Maximum number of runs to return",
2641
+ "name": "limit",
2642
+ "default": 20,
2643
+ "hasDynamicHelp": false,
2644
+ "multiple": false,
2645
+ "type": "option"
2646
+ },
2647
+ "offset": {
2648
+ "char": "o",
2649
+ "description": "Offset for pagination",
2650
+ "name": "offset",
2651
+ "default": 0,
2652
+ "hasDynamicHelp": false,
2653
+ "multiple": false,
2654
+ "type": "option"
2797
2655
  }
2798
2656
  },
2799
2657
  "hasDynamicHelp": false,
2800
2658
  "hiddenAliases": [],
2801
- "id": "kv:get",
2659
+ "id": "investigation:runs-list",
2802
2660
  "pluginAlias": "@formant/formant-cli",
2803
2661
  "pluginName": "@formant/formant-cli",
2804
2662
  "pluginType": "core",
2805
2663
  "strict": true,
2806
- "summary": "Get key-value",
2664
+ "summary": "List actual investigation runs",
2807
2665
  "enableJsonFlag": true,
2808
2666
  "isESM": true,
2809
2667
  "relativePath": [
2810
2668
  "dist",
2811
2669
  "commands",
2812
- "kv",
2813
- "get.js"
2670
+ "investigation",
2671
+ "runs-list.js"
2814
2672
  ]
2815
2673
  },
2816
- "kv:list": {
2674
+ "investigation:runs": {
2817
2675
  "aliases": [],
2818
- "args": {},
2819
- "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.",
2676
+ "args": {
2677
+ "id": {
2678
+ "description": "Investigation (taskflow) ID",
2679
+ "name": "id",
2680
+ "required": true
2681
+ }
2682
+ },
2683
+ "description": "List evaluation runs for a specific investigation.",
2820
2684
  "examples": [
2821
- "<%= config.bin %> kv list",
2822
- "<%= config.bin %> kv list --prefix config",
2823
- "<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
2824
- "<%= config.bin %> kv list --json"
2685
+ "<%= config.bin %> investigation runs <id>",
2686
+ "<%= config.bin %> investigation runs <id> --json"
2825
2687
  ],
2826
2688
  "flags": {
2827
2689
  "json": {
@@ -2860,59 +2722,32 @@
2860
2722
  "name": "toon",
2861
2723
  "allowNo": false,
2862
2724
  "type": "boolean"
2863
- },
2864
- "keys": {
2865
- "char": "k",
2866
- "description": "Specific keys to query (can be specified multiple times)",
2867
- "name": "keys",
2868
- "hasDynamicHelp": false,
2869
- "multiple": true,
2870
- "type": "option"
2871
- },
2872
- "prefix": {
2873
- "char": "p",
2874
- "description": "Filter keys by prefix",
2875
- "name": "prefix",
2876
- "hasDynamicHelp": false,
2877
- "multiple": false,
2878
- "type": "option"
2879
2725
  }
2880
2726
  },
2881
2727
  "hasDynamicHelp": false,
2882
2728
  "hiddenAliases": [],
2883
- "id": "kv:list",
2729
+ "id": "investigation:runs",
2884
2730
  "pluginAlias": "@formant/formant-cli",
2885
2731
  "pluginName": "@formant/formant-cli",
2886
2732
  "pluginType": "core",
2887
2733
  "strict": true,
2888
- "summary": "List key-value keys",
2734
+ "summary": "List runs for an investigation",
2889
2735
  "enableJsonFlag": true,
2890
2736
  "isESM": true,
2891
2737
  "relativePath": [
2892
2738
  "dist",
2893
2739
  "commands",
2894
- "kv",
2895
- "list.js"
2740
+ "investigation",
2741
+ "runs.js"
2896
2742
  ]
2897
2743
  },
2898
- "kv:set": {
2744
+ "investigation:stats": {
2899
2745
  "aliases": [],
2900
- "args": {
2901
- "key": {
2902
- "description": "Key to set",
2903
- "name": "key",
2904
- "required": true
2905
- },
2906
- "value": {
2907
- "description": "Value to store (JSON string)",
2908
- "name": "value",
2909
- "required": true
2910
- }
2911
- },
2912
- "description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
2746
+ "args": {},
2747
+ "description": "Get investigation statistics for a time range.",
2913
2748
  "examples": [
2914
- "<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
2915
- "<%= config.bin %> kv set config '{\"setting\": true}'"
2749
+ "<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01",
2750
+ "<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01 --json"
2916
2751
  ],
2917
2752
  "flags": {
2918
2753
  "json": {
@@ -2951,33 +2786,54 @@
2951
2786
  "name": "toon",
2952
2787
  "allowNo": false,
2953
2788
  "type": "boolean"
2789
+ },
2790
+ "end": {
2791
+ "description": "End time (ISO 8601)",
2792
+ "name": "end",
2793
+ "required": true,
2794
+ "hasDynamicHelp": false,
2795
+ "multiple": false,
2796
+ "type": "option"
2797
+ },
2798
+ "start": {
2799
+ "description": "Start time (ISO 8601)",
2800
+ "name": "start",
2801
+ "required": true,
2802
+ "hasDynamicHelp": false,
2803
+ "multiple": false,
2804
+ "type": "option"
2954
2805
  }
2955
2806
  },
2956
2807
  "hasDynamicHelp": false,
2957
2808
  "hiddenAliases": [],
2958
- "id": "kv:set",
2809
+ "id": "investigation:stats",
2959
2810
  "pluginAlias": "@formant/formant-cli",
2960
2811
  "pluginName": "@formant/formant-cli",
2961
2812
  "pluginType": "core",
2962
2813
  "strict": true,
2963
- "summary": "Set key-value",
2814
+ "summary": "Get investigation stats",
2964
2815
  "enableJsonFlag": true,
2965
2816
  "isESM": true,
2966
2817
  "relativePath": [
2967
2818
  "dist",
2968
2819
  "commands",
2969
- "kv",
2970
- "set.js"
2820
+ "investigation",
2821
+ "stats.js"
2971
2822
  ]
2972
2823
  },
2973
- "investigation:analytics": {
2824
+ "investigation:trigger": {
2974
2825
  "aliases": [],
2975
- "args": {},
2976
- "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.",
2826
+ "args": {
2827
+ "id": {
2828
+ "description": "Investigation (taskflow) ID",
2829
+ "name": "id",
2830
+ "required": true
2831
+ }
2832
+ },
2833
+ "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.",
2977
2834
  "examples": [
2978
- "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01",
2979
- "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
2980
- "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
2835
+ "<%= config.bin %> investigation trigger <id> --input \"Robot stopped responding\"",
2836
+ "<%= config.bin %> investigation trigger <id> --input \"Battery draining fast on device X\" --json"
2981
2837
  ],
2982
2838
  "flags": {
2983
2839
  "json": {
@@ -3017,41 +2873,18 @@
3017
2873
  "allowNo": false,
3018
2874
  "type": "boolean"
3019
2875
  },
3020
- "end": {
3021
- "description": "End time (ISO 8601)",
3022
- "name": "end",
2876
+ "input": {
2877
+ "char": "i",
2878
+ "description": "Input text / problem description for the investigation",
2879
+ "name": "input",
3023
2880
  "required": true,
3024
2881
  "hasDynamicHelp": false,
3025
2882
  "multiple": false,
3026
2883
  "type": "option"
3027
2884
  },
3028
- "group-by": {
3029
- "description": "Group results by",
3030
- "name": "group-by",
3031
- "hasDynamicHelp": false,
3032
- "multiple": false,
3033
- "options": [
3034
- "resultType",
3035
- "signalType"
3036
- ],
3037
- "type": "option"
3038
- },
3039
- "interval": {
3040
- "description": "Time interval for aggregation",
3041
- "name": "interval",
3042
- "default": "daily",
3043
- "hasDynamicHelp": false,
3044
- "multiple": false,
3045
- "options": [
3046
- "daily",
3047
- "hourly"
3048
- ],
3049
- "type": "option"
3050
- },
3051
- "start": {
3052
- "description": "Start time (ISO 8601)",
3053
- "name": "start",
3054
- "required": true,
2885
+ "signal-id": {
2886
+ "description": "Optional signal ID to associate with this run",
2887
+ "name": "signal-id",
3055
2888
  "hasDynamicHelp": false,
3056
2889
  "multiple": false,
3057
2890
  "type": "option"
@@ -3059,34 +2892,40 @@
3059
2892
  },
3060
2893
  "hasDynamicHelp": false,
3061
2894
  "hiddenAliases": [],
3062
- "id": "investigation:analytics",
2895
+ "id": "investigation:trigger",
3063
2896
  "pluginAlias": "@formant/formant-cli",
3064
2897
  "pluginName": "@formant/formant-cli",
3065
2898
  "pluginType": "core",
3066
2899
  "strict": true,
3067
- "summary": "Get investigation analytics",
2900
+ "summary": "Trigger an investigation",
3068
2901
  "enableJsonFlag": true,
3069
2902
  "isESM": true,
3070
2903
  "relativePath": [
3071
2904
  "dist",
3072
2905
  "commands",
3073
2906
  "investigation",
3074
- "analytics.js"
2907
+ "trigger.js"
3075
2908
  ]
3076
2909
  },
3077
- "investigation:get": {
2910
+ "persona:delegate-task": {
3078
2911
  "aliases": [],
3079
2912
  "args": {
3080
2913
  "id": {
3081
- "description": "Investigation (taskflow) ID",
2914
+ "description": "Persona ID (UUID)",
3082
2915
  "name": "id",
3083
2916
  "required": true
2917
+ },
2918
+ "goal": {
2919
+ "description": "The task goal / instruction for the persona",
2920
+ "name": "goal",
2921
+ "required": true
3084
2922
  }
3085
2923
  },
3086
- "description": "Get detailed information about a specific investigation by ID.",
2924
+ "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\".",
3087
2925
  "examples": [
3088
- "<%= config.bin %> investigation get <id>",
3089
- "<%= config.bin %> investigation get <id> --json"
2926
+ "<%= config.bin %> persona delegate-task <persona-id> \"Analyze recent device failures and summarize findings\"",
2927
+ "<%= config.bin %> persona delegate-task <persona-id> \"Generate a daily report of fleet health\" --name \"Daily Fleet Report\"",
2928
+ "<%= config.bin %> persona delegate-task <persona-id> \"Check all offline devices\" --dev"
3090
2929
  ],
3091
2930
  "flags": {
3092
2931
  "json": {
@@ -3125,33 +2964,47 @@
3125
2964
  "name": "toon",
3126
2965
  "allowNo": false,
3127
2966
  "type": "boolean"
2967
+ },
2968
+ "name": {
2969
+ "char": "n",
2970
+ "description": "Task name (defaults to first 50 chars of goal)",
2971
+ "name": "name",
2972
+ "hasDynamicHelp": false,
2973
+ "multiple": false,
2974
+ "type": "option"
3128
2975
  }
3129
2976
  },
3130
2977
  "hasDynamicHelp": false,
3131
2978
  "hiddenAliases": [],
3132
- "id": "investigation:get",
2979
+ "id": "persona:delegate-task",
3133
2980
  "pluginAlias": "@formant/formant-cli",
3134
2981
  "pluginName": "@formant/formant-cli",
3135
2982
  "pluginType": "core",
3136
2983
  "strict": true,
3137
- "summary": "Get an investigation by ID",
2984
+ "summary": "Delegate an async task to a persona",
3138
2985
  "enableJsonFlag": true,
3139
2986
  "isESM": true,
3140
2987
  "relativePath": [
3141
2988
  "dist",
3142
2989
  "commands",
3143
- "investigation",
3144
- "get.js"
2990
+ "persona",
2991
+ "delegate-task.js"
3145
2992
  ]
3146
2993
  },
3147
- "investigation:list": {
2994
+ "persona:get": {
3148
2995
  "aliases": [],
3149
- "args": {},
3150
- "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.",
2996
+ "args": {
2997
+ "id": {
2998
+ "description": "Persona ID (UUID)",
2999
+ "name": "id",
3000
+ "required": true
3001
+ }
3002
+ },
3003
+ "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.",
3151
3004
  "examples": [
3152
- "<%= config.bin %> investigation list",
3153
- "<%= config.bin %> investigation list --signal-handler",
3154
- "<%= config.bin %> investigation list --json"
3005
+ "<%= config.bin %> personas get <persona-id>",
3006
+ "<%= config.bin %> personas get <persona-id> --json",
3007
+ "<%= config.bin %> personas get <persona-id> --dev"
3155
3008
  ],
3156
3009
  "flags": {
3157
3010
  "json": {
@@ -3190,50 +3043,33 @@
3190
3043
  "name": "toon",
3191
3044
  "allowNo": false,
3192
3045
  "type": "boolean"
3193
- },
3194
- "signal-handler": {
3195
- "description": "Only show investigations that handle signals",
3196
- "name": "signal-handler",
3197
- "allowNo": false,
3198
- "type": "boolean"
3199
3046
  }
3200
3047
  },
3201
3048
  "hasDynamicHelp": false,
3202
3049
  "hiddenAliases": [],
3203
- "id": "investigation:list",
3050
+ "id": "persona:get",
3204
3051
  "pluginAlias": "@formant/formant-cli",
3205
3052
  "pluginName": "@formant/formant-cli",
3206
3053
  "pluginType": "core",
3207
3054
  "strict": true,
3208
- "summary": "List investigations",
3055
+ "summary": "Get persona details and tools",
3209
3056
  "enableJsonFlag": true,
3210
3057
  "isESM": true,
3211
3058
  "relativePath": [
3212
3059
  "dist",
3213
3060
  "commands",
3214
- "investigation",
3215
- "list.js"
3061
+ "persona",
3062
+ "get.js"
3216
3063
  ]
3217
3064
  },
3218
- "investigation:run": {
3065
+ "persona:list": {
3219
3066
  "aliases": [],
3220
- "args": {
3221
- "investigationId": {
3222
- "description": "Investigation (taskflow) ID",
3223
- "name": "investigationId",
3224
- "required": true
3225
- },
3226
- "runId": {
3227
- "description": "Run ID",
3228
- "name": "runId",
3229
- "required": true
3230
- }
3231
- },
3232
- "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.",
3067
+ "args": {},
3068
+ "description": "List AI personas available in your organization.\n\nShows both built-in and custom personas with their ID, name, and description.",
3233
3069
  "examples": [
3234
- "<%= config.bin %> investigation run <investigation-id> <run-id>",
3235
- "<%= config.bin %> investigation run <investigation-id> <run-id> --log-only",
3236
- "<%= config.bin %> investigation run <investigation-id> <run-id> --json"
3070
+ "<%= config.bin %> personas list",
3071
+ "<%= config.bin %> personas list --json",
3072
+ "<%= config.bin %> personas list --dev"
3237
3073
  ],
3238
3074
  "flags": {
3239
3075
  "json": {
@@ -3272,51 +3108,39 @@
3272
3108
  "name": "toon",
3273
3109
  "allowNo": false,
3274
3110
  "type": "boolean"
3275
- },
3276
- "log-only": {
3277
- "description": "Only show the execution log (skip run details)",
3278
- "name": "log-only",
3279
- "allowNo": false,
3280
- "type": "boolean"
3281
- },
3282
- "trace-signal": {
3283
- "description": "Fetch and display the signal and event information for this run",
3284
- "name": "trace-signal",
3285
- "allowNo": false,
3286
- "type": "boolean"
3287
3111
  }
3288
3112
  },
3289
3113
  "hasDynamicHelp": false,
3290
3114
  "hiddenAliases": [],
3291
- "id": "investigation:run",
3115
+ "id": "persona:list",
3292
3116
  "pluginAlias": "@formant/formant-cli",
3293
3117
  "pluginName": "@formant/formant-cli",
3294
3118
  "pluginType": "core",
3295
3119
  "strict": true,
3296
- "summary": "Get investigation run details and execution log",
3120
+ "summary": "List AI personas",
3297
3121
  "enableJsonFlag": true,
3298
3122
  "isESM": true,
3299
3123
  "relativePath": [
3300
3124
  "dist",
3301
3125
  "commands",
3302
- "investigation",
3303
- "run.js"
3126
+ "persona",
3127
+ "list.js"
3304
3128
  ]
3305
3129
  },
3306
- "investigation:runs-list": {
3130
+ "persona:task-status": {
3307
3131
  "aliases": [],
3308
3132
  "args": {
3309
- "id": {
3310
- "description": "Investigation (taskflow) ID",
3311
- "name": "id",
3133
+ "taskId": {
3134
+ "description": "Task ID (from delegate-task output)",
3135
+ "name": "taskId",
3312
3136
  "required": true
3313
3137
  }
3314
3138
  },
3315
- "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.",
3139
+ "description": "Check the status and results of a delegated task.\n\nShows all runs for a task including their status, result summary, and timestamps.",
3316
3140
  "examples": [
3317
- "<%= config.bin %> investigation runs-list <id>",
3318
- "<%= config.bin %> investigation runs-list <id> --limit 50",
3319
- "<%= config.bin %> investigation runs-list <id> --details --json"
3141
+ "<%= config.bin %> persona task-status <task-id>",
3142
+ "<%= config.bin %> persona task-status <task-id> --json",
3143
+ "<%= config.bin %> persona task-status <task-id> --dev"
3320
3144
  ],
3321
3145
  "flags": {
3322
3146
  "json": {
@@ -3355,62 +3179,38 @@
3355
3179
  "name": "toon",
3356
3180
  "allowNo": false,
3357
3181
  "type": "boolean"
3358
- },
3359
- "details": {
3360
- "description": "Include detailed information about each run",
3361
- "name": "details",
3362
- "allowNo": false,
3363
- "type": "boolean"
3364
- },
3365
- "limit": {
3366
- "char": "l",
3367
- "description": "Maximum number of runs to return",
3368
- "name": "limit",
3369
- "default": 20,
3370
- "hasDynamicHelp": false,
3371
- "multiple": false,
3372
- "type": "option"
3373
- },
3374
- "offset": {
3375
- "char": "o",
3376
- "description": "Offset for pagination",
3377
- "name": "offset",
3378
- "default": 0,
3379
- "hasDynamicHelp": false,
3380
- "multiple": false,
3381
- "type": "option"
3382
3182
  }
3383
3183
  },
3384
3184
  "hasDynamicHelp": false,
3385
3185
  "hiddenAliases": [],
3386
- "id": "investigation:runs-list",
3186
+ "id": "persona:task-status",
3387
3187
  "pluginAlias": "@formant/formant-cli",
3388
3188
  "pluginName": "@formant/formant-cli",
3389
3189
  "pluginType": "core",
3390
3190
  "strict": true,
3391
- "summary": "List actual investigation runs",
3191
+ "summary": "Check status of a delegated task",
3392
3192
  "enableJsonFlag": true,
3393
3193
  "isESM": true,
3394
3194
  "relativePath": [
3395
3195
  "dist",
3396
3196
  "commands",
3397
- "investigation",
3398
- "runs-list.js"
3197
+ "persona",
3198
+ "task-status.js"
3399
3199
  ]
3400
3200
  },
3401
- "investigation:runs": {
3201
+ "device:config": {
3402
3202
  "aliases": [],
3403
3203
  "args": {
3404
3204
  "id": {
3405
- "description": "Investigation (taskflow) ID",
3205
+ "description": "Device ID (UUID)",
3406
3206
  "name": "id",
3407
3207
  "required": true
3408
3208
  }
3409
3209
  },
3410
- "description": "List evaluation runs for a specific investigation.",
3210
+ "description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
3411
3211
  "examples": [
3412
- "<%= config.bin %> investigation runs <id>",
3413
- "<%= config.bin %> investigation runs <id> --json"
3212
+ "<%= config.bin %> device config <device-id>",
3213
+ "<%= config.bin %> device config <device-id> --json"
3414
3214
  ],
3415
3215
  "flags": {
3416
3216
  "json": {
@@ -3453,28 +3253,35 @@
3453
3253
  },
3454
3254
  "hasDynamicHelp": false,
3455
3255
  "hiddenAliases": [],
3456
- "id": "investigation:runs",
3256
+ "id": "device:config",
3457
3257
  "pluginAlias": "@formant/formant-cli",
3458
3258
  "pluginName": "@formant/formant-cli",
3459
3259
  "pluginType": "core",
3460
3260
  "strict": true,
3461
- "summary": "List runs for an investigation",
3261
+ "summary": "Get device configuration",
3462
3262
  "enableJsonFlag": true,
3463
3263
  "isESM": true,
3464
3264
  "relativePath": [
3465
3265
  "dist",
3466
3266
  "commands",
3467
- "investigation",
3468
- "runs.js"
3267
+ "device",
3268
+ "config.js"
3469
3269
  ]
3470
3270
  },
3471
- "investigation:stats": {
3271
+ "device:create": {
3472
3272
  "aliases": [],
3473
- "args": {},
3474
- "description": "Get investigation statistics for a time range.",
3273
+ "args": {
3274
+ "name": {
3275
+ "description": "Name for the new device",
3276
+ "name": "name",
3277
+ "required": true
3278
+ }
3279
+ },
3280
+ "description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
3475
3281
  "examples": [
3476
- "<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01",
3477
- "<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01 --json"
3282
+ "<%= config.bin %> device create my-robot",
3283
+ "<%= config.bin %> device create my-robot --tag location=warehouse --tag env=prod",
3284
+ "<%= config.bin %> device create my-robot --json"
3478
3285
  ],
3479
3286
  "flags": {
3480
3287
  "json": {
@@ -3514,53 +3321,45 @@
3514
3321
  "allowNo": false,
3515
3322
  "type": "boolean"
3516
3323
  },
3517
- "end": {
3518
- "description": "End time (ISO 8601)",
3519
- "name": "end",
3520
- "required": true,
3521
- "hasDynamicHelp": false,
3522
- "multiple": false,
3523
- "type": "option"
3524
- },
3525
- "start": {
3526
- "description": "Start time (ISO 8601)",
3527
- "name": "start",
3528
- "required": true,
3324
+ "tag": {
3325
+ "char": "t",
3326
+ "description": "Tag to apply (key=value), can be specified multiple times",
3327
+ "name": "tag",
3529
3328
  "hasDynamicHelp": false,
3530
- "multiple": false,
3329
+ "multiple": true,
3531
3330
  "type": "option"
3532
3331
  }
3533
3332
  },
3534
3333
  "hasDynamicHelp": false,
3535
3334
  "hiddenAliases": [],
3536
- "id": "investigation:stats",
3335
+ "id": "device:create",
3537
3336
  "pluginAlias": "@formant/formant-cli",
3538
3337
  "pluginName": "@formant/formant-cli",
3539
3338
  "pluginType": "core",
3540
3339
  "strict": true,
3541
- "summary": "Get investigation stats",
3340
+ "summary": "Create a new device",
3542
3341
  "enableJsonFlag": true,
3543
3342
  "isESM": true,
3544
3343
  "relativePath": [
3545
3344
  "dist",
3546
3345
  "commands",
3547
- "investigation",
3548
- "stats.js"
3346
+ "device",
3347
+ "create.js"
3549
3348
  ]
3550
3349
  },
3551
- "investigation:trigger": {
3350
+ "device:delete": {
3552
3351
  "aliases": [],
3553
3352
  "args": {
3554
3353
  "id": {
3555
- "description": "Investigation (taskflow) ID",
3354
+ "description": "Device ID (UUID)",
3556
3355
  "name": "id",
3557
3356
  "required": true
3558
3357
  }
3559
3358
  },
3560
- "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.",
3359
+ "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.",
3561
3360
  "examples": [
3562
- "<%= config.bin %> investigation trigger <id> --input \"Robot stopped responding\"",
3563
- "<%= config.bin %> investigation trigger <id> --input \"Battery draining fast on device X\" --json"
3361
+ "<%= config.bin %> device delete <device-id>",
3362
+ "<%= config.bin %> device delete <device-id> --json"
3564
3363
  ],
3565
3364
  "flags": {
3566
3365
  "json": {
@@ -3599,60 +3398,38 @@
3599
3398
  "name": "toon",
3600
3399
  "allowNo": false,
3601
3400
  "type": "boolean"
3602
- },
3603
- "input": {
3604
- "char": "i",
3605
- "description": "Input text / problem description for the investigation",
3606
- "name": "input",
3607
- "required": true,
3608
- "hasDynamicHelp": false,
3609
- "multiple": false,
3610
- "type": "option"
3611
- },
3612
- "signal-id": {
3613
- "description": "Optional signal ID to associate with this run",
3614
- "name": "signal-id",
3615
- "hasDynamicHelp": false,
3616
- "multiple": false,
3617
- "type": "option"
3618
3401
  }
3619
3402
  },
3620
3403
  "hasDynamicHelp": false,
3621
3404
  "hiddenAliases": [],
3622
- "id": "investigation:trigger",
3405
+ "id": "device:delete",
3623
3406
  "pluginAlias": "@formant/formant-cli",
3624
3407
  "pluginName": "@formant/formant-cli",
3625
3408
  "pluginType": "core",
3626
3409
  "strict": true,
3627
- "summary": "Trigger an investigation",
3410
+ "summary": "Delete (disable) a device",
3628
3411
  "enableJsonFlag": true,
3629
3412
  "isESM": true,
3630
3413
  "relativePath": [
3631
3414
  "dist",
3632
3415
  "commands",
3633
- "investigation",
3634
- "trigger.js"
3416
+ "device",
3417
+ "delete.js"
3635
3418
  ]
3636
3419
  },
3637
- "persona:delegate-task": {
3420
+ "device:get": {
3638
3421
  "aliases": [],
3639
3422
  "args": {
3640
3423
  "id": {
3641
- "description": "Persona ID (UUID)",
3424
+ "description": "Device ID (UUID)",
3642
3425
  "name": "id",
3643
3426
  "required": true
3644
- },
3645
- "goal": {
3646
- "description": "The task goal / instruction for the persona",
3647
- "name": "goal",
3648
- "required": true
3649
3427
  }
3650
3428
  },
3651
- "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\".",
3429
+ "description": "Get detailed information about a specific device by its ID.",
3652
3430
  "examples": [
3653
- "<%= config.bin %> persona delegate-task <persona-id> \"Analyze recent device failures and summarize findings\"",
3654
- "<%= config.bin %> persona delegate-task <persona-id> \"Generate a daily report of fleet health\" --name \"Daily Fleet Report\"",
3655
- "<%= config.bin %> persona delegate-task <persona-id> \"Check all offline devices\" --dev"
3431
+ "<%= config.bin %> device get <device-id>",
3432
+ "<%= config.bin %> device get <device-id> --json"
3656
3433
  ],
3657
3434
  "flags": {
3658
3435
  "json": {
@@ -3691,47 +3468,38 @@
3691
3468
  "name": "toon",
3692
3469
  "allowNo": false,
3693
3470
  "type": "boolean"
3694
- },
3695
- "name": {
3696
- "char": "n",
3697
- "description": "Task name (defaults to first 50 chars of goal)",
3698
- "name": "name",
3699
- "hasDynamicHelp": false,
3700
- "multiple": false,
3701
- "type": "option"
3702
3471
  }
3703
3472
  },
3704
3473
  "hasDynamicHelp": false,
3705
3474
  "hiddenAliases": [],
3706
- "id": "persona:delegate-task",
3475
+ "id": "device:get",
3707
3476
  "pluginAlias": "@formant/formant-cli",
3708
3477
  "pluginName": "@formant/formant-cli",
3709
3478
  "pluginType": "core",
3710
3479
  "strict": true,
3711
- "summary": "Delegate an async task to a persona",
3480
+ "summary": "Get a device by ID",
3712
3481
  "enableJsonFlag": true,
3713
3482
  "isESM": true,
3714
3483
  "relativePath": [
3715
3484
  "dist",
3716
- "commands",
3717
- "persona",
3718
- "delegate-task.js"
3485
+ "commands",
3486
+ "device",
3487
+ "get.js"
3719
3488
  ]
3720
3489
  },
3721
- "persona:get": {
3490
+ "device:list": {
3722
3491
  "aliases": [],
3723
- "args": {
3724
- "id": {
3725
- "description": "Persona ID (UUID)",
3726
- "name": "id",
3727
- "required": true
3728
- }
3729
- },
3730
- "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.",
3492
+ "args": {},
3493
+ "description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --include-offline to include offline devices. Use --with-data to show only\ndevices that have ingested data. Each device is enriched with data-based last\nseen timestamp and datapoint count from analytics.",
3731
3494
  "examples": [
3732
- "<%= config.bin %> personas get <persona-id>",
3733
- "<%= config.bin %> personas get <persona-id> --json",
3734
- "<%= config.bin %> personas get <persona-id> --dev"
3495
+ "<%= config.bin %> device list",
3496
+ "<%= config.bin %> device list --include-offline",
3497
+ "<%= config.bin %> device list --with-data",
3498
+ "<%= config.bin %> device list --with-data --days 90",
3499
+ "<%= config.bin %> device list --include-offline --limit 100",
3500
+ "<%= config.bin %> device list --tag location=warehouse",
3501
+ "<%= config.bin %> device list --name robot --dev --json",
3502
+ "<%= config.bin %> device list --name mech-0 --name mech-1 --dev --toon"
3735
3503
  ],
3736
3504
  "flags": {
3737
3505
  "json": {
@@ -3770,33 +3538,90 @@
3770
3538
  "name": "toon",
3771
3539
  "allowNo": false,
3772
3540
  "type": "boolean"
3541
+ },
3542
+ "include-offline": {
3543
+ "char": "a",
3544
+ "description": "Include offline devices",
3545
+ "name": "include-offline",
3546
+ "allowNo": false,
3547
+ "type": "boolean"
3548
+ },
3549
+ "days": {
3550
+ "description": "How many days back to search for last seen data",
3551
+ "name": "days",
3552
+ "default": 30,
3553
+ "hasDynamicHelp": false,
3554
+ "multiple": false,
3555
+ "type": "option"
3556
+ },
3557
+ "limit": {
3558
+ "char": "l",
3559
+ "description": "Maximum number of devices to return",
3560
+ "name": "limit",
3561
+ "default": 50,
3562
+ "hasDynamicHelp": false,
3563
+ "multiple": false,
3564
+ "type": "option"
3565
+ },
3566
+ "name": {
3567
+ "char": "n",
3568
+ "description": "Filter devices by name (search), can be specified multiple times",
3569
+ "name": "name",
3570
+ "hasDynamicHelp": false,
3571
+ "multiple": true,
3572
+ "type": "option"
3573
+ },
3574
+ "with-data": {
3575
+ "char": "w",
3576
+ "description": "Only show devices that have data in the last --days window",
3577
+ "name": "with-data",
3578
+ "allowNo": false,
3579
+ "type": "boolean"
3580
+ },
3581
+ "tag": {
3582
+ "char": "t",
3583
+ "description": "Filter by tag (key=value), can be specified multiple times",
3584
+ "name": "tag",
3585
+ "hasDynamicHelp": false,
3586
+ "multiple": true,
3587
+ "type": "option"
3773
3588
  }
3774
3589
  },
3775
3590
  "hasDynamicHelp": false,
3776
3591
  "hiddenAliases": [],
3777
- "id": "persona:get",
3592
+ "id": "device:list",
3778
3593
  "pluginAlias": "@formant/formant-cli",
3779
3594
  "pluginName": "@formant/formant-cli",
3780
3595
  "pluginType": "core",
3781
3596
  "strict": true,
3782
- "summary": "Get persona details and tools",
3597
+ "summary": "List robots and sensors in your fleet",
3783
3598
  "enableJsonFlag": true,
3784
3599
  "isESM": true,
3785
3600
  "relativePath": [
3786
3601
  "dist",
3787
3602
  "commands",
3788
- "persona",
3789
- "get.js"
3603
+ "device",
3604
+ "list.js"
3790
3605
  ]
3791
3606
  },
3792
- "persona:list": {
3607
+ "device:rename": {
3793
3608
  "aliases": [],
3794
- "args": {},
3795
- "description": "List AI personas available in your organization.\n\nShows both built-in and custom personas with their ID, name, and description.",
3609
+ "args": {
3610
+ "id": {
3611
+ "description": "Device ID (UUID)",
3612
+ "name": "id",
3613
+ "required": true
3614
+ },
3615
+ "name": {
3616
+ "description": "New name for the device",
3617
+ "name": "name",
3618
+ "required": true
3619
+ }
3620
+ },
3621
+ "description": "Rename a device by updating its name.",
3796
3622
  "examples": [
3797
- "<%= config.bin %> personas list",
3798
- "<%= config.bin %> personas list --json",
3799
- "<%= config.bin %> personas list --dev"
3623
+ "<%= config.bin %> device rename <device-id> new-robot-name",
3624
+ "<%= config.bin %> device rename <device-id> new-robot-name --json"
3800
3625
  ],
3801
3626
  "flags": {
3802
3627
  "json": {
@@ -3839,35 +3664,36 @@
3839
3664
  },
3840
3665
  "hasDynamicHelp": false,
3841
3666
  "hiddenAliases": [],
3842
- "id": "persona:list",
3667
+ "id": "device:rename",
3843
3668
  "pluginAlias": "@formant/formant-cli",
3844
3669
  "pluginName": "@formant/formant-cli",
3845
3670
  "pluginType": "core",
3846
3671
  "strict": true,
3847
- "summary": "List AI personas",
3672
+ "summary": "Rename a device",
3848
3673
  "enableJsonFlag": true,
3849
3674
  "isESM": true,
3850
3675
  "relativePath": [
3851
3676
  "dist",
3852
3677
  "commands",
3853
- "persona",
3854
- "list.js"
3678
+ "device",
3679
+ "rename.js"
3855
3680
  ]
3856
3681
  },
3857
- "persona:task-status": {
3682
+ "device:streams": {
3858
3683
  "aliases": [],
3859
3684
  "args": {
3860
- "taskId": {
3861
- "description": "Task ID (from delegate-task output)",
3862
- "name": "taskId",
3685
+ "id": {
3686
+ "description": "Device ID (UUID)",
3687
+ "name": "id",
3863
3688
  "required": true
3864
3689
  }
3865
3690
  },
3866
- "description": "Check the status and results of a delegated task.\n\nShows all runs for a task including their status, result summary, and timestamps.",
3691
+ "description": "List telemetry streams for a device with data presence.\n\nShows streams from the device configuration and any streams discovered from\ningested data. Each stream is enriched with presence info from the analytics\nbackend: data point count, last seen time, and a freshness indicator\n(active/recent/stale/dormant).\n\nUnconfigured streams (discovered from data only) are marked with SOURCE \"data\".",
3867
3692
  "examples": [
3868
- "<%= config.bin %> persona task-status <task-id>",
3869
- "<%= config.bin %> persona task-status <task-id> --json",
3870
- "<%= config.bin %> persona task-status <task-id> --dev"
3693
+ "<%= config.bin %> device streams <device-id>",
3694
+ "<%= config.bin %> device streams <device-id> --with-data",
3695
+ "<%= config.bin %> device streams <device-id> --with-data --days 30",
3696
+ "<%= config.bin %> device streams <device-id> --json"
3871
3697
  ],
3872
3698
  "flags": {
3873
3699
  "json": {
@@ -3906,37 +3732,54 @@
3906
3732
  "name": "toon",
3907
3733
  "allowNo": false,
3908
3734
  "type": "boolean"
3735
+ },
3736
+ "days": {
3737
+ "description": "How many days back to look for stream data presence",
3738
+ "name": "days",
3739
+ "default": 7,
3740
+ "hasDynamicHelp": false,
3741
+ "multiple": false,
3742
+ "type": "option"
3743
+ },
3744
+ "with-data": {
3745
+ "char": "w",
3746
+ "description": "Only show streams that have data in the --days window",
3747
+ "name": "with-data",
3748
+ "allowNo": false,
3749
+ "type": "boolean"
3909
3750
  }
3910
3751
  },
3911
3752
  "hasDynamicHelp": false,
3912
3753
  "hiddenAliases": [],
3913
- "id": "persona:task-status",
3754
+ "id": "device:streams",
3914
3755
  "pluginAlias": "@formant/formant-cli",
3915
3756
  "pluginName": "@formant/formant-cli",
3916
3757
  "pluginType": "core",
3917
3758
  "strict": true,
3918
- "summary": "Check status of a delegated task",
3759
+ "summary": "List device streams with data presence",
3919
3760
  "enableJsonFlag": true,
3920
3761
  "isESM": true,
3921
3762
  "relativePath": [
3922
3763
  "dist",
3923
3764
  "commands",
3924
- "persona",
3925
- "task-status.js"
3765
+ "device",
3766
+ "streams.js"
3926
3767
  ]
3927
3768
  },
3928
- "query": {
3769
+ "device:tag": {
3929
3770
  "aliases": [],
3930
- "args": {},
3931
- "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-values-only to get only the most recent value.\n\nUse --all-streams with --latest-values-only to automatically discover and query all\nstreams — both from the device configuration and from actual ingested data\n(unconfigured streams included).\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.",
3771
+ "args": {
3772
+ "id": {
3773
+ "description": "Device ID (UUID)",
3774
+ "name": "id",
3775
+ "required": true
3776
+ }
3777
+ },
3778
+ "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.",
3932
3779
  "examples": [
3933
- "<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-01-02",
3934
- "<%= config.bin %> query --device <id> --stream speed --aggregate hour --start 2026-01-01 --end 2026-02-01",
3935
- "<%= config.bin %> query --device <id> --stream battery_level --stream temperature --start 2026-01-01 --end 2026-01-02",
3936
- "<%= config.bin %> query --device <id1> --device <id2> --stream battery_level --start 2026-01-01 --end 2026-01-02",
3937
- "<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-02-01 --latest-values-only",
3938
- "<%= config.bin %> query --device <id> --all-streams --start 2026-01-01 --end 2026-02-01 --latest-values-only",
3939
- "<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
3780
+ "<%= config.bin %> device tag <device-id> --tag location=warehouse",
3781
+ "<%= config.bin %> device tag <device-id> --tag env=prod --tag region=us-east",
3782
+ "<%= config.bin %> device tag <device-id> --tag location=factory --json"
3940
3783
  ],
3941
3784
  "flags": {
3942
3785
  "json": {
@@ -3976,113 +3819,47 @@
3976
3819
  "allowNo": false,
3977
3820
  "type": "boolean"
3978
3821
  },
3979
- "aggregate": {
3980
- "char": "a",
3981
- "description": "Aggregation level for downsampling",
3982
- "name": "aggregate",
3983
- "hasDynamicHelp": false,
3984
- "multiple": false,
3985
- "type": "option"
3986
- },
3987
- "all-streams": {
3988
- "description": "Query all streams for the device — from config and from ingested data (requires single --device and --latest-values-only)",
3989
- "name": "all-streams",
3990
- "allowNo": false,
3991
- "type": "boolean"
3992
- },
3993
- "days": {
3994
- "description": "How many days back to look for unconfigured streams when using --all-streams",
3995
- "name": "days",
3996
- "default": 14,
3997
- "hasDynamicHelp": false,
3998
- "multiple": false,
3999
- "type": "option"
4000
- },
4001
- "device": {
4002
- "char": "d",
4003
- "description": "Device ID(s), can be specified multiple times",
4004
- "name": "device",
4005
- "required": true,
4006
- "hasDynamicHelp": false,
4007
- "multiple": true,
4008
- "type": "option"
4009
- },
4010
- "end": {
4011
- "description": "End time (ISO 8601)",
4012
- "name": "end",
4013
- "required": true,
4014
- "hasDynamicHelp": false,
4015
- "multiple": false,
4016
- "type": "option"
4017
- },
4018
- "latest-values-only": {
4019
- "description": "Only return the most recent value per stream",
4020
- "name": "latest-values-only",
4021
- "allowNo": false,
4022
- "type": "boolean"
4023
- },
4024
- "limit": {
4025
- "char": "l",
4026
- "description": "Maximum number of datapoints",
4027
- "name": "limit",
4028
- "hasDynamicHelp": false,
4029
- "multiple": false,
4030
- "type": "option"
4031
- },
4032
- "start": {
4033
- "description": "Start time (ISO 8601)",
4034
- "name": "start",
3822
+ "tag": {
3823
+ "char": "t",
3824
+ "description": "Tag to add or update (key=value), can be specified multiple times",
3825
+ "name": "tag",
4035
3826
  "required": true,
4036
3827
  "hasDynamicHelp": false,
4037
- "multiple": false,
4038
- "type": "option"
4039
- },
4040
- "stream": {
4041
- "char": "s",
4042
- "description": "Stream name(s), can be specified multiple times",
4043
- "name": "stream",
4044
- "hasDynamicHelp": false,
4045
3828
  "multiple": true,
4046
3829
  "type": "option"
4047
- },
4048
- "type": {
4049
- "description": "Filter by stream type",
4050
- "name": "type",
4051
- "hasDynamicHelp": false,
4052
- "multiple": false,
4053
- "type": "option"
4054
3830
  }
4055
3831
  },
4056
3832
  "hasDynamicHelp": false,
4057
3833
  "hiddenAliases": [],
4058
- "id": "query",
3834
+ "id": "device:tag",
4059
3835
  "pluginAlias": "@formant/formant-cli",
4060
3836
  "pluginName": "@formant/formant-cli",
4061
3837
  "pluginType": "core",
4062
3838
  "strict": true,
4063
- "summary": "Query telemetry stream data",
3839
+ "summary": "Add or update tags on a device",
4064
3840
  "enableJsonFlag": true,
4065
3841
  "isESM": true,
4066
3842
  "relativePath": [
4067
3843
  "dist",
4068
3844
  "commands",
4069
- "query",
4070
- "index.js"
3845
+ "device",
3846
+ "tag.js"
4071
3847
  ]
4072
3848
  },
4073
- "user:get": {
3849
+ "device:untag": {
4074
3850
  "aliases": [],
4075
3851
  "args": {
4076
3852
  "id": {
4077
- "description": "User ID (UUID)",
3853
+ "description": "Device ID (UUID)",
4078
3854
  "name": "id",
4079
3855
  "required": true
4080
3856
  }
4081
3857
  },
4082
- "description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.",
3858
+ "description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.",
4083
3859
  "examples": [
4084
- "<%= config.bin %> user get <user-id>",
4085
- "<%= config.bin %> user get <user-id> --json"
3860
+ "<%= config.bin %> device untag <device-id> --key location",
3861
+ "<%= config.bin %> device untag <device-id> --key env --key region",
3862
+ "<%= config.bin %> device untag <device-id> --key location --json"
4086
3863
  ],
4087
3864
  "flags": {
4088
3865
  "json": {
@@ -4121,32 +3898,46 @@
4121
3898
  "name": "toon",
4122
3899
  "allowNo": false,
4123
3900
  "type": "boolean"
3901
+ },
3902
+ "key": {
3903
+ "char": "k",
3904
+ "description": "Tag key to remove, can be specified multiple times",
3905
+ "name": "key",
3906
+ "required": true,
3907
+ "hasDynamicHelp": false,
3908
+ "multiple": true,
3909
+ "type": "option"
4124
3910
  }
4125
3911
  },
4126
3912
  "hasDynamicHelp": false,
4127
3913
  "hiddenAliases": [],
4128
- "id": "user:get",
3914
+ "id": "device:untag",
4129
3915
  "pluginAlias": "@formant/formant-cli",
4130
3916
  "pluginName": "@formant/formant-cli",
4131
3917
  "pluginType": "core",
4132
3918
  "strict": true,
4133
- "summary": "Get user details",
3919
+ "summary": "Remove tags from a device",
4134
3920
  "enableJsonFlag": true,
4135
3921
  "isESM": true,
4136
3922
  "relativePath": [
4137
3923
  "dist",
4138
3924
  "commands",
4139
- "user",
4140
- "get.js"
3925
+ "device",
3926
+ "untag.js"
4141
3927
  ]
4142
3928
  },
4143
- "user:list": {
3929
+ "query": {
4144
3930
  "aliases": [],
4145
3931
  "args": {},
4146
- "description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.",
3932
+ "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-values-only to get only the most recent value.\n\nUse --all-streams with --latest-values-only to automatically discover and query all\nstreams — both from the device configuration and from actual ingested data\n(unconfigured streams included).\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.",
4147
3933
  "examples": [
4148
- "<%= config.bin %> user list",
4149
- "<%= config.bin %> user list --json"
3934
+ "<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-01-02",
3935
+ "<%= config.bin %> query --device <id> --stream speed --aggregate hour --start 2026-01-01 --end 2026-02-01",
3936
+ "<%= config.bin %> query --device <id> --stream battery_level --stream temperature --start 2026-01-01 --end 2026-01-02",
3937
+ "<%= config.bin %> query --device <id1> --device <id2> --stream battery_level --start 2026-01-01 --end 2026-01-02",
3938
+ "<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-02-01 --latest-values-only",
3939
+ "<%= config.bin %> query --device <id> --all-streams --start 2026-01-01 --end 2026-02-01 --latest-values-only",
3940
+ "<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
4150
3941
  ],
4151
3942
  "flags": {
4152
3943
  "json": {
@@ -4185,23 +3976,99 @@
4185
3976
  "name": "toon",
4186
3977
  "allowNo": false,
4187
3978
  "type": "boolean"
3979
+ },
3980
+ "aggregate": {
3981
+ "char": "a",
3982
+ "description": "Aggregation level for downsampling",
3983
+ "name": "aggregate",
3984
+ "hasDynamicHelp": false,
3985
+ "multiple": false,
3986
+ "type": "option"
3987
+ },
3988
+ "all-streams": {
3989
+ "description": "Query all streams for the device — from config and from ingested data (requires single --device and --latest-values-only)",
3990
+ "name": "all-streams",
3991
+ "allowNo": false,
3992
+ "type": "boolean"
3993
+ },
3994
+ "days": {
3995
+ "description": "How many days back to look for unconfigured streams when using --all-streams",
3996
+ "name": "days",
3997
+ "default": 14,
3998
+ "hasDynamicHelp": false,
3999
+ "multiple": false,
4000
+ "type": "option"
4001
+ },
4002
+ "device": {
4003
+ "char": "d",
4004
+ "description": "Device ID(s), can be specified multiple times",
4005
+ "name": "device",
4006
+ "required": true,
4007
+ "hasDynamicHelp": false,
4008
+ "multiple": true,
4009
+ "type": "option"
4010
+ },
4011
+ "end": {
4012
+ "description": "End time (ISO 8601)",
4013
+ "name": "end",
4014
+ "required": true,
4015
+ "hasDynamicHelp": false,
4016
+ "multiple": false,
4017
+ "type": "option"
4018
+ },
4019
+ "latest-values-only": {
4020
+ "description": "Only return the most recent value per stream",
4021
+ "name": "latest-values-only",
4022
+ "allowNo": false,
4023
+ "type": "boolean"
4024
+ },
4025
+ "limit": {
4026
+ "char": "l",
4027
+ "description": "Maximum number of datapoints",
4028
+ "name": "limit",
4029
+ "hasDynamicHelp": false,
4030
+ "multiple": false,
4031
+ "type": "option"
4032
+ },
4033
+ "start": {
4034
+ "description": "Start time (ISO 8601)",
4035
+ "name": "start",
4036
+ "required": true,
4037
+ "hasDynamicHelp": false,
4038
+ "multiple": false,
4039
+ "type": "option"
4040
+ },
4041
+ "stream": {
4042
+ "char": "s",
4043
+ "description": "Stream name(s), can be specified multiple times",
4044
+ "name": "stream",
4045
+ "hasDynamicHelp": false,
4046
+ "multiple": true,
4047
+ "type": "option"
4048
+ },
4049
+ "type": {
4050
+ "description": "Filter by stream type",
4051
+ "name": "type",
4052
+ "hasDynamicHelp": false,
4053
+ "multiple": false,
4054
+ "type": "option"
4188
4055
  }
4189
4056
  },
4190
4057
  "hasDynamicHelp": false,
4191
4058
  "hiddenAliases": [],
4192
- "id": "user:list",
4059
+ "id": "query",
4193
4060
  "pluginAlias": "@formant/formant-cli",
4194
4061
  "pluginName": "@formant/formant-cli",
4195
4062
  "pluginType": "core",
4196
4063
  "strict": true,
4197
- "summary": "List users",
4064
+ "summary": "Query telemetry stream data",
4198
4065
  "enableJsonFlag": true,
4199
4066
  "isESM": true,
4200
4067
  "relativePath": [
4201
4068
  "dist",
4202
4069
  "commands",
4203
- "user",
4204
- "list.js"
4070
+ "query",
4071
+ "index.js"
4205
4072
  ]
4206
4073
  },
4207
4074
  "schedule:get": {
@@ -4856,7 +4723,141 @@
4856
4723
  "signal",
4857
4724
  "set-ground-truth.js"
4858
4725
  ]
4726
+ },
4727
+ "user:get": {
4728
+ "aliases": [],
4729
+ "args": {
4730
+ "id": {
4731
+ "description": "User ID (UUID)",
4732
+ "name": "id",
4733
+ "required": true
4734
+ }
4735
+ },
4736
+ "description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.",
4737
+ "examples": [
4738
+ "<%= config.bin %> user get <user-id>",
4739
+ "<%= config.bin %> user get <user-id> --json"
4740
+ ],
4741
+ "flags": {
4742
+ "json": {
4743
+ "description": "Format output as json.",
4744
+ "helpGroup": "GLOBAL",
4745
+ "name": "json",
4746
+ "allowNo": false,
4747
+ "type": "boolean"
4748
+ },
4749
+ "dev": {
4750
+ "description": "Target the dev environment",
4751
+ "exclusive": [
4752
+ "stage"
4753
+ ],
4754
+ "helpGroup": "GLOBAL",
4755
+ "name": "dev",
4756
+ "allowNo": false,
4757
+ "type": "boolean"
4758
+ },
4759
+ "stage": {
4760
+ "description": "Target the stage environment",
4761
+ "exclusive": [
4762
+ "dev"
4763
+ ],
4764
+ "helpGroup": "GLOBAL",
4765
+ "name": "stage",
4766
+ "allowNo": false,
4767
+ "type": "boolean"
4768
+ },
4769
+ "toon": {
4770
+ "description": "Output data in TOON (Token-Oriented Object Notation) format",
4771
+ "exclusive": [
4772
+ "json"
4773
+ ],
4774
+ "helpGroup": "GLOBAL",
4775
+ "name": "toon",
4776
+ "allowNo": false,
4777
+ "type": "boolean"
4778
+ }
4779
+ },
4780
+ "hasDynamicHelp": false,
4781
+ "hiddenAliases": [],
4782
+ "id": "user:get",
4783
+ "pluginAlias": "@formant/formant-cli",
4784
+ "pluginName": "@formant/formant-cli",
4785
+ "pluginType": "core",
4786
+ "strict": true,
4787
+ "summary": "Get user details",
4788
+ "enableJsonFlag": true,
4789
+ "isESM": true,
4790
+ "relativePath": [
4791
+ "dist",
4792
+ "commands",
4793
+ "user",
4794
+ "get.js"
4795
+ ]
4796
+ },
4797
+ "user:list": {
4798
+ "aliases": [],
4799
+ "args": {},
4800
+ "description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.",
4801
+ "examples": [
4802
+ "<%= config.bin %> user list",
4803
+ "<%= config.bin %> user list --json"
4804
+ ],
4805
+ "flags": {
4806
+ "json": {
4807
+ "description": "Format output as json.",
4808
+ "helpGroup": "GLOBAL",
4809
+ "name": "json",
4810
+ "allowNo": false,
4811
+ "type": "boolean"
4812
+ },
4813
+ "dev": {
4814
+ "description": "Target the dev environment",
4815
+ "exclusive": [
4816
+ "stage"
4817
+ ],
4818
+ "helpGroup": "GLOBAL",
4819
+ "name": "dev",
4820
+ "allowNo": false,
4821
+ "type": "boolean"
4822
+ },
4823
+ "stage": {
4824
+ "description": "Target the stage environment",
4825
+ "exclusive": [
4826
+ "dev"
4827
+ ],
4828
+ "helpGroup": "GLOBAL",
4829
+ "name": "stage",
4830
+ "allowNo": false,
4831
+ "type": "boolean"
4832
+ },
4833
+ "toon": {
4834
+ "description": "Output data in TOON (Token-Oriented Object Notation) format",
4835
+ "exclusive": [
4836
+ "json"
4837
+ ],
4838
+ "helpGroup": "GLOBAL",
4839
+ "name": "toon",
4840
+ "allowNo": false,
4841
+ "type": "boolean"
4842
+ }
4843
+ },
4844
+ "hasDynamicHelp": false,
4845
+ "hiddenAliases": [],
4846
+ "id": "user:list",
4847
+ "pluginAlias": "@formant/formant-cli",
4848
+ "pluginName": "@formant/formant-cli",
4849
+ "pluginType": "core",
4850
+ "strict": true,
4851
+ "summary": "List users",
4852
+ "enableJsonFlag": true,
4853
+ "isESM": true,
4854
+ "relativePath": [
4855
+ "dist",
4856
+ "commands",
4857
+ "user",
4858
+ "list.js"
4859
+ ]
4859
4860
  }
4860
4861
  },
4861
- "version": "0.5.0"
4862
+ "version": "0.5.2"
4862
4863
  }