@formant/formant-cli 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/devices/streams.d.ts +3 -0
- package/dist/commands/devices/streams.js +71 -27
- package/dist/commands/devices/streams.js.map +1 -1
- package/dist/commands/query/latest-values.d.ts +1 -0
- package/dist/commands/query/latest-values.js +41 -15
- package/dist/commands/query/latest-values.js.map +1 -1
- package/oclif.manifest.json +1214 -1197
- package/package.json +1 -1
package/oclif.manifest.json
CHANGED
|
@@ -140,173 +140,6 @@
|
|
|
140
140
|
"tables.js"
|
|
141
141
|
]
|
|
142
142
|
},
|
|
143
|
-
"events:get": {
|
|
144
|
-
"aliases": [],
|
|
145
|
-
"args": {
|
|
146
|
-
"id": {
|
|
147
|
-
"description": "Event ID (UUID)",
|
|
148
|
-
"name": "id",
|
|
149
|
-
"required": true
|
|
150
|
-
}
|
|
151
|
-
},
|
|
152
|
-
"description": "Get detailed information about a specific event by its ID.",
|
|
153
|
-
"examples": [
|
|
154
|
-
"<%= config.bin %> events get <event-id>",
|
|
155
|
-
"<%= config.bin %> events get <event-id> --json"
|
|
156
|
-
],
|
|
157
|
-
"flags": {
|
|
158
|
-
"json": {
|
|
159
|
-
"description": "Format output as json.",
|
|
160
|
-
"helpGroup": "GLOBAL",
|
|
161
|
-
"name": "json",
|
|
162
|
-
"allowNo": false,
|
|
163
|
-
"type": "boolean"
|
|
164
|
-
},
|
|
165
|
-
"dev": {
|
|
166
|
-
"description": "Target the dev environment",
|
|
167
|
-
"exclusive": [
|
|
168
|
-
"stage"
|
|
169
|
-
],
|
|
170
|
-
"helpGroup": "GLOBAL",
|
|
171
|
-
"name": "dev",
|
|
172
|
-
"allowNo": false,
|
|
173
|
-
"type": "boolean"
|
|
174
|
-
},
|
|
175
|
-
"stage": {
|
|
176
|
-
"description": "Target the stage environment",
|
|
177
|
-
"exclusive": [
|
|
178
|
-
"dev"
|
|
179
|
-
],
|
|
180
|
-
"helpGroup": "GLOBAL",
|
|
181
|
-
"name": "stage",
|
|
182
|
-
"allowNo": false,
|
|
183
|
-
"type": "boolean"
|
|
184
|
-
}
|
|
185
|
-
},
|
|
186
|
-
"hasDynamicHelp": false,
|
|
187
|
-
"hiddenAliases": [],
|
|
188
|
-
"id": "events:get",
|
|
189
|
-
"pluginAlias": "@formant/formant-cli",
|
|
190
|
-
"pluginName": "@formant/formant-cli",
|
|
191
|
-
"pluginType": "core",
|
|
192
|
-
"strict": true,
|
|
193
|
-
"summary": "Get an event by ID",
|
|
194
|
-
"enableJsonFlag": true,
|
|
195
|
-
"isESM": true,
|
|
196
|
-
"relativePath": [
|
|
197
|
-
"dist",
|
|
198
|
-
"commands",
|
|
199
|
-
"events",
|
|
200
|
-
"get.js"
|
|
201
|
-
]
|
|
202
|
-
},
|
|
203
|
-
"events:list": {
|
|
204
|
-
"aliases": [],
|
|
205
|
-
"args": {},
|
|
206
|
-
"description": "View important events emitted by devices with optional filters.\n\nEvents are significant occurrences from robots and sensors (e.g., device online/offline,\nerrors, state changes, commands). They can trigger signals for investigation.\n\nEvent types include: triggered-event, datapoint-event, device-online, device-offline,\nintervention-request, intervention-response, teleop-session-record, command-request,\ncommand-response, custom, comment, system, annotation, task-summary, stateful.\n\nSeverities: info, warning, error, critical.",
|
|
207
|
-
"examples": [
|
|
208
|
-
"<%= config.bin %> events list",
|
|
209
|
-
"<%= config.bin %> events list --device <id> --severity critical",
|
|
210
|
-
"<%= config.bin %> events list --type device-offline --start 2026-01-01 --end 2026-01-02",
|
|
211
|
-
"<%= config.bin %> events list --limit 100 --json"
|
|
212
|
-
],
|
|
213
|
-
"flags": {
|
|
214
|
-
"json": {
|
|
215
|
-
"description": "Format output as json.",
|
|
216
|
-
"helpGroup": "GLOBAL",
|
|
217
|
-
"name": "json",
|
|
218
|
-
"allowNo": false,
|
|
219
|
-
"type": "boolean"
|
|
220
|
-
},
|
|
221
|
-
"dev": {
|
|
222
|
-
"description": "Target the dev environment",
|
|
223
|
-
"exclusive": [
|
|
224
|
-
"stage"
|
|
225
|
-
],
|
|
226
|
-
"helpGroup": "GLOBAL",
|
|
227
|
-
"name": "dev",
|
|
228
|
-
"allowNo": false,
|
|
229
|
-
"type": "boolean"
|
|
230
|
-
},
|
|
231
|
-
"stage": {
|
|
232
|
-
"description": "Target the stage environment",
|
|
233
|
-
"exclusive": [
|
|
234
|
-
"dev"
|
|
235
|
-
],
|
|
236
|
-
"helpGroup": "GLOBAL",
|
|
237
|
-
"name": "stage",
|
|
238
|
-
"allowNo": false,
|
|
239
|
-
"type": "boolean"
|
|
240
|
-
},
|
|
241
|
-
"device": {
|
|
242
|
-
"char": "d",
|
|
243
|
-
"description": "Filter by device ID",
|
|
244
|
-
"name": "device",
|
|
245
|
-
"hasDynamicHelp": false,
|
|
246
|
-
"multiple": false,
|
|
247
|
-
"type": "option"
|
|
248
|
-
},
|
|
249
|
-
"end": {
|
|
250
|
-
"description": "End time (ISO 8601)",
|
|
251
|
-
"name": "end",
|
|
252
|
-
"hasDynamicHelp": false,
|
|
253
|
-
"multiple": false,
|
|
254
|
-
"type": "option"
|
|
255
|
-
},
|
|
256
|
-
"limit": {
|
|
257
|
-
"char": "l",
|
|
258
|
-
"description": "Maximum number of events to return",
|
|
259
|
-
"name": "limit",
|
|
260
|
-
"default": 25,
|
|
261
|
-
"hasDynamicHelp": false,
|
|
262
|
-
"multiple": false,
|
|
263
|
-
"type": "option"
|
|
264
|
-
},
|
|
265
|
-
"severity": {
|
|
266
|
-
"description": "Filter by severity",
|
|
267
|
-
"name": "severity",
|
|
268
|
-
"hasDynamicHelp": false,
|
|
269
|
-
"multiple": false,
|
|
270
|
-
"options": [
|
|
271
|
-
"info",
|
|
272
|
-
"warning",
|
|
273
|
-
"error",
|
|
274
|
-
"critical"
|
|
275
|
-
],
|
|
276
|
-
"type": "option"
|
|
277
|
-
},
|
|
278
|
-
"start": {
|
|
279
|
-
"description": "Start time (ISO 8601)",
|
|
280
|
-
"name": "start",
|
|
281
|
-
"hasDynamicHelp": false,
|
|
282
|
-
"multiple": false,
|
|
283
|
-
"type": "option"
|
|
284
|
-
},
|
|
285
|
-
"type": {
|
|
286
|
-
"description": "Filter by event type",
|
|
287
|
-
"name": "type",
|
|
288
|
-
"hasDynamicHelp": false,
|
|
289
|
-
"multiple": false,
|
|
290
|
-
"type": "option"
|
|
291
|
-
}
|
|
292
|
-
},
|
|
293
|
-
"hasDynamicHelp": false,
|
|
294
|
-
"hiddenAliases": [],
|
|
295
|
-
"id": "events:list",
|
|
296
|
-
"pluginAlias": "@formant/formant-cli",
|
|
297
|
-
"pluginName": "@formant/formant-cli",
|
|
298
|
-
"pluginType": "core",
|
|
299
|
-
"strict": true,
|
|
300
|
-
"summary": "View events emitted by devices",
|
|
301
|
-
"enableJsonFlag": true,
|
|
302
|
-
"isESM": true,
|
|
303
|
-
"relativePath": [
|
|
304
|
-
"dist",
|
|
305
|
-
"commands",
|
|
306
|
-
"events",
|
|
307
|
-
"list.js"
|
|
308
|
-
]
|
|
309
|
-
},
|
|
310
143
|
"commands:for-device": {
|
|
311
144
|
"aliases": [],
|
|
312
145
|
"args": {
|
|
@@ -643,19 +476,19 @@
|
|
|
643
476
|
"send.js"
|
|
644
477
|
]
|
|
645
478
|
},
|
|
646
|
-
"
|
|
479
|
+
"devices:config": {
|
|
647
480
|
"aliases": [],
|
|
648
481
|
"args": {
|
|
649
482
|
"id": {
|
|
650
|
-
"description": "
|
|
483
|
+
"description": "Device ID (UUID)",
|
|
651
484
|
"name": "id",
|
|
652
485
|
"required": true
|
|
653
486
|
}
|
|
654
487
|
},
|
|
655
|
-
"description": "Get
|
|
488
|
+
"description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
|
|
656
489
|
"examples": [
|
|
657
|
-
"<%= config.bin %>
|
|
658
|
-
"<%= config.bin %>
|
|
490
|
+
"<%= config.bin %> devices config <device-id>",
|
|
491
|
+
"<%= config.bin %> devices config <device-id> --json"
|
|
659
492
|
],
|
|
660
493
|
"flags": {
|
|
661
494
|
"json": {
|
|
@@ -688,28 +521,35 @@
|
|
|
688
521
|
},
|
|
689
522
|
"hasDynamicHelp": false,
|
|
690
523
|
"hiddenAliases": [],
|
|
691
|
-
"id": "
|
|
524
|
+
"id": "devices:config",
|
|
692
525
|
"pluginAlias": "@formant/formant-cli",
|
|
693
526
|
"pluginName": "@formant/formant-cli",
|
|
694
527
|
"pluginType": "core",
|
|
695
528
|
"strict": true,
|
|
696
|
-
"summary": "Get
|
|
529
|
+
"summary": "Get device configuration",
|
|
697
530
|
"enableJsonFlag": true,
|
|
698
531
|
"isESM": true,
|
|
699
532
|
"relativePath": [
|
|
700
533
|
"dist",
|
|
701
534
|
"commands",
|
|
702
|
-
"
|
|
703
|
-
"
|
|
535
|
+
"devices",
|
|
536
|
+
"config.js"
|
|
704
537
|
]
|
|
705
538
|
},
|
|
706
|
-
"
|
|
539
|
+
"devices:create": {
|
|
707
540
|
"aliases": [],
|
|
708
|
-
"args": {
|
|
709
|
-
|
|
541
|
+
"args": {
|
|
542
|
+
"name": {
|
|
543
|
+
"description": "Name for the new device",
|
|
544
|
+
"name": "name",
|
|
545
|
+
"required": true
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
"description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
|
|
710
549
|
"examples": [
|
|
711
|
-
"<%= config.bin %>
|
|
712
|
-
"<%= config.bin %>
|
|
550
|
+
"<%= config.bin %> devices create my-robot",
|
|
551
|
+
"<%= config.bin %> devices create my-robot --tag location=warehouse --tag env=prod",
|
|
552
|
+
"<%= config.bin %> devices create my-robot --json"
|
|
713
553
|
],
|
|
714
554
|
"flags": {
|
|
715
555
|
"json": {
|
|
@@ -738,38 +578,46 @@
|
|
|
738
578
|
"name": "stage",
|
|
739
579
|
"allowNo": false,
|
|
740
580
|
"type": "boolean"
|
|
581
|
+
},
|
|
582
|
+
"tag": {
|
|
583
|
+
"char": "t",
|
|
584
|
+
"description": "Tag to apply (key=value), can be specified multiple times",
|
|
585
|
+
"name": "tag",
|
|
586
|
+
"hasDynamicHelp": false,
|
|
587
|
+
"multiple": true,
|
|
588
|
+
"type": "option"
|
|
741
589
|
}
|
|
742
590
|
},
|
|
743
591
|
"hasDynamicHelp": false,
|
|
744
592
|
"hiddenAliases": [],
|
|
745
|
-
"id": "
|
|
593
|
+
"id": "devices:create",
|
|
746
594
|
"pluginAlias": "@formant/formant-cli",
|
|
747
595
|
"pluginName": "@formant/formant-cli",
|
|
748
596
|
"pluginType": "core",
|
|
749
597
|
"strict": true,
|
|
750
|
-
"summary": "
|
|
598
|
+
"summary": "Create a new device",
|
|
751
599
|
"enableJsonFlag": true,
|
|
752
600
|
"isESM": true,
|
|
753
601
|
"relativePath": [
|
|
754
602
|
"dist",
|
|
755
603
|
"commands",
|
|
756
|
-
"
|
|
757
|
-
"
|
|
604
|
+
"devices",
|
|
605
|
+
"create.js"
|
|
758
606
|
]
|
|
759
607
|
},
|
|
760
|
-
"
|
|
608
|
+
"devices:delete": {
|
|
761
609
|
"aliases": [],
|
|
762
610
|
"args": {
|
|
763
611
|
"id": {
|
|
764
|
-
"description": "
|
|
612
|
+
"description": "Device ID (UUID)",
|
|
765
613
|
"name": "id",
|
|
766
614
|
"required": true
|
|
767
615
|
}
|
|
768
616
|
},
|
|
769
|
-
"description": "
|
|
617
|
+
"description": "Delete (disable) a device from your fleet.\n\nThis performs a soft-delete by disabling the device. The device and its telemetry\nhistory are preserved but it will no longer appear in device listings.",
|
|
770
618
|
"examples": [
|
|
771
|
-
"<%= config.bin %>
|
|
772
|
-
"<%= config.bin %>
|
|
619
|
+
"<%= config.bin %> devices delete <device-id>",
|
|
620
|
+
"<%= config.bin %> devices delete <device-id> --json"
|
|
773
621
|
],
|
|
774
622
|
"flags": {
|
|
775
623
|
"json": {
|
|
@@ -802,28 +650,34 @@
|
|
|
802
650
|
},
|
|
803
651
|
"hasDynamicHelp": false,
|
|
804
652
|
"hiddenAliases": [],
|
|
805
|
-
"id": "
|
|
653
|
+
"id": "devices:delete",
|
|
806
654
|
"pluginAlias": "@formant/formant-cli",
|
|
807
655
|
"pluginName": "@formant/formant-cli",
|
|
808
656
|
"pluginType": "core",
|
|
809
657
|
"strict": true,
|
|
810
|
-
"summary": "
|
|
658
|
+
"summary": "Delete (disable) a device",
|
|
811
659
|
"enableJsonFlag": true,
|
|
812
660
|
"isESM": true,
|
|
813
661
|
"relativePath": [
|
|
814
662
|
"dist",
|
|
815
663
|
"commands",
|
|
816
|
-
"
|
|
817
|
-
"
|
|
664
|
+
"devices",
|
|
665
|
+
"delete.js"
|
|
818
666
|
]
|
|
819
667
|
},
|
|
820
|
-
"
|
|
668
|
+
"devices:get": {
|
|
821
669
|
"aliases": [],
|
|
822
|
-
"args": {
|
|
823
|
-
|
|
670
|
+
"args": {
|
|
671
|
+
"id": {
|
|
672
|
+
"description": "Device ID (UUID)",
|
|
673
|
+
"name": "id",
|
|
674
|
+
"required": true
|
|
675
|
+
}
|
|
676
|
+
},
|
|
677
|
+
"description": "Get detailed information about a specific device by its ID.",
|
|
824
678
|
"examples": [
|
|
825
|
-
"<%= config.bin %>
|
|
826
|
-
"<%= config.bin %>
|
|
679
|
+
"<%= config.bin %> devices get <device-id>",
|
|
680
|
+
"<%= config.bin %> devices get <device-id> --json"
|
|
827
681
|
],
|
|
828
682
|
"flags": {
|
|
829
683
|
"json": {
|
|
@@ -856,30 +710,34 @@
|
|
|
856
710
|
},
|
|
857
711
|
"hasDynamicHelp": false,
|
|
858
712
|
"hiddenAliases": [],
|
|
859
|
-
"id": "
|
|
713
|
+
"id": "devices:get",
|
|
860
714
|
"pluginAlias": "@formant/formant-cli",
|
|
861
715
|
"pluginName": "@formant/formant-cli",
|
|
862
716
|
"pluginType": "core",
|
|
863
717
|
"strict": true,
|
|
864
|
-
"summary": "
|
|
718
|
+
"summary": "Get a device by ID",
|
|
865
719
|
"enableJsonFlag": true,
|
|
866
720
|
"isESM": true,
|
|
867
721
|
"relativePath": [
|
|
868
722
|
"dist",
|
|
869
723
|
"commands",
|
|
870
|
-
"
|
|
871
|
-
"
|
|
724
|
+
"devices",
|
|
725
|
+
"get.js"
|
|
872
726
|
]
|
|
873
727
|
},
|
|
874
|
-
"
|
|
728
|
+
"devices:last-seen": {
|
|
875
729
|
"aliases": [],
|
|
876
|
-
"args": {
|
|
877
|
-
|
|
730
|
+
"args": {
|
|
731
|
+
"id": {
|
|
732
|
+
"description": "Device ID (UUID)",
|
|
733
|
+
"name": "id",
|
|
734
|
+
"required": true
|
|
735
|
+
}
|
|
736
|
+
},
|
|
737
|
+
"description": "Get when a device was last seen online.\n\nShows the most recent timestamp when the device was detected as online.",
|
|
878
738
|
"examples": [
|
|
879
|
-
"<%= config.bin %>
|
|
880
|
-
"<%= config.bin %>
|
|
881
|
-
"cat payload.json | <%= config.bin %> ingest batch --stdin",
|
|
882
|
-
"# Example payload.json with multiple types:\n{\n \"items\": [\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"battery_level\",\n \"type\": \"numeric\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, 42.5], [1708272060000, 41.8]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"status\",\n \"type\": \"text\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, \"operational\"]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"health\",\n \"type\": \"health\",\n \"tags\": {},\n \"points\": [[1708272000000, {\"status\": \"operational\"}]]\n }\n ]\n}"
|
|
739
|
+
"<%= config.bin %> devices last-seen <device-id>",
|
|
740
|
+
"<%= config.bin %> devices last-seen <device-id> --json"
|
|
883
741
|
],
|
|
884
742
|
"flags": {
|
|
885
743
|
"json": {
|
|
@@ -908,53 +766,35 @@
|
|
|
908
766
|
"name": "stage",
|
|
909
767
|
"allowNo": false,
|
|
910
768
|
"type": "boolean"
|
|
911
|
-
},
|
|
912
|
-
"file": {
|
|
913
|
-
"char": "f",
|
|
914
|
-
"description": "Path to JSON file containing batch payload",
|
|
915
|
-
"exclusive": [
|
|
916
|
-
"stdin"
|
|
917
|
-
],
|
|
918
|
-
"name": "file",
|
|
919
|
-
"hasDynamicHelp": false,
|
|
920
|
-
"multiple": false,
|
|
921
|
-
"type": "option"
|
|
922
|
-
},
|
|
923
|
-
"stdin": {
|
|
924
|
-
"description": "Read JSON payload from stdin",
|
|
925
|
-
"exclusive": [
|
|
926
|
-
"file"
|
|
927
|
-
],
|
|
928
|
-
"name": "stdin",
|
|
929
|
-
"allowNo": false,
|
|
930
|
-
"type": "boolean"
|
|
931
769
|
}
|
|
932
770
|
},
|
|
933
771
|
"hasDynamicHelp": false,
|
|
934
772
|
"hiddenAliases": [],
|
|
935
|
-
"id": "
|
|
773
|
+
"id": "devices:last-seen",
|
|
936
774
|
"pluginAlias": "@formant/formant-cli",
|
|
937
775
|
"pluginName": "@formant/formant-cli",
|
|
938
776
|
"pluginType": "core",
|
|
939
777
|
"strict": true,
|
|
940
|
-
"summary": "
|
|
778
|
+
"summary": "Get device last seen timestamp",
|
|
941
779
|
"enableJsonFlag": true,
|
|
942
780
|
"isESM": true,
|
|
943
781
|
"relativePath": [
|
|
944
782
|
"dist",
|
|
945
783
|
"commands",
|
|
946
|
-
"
|
|
947
|
-
"
|
|
784
|
+
"devices",
|
|
785
|
+
"last-seen.js"
|
|
948
786
|
]
|
|
949
787
|
},
|
|
950
|
-
"
|
|
788
|
+
"devices:list": {
|
|
951
789
|
"aliases": [],
|
|
952
790
|
"args": {},
|
|
953
|
-
"description": "
|
|
791
|
+
"description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --all to include offline devices.",
|
|
954
792
|
"examples": [
|
|
955
|
-
"<%= config.bin %>
|
|
956
|
-
"<%= config.bin %>
|
|
957
|
-
"<%= config.bin %>
|
|
793
|
+
"<%= config.bin %> devices list",
|
|
794
|
+
"<%= config.bin %> devices list --all",
|
|
795
|
+
"<%= config.bin %> devices list --all --limit 100",
|
|
796
|
+
"<%= config.bin %> devices list --tag location=warehouse",
|
|
797
|
+
"<%= config.bin %> devices list --name robot --dev --json"
|
|
958
798
|
],
|
|
959
799
|
"flags": {
|
|
960
800
|
"json": {
|
|
@@ -984,83 +824,74 @@
|
|
|
984
824
|
"allowNo": false,
|
|
985
825
|
"type": "boolean"
|
|
986
826
|
},
|
|
987
|
-
"
|
|
988
|
-
"char": "
|
|
989
|
-
"description": "
|
|
990
|
-
"name": "
|
|
991
|
-
"
|
|
992
|
-
"
|
|
993
|
-
"multiple": false,
|
|
994
|
-
"type": "option"
|
|
995
|
-
},
|
|
996
|
-
"stream": {
|
|
997
|
-
"char": "s",
|
|
998
|
-
"description": "Stream name",
|
|
999
|
-
"name": "stream",
|
|
1000
|
-
"required": true,
|
|
1001
|
-
"hasDynamicHelp": false,
|
|
1002
|
-
"multiple": false,
|
|
1003
|
-
"type": "option"
|
|
827
|
+
"all": {
|
|
828
|
+
"char": "a",
|
|
829
|
+
"description": "Show all devices (online and offline)",
|
|
830
|
+
"name": "all",
|
|
831
|
+
"allowNo": false,
|
|
832
|
+
"type": "boolean"
|
|
1004
833
|
},
|
|
1005
|
-
"
|
|
1006
|
-
"char": "
|
|
1007
|
-
"description": "
|
|
1008
|
-
"name": "
|
|
1009
|
-
"
|
|
834
|
+
"limit": {
|
|
835
|
+
"char": "l",
|
|
836
|
+
"description": "Maximum number of devices to return",
|
|
837
|
+
"name": "limit",
|
|
838
|
+
"default": 50,
|
|
1010
839
|
"hasDynamicHelp": false,
|
|
1011
840
|
"multiple": false,
|
|
1012
841
|
"type": "option"
|
|
1013
842
|
},
|
|
1014
|
-
"
|
|
1015
|
-
"char": "
|
|
1016
|
-
"description": "
|
|
1017
|
-
"name": "
|
|
1018
|
-
"required": true,
|
|
843
|
+
"name": {
|
|
844
|
+
"char": "n",
|
|
845
|
+
"description": "Filter devices by name (search)",
|
|
846
|
+
"name": "name",
|
|
1019
847
|
"hasDynamicHelp": false,
|
|
1020
848
|
"multiple": false,
|
|
1021
849
|
"type": "option"
|
|
1022
850
|
},
|
|
1023
851
|
"tag": {
|
|
1024
852
|
"char": "t",
|
|
1025
|
-
"description": "
|
|
853
|
+
"description": "Filter by tag (key=value), can be specified multiple times",
|
|
1026
854
|
"name": "tag",
|
|
1027
855
|
"hasDynamicHelp": false,
|
|
1028
856
|
"multiple": true,
|
|
1029
857
|
"type": "option"
|
|
1030
|
-
},
|
|
1031
|
-
"timestamp": {
|
|
1032
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1033
|
-
"name": "timestamp",
|
|
1034
|
-
"hasDynamicHelp": false,
|
|
1035
|
-
"multiple": false,
|
|
1036
|
-
"type": "option"
|
|
1037
858
|
}
|
|
1038
859
|
},
|
|
1039
860
|
"hasDynamicHelp": false,
|
|
1040
861
|
"hiddenAliases": [],
|
|
1041
|
-
"id": "
|
|
862
|
+
"id": "devices:list",
|
|
1042
863
|
"pluginAlias": "@formant/formant-cli",
|
|
1043
864
|
"pluginName": "@formant/formant-cli",
|
|
1044
865
|
"pluginType": "core",
|
|
1045
866
|
"strict": true,
|
|
1046
|
-
"summary": "
|
|
867
|
+
"summary": "List robots and sensors in your fleet",
|
|
1047
868
|
"enableJsonFlag": true,
|
|
1048
869
|
"isESM": true,
|
|
1049
870
|
"relativePath": [
|
|
1050
871
|
"dist",
|
|
1051
872
|
"commands",
|
|
1052
|
-
"
|
|
1053
|
-
"
|
|
873
|
+
"devices",
|
|
874
|
+
"list.js"
|
|
1054
875
|
]
|
|
1055
876
|
},
|
|
1056
|
-
"
|
|
877
|
+
"devices:rename": {
|
|
1057
878
|
"aliases": [],
|
|
1058
|
-
"args": {
|
|
1059
|
-
|
|
879
|
+
"args": {
|
|
880
|
+
"id": {
|
|
881
|
+
"description": "Device ID (UUID)",
|
|
882
|
+
"name": "id",
|
|
883
|
+
"required": true
|
|
884
|
+
},
|
|
885
|
+
"name": {
|
|
886
|
+
"description": "New name for the device",
|
|
887
|
+
"name": "name",
|
|
888
|
+
"required": true
|
|
889
|
+
}
|
|
890
|
+
},
|
|
891
|
+
"description": "Rename a device by updating its name.",
|
|
1060
892
|
"examples": [
|
|
1061
|
-
"<%= config.bin %>
|
|
1062
|
-
"<%= config.bin %>
|
|
1063
|
-
"<%= config.bin %> ingest health --device <device-id> --stream sync --status operational --clock-skew 150"
|
|
893
|
+
"<%= config.bin %> devices rename <device-id> new-robot-name",
|
|
894
|
+
"<%= config.bin %> devices rename <device-id> new-robot-name --json"
|
|
1064
895
|
],
|
|
1065
896
|
"flags": {
|
|
1066
897
|
"json": {
|
|
@@ -1089,57 +920,72 @@
|
|
|
1089
920
|
"name": "stage",
|
|
1090
921
|
"allowNo": false,
|
|
1091
922
|
"type": "boolean"
|
|
1092
|
-
}
|
|
1093
|
-
|
|
1094
|
-
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"hasDynamicHelp": false,
|
|
926
|
+
"hiddenAliases": [],
|
|
927
|
+
"id": "devices:rename",
|
|
928
|
+
"pluginAlias": "@formant/formant-cli",
|
|
929
|
+
"pluginName": "@formant/formant-cli",
|
|
930
|
+
"pluginType": "core",
|
|
931
|
+
"strict": true,
|
|
932
|
+
"summary": "Rename a device",
|
|
933
|
+
"enableJsonFlag": true,
|
|
934
|
+
"isESM": true,
|
|
935
|
+
"relativePath": [
|
|
936
|
+
"dist",
|
|
937
|
+
"commands",
|
|
938
|
+
"devices",
|
|
939
|
+
"rename.js"
|
|
940
|
+
]
|
|
941
|
+
},
|
|
942
|
+
"devices:streams": {
|
|
943
|
+
"aliases": [],
|
|
944
|
+
"args": {
|
|
945
|
+
"id": {
|
|
1095
946
|
"description": "Device ID (UUID)",
|
|
1096
|
-
"name": "
|
|
1097
|
-
"required": true
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
"
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
"
|
|
1109
|
-
"
|
|
947
|
+
"name": "id",
|
|
948
|
+
"required": true
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
"description": "List telemetry streams for a device.\n\nShows streams parsed from the device configuration as well as any streams\ndiscovered from actual ingested data (even if not explicitly configured).\nUnconfigured streams are marked with a SOURCE of \"data\" in the output.",
|
|
952
|
+
"examples": [
|
|
953
|
+
"<%= config.bin %> devices streams <device-id>",
|
|
954
|
+
"<%= config.bin %> devices streams <device-id> --json",
|
|
955
|
+
"<%= config.bin %> devices streams <device-id> --days 30"
|
|
956
|
+
],
|
|
957
|
+
"flags": {
|
|
958
|
+
"json": {
|
|
959
|
+
"description": "Format output as json.",
|
|
960
|
+
"helpGroup": "GLOBAL",
|
|
961
|
+
"name": "json",
|
|
962
|
+
"allowNo": false,
|
|
963
|
+
"type": "boolean"
|
|
1110
964
|
},
|
|
1111
|
-
"
|
|
1112
|
-
"description": "
|
|
1113
|
-
"
|
|
1114
|
-
|
|
1115
|
-
"hasDynamicHelp": false,
|
|
1116
|
-
"multiple": false,
|
|
1117
|
-
"options": [
|
|
1118
|
-
"unknown",
|
|
1119
|
-
"operational",
|
|
1120
|
-
"offline",
|
|
1121
|
-
"error"
|
|
965
|
+
"dev": {
|
|
966
|
+
"description": "Target the dev environment",
|
|
967
|
+
"exclusive": [
|
|
968
|
+
"stage"
|
|
1122
969
|
],
|
|
1123
|
-
"
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
"
|
|
1127
|
-
"name": "clock-skew",
|
|
1128
|
-
"hasDynamicHelp": false,
|
|
1129
|
-
"multiple": false,
|
|
1130
|
-
"type": "option"
|
|
970
|
+
"helpGroup": "GLOBAL",
|
|
971
|
+
"name": "dev",
|
|
972
|
+
"allowNo": false,
|
|
973
|
+
"type": "boolean"
|
|
1131
974
|
},
|
|
1132
|
-
"
|
|
1133
|
-
"
|
|
1134
|
-
"
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
"
|
|
1138
|
-
"
|
|
975
|
+
"stage": {
|
|
976
|
+
"description": "Target the stage environment",
|
|
977
|
+
"exclusive": [
|
|
978
|
+
"dev"
|
|
979
|
+
],
|
|
980
|
+
"helpGroup": "GLOBAL",
|
|
981
|
+
"name": "stage",
|
|
982
|
+
"allowNo": false,
|
|
983
|
+
"type": "boolean"
|
|
1139
984
|
},
|
|
1140
|
-
"
|
|
1141
|
-
"description": "
|
|
1142
|
-
"name": "
|
|
985
|
+
"days": {
|
|
986
|
+
"description": "How many days back to look for unconfigured streams in ingested data",
|
|
987
|
+
"name": "days",
|
|
988
|
+
"default": 14,
|
|
1143
989
|
"hasDynamicHelp": false,
|
|
1144
990
|
"multiple": false,
|
|
1145
991
|
"type": "option"
|
|
@@ -1147,29 +993,35 @@
|
|
|
1147
993
|
},
|
|
1148
994
|
"hasDynamicHelp": false,
|
|
1149
995
|
"hiddenAliases": [],
|
|
1150
|
-
"id": "
|
|
996
|
+
"id": "devices:streams",
|
|
1151
997
|
"pluginAlias": "@formant/formant-cli",
|
|
1152
998
|
"pluginName": "@formant/formant-cli",
|
|
1153
999
|
"pluginType": "core",
|
|
1154
1000
|
"strict": true,
|
|
1155
|
-
"summary": "
|
|
1001
|
+
"summary": "List device streams",
|
|
1156
1002
|
"enableJsonFlag": true,
|
|
1157
1003
|
"isESM": true,
|
|
1158
1004
|
"relativePath": [
|
|
1159
1005
|
"dist",
|
|
1160
1006
|
"commands",
|
|
1161
|
-
"
|
|
1162
|
-
"
|
|
1007
|
+
"devices",
|
|
1008
|
+
"streams.js"
|
|
1163
1009
|
]
|
|
1164
1010
|
},
|
|
1165
|
-
"
|
|
1011
|
+
"devices:tag": {
|
|
1166
1012
|
"aliases": [],
|
|
1167
|
-
"args": {
|
|
1168
|
-
|
|
1013
|
+
"args": {
|
|
1014
|
+
"id": {
|
|
1015
|
+
"description": "Device ID (UUID)",
|
|
1016
|
+
"name": "id",
|
|
1017
|
+
"required": true
|
|
1018
|
+
}
|
|
1019
|
+
},
|
|
1020
|
+
"description": "Add or update tags on a device.\n\nTags are key-value pairs. If a tag key already exists, its value will be updated.\nSpecify one or more tags with --tag key=value.",
|
|
1169
1021
|
"examples": [
|
|
1170
|
-
"<%= config.bin %>
|
|
1171
|
-
"<%= config.bin %>
|
|
1172
|
-
"<%= config.bin %>
|
|
1022
|
+
"<%= config.bin %> devices tag <device-id> --tag location=warehouse",
|
|
1023
|
+
"<%= config.bin %> devices tag <device-id> --tag env=prod --tag region=us-east",
|
|
1024
|
+
"<%= config.bin %> devices tag <device-id> --tag location=factory --json"
|
|
1173
1025
|
],
|
|
1174
1026
|
"flags": {
|
|
1175
1027
|
"json": {
|
|
@@ -1199,87 +1051,116 @@
|
|
|
1199
1051
|
"allowNo": false,
|
|
1200
1052
|
"type": "boolean"
|
|
1201
1053
|
},
|
|
1202
|
-
"
|
|
1203
|
-
"char": "
|
|
1204
|
-
"description": "
|
|
1205
|
-
"name": "
|
|
1206
|
-
"required": true,
|
|
1207
|
-
"hasDynamicHelp": false,
|
|
1208
|
-
"multiple": false,
|
|
1209
|
-
"type": "option"
|
|
1210
|
-
},
|
|
1211
|
-
"stream": {
|
|
1212
|
-
"char": "s",
|
|
1213
|
-
"description": "Stream name",
|
|
1214
|
-
"name": "stream",
|
|
1054
|
+
"tag": {
|
|
1055
|
+
"char": "t",
|
|
1056
|
+
"description": "Tag to add or update (key=value), can be specified multiple times",
|
|
1057
|
+
"name": "tag",
|
|
1215
1058
|
"required": true,
|
|
1216
1059
|
"hasDynamicHelp": false,
|
|
1217
|
-
"multiple":
|
|
1060
|
+
"multiple": true,
|
|
1218
1061
|
"type": "option"
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1064
|
+
"hasDynamicHelp": false,
|
|
1065
|
+
"hiddenAliases": [],
|
|
1066
|
+
"id": "devices:tag",
|
|
1067
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1068
|
+
"pluginName": "@formant/formant-cli",
|
|
1069
|
+
"pluginType": "core",
|
|
1070
|
+
"strict": true,
|
|
1071
|
+
"summary": "Add or update tags on a device",
|
|
1072
|
+
"enableJsonFlag": true,
|
|
1073
|
+
"isESM": true,
|
|
1074
|
+
"relativePath": [
|
|
1075
|
+
"dist",
|
|
1076
|
+
"commands",
|
|
1077
|
+
"devices",
|
|
1078
|
+
"tag.js"
|
|
1079
|
+
]
|
|
1080
|
+
},
|
|
1081
|
+
"devices:untag": {
|
|
1082
|
+
"aliases": [],
|
|
1083
|
+
"args": {
|
|
1084
|
+
"id": {
|
|
1085
|
+
"description": "Device ID (UUID)",
|
|
1086
|
+
"name": "id",
|
|
1087
|
+
"required": true
|
|
1088
|
+
}
|
|
1089
|
+
},
|
|
1090
|
+
"description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.",
|
|
1091
|
+
"examples": [
|
|
1092
|
+
"<%= config.bin %> devices untag <device-id> --key location",
|
|
1093
|
+
"<%= config.bin %> devices untag <device-id> --key env --key region",
|
|
1094
|
+
"<%= config.bin %> devices untag <device-id> --key location --json"
|
|
1095
|
+
],
|
|
1096
|
+
"flags": {
|
|
1097
|
+
"json": {
|
|
1098
|
+
"description": "Format output as json.",
|
|
1099
|
+
"helpGroup": "GLOBAL",
|
|
1100
|
+
"name": "json",
|
|
1101
|
+
"allowNo": false,
|
|
1102
|
+
"type": "boolean"
|
|
1219
1103
|
},
|
|
1220
|
-
"
|
|
1221
|
-
"
|
|
1222
|
-
"
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
"
|
|
1226
|
-
"
|
|
1227
|
-
"
|
|
1104
|
+
"dev": {
|
|
1105
|
+
"description": "Target the dev environment",
|
|
1106
|
+
"exclusive": [
|
|
1107
|
+
"stage"
|
|
1108
|
+
],
|
|
1109
|
+
"helpGroup": "GLOBAL",
|
|
1110
|
+
"name": "dev",
|
|
1111
|
+
"allowNo": false,
|
|
1112
|
+
"type": "boolean"
|
|
1228
1113
|
},
|
|
1229
|
-
"
|
|
1230
|
-
"description": "
|
|
1231
|
-
"
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
"
|
|
1114
|
+
"stage": {
|
|
1115
|
+
"description": "Target the stage environment",
|
|
1116
|
+
"exclusive": [
|
|
1117
|
+
"dev"
|
|
1118
|
+
],
|
|
1119
|
+
"helpGroup": "GLOBAL",
|
|
1120
|
+
"name": "stage",
|
|
1121
|
+
"allowNo": false,
|
|
1122
|
+
"type": "boolean"
|
|
1235
1123
|
},
|
|
1236
|
-
"
|
|
1237
|
-
"char": "
|
|
1238
|
-
"description": "Tag
|
|
1239
|
-
"name": "
|
|
1124
|
+
"key": {
|
|
1125
|
+
"char": "k",
|
|
1126
|
+
"description": "Tag key to remove, can be specified multiple times",
|
|
1127
|
+
"name": "key",
|
|
1128
|
+
"required": true,
|
|
1240
1129
|
"hasDynamicHelp": false,
|
|
1241
1130
|
"multiple": true,
|
|
1242
1131
|
"type": "option"
|
|
1243
|
-
},
|
|
1244
|
-
"timestamp": {
|
|
1245
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1246
|
-
"name": "timestamp",
|
|
1247
|
-
"hasDynamicHelp": false,
|
|
1248
|
-
"multiple": false,
|
|
1249
|
-
"type": "option"
|
|
1250
1132
|
}
|
|
1251
1133
|
},
|
|
1252
1134
|
"hasDynamicHelp": false,
|
|
1253
1135
|
"hiddenAliases": [],
|
|
1254
|
-
"id": "
|
|
1136
|
+
"id": "devices:untag",
|
|
1255
1137
|
"pluginAlias": "@formant/formant-cli",
|
|
1256
1138
|
"pluginName": "@formant/formant-cli",
|
|
1257
1139
|
"pluginType": "core",
|
|
1258
1140
|
"strict": true,
|
|
1259
|
-
"summary": "
|
|
1141
|
+
"summary": "Remove tags from a device",
|
|
1260
1142
|
"enableJsonFlag": true,
|
|
1261
1143
|
"isESM": true,
|
|
1262
1144
|
"relativePath": [
|
|
1263
1145
|
"dist",
|
|
1264
1146
|
"commands",
|
|
1265
|
-
"
|
|
1266
|
-
"
|
|
1147
|
+
"devices",
|
|
1148
|
+
"untag.js"
|
|
1267
1149
|
]
|
|
1268
1150
|
},
|
|
1269
|
-
"
|
|
1151
|
+
"event-triggers:get": {
|
|
1270
1152
|
"aliases": [],
|
|
1271
1153
|
"args": {
|
|
1272
|
-
"
|
|
1273
|
-
"description": "
|
|
1274
|
-
"name": "
|
|
1154
|
+
"id": {
|
|
1155
|
+
"description": "Event trigger ID (UUID)",
|
|
1156
|
+
"name": "id",
|
|
1275
1157
|
"required": true
|
|
1276
1158
|
}
|
|
1277
1159
|
},
|
|
1278
|
-
"description": "
|
|
1160
|
+
"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.",
|
|
1279
1161
|
"examples": [
|
|
1280
|
-
"<%= config.bin %>
|
|
1281
|
-
"<%= config.bin %>
|
|
1282
|
-
"<%= config.bin %> ingest json '[1,2,3,4,5]' --device <device-id> --stream array_data"
|
|
1162
|
+
"<%= config.bin %> event-triggers get <trigger-id>",
|
|
1163
|
+
"<%= config.bin %> event-triggers get <trigger-id> --json"
|
|
1283
1164
|
],
|
|
1284
1165
|
"flags": {
|
|
1285
1166
|
"json": {
|
|
@@ -1308,72 +1189,32 @@
|
|
|
1308
1189
|
"name": "stage",
|
|
1309
1190
|
"allowNo": false,
|
|
1310
1191
|
"type": "boolean"
|
|
1311
|
-
},
|
|
1312
|
-
"device": {
|
|
1313
|
-
"char": "d",
|
|
1314
|
-
"description": "Device ID (UUID)",
|
|
1315
|
-
"name": "device",
|
|
1316
|
-
"required": true,
|
|
1317
|
-
"hasDynamicHelp": false,
|
|
1318
|
-
"multiple": false,
|
|
1319
|
-
"type": "option"
|
|
1320
|
-
},
|
|
1321
|
-
"stream": {
|
|
1322
|
-
"char": "s",
|
|
1323
|
-
"description": "Stream name",
|
|
1324
|
-
"name": "stream",
|
|
1325
|
-
"required": true,
|
|
1326
|
-
"hasDynamicHelp": false,
|
|
1327
|
-
"multiple": false,
|
|
1328
|
-
"type": "option"
|
|
1329
|
-
},
|
|
1330
|
-
"tag": {
|
|
1331
|
-
"char": "t",
|
|
1332
|
-
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1333
|
-
"name": "tag",
|
|
1334
|
-
"hasDynamicHelp": false,
|
|
1335
|
-
"multiple": true,
|
|
1336
|
-
"type": "option"
|
|
1337
|
-
},
|
|
1338
|
-
"timestamp": {
|
|
1339
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1340
|
-
"name": "timestamp",
|
|
1341
|
-
"hasDynamicHelp": false,
|
|
1342
|
-
"multiple": false,
|
|
1343
|
-
"type": "option"
|
|
1344
1192
|
}
|
|
1345
1193
|
},
|
|
1346
1194
|
"hasDynamicHelp": false,
|
|
1347
1195
|
"hiddenAliases": [],
|
|
1348
|
-
"id": "
|
|
1196
|
+
"id": "event-triggers:get",
|
|
1349
1197
|
"pluginAlias": "@formant/formant-cli",
|
|
1350
1198
|
"pluginName": "@formant/formant-cli",
|
|
1351
1199
|
"pluginType": "core",
|
|
1352
1200
|
"strict": true,
|
|
1353
|
-
"summary": "
|
|
1201
|
+
"summary": "Get event trigger details",
|
|
1354
1202
|
"enableJsonFlag": true,
|
|
1355
1203
|
"isESM": true,
|
|
1356
1204
|
"relativePath": [
|
|
1357
1205
|
"dist",
|
|
1358
1206
|
"commands",
|
|
1359
|
-
"
|
|
1360
|
-
"
|
|
1207
|
+
"event-triggers",
|
|
1208
|
+
"get.js"
|
|
1361
1209
|
]
|
|
1362
1210
|
},
|
|
1363
|
-
"
|
|
1211
|
+
"event-triggers:list": {
|
|
1364
1212
|
"aliases": [],
|
|
1365
|
-
"args": {
|
|
1366
|
-
|
|
1367
|
-
"description": "Numeric value to ingest",
|
|
1368
|
-
"name": "value",
|
|
1369
|
-
"required": true
|
|
1370
|
-
}
|
|
1371
|
-
},
|
|
1372
|
-
"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.",
|
|
1213
|
+
"args": {},
|
|
1214
|
+
"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.",
|
|
1373
1215
|
"examples": [
|
|
1374
|
-
"<%= config.bin %>
|
|
1375
|
-
"<%= config.bin %>
|
|
1376
|
-
"<%= config.bin %> ingest numeric 1500 --device <device-id> --stream rpm --timestamp 1700000000000"
|
|
1216
|
+
"<%= config.bin %> event-triggers list",
|
|
1217
|
+
"<%= config.bin %> event-triggers list --json"
|
|
1377
1218
|
],
|
|
1378
1219
|
"flags": {
|
|
1379
1220
|
"json": {
|
|
@@ -1402,72 +1243,38 @@
|
|
|
1402
1243
|
"name": "stage",
|
|
1403
1244
|
"allowNo": false,
|
|
1404
1245
|
"type": "boolean"
|
|
1405
|
-
},
|
|
1406
|
-
"device": {
|
|
1407
|
-
"char": "d",
|
|
1408
|
-
"description": "Device ID (UUID)",
|
|
1409
|
-
"name": "device",
|
|
1410
|
-
"required": true,
|
|
1411
|
-
"hasDynamicHelp": false,
|
|
1412
|
-
"multiple": false,
|
|
1413
|
-
"type": "option"
|
|
1414
|
-
},
|
|
1415
|
-
"stream": {
|
|
1416
|
-
"char": "s",
|
|
1417
|
-
"description": "Stream name",
|
|
1418
|
-
"name": "stream",
|
|
1419
|
-
"required": true,
|
|
1420
|
-
"hasDynamicHelp": false,
|
|
1421
|
-
"multiple": false,
|
|
1422
|
-
"type": "option"
|
|
1423
|
-
},
|
|
1424
|
-
"tag": {
|
|
1425
|
-
"char": "t",
|
|
1426
|
-
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1427
|
-
"name": "tag",
|
|
1428
|
-
"hasDynamicHelp": false,
|
|
1429
|
-
"multiple": true,
|
|
1430
|
-
"type": "option"
|
|
1431
|
-
},
|
|
1432
|
-
"timestamp": {
|
|
1433
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1434
|
-
"name": "timestamp",
|
|
1435
|
-
"hasDynamicHelp": false,
|
|
1436
|
-
"multiple": false,
|
|
1437
|
-
"type": "option"
|
|
1438
1246
|
}
|
|
1439
1247
|
},
|
|
1440
1248
|
"hasDynamicHelp": false,
|
|
1441
1249
|
"hiddenAliases": [],
|
|
1442
|
-
"id": "
|
|
1250
|
+
"id": "event-triggers:list",
|
|
1443
1251
|
"pluginAlias": "@formant/formant-cli",
|
|
1444
1252
|
"pluginName": "@formant/formant-cli",
|
|
1445
1253
|
"pluginType": "core",
|
|
1446
1254
|
"strict": true,
|
|
1447
|
-
"summary": "
|
|
1255
|
+
"summary": "List event trigger rules",
|
|
1448
1256
|
"enableJsonFlag": true,
|
|
1449
1257
|
"isESM": true,
|
|
1450
1258
|
"relativePath": [
|
|
1451
1259
|
"dist",
|
|
1452
1260
|
"commands",
|
|
1453
|
-
"
|
|
1454
|
-
"
|
|
1261
|
+
"event-triggers",
|
|
1262
|
+
"list.js"
|
|
1455
1263
|
]
|
|
1456
1264
|
},
|
|
1457
|
-
"
|
|
1265
|
+
"events:get": {
|
|
1458
1266
|
"aliases": [],
|
|
1459
1267
|
"args": {
|
|
1460
|
-
"
|
|
1461
|
-
"description": "
|
|
1462
|
-
"name": "
|
|
1268
|
+
"id": {
|
|
1269
|
+
"description": "Event ID (UUID)",
|
|
1270
|
+
"name": "id",
|
|
1463
1271
|
"required": true
|
|
1464
1272
|
}
|
|
1465
1273
|
},
|
|
1466
|
-
"description": "
|
|
1274
|
+
"description": "Get detailed information about a specific event by its ID.",
|
|
1467
1275
|
"examples": [
|
|
1468
|
-
"<%= config.bin %>
|
|
1469
|
-
"<%= config.bin %>
|
|
1470
|
-
"<%= config.bin %> ingest text \"Checkpoint A reached\" --device <device-id> --stream waypoints"
|
|
1276
|
+
"<%= config.bin %> events get <event-id>",
|
|
1277
|
+
"<%= config.bin %> events get <event-id> --json"
|
|
1471
1278
|
],
|
|
1472
1279
|
"flags": {
|
|
1473
1280
|
"json": {
|
|
@@ -1496,66 +1303,34 @@
|
|
|
1496
1303
|
"name": "stage",
|
|
1497
1304
|
"allowNo": false,
|
|
1498
1305
|
"type": "boolean"
|
|
1499
|
-
},
|
|
1500
|
-
"device": {
|
|
1501
|
-
"char": "d",
|
|
1502
|
-
"description": "Device ID (UUID)",
|
|
1503
|
-
"name": "device",
|
|
1504
|
-
"required": true,
|
|
1505
|
-
"hasDynamicHelp": false,
|
|
1506
|
-
"multiple": false,
|
|
1507
|
-
"type": "option"
|
|
1508
|
-
},
|
|
1509
|
-
"stream": {
|
|
1510
|
-
"char": "s",
|
|
1511
|
-
"description": "Stream name",
|
|
1512
|
-
"name": "stream",
|
|
1513
|
-
"required": true,
|
|
1514
|
-
"hasDynamicHelp": false,
|
|
1515
|
-
"multiple": false,
|
|
1516
|
-
"type": "option"
|
|
1517
|
-
},
|
|
1518
|
-
"tag": {
|
|
1519
|
-
"char": "t",
|
|
1520
|
-
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1521
|
-
"name": "tag",
|
|
1522
|
-
"hasDynamicHelp": false,
|
|
1523
|
-
"multiple": true,
|
|
1524
|
-
"type": "option"
|
|
1525
|
-
},
|
|
1526
|
-
"timestamp": {
|
|
1527
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1528
|
-
"name": "timestamp",
|
|
1529
|
-
"hasDynamicHelp": false,
|
|
1530
|
-
"multiple": false,
|
|
1531
|
-
"type": "option"
|
|
1532
1306
|
}
|
|
1533
1307
|
},
|
|
1534
1308
|
"hasDynamicHelp": false,
|
|
1535
1309
|
"hiddenAliases": [],
|
|
1536
|
-
"id": "
|
|
1310
|
+
"id": "events:get",
|
|
1537
1311
|
"pluginAlias": "@formant/formant-cli",
|
|
1538
1312
|
"pluginName": "@formant/formant-cli",
|
|
1539
1313
|
"pluginType": "core",
|
|
1540
1314
|
"strict": true,
|
|
1541
|
-
"summary": "
|
|
1315
|
+
"summary": "Get an event by ID",
|
|
1542
1316
|
"enableJsonFlag": true,
|
|
1543
1317
|
"isESM": true,
|
|
1544
1318
|
"relativePath": [
|
|
1545
1319
|
"dist",
|
|
1546
1320
|
"commands",
|
|
1547
|
-
"
|
|
1548
|
-
"
|
|
1321
|
+
"events",
|
|
1322
|
+
"get.js"
|
|
1549
1323
|
]
|
|
1550
1324
|
},
|
|
1551
|
-
"
|
|
1325
|
+
"events:list": {
|
|
1552
1326
|
"aliases": [],
|
|
1553
1327
|
"args": {},
|
|
1554
|
-
"description": "
|
|
1328
|
+
"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.",
|
|
1555
1329
|
"examples": [
|
|
1556
|
-
"<%= config.bin %>
|
|
1557
|
-
"<%= config.bin %>
|
|
1558
|
-
"<%= config.bin %>
|
|
1330
|
+
"<%= config.bin %> events list",
|
|
1331
|
+
"<%= config.bin %> events list --device <id> --severity critical",
|
|
1332
|
+
"<%= config.bin %> events list --type device-offline --start 2026-01-01 --end 2026-01-02",
|
|
1333
|
+
"<%= config.bin %> events list --limit 100 --json"
|
|
1559
1334
|
],
|
|
1560
1335
|
"flags": {
|
|
1561
1336
|
"json": {
|
|
@@ -1587,57 +1362,51 @@
|
|
|
1587
1362
|
},
|
|
1588
1363
|
"device": {
|
|
1589
1364
|
"char": "d",
|
|
1590
|
-
"description": "
|
|
1365
|
+
"description": "Filter by device ID",
|
|
1591
1366
|
"name": "device",
|
|
1592
|
-
"required": true,
|
|
1593
1367
|
"hasDynamicHelp": false,
|
|
1594
1368
|
"multiple": false,
|
|
1595
1369
|
"type": "option"
|
|
1596
1370
|
},
|
|
1597
|
-
"
|
|
1598
|
-
"
|
|
1599
|
-
"
|
|
1600
|
-
"name": "stream",
|
|
1601
|
-
"required": true,
|
|
1371
|
+
"end": {
|
|
1372
|
+
"description": "End time (ISO 8601)",
|
|
1373
|
+
"name": "end",
|
|
1602
1374
|
"hasDynamicHelp": false,
|
|
1603
1375
|
"multiple": false,
|
|
1604
1376
|
"type": "option"
|
|
1605
1377
|
},
|
|
1606
|
-
"
|
|
1607
|
-
"char": "
|
|
1608
|
-
"description": "
|
|
1609
|
-
"name": "
|
|
1610
|
-
"
|
|
1378
|
+
"limit": {
|
|
1379
|
+
"char": "l",
|
|
1380
|
+
"description": "Maximum number of events to return",
|
|
1381
|
+
"name": "limit",
|
|
1382
|
+
"default": 25,
|
|
1611
1383
|
"hasDynamicHelp": false,
|
|
1612
1384
|
"multiple": false,
|
|
1613
1385
|
"type": "option"
|
|
1614
1386
|
},
|
|
1615
|
-
"
|
|
1616
|
-
"description": "
|
|
1617
|
-
"name": "
|
|
1618
|
-
"required": true,
|
|
1387
|
+
"severity": {
|
|
1388
|
+
"description": "Filter by severity",
|
|
1389
|
+
"name": "severity",
|
|
1619
1390
|
"hasDynamicHelp": false,
|
|
1620
1391
|
"multiple": false,
|
|
1392
|
+
"options": [
|
|
1393
|
+
"info",
|
|
1394
|
+
"warning",
|
|
1395
|
+
"error",
|
|
1396
|
+
"critical"
|
|
1397
|
+
],
|
|
1621
1398
|
"type": "option"
|
|
1622
1399
|
},
|
|
1623
|
-
"
|
|
1624
|
-
"description": "
|
|
1625
|
-
"name": "
|
|
1400
|
+
"start": {
|
|
1401
|
+
"description": "Start time (ISO 8601)",
|
|
1402
|
+
"name": "start",
|
|
1626
1403
|
"hasDynamicHelp": false,
|
|
1627
1404
|
"multiple": false,
|
|
1628
1405
|
"type": "option"
|
|
1629
1406
|
},
|
|
1630
|
-
"
|
|
1631
|
-
"
|
|
1632
|
-
"
|
|
1633
|
-
"name": "tag",
|
|
1634
|
-
"hasDynamicHelp": false,
|
|
1635
|
-
"multiple": true,
|
|
1636
|
-
"type": "option"
|
|
1637
|
-
},
|
|
1638
|
-
"timestamp": {
|
|
1639
|
-
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1640
|
-
"name": "timestamp",
|
|
1407
|
+
"type": {
|
|
1408
|
+
"description": "Filter by event type",
|
|
1409
|
+
"name": "type",
|
|
1641
1410
|
"hasDynamicHelp": false,
|
|
1642
1411
|
"multiple": false,
|
|
1643
1412
|
"type": "option"
|
|
@@ -1645,28 +1414,30 @@
|
|
|
1645
1414
|
},
|
|
1646
1415
|
"hasDynamicHelp": false,
|
|
1647
1416
|
"hiddenAliases": [],
|
|
1648
|
-
"id": "
|
|
1417
|
+
"id": "events:list",
|
|
1649
1418
|
"pluginAlias": "@formant/formant-cli",
|
|
1650
1419
|
"pluginName": "@formant/formant-cli",
|
|
1651
1420
|
"pluginType": "core",
|
|
1652
1421
|
"strict": true,
|
|
1653
|
-
"summary": "
|
|
1422
|
+
"summary": "View events emitted by devices",
|
|
1654
1423
|
"enableJsonFlag": true,
|
|
1655
1424
|
"isESM": true,
|
|
1656
1425
|
"relativePath": [
|
|
1657
1426
|
"dist",
|
|
1658
1427
|
"commands",
|
|
1659
|
-
"
|
|
1660
|
-
"
|
|
1428
|
+
"events",
|
|
1429
|
+
"list.js"
|
|
1661
1430
|
]
|
|
1662
1431
|
},
|
|
1663
|
-
"
|
|
1432
|
+
"ingest:batch": {
|
|
1664
1433
|
"aliases": [],
|
|
1665
1434
|
"args": {},
|
|
1666
|
-
"description": "
|
|
1435
|
+
"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).",
|
|
1667
1436
|
"examples": [
|
|
1668
|
-
"<%= config.bin %>
|
|
1669
|
-
"<%= config.bin %>
|
|
1437
|
+
"<%= config.bin %> ingest batch --file data.json",
|
|
1438
|
+
"<%= config.bin %> ingest batch --stdin < data.json",
|
|
1439
|
+
"cat payload.json | <%= config.bin %> ingest batch --stdin",
|
|
1440
|
+
"# Example payload.json with multiple types:\n{\n \"items\": [\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"battery_level\",\n \"type\": \"numeric\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, 42.5], [1708272060000, 41.8]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"status\",\n \"type\": \"text\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, \"operational\"]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"health\",\n \"type\": \"health\",\n \"tags\": {},\n \"points\": [[1708272000000, {\"status\": \"operational\"}]]\n }\n ]\n}"
|
|
1670
1441
|
],
|
|
1671
1442
|
"flags": {
|
|
1672
1443
|
"json": {
|
|
@@ -1695,34 +1466,53 @@
|
|
|
1695
1466
|
"name": "stage",
|
|
1696
1467
|
"allowNo": false,
|
|
1697
1468
|
"type": "boolean"
|
|
1469
|
+
},
|
|
1470
|
+
"file": {
|
|
1471
|
+
"char": "f",
|
|
1472
|
+
"description": "Path to JSON file containing batch payload",
|
|
1473
|
+
"exclusive": [
|
|
1474
|
+
"stdin"
|
|
1475
|
+
],
|
|
1476
|
+
"name": "file",
|
|
1477
|
+
"hasDynamicHelp": false,
|
|
1478
|
+
"multiple": false,
|
|
1479
|
+
"type": "option"
|
|
1480
|
+
},
|
|
1481
|
+
"stdin": {
|
|
1482
|
+
"description": "Read JSON payload from stdin",
|
|
1483
|
+
"exclusive": [
|
|
1484
|
+
"file"
|
|
1485
|
+
],
|
|
1486
|
+
"name": "stdin",
|
|
1487
|
+
"allowNo": false,
|
|
1488
|
+
"type": "boolean"
|
|
1698
1489
|
}
|
|
1699
1490
|
},
|
|
1700
1491
|
"hasDynamicHelp": false,
|
|
1701
1492
|
"hiddenAliases": [],
|
|
1702
|
-
"id": "
|
|
1493
|
+
"id": "ingest:batch",
|
|
1703
1494
|
"pluginAlias": "@formant/formant-cli",
|
|
1704
1495
|
"pluginName": "@formant/formant-cli",
|
|
1705
1496
|
"pluginType": "core",
|
|
1706
1497
|
"strict": true,
|
|
1707
|
-
"summary": "
|
|
1498
|
+
"summary": "Ingest batch data from file or stdin",
|
|
1708
1499
|
"enableJsonFlag": true,
|
|
1709
1500
|
"isESM": true,
|
|
1710
1501
|
"relativePath": [
|
|
1711
1502
|
"dist",
|
|
1712
1503
|
"commands",
|
|
1713
|
-
"
|
|
1714
|
-
"
|
|
1504
|
+
"ingest",
|
|
1505
|
+
"batch.js"
|
|
1715
1506
|
]
|
|
1716
1507
|
},
|
|
1717
|
-
"
|
|
1508
|
+
"ingest:bitset": {
|
|
1718
1509
|
"aliases": [],
|
|
1719
1510
|
"args": {},
|
|
1720
|
-
"description": "
|
|
1511
|
+
"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",
|
|
1721
1512
|
"examples": [
|
|
1722
|
-
"<%= config.bin %>
|
|
1723
|
-
"<%= config.bin %>
|
|
1724
|
-
"<%= config.bin %>
|
|
1725
|
-
"<%= config.bin %> org update --name \"My Fleet\" --json"
|
|
1513
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream sensors --keys \"door,window,motion\" --values \"true,false,true\"",
|
|
1514
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream flags --keys \"active,paused,error\" --values \"true,false,false\" --tag system=main",
|
|
1515
|
+
"<%= config.bin %> ingest bitset --device <device-id> --stream states --keys \"a,b\" --values \"false,true\""
|
|
1726
1516
|
],
|
|
1727
1517
|
"flags": {
|
|
1728
1518
|
"json": {
|
|
@@ -1752,18 +1542,53 @@
|
|
|
1752
1542
|
"allowNo": false,
|
|
1753
1543
|
"type": "boolean"
|
|
1754
1544
|
},
|
|
1755
|
-
"
|
|
1545
|
+
"device": {
|
|
1756
1546
|
"char": "d",
|
|
1757
|
-
"description": "
|
|
1758
|
-
"name": "
|
|
1547
|
+
"description": "Device ID (UUID)",
|
|
1548
|
+
"name": "device",
|
|
1549
|
+
"required": true,
|
|
1759
1550
|
"hasDynamicHelp": false,
|
|
1760
1551
|
"multiple": false,
|
|
1761
1552
|
"type": "option"
|
|
1762
1553
|
},
|
|
1763
|
-
"
|
|
1764
|
-
"char": "
|
|
1765
|
-
"description": "
|
|
1766
|
-
"name": "
|
|
1554
|
+
"stream": {
|
|
1555
|
+
"char": "s",
|
|
1556
|
+
"description": "Stream name",
|
|
1557
|
+
"name": "stream",
|
|
1558
|
+
"required": true,
|
|
1559
|
+
"hasDynamicHelp": false,
|
|
1560
|
+
"multiple": false,
|
|
1561
|
+
"type": "option"
|
|
1562
|
+
},
|
|
1563
|
+
"keys": {
|
|
1564
|
+
"char": "k",
|
|
1565
|
+
"description": "Comma-separated list of key names (1-1000 keys, max 255 chars each)",
|
|
1566
|
+
"name": "keys",
|
|
1567
|
+
"required": true,
|
|
1568
|
+
"hasDynamicHelp": false,
|
|
1569
|
+
"multiple": false,
|
|
1570
|
+
"type": "option"
|
|
1571
|
+
},
|
|
1572
|
+
"values": {
|
|
1573
|
+
"char": "v",
|
|
1574
|
+
"description": "Comma-separated list of boolean values (true/false, must match key count)",
|
|
1575
|
+
"name": "values",
|
|
1576
|
+
"required": true,
|
|
1577
|
+
"hasDynamicHelp": false,
|
|
1578
|
+
"multiple": false,
|
|
1579
|
+
"type": "option"
|
|
1580
|
+
},
|
|
1581
|
+
"tag": {
|
|
1582
|
+
"char": "t",
|
|
1583
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1584
|
+
"name": "tag",
|
|
1585
|
+
"hasDynamicHelp": false,
|
|
1586
|
+
"multiple": true,
|
|
1587
|
+
"type": "option"
|
|
1588
|
+
},
|
|
1589
|
+
"timestamp": {
|
|
1590
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1591
|
+
"name": "timestamp",
|
|
1767
1592
|
"hasDynamicHelp": false,
|
|
1768
1593
|
"multiple": false,
|
|
1769
1594
|
"type": "option"
|
|
@@ -1771,34 +1596,29 @@
|
|
|
1771
1596
|
},
|
|
1772
1597
|
"hasDynamicHelp": false,
|
|
1773
1598
|
"hiddenAliases": [],
|
|
1774
|
-
"id": "
|
|
1599
|
+
"id": "ingest:bitset",
|
|
1775
1600
|
"pluginAlias": "@formant/formant-cli",
|
|
1776
1601
|
"pluginName": "@formant/formant-cli",
|
|
1777
1602
|
"pluginType": "core",
|
|
1778
1603
|
"strict": true,
|
|
1779
|
-
"summary": "
|
|
1604
|
+
"summary": "Ingest bitset data",
|
|
1780
1605
|
"enableJsonFlag": true,
|
|
1781
1606
|
"isESM": true,
|
|
1782
1607
|
"relativePath": [
|
|
1783
1608
|
"dist",
|
|
1784
1609
|
"commands",
|
|
1785
|
-
"
|
|
1786
|
-
"
|
|
1610
|
+
"ingest",
|
|
1611
|
+
"bitset.js"
|
|
1787
1612
|
]
|
|
1788
1613
|
},
|
|
1789
|
-
"
|
|
1614
|
+
"ingest:health": {
|
|
1790
1615
|
"aliases": [],
|
|
1791
|
-
"args": {
|
|
1792
|
-
|
|
1793
|
-
"description": "Key to retrieve",
|
|
1794
|
-
"name": "key",
|
|
1795
|
-
"required": true
|
|
1796
|
-
}
|
|
1797
|
-
},
|
|
1798
|
-
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
1616
|
+
"args": {},
|
|
1617
|
+
"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.",
|
|
1799
1618
|
"examples": [
|
|
1800
|
-
"<%= config.bin %>
|
|
1801
|
-
"<%= config.bin %>
|
|
1619
|
+
"<%= config.bin %> ingest health --device <device-id> --stream system_health --status operational",
|
|
1620
|
+
"<%= config.bin %> ingest health --device <device-id> --stream health --status error --tag component=motor",
|
|
1621
|
+
"<%= config.bin %> ingest health --device <device-id> --stream sync --status operational --clock-skew 150"
|
|
1802
1622
|
],
|
|
1803
1623
|
"flags": {
|
|
1804
1624
|
"json": {
|
|
@@ -1827,34 +1647,87 @@
|
|
|
1827
1647
|
"name": "stage",
|
|
1828
1648
|
"allowNo": false,
|
|
1829
1649
|
"type": "boolean"
|
|
1650
|
+
},
|
|
1651
|
+
"device": {
|
|
1652
|
+
"char": "d",
|
|
1653
|
+
"description": "Device ID (UUID)",
|
|
1654
|
+
"name": "device",
|
|
1655
|
+
"required": true,
|
|
1656
|
+
"hasDynamicHelp": false,
|
|
1657
|
+
"multiple": false,
|
|
1658
|
+
"type": "option"
|
|
1659
|
+
},
|
|
1660
|
+
"stream": {
|
|
1661
|
+
"char": "s",
|
|
1662
|
+
"description": "Stream name",
|
|
1663
|
+
"name": "stream",
|
|
1664
|
+
"required": true,
|
|
1665
|
+
"hasDynamicHelp": false,
|
|
1666
|
+
"multiple": false,
|
|
1667
|
+
"type": "option"
|
|
1668
|
+
},
|
|
1669
|
+
"status": {
|
|
1670
|
+
"description": "Health status (unknown, operational, offline, or error)",
|
|
1671
|
+
"name": "status",
|
|
1672
|
+
"required": true,
|
|
1673
|
+
"hasDynamicHelp": false,
|
|
1674
|
+
"multiple": false,
|
|
1675
|
+
"options": [
|
|
1676
|
+
"unknown",
|
|
1677
|
+
"operational",
|
|
1678
|
+
"offline",
|
|
1679
|
+
"error"
|
|
1680
|
+
],
|
|
1681
|
+
"type": "option"
|
|
1682
|
+
},
|
|
1683
|
+
"clock-skew": {
|
|
1684
|
+
"description": "Clock skew in milliseconds (optional)",
|
|
1685
|
+
"name": "clock-skew",
|
|
1686
|
+
"hasDynamicHelp": false,
|
|
1687
|
+
"multiple": false,
|
|
1688
|
+
"type": "option"
|
|
1689
|
+
},
|
|
1690
|
+
"tag": {
|
|
1691
|
+
"char": "t",
|
|
1692
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1693
|
+
"name": "tag",
|
|
1694
|
+
"hasDynamicHelp": false,
|
|
1695
|
+
"multiple": true,
|
|
1696
|
+
"type": "option"
|
|
1697
|
+
},
|
|
1698
|
+
"timestamp": {
|
|
1699
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1700
|
+
"name": "timestamp",
|
|
1701
|
+
"hasDynamicHelp": false,
|
|
1702
|
+
"multiple": false,
|
|
1703
|
+
"type": "option"
|
|
1830
1704
|
}
|
|
1831
1705
|
},
|
|
1832
1706
|
"hasDynamicHelp": false,
|
|
1833
1707
|
"hiddenAliases": [],
|
|
1834
|
-
"id": "
|
|
1708
|
+
"id": "ingest:health",
|
|
1835
1709
|
"pluginAlias": "@formant/formant-cli",
|
|
1836
1710
|
"pluginName": "@formant/formant-cli",
|
|
1837
1711
|
"pluginType": "core",
|
|
1838
1712
|
"strict": true,
|
|
1839
|
-
"summary": "
|
|
1713
|
+
"summary": "Ingest health status data",
|
|
1840
1714
|
"enableJsonFlag": true,
|
|
1841
1715
|
"isESM": true,
|
|
1842
1716
|
"relativePath": [
|
|
1843
1717
|
"dist",
|
|
1844
1718
|
"commands",
|
|
1845
|
-
"
|
|
1846
|
-
"
|
|
1719
|
+
"ingest",
|
|
1720
|
+
"health.js"
|
|
1847
1721
|
]
|
|
1848
1722
|
},
|
|
1849
|
-
"
|
|
1723
|
+
"ingest:image": {
|
|
1850
1724
|
"aliases": [],
|
|
1851
1725
|
"args": {},
|
|
1852
|
-
"description": "
|
|
1726
|
+
"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.",
|
|
1853
1727
|
"examples": [
|
|
1854
|
-
"<%= config.bin %>
|
|
1855
|
-
"<%= config.bin %>
|
|
1856
|
-
"<%= config.bin %>
|
|
1857
|
-
"<%= config.bin %> kv list --json"
|
|
1728
|
+
"<%= config.bin %> ingest image --device <device-id> --stream camera_front --url https://example.com/image.jpg",
|
|
1729
|
+
"<%= config.bin %> ingest image --device <device-id> --stream snapshot --url https://example.com/snap.png --size 1024000",
|
|
1730
|
+
"<%= config.bin %> ingest image --device <device-id> --stream detection --url https://example.com/detect.jpg --tag frame=123"
|
|
1858
1731
|
],
|
|
1859
1732
|
"flags": {
|
|
1860
1733
|
"json": {
|
|
@@ -1884,18 +1757,51 @@
|
|
|
1884
1757
|
"allowNo": false,
|
|
1885
1758
|
"type": "boolean"
|
|
1886
1759
|
},
|
|
1887
|
-
"
|
|
1888
|
-
"char": "
|
|
1889
|
-
"description": "
|
|
1890
|
-
"name": "
|
|
1760
|
+
"device": {
|
|
1761
|
+
"char": "d",
|
|
1762
|
+
"description": "Device ID (UUID)",
|
|
1763
|
+
"name": "device",
|
|
1764
|
+
"required": true,
|
|
1765
|
+
"hasDynamicHelp": false,
|
|
1766
|
+
"multiple": false,
|
|
1767
|
+
"type": "option"
|
|
1768
|
+
},
|
|
1769
|
+
"stream": {
|
|
1770
|
+
"char": "s",
|
|
1771
|
+
"description": "Stream name",
|
|
1772
|
+
"name": "stream",
|
|
1773
|
+
"required": true,
|
|
1774
|
+
"hasDynamicHelp": false,
|
|
1775
|
+
"multiple": false,
|
|
1776
|
+
"type": "option"
|
|
1777
|
+
},
|
|
1778
|
+
"url": {
|
|
1779
|
+
"char": "u",
|
|
1780
|
+
"description": "Image URL (must be http:// or https://)",
|
|
1781
|
+
"name": "url",
|
|
1782
|
+
"required": true,
|
|
1783
|
+
"hasDynamicHelp": false,
|
|
1784
|
+
"multiple": false,
|
|
1785
|
+
"type": "option"
|
|
1786
|
+
},
|
|
1787
|
+
"size": {
|
|
1788
|
+
"description": "Image size in bytes (optional)",
|
|
1789
|
+
"name": "size",
|
|
1790
|
+
"hasDynamicHelp": false,
|
|
1791
|
+
"multiple": false,
|
|
1792
|
+
"type": "option"
|
|
1793
|
+
},
|
|
1794
|
+
"tag": {
|
|
1795
|
+
"char": "t",
|
|
1796
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1797
|
+
"name": "tag",
|
|
1891
1798
|
"hasDynamicHelp": false,
|
|
1892
1799
|
"multiple": true,
|
|
1893
1800
|
"type": "option"
|
|
1894
1801
|
},
|
|
1895
|
-
"
|
|
1896
|
-
"
|
|
1897
|
-
"
|
|
1898
|
-
"name": "prefix",
|
|
1802
|
+
"timestamp": {
|
|
1803
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1804
|
+
"name": "timestamp",
|
|
1899
1805
|
"hasDynamicHelp": false,
|
|
1900
1806
|
"multiple": false,
|
|
1901
1807
|
"type": "option"
|
|
@@ -1903,39 +1809,35 @@
|
|
|
1903
1809
|
},
|
|
1904
1810
|
"hasDynamicHelp": false,
|
|
1905
1811
|
"hiddenAliases": [],
|
|
1906
|
-
"id": "
|
|
1812
|
+
"id": "ingest:image",
|
|
1907
1813
|
"pluginAlias": "@formant/formant-cli",
|
|
1908
1814
|
"pluginName": "@formant/formant-cli",
|
|
1909
1815
|
"pluginType": "core",
|
|
1910
1816
|
"strict": true,
|
|
1911
|
-
"summary": "
|
|
1817
|
+
"summary": "Ingest image data",
|
|
1912
1818
|
"enableJsonFlag": true,
|
|
1913
1819
|
"isESM": true,
|
|
1914
1820
|
"relativePath": [
|
|
1915
1821
|
"dist",
|
|
1916
1822
|
"commands",
|
|
1917
|
-
"
|
|
1918
|
-
"
|
|
1823
|
+
"ingest",
|
|
1824
|
+
"image.js"
|
|
1919
1825
|
]
|
|
1920
1826
|
},
|
|
1921
|
-
"
|
|
1827
|
+
"ingest:json": {
|
|
1922
1828
|
"aliases": [],
|
|
1923
1829
|
"args": {
|
|
1924
|
-
"key": {
|
|
1925
|
-
"description": "Key to set",
|
|
1926
|
-
"name": "key",
|
|
1927
|
-
"required": true
|
|
1928
|
-
},
|
|
1929
1830
|
"value": {
|
|
1930
|
-
"description": "
|
|
1831
|
+
"description": "JSON value to ingest (as a JSON string)",
|
|
1931
1832
|
"name": "value",
|
|
1932
1833
|
"required": true
|
|
1933
1834
|
}
|
|
1934
1835
|
},
|
|
1935
|
-
"description": "
|
|
1836
|
+
"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.",
|
|
1936
1837
|
"examples": [
|
|
1937
|
-
"<%= config.bin %>
|
|
1938
|
-
"<%= config.bin %>
|
|
1838
|
+
"<%= config.bin %> ingest json '{\"x\":1,\"y\":2}' --device <device-id> --stream position",
|
|
1839
|
+
"<%= config.bin %> ingest json '{\"status\":\"active\",\"mode\":\"auto\"}' --device <device-id> --stream config",
|
|
1840
|
+
"<%= config.bin %> ingest json '[1,2,3,4,5]' --device <device-id> --stream array_data"
|
|
1939
1841
|
],
|
|
1940
1842
|
"flags": {
|
|
1941
1843
|
"json": {
|
|
@@ -1964,33 +1866,72 @@
|
|
|
1964
1866
|
"name": "stage",
|
|
1965
1867
|
"allowNo": false,
|
|
1966
1868
|
"type": "boolean"
|
|
1869
|
+
},
|
|
1870
|
+
"device": {
|
|
1871
|
+
"char": "d",
|
|
1872
|
+
"description": "Device ID (UUID)",
|
|
1873
|
+
"name": "device",
|
|
1874
|
+
"required": true,
|
|
1875
|
+
"hasDynamicHelp": false,
|
|
1876
|
+
"multiple": false,
|
|
1877
|
+
"type": "option"
|
|
1878
|
+
},
|
|
1879
|
+
"stream": {
|
|
1880
|
+
"char": "s",
|
|
1881
|
+
"description": "Stream name",
|
|
1882
|
+
"name": "stream",
|
|
1883
|
+
"required": true,
|
|
1884
|
+
"hasDynamicHelp": false,
|
|
1885
|
+
"multiple": false,
|
|
1886
|
+
"type": "option"
|
|
1887
|
+
},
|
|
1888
|
+
"tag": {
|
|
1889
|
+
"char": "t",
|
|
1890
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1891
|
+
"name": "tag",
|
|
1892
|
+
"hasDynamicHelp": false,
|
|
1893
|
+
"multiple": true,
|
|
1894
|
+
"type": "option"
|
|
1895
|
+
},
|
|
1896
|
+
"timestamp": {
|
|
1897
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1898
|
+
"name": "timestamp",
|
|
1899
|
+
"hasDynamicHelp": false,
|
|
1900
|
+
"multiple": false,
|
|
1901
|
+
"type": "option"
|
|
1967
1902
|
}
|
|
1968
1903
|
},
|
|
1969
1904
|
"hasDynamicHelp": false,
|
|
1970
1905
|
"hiddenAliases": [],
|
|
1971
|
-
"id": "
|
|
1906
|
+
"id": "ingest:json",
|
|
1972
1907
|
"pluginAlias": "@formant/formant-cli",
|
|
1973
1908
|
"pluginName": "@formant/formant-cli",
|
|
1974
1909
|
"pluginType": "core",
|
|
1975
1910
|
"strict": true,
|
|
1976
|
-
"summary": "
|
|
1911
|
+
"summary": "Ingest JSON data",
|
|
1977
1912
|
"enableJsonFlag": true,
|
|
1978
1913
|
"isESM": true,
|
|
1979
1914
|
"relativePath": [
|
|
1980
1915
|
"dist",
|
|
1981
1916
|
"commands",
|
|
1982
|
-
"
|
|
1983
|
-
"
|
|
1917
|
+
"ingest",
|
|
1918
|
+
"json.js"
|
|
1984
1919
|
]
|
|
1985
1920
|
},
|
|
1986
|
-
"
|
|
1921
|
+
"ingest:numeric": {
|
|
1987
1922
|
"aliases": [],
|
|
1988
|
-
"args": {
|
|
1989
|
-
|
|
1923
|
+
"args": {
|
|
1924
|
+
"value": {
|
|
1925
|
+
"description": "Numeric value to ingest",
|
|
1926
|
+
"name": "value",
|
|
1927
|
+
"required": true
|
|
1928
|
+
}
|
|
1929
|
+
},
|
|
1930
|
+
"description": "Ingest a numeric data point to a device stream.\n\nSends a single numeric value to the specified device stream. The value must be a valid number.\nNumeric streams are commonly used for sensor readings like battery level, temperature, speed, etc.",
|
|
1990
1931
|
"examples": [
|
|
1991
|
-
"<%= config.bin %>
|
|
1992
|
-
"<%= config.bin %>
|
|
1993
|
-
"<%= config.bin %>
|
|
1932
|
+
"<%= config.bin %> ingest numeric 42.5 --device <device-id> --stream battery_level",
|
|
1933
|
+
"<%= config.bin %> ingest numeric 98.6 --device <device-id> --stream temperature --tag unit=fahrenheit",
|
|
1934
|
+
"<%= config.bin %> ingest numeric 1500 --device <device-id> --stream rpm --timestamp 1700000000000"
|
|
1994
1935
|
],
|
|
1995
1936
|
"flags": {
|
|
1996
1937
|
"json": {
|
|
@@ -2020,41 +1961,35 @@
|
|
|
2020
1961
|
"allowNo": false,
|
|
2021
1962
|
"type": "boolean"
|
|
2022
1963
|
},
|
|
2023
|
-
"
|
|
2024
|
-
"
|
|
2025
|
-
"
|
|
1964
|
+
"device": {
|
|
1965
|
+
"char": "d",
|
|
1966
|
+
"description": "Device ID (UUID)",
|
|
1967
|
+
"name": "device",
|
|
2026
1968
|
"required": true,
|
|
2027
1969
|
"hasDynamicHelp": false,
|
|
2028
1970
|
"multiple": false,
|
|
2029
1971
|
"type": "option"
|
|
2030
1972
|
},
|
|
2031
|
-
"
|
|
2032
|
-
"
|
|
2033
|
-
"
|
|
1973
|
+
"stream": {
|
|
1974
|
+
"char": "s",
|
|
1975
|
+
"description": "Stream name",
|
|
1976
|
+
"name": "stream",
|
|
1977
|
+
"required": true,
|
|
2034
1978
|
"hasDynamicHelp": false,
|
|
2035
1979
|
"multiple": false,
|
|
2036
|
-
"options": [
|
|
2037
|
-
"resultType",
|
|
2038
|
-
"signalType"
|
|
2039
|
-
],
|
|
2040
1980
|
"type": "option"
|
|
2041
1981
|
},
|
|
2042
|
-
"
|
|
2043
|
-
"
|
|
2044
|
-
"
|
|
2045
|
-
"
|
|
1982
|
+
"tag": {
|
|
1983
|
+
"char": "t",
|
|
1984
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
1985
|
+
"name": "tag",
|
|
2046
1986
|
"hasDynamicHelp": false,
|
|
2047
|
-
"multiple":
|
|
2048
|
-
"options": [
|
|
2049
|
-
"daily",
|
|
2050
|
-
"hourly"
|
|
2051
|
-
],
|
|
1987
|
+
"multiple": true,
|
|
2052
1988
|
"type": "option"
|
|
2053
1989
|
},
|
|
2054
|
-
"
|
|
2055
|
-
"description": "
|
|
2056
|
-
"name": "
|
|
2057
|
-
"required": true,
|
|
1990
|
+
"timestamp": {
|
|
1991
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
1992
|
+
"name": "timestamp",
|
|
2058
1993
|
"hasDynamicHelp": false,
|
|
2059
1994
|
"multiple": false,
|
|
2060
1995
|
"type": "option"
|
|
@@ -2062,34 +1997,35 @@
|
|
|
2062
1997
|
},
|
|
2063
1998
|
"hasDynamicHelp": false,
|
|
2064
1999
|
"hiddenAliases": [],
|
|
2065
|
-
"id": "
|
|
2000
|
+
"id": "ingest:numeric",
|
|
2066
2001
|
"pluginAlias": "@formant/formant-cli",
|
|
2067
2002
|
"pluginName": "@formant/formant-cli",
|
|
2068
2003
|
"pluginType": "core",
|
|
2069
2004
|
"strict": true,
|
|
2070
|
-
"summary": "
|
|
2005
|
+
"summary": "Ingest numeric data",
|
|
2071
2006
|
"enableJsonFlag": true,
|
|
2072
2007
|
"isESM": true,
|
|
2073
2008
|
"relativePath": [
|
|
2074
2009
|
"dist",
|
|
2075
2010
|
"commands",
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2011
|
+
"ingest",
|
|
2012
|
+
"numeric.js"
|
|
2078
2013
|
]
|
|
2079
2014
|
},
|
|
2080
|
-
"
|
|
2015
|
+
"ingest:text": {
|
|
2081
2016
|
"aliases": [],
|
|
2082
2017
|
"args": {
|
|
2083
|
-
"
|
|
2084
|
-
"description": "
|
|
2085
|
-
"name": "
|
|
2018
|
+
"value": {
|
|
2019
|
+
"description": "Text value to ingest",
|
|
2020
|
+
"name": "value",
|
|
2086
2021
|
"required": true
|
|
2087
2022
|
}
|
|
2088
2023
|
},
|
|
2089
|
-
"description": "
|
|
2024
|
+
"description": "Ingest a text data point to a device stream.\n\nSends a single text/string value to the specified device stream. Text streams are commonly\nused for logs, status messages, error messages, and other string data.",
|
|
2090
2025
|
"examples": [
|
|
2091
|
-
"<%= config.bin %>
|
|
2092
|
-
"<%= config.bin %>
|
|
2026
|
+
"<%= config.bin %> ingest text \"Robot started successfully\" --device <device-id> --stream status",
|
|
2027
|
+
"<%= config.bin %> ingest text \"Error: sensor offline\" --device <device-id> --stream errors --tag severity=high",
|
|
2028
|
+
"<%= config.bin %> ingest text \"Checkpoint A reached\" --device <device-id> --stream waypoints"
|
|
2093
2029
|
],
|
|
2094
2030
|
"flags": {
|
|
2095
2031
|
"json": {
|
|
@@ -2118,33 +2054,66 @@
|
|
|
2118
2054
|
"name": "stage",
|
|
2119
2055
|
"allowNo": false,
|
|
2120
2056
|
"type": "boolean"
|
|
2057
|
+
},
|
|
2058
|
+
"device": {
|
|
2059
|
+
"char": "d",
|
|
2060
|
+
"description": "Device ID (UUID)",
|
|
2061
|
+
"name": "device",
|
|
2062
|
+
"required": true,
|
|
2063
|
+
"hasDynamicHelp": false,
|
|
2064
|
+
"multiple": false,
|
|
2065
|
+
"type": "option"
|
|
2066
|
+
},
|
|
2067
|
+
"stream": {
|
|
2068
|
+
"char": "s",
|
|
2069
|
+
"description": "Stream name",
|
|
2070
|
+
"name": "stream",
|
|
2071
|
+
"required": true,
|
|
2072
|
+
"hasDynamicHelp": false,
|
|
2073
|
+
"multiple": false,
|
|
2074
|
+
"type": "option"
|
|
2075
|
+
},
|
|
2076
|
+
"tag": {
|
|
2077
|
+
"char": "t",
|
|
2078
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2079
|
+
"name": "tag",
|
|
2080
|
+
"hasDynamicHelp": false,
|
|
2081
|
+
"multiple": true,
|
|
2082
|
+
"type": "option"
|
|
2083
|
+
},
|
|
2084
|
+
"timestamp": {
|
|
2085
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2086
|
+
"name": "timestamp",
|
|
2087
|
+
"hasDynamicHelp": false,
|
|
2088
|
+
"multiple": false,
|
|
2089
|
+
"type": "option"
|
|
2121
2090
|
}
|
|
2122
2091
|
},
|
|
2123
2092
|
"hasDynamicHelp": false,
|
|
2124
2093
|
"hiddenAliases": [],
|
|
2125
|
-
"id": "
|
|
2094
|
+
"id": "ingest:text",
|
|
2126
2095
|
"pluginAlias": "@formant/formant-cli",
|
|
2127
2096
|
"pluginName": "@formant/formant-cli",
|
|
2128
2097
|
"pluginType": "core",
|
|
2129
2098
|
"strict": true,
|
|
2130
|
-
"summary": "
|
|
2099
|
+
"summary": "Ingest text data",
|
|
2131
2100
|
"enableJsonFlag": true,
|
|
2132
2101
|
"isESM": true,
|
|
2133
2102
|
"relativePath": [
|
|
2134
2103
|
"dist",
|
|
2135
2104
|
"commands",
|
|
2136
|
-
"
|
|
2137
|
-
"
|
|
2105
|
+
"ingest",
|
|
2106
|
+
"text.js"
|
|
2138
2107
|
]
|
|
2139
2108
|
},
|
|
2140
|
-
"
|
|
2109
|
+
"ingest:video": {
|
|
2141
2110
|
"aliases": [],
|
|
2142
2111
|
"args": {},
|
|
2143
|
-
"description": "
|
|
2112
|
+
"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).",
|
|
2144
2113
|
"examples": [
|
|
2145
|
-
"<%= config.bin %>
|
|
2146
|
-
"<%= config.bin %>
|
|
2147
|
-
"<%= config.bin %>
|
|
2114
|
+
"<%= config.bin %> ingest video --device <device-id> --stream recordings --url https://example.com/video.mp4 --duration 5000",
|
|
2115
|
+
"<%= config.bin %> ingest video --device <device-id> --stream clips --url https://example.com/clip.webm --duration 3500 --size 2048000",
|
|
2116
|
+
"<%= config.bin %> ingest video --device <device-id> --stream event_video --url https://example.com/event.mov --duration 10000 --tag event=collision"
|
|
2148
2117
|
],
|
|
2149
2118
|
"flags": {
|
|
2150
2119
|
"json": {
|
|
@@ -2154,69 +2123,114 @@
|
|
|
2154
2123
|
"allowNo": false,
|
|
2155
2124
|
"type": "boolean"
|
|
2156
2125
|
},
|
|
2157
|
-
"dev": {
|
|
2158
|
-
"description": "Target the dev environment",
|
|
2159
|
-
"exclusive": [
|
|
2160
|
-
"stage"
|
|
2161
|
-
],
|
|
2162
|
-
"helpGroup": "GLOBAL",
|
|
2163
|
-
"name": "dev",
|
|
2164
|
-
"allowNo": false,
|
|
2165
|
-
"type": "boolean"
|
|
2126
|
+
"dev": {
|
|
2127
|
+
"description": "Target the dev environment",
|
|
2128
|
+
"exclusive": [
|
|
2129
|
+
"stage"
|
|
2130
|
+
],
|
|
2131
|
+
"helpGroup": "GLOBAL",
|
|
2132
|
+
"name": "dev",
|
|
2133
|
+
"allowNo": false,
|
|
2134
|
+
"type": "boolean"
|
|
2135
|
+
},
|
|
2136
|
+
"stage": {
|
|
2137
|
+
"description": "Target the stage environment",
|
|
2138
|
+
"exclusive": [
|
|
2139
|
+
"dev"
|
|
2140
|
+
],
|
|
2141
|
+
"helpGroup": "GLOBAL",
|
|
2142
|
+
"name": "stage",
|
|
2143
|
+
"allowNo": false,
|
|
2144
|
+
"type": "boolean"
|
|
2145
|
+
},
|
|
2146
|
+
"device": {
|
|
2147
|
+
"char": "d",
|
|
2148
|
+
"description": "Device ID (UUID)",
|
|
2149
|
+
"name": "device",
|
|
2150
|
+
"required": true,
|
|
2151
|
+
"hasDynamicHelp": false,
|
|
2152
|
+
"multiple": false,
|
|
2153
|
+
"type": "option"
|
|
2154
|
+
},
|
|
2155
|
+
"stream": {
|
|
2156
|
+
"char": "s",
|
|
2157
|
+
"description": "Stream name",
|
|
2158
|
+
"name": "stream",
|
|
2159
|
+
"required": true,
|
|
2160
|
+
"hasDynamicHelp": false,
|
|
2161
|
+
"multiple": false,
|
|
2162
|
+
"type": "option"
|
|
2163
|
+
},
|
|
2164
|
+
"url": {
|
|
2165
|
+
"char": "u",
|
|
2166
|
+
"description": "Video URL (must be http:// or https://)",
|
|
2167
|
+
"name": "url",
|
|
2168
|
+
"required": true,
|
|
2169
|
+
"hasDynamicHelp": false,
|
|
2170
|
+
"multiple": false,
|
|
2171
|
+
"type": "option"
|
|
2172
|
+
},
|
|
2173
|
+
"duration": {
|
|
2174
|
+
"description": "Video duration in milliseconds (required)",
|
|
2175
|
+
"name": "duration",
|
|
2176
|
+
"required": true,
|
|
2177
|
+
"hasDynamicHelp": false,
|
|
2178
|
+
"multiple": false,
|
|
2179
|
+
"type": "option"
|
|
2166
2180
|
},
|
|
2167
|
-
"
|
|
2168
|
-
"description": "
|
|
2169
|
-
"
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
"
|
|
2173
|
-
"name": "stage",
|
|
2174
|
-
"allowNo": false,
|
|
2175
|
-
"type": "boolean"
|
|
2181
|
+
"size": {
|
|
2182
|
+
"description": "Video size in bytes (optional)",
|
|
2183
|
+
"name": "size",
|
|
2184
|
+
"hasDynamicHelp": false,
|
|
2185
|
+
"multiple": false,
|
|
2186
|
+
"type": "option"
|
|
2176
2187
|
},
|
|
2177
|
-
"
|
|
2178
|
-
"
|
|
2179
|
-
"
|
|
2180
|
-
"
|
|
2181
|
-
"
|
|
2188
|
+
"tag": {
|
|
2189
|
+
"char": "t",
|
|
2190
|
+
"description": "Tag as key=value where both are strings (can be specified multiple times)",
|
|
2191
|
+
"name": "tag",
|
|
2192
|
+
"hasDynamicHelp": false,
|
|
2193
|
+
"multiple": true,
|
|
2194
|
+
"type": "option"
|
|
2195
|
+
},
|
|
2196
|
+
"timestamp": {
|
|
2197
|
+
"description": "Unix timestamp in milliseconds (defaults to now)",
|
|
2198
|
+
"name": "timestamp",
|
|
2199
|
+
"hasDynamicHelp": false,
|
|
2200
|
+
"multiple": false,
|
|
2201
|
+
"type": "option"
|
|
2182
2202
|
}
|
|
2183
2203
|
},
|
|
2184
2204
|
"hasDynamicHelp": false,
|
|
2185
2205
|
"hiddenAliases": [],
|
|
2186
|
-
"id": "
|
|
2206
|
+
"id": "ingest:video",
|
|
2187
2207
|
"pluginAlias": "@formant/formant-cli",
|
|
2188
2208
|
"pluginName": "@formant/formant-cli",
|
|
2189
2209
|
"pluginType": "core",
|
|
2190
2210
|
"strict": true,
|
|
2191
|
-
"summary": "
|
|
2211
|
+
"summary": "Ingest video data",
|
|
2192
2212
|
"enableJsonFlag": true,
|
|
2193
2213
|
"isESM": true,
|
|
2194
2214
|
"relativePath": [
|
|
2195
2215
|
"dist",
|
|
2196
2216
|
"commands",
|
|
2197
|
-
"
|
|
2198
|
-
"
|
|
2217
|
+
"ingest",
|
|
2218
|
+
"video.js"
|
|
2199
2219
|
]
|
|
2200
2220
|
},
|
|
2201
|
-
"
|
|
2221
|
+
"kv:get": {
|
|
2202
2222
|
"aliases": [],
|
|
2203
2223
|
"args": {
|
|
2204
|
-
"
|
|
2205
|
-
"description": "
|
|
2206
|
-
"name": "
|
|
2207
|
-
"required": true
|
|
2208
|
-
},
|
|
2209
|
-
"runId": {
|
|
2210
|
-
"description": "Run ID",
|
|
2211
|
-
"name": "runId",
|
|
2224
|
+
"key": {
|
|
2225
|
+
"description": "Key to retrieve",
|
|
2226
|
+
"name": "key",
|
|
2212
2227
|
"required": true
|
|
2213
2228
|
}
|
|
2214
2229
|
},
|
|
2215
|
-
"description": "Get
|
|
2230
|
+
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
2216
2231
|
"examples": [
|
|
2217
|
-
"<%= config.bin %>
|
|
2218
|
-
"<%= config.bin %>
|
|
2219
|
-
"<%= config.bin %> investigations run <investigation-id> <run-id> --json"
|
|
2232
|
+
"<%= config.bin %> kv get my-key",
|
|
2233
|
+
"<%= config.bin %> kv get my-key --json"
|
|
2220
2234
|
],
|
|
2221
2235
|
"flags": {
|
|
2222
2236
|
"json": {
|
|
@@ -2245,51 +2259,34 @@
|
|
|
2245
2259
|
"name": "stage",
|
|
2246
2260
|
"allowNo": false,
|
|
2247
2261
|
"type": "boolean"
|
|
2248
|
-
},
|
|
2249
|
-
"log-only": {
|
|
2250
|
-
"description": "Only show the execution log (skip run details)",
|
|
2251
|
-
"name": "log-only",
|
|
2252
|
-
"allowNo": false,
|
|
2253
|
-
"type": "boolean"
|
|
2254
|
-
},
|
|
2255
|
-
"trace-signal": {
|
|
2256
|
-
"description": "Fetch and display the signal and event information for this run",
|
|
2257
|
-
"name": "trace-signal",
|
|
2258
|
-
"allowNo": false,
|
|
2259
|
-
"type": "boolean"
|
|
2260
2262
|
}
|
|
2261
2263
|
},
|
|
2262
2264
|
"hasDynamicHelp": false,
|
|
2263
2265
|
"hiddenAliases": [],
|
|
2264
|
-
"id": "
|
|
2266
|
+
"id": "kv:get",
|
|
2265
2267
|
"pluginAlias": "@formant/formant-cli",
|
|
2266
2268
|
"pluginName": "@formant/formant-cli",
|
|
2267
2269
|
"pluginType": "core",
|
|
2268
2270
|
"strict": true,
|
|
2269
|
-
"summary": "Get
|
|
2271
|
+
"summary": "Get key-value",
|
|
2270
2272
|
"enableJsonFlag": true,
|
|
2271
2273
|
"isESM": true,
|
|
2272
2274
|
"relativePath": [
|
|
2273
2275
|
"dist",
|
|
2274
2276
|
"commands",
|
|
2275
|
-
"
|
|
2276
|
-
"
|
|
2277
|
+
"kv",
|
|
2278
|
+
"get.js"
|
|
2277
2279
|
]
|
|
2278
2280
|
},
|
|
2279
|
-
"
|
|
2281
|
+
"kv:list": {
|
|
2280
2282
|
"aliases": [],
|
|
2281
|
-
"args": {
|
|
2282
|
-
|
|
2283
|
-
"description": "Investigation (taskflow) ID",
|
|
2284
|
-
"name": "id",
|
|
2285
|
-
"required": true
|
|
2286
|
-
}
|
|
2287
|
-
},
|
|
2288
|
-
"description": "List actual investigation runs (not evaluation runs) for a specific investigation.\n\nShows runs with their status, signal IDs, and timestamps. Use 'investigations run' to see\ndetailed execution logs for a specific run.",
|
|
2283
|
+
"args": {},
|
|
2284
|
+
"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.",
|
|
2289
2285
|
"examples": [
|
|
2290
|
-
"<%= config.bin %>
|
|
2291
|
-
"<%= config.bin %>
|
|
2292
|
-
"<%= config.bin %>
|
|
2286
|
+
"<%= config.bin %> kv list",
|
|
2287
|
+
"<%= config.bin %> kv list --prefix config",
|
|
2288
|
+
"<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
|
|
2289
|
+
"<%= config.bin %> kv list --json"
|
|
2293
2290
|
],
|
|
2294
2291
|
"flags": {
|
|
2295
2292
|
"json": {
|
|
@@ -2319,26 +2316,18 @@
|
|
|
2319
2316
|
"allowNo": false,
|
|
2320
2317
|
"type": "boolean"
|
|
2321
2318
|
},
|
|
2322
|
-
"
|
|
2323
|
-
"
|
|
2324
|
-
"
|
|
2325
|
-
"
|
|
2326
|
-
"type": "boolean"
|
|
2327
|
-
},
|
|
2328
|
-
"limit": {
|
|
2329
|
-
"char": "l",
|
|
2330
|
-
"description": "Maximum number of runs to return",
|
|
2331
|
-
"name": "limit",
|
|
2332
|
-
"default": 20,
|
|
2319
|
+
"keys": {
|
|
2320
|
+
"char": "k",
|
|
2321
|
+
"description": "Specific keys to query (can be specified multiple times)",
|
|
2322
|
+
"name": "keys",
|
|
2333
2323
|
"hasDynamicHelp": false,
|
|
2334
|
-
"multiple":
|
|
2324
|
+
"multiple": true,
|
|
2335
2325
|
"type": "option"
|
|
2336
2326
|
},
|
|
2337
|
-
"
|
|
2338
|
-
"char": "
|
|
2339
|
-
"description": "
|
|
2340
|
-
"name": "
|
|
2341
|
-
"default": 0,
|
|
2327
|
+
"prefix": {
|
|
2328
|
+
"char": "p",
|
|
2329
|
+
"description": "Filter keys by prefix",
|
|
2330
|
+
"name": "prefix",
|
|
2342
2331
|
"hasDynamicHelp": false,
|
|
2343
2332
|
"multiple": false,
|
|
2344
2333
|
"type": "option"
|
|
@@ -2346,34 +2335,39 @@
|
|
|
2346
2335
|
},
|
|
2347
2336
|
"hasDynamicHelp": false,
|
|
2348
2337
|
"hiddenAliases": [],
|
|
2349
|
-
"id": "
|
|
2338
|
+
"id": "kv:list",
|
|
2350
2339
|
"pluginAlias": "@formant/formant-cli",
|
|
2351
2340
|
"pluginName": "@formant/formant-cli",
|
|
2352
2341
|
"pluginType": "core",
|
|
2353
2342
|
"strict": true,
|
|
2354
|
-
"summary": "List
|
|
2343
|
+
"summary": "List key-value keys",
|
|
2355
2344
|
"enableJsonFlag": true,
|
|
2356
2345
|
"isESM": true,
|
|
2357
2346
|
"relativePath": [
|
|
2358
2347
|
"dist",
|
|
2359
2348
|
"commands",
|
|
2360
|
-
"
|
|
2361
|
-
"
|
|
2349
|
+
"kv",
|
|
2350
|
+
"list.js"
|
|
2362
2351
|
]
|
|
2363
2352
|
},
|
|
2364
|
-
"
|
|
2353
|
+
"kv:set": {
|
|
2365
2354
|
"aliases": [],
|
|
2366
2355
|
"args": {
|
|
2367
|
-
"
|
|
2368
|
-
"description": "
|
|
2369
|
-
"name": "
|
|
2356
|
+
"key": {
|
|
2357
|
+
"description": "Key to set",
|
|
2358
|
+
"name": "key",
|
|
2359
|
+
"required": true
|
|
2360
|
+
},
|
|
2361
|
+
"value": {
|
|
2362
|
+
"description": "Value to store (JSON string)",
|
|
2363
|
+
"name": "value",
|
|
2370
2364
|
"required": true
|
|
2371
2365
|
}
|
|
2372
2366
|
},
|
|
2373
|
-
"description": "
|
|
2367
|
+
"description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
|
|
2374
2368
|
"examples": [
|
|
2375
|
-
"<%= config.bin %>
|
|
2376
|
-
"<%= config.bin %>
|
|
2369
|
+
"<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
|
|
2370
|
+
"<%= config.bin %> kv set config '{\"setting\": true}'"
|
|
2377
2371
|
],
|
|
2378
2372
|
"flags": {
|
|
2379
2373
|
"json": {
|
|
@@ -2406,28 +2400,28 @@
|
|
|
2406
2400
|
},
|
|
2407
2401
|
"hasDynamicHelp": false,
|
|
2408
2402
|
"hiddenAliases": [],
|
|
2409
|
-
"id": "
|
|
2403
|
+
"id": "kv:set",
|
|
2410
2404
|
"pluginAlias": "@formant/formant-cli",
|
|
2411
2405
|
"pluginName": "@formant/formant-cli",
|
|
2412
2406
|
"pluginType": "core",
|
|
2413
2407
|
"strict": true,
|
|
2414
|
-
"summary": "
|
|
2408
|
+
"summary": "Set key-value",
|
|
2415
2409
|
"enableJsonFlag": true,
|
|
2416
2410
|
"isESM": true,
|
|
2417
2411
|
"relativePath": [
|
|
2418
2412
|
"dist",
|
|
2419
2413
|
"commands",
|
|
2420
|
-
"
|
|
2421
|
-
"
|
|
2414
|
+
"kv",
|
|
2415
|
+
"set.js"
|
|
2422
2416
|
]
|
|
2423
2417
|
},
|
|
2424
|
-
"
|
|
2418
|
+
"org:get": {
|
|
2425
2419
|
"aliases": [],
|
|
2426
2420
|
"args": {},
|
|
2427
|
-
"description": "Get
|
|
2421
|
+
"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.",
|
|
2428
2422
|
"examples": [
|
|
2429
|
-
"<%= config.bin %>
|
|
2430
|
-
"<%= config.bin %>
|
|
2423
|
+
"<%= config.bin %> org get",
|
|
2424
|
+
"<%= config.bin %> org get --json"
|
|
2431
2425
|
],
|
|
2432
2426
|
"flags": {
|
|
2433
2427
|
"json": {
|
|
@@ -2456,54 +2450,34 @@
|
|
|
2456
2450
|
"name": "stage",
|
|
2457
2451
|
"allowNo": false,
|
|
2458
2452
|
"type": "boolean"
|
|
2459
|
-
},
|
|
2460
|
-
"end": {
|
|
2461
|
-
"description": "End time (ISO 8601)",
|
|
2462
|
-
"name": "end",
|
|
2463
|
-
"required": true,
|
|
2464
|
-
"hasDynamicHelp": false,
|
|
2465
|
-
"multiple": false,
|
|
2466
|
-
"type": "option"
|
|
2467
|
-
},
|
|
2468
|
-
"start": {
|
|
2469
|
-
"description": "Start time (ISO 8601)",
|
|
2470
|
-
"name": "start",
|
|
2471
|
-
"required": true,
|
|
2472
|
-
"hasDynamicHelp": false,
|
|
2473
|
-
"multiple": false,
|
|
2474
|
-
"type": "option"
|
|
2475
2453
|
}
|
|
2476
2454
|
},
|
|
2477
2455
|
"hasDynamicHelp": false,
|
|
2478
2456
|
"hiddenAliases": [],
|
|
2479
|
-
"id": "
|
|
2457
|
+
"id": "org:get",
|
|
2480
2458
|
"pluginAlias": "@formant/formant-cli",
|
|
2481
2459
|
"pluginName": "@formant/formant-cli",
|
|
2482
2460
|
"pluginType": "core",
|
|
2483
2461
|
"strict": true,
|
|
2484
|
-
"summary": "Get
|
|
2462
|
+
"summary": "Get your organization",
|
|
2485
2463
|
"enableJsonFlag": true,
|
|
2486
2464
|
"isESM": true,
|
|
2487
2465
|
"relativePath": [
|
|
2488
2466
|
"dist",
|
|
2489
2467
|
"commands",
|
|
2490
|
-
"
|
|
2491
|
-
"
|
|
2468
|
+
"org",
|
|
2469
|
+
"get.js"
|
|
2492
2470
|
]
|
|
2493
2471
|
},
|
|
2494
|
-
"
|
|
2472
|
+
"org:update": {
|
|
2495
2473
|
"aliases": [],
|
|
2496
|
-
"args": {
|
|
2497
|
-
|
|
2498
|
-
"description": "Investigation (taskflow) ID",
|
|
2499
|
-
"name": "id",
|
|
2500
|
-
"required": true
|
|
2501
|
-
}
|
|
2502
|
-
},
|
|
2503
|
-
"description": "Trigger an investigation to run. Provide input text describing the problem\nor context for the investigation. The investigation runs asynchronously and\nreturns a run ID you can use to check results.",
|
|
2474
|
+
"args": {},
|
|
2475
|
+
"description": "Update your organization's details.\n\nAt least one of --name or --description must be provided.",
|
|
2504
2476
|
"examples": [
|
|
2505
|
-
"<%= config.bin %>
|
|
2506
|
-
"<%= config.bin %>
|
|
2477
|
+
"<%= config.bin %> org update --name \"My Fleet\"",
|
|
2478
|
+
"<%= config.bin %> org update --description \"Production robot fleet\"",
|
|
2479
|
+
"<%= config.bin %> org update --name \"My Fleet\" --description \"Production robot fleet\"",
|
|
2480
|
+
"<%= config.bin %> org update --name \"My Fleet\" --json"
|
|
2507
2481
|
],
|
|
2508
2482
|
"flags": {
|
|
2509
2483
|
"json": {
|
|
@@ -2533,18 +2507,18 @@
|
|
|
2533
2507
|
"allowNo": false,
|
|
2534
2508
|
"type": "boolean"
|
|
2535
2509
|
},
|
|
2536
|
-
"
|
|
2537
|
-
"char": "
|
|
2538
|
-
"description": "
|
|
2539
|
-
"name": "
|
|
2540
|
-
"required": true,
|
|
2510
|
+
"description": {
|
|
2511
|
+
"char": "d",
|
|
2512
|
+
"description": "New description for the organization",
|
|
2513
|
+
"name": "description",
|
|
2541
2514
|
"hasDynamicHelp": false,
|
|
2542
2515
|
"multiple": false,
|
|
2543
2516
|
"type": "option"
|
|
2544
2517
|
},
|
|
2545
|
-
"
|
|
2546
|
-
"
|
|
2547
|
-
"
|
|
2518
|
+
"name": {
|
|
2519
|
+
"char": "n",
|
|
2520
|
+
"description": "New name for the organization",
|
|
2521
|
+
"name": "name",
|
|
2548
2522
|
"hasDynamicHelp": false,
|
|
2549
2523
|
"multiple": false,
|
|
2550
2524
|
"type": "option"
|
|
@@ -2552,30 +2526,29 @@
|
|
|
2552
2526
|
},
|
|
2553
2527
|
"hasDynamicHelp": false,
|
|
2554
2528
|
"hiddenAliases": [],
|
|
2555
|
-
"id": "
|
|
2529
|
+
"id": "org:update",
|
|
2556
2530
|
"pluginAlias": "@formant/formant-cli",
|
|
2557
2531
|
"pluginName": "@formant/formant-cli",
|
|
2558
2532
|
"pluginType": "core",
|
|
2559
2533
|
"strict": true,
|
|
2560
|
-
"summary": "
|
|
2534
|
+
"summary": "Update your organization",
|
|
2561
2535
|
"enableJsonFlag": true,
|
|
2562
2536
|
"isESM": true,
|
|
2563
2537
|
"relativePath": [
|
|
2564
2538
|
"dist",
|
|
2565
2539
|
"commands",
|
|
2566
|
-
"
|
|
2567
|
-
"
|
|
2540
|
+
"org",
|
|
2541
|
+
"update.js"
|
|
2568
2542
|
]
|
|
2569
2543
|
},
|
|
2570
|
-
"
|
|
2544
|
+
"investigations:analytics": {
|
|
2571
2545
|
"aliases": [],
|
|
2572
2546
|
"args": {},
|
|
2573
|
-
"description": "
|
|
2547
|
+
"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.",
|
|
2574
2548
|
"examples": [
|
|
2575
|
-
"<%= config.bin %>
|
|
2576
|
-
"<%= config.bin %>
|
|
2577
|
-
"<%= config.bin %>
|
|
2578
|
-
"<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
|
|
2549
|
+
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01",
|
|
2550
|
+
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
|
|
2551
|
+
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
|
|
2579
2552
|
],
|
|
2580
2553
|
"flags": {
|
|
2581
2554
|
"json": {
|
|
@@ -2605,94 +2578,76 @@
|
|
|
2605
2578
|
"allowNo": false,
|
|
2606
2579
|
"type": "boolean"
|
|
2607
2580
|
},
|
|
2608
|
-
"
|
|
2609
|
-
"
|
|
2610
|
-
"
|
|
2611
|
-
"name": "aggregate",
|
|
2612
|
-
"hasDynamicHelp": false,
|
|
2613
|
-
"multiple": false,
|
|
2614
|
-
"type": "option"
|
|
2615
|
-
},
|
|
2616
|
-
"device": {
|
|
2617
|
-
"char": "d",
|
|
2618
|
-
"description": "Device ID (UUID)",
|
|
2619
|
-
"name": "device",
|
|
2581
|
+
"end": {
|
|
2582
|
+
"description": "End time (ISO 8601)",
|
|
2583
|
+
"name": "end",
|
|
2620
2584
|
"required": true,
|
|
2621
2585
|
"hasDynamicHelp": false,
|
|
2622
2586
|
"multiple": false,
|
|
2623
2587
|
"type": "option"
|
|
2624
2588
|
},
|
|
2625
|
-
"
|
|
2626
|
-
"description": "
|
|
2627
|
-
"name": "
|
|
2589
|
+
"group-by": {
|
|
2590
|
+
"description": "Group results by",
|
|
2591
|
+
"name": "group-by",
|
|
2628
2592
|
"hasDynamicHelp": false,
|
|
2629
2593
|
"multiple": false,
|
|
2594
|
+
"options": [
|
|
2595
|
+
"resultType",
|
|
2596
|
+
"signalType"
|
|
2597
|
+
],
|
|
2630
2598
|
"type": "option"
|
|
2631
2599
|
},
|
|
2632
|
-
"
|
|
2633
|
-
"description": "
|
|
2634
|
-
"name": "
|
|
2635
|
-
"
|
|
2636
|
-
"type": "boolean"
|
|
2637
|
-
},
|
|
2638
|
-
"limit": {
|
|
2639
|
-
"char": "l",
|
|
2640
|
-
"description": "Maximum number of datapoints",
|
|
2641
|
-
"name": "limit",
|
|
2600
|
+
"interval": {
|
|
2601
|
+
"description": "Time interval for aggregation",
|
|
2602
|
+
"name": "interval",
|
|
2603
|
+
"default": "daily",
|
|
2642
2604
|
"hasDynamicHelp": false,
|
|
2643
2605
|
"multiple": false,
|
|
2606
|
+
"options": [
|
|
2607
|
+
"daily",
|
|
2608
|
+
"hourly"
|
|
2609
|
+
],
|
|
2644
2610
|
"type": "option"
|
|
2645
2611
|
},
|
|
2646
2612
|
"start": {
|
|
2647
2613
|
"description": "Start time (ISO 8601)",
|
|
2648
2614
|
"name": "start",
|
|
2649
|
-
"hasDynamicHelp": false,
|
|
2650
|
-
"multiple": false,
|
|
2651
|
-
"type": "option"
|
|
2652
|
-
},
|
|
2653
|
-
"stream": {
|
|
2654
|
-
"char": "s",
|
|
2655
|
-
"description": "Stream name(s), can be specified multiple times",
|
|
2656
|
-
"name": "stream",
|
|
2657
2615
|
"required": true,
|
|
2658
2616
|
"hasDynamicHelp": false,
|
|
2659
|
-
"multiple": true,
|
|
2660
|
-
"type": "option"
|
|
2661
|
-
},
|
|
2662
|
-
"type": {
|
|
2663
|
-
"description": "Filter by stream type",
|
|
2664
|
-
"name": "type",
|
|
2665
|
-
"hasDynamicHelp": false,
|
|
2666
2617
|
"multiple": false,
|
|
2667
2618
|
"type": "option"
|
|
2668
2619
|
}
|
|
2669
2620
|
},
|
|
2670
2621
|
"hasDynamicHelp": false,
|
|
2671
2622
|
"hiddenAliases": [],
|
|
2672
|
-
"id": "
|
|
2623
|
+
"id": "investigations:analytics",
|
|
2673
2624
|
"pluginAlias": "@formant/formant-cli",
|
|
2674
2625
|
"pluginName": "@formant/formant-cli",
|
|
2675
2626
|
"pluginType": "core",
|
|
2676
2627
|
"strict": true,
|
|
2677
|
-
"summary": "
|
|
2628
|
+
"summary": "Get investigation analytics",
|
|
2678
2629
|
"enableJsonFlag": true,
|
|
2679
2630
|
"isESM": true,
|
|
2680
2631
|
"relativePath": [
|
|
2681
2632
|
"dist",
|
|
2682
2633
|
"commands",
|
|
2683
|
-
"
|
|
2684
|
-
"
|
|
2634
|
+
"investigations",
|
|
2635
|
+
"analytics.js"
|
|
2685
2636
|
]
|
|
2686
2637
|
},
|
|
2687
|
-
"
|
|
2638
|
+
"investigations:get": {
|
|
2688
2639
|
"aliases": [],
|
|
2689
|
-
"args": {
|
|
2690
|
-
|
|
2640
|
+
"args": {
|
|
2641
|
+
"id": {
|
|
2642
|
+
"description": "Investigation (taskflow) ID",
|
|
2643
|
+
"name": "id",
|
|
2644
|
+
"required": true
|
|
2645
|
+
}
|
|
2646
|
+
},
|
|
2647
|
+
"description": "Get detailed information about a specific investigation by ID.",
|
|
2691
2648
|
"examples": [
|
|
2692
|
-
"<%= config.bin %>
|
|
2693
|
-
"<%= config.bin %>
|
|
2694
|
-
"<%= config.bin %> query latest-values --device <id> --all-streams",
|
|
2695
|
-
"<%= config.bin %> query latest-values --device <id> --all-streams --json"
|
|
2649
|
+
"<%= config.bin %> investigations get <id>",
|
|
2650
|
+
"<%= config.bin %> investigations get <id> --json"
|
|
2696
2651
|
],
|
|
2697
2652
|
"flags": {
|
|
2698
2653
|
"json": {
|
|
@@ -2721,61 +2676,33 @@
|
|
|
2721
2676
|
"name": "stage",
|
|
2722
2677
|
"allowNo": false,
|
|
2723
2678
|
"type": "boolean"
|
|
2724
|
-
},
|
|
2725
|
-
"all-streams": {
|
|
2726
|
-
"description": "Query all configured streams for the device (requires single --device)",
|
|
2727
|
-
"name": "all-streams",
|
|
2728
|
-
"allowNo": false,
|
|
2729
|
-
"type": "boolean"
|
|
2730
|
-
},
|
|
2731
|
-
"device": {
|
|
2732
|
-
"char": "d",
|
|
2733
|
-
"description": "Device ID (UUID)",
|
|
2734
|
-
"name": "device",
|
|
2735
|
-
"required": true,
|
|
2736
|
-
"hasDynamicHelp": false,
|
|
2737
|
-
"multiple": true,
|
|
2738
|
-
"type": "option"
|
|
2739
|
-
},
|
|
2740
|
-
"stream": {
|
|
2741
|
-
"char": "s",
|
|
2742
|
-
"description": "Stream name(s), can be specified multiple times",
|
|
2743
|
-
"name": "stream",
|
|
2744
|
-
"hasDynamicHelp": false,
|
|
2745
|
-
"multiple": true,
|
|
2746
|
-
"type": "option"
|
|
2747
2679
|
}
|
|
2748
2680
|
},
|
|
2749
2681
|
"hasDynamicHelp": false,
|
|
2750
2682
|
"hiddenAliases": [],
|
|
2751
|
-
"id": "
|
|
2683
|
+
"id": "investigations:get",
|
|
2752
2684
|
"pluginAlias": "@formant/formant-cli",
|
|
2753
2685
|
"pluginName": "@formant/formant-cli",
|
|
2754
2686
|
"pluginType": "core",
|
|
2755
2687
|
"strict": true,
|
|
2756
|
-
"summary": "Get
|
|
2688
|
+
"summary": "Get an investigation by ID",
|
|
2757
2689
|
"enableJsonFlag": true,
|
|
2758
2690
|
"isESM": true,
|
|
2759
2691
|
"relativePath": [
|
|
2760
2692
|
"dist",
|
|
2761
2693
|
"commands",
|
|
2762
|
-
"
|
|
2763
|
-
"
|
|
2694
|
+
"investigations",
|
|
2695
|
+
"get.js"
|
|
2764
2696
|
]
|
|
2765
2697
|
},
|
|
2766
|
-
"
|
|
2698
|
+
"investigations:list": {
|
|
2767
2699
|
"aliases": [],
|
|
2768
|
-
"args": {
|
|
2769
|
-
|
|
2770
|
-
"description": "Schedule ID (UUID)",
|
|
2771
|
-
"name": "id",
|
|
2772
|
-
"required": true
|
|
2773
|
-
}
|
|
2774
|
-
},
|
|
2775
|
-
"description": "Get detailed information about a schedule.\n\nShows the full schedule configuration including cron expression, command template,\ninvestigation link, and execution settings.",
|
|
2700
|
+
"args": {},
|
|
2701
|
+
"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.",
|
|
2776
2702
|
"examples": [
|
|
2777
|
-
"<%= config.bin %>
|
|
2778
|
-
"<%= config.bin %>
|
|
2703
|
+
"<%= config.bin %> investigations list",
|
|
2704
|
+
"<%= config.bin %> investigations list --signal-handler",
|
|
2705
|
+
"<%= config.bin %> investigations list --json"
|
|
2779
2706
|
],
|
|
2780
2707
|
"flags": {
|
|
2781
2708
|
"json": {
|
|
@@ -2804,32 +2731,50 @@
|
|
|
2804
2731
|
"name": "stage",
|
|
2805
2732
|
"allowNo": false,
|
|
2806
2733
|
"type": "boolean"
|
|
2734
|
+
},
|
|
2735
|
+
"signal-handler": {
|
|
2736
|
+
"description": "Only show investigations that handle signals",
|
|
2737
|
+
"name": "signal-handler",
|
|
2738
|
+
"allowNo": false,
|
|
2739
|
+
"type": "boolean"
|
|
2807
2740
|
}
|
|
2808
2741
|
},
|
|
2809
2742
|
"hasDynamicHelp": false,
|
|
2810
2743
|
"hiddenAliases": [],
|
|
2811
|
-
"id": "
|
|
2744
|
+
"id": "investigations:list",
|
|
2812
2745
|
"pluginAlias": "@formant/formant-cli",
|
|
2813
2746
|
"pluginName": "@formant/formant-cli",
|
|
2814
2747
|
"pluginType": "core",
|
|
2815
2748
|
"strict": true,
|
|
2816
|
-
"summary": "
|
|
2749
|
+
"summary": "List investigations",
|
|
2817
2750
|
"enableJsonFlag": true,
|
|
2818
2751
|
"isESM": true,
|
|
2819
2752
|
"relativePath": [
|
|
2820
2753
|
"dist",
|
|
2821
2754
|
"commands",
|
|
2822
|
-
"
|
|
2823
|
-
"
|
|
2755
|
+
"investigations",
|
|
2756
|
+
"list.js"
|
|
2824
2757
|
]
|
|
2825
2758
|
},
|
|
2826
|
-
"
|
|
2759
|
+
"investigations:run": {
|
|
2827
2760
|
"aliases": [],
|
|
2828
|
-
"args": {
|
|
2829
|
-
|
|
2761
|
+
"args": {
|
|
2762
|
+
"investigationId": {
|
|
2763
|
+
"description": "Investigation (taskflow) ID",
|
|
2764
|
+
"name": "investigationId",
|
|
2765
|
+
"required": true
|
|
2766
|
+
},
|
|
2767
|
+
"runId": {
|
|
2768
|
+
"description": "Run ID",
|
|
2769
|
+
"name": "runId",
|
|
2770
|
+
"required": true
|
|
2771
|
+
}
|
|
2772
|
+
},
|
|
2773
|
+
"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.",
|
|
2830
2774
|
"examples": [
|
|
2831
|
-
"<%= config.bin %>
|
|
2832
|
-
"<%= config.bin %>
|
|
2775
|
+
"<%= config.bin %> investigations run <investigation-id> <run-id>",
|
|
2776
|
+
"<%= config.bin %> investigations run <investigation-id> <run-id> --log-only",
|
|
2777
|
+
"<%= config.bin %> investigations run <investigation-id> <run-id> --json"
|
|
2833
2778
|
],
|
|
2834
2779
|
"flags": {
|
|
2835
2780
|
"json": {
|
|
@@ -2858,38 +2803,51 @@
|
|
|
2858
2803
|
"name": "stage",
|
|
2859
2804
|
"allowNo": false,
|
|
2860
2805
|
"type": "boolean"
|
|
2806
|
+
},
|
|
2807
|
+
"log-only": {
|
|
2808
|
+
"description": "Only show the execution log (skip run details)",
|
|
2809
|
+
"name": "log-only",
|
|
2810
|
+
"allowNo": false,
|
|
2811
|
+
"type": "boolean"
|
|
2812
|
+
},
|
|
2813
|
+
"trace-signal": {
|
|
2814
|
+
"description": "Fetch and display the signal and event information for this run",
|
|
2815
|
+
"name": "trace-signal",
|
|
2816
|
+
"allowNo": false,
|
|
2817
|
+
"type": "boolean"
|
|
2861
2818
|
}
|
|
2862
2819
|
},
|
|
2863
2820
|
"hasDynamicHelp": false,
|
|
2864
2821
|
"hiddenAliases": [],
|
|
2865
|
-
"id": "
|
|
2822
|
+
"id": "investigations:run",
|
|
2866
2823
|
"pluginAlias": "@formant/formant-cli",
|
|
2867
2824
|
"pluginName": "@formant/formant-cli",
|
|
2868
2825
|
"pluginType": "core",
|
|
2869
2826
|
"strict": true,
|
|
2870
|
-
"summary": "
|
|
2827
|
+
"summary": "Get investigation run details and execution log",
|
|
2871
2828
|
"enableJsonFlag": true,
|
|
2872
2829
|
"isESM": true,
|
|
2873
2830
|
"relativePath": [
|
|
2874
2831
|
"dist",
|
|
2875
2832
|
"commands",
|
|
2876
|
-
"
|
|
2877
|
-
"
|
|
2833
|
+
"investigations",
|
|
2834
|
+
"run.js"
|
|
2878
2835
|
]
|
|
2879
2836
|
},
|
|
2880
|
-
"
|
|
2837
|
+
"investigations:runs-list": {
|
|
2881
2838
|
"aliases": [],
|
|
2882
2839
|
"args": {
|
|
2883
2840
|
"id": {
|
|
2884
|
-
"description": "
|
|
2841
|
+
"description": "Investigation (taskflow) ID",
|
|
2885
2842
|
"name": "id",
|
|
2886
2843
|
"required": true
|
|
2887
2844
|
}
|
|
2888
2845
|
},
|
|
2889
|
-
"description": "
|
|
2846
|
+
"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.",
|
|
2890
2847
|
"examples": [
|
|
2891
|
-
"<%= config.bin %>
|
|
2892
|
-
"<%= config.bin %>
|
|
2848
|
+
"<%= config.bin %> investigations runs-list <id>",
|
|
2849
|
+
"<%= config.bin %> investigations runs-list <id> --limit 50",
|
|
2850
|
+
"<%= config.bin %> investigations runs-list <id> --details --json"
|
|
2893
2851
|
],
|
|
2894
2852
|
"flags": {
|
|
2895
2853
|
"json": {
|
|
@@ -2918,32 +2876,62 @@
|
|
|
2918
2876
|
"name": "stage",
|
|
2919
2877
|
"allowNo": false,
|
|
2920
2878
|
"type": "boolean"
|
|
2879
|
+
},
|
|
2880
|
+
"details": {
|
|
2881
|
+
"description": "Include detailed information about each run",
|
|
2882
|
+
"name": "details",
|
|
2883
|
+
"allowNo": false,
|
|
2884
|
+
"type": "boolean"
|
|
2885
|
+
},
|
|
2886
|
+
"limit": {
|
|
2887
|
+
"char": "l",
|
|
2888
|
+
"description": "Maximum number of runs to return",
|
|
2889
|
+
"name": "limit",
|
|
2890
|
+
"default": 20,
|
|
2891
|
+
"hasDynamicHelp": false,
|
|
2892
|
+
"multiple": false,
|
|
2893
|
+
"type": "option"
|
|
2894
|
+
},
|
|
2895
|
+
"offset": {
|
|
2896
|
+
"char": "o",
|
|
2897
|
+
"description": "Offset for pagination",
|
|
2898
|
+
"name": "offset",
|
|
2899
|
+
"default": 0,
|
|
2900
|
+
"hasDynamicHelp": false,
|
|
2901
|
+
"multiple": false,
|
|
2902
|
+
"type": "option"
|
|
2921
2903
|
}
|
|
2922
2904
|
},
|
|
2923
2905
|
"hasDynamicHelp": false,
|
|
2924
2906
|
"hiddenAliases": [],
|
|
2925
|
-
"id": "
|
|
2907
|
+
"id": "investigations:runs-list",
|
|
2926
2908
|
"pluginAlias": "@formant/formant-cli",
|
|
2927
2909
|
"pluginName": "@formant/formant-cli",
|
|
2928
2910
|
"pluginType": "core",
|
|
2929
2911
|
"strict": true,
|
|
2930
|
-
"summary": "
|
|
2912
|
+
"summary": "List actual investigation runs",
|
|
2931
2913
|
"enableJsonFlag": true,
|
|
2932
2914
|
"isESM": true,
|
|
2933
2915
|
"relativePath": [
|
|
2934
2916
|
"dist",
|
|
2935
2917
|
"commands",
|
|
2936
|
-
"
|
|
2937
|
-
"
|
|
2918
|
+
"investigations",
|
|
2919
|
+
"runs-list.js"
|
|
2938
2920
|
]
|
|
2939
2921
|
},
|
|
2940
|
-
"
|
|
2922
|
+
"investigations:runs": {
|
|
2941
2923
|
"aliases": [],
|
|
2942
|
-
"args": {
|
|
2943
|
-
|
|
2924
|
+
"args": {
|
|
2925
|
+
"id": {
|
|
2926
|
+
"description": "Investigation (taskflow) ID",
|
|
2927
|
+
"name": "id",
|
|
2928
|
+
"required": true
|
|
2929
|
+
}
|
|
2930
|
+
},
|
|
2931
|
+
"description": "List evaluation runs for a specific investigation.",
|
|
2944
2932
|
"examples": [
|
|
2945
|
-
"<%= config.bin %>
|
|
2946
|
-
"<%= config.bin %>
|
|
2933
|
+
"<%= config.bin %> investigations runs <id>",
|
|
2934
|
+
"<%= config.bin %> investigations runs <id> --json"
|
|
2947
2935
|
],
|
|
2948
2936
|
"flags": {
|
|
2949
2937
|
"json": {
|
|
@@ -2976,29 +2964,28 @@
|
|
|
2976
2964
|
},
|
|
2977
2965
|
"hasDynamicHelp": false,
|
|
2978
2966
|
"hiddenAliases": [],
|
|
2979
|
-
"id": "
|
|
2967
|
+
"id": "investigations:runs",
|
|
2980
2968
|
"pluginAlias": "@formant/formant-cli",
|
|
2981
2969
|
"pluginName": "@formant/formant-cli",
|
|
2982
2970
|
"pluginType": "core",
|
|
2983
2971
|
"strict": true,
|
|
2984
|
-
"summary": "List
|
|
2972
|
+
"summary": "List runs for an investigation",
|
|
2985
2973
|
"enableJsonFlag": true,
|
|
2986
2974
|
"isESM": true,
|
|
2987
2975
|
"relativePath": [
|
|
2988
2976
|
"dist",
|
|
2989
2977
|
"commands",
|
|
2990
|
-
"
|
|
2991
|
-
"
|
|
2978
|
+
"investigations",
|
|
2979
|
+
"runs.js"
|
|
2992
2980
|
]
|
|
2993
2981
|
},
|
|
2994
|
-
"
|
|
2982
|
+
"investigations:stats": {
|
|
2995
2983
|
"aliases": [],
|
|
2996
2984
|
"args": {},
|
|
2997
|
-
"description": "Get
|
|
2985
|
+
"description": "Get investigation statistics for a time range.",
|
|
2998
2986
|
"examples": [
|
|
2999
|
-
"<%= config.bin %>
|
|
3000
|
-
"<%= config.bin %>
|
|
3001
|
-
"<%= config.bin %> signals count --json"
|
|
2987
|
+
"<%= config.bin %> investigations stats --start 2026-01-01 --end 2026-02-01",
|
|
2988
|
+
"<%= config.bin %> investigations stats --start 2026-01-01 --end 2026-02-01 --json"
|
|
3002
2989
|
],
|
|
3003
2990
|
"flags": {
|
|
3004
2991
|
"json": {
|
|
@@ -3031,6 +3018,7 @@
|
|
|
3031
3018
|
"end": {
|
|
3032
3019
|
"description": "End time (ISO 8601)",
|
|
3033
3020
|
"name": "end",
|
|
3021
|
+
"required": true,
|
|
3034
3022
|
"hasDynamicHelp": false,
|
|
3035
3023
|
"multiple": false,
|
|
3036
3024
|
"type": "option"
|
|
@@ -3038,6 +3026,7 @@
|
|
|
3038
3026
|
"start": {
|
|
3039
3027
|
"description": "Start time (ISO 8601)",
|
|
3040
3028
|
"name": "start",
|
|
3029
|
+
"required": true,
|
|
3041
3030
|
"hasDynamicHelp": false,
|
|
3042
3031
|
"multiple": false,
|
|
3043
3032
|
"type": "option"
|
|
@@ -3045,35 +3034,34 @@
|
|
|
3045
3034
|
},
|
|
3046
3035
|
"hasDynamicHelp": false,
|
|
3047
3036
|
"hiddenAliases": [],
|
|
3048
|
-
"id": "
|
|
3037
|
+
"id": "investigations:stats",
|
|
3049
3038
|
"pluginAlias": "@formant/formant-cli",
|
|
3050
3039
|
"pluginName": "@formant/formant-cli",
|
|
3051
3040
|
"pluginType": "core",
|
|
3052
3041
|
"strict": true,
|
|
3053
|
-
"summary": "Get
|
|
3042
|
+
"summary": "Get investigation stats",
|
|
3054
3043
|
"enableJsonFlag": true,
|
|
3055
3044
|
"isESM": true,
|
|
3056
3045
|
"relativePath": [
|
|
3057
3046
|
"dist",
|
|
3058
3047
|
"commands",
|
|
3059
|
-
"
|
|
3060
|
-
"
|
|
3048
|
+
"investigations",
|
|
3049
|
+
"stats.js"
|
|
3061
3050
|
]
|
|
3062
3051
|
},
|
|
3063
|
-
"
|
|
3052
|
+
"investigations:trigger": {
|
|
3064
3053
|
"aliases": [],
|
|
3065
3054
|
"args": {
|
|
3066
3055
|
"id": {
|
|
3067
|
-
"description": "
|
|
3056
|
+
"description": "Investigation (taskflow) ID",
|
|
3068
3057
|
"name": "id",
|
|
3069
3058
|
"required": true
|
|
3070
3059
|
}
|
|
3071
3060
|
},
|
|
3072
|
-
"description": "
|
|
3061
|
+
"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.",
|
|
3073
3062
|
"examples": [
|
|
3074
|
-
"<%= config.bin %>
|
|
3075
|
-
"<%= config.bin %>
|
|
3076
|
-
"<%= config.bin %> signals get <signal-id> --json"
|
|
3063
|
+
"<%= config.bin %> investigations trigger <id> --input \"Robot stopped responding\"",
|
|
3064
|
+
"<%= config.bin %> investigations trigger <id> --input \"Battery draining fast on device X\" --json"
|
|
3077
3065
|
],
|
|
3078
3066
|
"flags": {
|
|
3079
3067
|
"json": {
|
|
@@ -3103,37 +3091,49 @@
|
|
|
3103
3091
|
"allowNo": false,
|
|
3104
3092
|
"type": "boolean"
|
|
3105
3093
|
},
|
|
3106
|
-
"
|
|
3107
|
-
"
|
|
3108
|
-
"
|
|
3109
|
-
"
|
|
3110
|
-
"
|
|
3094
|
+
"input": {
|
|
3095
|
+
"char": "i",
|
|
3096
|
+
"description": "Input text / problem description for the investigation",
|
|
3097
|
+
"name": "input",
|
|
3098
|
+
"required": true,
|
|
3099
|
+
"hasDynamicHelp": false,
|
|
3100
|
+
"multiple": false,
|
|
3101
|
+
"type": "option"
|
|
3102
|
+
},
|
|
3103
|
+
"signal-id": {
|
|
3104
|
+
"description": "Optional signal ID to associate with this run",
|
|
3105
|
+
"name": "signal-id",
|
|
3106
|
+
"hasDynamicHelp": false,
|
|
3107
|
+
"multiple": false,
|
|
3108
|
+
"type": "option"
|
|
3111
3109
|
}
|
|
3112
3110
|
},
|
|
3113
3111
|
"hasDynamicHelp": false,
|
|
3114
3112
|
"hiddenAliases": [],
|
|
3115
|
-
"id": "
|
|
3113
|
+
"id": "investigations:trigger",
|
|
3116
3114
|
"pluginAlias": "@formant/formant-cli",
|
|
3117
3115
|
"pluginName": "@formant/formant-cli",
|
|
3118
3116
|
"pluginType": "core",
|
|
3119
3117
|
"strict": true,
|
|
3120
|
-
"summary": "
|
|
3118
|
+
"summary": "Trigger an investigation",
|
|
3121
3119
|
"enableJsonFlag": true,
|
|
3122
3120
|
"isESM": true,
|
|
3123
3121
|
"relativePath": [
|
|
3124
3122
|
"dist",
|
|
3125
3123
|
"commands",
|
|
3126
|
-
"
|
|
3127
|
-
"
|
|
3124
|
+
"investigations",
|
|
3125
|
+
"trigger.js"
|
|
3128
3126
|
]
|
|
3129
3127
|
},
|
|
3130
|
-
"
|
|
3128
|
+
"query": {
|
|
3131
3129
|
"aliases": [],
|
|
3132
3130
|
"args": {},
|
|
3133
|
-
"description": "
|
|
3131
|
+
"description": "Query telemetry stream data for a device over a time range.\n\nReturns time-series datapoints for the specified stream(s). Supports aggregation\nfor downsampling large datasets, and --latest to get only the most recent value.\n\nStream types: numeric, text, image, video, location, json, bitset, battery, health,\n\"numeric set\", \"point cloud\", localization, \"transform tree\", file.\n\nAggregate levels: second, 5 seconds, 30 seconds, minute, 5 minutes, 30 minutes,\nhour, 4 hours, 12 hours, day, week, month, year.",
|
|
3134
3132
|
"examples": [
|
|
3135
|
-
"<%= config.bin %>
|
|
3136
|
-
"<%= config.bin %>
|
|
3133
|
+
"<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-01-02",
|
|
3134
|
+
"<%= config.bin %> query --device <id> --stream speed --aggregate hour --start 2026-01-01 --end 2026-02-01",
|
|
3135
|
+
"<%= config.bin %> query --device <id> --stream battery_level --latest",
|
|
3136
|
+
"<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
|
|
3137
3137
|
],
|
|
3138
3138
|
"flags": {
|
|
3139
3139
|
"json": {
|
|
@@ -3162,33 +3162,95 @@
|
|
|
3162
3162
|
"name": "stage",
|
|
3163
3163
|
"allowNo": false,
|
|
3164
3164
|
"type": "boolean"
|
|
3165
|
+
},
|
|
3166
|
+
"aggregate": {
|
|
3167
|
+
"char": "a",
|
|
3168
|
+
"description": "Aggregation level for downsampling",
|
|
3169
|
+
"name": "aggregate",
|
|
3170
|
+
"hasDynamicHelp": false,
|
|
3171
|
+
"multiple": false,
|
|
3172
|
+
"type": "option"
|
|
3173
|
+
},
|
|
3174
|
+
"device": {
|
|
3175
|
+
"char": "d",
|
|
3176
|
+
"description": "Device ID (UUID)",
|
|
3177
|
+
"name": "device",
|
|
3178
|
+
"required": true,
|
|
3179
|
+
"hasDynamicHelp": false,
|
|
3180
|
+
"multiple": false,
|
|
3181
|
+
"type": "option"
|
|
3182
|
+
},
|
|
3183
|
+
"end": {
|
|
3184
|
+
"description": "End time (ISO 8601)",
|
|
3185
|
+
"name": "end",
|
|
3186
|
+
"hasDynamicHelp": false,
|
|
3187
|
+
"multiple": false,
|
|
3188
|
+
"type": "option"
|
|
3189
|
+
},
|
|
3190
|
+
"latest": {
|
|
3191
|
+
"description": "Only return the most recent value per stream",
|
|
3192
|
+
"name": "latest",
|
|
3193
|
+
"allowNo": false,
|
|
3194
|
+
"type": "boolean"
|
|
3195
|
+
},
|
|
3196
|
+
"limit": {
|
|
3197
|
+
"char": "l",
|
|
3198
|
+
"description": "Maximum number of datapoints",
|
|
3199
|
+
"name": "limit",
|
|
3200
|
+
"hasDynamicHelp": false,
|
|
3201
|
+
"multiple": false,
|
|
3202
|
+
"type": "option"
|
|
3203
|
+
},
|
|
3204
|
+
"start": {
|
|
3205
|
+
"description": "Start time (ISO 8601)",
|
|
3206
|
+
"name": "start",
|
|
3207
|
+
"hasDynamicHelp": false,
|
|
3208
|
+
"multiple": false,
|
|
3209
|
+
"type": "option"
|
|
3210
|
+
},
|
|
3211
|
+
"stream": {
|
|
3212
|
+
"char": "s",
|
|
3213
|
+
"description": "Stream name(s), can be specified multiple times",
|
|
3214
|
+
"name": "stream",
|
|
3215
|
+
"required": true,
|
|
3216
|
+
"hasDynamicHelp": false,
|
|
3217
|
+
"multiple": true,
|
|
3218
|
+
"type": "option"
|
|
3219
|
+
},
|
|
3220
|
+
"type": {
|
|
3221
|
+
"description": "Filter by stream type",
|
|
3222
|
+
"name": "type",
|
|
3223
|
+
"hasDynamicHelp": false,
|
|
3224
|
+
"multiple": false,
|
|
3225
|
+
"type": "option"
|
|
3165
3226
|
}
|
|
3166
3227
|
},
|
|
3167
3228
|
"hasDynamicHelp": false,
|
|
3168
3229
|
"hiddenAliases": [],
|
|
3169
|
-
"id": "
|
|
3230
|
+
"id": "query",
|
|
3170
3231
|
"pluginAlias": "@formant/formant-cli",
|
|
3171
3232
|
"pluginName": "@formant/formant-cli",
|
|
3172
3233
|
"pluginType": "core",
|
|
3173
3234
|
"strict": true,
|
|
3174
|
-
"summary": "
|
|
3235
|
+
"summary": "Query telemetry stream data",
|
|
3175
3236
|
"enableJsonFlag": true,
|
|
3176
3237
|
"isESM": true,
|
|
3177
3238
|
"relativePath": [
|
|
3178
3239
|
"dist",
|
|
3179
3240
|
"commands",
|
|
3180
|
-
"
|
|
3181
|
-
"
|
|
3241
|
+
"query",
|
|
3242
|
+
"index.js"
|
|
3182
3243
|
]
|
|
3183
3244
|
},
|
|
3184
|
-
"
|
|
3245
|
+
"query:latest-values": {
|
|
3185
3246
|
"aliases": [],
|
|
3186
3247
|
"args": {},
|
|
3187
|
-
"description": "
|
|
3248
|
+
"description": "Get the latest values for streams across devices.\n\nReturns the most recent value for specified streams without needing to specify\na time range. Useful for checking current sensor readings.\n\nUse --all-streams with a single device to automatically discover and query all\nstreams — both from the device configuration and from actual ingested data\n(unconfigured streams included).",
|
|
3188
3249
|
"examples": [
|
|
3189
|
-
"<%= config.bin %>
|
|
3190
|
-
"<%= config.bin %>
|
|
3191
|
-
"<%= config.bin %>
|
|
3250
|
+
"<%= config.bin %> query latest-values --device <id> --stream battery_level",
|
|
3251
|
+
"<%= config.bin %> query latest-values --device <id> --stream temperature --stream humidity",
|
|
3252
|
+
"<%= config.bin %> query latest-values --device <id> --all-streams",
|
|
3253
|
+
"<%= config.bin %> query latest-values --device <id> --all-streams --json"
|
|
3192
3254
|
],
|
|
3193
3255
|
"flags": {
|
|
3194
3256
|
"json": {
|
|
@@ -3218,65 +3280,68 @@
|
|
|
3218
3280
|
"allowNo": false,
|
|
3219
3281
|
"type": "boolean"
|
|
3220
3282
|
},
|
|
3221
|
-
"
|
|
3222
|
-
"description": "
|
|
3223
|
-
"name": "
|
|
3283
|
+
"all-streams": {
|
|
3284
|
+
"description": "Query all streams for the device — from config and from ingested data (requires single --device)",
|
|
3285
|
+
"name": "all-streams",
|
|
3286
|
+
"allowNo": false,
|
|
3287
|
+
"type": "boolean"
|
|
3288
|
+
},
|
|
3289
|
+
"days": {
|
|
3290
|
+
"description": "How many days back to look for unconfigured streams when using --all-streams",
|
|
3291
|
+
"name": "days",
|
|
3292
|
+
"default": 14,
|
|
3224
3293
|
"hasDynamicHelp": false,
|
|
3225
3294
|
"multiple": false,
|
|
3226
3295
|
"type": "option"
|
|
3227
3296
|
},
|
|
3228
|
-
"
|
|
3229
|
-
"
|
|
3230
|
-
"
|
|
3297
|
+
"device": {
|
|
3298
|
+
"char": "d",
|
|
3299
|
+
"description": "Device ID (UUID)",
|
|
3300
|
+
"name": "device",
|
|
3231
3301
|
"required": true,
|
|
3232
3302
|
"hasDynamicHelp": false,
|
|
3233
|
-
"multiple":
|
|
3303
|
+
"multiple": true,
|
|
3234
3304
|
"type": "option"
|
|
3235
3305
|
},
|
|
3236
|
-
"
|
|
3237
|
-
"
|
|
3238
|
-
"
|
|
3306
|
+
"stream": {
|
|
3307
|
+
"char": "s",
|
|
3308
|
+
"description": "Stream name(s), can be specified multiple times",
|
|
3309
|
+
"name": "stream",
|
|
3239
3310
|
"hasDynamicHelp": false,
|
|
3240
|
-
"multiple":
|
|
3241
|
-
"options": [
|
|
3242
|
-
"manual",
|
|
3243
|
-
"eventTrigger",
|
|
3244
|
-
"schedule",
|
|
3245
|
-
"slack"
|
|
3246
|
-
],
|
|
3311
|
+
"multiple": true,
|
|
3247
3312
|
"type": "option"
|
|
3248
3313
|
}
|
|
3249
3314
|
},
|
|
3250
3315
|
"hasDynamicHelp": false,
|
|
3251
3316
|
"hiddenAliases": [],
|
|
3252
|
-
"id": "
|
|
3317
|
+
"id": "query:latest-values",
|
|
3253
3318
|
"pluginAlias": "@formant/formant-cli",
|
|
3254
3319
|
"pluginName": "@formant/formant-cli",
|
|
3255
3320
|
"pluginType": "core",
|
|
3256
3321
|
"strict": true,
|
|
3257
|
-
"summary": "
|
|
3322
|
+
"summary": "Get latest stream values",
|
|
3258
3323
|
"enableJsonFlag": true,
|
|
3259
3324
|
"isESM": true,
|
|
3260
3325
|
"relativePath": [
|
|
3261
3326
|
"dist",
|
|
3262
3327
|
"commands",
|
|
3263
|
-
"
|
|
3264
|
-
"
|
|
3328
|
+
"query",
|
|
3329
|
+
"latest-values.js"
|
|
3265
3330
|
]
|
|
3266
3331
|
},
|
|
3267
|
-
"
|
|
3332
|
+
"fleets:get": {
|
|
3268
3333
|
"aliases": [],
|
|
3269
3334
|
"args": {
|
|
3270
3335
|
"id": {
|
|
3271
|
-
"description": "
|
|
3336
|
+
"description": "Fleet (group) ID (UUID)",
|
|
3272
3337
|
"name": "id",
|
|
3273
3338
|
"required": true
|
|
3274
3339
|
}
|
|
3275
3340
|
},
|
|
3276
|
-
"description": "Get
|
|
3341
|
+
"description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.",
|
|
3277
3342
|
"examples": [
|
|
3278
|
-
"<%= config.bin %>
|
|
3279
|
-
"<%= config.bin %>
|
|
3343
|
+
"<%= config.bin %> fleets get <fleet-id>",
|
|
3344
|
+
"<%= config.bin %> fleets get <fleet-id> --json"
|
|
3280
3345
|
],
|
|
3281
3346
|
"flags": {
|
|
3282
3347
|
"json": {
|
|
@@ -3309,35 +3374,28 @@
|
|
|
3309
3374
|
},
|
|
3310
3375
|
"hasDynamicHelp": false,
|
|
3311
3376
|
"hiddenAliases": [],
|
|
3312
|
-
"id": "
|
|
3377
|
+
"id": "fleets:get",
|
|
3313
3378
|
"pluginAlias": "@formant/formant-cli",
|
|
3314
3379
|
"pluginName": "@formant/formant-cli",
|
|
3315
3380
|
"pluginType": "core",
|
|
3316
3381
|
"strict": true,
|
|
3317
|
-
"summary": "Get
|
|
3382
|
+
"summary": "Get fleet details",
|
|
3318
3383
|
"enableJsonFlag": true,
|
|
3319
3384
|
"isESM": true,
|
|
3320
3385
|
"relativePath": [
|
|
3321
3386
|
"dist",
|
|
3322
3387
|
"commands",
|
|
3323
|
-
"
|
|
3324
|
-
"
|
|
3388
|
+
"fleets",
|
|
3389
|
+
"get.js"
|
|
3325
3390
|
]
|
|
3326
3391
|
},
|
|
3327
|
-
"
|
|
3392
|
+
"fleets:list": {
|
|
3328
3393
|
"aliases": [],
|
|
3329
|
-
"args": {
|
|
3330
|
-
|
|
3331
|
-
"description": "Name for the new device",
|
|
3332
|
-
"name": "name",
|
|
3333
|
-
"required": true
|
|
3334
|
-
}
|
|
3335
|
-
},
|
|
3336
|
-
"description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.",
|
|
3394
|
+
"args": {},
|
|
3395
|
+
"description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.",
|
|
3337
3396
|
"examples": [
|
|
3338
|
-
"<%= config.bin %>
|
|
3339
|
-
"<%= config.bin %>
|
|
3340
|
-
"<%= config.bin %> devices create my-robot --json"
|
|
3397
|
+
"<%= config.bin %> fleets list",
|
|
3398
|
+
"<%= config.bin %> fleets list --json"
|
|
3341
3399
|
],
|
|
3342
3400
|
"flags": {
|
|
3343
3401
|
"json": {
|
|
@@ -3366,46 +3424,38 @@
|
|
|
3366
3424
|
"name": "stage",
|
|
3367
3425
|
"allowNo": false,
|
|
3368
3426
|
"type": "boolean"
|
|
3369
|
-
},
|
|
3370
|
-
"tag": {
|
|
3371
|
-
"char": "t",
|
|
3372
|
-
"description": "Tag to apply (key=value), can be specified multiple times",
|
|
3373
|
-
"name": "tag",
|
|
3374
|
-
"hasDynamicHelp": false,
|
|
3375
|
-
"multiple": true,
|
|
3376
|
-
"type": "option"
|
|
3377
3427
|
}
|
|
3378
3428
|
},
|
|
3379
3429
|
"hasDynamicHelp": false,
|
|
3380
3430
|
"hiddenAliases": [],
|
|
3381
|
-
"id": "
|
|
3431
|
+
"id": "fleets:list",
|
|
3382
3432
|
"pluginAlias": "@formant/formant-cli",
|
|
3383
3433
|
"pluginName": "@formant/formant-cli",
|
|
3384
3434
|
"pluginType": "core",
|
|
3385
3435
|
"strict": true,
|
|
3386
|
-
"summary": "
|
|
3436
|
+
"summary": "List device groups",
|
|
3387
3437
|
"enableJsonFlag": true,
|
|
3388
3438
|
"isESM": true,
|
|
3389
3439
|
"relativePath": [
|
|
3390
3440
|
"dist",
|
|
3391
3441
|
"commands",
|
|
3392
|
-
"
|
|
3393
|
-
"
|
|
3442
|
+
"fleets",
|
|
3443
|
+
"list.js"
|
|
3394
3444
|
]
|
|
3395
3445
|
},
|
|
3396
|
-
"
|
|
3446
|
+
"schedules:get": {
|
|
3397
3447
|
"aliases": [],
|
|
3398
3448
|
"args": {
|
|
3399
3449
|
"id": {
|
|
3400
|
-
"description": "
|
|
3450
|
+
"description": "Schedule ID (UUID)",
|
|
3401
3451
|
"name": "id",
|
|
3402
3452
|
"required": true
|
|
3403
3453
|
}
|
|
3404
3454
|
},
|
|
3405
|
-
"description": "
|
|
3455
|
+
"description": "Get detailed information about a schedule.\n\nShows the full schedule configuration including cron expression, command template,\ninvestigation link, and execution settings.",
|
|
3406
3456
|
"examples": [
|
|
3407
|
-
"<%= config.bin %>
|
|
3408
|
-
"<%= config.bin %>
|
|
3457
|
+
"<%= config.bin %> schedules get <schedule-id>",
|
|
3458
|
+
"<%= config.bin %> schedules get <schedule-id> --json"
|
|
3409
3459
|
],
|
|
3410
3460
|
"flags": {
|
|
3411
3461
|
"json": {
|
|
@@ -3438,34 +3488,28 @@
|
|
|
3438
3488
|
},
|
|
3439
3489
|
"hasDynamicHelp": false,
|
|
3440
3490
|
"hiddenAliases": [],
|
|
3441
|
-
"id": "
|
|
3491
|
+
"id": "schedules:get",
|
|
3442
3492
|
"pluginAlias": "@formant/formant-cli",
|
|
3443
3493
|
"pluginName": "@formant/formant-cli",
|
|
3444
3494
|
"pluginType": "core",
|
|
3445
3495
|
"strict": true,
|
|
3446
|
-
"summary": "
|
|
3496
|
+
"summary": "Get schedule details",
|
|
3447
3497
|
"enableJsonFlag": true,
|
|
3448
3498
|
"isESM": true,
|
|
3449
3499
|
"relativePath": [
|
|
3450
3500
|
"dist",
|
|
3451
3501
|
"commands",
|
|
3452
|
-
"
|
|
3453
|
-
"
|
|
3502
|
+
"schedules",
|
|
3503
|
+
"get.js"
|
|
3454
3504
|
]
|
|
3455
3505
|
},
|
|
3456
|
-
"
|
|
3506
|
+
"schedules:list": {
|
|
3457
3507
|
"aliases": [],
|
|
3458
|
-
"args": {
|
|
3459
|
-
|
|
3460
|
-
"description": "Device ID (UUID)",
|
|
3461
|
-
"name": "id",
|
|
3462
|
-
"required": true
|
|
3463
|
-
}
|
|
3464
|
-
},
|
|
3465
|
-
"description": "Get detailed information about a specific device by its ID.",
|
|
3508
|
+
"args": {},
|
|
3509
|
+
"description": "List all schedules in your organization.\n\nSchedules can trigger commands or investigations on a recurring (cron) or one-time basis.",
|
|
3466
3510
|
"examples": [
|
|
3467
|
-
"<%= config.bin %>
|
|
3468
|
-
"<%= config.bin %>
|
|
3511
|
+
"<%= config.bin %> schedules list",
|
|
3512
|
+
"<%= config.bin %> schedules list --json"
|
|
3469
3513
|
],
|
|
3470
3514
|
"flags": {
|
|
3471
3515
|
"json": {
|
|
@@ -3498,34 +3542,34 @@
|
|
|
3498
3542
|
},
|
|
3499
3543
|
"hasDynamicHelp": false,
|
|
3500
3544
|
"hiddenAliases": [],
|
|
3501
|
-
"id": "
|
|
3545
|
+
"id": "schedules:list",
|
|
3502
3546
|
"pluginAlias": "@formant/formant-cli",
|
|
3503
3547
|
"pluginName": "@formant/formant-cli",
|
|
3504
3548
|
"pluginType": "core",
|
|
3505
3549
|
"strict": true,
|
|
3506
|
-
"summary": "
|
|
3550
|
+
"summary": "List schedules",
|
|
3507
3551
|
"enableJsonFlag": true,
|
|
3508
3552
|
"isESM": true,
|
|
3509
3553
|
"relativePath": [
|
|
3510
3554
|
"dist",
|
|
3511
3555
|
"commands",
|
|
3512
|
-
"
|
|
3513
|
-
"
|
|
3556
|
+
"schedules",
|
|
3557
|
+
"list.js"
|
|
3514
3558
|
]
|
|
3515
3559
|
},
|
|
3516
|
-
"
|
|
3560
|
+
"users:get": {
|
|
3517
3561
|
"aliases": [],
|
|
3518
3562
|
"args": {
|
|
3519
3563
|
"id": {
|
|
3520
|
-
"description": "
|
|
3564
|
+
"description": "User ID (UUID)",
|
|
3521
3565
|
"name": "id",
|
|
3522
3566
|
"required": true
|
|
3523
3567
|
}
|
|
3524
3568
|
},
|
|
3525
|
-
"description": "Get
|
|
3569
|
+
"description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.",
|
|
3526
3570
|
"examples": [
|
|
3527
|
-
"<%= config.bin %>
|
|
3528
|
-
"<%= config.bin %>
|
|
3571
|
+
"<%= config.bin %> users get <user-id>",
|
|
3572
|
+
"<%= config.bin %> users get <user-id> --json"
|
|
3529
3573
|
],
|
|
3530
3574
|
"flags": {
|
|
3531
3575
|
"json": {
|
|
@@ -3558,31 +3602,28 @@
|
|
|
3558
3602
|
},
|
|
3559
3603
|
"hasDynamicHelp": false,
|
|
3560
3604
|
"hiddenAliases": [],
|
|
3561
|
-
"id": "
|
|
3605
|
+
"id": "users:get",
|
|
3562
3606
|
"pluginAlias": "@formant/formant-cli",
|
|
3563
3607
|
"pluginName": "@formant/formant-cli",
|
|
3564
3608
|
"pluginType": "core",
|
|
3565
3609
|
"strict": true,
|
|
3566
|
-
"summary": "Get
|
|
3610
|
+
"summary": "Get user details",
|
|
3567
3611
|
"enableJsonFlag": true,
|
|
3568
3612
|
"isESM": true,
|
|
3569
3613
|
"relativePath": [
|
|
3570
3614
|
"dist",
|
|
3571
3615
|
"commands",
|
|
3572
|
-
"
|
|
3573
|
-
"
|
|
3616
|
+
"users",
|
|
3617
|
+
"get.js"
|
|
3574
3618
|
]
|
|
3575
3619
|
},
|
|
3576
|
-
"
|
|
3620
|
+
"users:list": {
|
|
3577
3621
|
"aliases": [],
|
|
3578
3622
|
"args": {},
|
|
3579
|
-
"description": "List
|
|
3623
|
+
"description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.",
|
|
3580
3624
|
"examples": [
|
|
3581
|
-
"<%= config.bin %>
|
|
3582
|
-
"<%= config.bin %>
|
|
3583
|
-
"<%= config.bin %> devices list --all --limit 100",
|
|
3584
|
-
"<%= config.bin %> devices list --tag location=warehouse",
|
|
3585
|
-
"<%= config.bin %> devices list --name robot --dev --json"
|
|
3625
|
+
"<%= config.bin %> users list",
|
|
3626
|
+
"<%= config.bin %> users list --json"
|
|
3586
3627
|
],
|
|
3587
3628
|
"flags": {
|
|
3588
3629
|
"json": {
|
|
@@ -3611,75 +3652,33 @@
|
|
|
3611
3652
|
"name": "stage",
|
|
3612
3653
|
"allowNo": false,
|
|
3613
3654
|
"type": "boolean"
|
|
3614
|
-
},
|
|
3615
|
-
"all": {
|
|
3616
|
-
"char": "a",
|
|
3617
|
-
"description": "Show all devices (online and offline)",
|
|
3618
|
-
"name": "all",
|
|
3619
|
-
"allowNo": false,
|
|
3620
|
-
"type": "boolean"
|
|
3621
|
-
},
|
|
3622
|
-
"limit": {
|
|
3623
|
-
"char": "l",
|
|
3624
|
-
"description": "Maximum number of devices to return",
|
|
3625
|
-
"name": "limit",
|
|
3626
|
-
"default": 50,
|
|
3627
|
-
"hasDynamicHelp": false,
|
|
3628
|
-
"multiple": false,
|
|
3629
|
-
"type": "option"
|
|
3630
|
-
},
|
|
3631
|
-
"name": {
|
|
3632
|
-
"char": "n",
|
|
3633
|
-
"description": "Filter devices by name (search)",
|
|
3634
|
-
"name": "name",
|
|
3635
|
-
"hasDynamicHelp": false,
|
|
3636
|
-
"multiple": false,
|
|
3637
|
-
"type": "option"
|
|
3638
|
-
},
|
|
3639
|
-
"tag": {
|
|
3640
|
-
"char": "t",
|
|
3641
|
-
"description": "Filter by tag (key=value), can be specified multiple times",
|
|
3642
|
-
"name": "tag",
|
|
3643
|
-
"hasDynamicHelp": false,
|
|
3644
|
-
"multiple": true,
|
|
3645
|
-
"type": "option"
|
|
3646
3655
|
}
|
|
3647
3656
|
},
|
|
3648
3657
|
"hasDynamicHelp": false,
|
|
3649
3658
|
"hiddenAliases": [],
|
|
3650
|
-
"id": "
|
|
3659
|
+
"id": "users:list",
|
|
3651
3660
|
"pluginAlias": "@formant/formant-cli",
|
|
3652
3661
|
"pluginName": "@formant/formant-cli",
|
|
3653
3662
|
"pluginType": "core",
|
|
3654
3663
|
"strict": true,
|
|
3655
|
-
"summary": "List
|
|
3664
|
+
"summary": "List users",
|
|
3656
3665
|
"enableJsonFlag": true,
|
|
3657
3666
|
"isESM": true,
|
|
3658
3667
|
"relativePath": [
|
|
3659
3668
|
"dist",
|
|
3660
3669
|
"commands",
|
|
3661
|
-
"
|
|
3670
|
+
"users",
|
|
3662
3671
|
"list.js"
|
|
3663
3672
|
]
|
|
3664
3673
|
},
|
|
3665
|
-
"
|
|
3674
|
+
"signals:count": {
|
|
3666
3675
|
"aliases": [],
|
|
3667
|
-
"args": {
|
|
3668
|
-
|
|
3669
|
-
"description": "Device ID (UUID)",
|
|
3670
|
-
"name": "id",
|
|
3671
|
-
"required": true
|
|
3672
|
-
},
|
|
3673
|
-
"name": {
|
|
3674
|
-
"description": "New name for the device",
|
|
3675
|
-
"name": "name",
|
|
3676
|
-
"required": true
|
|
3677
|
-
}
|
|
3678
|
-
},
|
|
3679
|
-
"description": "Rename a device by updating its name.",
|
|
3676
|
+
"args": {},
|
|
3677
|
+
"description": "Get counts of signals grouped by type.\n\nReturns total counts and per-type breakdowns (manual, eventTrigger, schedule, slack).",
|
|
3680
3678
|
"examples": [
|
|
3681
|
-
"<%= config.bin %>
|
|
3682
|
-
"<%= config.bin %>
|
|
3679
|
+
"<%= config.bin %> signals count",
|
|
3680
|
+
"<%= config.bin %> signals count --start 2026-01-01 --end 2026-02-01",
|
|
3681
|
+
"<%= config.bin %> signals count --json"
|
|
3683
3682
|
],
|
|
3684
3683
|
"flags": {
|
|
3685
3684
|
"json": {
|
|
@@ -3708,38 +3707,53 @@
|
|
|
3708
3707
|
"name": "stage",
|
|
3709
3708
|
"allowNo": false,
|
|
3710
3709
|
"type": "boolean"
|
|
3710
|
+
},
|
|
3711
|
+
"end": {
|
|
3712
|
+
"description": "End time (ISO 8601)",
|
|
3713
|
+
"name": "end",
|
|
3714
|
+
"hasDynamicHelp": false,
|
|
3715
|
+
"multiple": false,
|
|
3716
|
+
"type": "option"
|
|
3717
|
+
},
|
|
3718
|
+
"start": {
|
|
3719
|
+
"description": "Start time (ISO 8601)",
|
|
3720
|
+
"name": "start",
|
|
3721
|
+
"hasDynamicHelp": false,
|
|
3722
|
+
"multiple": false,
|
|
3723
|
+
"type": "option"
|
|
3711
3724
|
}
|
|
3712
3725
|
},
|
|
3713
3726
|
"hasDynamicHelp": false,
|
|
3714
3727
|
"hiddenAliases": [],
|
|
3715
|
-
"id": "
|
|
3728
|
+
"id": "signals:count",
|
|
3716
3729
|
"pluginAlias": "@formant/formant-cli",
|
|
3717
3730
|
"pluginName": "@formant/formant-cli",
|
|
3718
3731
|
"pluginType": "core",
|
|
3719
3732
|
"strict": true,
|
|
3720
|
-
"summary": "
|
|
3733
|
+
"summary": "Get signal counts by type",
|
|
3721
3734
|
"enableJsonFlag": true,
|
|
3722
3735
|
"isESM": true,
|
|
3723
3736
|
"relativePath": [
|
|
3724
3737
|
"dist",
|
|
3725
3738
|
"commands",
|
|
3726
|
-
"
|
|
3727
|
-
"
|
|
3739
|
+
"signals",
|
|
3740
|
+
"count.js"
|
|
3728
3741
|
]
|
|
3729
3742
|
},
|
|
3730
|
-
"
|
|
3743
|
+
"signals:get": {
|
|
3731
3744
|
"aliases": [],
|
|
3732
3745
|
"args": {
|
|
3733
3746
|
"id": {
|
|
3734
|
-
"description": "
|
|
3747
|
+
"description": "Signal ID (UUID)",
|
|
3735
3748
|
"name": "id",
|
|
3736
3749
|
"required": true
|
|
3737
3750
|
}
|
|
3738
3751
|
},
|
|
3739
|
-
"description": "
|
|
3752
|
+
"description": "Get detailed information about a specific signal by its ID.\n\nShows signal details including the triggering event, goal, status, and type (manual, \neventTrigger, schedule, slack). Use --trace to also fetch the event and event trigger \ninformation.",
|
|
3740
3753
|
"examples": [
|
|
3741
|
-
"<%= config.bin %>
|
|
3742
|
-
"<%= config.bin %>
|
|
3754
|
+
"<%= config.bin %> signals get <signal-id>",
|
|
3755
|
+
"<%= config.bin %> signals get <signal-id> --trace",
|
|
3756
|
+
"<%= config.bin %> signals get <signal-id> --json"
|
|
3743
3757
|
],
|
|
3744
3758
|
"flags": {
|
|
3745
3759
|
"json": {
|
|
@@ -3768,39 +3782,38 @@
|
|
|
3768
3782
|
"name": "stage",
|
|
3769
3783
|
"allowNo": false,
|
|
3770
3784
|
"type": "boolean"
|
|
3785
|
+
},
|
|
3786
|
+
"trace": {
|
|
3787
|
+
"description": "Fetch and display the triggering event and event trigger information",
|
|
3788
|
+
"name": "trace",
|
|
3789
|
+
"allowNo": false,
|
|
3790
|
+
"type": "boolean"
|
|
3771
3791
|
}
|
|
3772
3792
|
},
|
|
3773
3793
|
"hasDynamicHelp": false,
|
|
3774
3794
|
"hiddenAliases": [],
|
|
3775
|
-
"id": "
|
|
3795
|
+
"id": "signals:get",
|
|
3776
3796
|
"pluginAlias": "@formant/formant-cli",
|
|
3777
3797
|
"pluginName": "@formant/formant-cli",
|
|
3778
3798
|
"pluginType": "core",
|
|
3779
3799
|
"strict": true,
|
|
3780
|
-
"summary": "
|
|
3800
|
+
"summary": "Get a signal by ID",
|
|
3781
3801
|
"enableJsonFlag": true,
|
|
3782
3802
|
"isESM": true,
|
|
3783
3803
|
"relativePath": [
|
|
3784
3804
|
"dist",
|
|
3785
3805
|
"commands",
|
|
3786
|
-
"
|
|
3787
|
-
"
|
|
3806
|
+
"signals",
|
|
3807
|
+
"get.js"
|
|
3788
3808
|
]
|
|
3789
3809
|
},
|
|
3790
|
-
"
|
|
3810
|
+
"signals:list": {
|
|
3791
3811
|
"aliases": [],
|
|
3792
|
-
"args": {
|
|
3793
|
-
|
|
3794
|
-
"description": "Device ID (UUID)",
|
|
3795
|
-
"name": "id",
|
|
3796
|
-
"required": true
|
|
3797
|
-
}
|
|
3798
|
-
},
|
|
3799
|
-
"description": "Add or update tags on a device.\n\nTags are key-value pairs. If a tag key already exists, its value will be updated.\nSpecify one or more tags with --tag key=value.",
|
|
3812
|
+
"args": {},
|
|
3813
|
+
"description": "List all signals in your organization.\n\nSignals are points of interest that trigger AI-powered investigations. They can be\ncreated manually, generated from device events, scheduled, or from Slack/Teams integrations.",
|
|
3800
3814
|
"examples": [
|
|
3801
|
-
"<%= config.bin %>
|
|
3802
|
-
"<%= config.bin %>
|
|
3803
|
-
"<%= config.bin %> devices tag <device-id> --tag location=factory --json"
|
|
3815
|
+
"<%= config.bin %> signals list",
|
|
3816
|
+
"<%= config.bin %> signals list --json"
|
|
3804
3817
|
],
|
|
3805
3818
|
"flags": {
|
|
3806
3819
|
"json": {
|
|
@@ -3829,48 +3842,33 @@
|
|
|
3829
3842
|
"name": "stage",
|
|
3830
3843
|
"allowNo": false,
|
|
3831
3844
|
"type": "boolean"
|
|
3832
|
-
},
|
|
3833
|
-
"tag": {
|
|
3834
|
-
"char": "t",
|
|
3835
|
-
"description": "Tag to add or update (key=value), can be specified multiple times",
|
|
3836
|
-
"name": "tag",
|
|
3837
|
-
"required": true,
|
|
3838
|
-
"hasDynamicHelp": false,
|
|
3839
|
-
"multiple": true,
|
|
3840
|
-
"type": "option"
|
|
3841
3845
|
}
|
|
3842
3846
|
},
|
|
3843
3847
|
"hasDynamicHelp": false,
|
|
3844
3848
|
"hiddenAliases": [],
|
|
3845
|
-
"id": "
|
|
3849
|
+
"id": "signals:list",
|
|
3846
3850
|
"pluginAlias": "@formant/formant-cli",
|
|
3847
3851
|
"pluginName": "@formant/formant-cli",
|
|
3848
3852
|
"pluginType": "core",
|
|
3849
3853
|
"strict": true,
|
|
3850
|
-
"summary": "
|
|
3854
|
+
"summary": "List all signals",
|
|
3851
3855
|
"enableJsonFlag": true,
|
|
3852
3856
|
"isESM": true,
|
|
3853
3857
|
"relativePath": [
|
|
3854
3858
|
"dist",
|
|
3855
3859
|
"commands",
|
|
3856
|
-
"
|
|
3857
|
-
"
|
|
3860
|
+
"signals",
|
|
3861
|
+
"list.js"
|
|
3858
3862
|
]
|
|
3859
3863
|
},
|
|
3860
|
-
"
|
|
3864
|
+
"signals:query": {
|
|
3861
3865
|
"aliases": [],
|
|
3862
|
-
"args": {
|
|
3863
|
-
|
|
3864
|
-
"description": "Device ID (UUID)",
|
|
3865
|
-
"name": "id",
|
|
3866
|
-
"required": true
|
|
3867
|
-
}
|
|
3868
|
-
},
|
|
3869
|
-
"description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.",
|
|
3866
|
+
"args": {},
|
|
3867
|
+
"description": "Query signals by time range and type.\n\nSignal types: manual, eventTrigger, schedule, slack.",
|
|
3870
3868
|
"examples": [
|
|
3871
|
-
"<%= config.bin %>
|
|
3872
|
-
"<%= config.bin %>
|
|
3873
|
-
"<%= config.bin %>
|
|
3869
|
+
"<%= config.bin %> signals query --start 2026-01-01",
|
|
3870
|
+
"<%= config.bin %> signals query --start 2026-01-01 --end 2026-02-01 --type eventTrigger",
|
|
3871
|
+
"<%= config.bin %> signals query --start 2026-01-01 --json"
|
|
3874
3872
|
],
|
|
3875
3873
|
"flags": {
|
|
3876
3874
|
"json": {
|
|
@@ -3900,33 +3898,52 @@
|
|
|
3900
3898
|
"allowNo": false,
|
|
3901
3899
|
"type": "boolean"
|
|
3902
3900
|
},
|
|
3903
|
-
"
|
|
3904
|
-
"
|
|
3905
|
-
"
|
|
3906
|
-
"
|
|
3901
|
+
"end": {
|
|
3902
|
+
"description": "End time (ISO 8601)",
|
|
3903
|
+
"name": "end",
|
|
3904
|
+
"hasDynamicHelp": false,
|
|
3905
|
+
"multiple": false,
|
|
3906
|
+
"type": "option"
|
|
3907
|
+
},
|
|
3908
|
+
"start": {
|
|
3909
|
+
"description": "Start time (ISO 8601)",
|
|
3910
|
+
"name": "start",
|
|
3907
3911
|
"required": true,
|
|
3908
3912
|
"hasDynamicHelp": false,
|
|
3909
|
-
"multiple":
|
|
3913
|
+
"multiple": false,
|
|
3914
|
+
"type": "option"
|
|
3915
|
+
},
|
|
3916
|
+
"type": {
|
|
3917
|
+
"description": "Filter by signal type",
|
|
3918
|
+
"name": "type",
|
|
3919
|
+
"hasDynamicHelp": false,
|
|
3920
|
+
"multiple": false,
|
|
3921
|
+
"options": [
|
|
3922
|
+
"manual",
|
|
3923
|
+
"eventTrigger",
|
|
3924
|
+
"schedule",
|
|
3925
|
+
"slack"
|
|
3926
|
+
],
|
|
3910
3927
|
"type": "option"
|
|
3911
3928
|
}
|
|
3912
3929
|
},
|
|
3913
3930
|
"hasDynamicHelp": false,
|
|
3914
3931
|
"hiddenAliases": [],
|
|
3915
|
-
"id": "
|
|
3932
|
+
"id": "signals:query",
|
|
3916
3933
|
"pluginAlias": "@formant/formant-cli",
|
|
3917
3934
|
"pluginName": "@formant/formant-cli",
|
|
3918
3935
|
"pluginType": "core",
|
|
3919
3936
|
"strict": true,
|
|
3920
|
-
"summary": "
|
|
3937
|
+
"summary": "Query signals by time range",
|
|
3921
3938
|
"enableJsonFlag": true,
|
|
3922
3939
|
"isESM": true,
|
|
3923
3940
|
"relativePath": [
|
|
3924
3941
|
"dist",
|
|
3925
3942
|
"commands",
|
|
3926
|
-
"
|
|
3927
|
-
"
|
|
3943
|
+
"signals",
|
|
3944
|
+
"query.js"
|
|
3928
3945
|
]
|
|
3929
3946
|
}
|
|
3930
3947
|
},
|
|
3931
|
-
"version": "0.3.
|
|
3948
|
+
"version": "0.3.1"
|
|
3932
3949
|
}
|