@formant/formant-cli 0.1.0
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/LICENSE +24 -0
- package/README.md +322 -0
- package/bin/dev.js +5 -0
- package/bin/run.js +5 -0
- package/dist/base-command.d.ts +38 -0
- package/dist/base-command.js +66 -0
- package/dist/base-command.js.map +1 -0
- package/dist/commands/analytics/query.d.ts +12 -0
- package/dist/commands/analytics/query.js +82 -0
- package/dist/commands/analytics/query.js.map +1 -0
- package/dist/commands/analytics/tables.d.ts +9 -0
- package/dist/commands/analytics/tables.js +34 -0
- package/dist/commands/analytics/tables.js.map +1 -0
- package/dist/commands/commands/for-device.d.ts +12 -0
- package/dist/commands/commands/for-device.js +33 -0
- package/dist/commands/commands/for-device.js.map +1 -0
- package/dist/commands/commands/get.d.ts +11 -0
- package/dist/commands/commands/get.js +133 -0
- package/dist/commands/commands/get.js.map +1 -0
- package/dist/commands/commands/history.d.ts +13 -0
- package/dist/commands/commands/history.js +49 -0
- package/dist/commands/commands/history.js.map +1 -0
- package/dist/commands/commands/list.d.ts +9 -0
- package/dist/commands/commands/list.js +31 -0
- package/dist/commands/commands/list.js.map +1 -0
- package/dist/commands/commands/send.d.ts +37 -0
- package/dist/commands/commands/send.js +260 -0
- package/dist/commands/commands/send.js.map +1 -0
- package/dist/commands/devices/config.d.ts +10 -0
- package/dist/commands/devices/config.js +38 -0
- package/dist/commands/devices/config.js.map +1 -0
- package/dist/commands/devices/get.d.ts +10 -0
- package/dist/commands/devices/get.js +35 -0
- package/dist/commands/devices/get.js.map +1 -0
- package/dist/commands/devices/last-seen.d.ts +10 -0
- package/dist/commands/devices/last-seen.js +25 -0
- package/dist/commands/devices/last-seen.js.map +1 -0
- package/dist/commands/devices/list.d.ts +20 -0
- package/dist/commands/devices/list.js +133 -0
- package/dist/commands/devices/list.js.map +1 -0
- package/dist/commands/devices/streams.d.ts +12 -0
- package/dist/commands/devices/streams.js +56 -0
- package/dist/commands/devices/streams.js.map +1 -0
- package/dist/commands/event-triggers/get.d.ts +10 -0
- package/dist/commands/event-triggers/get.js +29 -0
- package/dist/commands/event-triggers/get.js.map +1 -0
- package/dist/commands/event-triggers/list.d.ts +9 -0
- package/dist/commands/event-triggers/list.js +30 -0
- package/dist/commands/event-triggers/list.js.map +1 -0
- package/dist/commands/events/get.d.ts +10 -0
- package/dist/commands/events/get.js +35 -0
- package/dist/commands/events/get.js.map +1 -0
- package/dist/commands/events/list.d.ts +17 -0
- package/dist/commands/events/list.js +81 -0
- package/dist/commands/events/list.js.map +1 -0
- package/dist/commands/fleets/get.d.ts +10 -0
- package/dist/commands/fleets/get.js +28 -0
- package/dist/commands/fleets/get.js.map +1 -0
- package/dist/commands/fleets/list.d.ts +9 -0
- package/dist/commands/fleets/list.js +27 -0
- package/dist/commands/fleets/list.js.map +1 -0
- package/dist/commands/investigations/analytics.d.ts +15 -0
- package/dist/commands/investigations/analytics.js +69 -0
- package/dist/commands/investigations/analytics.js.map +1 -0
- package/dist/commands/investigations/get.d.ts +10 -0
- package/dist/commands/investigations/get.js +38 -0
- package/dist/commands/investigations/get.js.map +1 -0
- package/dist/commands/investigations/list.d.ts +12 -0
- package/dist/commands/investigations/list.js +41 -0
- package/dist/commands/investigations/list.js.map +1 -0
- package/dist/commands/investigations/run.d.ts +15 -0
- package/dist/commands/investigations/run.js +96 -0
- package/dist/commands/investigations/run.js.map +1 -0
- package/dist/commands/investigations/runs-list.d.ts +18 -0
- package/dist/commands/investigations/runs-list.js +57 -0
- package/dist/commands/investigations/runs-list.js.map +1 -0
- package/dist/commands/investigations/runs.d.ts +12 -0
- package/dist/commands/investigations/runs.js +30 -0
- package/dist/commands/investigations/runs.js.map +1 -0
- package/dist/commands/investigations/stats.d.ts +11 -0
- package/dist/commands/investigations/stats.js +40 -0
- package/dist/commands/investigations/stats.js.map +1 -0
- package/dist/commands/investigations/trigger.d.ts +14 -0
- package/dist/commands/investigations/trigger.js +43 -0
- package/dist/commands/investigations/trigger.js.map +1 -0
- package/dist/commands/kv/get.d.ts +10 -0
- package/dist/commands/kv/get.js +28 -0
- package/dist/commands/kv/get.js.map +1 -0
- package/dist/commands/kv/list.d.ts +13 -0
- package/dist/commands/kv/list.js +73 -0
- package/dist/commands/kv/list.js.map +1 -0
- package/dist/commands/kv/set.d.ts +11 -0
- package/dist/commands/kv/set.js +40 -0
- package/dist/commands/kv/set.js.map +1 -0
- package/dist/commands/query/index.d.ts +19 -0
- package/dist/commands/query/index.js +105 -0
- package/dist/commands/query/index.js.map +1 -0
- package/dist/commands/query/latest-values.d.ts +14 -0
- package/dist/commands/query/latest-values.js +102 -0
- package/dist/commands/query/latest-values.js.map +1 -0
- package/dist/commands/schedules/get.d.ts +10 -0
- package/dist/commands/schedules/get.js +29 -0
- package/dist/commands/schedules/get.js.map +1 -0
- package/dist/commands/schedules/list.d.ts +9 -0
- package/dist/commands/schedules/list.js +29 -0
- package/dist/commands/schedules/list.js.map +1 -0
- package/dist/commands/signals/count.d.ts +13 -0
- package/dist/commands/signals/count.js +43 -0
- package/dist/commands/signals/count.js.map +1 -0
- package/dist/commands/signals/get.d.ts +13 -0
- package/dist/commands/signals/get.js +80 -0
- package/dist/commands/signals/get.js.map +1 -0
- package/dist/commands/signals/list.d.ts +9 -0
- package/dist/commands/signals/list.js +30 -0
- package/dist/commands/signals/list.js.map +1 -0
- package/dist/commands/signals/query.d.ts +14 -0
- package/dist/commands/signals/query.js +52 -0
- package/dist/commands/signals/query.js.map +1 -0
- package/dist/commands/users/get.d.ts +10 -0
- package/dist/commands/users/get.js +28 -0
- package/dist/commands/users/get.js.map +1 -0
- package/dist/commands/users/list.d.ts +9 -0
- package/dist/commands/users/list.js +28 -0
- package/dist/commands/users/list.js.map +1 -0
- package/dist/help.d.ts +4 -0
- package/dist/help.js +91 -0
- package/dist/help.js.map +1 -0
- package/dist/hooks/init.d.ts +3 -0
- package/dist/hooks/init.js +7 -0
- package/dist/hooks/init.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/api.d.ts +12 -0
- package/dist/lib/api.js +46 -0
- package/dist/lib/api.js.map +1 -0
- package/dist/lib/auth.d.ts +17 -0
- package/dist/lib/auth.js +41 -0
- package/dist/lib/auth.js.map +1 -0
- package/dist/lib/config.d.ts +7 -0
- package/dist/lib/config.js +21 -0
- package/dist/lib/config.js.map +1 -0
- package/dist/lib/formatters.d.ts +17 -0
- package/dist/lib/formatters.js +53 -0
- package/dist/lib/formatters.js.map +1 -0
- package/oclif.manifest.json +2683 -0
- package/package.json +117 -0
|
@@ -0,0 +1,2683 @@
|
|
|
1
|
+
{
|
|
2
|
+
"commands": {
|
|
3
|
+
"analytics:query": {
|
|
4
|
+
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "Execute a SQL query against analytics data (Snowflake SQL dialect).\n\nQuery telemetry data, events, and other analytics tables using Snowflake-compatible SQL.\nUse 'fcli analytics tables' to see available tables and their columns.\n\nNote: The analytics engine uses the Snowflake SQL dialect. String comparisons are\ncase-sensitive, use ILIKE for case-insensitive matching, and timestamps should be\nquoted strings (e.g. WHERE time > '2026-01-01'). Large unbounded queries may be\nrejected — always filter by time range for large tables.",
|
|
7
|
+
"examples": [
|
|
8
|
+
"<%= config.bin %> analytics query --sql \"SELECT * FROM query_event WHERE time > '2026-01-01' LIMIT 10\"",
|
|
9
|
+
"<%= config.bin %> analytics query --sql \"SELECT device_id, avg(value) as avg_val FROM query_numeric WHERE time > '2026-02-01' GROUP BY device_id LIMIT 10\"",
|
|
10
|
+
"<%= config.bin %> analytics query --sql \"SELECT type, count(*) as cnt FROM query_event WHERE time > '2026-02-01' GROUP BY type ORDER BY cnt DESC LIMIT 5\"",
|
|
11
|
+
"<%= config.bin %> analytics query --sql \"SELECT * FROM query_event LIMIT 10\" --json"
|
|
12
|
+
],
|
|
13
|
+
"flags": {
|
|
14
|
+
"json": {
|
|
15
|
+
"description": "Format output as json.",
|
|
16
|
+
"helpGroup": "GLOBAL",
|
|
17
|
+
"name": "json",
|
|
18
|
+
"allowNo": false,
|
|
19
|
+
"type": "boolean"
|
|
20
|
+
},
|
|
21
|
+
"dev": {
|
|
22
|
+
"description": "Target the dev environment",
|
|
23
|
+
"exclusive": [
|
|
24
|
+
"stage"
|
|
25
|
+
],
|
|
26
|
+
"helpGroup": "GLOBAL",
|
|
27
|
+
"name": "dev",
|
|
28
|
+
"allowNo": false,
|
|
29
|
+
"type": "boolean"
|
|
30
|
+
},
|
|
31
|
+
"stage": {
|
|
32
|
+
"description": "Target the stage environment",
|
|
33
|
+
"exclusive": [
|
|
34
|
+
"dev"
|
|
35
|
+
],
|
|
36
|
+
"helpGroup": "GLOBAL",
|
|
37
|
+
"name": "stage",
|
|
38
|
+
"allowNo": false,
|
|
39
|
+
"type": "boolean"
|
|
40
|
+
},
|
|
41
|
+
"limit": {
|
|
42
|
+
"char": "l",
|
|
43
|
+
"description": "Maximum number of rows to return",
|
|
44
|
+
"name": "limit",
|
|
45
|
+
"hasDynamicHelp": false,
|
|
46
|
+
"multiple": false,
|
|
47
|
+
"type": "option"
|
|
48
|
+
},
|
|
49
|
+
"sql": {
|
|
50
|
+
"char": "s",
|
|
51
|
+
"description": "SQL query to execute",
|
|
52
|
+
"name": "sql",
|
|
53
|
+
"required": true,
|
|
54
|
+
"hasDynamicHelp": false,
|
|
55
|
+
"multiple": false,
|
|
56
|
+
"type": "option"
|
|
57
|
+
},
|
|
58
|
+
"type": {
|
|
59
|
+
"description": "Query type",
|
|
60
|
+
"name": "type",
|
|
61
|
+
"default": "advanced",
|
|
62
|
+
"hasDynamicHelp": false,
|
|
63
|
+
"multiple": false,
|
|
64
|
+
"options": [
|
|
65
|
+
"stream",
|
|
66
|
+
"task",
|
|
67
|
+
"advanced"
|
|
68
|
+
],
|
|
69
|
+
"type": "option"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"hasDynamicHelp": false,
|
|
73
|
+
"hiddenAliases": [],
|
|
74
|
+
"id": "analytics:query",
|
|
75
|
+
"pluginAlias": "@formant/formant-cli",
|
|
76
|
+
"pluginName": "@formant/formant-cli",
|
|
77
|
+
"pluginType": "core",
|
|
78
|
+
"strict": true,
|
|
79
|
+
"summary": "Execute SQL analytics query",
|
|
80
|
+
"enableJsonFlag": true,
|
|
81
|
+
"isESM": true,
|
|
82
|
+
"relativePath": [
|
|
83
|
+
"dist",
|
|
84
|
+
"commands",
|
|
85
|
+
"analytics",
|
|
86
|
+
"query.js"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"analytics:tables": {
|
|
90
|
+
"aliases": [],
|
|
91
|
+
"args": {},
|
|
92
|
+
"description": "List available SQL tables for analytics queries.\n\nShows table names, descriptions, and column definitions that can be used\nwith 'fcli analytics query'. The analytics engine uses the Snowflake SQL dialect.",
|
|
93
|
+
"examples": [
|
|
94
|
+
"<%= config.bin %> analytics tables",
|
|
95
|
+
"<%= config.bin %> analytics tables --json"
|
|
96
|
+
],
|
|
97
|
+
"flags": {
|
|
98
|
+
"json": {
|
|
99
|
+
"description": "Format output as json.",
|
|
100
|
+
"helpGroup": "GLOBAL",
|
|
101
|
+
"name": "json",
|
|
102
|
+
"allowNo": false,
|
|
103
|
+
"type": "boolean"
|
|
104
|
+
},
|
|
105
|
+
"dev": {
|
|
106
|
+
"description": "Target the dev environment",
|
|
107
|
+
"exclusive": [
|
|
108
|
+
"stage"
|
|
109
|
+
],
|
|
110
|
+
"helpGroup": "GLOBAL",
|
|
111
|
+
"name": "dev",
|
|
112
|
+
"allowNo": false,
|
|
113
|
+
"type": "boolean"
|
|
114
|
+
},
|
|
115
|
+
"stage": {
|
|
116
|
+
"description": "Target the stage environment",
|
|
117
|
+
"exclusive": [
|
|
118
|
+
"dev"
|
|
119
|
+
],
|
|
120
|
+
"helpGroup": "GLOBAL",
|
|
121
|
+
"name": "stage",
|
|
122
|
+
"allowNo": false,
|
|
123
|
+
"type": "boolean"
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
"hasDynamicHelp": false,
|
|
127
|
+
"hiddenAliases": [],
|
|
128
|
+
"id": "analytics:tables",
|
|
129
|
+
"pluginAlias": "@formant/formant-cli",
|
|
130
|
+
"pluginName": "@formant/formant-cli",
|
|
131
|
+
"pluginType": "core",
|
|
132
|
+
"strict": true,
|
|
133
|
+
"summary": "List analytics tables",
|
|
134
|
+
"enableJsonFlag": true,
|
|
135
|
+
"isESM": true,
|
|
136
|
+
"relativePath": [
|
|
137
|
+
"dist",
|
|
138
|
+
"commands",
|
|
139
|
+
"analytics",
|
|
140
|
+
"tables.js"
|
|
141
|
+
]
|
|
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
|
+
"event-triggers:get": {
|
|
311
|
+
"aliases": [],
|
|
312
|
+
"args": {
|
|
313
|
+
"id": {
|
|
314
|
+
"description": "Event trigger ID (UUID)",
|
|
315
|
+
"name": "id",
|
|
316
|
+
"required": true
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
"description": "Get detailed information about an event trigger.\n\nShows the full trigger configuration including conditions, exit conditions, commands\nit executes, and device targeting filters.",
|
|
320
|
+
"examples": [
|
|
321
|
+
"<%= config.bin %> event-triggers get <trigger-id>",
|
|
322
|
+
"<%= config.bin %> event-triggers get <trigger-id> --json"
|
|
323
|
+
],
|
|
324
|
+
"flags": {
|
|
325
|
+
"json": {
|
|
326
|
+
"description": "Format output as json.",
|
|
327
|
+
"helpGroup": "GLOBAL",
|
|
328
|
+
"name": "json",
|
|
329
|
+
"allowNo": false,
|
|
330
|
+
"type": "boolean"
|
|
331
|
+
},
|
|
332
|
+
"dev": {
|
|
333
|
+
"description": "Target the dev environment",
|
|
334
|
+
"exclusive": [
|
|
335
|
+
"stage"
|
|
336
|
+
],
|
|
337
|
+
"helpGroup": "GLOBAL",
|
|
338
|
+
"name": "dev",
|
|
339
|
+
"allowNo": false,
|
|
340
|
+
"type": "boolean"
|
|
341
|
+
},
|
|
342
|
+
"stage": {
|
|
343
|
+
"description": "Target the stage environment",
|
|
344
|
+
"exclusive": [
|
|
345
|
+
"dev"
|
|
346
|
+
],
|
|
347
|
+
"helpGroup": "GLOBAL",
|
|
348
|
+
"name": "stage",
|
|
349
|
+
"allowNo": false,
|
|
350
|
+
"type": "boolean"
|
|
351
|
+
}
|
|
352
|
+
},
|
|
353
|
+
"hasDynamicHelp": false,
|
|
354
|
+
"hiddenAliases": [],
|
|
355
|
+
"id": "event-triggers:get",
|
|
356
|
+
"pluginAlias": "@formant/formant-cli",
|
|
357
|
+
"pluginName": "@formant/formant-cli",
|
|
358
|
+
"pluginType": "core",
|
|
359
|
+
"strict": true,
|
|
360
|
+
"summary": "Get event trigger details",
|
|
361
|
+
"enableJsonFlag": true,
|
|
362
|
+
"isESM": true,
|
|
363
|
+
"relativePath": [
|
|
364
|
+
"dist",
|
|
365
|
+
"commands",
|
|
366
|
+
"event-triggers",
|
|
367
|
+
"get.js"
|
|
368
|
+
]
|
|
369
|
+
},
|
|
370
|
+
"event-triggers:list": {
|
|
371
|
+
"aliases": [],
|
|
372
|
+
"args": {},
|
|
373
|
+
"description": "List all event trigger rules in your organization.\n\nEvent triggers monitor device data and generate events/signals when conditions are met.\nThey can trigger investigations, send notifications, or execute commands.",
|
|
374
|
+
"examples": [
|
|
375
|
+
"<%= config.bin %> event-triggers list",
|
|
376
|
+
"<%= config.bin %> event-triggers list --json"
|
|
377
|
+
],
|
|
378
|
+
"flags": {
|
|
379
|
+
"json": {
|
|
380
|
+
"description": "Format output as json.",
|
|
381
|
+
"helpGroup": "GLOBAL",
|
|
382
|
+
"name": "json",
|
|
383
|
+
"allowNo": false,
|
|
384
|
+
"type": "boolean"
|
|
385
|
+
},
|
|
386
|
+
"dev": {
|
|
387
|
+
"description": "Target the dev environment",
|
|
388
|
+
"exclusive": [
|
|
389
|
+
"stage"
|
|
390
|
+
],
|
|
391
|
+
"helpGroup": "GLOBAL",
|
|
392
|
+
"name": "dev",
|
|
393
|
+
"allowNo": false,
|
|
394
|
+
"type": "boolean"
|
|
395
|
+
},
|
|
396
|
+
"stage": {
|
|
397
|
+
"description": "Target the stage environment",
|
|
398
|
+
"exclusive": [
|
|
399
|
+
"dev"
|
|
400
|
+
],
|
|
401
|
+
"helpGroup": "GLOBAL",
|
|
402
|
+
"name": "stage",
|
|
403
|
+
"allowNo": false,
|
|
404
|
+
"type": "boolean"
|
|
405
|
+
}
|
|
406
|
+
},
|
|
407
|
+
"hasDynamicHelp": false,
|
|
408
|
+
"hiddenAliases": [],
|
|
409
|
+
"id": "event-triggers:list",
|
|
410
|
+
"pluginAlias": "@formant/formant-cli",
|
|
411
|
+
"pluginName": "@formant/formant-cli",
|
|
412
|
+
"pluginType": "core",
|
|
413
|
+
"strict": true,
|
|
414
|
+
"summary": "List event trigger rules",
|
|
415
|
+
"enableJsonFlag": true,
|
|
416
|
+
"isESM": true,
|
|
417
|
+
"relativePath": [
|
|
418
|
+
"dist",
|
|
419
|
+
"commands",
|
|
420
|
+
"event-triggers",
|
|
421
|
+
"list.js"
|
|
422
|
+
]
|
|
423
|
+
},
|
|
424
|
+
"commands:for-device": {
|
|
425
|
+
"aliases": [],
|
|
426
|
+
"args": {
|
|
427
|
+
"deviceId": {
|
|
428
|
+
"description": "Device ID (UUID)",
|
|
429
|
+
"name": "deviceId",
|
|
430
|
+
"required": true
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
"description": "List command templates available for a specific device.\n\nReturns commands that match the device's tags and filters. Only enabled commands\nthat apply to this device are shown.",
|
|
434
|
+
"examples": [
|
|
435
|
+
"<%= config.bin %> commands for-device <device-id>",
|
|
436
|
+
"<%= config.bin %> commands for-device <device-id> --json"
|
|
437
|
+
],
|
|
438
|
+
"flags": {
|
|
439
|
+
"json": {
|
|
440
|
+
"description": "Format output as json.",
|
|
441
|
+
"helpGroup": "GLOBAL",
|
|
442
|
+
"name": "json",
|
|
443
|
+
"allowNo": false,
|
|
444
|
+
"type": "boolean"
|
|
445
|
+
},
|
|
446
|
+
"dev": {
|
|
447
|
+
"description": "Target the dev environment",
|
|
448
|
+
"exclusive": [
|
|
449
|
+
"stage"
|
|
450
|
+
],
|
|
451
|
+
"helpGroup": "GLOBAL",
|
|
452
|
+
"name": "dev",
|
|
453
|
+
"allowNo": false,
|
|
454
|
+
"type": "boolean"
|
|
455
|
+
},
|
|
456
|
+
"stage": {
|
|
457
|
+
"description": "Target the stage environment",
|
|
458
|
+
"exclusive": [
|
|
459
|
+
"dev"
|
|
460
|
+
],
|
|
461
|
+
"helpGroup": "GLOBAL",
|
|
462
|
+
"name": "stage",
|
|
463
|
+
"allowNo": false,
|
|
464
|
+
"type": "boolean"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
"hasDynamicHelp": false,
|
|
468
|
+
"hiddenAliases": [],
|
|
469
|
+
"id": "commands:for-device",
|
|
470
|
+
"pluginAlias": "@formant/formant-cli",
|
|
471
|
+
"pluginName": "@formant/formant-cli",
|
|
472
|
+
"pluginType": "core",
|
|
473
|
+
"strict": true,
|
|
474
|
+
"summary": "List commands available for a device",
|
|
475
|
+
"enableJsonFlag": true,
|
|
476
|
+
"isESM": true,
|
|
477
|
+
"relativePath": [
|
|
478
|
+
"dist",
|
|
479
|
+
"commands",
|
|
480
|
+
"commands",
|
|
481
|
+
"for-device.js"
|
|
482
|
+
]
|
|
483
|
+
},
|
|
484
|
+
"commands:get": {
|
|
485
|
+
"aliases": [],
|
|
486
|
+
"args": {
|
|
487
|
+
"id": {
|
|
488
|
+
"description": "Command template ID (UUID)",
|
|
489
|
+
"name": "id",
|
|
490
|
+
"required": true
|
|
491
|
+
}
|
|
492
|
+
},
|
|
493
|
+
"description": "Get detailed information about a command template.\n\nShows the full template configuration including command string, parameter schema,\ndevice targeting filters, and delivery settings. If the template has structured\nparameters (schema), they are displayed in a readable format.",
|
|
494
|
+
"examples": [
|
|
495
|
+
"<%= config.bin %> commands get <template-id>",
|
|
496
|
+
"<%= config.bin %> commands get <template-id> --json"
|
|
497
|
+
],
|
|
498
|
+
"flags": {
|
|
499
|
+
"json": {
|
|
500
|
+
"description": "Format output as json.",
|
|
501
|
+
"helpGroup": "GLOBAL",
|
|
502
|
+
"name": "json",
|
|
503
|
+
"allowNo": false,
|
|
504
|
+
"type": "boolean"
|
|
505
|
+
},
|
|
506
|
+
"dev": {
|
|
507
|
+
"description": "Target the dev environment",
|
|
508
|
+
"exclusive": [
|
|
509
|
+
"stage"
|
|
510
|
+
],
|
|
511
|
+
"helpGroup": "GLOBAL",
|
|
512
|
+
"name": "dev",
|
|
513
|
+
"allowNo": false,
|
|
514
|
+
"type": "boolean"
|
|
515
|
+
},
|
|
516
|
+
"stage": {
|
|
517
|
+
"description": "Target the stage environment",
|
|
518
|
+
"exclusive": [
|
|
519
|
+
"dev"
|
|
520
|
+
],
|
|
521
|
+
"helpGroup": "GLOBAL",
|
|
522
|
+
"name": "stage",
|
|
523
|
+
"allowNo": false,
|
|
524
|
+
"type": "boolean"
|
|
525
|
+
}
|
|
526
|
+
},
|
|
527
|
+
"hasDynamicHelp": false,
|
|
528
|
+
"hiddenAliases": [],
|
|
529
|
+
"id": "commands:get",
|
|
530
|
+
"pluginAlias": "@formant/formant-cli",
|
|
531
|
+
"pluginName": "@formant/formant-cli",
|
|
532
|
+
"pluginType": "core",
|
|
533
|
+
"strict": true,
|
|
534
|
+
"summary": "Get command template details",
|
|
535
|
+
"enableJsonFlag": true,
|
|
536
|
+
"isESM": true,
|
|
537
|
+
"relativePath": [
|
|
538
|
+
"dist",
|
|
539
|
+
"commands",
|
|
540
|
+
"commands",
|
|
541
|
+
"get.js"
|
|
542
|
+
]
|
|
543
|
+
},
|
|
544
|
+
"commands:history": {
|
|
545
|
+
"aliases": [],
|
|
546
|
+
"args": {},
|
|
547
|
+
"description": "Query command history for a device.\n\nShows commands that have been sent to a device, including delivery status and responses.\nUse this to check if commands were delivered and executed successfully.",
|
|
548
|
+
"examples": [
|
|
549
|
+
"<%= config.bin %> commands history --device <device-id>",
|
|
550
|
+
"<%= config.bin %> commands history --device <device-id> --limit 50",
|
|
551
|
+
"<%= config.bin %> commands history --device <device-id> --json"
|
|
552
|
+
],
|
|
553
|
+
"flags": {
|
|
554
|
+
"json": {
|
|
555
|
+
"description": "Format output as json.",
|
|
556
|
+
"helpGroup": "GLOBAL",
|
|
557
|
+
"name": "json",
|
|
558
|
+
"allowNo": false,
|
|
559
|
+
"type": "boolean"
|
|
560
|
+
},
|
|
561
|
+
"dev": {
|
|
562
|
+
"description": "Target the dev environment",
|
|
563
|
+
"exclusive": [
|
|
564
|
+
"stage"
|
|
565
|
+
],
|
|
566
|
+
"helpGroup": "GLOBAL",
|
|
567
|
+
"name": "dev",
|
|
568
|
+
"allowNo": false,
|
|
569
|
+
"type": "boolean"
|
|
570
|
+
},
|
|
571
|
+
"stage": {
|
|
572
|
+
"description": "Target the stage environment",
|
|
573
|
+
"exclusive": [
|
|
574
|
+
"dev"
|
|
575
|
+
],
|
|
576
|
+
"helpGroup": "GLOBAL",
|
|
577
|
+
"name": "stage",
|
|
578
|
+
"allowNo": false,
|
|
579
|
+
"type": "boolean"
|
|
580
|
+
},
|
|
581
|
+
"device": {
|
|
582
|
+
"char": "d",
|
|
583
|
+
"description": "Device ID (UUID)",
|
|
584
|
+
"name": "device",
|
|
585
|
+
"required": true,
|
|
586
|
+
"hasDynamicHelp": false,
|
|
587
|
+
"multiple": false,
|
|
588
|
+
"type": "option"
|
|
589
|
+
},
|
|
590
|
+
"limit": {
|
|
591
|
+
"char": "l",
|
|
592
|
+
"description": "Maximum number of commands to return",
|
|
593
|
+
"name": "limit",
|
|
594
|
+
"default": 25,
|
|
595
|
+
"hasDynamicHelp": false,
|
|
596
|
+
"multiple": false,
|
|
597
|
+
"type": "option"
|
|
598
|
+
}
|
|
599
|
+
},
|
|
600
|
+
"hasDynamicHelp": false,
|
|
601
|
+
"hiddenAliases": [],
|
|
602
|
+
"id": "commands:history",
|
|
603
|
+
"pluginAlias": "@formant/formant-cli",
|
|
604
|
+
"pluginName": "@formant/formant-cli",
|
|
605
|
+
"pluginType": "core",
|
|
606
|
+
"strict": true,
|
|
607
|
+
"summary": "Query command history",
|
|
608
|
+
"enableJsonFlag": true,
|
|
609
|
+
"isESM": true,
|
|
610
|
+
"relativePath": [
|
|
611
|
+
"dist",
|
|
612
|
+
"commands",
|
|
613
|
+
"commands",
|
|
614
|
+
"history.js"
|
|
615
|
+
]
|
|
616
|
+
},
|
|
617
|
+
"commands:list": {
|
|
618
|
+
"aliases": [],
|
|
619
|
+
"args": {},
|
|
620
|
+
"description": "List all command templates defined in your organization.\n\nCommand templates define the commands that can be sent to devices. Each template\nspecifies the command string, parameters, delivery settings, and device targeting.",
|
|
621
|
+
"examples": [
|
|
622
|
+
"<%= config.bin %> commands list",
|
|
623
|
+
"<%= config.bin %> commands list --json"
|
|
624
|
+
],
|
|
625
|
+
"flags": {
|
|
626
|
+
"json": {
|
|
627
|
+
"description": "Format output as json.",
|
|
628
|
+
"helpGroup": "GLOBAL",
|
|
629
|
+
"name": "json",
|
|
630
|
+
"allowNo": false,
|
|
631
|
+
"type": "boolean"
|
|
632
|
+
},
|
|
633
|
+
"dev": {
|
|
634
|
+
"description": "Target the dev environment",
|
|
635
|
+
"exclusive": [
|
|
636
|
+
"stage"
|
|
637
|
+
],
|
|
638
|
+
"helpGroup": "GLOBAL",
|
|
639
|
+
"name": "dev",
|
|
640
|
+
"allowNo": false,
|
|
641
|
+
"type": "boolean"
|
|
642
|
+
},
|
|
643
|
+
"stage": {
|
|
644
|
+
"description": "Target the stage environment",
|
|
645
|
+
"exclusive": [
|
|
646
|
+
"dev"
|
|
647
|
+
],
|
|
648
|
+
"helpGroup": "GLOBAL",
|
|
649
|
+
"name": "stage",
|
|
650
|
+
"allowNo": false,
|
|
651
|
+
"type": "boolean"
|
|
652
|
+
}
|
|
653
|
+
},
|
|
654
|
+
"hasDynamicHelp": false,
|
|
655
|
+
"hiddenAliases": [],
|
|
656
|
+
"id": "commands:list",
|
|
657
|
+
"pluginAlias": "@formant/formant-cli",
|
|
658
|
+
"pluginName": "@formant/formant-cli",
|
|
659
|
+
"pluginType": "core",
|
|
660
|
+
"strict": true,
|
|
661
|
+
"summary": "List command templates",
|
|
662
|
+
"enableJsonFlag": true,
|
|
663
|
+
"isESM": true,
|
|
664
|
+
"relativePath": [
|
|
665
|
+
"dist",
|
|
666
|
+
"commands",
|
|
667
|
+
"commands",
|
|
668
|
+
"list.js"
|
|
669
|
+
]
|
|
670
|
+
},
|
|
671
|
+
"commands:send": {
|
|
672
|
+
"aliases": [],
|
|
673
|
+
"args": {
|
|
674
|
+
"deviceId": {
|
|
675
|
+
"description": "Device ID (UUID)",
|
|
676
|
+
"name": "deviceId",
|
|
677
|
+
"required": true
|
|
678
|
+
},
|
|
679
|
+
"templateId": {
|
|
680
|
+
"description": "Command template ID (UUID)",
|
|
681
|
+
"name": "templateId",
|
|
682
|
+
"required": true
|
|
683
|
+
}
|
|
684
|
+
},
|
|
685
|
+
"description": "Send a command to a device using a command template.\n\nFetches the template, validates parameters against its schema, and sends the command\nto the specified device. Use --param flags to override parameter values.\n\nFor templates with structured parameters (schema), parameter names and types are\nvalidated. For unstructured parameters, the raw value is sent as-is.\n\nUse --dry-run to preview the payload without actually sending.",
|
|
686
|
+
"examples": [
|
|
687
|
+
"<%= config.bin %> commands send <device-id> <template-id>",
|
|
688
|
+
"<%= config.bin %> commands send <device-id> <template-id> --param speed=5 --param mode=fast",
|
|
689
|
+
"<%= config.bin %> commands send <device-id> <template-id> --dry-run",
|
|
690
|
+
"<%= config.bin %> commands send <device-id> <template-id> --raw-value '{\"x\":1,\"y\":2}'",
|
|
691
|
+
"<%= config.bin %> commands send <device-id> <template-id> --json"
|
|
692
|
+
],
|
|
693
|
+
"flags": {
|
|
694
|
+
"json": {
|
|
695
|
+
"description": "Format output as json.",
|
|
696
|
+
"helpGroup": "GLOBAL",
|
|
697
|
+
"name": "json",
|
|
698
|
+
"allowNo": false,
|
|
699
|
+
"type": "boolean"
|
|
700
|
+
},
|
|
701
|
+
"dev": {
|
|
702
|
+
"description": "Target the dev environment",
|
|
703
|
+
"exclusive": [
|
|
704
|
+
"stage"
|
|
705
|
+
],
|
|
706
|
+
"helpGroup": "GLOBAL",
|
|
707
|
+
"name": "dev",
|
|
708
|
+
"allowNo": false,
|
|
709
|
+
"type": "boolean"
|
|
710
|
+
},
|
|
711
|
+
"stage": {
|
|
712
|
+
"description": "Target the stage environment",
|
|
713
|
+
"exclusive": [
|
|
714
|
+
"dev"
|
|
715
|
+
],
|
|
716
|
+
"helpGroup": "GLOBAL",
|
|
717
|
+
"name": "stage",
|
|
718
|
+
"allowNo": false,
|
|
719
|
+
"type": "boolean"
|
|
720
|
+
},
|
|
721
|
+
"dry-run": {
|
|
722
|
+
"description": "Preview the command payload without sending",
|
|
723
|
+
"name": "dry-run",
|
|
724
|
+
"allowNo": false,
|
|
725
|
+
"type": "boolean"
|
|
726
|
+
},
|
|
727
|
+
"param": {
|
|
728
|
+
"char": "p",
|
|
729
|
+
"description": "Parameter override (name=value), can be specified multiple times",
|
|
730
|
+
"name": "param",
|
|
731
|
+
"hasDynamicHelp": false,
|
|
732
|
+
"multiple": true,
|
|
733
|
+
"type": "option"
|
|
734
|
+
},
|
|
735
|
+
"raw-value": {
|
|
736
|
+
"description": "Send a raw parameter value string (bypasses schema validation)",
|
|
737
|
+
"name": "raw-value",
|
|
738
|
+
"hasDynamicHelp": false,
|
|
739
|
+
"multiple": false,
|
|
740
|
+
"type": "option"
|
|
741
|
+
}
|
|
742
|
+
},
|
|
743
|
+
"hasDynamicHelp": false,
|
|
744
|
+
"hiddenAliases": [],
|
|
745
|
+
"id": "commands:send",
|
|
746
|
+
"pluginAlias": "@formant/formant-cli",
|
|
747
|
+
"pluginName": "@formant/formant-cli",
|
|
748
|
+
"pluginType": "core",
|
|
749
|
+
"strict": true,
|
|
750
|
+
"summary": "Send a command to a device",
|
|
751
|
+
"enableJsonFlag": true,
|
|
752
|
+
"isESM": true,
|
|
753
|
+
"relativePath": [
|
|
754
|
+
"dist",
|
|
755
|
+
"commands",
|
|
756
|
+
"commands",
|
|
757
|
+
"send.js"
|
|
758
|
+
]
|
|
759
|
+
},
|
|
760
|
+
"fleets:get": {
|
|
761
|
+
"aliases": [],
|
|
762
|
+
"args": {
|
|
763
|
+
"id": {
|
|
764
|
+
"description": "Fleet (group) ID (UUID)",
|
|
765
|
+
"name": "id",
|
|
766
|
+
"required": true
|
|
767
|
+
}
|
|
768
|
+
},
|
|
769
|
+
"description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.",
|
|
770
|
+
"examples": [
|
|
771
|
+
"<%= config.bin %> fleets get <fleet-id>",
|
|
772
|
+
"<%= config.bin %> fleets get <fleet-id> --json"
|
|
773
|
+
],
|
|
774
|
+
"flags": {
|
|
775
|
+
"json": {
|
|
776
|
+
"description": "Format output as json.",
|
|
777
|
+
"helpGroup": "GLOBAL",
|
|
778
|
+
"name": "json",
|
|
779
|
+
"allowNo": false,
|
|
780
|
+
"type": "boolean"
|
|
781
|
+
},
|
|
782
|
+
"dev": {
|
|
783
|
+
"description": "Target the dev environment",
|
|
784
|
+
"exclusive": [
|
|
785
|
+
"stage"
|
|
786
|
+
],
|
|
787
|
+
"helpGroup": "GLOBAL",
|
|
788
|
+
"name": "dev",
|
|
789
|
+
"allowNo": false,
|
|
790
|
+
"type": "boolean"
|
|
791
|
+
},
|
|
792
|
+
"stage": {
|
|
793
|
+
"description": "Target the stage environment",
|
|
794
|
+
"exclusive": [
|
|
795
|
+
"dev"
|
|
796
|
+
],
|
|
797
|
+
"helpGroup": "GLOBAL",
|
|
798
|
+
"name": "stage",
|
|
799
|
+
"allowNo": false,
|
|
800
|
+
"type": "boolean"
|
|
801
|
+
}
|
|
802
|
+
},
|
|
803
|
+
"hasDynamicHelp": false,
|
|
804
|
+
"hiddenAliases": [],
|
|
805
|
+
"id": "fleets:get",
|
|
806
|
+
"pluginAlias": "@formant/formant-cli",
|
|
807
|
+
"pluginName": "@formant/formant-cli",
|
|
808
|
+
"pluginType": "core",
|
|
809
|
+
"strict": true,
|
|
810
|
+
"summary": "Get fleet details",
|
|
811
|
+
"enableJsonFlag": true,
|
|
812
|
+
"isESM": true,
|
|
813
|
+
"relativePath": [
|
|
814
|
+
"dist",
|
|
815
|
+
"commands",
|
|
816
|
+
"fleets",
|
|
817
|
+
"get.js"
|
|
818
|
+
]
|
|
819
|
+
},
|
|
820
|
+
"fleets:list": {
|
|
821
|
+
"aliases": [],
|
|
822
|
+
"args": {},
|
|
823
|
+
"description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.",
|
|
824
|
+
"examples": [
|
|
825
|
+
"<%= config.bin %> fleets list",
|
|
826
|
+
"<%= config.bin %> fleets list --json"
|
|
827
|
+
],
|
|
828
|
+
"flags": {
|
|
829
|
+
"json": {
|
|
830
|
+
"description": "Format output as json.",
|
|
831
|
+
"helpGroup": "GLOBAL",
|
|
832
|
+
"name": "json",
|
|
833
|
+
"allowNo": false,
|
|
834
|
+
"type": "boolean"
|
|
835
|
+
},
|
|
836
|
+
"dev": {
|
|
837
|
+
"description": "Target the dev environment",
|
|
838
|
+
"exclusive": [
|
|
839
|
+
"stage"
|
|
840
|
+
],
|
|
841
|
+
"helpGroup": "GLOBAL",
|
|
842
|
+
"name": "dev",
|
|
843
|
+
"allowNo": false,
|
|
844
|
+
"type": "boolean"
|
|
845
|
+
},
|
|
846
|
+
"stage": {
|
|
847
|
+
"description": "Target the stage environment",
|
|
848
|
+
"exclusive": [
|
|
849
|
+
"dev"
|
|
850
|
+
],
|
|
851
|
+
"helpGroup": "GLOBAL",
|
|
852
|
+
"name": "stage",
|
|
853
|
+
"allowNo": false,
|
|
854
|
+
"type": "boolean"
|
|
855
|
+
}
|
|
856
|
+
},
|
|
857
|
+
"hasDynamicHelp": false,
|
|
858
|
+
"hiddenAliases": [],
|
|
859
|
+
"id": "fleets:list",
|
|
860
|
+
"pluginAlias": "@formant/formant-cli",
|
|
861
|
+
"pluginName": "@formant/formant-cli",
|
|
862
|
+
"pluginType": "core",
|
|
863
|
+
"strict": true,
|
|
864
|
+
"summary": "List device groups",
|
|
865
|
+
"enableJsonFlag": true,
|
|
866
|
+
"isESM": true,
|
|
867
|
+
"relativePath": [
|
|
868
|
+
"dist",
|
|
869
|
+
"commands",
|
|
870
|
+
"fleets",
|
|
871
|
+
"list.js"
|
|
872
|
+
]
|
|
873
|
+
},
|
|
874
|
+
"kv:get": {
|
|
875
|
+
"aliases": [],
|
|
876
|
+
"args": {
|
|
877
|
+
"key": {
|
|
878
|
+
"description": "Key to retrieve",
|
|
879
|
+
"name": "key",
|
|
880
|
+
"required": true
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.",
|
|
884
|
+
"examples": [
|
|
885
|
+
"<%= config.bin %> kv get my-key",
|
|
886
|
+
"<%= config.bin %> kv get my-key --json"
|
|
887
|
+
],
|
|
888
|
+
"flags": {
|
|
889
|
+
"json": {
|
|
890
|
+
"description": "Format output as json.",
|
|
891
|
+
"helpGroup": "GLOBAL",
|
|
892
|
+
"name": "json",
|
|
893
|
+
"allowNo": false,
|
|
894
|
+
"type": "boolean"
|
|
895
|
+
},
|
|
896
|
+
"dev": {
|
|
897
|
+
"description": "Target the dev environment",
|
|
898
|
+
"exclusive": [
|
|
899
|
+
"stage"
|
|
900
|
+
],
|
|
901
|
+
"helpGroup": "GLOBAL",
|
|
902
|
+
"name": "dev",
|
|
903
|
+
"allowNo": false,
|
|
904
|
+
"type": "boolean"
|
|
905
|
+
},
|
|
906
|
+
"stage": {
|
|
907
|
+
"description": "Target the stage environment",
|
|
908
|
+
"exclusive": [
|
|
909
|
+
"dev"
|
|
910
|
+
],
|
|
911
|
+
"helpGroup": "GLOBAL",
|
|
912
|
+
"name": "stage",
|
|
913
|
+
"allowNo": false,
|
|
914
|
+
"type": "boolean"
|
|
915
|
+
}
|
|
916
|
+
},
|
|
917
|
+
"hasDynamicHelp": false,
|
|
918
|
+
"hiddenAliases": [],
|
|
919
|
+
"id": "kv:get",
|
|
920
|
+
"pluginAlias": "@formant/formant-cli",
|
|
921
|
+
"pluginName": "@formant/formant-cli",
|
|
922
|
+
"pluginType": "core",
|
|
923
|
+
"strict": true,
|
|
924
|
+
"summary": "Get key-value",
|
|
925
|
+
"enableJsonFlag": true,
|
|
926
|
+
"isESM": true,
|
|
927
|
+
"relativePath": [
|
|
928
|
+
"dist",
|
|
929
|
+
"commands",
|
|
930
|
+
"kv",
|
|
931
|
+
"get.js"
|
|
932
|
+
]
|
|
933
|
+
},
|
|
934
|
+
"kv:list": {
|
|
935
|
+
"aliases": [],
|
|
936
|
+
"args": {},
|
|
937
|
+
"description": "List all keys in the key-value store.\n\nShows all stored keys in the organization's key-value store. Use --prefix to filter\nkeys that start with a specific prefix, or --keys to query specific keys.",
|
|
938
|
+
"examples": [
|
|
939
|
+
"<%= config.bin %> kv list",
|
|
940
|
+
"<%= config.bin %> kv list --prefix config",
|
|
941
|
+
"<%= config.bin %> kv list --keys key1 --keys key2 --keys key3",
|
|
942
|
+
"<%= config.bin %> kv list --json"
|
|
943
|
+
],
|
|
944
|
+
"flags": {
|
|
945
|
+
"json": {
|
|
946
|
+
"description": "Format output as json.",
|
|
947
|
+
"helpGroup": "GLOBAL",
|
|
948
|
+
"name": "json",
|
|
949
|
+
"allowNo": false,
|
|
950
|
+
"type": "boolean"
|
|
951
|
+
},
|
|
952
|
+
"dev": {
|
|
953
|
+
"description": "Target the dev environment",
|
|
954
|
+
"exclusive": [
|
|
955
|
+
"stage"
|
|
956
|
+
],
|
|
957
|
+
"helpGroup": "GLOBAL",
|
|
958
|
+
"name": "dev",
|
|
959
|
+
"allowNo": false,
|
|
960
|
+
"type": "boolean"
|
|
961
|
+
},
|
|
962
|
+
"stage": {
|
|
963
|
+
"description": "Target the stage environment",
|
|
964
|
+
"exclusive": [
|
|
965
|
+
"dev"
|
|
966
|
+
],
|
|
967
|
+
"helpGroup": "GLOBAL",
|
|
968
|
+
"name": "stage",
|
|
969
|
+
"allowNo": false,
|
|
970
|
+
"type": "boolean"
|
|
971
|
+
},
|
|
972
|
+
"keys": {
|
|
973
|
+
"char": "k",
|
|
974
|
+
"description": "Specific keys to query (can be specified multiple times)",
|
|
975
|
+
"name": "keys",
|
|
976
|
+
"hasDynamicHelp": false,
|
|
977
|
+
"multiple": true,
|
|
978
|
+
"type": "option"
|
|
979
|
+
},
|
|
980
|
+
"prefix": {
|
|
981
|
+
"char": "p",
|
|
982
|
+
"description": "Filter keys by prefix",
|
|
983
|
+
"name": "prefix",
|
|
984
|
+
"hasDynamicHelp": false,
|
|
985
|
+
"multiple": false,
|
|
986
|
+
"type": "option"
|
|
987
|
+
}
|
|
988
|
+
},
|
|
989
|
+
"hasDynamicHelp": false,
|
|
990
|
+
"hiddenAliases": [],
|
|
991
|
+
"id": "kv:list",
|
|
992
|
+
"pluginAlias": "@formant/formant-cli",
|
|
993
|
+
"pluginName": "@formant/formant-cli",
|
|
994
|
+
"pluginType": "core",
|
|
995
|
+
"strict": true,
|
|
996
|
+
"summary": "List key-value keys",
|
|
997
|
+
"enableJsonFlag": true,
|
|
998
|
+
"isESM": true,
|
|
999
|
+
"relativePath": [
|
|
1000
|
+
"dist",
|
|
1001
|
+
"commands",
|
|
1002
|
+
"kv",
|
|
1003
|
+
"list.js"
|
|
1004
|
+
]
|
|
1005
|
+
},
|
|
1006
|
+
"kv:set": {
|
|
1007
|
+
"aliases": [],
|
|
1008
|
+
"args": {
|
|
1009
|
+
"key": {
|
|
1010
|
+
"description": "Key to set",
|
|
1011
|
+
"name": "key",
|
|
1012
|
+
"required": true
|
|
1013
|
+
},
|
|
1014
|
+
"value": {
|
|
1015
|
+
"description": "Value to store (JSON string)",
|
|
1016
|
+
"name": "value",
|
|
1017
|
+
"required": true
|
|
1018
|
+
}
|
|
1019
|
+
},
|
|
1020
|
+
"description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.",
|
|
1021
|
+
"examples": [
|
|
1022
|
+
"<%= config.bin %> kv set my-key '{\"data\": \"value\"}'",
|
|
1023
|
+
"<%= config.bin %> kv set config '{\"setting\": true}'"
|
|
1024
|
+
],
|
|
1025
|
+
"flags": {
|
|
1026
|
+
"json": {
|
|
1027
|
+
"description": "Format output as json.",
|
|
1028
|
+
"helpGroup": "GLOBAL",
|
|
1029
|
+
"name": "json",
|
|
1030
|
+
"allowNo": false,
|
|
1031
|
+
"type": "boolean"
|
|
1032
|
+
},
|
|
1033
|
+
"dev": {
|
|
1034
|
+
"description": "Target the dev environment",
|
|
1035
|
+
"exclusive": [
|
|
1036
|
+
"stage"
|
|
1037
|
+
],
|
|
1038
|
+
"helpGroup": "GLOBAL",
|
|
1039
|
+
"name": "dev",
|
|
1040
|
+
"allowNo": false,
|
|
1041
|
+
"type": "boolean"
|
|
1042
|
+
},
|
|
1043
|
+
"stage": {
|
|
1044
|
+
"description": "Target the stage environment",
|
|
1045
|
+
"exclusive": [
|
|
1046
|
+
"dev"
|
|
1047
|
+
],
|
|
1048
|
+
"helpGroup": "GLOBAL",
|
|
1049
|
+
"name": "stage",
|
|
1050
|
+
"allowNo": false,
|
|
1051
|
+
"type": "boolean"
|
|
1052
|
+
}
|
|
1053
|
+
},
|
|
1054
|
+
"hasDynamicHelp": false,
|
|
1055
|
+
"hiddenAliases": [],
|
|
1056
|
+
"id": "kv:set",
|
|
1057
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1058
|
+
"pluginName": "@formant/formant-cli",
|
|
1059
|
+
"pluginType": "core",
|
|
1060
|
+
"strict": true,
|
|
1061
|
+
"summary": "Set key-value",
|
|
1062
|
+
"enableJsonFlag": true,
|
|
1063
|
+
"isESM": true,
|
|
1064
|
+
"relativePath": [
|
|
1065
|
+
"dist",
|
|
1066
|
+
"commands",
|
|
1067
|
+
"kv",
|
|
1068
|
+
"set.js"
|
|
1069
|
+
]
|
|
1070
|
+
},
|
|
1071
|
+
"query": {
|
|
1072
|
+
"aliases": [],
|
|
1073
|
+
"args": {},
|
|
1074
|
+
"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.",
|
|
1075
|
+
"examples": [
|
|
1076
|
+
"<%= config.bin %> query --device <id> --stream battery_level --start 2026-01-01 --end 2026-01-02",
|
|
1077
|
+
"<%= config.bin %> query --device <id> --stream speed --aggregate hour --start 2026-01-01 --end 2026-02-01",
|
|
1078
|
+
"<%= config.bin %> query --device <id> --stream battery_level --latest",
|
|
1079
|
+
"<%= config.bin %> query --device <id> --stream temperature --type numeric --json"
|
|
1080
|
+
],
|
|
1081
|
+
"flags": {
|
|
1082
|
+
"json": {
|
|
1083
|
+
"description": "Format output as json.",
|
|
1084
|
+
"helpGroup": "GLOBAL",
|
|
1085
|
+
"name": "json",
|
|
1086
|
+
"allowNo": false,
|
|
1087
|
+
"type": "boolean"
|
|
1088
|
+
},
|
|
1089
|
+
"dev": {
|
|
1090
|
+
"description": "Target the dev environment",
|
|
1091
|
+
"exclusive": [
|
|
1092
|
+
"stage"
|
|
1093
|
+
],
|
|
1094
|
+
"helpGroup": "GLOBAL",
|
|
1095
|
+
"name": "dev",
|
|
1096
|
+
"allowNo": false,
|
|
1097
|
+
"type": "boolean"
|
|
1098
|
+
},
|
|
1099
|
+
"stage": {
|
|
1100
|
+
"description": "Target the stage environment",
|
|
1101
|
+
"exclusive": [
|
|
1102
|
+
"dev"
|
|
1103
|
+
],
|
|
1104
|
+
"helpGroup": "GLOBAL",
|
|
1105
|
+
"name": "stage",
|
|
1106
|
+
"allowNo": false,
|
|
1107
|
+
"type": "boolean"
|
|
1108
|
+
},
|
|
1109
|
+
"aggregate": {
|
|
1110
|
+
"char": "a",
|
|
1111
|
+
"description": "Aggregation level for downsampling",
|
|
1112
|
+
"name": "aggregate",
|
|
1113
|
+
"hasDynamicHelp": false,
|
|
1114
|
+
"multiple": false,
|
|
1115
|
+
"type": "option"
|
|
1116
|
+
},
|
|
1117
|
+
"device": {
|
|
1118
|
+
"char": "d",
|
|
1119
|
+
"description": "Device ID (UUID)",
|
|
1120
|
+
"name": "device",
|
|
1121
|
+
"required": true,
|
|
1122
|
+
"hasDynamicHelp": false,
|
|
1123
|
+
"multiple": false,
|
|
1124
|
+
"type": "option"
|
|
1125
|
+
},
|
|
1126
|
+
"end": {
|
|
1127
|
+
"description": "End time (ISO 8601)",
|
|
1128
|
+
"name": "end",
|
|
1129
|
+
"hasDynamicHelp": false,
|
|
1130
|
+
"multiple": false,
|
|
1131
|
+
"type": "option"
|
|
1132
|
+
},
|
|
1133
|
+
"latest": {
|
|
1134
|
+
"description": "Only return the most recent value per stream",
|
|
1135
|
+
"name": "latest",
|
|
1136
|
+
"allowNo": false,
|
|
1137
|
+
"type": "boolean"
|
|
1138
|
+
},
|
|
1139
|
+
"limit": {
|
|
1140
|
+
"char": "l",
|
|
1141
|
+
"description": "Maximum number of datapoints",
|
|
1142
|
+
"name": "limit",
|
|
1143
|
+
"hasDynamicHelp": false,
|
|
1144
|
+
"multiple": false,
|
|
1145
|
+
"type": "option"
|
|
1146
|
+
},
|
|
1147
|
+
"start": {
|
|
1148
|
+
"description": "Start time (ISO 8601)",
|
|
1149
|
+
"name": "start",
|
|
1150
|
+
"hasDynamicHelp": false,
|
|
1151
|
+
"multiple": false,
|
|
1152
|
+
"type": "option"
|
|
1153
|
+
},
|
|
1154
|
+
"stream": {
|
|
1155
|
+
"char": "s",
|
|
1156
|
+
"description": "Stream name(s), can be specified multiple times",
|
|
1157
|
+
"name": "stream",
|
|
1158
|
+
"required": true,
|
|
1159
|
+
"hasDynamicHelp": false,
|
|
1160
|
+
"multiple": true,
|
|
1161
|
+
"type": "option"
|
|
1162
|
+
},
|
|
1163
|
+
"type": {
|
|
1164
|
+
"description": "Filter by stream type",
|
|
1165
|
+
"name": "type",
|
|
1166
|
+
"hasDynamicHelp": false,
|
|
1167
|
+
"multiple": false,
|
|
1168
|
+
"type": "option"
|
|
1169
|
+
}
|
|
1170
|
+
},
|
|
1171
|
+
"hasDynamicHelp": false,
|
|
1172
|
+
"hiddenAliases": [],
|
|
1173
|
+
"id": "query",
|
|
1174
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1175
|
+
"pluginName": "@formant/formant-cli",
|
|
1176
|
+
"pluginType": "core",
|
|
1177
|
+
"strict": true,
|
|
1178
|
+
"summary": "Query telemetry stream data",
|
|
1179
|
+
"enableJsonFlag": true,
|
|
1180
|
+
"isESM": true,
|
|
1181
|
+
"relativePath": [
|
|
1182
|
+
"dist",
|
|
1183
|
+
"commands",
|
|
1184
|
+
"query",
|
|
1185
|
+
"index.js"
|
|
1186
|
+
]
|
|
1187
|
+
},
|
|
1188
|
+
"query:latest-values": {
|
|
1189
|
+
"aliases": [],
|
|
1190
|
+
"args": {},
|
|
1191
|
+
"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\nconfigured streams from the device configuration.",
|
|
1192
|
+
"examples": [
|
|
1193
|
+
"<%= config.bin %> query latest-values --device <id> --stream battery_level",
|
|
1194
|
+
"<%= config.bin %> query latest-values --device <id> --stream temperature --stream humidity",
|
|
1195
|
+
"<%= config.bin %> query latest-values --device <id> --all-streams",
|
|
1196
|
+
"<%= config.bin %> query latest-values --device <id> --all-streams --json"
|
|
1197
|
+
],
|
|
1198
|
+
"flags": {
|
|
1199
|
+
"json": {
|
|
1200
|
+
"description": "Format output as json.",
|
|
1201
|
+
"helpGroup": "GLOBAL",
|
|
1202
|
+
"name": "json",
|
|
1203
|
+
"allowNo": false,
|
|
1204
|
+
"type": "boolean"
|
|
1205
|
+
},
|
|
1206
|
+
"dev": {
|
|
1207
|
+
"description": "Target the dev environment",
|
|
1208
|
+
"exclusive": [
|
|
1209
|
+
"stage"
|
|
1210
|
+
],
|
|
1211
|
+
"helpGroup": "GLOBAL",
|
|
1212
|
+
"name": "dev",
|
|
1213
|
+
"allowNo": false,
|
|
1214
|
+
"type": "boolean"
|
|
1215
|
+
},
|
|
1216
|
+
"stage": {
|
|
1217
|
+
"description": "Target the stage environment",
|
|
1218
|
+
"exclusive": [
|
|
1219
|
+
"dev"
|
|
1220
|
+
],
|
|
1221
|
+
"helpGroup": "GLOBAL",
|
|
1222
|
+
"name": "stage",
|
|
1223
|
+
"allowNo": false,
|
|
1224
|
+
"type": "boolean"
|
|
1225
|
+
},
|
|
1226
|
+
"all-streams": {
|
|
1227
|
+
"description": "Query all configured streams for the device (requires single --device)",
|
|
1228
|
+
"name": "all-streams",
|
|
1229
|
+
"allowNo": false,
|
|
1230
|
+
"type": "boolean"
|
|
1231
|
+
},
|
|
1232
|
+
"device": {
|
|
1233
|
+
"char": "d",
|
|
1234
|
+
"description": "Device ID (UUID)",
|
|
1235
|
+
"name": "device",
|
|
1236
|
+
"required": true,
|
|
1237
|
+
"hasDynamicHelp": false,
|
|
1238
|
+
"multiple": true,
|
|
1239
|
+
"type": "option"
|
|
1240
|
+
},
|
|
1241
|
+
"stream": {
|
|
1242
|
+
"char": "s",
|
|
1243
|
+
"description": "Stream name(s), can be specified multiple times",
|
|
1244
|
+
"name": "stream",
|
|
1245
|
+
"hasDynamicHelp": false,
|
|
1246
|
+
"multiple": true,
|
|
1247
|
+
"type": "option"
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
"hasDynamicHelp": false,
|
|
1251
|
+
"hiddenAliases": [],
|
|
1252
|
+
"id": "query:latest-values",
|
|
1253
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1254
|
+
"pluginName": "@formant/formant-cli",
|
|
1255
|
+
"pluginType": "core",
|
|
1256
|
+
"strict": true,
|
|
1257
|
+
"summary": "Get latest stream values",
|
|
1258
|
+
"enableJsonFlag": true,
|
|
1259
|
+
"isESM": true,
|
|
1260
|
+
"relativePath": [
|
|
1261
|
+
"dist",
|
|
1262
|
+
"commands",
|
|
1263
|
+
"query",
|
|
1264
|
+
"latest-values.js"
|
|
1265
|
+
]
|
|
1266
|
+
},
|
|
1267
|
+
"devices:config": {
|
|
1268
|
+
"aliases": [],
|
|
1269
|
+
"args": {
|
|
1270
|
+
"id": {
|
|
1271
|
+
"description": "Device ID (UUID)",
|
|
1272
|
+
"name": "id",
|
|
1273
|
+
"required": true
|
|
1274
|
+
}
|
|
1275
|
+
},
|
|
1276
|
+
"description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.",
|
|
1277
|
+
"examples": [
|
|
1278
|
+
"<%= config.bin %> devices config <device-id>",
|
|
1279
|
+
"<%= config.bin %> devices config <device-id> --json"
|
|
1280
|
+
],
|
|
1281
|
+
"flags": {
|
|
1282
|
+
"json": {
|
|
1283
|
+
"description": "Format output as json.",
|
|
1284
|
+
"helpGroup": "GLOBAL",
|
|
1285
|
+
"name": "json",
|
|
1286
|
+
"allowNo": false,
|
|
1287
|
+
"type": "boolean"
|
|
1288
|
+
},
|
|
1289
|
+
"dev": {
|
|
1290
|
+
"description": "Target the dev environment",
|
|
1291
|
+
"exclusive": [
|
|
1292
|
+
"stage"
|
|
1293
|
+
],
|
|
1294
|
+
"helpGroup": "GLOBAL",
|
|
1295
|
+
"name": "dev",
|
|
1296
|
+
"allowNo": false,
|
|
1297
|
+
"type": "boolean"
|
|
1298
|
+
},
|
|
1299
|
+
"stage": {
|
|
1300
|
+
"description": "Target the stage environment",
|
|
1301
|
+
"exclusive": [
|
|
1302
|
+
"dev"
|
|
1303
|
+
],
|
|
1304
|
+
"helpGroup": "GLOBAL",
|
|
1305
|
+
"name": "stage",
|
|
1306
|
+
"allowNo": false,
|
|
1307
|
+
"type": "boolean"
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
"hasDynamicHelp": false,
|
|
1311
|
+
"hiddenAliases": [],
|
|
1312
|
+
"id": "devices:config",
|
|
1313
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1314
|
+
"pluginName": "@formant/formant-cli",
|
|
1315
|
+
"pluginType": "core",
|
|
1316
|
+
"strict": true,
|
|
1317
|
+
"summary": "Get device configuration",
|
|
1318
|
+
"enableJsonFlag": true,
|
|
1319
|
+
"isESM": true,
|
|
1320
|
+
"relativePath": [
|
|
1321
|
+
"dist",
|
|
1322
|
+
"commands",
|
|
1323
|
+
"devices",
|
|
1324
|
+
"config.js"
|
|
1325
|
+
]
|
|
1326
|
+
},
|
|
1327
|
+
"devices:get": {
|
|
1328
|
+
"aliases": [],
|
|
1329
|
+
"args": {
|
|
1330
|
+
"id": {
|
|
1331
|
+
"description": "Device ID (UUID)",
|
|
1332
|
+
"name": "id",
|
|
1333
|
+
"required": true
|
|
1334
|
+
}
|
|
1335
|
+
},
|
|
1336
|
+
"description": "Get detailed information about a specific device by its ID.",
|
|
1337
|
+
"examples": [
|
|
1338
|
+
"<%= config.bin %> devices get <device-id>",
|
|
1339
|
+
"<%= config.bin %> devices get <device-id> --json"
|
|
1340
|
+
],
|
|
1341
|
+
"flags": {
|
|
1342
|
+
"json": {
|
|
1343
|
+
"description": "Format output as json.",
|
|
1344
|
+
"helpGroup": "GLOBAL",
|
|
1345
|
+
"name": "json",
|
|
1346
|
+
"allowNo": false,
|
|
1347
|
+
"type": "boolean"
|
|
1348
|
+
},
|
|
1349
|
+
"dev": {
|
|
1350
|
+
"description": "Target the dev environment",
|
|
1351
|
+
"exclusive": [
|
|
1352
|
+
"stage"
|
|
1353
|
+
],
|
|
1354
|
+
"helpGroup": "GLOBAL",
|
|
1355
|
+
"name": "dev",
|
|
1356
|
+
"allowNo": false,
|
|
1357
|
+
"type": "boolean"
|
|
1358
|
+
},
|
|
1359
|
+
"stage": {
|
|
1360
|
+
"description": "Target the stage environment",
|
|
1361
|
+
"exclusive": [
|
|
1362
|
+
"dev"
|
|
1363
|
+
],
|
|
1364
|
+
"helpGroup": "GLOBAL",
|
|
1365
|
+
"name": "stage",
|
|
1366
|
+
"allowNo": false,
|
|
1367
|
+
"type": "boolean"
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"hasDynamicHelp": false,
|
|
1371
|
+
"hiddenAliases": [],
|
|
1372
|
+
"id": "devices:get",
|
|
1373
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1374
|
+
"pluginName": "@formant/formant-cli",
|
|
1375
|
+
"pluginType": "core",
|
|
1376
|
+
"strict": true,
|
|
1377
|
+
"summary": "Get a device by ID",
|
|
1378
|
+
"enableJsonFlag": true,
|
|
1379
|
+
"isESM": true,
|
|
1380
|
+
"relativePath": [
|
|
1381
|
+
"dist",
|
|
1382
|
+
"commands",
|
|
1383
|
+
"devices",
|
|
1384
|
+
"get.js"
|
|
1385
|
+
]
|
|
1386
|
+
},
|
|
1387
|
+
"devices:last-seen": {
|
|
1388
|
+
"aliases": [],
|
|
1389
|
+
"args": {
|
|
1390
|
+
"id": {
|
|
1391
|
+
"description": "Device ID (UUID)",
|
|
1392
|
+
"name": "id",
|
|
1393
|
+
"required": true
|
|
1394
|
+
}
|
|
1395
|
+
},
|
|
1396
|
+
"description": "Get when a device was last seen online.\n\nShows the most recent timestamp when the device was detected as online.",
|
|
1397
|
+
"examples": [
|
|
1398
|
+
"<%= config.bin %> devices last-seen <device-id>",
|
|
1399
|
+
"<%= config.bin %> devices last-seen <device-id> --json"
|
|
1400
|
+
],
|
|
1401
|
+
"flags": {
|
|
1402
|
+
"json": {
|
|
1403
|
+
"description": "Format output as json.",
|
|
1404
|
+
"helpGroup": "GLOBAL",
|
|
1405
|
+
"name": "json",
|
|
1406
|
+
"allowNo": false,
|
|
1407
|
+
"type": "boolean"
|
|
1408
|
+
},
|
|
1409
|
+
"dev": {
|
|
1410
|
+
"description": "Target the dev environment",
|
|
1411
|
+
"exclusive": [
|
|
1412
|
+
"stage"
|
|
1413
|
+
],
|
|
1414
|
+
"helpGroup": "GLOBAL",
|
|
1415
|
+
"name": "dev",
|
|
1416
|
+
"allowNo": false,
|
|
1417
|
+
"type": "boolean"
|
|
1418
|
+
},
|
|
1419
|
+
"stage": {
|
|
1420
|
+
"description": "Target the stage environment",
|
|
1421
|
+
"exclusive": [
|
|
1422
|
+
"dev"
|
|
1423
|
+
],
|
|
1424
|
+
"helpGroup": "GLOBAL",
|
|
1425
|
+
"name": "stage",
|
|
1426
|
+
"allowNo": false,
|
|
1427
|
+
"type": "boolean"
|
|
1428
|
+
}
|
|
1429
|
+
},
|
|
1430
|
+
"hasDynamicHelp": false,
|
|
1431
|
+
"hiddenAliases": [],
|
|
1432
|
+
"id": "devices:last-seen",
|
|
1433
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1434
|
+
"pluginName": "@formant/formant-cli",
|
|
1435
|
+
"pluginType": "core",
|
|
1436
|
+
"strict": true,
|
|
1437
|
+
"summary": "Get device last seen timestamp",
|
|
1438
|
+
"enableJsonFlag": true,
|
|
1439
|
+
"isESM": true,
|
|
1440
|
+
"relativePath": [
|
|
1441
|
+
"dist",
|
|
1442
|
+
"commands",
|
|
1443
|
+
"devices",
|
|
1444
|
+
"last-seen.js"
|
|
1445
|
+
]
|
|
1446
|
+
},
|
|
1447
|
+
"devices:list": {
|
|
1448
|
+
"aliases": [],
|
|
1449
|
+
"args": {},
|
|
1450
|
+
"description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --all to include offline devices.",
|
|
1451
|
+
"examples": [
|
|
1452
|
+
"<%= config.bin %> devices list",
|
|
1453
|
+
"<%= config.bin %> devices list --all",
|
|
1454
|
+
"<%= config.bin %> devices list --all --limit 100",
|
|
1455
|
+
"<%= config.bin %> devices list --tag location=warehouse",
|
|
1456
|
+
"<%= config.bin %> devices list --name robot --dev --json"
|
|
1457
|
+
],
|
|
1458
|
+
"flags": {
|
|
1459
|
+
"json": {
|
|
1460
|
+
"description": "Format output as json.",
|
|
1461
|
+
"helpGroup": "GLOBAL",
|
|
1462
|
+
"name": "json",
|
|
1463
|
+
"allowNo": false,
|
|
1464
|
+
"type": "boolean"
|
|
1465
|
+
},
|
|
1466
|
+
"dev": {
|
|
1467
|
+
"description": "Target the dev environment",
|
|
1468
|
+
"exclusive": [
|
|
1469
|
+
"stage"
|
|
1470
|
+
],
|
|
1471
|
+
"helpGroup": "GLOBAL",
|
|
1472
|
+
"name": "dev",
|
|
1473
|
+
"allowNo": false,
|
|
1474
|
+
"type": "boolean"
|
|
1475
|
+
},
|
|
1476
|
+
"stage": {
|
|
1477
|
+
"description": "Target the stage environment",
|
|
1478
|
+
"exclusive": [
|
|
1479
|
+
"dev"
|
|
1480
|
+
],
|
|
1481
|
+
"helpGroup": "GLOBAL",
|
|
1482
|
+
"name": "stage",
|
|
1483
|
+
"allowNo": false,
|
|
1484
|
+
"type": "boolean"
|
|
1485
|
+
},
|
|
1486
|
+
"all": {
|
|
1487
|
+
"char": "a",
|
|
1488
|
+
"description": "Show all devices (online and offline)",
|
|
1489
|
+
"name": "all",
|
|
1490
|
+
"allowNo": false,
|
|
1491
|
+
"type": "boolean"
|
|
1492
|
+
},
|
|
1493
|
+
"limit": {
|
|
1494
|
+
"char": "l",
|
|
1495
|
+
"description": "Maximum number of devices to return",
|
|
1496
|
+
"name": "limit",
|
|
1497
|
+
"default": 50,
|
|
1498
|
+
"hasDynamicHelp": false,
|
|
1499
|
+
"multiple": false,
|
|
1500
|
+
"type": "option"
|
|
1501
|
+
},
|
|
1502
|
+
"name": {
|
|
1503
|
+
"char": "n",
|
|
1504
|
+
"description": "Filter devices by name (search)",
|
|
1505
|
+
"name": "name",
|
|
1506
|
+
"hasDynamicHelp": false,
|
|
1507
|
+
"multiple": false,
|
|
1508
|
+
"type": "option"
|
|
1509
|
+
},
|
|
1510
|
+
"tag": {
|
|
1511
|
+
"char": "t",
|
|
1512
|
+
"description": "Filter by tag (key=value), can be specified multiple times",
|
|
1513
|
+
"name": "tag",
|
|
1514
|
+
"hasDynamicHelp": false,
|
|
1515
|
+
"multiple": true,
|
|
1516
|
+
"type": "option"
|
|
1517
|
+
}
|
|
1518
|
+
},
|
|
1519
|
+
"hasDynamicHelp": false,
|
|
1520
|
+
"hiddenAliases": [],
|
|
1521
|
+
"id": "devices:list",
|
|
1522
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1523
|
+
"pluginName": "@formant/formant-cli",
|
|
1524
|
+
"pluginType": "core",
|
|
1525
|
+
"strict": true,
|
|
1526
|
+
"summary": "List robots and sensors in your fleet",
|
|
1527
|
+
"enableJsonFlag": true,
|
|
1528
|
+
"isESM": true,
|
|
1529
|
+
"relativePath": [
|
|
1530
|
+
"dist",
|
|
1531
|
+
"commands",
|
|
1532
|
+
"devices",
|
|
1533
|
+
"list.js"
|
|
1534
|
+
]
|
|
1535
|
+
},
|
|
1536
|
+
"devices:streams": {
|
|
1537
|
+
"aliases": [],
|
|
1538
|
+
"args": {
|
|
1539
|
+
"id": {
|
|
1540
|
+
"description": "Device ID (UUID)",
|
|
1541
|
+
"name": "id",
|
|
1542
|
+
"required": true
|
|
1543
|
+
}
|
|
1544
|
+
},
|
|
1545
|
+
"description": "List telemetry streams configured on a device.\n\nShows a clean view of stream definitions parsed from the device configuration,\nincluding stream names, types, topics, and quality settings.",
|
|
1546
|
+
"examples": [
|
|
1547
|
+
"<%= config.bin %> devices streams <device-id>",
|
|
1548
|
+
"<%= config.bin %> devices streams <device-id> --json"
|
|
1549
|
+
],
|
|
1550
|
+
"flags": {
|
|
1551
|
+
"json": {
|
|
1552
|
+
"description": "Format output as json.",
|
|
1553
|
+
"helpGroup": "GLOBAL",
|
|
1554
|
+
"name": "json",
|
|
1555
|
+
"allowNo": false,
|
|
1556
|
+
"type": "boolean"
|
|
1557
|
+
},
|
|
1558
|
+
"dev": {
|
|
1559
|
+
"description": "Target the dev environment",
|
|
1560
|
+
"exclusive": [
|
|
1561
|
+
"stage"
|
|
1562
|
+
],
|
|
1563
|
+
"helpGroup": "GLOBAL",
|
|
1564
|
+
"name": "dev",
|
|
1565
|
+
"allowNo": false,
|
|
1566
|
+
"type": "boolean"
|
|
1567
|
+
},
|
|
1568
|
+
"stage": {
|
|
1569
|
+
"description": "Target the stage environment",
|
|
1570
|
+
"exclusive": [
|
|
1571
|
+
"dev"
|
|
1572
|
+
],
|
|
1573
|
+
"helpGroup": "GLOBAL",
|
|
1574
|
+
"name": "stage",
|
|
1575
|
+
"allowNo": false,
|
|
1576
|
+
"type": "boolean"
|
|
1577
|
+
}
|
|
1578
|
+
},
|
|
1579
|
+
"hasDynamicHelp": false,
|
|
1580
|
+
"hiddenAliases": [],
|
|
1581
|
+
"id": "devices:streams",
|
|
1582
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1583
|
+
"pluginName": "@formant/formant-cli",
|
|
1584
|
+
"pluginType": "core",
|
|
1585
|
+
"strict": true,
|
|
1586
|
+
"summary": "List device streams",
|
|
1587
|
+
"enableJsonFlag": true,
|
|
1588
|
+
"isESM": true,
|
|
1589
|
+
"relativePath": [
|
|
1590
|
+
"dist",
|
|
1591
|
+
"commands",
|
|
1592
|
+
"devices",
|
|
1593
|
+
"streams.js"
|
|
1594
|
+
]
|
|
1595
|
+
},
|
|
1596
|
+
"investigations:analytics": {
|
|
1597
|
+
"aliases": [],
|
|
1598
|
+
"args": {},
|
|
1599
|
+
"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.",
|
|
1600
|
+
"examples": [
|
|
1601
|
+
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01",
|
|
1602
|
+
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01 --interval hourly",
|
|
1603
|
+
"<%= config.bin %> investigations analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json"
|
|
1604
|
+
],
|
|
1605
|
+
"flags": {
|
|
1606
|
+
"json": {
|
|
1607
|
+
"description": "Format output as json.",
|
|
1608
|
+
"helpGroup": "GLOBAL",
|
|
1609
|
+
"name": "json",
|
|
1610
|
+
"allowNo": false,
|
|
1611
|
+
"type": "boolean"
|
|
1612
|
+
},
|
|
1613
|
+
"dev": {
|
|
1614
|
+
"description": "Target the dev environment",
|
|
1615
|
+
"exclusive": [
|
|
1616
|
+
"stage"
|
|
1617
|
+
],
|
|
1618
|
+
"helpGroup": "GLOBAL",
|
|
1619
|
+
"name": "dev",
|
|
1620
|
+
"allowNo": false,
|
|
1621
|
+
"type": "boolean"
|
|
1622
|
+
},
|
|
1623
|
+
"stage": {
|
|
1624
|
+
"description": "Target the stage environment",
|
|
1625
|
+
"exclusive": [
|
|
1626
|
+
"dev"
|
|
1627
|
+
],
|
|
1628
|
+
"helpGroup": "GLOBAL",
|
|
1629
|
+
"name": "stage",
|
|
1630
|
+
"allowNo": false,
|
|
1631
|
+
"type": "boolean"
|
|
1632
|
+
},
|
|
1633
|
+
"end": {
|
|
1634
|
+
"description": "End time (ISO 8601)",
|
|
1635
|
+
"name": "end",
|
|
1636
|
+
"required": true,
|
|
1637
|
+
"hasDynamicHelp": false,
|
|
1638
|
+
"multiple": false,
|
|
1639
|
+
"type": "option"
|
|
1640
|
+
},
|
|
1641
|
+
"group-by": {
|
|
1642
|
+
"description": "Group results by",
|
|
1643
|
+
"name": "group-by",
|
|
1644
|
+
"hasDynamicHelp": false,
|
|
1645
|
+
"multiple": false,
|
|
1646
|
+
"options": [
|
|
1647
|
+
"resultType",
|
|
1648
|
+
"signalType"
|
|
1649
|
+
],
|
|
1650
|
+
"type": "option"
|
|
1651
|
+
},
|
|
1652
|
+
"interval": {
|
|
1653
|
+
"description": "Time interval for aggregation",
|
|
1654
|
+
"name": "interval",
|
|
1655
|
+
"default": "daily",
|
|
1656
|
+
"hasDynamicHelp": false,
|
|
1657
|
+
"multiple": false,
|
|
1658
|
+
"options": [
|
|
1659
|
+
"daily",
|
|
1660
|
+
"hourly"
|
|
1661
|
+
],
|
|
1662
|
+
"type": "option"
|
|
1663
|
+
},
|
|
1664
|
+
"start": {
|
|
1665
|
+
"description": "Start time (ISO 8601)",
|
|
1666
|
+
"name": "start",
|
|
1667
|
+
"required": true,
|
|
1668
|
+
"hasDynamicHelp": false,
|
|
1669
|
+
"multiple": false,
|
|
1670
|
+
"type": "option"
|
|
1671
|
+
}
|
|
1672
|
+
},
|
|
1673
|
+
"hasDynamicHelp": false,
|
|
1674
|
+
"hiddenAliases": [],
|
|
1675
|
+
"id": "investigations:analytics",
|
|
1676
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1677
|
+
"pluginName": "@formant/formant-cli",
|
|
1678
|
+
"pluginType": "core",
|
|
1679
|
+
"strict": true,
|
|
1680
|
+
"summary": "Get investigation analytics",
|
|
1681
|
+
"enableJsonFlag": true,
|
|
1682
|
+
"isESM": true,
|
|
1683
|
+
"relativePath": [
|
|
1684
|
+
"dist",
|
|
1685
|
+
"commands",
|
|
1686
|
+
"investigations",
|
|
1687
|
+
"analytics.js"
|
|
1688
|
+
]
|
|
1689
|
+
},
|
|
1690
|
+
"investigations:get": {
|
|
1691
|
+
"aliases": [],
|
|
1692
|
+
"args": {
|
|
1693
|
+
"id": {
|
|
1694
|
+
"description": "Investigation (taskflow) ID",
|
|
1695
|
+
"name": "id",
|
|
1696
|
+
"required": true
|
|
1697
|
+
}
|
|
1698
|
+
},
|
|
1699
|
+
"description": "Get detailed information about a specific investigation by ID.",
|
|
1700
|
+
"examples": [
|
|
1701
|
+
"<%= config.bin %> investigations get <id>",
|
|
1702
|
+
"<%= config.bin %> investigations get <id> --json"
|
|
1703
|
+
],
|
|
1704
|
+
"flags": {
|
|
1705
|
+
"json": {
|
|
1706
|
+
"description": "Format output as json.",
|
|
1707
|
+
"helpGroup": "GLOBAL",
|
|
1708
|
+
"name": "json",
|
|
1709
|
+
"allowNo": false,
|
|
1710
|
+
"type": "boolean"
|
|
1711
|
+
},
|
|
1712
|
+
"dev": {
|
|
1713
|
+
"description": "Target the dev environment",
|
|
1714
|
+
"exclusive": [
|
|
1715
|
+
"stage"
|
|
1716
|
+
],
|
|
1717
|
+
"helpGroup": "GLOBAL",
|
|
1718
|
+
"name": "dev",
|
|
1719
|
+
"allowNo": false,
|
|
1720
|
+
"type": "boolean"
|
|
1721
|
+
},
|
|
1722
|
+
"stage": {
|
|
1723
|
+
"description": "Target the stage environment",
|
|
1724
|
+
"exclusive": [
|
|
1725
|
+
"dev"
|
|
1726
|
+
],
|
|
1727
|
+
"helpGroup": "GLOBAL",
|
|
1728
|
+
"name": "stage",
|
|
1729
|
+
"allowNo": false,
|
|
1730
|
+
"type": "boolean"
|
|
1731
|
+
}
|
|
1732
|
+
},
|
|
1733
|
+
"hasDynamicHelp": false,
|
|
1734
|
+
"hiddenAliases": [],
|
|
1735
|
+
"id": "investigations:get",
|
|
1736
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1737
|
+
"pluginName": "@formant/formant-cli",
|
|
1738
|
+
"pluginType": "core",
|
|
1739
|
+
"strict": true,
|
|
1740
|
+
"summary": "Get an investigation by ID",
|
|
1741
|
+
"enableJsonFlag": true,
|
|
1742
|
+
"isESM": true,
|
|
1743
|
+
"relativePath": [
|
|
1744
|
+
"dist",
|
|
1745
|
+
"commands",
|
|
1746
|
+
"investigations",
|
|
1747
|
+
"get.js"
|
|
1748
|
+
]
|
|
1749
|
+
},
|
|
1750
|
+
"investigations:list": {
|
|
1751
|
+
"aliases": [],
|
|
1752
|
+
"args": {},
|
|
1753
|
+
"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.",
|
|
1754
|
+
"examples": [
|
|
1755
|
+
"<%= config.bin %> investigations list",
|
|
1756
|
+
"<%= config.bin %> investigations list --signal-handler",
|
|
1757
|
+
"<%= config.bin %> investigations list --json"
|
|
1758
|
+
],
|
|
1759
|
+
"flags": {
|
|
1760
|
+
"json": {
|
|
1761
|
+
"description": "Format output as json.",
|
|
1762
|
+
"helpGroup": "GLOBAL",
|
|
1763
|
+
"name": "json",
|
|
1764
|
+
"allowNo": false,
|
|
1765
|
+
"type": "boolean"
|
|
1766
|
+
},
|
|
1767
|
+
"dev": {
|
|
1768
|
+
"description": "Target the dev environment",
|
|
1769
|
+
"exclusive": [
|
|
1770
|
+
"stage"
|
|
1771
|
+
],
|
|
1772
|
+
"helpGroup": "GLOBAL",
|
|
1773
|
+
"name": "dev",
|
|
1774
|
+
"allowNo": false,
|
|
1775
|
+
"type": "boolean"
|
|
1776
|
+
},
|
|
1777
|
+
"stage": {
|
|
1778
|
+
"description": "Target the stage environment",
|
|
1779
|
+
"exclusive": [
|
|
1780
|
+
"dev"
|
|
1781
|
+
],
|
|
1782
|
+
"helpGroup": "GLOBAL",
|
|
1783
|
+
"name": "stage",
|
|
1784
|
+
"allowNo": false,
|
|
1785
|
+
"type": "boolean"
|
|
1786
|
+
},
|
|
1787
|
+
"signal-handler": {
|
|
1788
|
+
"description": "Only show investigations that handle signals",
|
|
1789
|
+
"name": "signal-handler",
|
|
1790
|
+
"allowNo": false,
|
|
1791
|
+
"type": "boolean"
|
|
1792
|
+
}
|
|
1793
|
+
},
|
|
1794
|
+
"hasDynamicHelp": false,
|
|
1795
|
+
"hiddenAliases": [],
|
|
1796
|
+
"id": "investigations:list",
|
|
1797
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1798
|
+
"pluginName": "@formant/formant-cli",
|
|
1799
|
+
"pluginType": "core",
|
|
1800
|
+
"strict": true,
|
|
1801
|
+
"summary": "List investigations",
|
|
1802
|
+
"enableJsonFlag": true,
|
|
1803
|
+
"isESM": true,
|
|
1804
|
+
"relativePath": [
|
|
1805
|
+
"dist",
|
|
1806
|
+
"commands",
|
|
1807
|
+
"investigations",
|
|
1808
|
+
"list.js"
|
|
1809
|
+
]
|
|
1810
|
+
},
|
|
1811
|
+
"investigations:run": {
|
|
1812
|
+
"aliases": [],
|
|
1813
|
+
"args": {
|
|
1814
|
+
"investigationId": {
|
|
1815
|
+
"description": "Investigation (taskflow) ID",
|
|
1816
|
+
"name": "investigationId",
|
|
1817
|
+
"required": true
|
|
1818
|
+
},
|
|
1819
|
+
"runId": {
|
|
1820
|
+
"description": "Run ID",
|
|
1821
|
+
"name": "runId",
|
|
1822
|
+
"required": true
|
|
1823
|
+
}
|
|
1824
|
+
},
|
|
1825
|
+
"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.",
|
|
1826
|
+
"examples": [
|
|
1827
|
+
"<%= config.bin %> investigations run <investigation-id> <run-id>",
|
|
1828
|
+
"<%= config.bin %> investigations run <investigation-id> <run-id> --log-only",
|
|
1829
|
+
"<%= config.bin %> investigations run <investigation-id> <run-id> --json"
|
|
1830
|
+
],
|
|
1831
|
+
"flags": {
|
|
1832
|
+
"json": {
|
|
1833
|
+
"description": "Format output as json.",
|
|
1834
|
+
"helpGroup": "GLOBAL",
|
|
1835
|
+
"name": "json",
|
|
1836
|
+
"allowNo": false,
|
|
1837
|
+
"type": "boolean"
|
|
1838
|
+
},
|
|
1839
|
+
"dev": {
|
|
1840
|
+
"description": "Target the dev environment",
|
|
1841
|
+
"exclusive": [
|
|
1842
|
+
"stage"
|
|
1843
|
+
],
|
|
1844
|
+
"helpGroup": "GLOBAL",
|
|
1845
|
+
"name": "dev",
|
|
1846
|
+
"allowNo": false,
|
|
1847
|
+
"type": "boolean"
|
|
1848
|
+
},
|
|
1849
|
+
"stage": {
|
|
1850
|
+
"description": "Target the stage environment",
|
|
1851
|
+
"exclusive": [
|
|
1852
|
+
"dev"
|
|
1853
|
+
],
|
|
1854
|
+
"helpGroup": "GLOBAL",
|
|
1855
|
+
"name": "stage",
|
|
1856
|
+
"allowNo": false,
|
|
1857
|
+
"type": "boolean"
|
|
1858
|
+
},
|
|
1859
|
+
"log-only": {
|
|
1860
|
+
"description": "Only show the execution log (skip run details)",
|
|
1861
|
+
"name": "log-only",
|
|
1862
|
+
"allowNo": false,
|
|
1863
|
+
"type": "boolean"
|
|
1864
|
+
},
|
|
1865
|
+
"trace-signal": {
|
|
1866
|
+
"description": "Fetch and display the signal and event information for this run",
|
|
1867
|
+
"name": "trace-signal",
|
|
1868
|
+
"allowNo": false,
|
|
1869
|
+
"type": "boolean"
|
|
1870
|
+
}
|
|
1871
|
+
},
|
|
1872
|
+
"hasDynamicHelp": false,
|
|
1873
|
+
"hiddenAliases": [],
|
|
1874
|
+
"id": "investigations:run",
|
|
1875
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1876
|
+
"pluginName": "@formant/formant-cli",
|
|
1877
|
+
"pluginType": "core",
|
|
1878
|
+
"strict": true,
|
|
1879
|
+
"summary": "Get investigation run details and execution log",
|
|
1880
|
+
"enableJsonFlag": true,
|
|
1881
|
+
"isESM": true,
|
|
1882
|
+
"relativePath": [
|
|
1883
|
+
"dist",
|
|
1884
|
+
"commands",
|
|
1885
|
+
"investigations",
|
|
1886
|
+
"run.js"
|
|
1887
|
+
]
|
|
1888
|
+
},
|
|
1889
|
+
"investigations:runs-list": {
|
|
1890
|
+
"aliases": [],
|
|
1891
|
+
"args": {
|
|
1892
|
+
"id": {
|
|
1893
|
+
"description": "Investigation (taskflow) ID",
|
|
1894
|
+
"name": "id",
|
|
1895
|
+
"required": true
|
|
1896
|
+
}
|
|
1897
|
+
},
|
|
1898
|
+
"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.",
|
|
1899
|
+
"examples": [
|
|
1900
|
+
"<%= config.bin %> investigations runs-list <id>",
|
|
1901
|
+
"<%= config.bin %> investigations runs-list <id> --limit 50",
|
|
1902
|
+
"<%= config.bin %> investigations runs-list <id> --details --json"
|
|
1903
|
+
],
|
|
1904
|
+
"flags": {
|
|
1905
|
+
"json": {
|
|
1906
|
+
"description": "Format output as json.",
|
|
1907
|
+
"helpGroup": "GLOBAL",
|
|
1908
|
+
"name": "json",
|
|
1909
|
+
"allowNo": false,
|
|
1910
|
+
"type": "boolean"
|
|
1911
|
+
},
|
|
1912
|
+
"dev": {
|
|
1913
|
+
"description": "Target the dev environment",
|
|
1914
|
+
"exclusive": [
|
|
1915
|
+
"stage"
|
|
1916
|
+
],
|
|
1917
|
+
"helpGroup": "GLOBAL",
|
|
1918
|
+
"name": "dev",
|
|
1919
|
+
"allowNo": false,
|
|
1920
|
+
"type": "boolean"
|
|
1921
|
+
},
|
|
1922
|
+
"stage": {
|
|
1923
|
+
"description": "Target the stage environment",
|
|
1924
|
+
"exclusive": [
|
|
1925
|
+
"dev"
|
|
1926
|
+
],
|
|
1927
|
+
"helpGroup": "GLOBAL",
|
|
1928
|
+
"name": "stage",
|
|
1929
|
+
"allowNo": false,
|
|
1930
|
+
"type": "boolean"
|
|
1931
|
+
},
|
|
1932
|
+
"details": {
|
|
1933
|
+
"description": "Include detailed information about each run",
|
|
1934
|
+
"name": "details",
|
|
1935
|
+
"allowNo": false,
|
|
1936
|
+
"type": "boolean"
|
|
1937
|
+
},
|
|
1938
|
+
"limit": {
|
|
1939
|
+
"char": "l",
|
|
1940
|
+
"description": "Maximum number of runs to return",
|
|
1941
|
+
"name": "limit",
|
|
1942
|
+
"default": 20,
|
|
1943
|
+
"hasDynamicHelp": false,
|
|
1944
|
+
"multiple": false,
|
|
1945
|
+
"type": "option"
|
|
1946
|
+
},
|
|
1947
|
+
"offset": {
|
|
1948
|
+
"char": "o",
|
|
1949
|
+
"description": "Offset for pagination",
|
|
1950
|
+
"name": "offset",
|
|
1951
|
+
"default": 0,
|
|
1952
|
+
"hasDynamicHelp": false,
|
|
1953
|
+
"multiple": false,
|
|
1954
|
+
"type": "option"
|
|
1955
|
+
}
|
|
1956
|
+
},
|
|
1957
|
+
"hasDynamicHelp": false,
|
|
1958
|
+
"hiddenAliases": [],
|
|
1959
|
+
"id": "investigations:runs-list",
|
|
1960
|
+
"pluginAlias": "@formant/formant-cli",
|
|
1961
|
+
"pluginName": "@formant/formant-cli",
|
|
1962
|
+
"pluginType": "core",
|
|
1963
|
+
"strict": true,
|
|
1964
|
+
"summary": "List actual investigation runs",
|
|
1965
|
+
"enableJsonFlag": true,
|
|
1966
|
+
"isESM": true,
|
|
1967
|
+
"relativePath": [
|
|
1968
|
+
"dist",
|
|
1969
|
+
"commands",
|
|
1970
|
+
"investigations",
|
|
1971
|
+
"runs-list.js"
|
|
1972
|
+
]
|
|
1973
|
+
},
|
|
1974
|
+
"investigations:runs": {
|
|
1975
|
+
"aliases": [],
|
|
1976
|
+
"args": {
|
|
1977
|
+
"id": {
|
|
1978
|
+
"description": "Investigation (taskflow) ID",
|
|
1979
|
+
"name": "id",
|
|
1980
|
+
"required": true
|
|
1981
|
+
}
|
|
1982
|
+
},
|
|
1983
|
+
"description": "List evaluation runs for a specific investigation.",
|
|
1984
|
+
"examples": [
|
|
1985
|
+
"<%= config.bin %> investigations runs <id>",
|
|
1986
|
+
"<%= config.bin %> investigations runs <id> --json"
|
|
1987
|
+
],
|
|
1988
|
+
"flags": {
|
|
1989
|
+
"json": {
|
|
1990
|
+
"description": "Format output as json.",
|
|
1991
|
+
"helpGroup": "GLOBAL",
|
|
1992
|
+
"name": "json",
|
|
1993
|
+
"allowNo": false,
|
|
1994
|
+
"type": "boolean"
|
|
1995
|
+
},
|
|
1996
|
+
"dev": {
|
|
1997
|
+
"description": "Target the dev environment",
|
|
1998
|
+
"exclusive": [
|
|
1999
|
+
"stage"
|
|
2000
|
+
],
|
|
2001
|
+
"helpGroup": "GLOBAL",
|
|
2002
|
+
"name": "dev",
|
|
2003
|
+
"allowNo": false,
|
|
2004
|
+
"type": "boolean"
|
|
2005
|
+
},
|
|
2006
|
+
"stage": {
|
|
2007
|
+
"description": "Target the stage environment",
|
|
2008
|
+
"exclusive": [
|
|
2009
|
+
"dev"
|
|
2010
|
+
],
|
|
2011
|
+
"helpGroup": "GLOBAL",
|
|
2012
|
+
"name": "stage",
|
|
2013
|
+
"allowNo": false,
|
|
2014
|
+
"type": "boolean"
|
|
2015
|
+
}
|
|
2016
|
+
},
|
|
2017
|
+
"hasDynamicHelp": false,
|
|
2018
|
+
"hiddenAliases": [],
|
|
2019
|
+
"id": "investigations:runs",
|
|
2020
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2021
|
+
"pluginName": "@formant/formant-cli",
|
|
2022
|
+
"pluginType": "core",
|
|
2023
|
+
"strict": true,
|
|
2024
|
+
"summary": "List runs for an investigation",
|
|
2025
|
+
"enableJsonFlag": true,
|
|
2026
|
+
"isESM": true,
|
|
2027
|
+
"relativePath": [
|
|
2028
|
+
"dist",
|
|
2029
|
+
"commands",
|
|
2030
|
+
"investigations",
|
|
2031
|
+
"runs.js"
|
|
2032
|
+
]
|
|
2033
|
+
},
|
|
2034
|
+
"investigations:stats": {
|
|
2035
|
+
"aliases": [],
|
|
2036
|
+
"args": {},
|
|
2037
|
+
"description": "Get investigation statistics for a time range.",
|
|
2038
|
+
"examples": [
|
|
2039
|
+
"<%= config.bin %> investigations stats --start 2026-01-01 --end 2026-02-01",
|
|
2040
|
+
"<%= config.bin %> investigations stats --start 2026-01-01 --end 2026-02-01 --json"
|
|
2041
|
+
],
|
|
2042
|
+
"flags": {
|
|
2043
|
+
"json": {
|
|
2044
|
+
"description": "Format output as json.",
|
|
2045
|
+
"helpGroup": "GLOBAL",
|
|
2046
|
+
"name": "json",
|
|
2047
|
+
"allowNo": false,
|
|
2048
|
+
"type": "boolean"
|
|
2049
|
+
},
|
|
2050
|
+
"dev": {
|
|
2051
|
+
"description": "Target the dev environment",
|
|
2052
|
+
"exclusive": [
|
|
2053
|
+
"stage"
|
|
2054
|
+
],
|
|
2055
|
+
"helpGroup": "GLOBAL",
|
|
2056
|
+
"name": "dev",
|
|
2057
|
+
"allowNo": false,
|
|
2058
|
+
"type": "boolean"
|
|
2059
|
+
},
|
|
2060
|
+
"stage": {
|
|
2061
|
+
"description": "Target the stage environment",
|
|
2062
|
+
"exclusive": [
|
|
2063
|
+
"dev"
|
|
2064
|
+
],
|
|
2065
|
+
"helpGroup": "GLOBAL",
|
|
2066
|
+
"name": "stage",
|
|
2067
|
+
"allowNo": false,
|
|
2068
|
+
"type": "boolean"
|
|
2069
|
+
},
|
|
2070
|
+
"end": {
|
|
2071
|
+
"description": "End time (ISO 8601)",
|
|
2072
|
+
"name": "end",
|
|
2073
|
+
"required": true,
|
|
2074
|
+
"hasDynamicHelp": false,
|
|
2075
|
+
"multiple": false,
|
|
2076
|
+
"type": "option"
|
|
2077
|
+
},
|
|
2078
|
+
"start": {
|
|
2079
|
+
"description": "Start time (ISO 8601)",
|
|
2080
|
+
"name": "start",
|
|
2081
|
+
"required": true,
|
|
2082
|
+
"hasDynamicHelp": false,
|
|
2083
|
+
"multiple": false,
|
|
2084
|
+
"type": "option"
|
|
2085
|
+
}
|
|
2086
|
+
},
|
|
2087
|
+
"hasDynamicHelp": false,
|
|
2088
|
+
"hiddenAliases": [],
|
|
2089
|
+
"id": "investigations:stats",
|
|
2090
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2091
|
+
"pluginName": "@formant/formant-cli",
|
|
2092
|
+
"pluginType": "core",
|
|
2093
|
+
"strict": true,
|
|
2094
|
+
"summary": "Get investigation stats",
|
|
2095
|
+
"enableJsonFlag": true,
|
|
2096
|
+
"isESM": true,
|
|
2097
|
+
"relativePath": [
|
|
2098
|
+
"dist",
|
|
2099
|
+
"commands",
|
|
2100
|
+
"investigations",
|
|
2101
|
+
"stats.js"
|
|
2102
|
+
]
|
|
2103
|
+
},
|
|
2104
|
+
"investigations:trigger": {
|
|
2105
|
+
"aliases": [],
|
|
2106
|
+
"args": {
|
|
2107
|
+
"id": {
|
|
2108
|
+
"description": "Investigation (taskflow) ID",
|
|
2109
|
+
"name": "id",
|
|
2110
|
+
"required": true
|
|
2111
|
+
}
|
|
2112
|
+
},
|
|
2113
|
+
"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.",
|
|
2114
|
+
"examples": [
|
|
2115
|
+
"<%= config.bin %> investigations trigger <id> --input \"Robot stopped responding\"",
|
|
2116
|
+
"<%= config.bin %> investigations trigger <id> --input \"Battery draining fast on device X\" --json"
|
|
2117
|
+
],
|
|
2118
|
+
"flags": {
|
|
2119
|
+
"json": {
|
|
2120
|
+
"description": "Format output as json.",
|
|
2121
|
+
"helpGroup": "GLOBAL",
|
|
2122
|
+
"name": "json",
|
|
2123
|
+
"allowNo": false,
|
|
2124
|
+
"type": "boolean"
|
|
2125
|
+
},
|
|
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
|
+
"input": {
|
|
2147
|
+
"char": "i",
|
|
2148
|
+
"description": "Input text / problem description for the investigation",
|
|
2149
|
+
"name": "input",
|
|
2150
|
+
"required": true,
|
|
2151
|
+
"hasDynamicHelp": false,
|
|
2152
|
+
"multiple": false,
|
|
2153
|
+
"type": "option"
|
|
2154
|
+
},
|
|
2155
|
+
"signal-id": {
|
|
2156
|
+
"description": "Optional signal ID to associate with this run",
|
|
2157
|
+
"name": "signal-id",
|
|
2158
|
+
"hasDynamicHelp": false,
|
|
2159
|
+
"multiple": false,
|
|
2160
|
+
"type": "option"
|
|
2161
|
+
}
|
|
2162
|
+
},
|
|
2163
|
+
"hasDynamicHelp": false,
|
|
2164
|
+
"hiddenAliases": [],
|
|
2165
|
+
"id": "investigations:trigger",
|
|
2166
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2167
|
+
"pluginName": "@formant/formant-cli",
|
|
2168
|
+
"pluginType": "core",
|
|
2169
|
+
"strict": true,
|
|
2170
|
+
"summary": "Trigger an investigation",
|
|
2171
|
+
"enableJsonFlag": true,
|
|
2172
|
+
"isESM": true,
|
|
2173
|
+
"relativePath": [
|
|
2174
|
+
"dist",
|
|
2175
|
+
"commands",
|
|
2176
|
+
"investigations",
|
|
2177
|
+
"trigger.js"
|
|
2178
|
+
]
|
|
2179
|
+
},
|
|
2180
|
+
"schedules:get": {
|
|
2181
|
+
"aliases": [],
|
|
2182
|
+
"args": {
|
|
2183
|
+
"id": {
|
|
2184
|
+
"description": "Schedule ID (UUID)",
|
|
2185
|
+
"name": "id",
|
|
2186
|
+
"required": true
|
|
2187
|
+
}
|
|
2188
|
+
},
|
|
2189
|
+
"description": "Get detailed information about a schedule.\n\nShows the full schedule configuration including cron expression, command template,\ninvestigation link, and execution settings.",
|
|
2190
|
+
"examples": [
|
|
2191
|
+
"<%= config.bin %> schedules get <schedule-id>",
|
|
2192
|
+
"<%= config.bin %> schedules get <schedule-id> --json"
|
|
2193
|
+
],
|
|
2194
|
+
"flags": {
|
|
2195
|
+
"json": {
|
|
2196
|
+
"description": "Format output as json.",
|
|
2197
|
+
"helpGroup": "GLOBAL",
|
|
2198
|
+
"name": "json",
|
|
2199
|
+
"allowNo": false,
|
|
2200
|
+
"type": "boolean"
|
|
2201
|
+
},
|
|
2202
|
+
"dev": {
|
|
2203
|
+
"description": "Target the dev environment",
|
|
2204
|
+
"exclusive": [
|
|
2205
|
+
"stage"
|
|
2206
|
+
],
|
|
2207
|
+
"helpGroup": "GLOBAL",
|
|
2208
|
+
"name": "dev",
|
|
2209
|
+
"allowNo": false,
|
|
2210
|
+
"type": "boolean"
|
|
2211
|
+
},
|
|
2212
|
+
"stage": {
|
|
2213
|
+
"description": "Target the stage environment",
|
|
2214
|
+
"exclusive": [
|
|
2215
|
+
"dev"
|
|
2216
|
+
],
|
|
2217
|
+
"helpGroup": "GLOBAL",
|
|
2218
|
+
"name": "stage",
|
|
2219
|
+
"allowNo": false,
|
|
2220
|
+
"type": "boolean"
|
|
2221
|
+
}
|
|
2222
|
+
},
|
|
2223
|
+
"hasDynamicHelp": false,
|
|
2224
|
+
"hiddenAliases": [],
|
|
2225
|
+
"id": "schedules:get",
|
|
2226
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2227
|
+
"pluginName": "@formant/formant-cli",
|
|
2228
|
+
"pluginType": "core",
|
|
2229
|
+
"strict": true,
|
|
2230
|
+
"summary": "Get schedule details",
|
|
2231
|
+
"enableJsonFlag": true,
|
|
2232
|
+
"isESM": true,
|
|
2233
|
+
"relativePath": [
|
|
2234
|
+
"dist",
|
|
2235
|
+
"commands",
|
|
2236
|
+
"schedules",
|
|
2237
|
+
"get.js"
|
|
2238
|
+
]
|
|
2239
|
+
},
|
|
2240
|
+
"schedules:list": {
|
|
2241
|
+
"aliases": [],
|
|
2242
|
+
"args": {},
|
|
2243
|
+
"description": "List all schedules in your organization.\n\nSchedules can trigger commands or investigations on a recurring (cron) or one-time basis.",
|
|
2244
|
+
"examples": [
|
|
2245
|
+
"<%= config.bin %> schedules list",
|
|
2246
|
+
"<%= config.bin %> schedules list --json"
|
|
2247
|
+
],
|
|
2248
|
+
"flags": {
|
|
2249
|
+
"json": {
|
|
2250
|
+
"description": "Format output as json.",
|
|
2251
|
+
"helpGroup": "GLOBAL",
|
|
2252
|
+
"name": "json",
|
|
2253
|
+
"allowNo": false,
|
|
2254
|
+
"type": "boolean"
|
|
2255
|
+
},
|
|
2256
|
+
"dev": {
|
|
2257
|
+
"description": "Target the dev environment",
|
|
2258
|
+
"exclusive": [
|
|
2259
|
+
"stage"
|
|
2260
|
+
],
|
|
2261
|
+
"helpGroup": "GLOBAL",
|
|
2262
|
+
"name": "dev",
|
|
2263
|
+
"allowNo": false,
|
|
2264
|
+
"type": "boolean"
|
|
2265
|
+
},
|
|
2266
|
+
"stage": {
|
|
2267
|
+
"description": "Target the stage environment",
|
|
2268
|
+
"exclusive": [
|
|
2269
|
+
"dev"
|
|
2270
|
+
],
|
|
2271
|
+
"helpGroup": "GLOBAL",
|
|
2272
|
+
"name": "stage",
|
|
2273
|
+
"allowNo": false,
|
|
2274
|
+
"type": "boolean"
|
|
2275
|
+
}
|
|
2276
|
+
},
|
|
2277
|
+
"hasDynamicHelp": false,
|
|
2278
|
+
"hiddenAliases": [],
|
|
2279
|
+
"id": "schedules:list",
|
|
2280
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2281
|
+
"pluginName": "@formant/formant-cli",
|
|
2282
|
+
"pluginType": "core",
|
|
2283
|
+
"strict": true,
|
|
2284
|
+
"summary": "List schedules",
|
|
2285
|
+
"enableJsonFlag": true,
|
|
2286
|
+
"isESM": true,
|
|
2287
|
+
"relativePath": [
|
|
2288
|
+
"dist",
|
|
2289
|
+
"commands",
|
|
2290
|
+
"schedules",
|
|
2291
|
+
"list.js"
|
|
2292
|
+
]
|
|
2293
|
+
},
|
|
2294
|
+
"users:get": {
|
|
2295
|
+
"aliases": [],
|
|
2296
|
+
"args": {
|
|
2297
|
+
"id": {
|
|
2298
|
+
"description": "User ID (UUID)",
|
|
2299
|
+
"name": "id",
|
|
2300
|
+
"required": true
|
|
2301
|
+
}
|
|
2302
|
+
},
|
|
2303
|
+
"description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.",
|
|
2304
|
+
"examples": [
|
|
2305
|
+
"<%= config.bin %> users get <user-id>",
|
|
2306
|
+
"<%= config.bin %> users get <user-id> --json"
|
|
2307
|
+
],
|
|
2308
|
+
"flags": {
|
|
2309
|
+
"json": {
|
|
2310
|
+
"description": "Format output as json.",
|
|
2311
|
+
"helpGroup": "GLOBAL",
|
|
2312
|
+
"name": "json",
|
|
2313
|
+
"allowNo": false,
|
|
2314
|
+
"type": "boolean"
|
|
2315
|
+
},
|
|
2316
|
+
"dev": {
|
|
2317
|
+
"description": "Target the dev environment",
|
|
2318
|
+
"exclusive": [
|
|
2319
|
+
"stage"
|
|
2320
|
+
],
|
|
2321
|
+
"helpGroup": "GLOBAL",
|
|
2322
|
+
"name": "dev",
|
|
2323
|
+
"allowNo": false,
|
|
2324
|
+
"type": "boolean"
|
|
2325
|
+
},
|
|
2326
|
+
"stage": {
|
|
2327
|
+
"description": "Target the stage environment",
|
|
2328
|
+
"exclusive": [
|
|
2329
|
+
"dev"
|
|
2330
|
+
],
|
|
2331
|
+
"helpGroup": "GLOBAL",
|
|
2332
|
+
"name": "stage",
|
|
2333
|
+
"allowNo": false,
|
|
2334
|
+
"type": "boolean"
|
|
2335
|
+
}
|
|
2336
|
+
},
|
|
2337
|
+
"hasDynamicHelp": false,
|
|
2338
|
+
"hiddenAliases": [],
|
|
2339
|
+
"id": "users:get",
|
|
2340
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2341
|
+
"pluginName": "@formant/formant-cli",
|
|
2342
|
+
"pluginType": "core",
|
|
2343
|
+
"strict": true,
|
|
2344
|
+
"summary": "Get user details",
|
|
2345
|
+
"enableJsonFlag": true,
|
|
2346
|
+
"isESM": true,
|
|
2347
|
+
"relativePath": [
|
|
2348
|
+
"dist",
|
|
2349
|
+
"commands",
|
|
2350
|
+
"users",
|
|
2351
|
+
"get.js"
|
|
2352
|
+
]
|
|
2353
|
+
},
|
|
2354
|
+
"users:list": {
|
|
2355
|
+
"aliases": [],
|
|
2356
|
+
"args": {},
|
|
2357
|
+
"description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.",
|
|
2358
|
+
"examples": [
|
|
2359
|
+
"<%= config.bin %> users list",
|
|
2360
|
+
"<%= config.bin %> users list --json"
|
|
2361
|
+
],
|
|
2362
|
+
"flags": {
|
|
2363
|
+
"json": {
|
|
2364
|
+
"description": "Format output as json.",
|
|
2365
|
+
"helpGroup": "GLOBAL",
|
|
2366
|
+
"name": "json",
|
|
2367
|
+
"allowNo": false,
|
|
2368
|
+
"type": "boolean"
|
|
2369
|
+
},
|
|
2370
|
+
"dev": {
|
|
2371
|
+
"description": "Target the dev environment",
|
|
2372
|
+
"exclusive": [
|
|
2373
|
+
"stage"
|
|
2374
|
+
],
|
|
2375
|
+
"helpGroup": "GLOBAL",
|
|
2376
|
+
"name": "dev",
|
|
2377
|
+
"allowNo": false,
|
|
2378
|
+
"type": "boolean"
|
|
2379
|
+
},
|
|
2380
|
+
"stage": {
|
|
2381
|
+
"description": "Target the stage environment",
|
|
2382
|
+
"exclusive": [
|
|
2383
|
+
"dev"
|
|
2384
|
+
],
|
|
2385
|
+
"helpGroup": "GLOBAL",
|
|
2386
|
+
"name": "stage",
|
|
2387
|
+
"allowNo": false,
|
|
2388
|
+
"type": "boolean"
|
|
2389
|
+
}
|
|
2390
|
+
},
|
|
2391
|
+
"hasDynamicHelp": false,
|
|
2392
|
+
"hiddenAliases": [],
|
|
2393
|
+
"id": "users:list",
|
|
2394
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2395
|
+
"pluginName": "@formant/formant-cli",
|
|
2396
|
+
"pluginType": "core",
|
|
2397
|
+
"strict": true,
|
|
2398
|
+
"summary": "List users",
|
|
2399
|
+
"enableJsonFlag": true,
|
|
2400
|
+
"isESM": true,
|
|
2401
|
+
"relativePath": [
|
|
2402
|
+
"dist",
|
|
2403
|
+
"commands",
|
|
2404
|
+
"users",
|
|
2405
|
+
"list.js"
|
|
2406
|
+
]
|
|
2407
|
+
},
|
|
2408
|
+
"signals:count": {
|
|
2409
|
+
"aliases": [],
|
|
2410
|
+
"args": {},
|
|
2411
|
+
"description": "Get counts of signals grouped by type.\n\nReturns total counts and per-type breakdowns (manual, eventTrigger, schedule, slack).",
|
|
2412
|
+
"examples": [
|
|
2413
|
+
"<%= config.bin %> signals count",
|
|
2414
|
+
"<%= config.bin %> signals count --start 2026-01-01 --end 2026-02-01",
|
|
2415
|
+
"<%= config.bin %> signals count --json"
|
|
2416
|
+
],
|
|
2417
|
+
"flags": {
|
|
2418
|
+
"json": {
|
|
2419
|
+
"description": "Format output as json.",
|
|
2420
|
+
"helpGroup": "GLOBAL",
|
|
2421
|
+
"name": "json",
|
|
2422
|
+
"allowNo": false,
|
|
2423
|
+
"type": "boolean"
|
|
2424
|
+
},
|
|
2425
|
+
"dev": {
|
|
2426
|
+
"description": "Target the dev environment",
|
|
2427
|
+
"exclusive": [
|
|
2428
|
+
"stage"
|
|
2429
|
+
],
|
|
2430
|
+
"helpGroup": "GLOBAL",
|
|
2431
|
+
"name": "dev",
|
|
2432
|
+
"allowNo": false,
|
|
2433
|
+
"type": "boolean"
|
|
2434
|
+
},
|
|
2435
|
+
"stage": {
|
|
2436
|
+
"description": "Target the stage environment",
|
|
2437
|
+
"exclusive": [
|
|
2438
|
+
"dev"
|
|
2439
|
+
],
|
|
2440
|
+
"helpGroup": "GLOBAL",
|
|
2441
|
+
"name": "stage",
|
|
2442
|
+
"allowNo": false,
|
|
2443
|
+
"type": "boolean"
|
|
2444
|
+
},
|
|
2445
|
+
"end": {
|
|
2446
|
+
"description": "End time (ISO 8601)",
|
|
2447
|
+
"name": "end",
|
|
2448
|
+
"hasDynamicHelp": false,
|
|
2449
|
+
"multiple": false,
|
|
2450
|
+
"type": "option"
|
|
2451
|
+
},
|
|
2452
|
+
"start": {
|
|
2453
|
+
"description": "Start time (ISO 8601)",
|
|
2454
|
+
"name": "start",
|
|
2455
|
+
"hasDynamicHelp": false,
|
|
2456
|
+
"multiple": false,
|
|
2457
|
+
"type": "option"
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"hasDynamicHelp": false,
|
|
2461
|
+
"hiddenAliases": [],
|
|
2462
|
+
"id": "signals:count",
|
|
2463
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2464
|
+
"pluginName": "@formant/formant-cli",
|
|
2465
|
+
"pluginType": "core",
|
|
2466
|
+
"strict": true,
|
|
2467
|
+
"summary": "Get signal counts by type",
|
|
2468
|
+
"enableJsonFlag": true,
|
|
2469
|
+
"isESM": true,
|
|
2470
|
+
"relativePath": [
|
|
2471
|
+
"dist",
|
|
2472
|
+
"commands",
|
|
2473
|
+
"signals",
|
|
2474
|
+
"count.js"
|
|
2475
|
+
]
|
|
2476
|
+
},
|
|
2477
|
+
"signals:get": {
|
|
2478
|
+
"aliases": [],
|
|
2479
|
+
"args": {
|
|
2480
|
+
"id": {
|
|
2481
|
+
"description": "Signal ID (UUID)",
|
|
2482
|
+
"name": "id",
|
|
2483
|
+
"required": true
|
|
2484
|
+
}
|
|
2485
|
+
},
|
|
2486
|
+
"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.",
|
|
2487
|
+
"examples": [
|
|
2488
|
+
"<%= config.bin %> signals get <signal-id>",
|
|
2489
|
+
"<%= config.bin %> signals get <signal-id> --trace",
|
|
2490
|
+
"<%= config.bin %> signals get <signal-id> --json"
|
|
2491
|
+
],
|
|
2492
|
+
"flags": {
|
|
2493
|
+
"json": {
|
|
2494
|
+
"description": "Format output as json.",
|
|
2495
|
+
"helpGroup": "GLOBAL",
|
|
2496
|
+
"name": "json",
|
|
2497
|
+
"allowNo": false,
|
|
2498
|
+
"type": "boolean"
|
|
2499
|
+
},
|
|
2500
|
+
"dev": {
|
|
2501
|
+
"description": "Target the dev environment",
|
|
2502
|
+
"exclusive": [
|
|
2503
|
+
"stage"
|
|
2504
|
+
],
|
|
2505
|
+
"helpGroup": "GLOBAL",
|
|
2506
|
+
"name": "dev",
|
|
2507
|
+
"allowNo": false,
|
|
2508
|
+
"type": "boolean"
|
|
2509
|
+
},
|
|
2510
|
+
"stage": {
|
|
2511
|
+
"description": "Target the stage environment",
|
|
2512
|
+
"exclusive": [
|
|
2513
|
+
"dev"
|
|
2514
|
+
],
|
|
2515
|
+
"helpGroup": "GLOBAL",
|
|
2516
|
+
"name": "stage",
|
|
2517
|
+
"allowNo": false,
|
|
2518
|
+
"type": "boolean"
|
|
2519
|
+
},
|
|
2520
|
+
"trace": {
|
|
2521
|
+
"description": "Fetch and display the triggering event and event trigger information",
|
|
2522
|
+
"name": "trace",
|
|
2523
|
+
"allowNo": false,
|
|
2524
|
+
"type": "boolean"
|
|
2525
|
+
}
|
|
2526
|
+
},
|
|
2527
|
+
"hasDynamicHelp": false,
|
|
2528
|
+
"hiddenAliases": [],
|
|
2529
|
+
"id": "signals:get",
|
|
2530
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2531
|
+
"pluginName": "@formant/formant-cli",
|
|
2532
|
+
"pluginType": "core",
|
|
2533
|
+
"strict": true,
|
|
2534
|
+
"summary": "Get a signal by ID",
|
|
2535
|
+
"enableJsonFlag": true,
|
|
2536
|
+
"isESM": true,
|
|
2537
|
+
"relativePath": [
|
|
2538
|
+
"dist",
|
|
2539
|
+
"commands",
|
|
2540
|
+
"signals",
|
|
2541
|
+
"get.js"
|
|
2542
|
+
]
|
|
2543
|
+
},
|
|
2544
|
+
"signals:list": {
|
|
2545
|
+
"aliases": [],
|
|
2546
|
+
"args": {},
|
|
2547
|
+
"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.",
|
|
2548
|
+
"examples": [
|
|
2549
|
+
"<%= config.bin %> signals list",
|
|
2550
|
+
"<%= config.bin %> signals list --json"
|
|
2551
|
+
],
|
|
2552
|
+
"flags": {
|
|
2553
|
+
"json": {
|
|
2554
|
+
"description": "Format output as json.",
|
|
2555
|
+
"helpGroup": "GLOBAL",
|
|
2556
|
+
"name": "json",
|
|
2557
|
+
"allowNo": false,
|
|
2558
|
+
"type": "boolean"
|
|
2559
|
+
},
|
|
2560
|
+
"dev": {
|
|
2561
|
+
"description": "Target the dev environment",
|
|
2562
|
+
"exclusive": [
|
|
2563
|
+
"stage"
|
|
2564
|
+
],
|
|
2565
|
+
"helpGroup": "GLOBAL",
|
|
2566
|
+
"name": "dev",
|
|
2567
|
+
"allowNo": false,
|
|
2568
|
+
"type": "boolean"
|
|
2569
|
+
},
|
|
2570
|
+
"stage": {
|
|
2571
|
+
"description": "Target the stage environment",
|
|
2572
|
+
"exclusive": [
|
|
2573
|
+
"dev"
|
|
2574
|
+
],
|
|
2575
|
+
"helpGroup": "GLOBAL",
|
|
2576
|
+
"name": "stage",
|
|
2577
|
+
"allowNo": false,
|
|
2578
|
+
"type": "boolean"
|
|
2579
|
+
}
|
|
2580
|
+
},
|
|
2581
|
+
"hasDynamicHelp": false,
|
|
2582
|
+
"hiddenAliases": [],
|
|
2583
|
+
"id": "signals:list",
|
|
2584
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2585
|
+
"pluginName": "@formant/formant-cli",
|
|
2586
|
+
"pluginType": "core",
|
|
2587
|
+
"strict": true,
|
|
2588
|
+
"summary": "List all signals",
|
|
2589
|
+
"enableJsonFlag": true,
|
|
2590
|
+
"isESM": true,
|
|
2591
|
+
"relativePath": [
|
|
2592
|
+
"dist",
|
|
2593
|
+
"commands",
|
|
2594
|
+
"signals",
|
|
2595
|
+
"list.js"
|
|
2596
|
+
]
|
|
2597
|
+
},
|
|
2598
|
+
"signals:query": {
|
|
2599
|
+
"aliases": [],
|
|
2600
|
+
"args": {},
|
|
2601
|
+
"description": "Query signals by time range and type.\n\nSignal types: manual, eventTrigger, schedule, slack.",
|
|
2602
|
+
"examples": [
|
|
2603
|
+
"<%= config.bin %> signals query --start 2026-01-01",
|
|
2604
|
+
"<%= config.bin %> signals query --start 2026-01-01 --end 2026-02-01 --type eventTrigger",
|
|
2605
|
+
"<%= config.bin %> signals query --start 2026-01-01 --json"
|
|
2606
|
+
],
|
|
2607
|
+
"flags": {
|
|
2608
|
+
"json": {
|
|
2609
|
+
"description": "Format output as json.",
|
|
2610
|
+
"helpGroup": "GLOBAL",
|
|
2611
|
+
"name": "json",
|
|
2612
|
+
"allowNo": false,
|
|
2613
|
+
"type": "boolean"
|
|
2614
|
+
},
|
|
2615
|
+
"dev": {
|
|
2616
|
+
"description": "Target the dev environment",
|
|
2617
|
+
"exclusive": [
|
|
2618
|
+
"stage"
|
|
2619
|
+
],
|
|
2620
|
+
"helpGroup": "GLOBAL",
|
|
2621
|
+
"name": "dev",
|
|
2622
|
+
"allowNo": false,
|
|
2623
|
+
"type": "boolean"
|
|
2624
|
+
},
|
|
2625
|
+
"stage": {
|
|
2626
|
+
"description": "Target the stage environment",
|
|
2627
|
+
"exclusive": [
|
|
2628
|
+
"dev"
|
|
2629
|
+
],
|
|
2630
|
+
"helpGroup": "GLOBAL",
|
|
2631
|
+
"name": "stage",
|
|
2632
|
+
"allowNo": false,
|
|
2633
|
+
"type": "boolean"
|
|
2634
|
+
},
|
|
2635
|
+
"end": {
|
|
2636
|
+
"description": "End time (ISO 8601)",
|
|
2637
|
+
"name": "end",
|
|
2638
|
+
"hasDynamicHelp": false,
|
|
2639
|
+
"multiple": false,
|
|
2640
|
+
"type": "option"
|
|
2641
|
+
},
|
|
2642
|
+
"start": {
|
|
2643
|
+
"description": "Start time (ISO 8601)",
|
|
2644
|
+
"name": "start",
|
|
2645
|
+
"required": true,
|
|
2646
|
+
"hasDynamicHelp": false,
|
|
2647
|
+
"multiple": false,
|
|
2648
|
+
"type": "option"
|
|
2649
|
+
},
|
|
2650
|
+
"type": {
|
|
2651
|
+
"description": "Filter by signal type",
|
|
2652
|
+
"name": "type",
|
|
2653
|
+
"hasDynamicHelp": false,
|
|
2654
|
+
"multiple": false,
|
|
2655
|
+
"options": [
|
|
2656
|
+
"manual",
|
|
2657
|
+
"eventTrigger",
|
|
2658
|
+
"schedule",
|
|
2659
|
+
"slack"
|
|
2660
|
+
],
|
|
2661
|
+
"type": "option"
|
|
2662
|
+
}
|
|
2663
|
+
},
|
|
2664
|
+
"hasDynamicHelp": false,
|
|
2665
|
+
"hiddenAliases": [],
|
|
2666
|
+
"id": "signals:query",
|
|
2667
|
+
"pluginAlias": "@formant/formant-cli",
|
|
2668
|
+
"pluginName": "@formant/formant-cli",
|
|
2669
|
+
"pluginType": "core",
|
|
2670
|
+
"strict": true,
|
|
2671
|
+
"summary": "Query signals by time range",
|
|
2672
|
+
"enableJsonFlag": true,
|
|
2673
|
+
"isESM": true,
|
|
2674
|
+
"relativePath": [
|
|
2675
|
+
"dist",
|
|
2676
|
+
"commands",
|
|
2677
|
+
"signals",
|
|
2678
|
+
"query.js"
|
|
2679
|
+
]
|
|
2680
|
+
}
|
|
2681
|
+
},
|
|
2682
|
+
"version": "0.1.0"
|
|
2683
|
+
}
|