balena-cli 23.2.12 → 23.2.13-build-update-docker-progress-5-4-0-11745cd340eeb2790888818f755922221cd78df9-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -160,56 +160,6 @@
160
160
  "create.js"
161
161
  ]
162
162
  },
163
- "block:create": {
164
- "aliases": [],
165
- "args": {
166
- "name": {
167
- "description": "block name",
168
- "name": "name",
169
- "required": true
170
- }
171
- },
172
- "description": "Create an block.\n\nCreate a new balena block.\n\nYou can specify the organization the block should belong to using\nthe `--organization` option. The organization's handle, not its name,\nshould be provided. Organization handles can be listed with the\n`balena organization list` command.\n\nThe block's default device type is specified with the `--type` option.\nThe `balena device-type list` command can be used to list the available\ndevice types.\n\nInteractive dropdowns will be shown for selection if no device type or\norganization is specified and there are multiple options to choose from.\nIf there is a single option to choose from, it will be chosen automatically.\nThis interactive behavior can be disabled by explicitly specifying a device\ntype and organization.",
173
- "examples": [
174
- "$ balena block create MyBlock",
175
- "$ balena block create MyBlock --organization mmyorg",
176
- "$ balena block create MyBlock -o myorg --type raspberry-pi"
177
- ],
178
- "flags": {
179
- "organization": {
180
- "char": "o",
181
- "description": "handle of the organization the block should belong to",
182
- "name": "organization",
183
- "hasDynamicHelp": false,
184
- "multiple": false,
185
- "type": "option"
186
- },
187
- "type": {
188
- "char": "t",
189
- "description": "block device type (Check available types with `balena device-type list`)",
190
- "name": "type",
191
- "hasDynamicHelp": false,
192
- "multiple": false,
193
- "type": "option"
194
- }
195
- },
196
- "hasDynamicHelp": false,
197
- "hiddenAliases": [],
198
- "id": "block:create",
199
- "pluginAlias": "balena-cli",
200
- "pluginName": "balena-cli",
201
- "pluginType": "core",
202
- "strict": true,
203
- "enableJsonFlag": false,
204
- "authenticated": true,
205
- "isESM": false,
206
- "relativePath": [
207
- "build",
208
- "commands",
209
- "block",
210
- "create.js"
211
- ]
212
- },
213
163
  "build": {
214
164
  "aliases": [],
215
165
  "args": {
@@ -412,6 +362,56 @@
412
362
  "index.js"
413
363
  ]
414
364
  },
365
+ "block:create": {
366
+ "aliases": [],
367
+ "args": {
368
+ "name": {
369
+ "description": "block name",
370
+ "name": "name",
371
+ "required": true
372
+ }
373
+ },
374
+ "description": "Create an block.\n\nCreate a new balena block.\n\nYou can specify the organization the block should belong to using\nthe `--organization` option. The organization's handle, not its name,\nshould be provided. Organization handles can be listed with the\n`balena organization list` command.\n\nThe block's default device type is specified with the `--type` option.\nThe `balena device-type list` command can be used to list the available\ndevice types.\n\nInteractive dropdowns will be shown for selection if no device type or\norganization is specified and there are multiple options to choose from.\nIf there is a single option to choose from, it will be chosen automatically.\nThis interactive behavior can be disabled by explicitly specifying a device\ntype and organization.",
375
+ "examples": [
376
+ "$ balena block create MyBlock",
377
+ "$ balena block create MyBlock --organization mmyorg",
378
+ "$ balena block create MyBlock -o myorg --type raspberry-pi"
379
+ ],
380
+ "flags": {
381
+ "organization": {
382
+ "char": "o",
383
+ "description": "handle of the organization the block should belong to",
384
+ "name": "organization",
385
+ "hasDynamicHelp": false,
386
+ "multiple": false,
387
+ "type": "option"
388
+ },
389
+ "type": {
390
+ "char": "t",
391
+ "description": "block device type (Check available types with `balena device-type list`)",
392
+ "name": "type",
393
+ "hasDynamicHelp": false,
394
+ "multiple": false,
395
+ "type": "option"
396
+ }
397
+ },
398
+ "hasDynamicHelp": false,
399
+ "hiddenAliases": [],
400
+ "id": "block:create",
401
+ "pluginAlias": "balena-cli",
402
+ "pluginName": "balena-cli",
403
+ "pluginType": "core",
404
+ "strict": true,
405
+ "enableJsonFlag": false,
406
+ "authenticated": true,
407
+ "isESM": false,
408
+ "relativePath": [
409
+ "build",
410
+ "commands",
411
+ "block",
412
+ "create.js"
413
+ ]
414
+ },
415
415
  "config:generate": {
416
416
  "aliases": [],
417
417
  "args": {},
@@ -1018,16 +1018,54 @@
1018
1018
  "list.js"
1019
1019
  ]
1020
1020
  },
1021
- "env:list": {
1021
+ "device:deactivate": {
1022
+ "aliases": [],
1023
+ "args": {
1024
+ "uuid": {
1025
+ "description": "the UUID of the device to be deactivated",
1026
+ "name": "uuid",
1027
+ "required": true
1028
+ }
1029
+ },
1030
+ "description": "Deactivate a device.\n\nDeactivate a device.\n\nNote this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` option.",
1031
+ "examples": [
1032
+ "$ balena device deactivate 7cf02a6",
1033
+ "$ balena device deactivate 7cf02a6 --yes"
1034
+ ],
1035
+ "flags": {
1036
+ "yes": {
1037
+ "char": "y",
1038
+ "description": "answer \"yes\" to all questions (non interactive use)",
1039
+ "name": "yes",
1040
+ "allowNo": false,
1041
+ "type": "boolean"
1042
+ }
1043
+ },
1044
+ "hasDynamicHelp": false,
1045
+ "hiddenAliases": [],
1046
+ "id": "device:deactivate",
1047
+ "pluginAlias": "balena-cli",
1048
+ "pluginName": "balena-cli",
1049
+ "pluginType": "core",
1050
+ "strict": true,
1051
+ "enableJsonFlag": false,
1052
+ "authenticated": true,
1053
+ "isESM": false,
1054
+ "relativePath": [
1055
+ "build",
1056
+ "commands",
1057
+ "device",
1058
+ "deactivate.js"
1059
+ ]
1060
+ },
1061
+ "device:detect": {
1022
1062
  "aliases": [],
1023
1063
  "args": {},
1024
- "description": "List the environment or config variables of a fleet, device or service.\n\nList the environment or configuration variables of a fleet, device or\nservice, as selected by the respective command-line options. (A service\ncorresponds to a Docker image/container in a microservices fleet.)\n\nThe results include fleet-wide (multiple devices), device-specific (multiple\nservices on a specific device) and service-specific variables that apply to the\nselected fleet, device or service. It can be thought of as including inherited\nvariables; for example, a service inherits device-wide variables, and a device\ninherits fleet-wide variables.\n\nThe printed output may include DEVICE and/or SERVICE columns to distinguish\nbetween fleet-wide, device-specific and service-specific variables.\nAn asterisk in these columns indicates that the variable applies to\n\"all devices\" or \"all services\".\n\nThe --config option is used to list \"configuration variables\" that control\nbalena platform features, as opposed to custom environment variables defined\nby the user. The --config and the --service options are mutually exclusive\nbecause configuration variables cannot be set for specific services.\n\nWhen --json is used, an empty JSON array ([]) is printed instead of an error \nmessage when no variables exist for the given query. When querying variables \nfor a device, note that the fleet name may be null in JSON output \n(or 'N/A' in tabular output) if the fleet that the device belonged to is no \nlonger accessible by the current user (for example, in case the current user \nwas removed from the fleet by the fleet's owner).\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
1064
+ "description": "Scan for balenaOS devices on your local network.\n\nScan for balenaOS devices on your local network.\n\nThe output includes device information collected through balenaEngine for\ndevices running a development image of balenaOS. Devices running a production\nimage do not expose balenaEngine (on TCP port 2375), which is why less\ninformation is printed about them.",
1025
1065
  "examples": [
1026
- "$ balena env list --fleet myorg/myfleet",
1027
- "$ balena env list --fleet MyFleet --service MyService",
1028
- "$ balena env list --fleet MyFleet --config",
1029
- "$ balena env list --device 7cf02a6",
1030
- "$ balena env list --device 7cf02a6 --service MyService"
1066
+ "$ balena device detect",
1067
+ "$ balena device detect --timeout 120",
1068
+ "$ balena device detect --verbose"
1031
1069
  ],
1032
1070
  "flags": {
1033
1071
  "json": {
@@ -1037,45 +1075,17 @@
1037
1075
  "allowNo": false,
1038
1076
  "type": "boolean"
1039
1077
  },
1040
- "fleet": {
1041
- "char": "f",
1042
- "description": "fleet name or slug (preferred)",
1043
- "exclusive": [
1044
- "device"
1045
- ],
1046
- "name": "fleet",
1047
- "hasDynamicHelp": false,
1048
- "multiple": false,
1049
- "type": "option"
1050
- },
1051
- "config": {
1052
- "char": "c",
1053
- "description": "show configuration variables only",
1054
- "exclusive": [
1055
- "service"
1056
- ],
1057
- "name": "config",
1078
+ "verbose": {
1079
+ "char": "v",
1080
+ "description": "display full info",
1081
+ "name": "verbose",
1058
1082
  "allowNo": false,
1059
1083
  "type": "boolean"
1060
1084
  },
1061
- "device": {
1062
- "char": "d",
1063
- "description": "device UUID",
1064
- "exclusive": [
1065
- "fleet"
1066
- ],
1067
- "name": "device",
1068
- "hasDynamicHelp": false,
1069
- "multiple": false,
1070
- "type": "option"
1071
- },
1072
- "service": {
1073
- "char": "s",
1074
- "description": "service name",
1075
- "exclusive": [
1076
- "config"
1077
- ],
1078
- "name": "service",
1085
+ "timeout": {
1086
+ "char": "t",
1087
+ "description": "scan timeout in seconds",
1088
+ "name": "timeout",
1079
1089
  "hasDynamicHelp": false,
1080
1090
  "multiple": false,
1081
1091
  "type": "option"
@@ -1083,362 +1093,53 @@
1083
1093
  },
1084
1094
  "hasDynamicHelp": false,
1085
1095
  "hiddenAliases": [],
1086
- "id": "env:list",
1096
+ "id": "device:detect",
1087
1097
  "pluginAlias": "balena-cli",
1088
1098
  "pluginName": "balena-cli",
1089
1099
  "pluginType": "core",
1090
1100
  "strict": true,
1091
1101
  "enableJsonFlag": true,
1102
+ "primary": true,
1103
+ "root": true,
1104
+ "offlineCompatible": true,
1105
+ "dockerInfoProperties": [
1106
+ "Containers",
1107
+ "ContainersRunning",
1108
+ "ContainersPaused",
1109
+ "ContainersStopped",
1110
+ "Images",
1111
+ "Driver",
1112
+ "SystemTime",
1113
+ "KernelVersion",
1114
+ "OperatingSystem",
1115
+ "Architecture"
1116
+ ],
1117
+ "dockerVersionProperties": [
1118
+ "Version",
1119
+ "ApiVersion"
1120
+ ],
1121
+ "noDevicesFoundMessage": "Could not find any balenaOS devices on the local network.",
1122
+ "windowsTipMessage": "\n\nNote for Windows users:\n The 'device detect' command relies on the Bonjour service. Check whether Bonjour is\n installed (Control Panel > Programs and Features). If not, you can download\n Bonjour for Windows (included with Bonjour Print Services) from here:\n https://support.apple.com/kb/DL999\n\n After installing Bonjour, restart your PC and run the 'balena device detect' command\n again.",
1092
1123
  "isESM": false,
1093
1124
  "relativePath": [
1094
1125
  "build",
1095
1126
  "commands",
1096
- "env",
1097
- "list.js"
1127
+ "device",
1128
+ "detect.js"
1098
1129
  ]
1099
1130
  },
1100
- "env:rename": {
1131
+ "device:identify": {
1101
1132
  "aliases": [],
1102
1133
  "args": {
1103
- "id": {
1104
- "description": "variable's numeric database ID",
1105
- "name": "id",
1106
- "required": true
1107
- },
1108
- "value": {
1109
- "description": "variable value; if omitted, use value from this process' environment",
1110
- "name": "value",
1134
+ "uuid": {
1135
+ "description": "the uuid of the device to identify",
1136
+ "name": "uuid",
1111
1137
  "required": true
1112
1138
  }
1113
1139
  },
1114
- "description": "Change the value of a config or env var for a fleet, device or service.\n\nChange the value of a configuration or environment variable for a fleet,\ndevice or service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.",
1140
+ "description": "Identify a device.\n\nIdentify a device by making the ACT LED blink (Raspberry Pi).",
1115
1141
  "examples": [
1116
- "$ balena env rename 123123 emacs",
1117
- "$ balena env rename 234234 emacs --service",
1118
- "$ balena env rename 345345 emacs --device",
1119
- "$ balena env rename 456456 emacs --device --service",
1120
- "$ balena env rename 567567 1 --config",
1121
- "$ balena env rename 678678 1 --device --config"
1122
- ],
1123
- "flags": {
1124
- "config": {
1125
- "char": "c",
1126
- "description": "select a configuration variable (may be used together with the --device option)",
1127
- "exclusive": [
1128
- "service"
1129
- ],
1130
- "name": "config",
1131
- "allowNo": false,
1132
- "type": "boolean"
1133
- },
1134
- "device": {
1135
- "char": "d",
1136
- "description": "select a device-specific variable instead of a fleet variable",
1137
- "name": "device",
1138
- "allowNo": false,
1139
- "type": "boolean"
1140
- },
1141
- "service": {
1142
- "char": "s",
1143
- "description": "select a service variable (may be used together with the --device option)",
1144
- "exclusive": [
1145
- "config"
1146
- ],
1147
- "name": "service",
1148
- "allowNo": false,
1149
- "type": "boolean"
1150
- }
1151
- },
1152
- "hasDynamicHelp": false,
1153
- "hiddenAliases": [],
1154
- "id": "env:rename",
1155
- "pluginAlias": "balena-cli",
1156
- "pluginName": "balena-cli",
1157
- "pluginType": "core",
1158
- "strict": true,
1159
- "enableJsonFlag": false,
1160
- "isESM": false,
1161
- "relativePath": [
1162
- "build",
1163
- "commands",
1164
- "env",
1165
- "rename.js"
1166
- ]
1167
- },
1168
- "env:rm": {
1169
- "aliases": [],
1170
- "args": {
1171
- "id": {
1172
- "description": "variable's numeric database ID",
1173
- "name": "id",
1174
- "required": true
1175
- }
1176
- },
1177
- "description": "Remove a config or env var from a fleet, device or service.\n\nRemove a configuration or environment variable from a fleet, device\nor service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.\n\nInteractive confirmation is normally asked before the variable is deleted.\nThe --yes option disables this behavior.",
1178
- "examples": [
1179
- "$ balena env rm 123123",
1180
- "$ balena env rm 234234 --yes",
1181
- "$ balena env rm 345345 --config",
1182
- "$ balena env rm 456456 --service",
1183
- "$ balena env rm 567567 --device",
1184
- "$ balena env rm 678678 --device --config",
1185
- "$ balena env rm 789789 --device --service --yes"
1186
- ],
1187
- "flags": {
1188
- "config": {
1189
- "char": "c",
1190
- "description": "select a configuration variable (may be used together with the --device option)",
1191
- "exclusive": [
1192
- "service"
1193
- ],
1194
- "name": "config",
1195
- "allowNo": false,
1196
- "type": "boolean"
1197
- },
1198
- "device": {
1199
- "char": "d",
1200
- "description": "select a device-specific variable instead of a fleet variable",
1201
- "name": "device",
1202
- "allowNo": false,
1203
- "type": "boolean"
1204
- },
1205
- "service": {
1206
- "char": "s",
1207
- "description": "select a service variable (may be used together with the --device option)",
1208
- "exclusive": [
1209
- "config"
1210
- ],
1211
- "name": "service",
1212
- "allowNo": false,
1213
- "type": "boolean"
1214
- },
1215
- "yes": {
1216
- "char": "y",
1217
- "description": "do not prompt for confirmation before deleting the variable",
1218
- "name": "yes",
1219
- "allowNo": false,
1220
- "type": "boolean"
1221
- }
1222
- },
1223
- "hasDynamicHelp": false,
1224
- "hiddenAliases": [],
1225
- "id": "env:rm",
1226
- "pluginAlias": "balena-cli",
1227
- "pluginName": "balena-cli",
1228
- "pluginType": "core",
1229
- "strict": true,
1230
- "enableJsonFlag": false,
1231
- "isESM": false,
1232
- "relativePath": [
1233
- "build",
1234
- "commands",
1235
- "env",
1236
- "rm.js"
1237
- ]
1238
- },
1239
- "env:set": {
1240
- "aliases": [],
1241
- "args": {
1242
- "name": {
1243
- "description": "environment or config variable name",
1244
- "name": "name",
1245
- "required": true
1246
- },
1247
- "value": {
1248
- "description": "variable value; if omitted, use value from this process' environment",
1249
- "name": "value",
1250
- "required": false
1251
- }
1252
- },
1253
- "description": "Add or update env or config variable to fleets, devices or services.\n\nAdd or update an environment or config variable to one or more fleets, devices or\nservices, as selected by the respective command-line options. Either the\n--fleet or the --device option must be provided, and either may be be\nused alongside the --service option to define a service-specific variable.\n(A service corresponds to a Docker image/container in a microservices fleet.)\nWhen the --service option is used in conjunction with the --device option,\nthe service variable applies to the selected device only. Otherwise, it\napplies to all devices of the selected fleet. If the --service option is\nomitted, the variable applies to all services.\n\nIf VALUE is omitted, the CLI will attempt to use the value of the environment\nvariable of same name in the CLI process' environment. In this case, a warning\nmessage will be printed. Use `--quiet` to suppress it.\n\n'BALENA_' or 'RESIN_' are reserved variable name prefixes used to identify\n\"configuration variables\". Configuration variables control balena platform\nfeatures and are treated specially by balenaOS and the balena supervisor\nrunning on devices. They are also stored differently in the balenaCloud API\ndatabase. Configuration variables cannot be set for specific services,\ntherefore the --service option cannot be used when the variable name starts\nwith a reserved prefix. When defining custom fleet variables, please avoid\nthese reserved prefixes.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
1254
- "examples": [
1255
- "$ balena env set TERM --fleet MyFleet",
1256
- "$ balena env set EDITOR vim -f myorg/myfleet",
1257
- "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2",
1258
- "$ balena env set EDITOR vim --fleet MyFleet --service MyService",
1259
- "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2",
1260
- "$ balena env set EDITOR vim --device 7cf02a6",
1261
- "$ balena env set EDITOR vim --device 7cf02a6,d6f1433",
1262
- "$ balena env set EDITOR vim --device 7cf02a6 --service MyService",
1263
- "$ balena env set EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2"
1264
- ],
1265
- "flags": {
1266
- "fleet": {
1267
- "char": "f",
1268
- "description": "fleet name or slug (preferred)",
1269
- "exclusive": [
1270
- "device"
1271
- ],
1272
- "name": "fleet",
1273
- "hasDynamicHelp": false,
1274
- "multiple": false,
1275
- "type": "option"
1276
- },
1277
- "device": {
1278
- "char": "d",
1279
- "description": "device UUID",
1280
- "exclusive": [
1281
- "fleet"
1282
- ],
1283
- "name": "device",
1284
- "hasDynamicHelp": false,
1285
- "multiple": false,
1286
- "type": "option"
1287
- },
1288
- "quiet": {
1289
- "char": "q",
1290
- "description": "suppress warning messages",
1291
- "name": "quiet",
1292
- "allowNo": false,
1293
- "type": "boolean"
1294
- },
1295
- "service": {
1296
- "char": "s",
1297
- "description": "service name",
1298
- "name": "service",
1299
- "hasDynamicHelp": false,
1300
- "multiple": false,
1301
- "type": "option"
1302
- }
1303
- },
1304
- "hasDynamicHelp": false,
1305
- "hiddenAliases": [],
1306
- "id": "env:set",
1307
- "pluginAlias": "balena-cli",
1308
- "pluginName": "balena-cli",
1309
- "pluginType": "core",
1310
- "strict": false,
1311
- "enableJsonFlag": false,
1312
- "isESM": false,
1313
- "relativePath": [
1314
- "build",
1315
- "commands",
1316
- "env",
1317
- "set.js"
1318
- ]
1319
- },
1320
- "device:deactivate": {
1321
- "aliases": [],
1322
- "args": {
1323
- "uuid": {
1324
- "description": "the UUID of the device to be deactivated",
1325
- "name": "uuid",
1326
- "required": true
1327
- }
1328
- },
1329
- "description": "Deactivate a device.\n\nDeactivate a device.\n\nNote this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` option.",
1330
- "examples": [
1331
- "$ balena device deactivate 7cf02a6",
1332
- "$ balena device deactivate 7cf02a6 --yes"
1333
- ],
1334
- "flags": {
1335
- "yes": {
1336
- "char": "y",
1337
- "description": "answer \"yes\" to all questions (non interactive use)",
1338
- "name": "yes",
1339
- "allowNo": false,
1340
- "type": "boolean"
1341
- }
1342
- },
1343
- "hasDynamicHelp": false,
1344
- "hiddenAliases": [],
1345
- "id": "device:deactivate",
1346
- "pluginAlias": "balena-cli",
1347
- "pluginName": "balena-cli",
1348
- "pluginType": "core",
1349
- "strict": true,
1350
- "enableJsonFlag": false,
1351
- "authenticated": true,
1352
- "isESM": false,
1353
- "relativePath": [
1354
- "build",
1355
- "commands",
1356
- "device",
1357
- "deactivate.js"
1358
- ]
1359
- },
1360
- "device:detect": {
1361
- "aliases": [],
1362
- "args": {},
1363
- "description": "Scan for balenaOS devices on your local network.\n\nScan for balenaOS devices on your local network.\n\nThe output includes device information collected through balenaEngine for\ndevices running a development image of balenaOS. Devices running a production\nimage do not expose balenaEngine (on TCP port 2375), which is why less\ninformation is printed about them.",
1364
- "examples": [
1365
- "$ balena device detect",
1366
- "$ balena device detect --timeout 120",
1367
- "$ balena device detect --verbose"
1368
- ],
1369
- "flags": {
1370
- "json": {
1371
- "description": "Format output as json.",
1372
- "helpGroup": "GLOBAL",
1373
- "name": "json",
1374
- "allowNo": false,
1375
- "type": "boolean"
1376
- },
1377
- "verbose": {
1378
- "char": "v",
1379
- "description": "display full info",
1380
- "name": "verbose",
1381
- "allowNo": false,
1382
- "type": "boolean"
1383
- },
1384
- "timeout": {
1385
- "char": "t",
1386
- "description": "scan timeout in seconds",
1387
- "name": "timeout",
1388
- "hasDynamicHelp": false,
1389
- "multiple": false,
1390
- "type": "option"
1391
- }
1392
- },
1393
- "hasDynamicHelp": false,
1394
- "hiddenAliases": [],
1395
- "id": "device:detect",
1396
- "pluginAlias": "balena-cli",
1397
- "pluginName": "balena-cli",
1398
- "pluginType": "core",
1399
- "strict": true,
1400
- "enableJsonFlag": true,
1401
- "primary": true,
1402
- "root": true,
1403
- "offlineCompatible": true,
1404
- "dockerInfoProperties": [
1405
- "Containers",
1406
- "ContainersRunning",
1407
- "ContainersPaused",
1408
- "ContainersStopped",
1409
- "Images",
1410
- "Driver",
1411
- "SystemTime",
1412
- "KernelVersion",
1413
- "OperatingSystem",
1414
- "Architecture"
1415
- ],
1416
- "dockerVersionProperties": [
1417
- "Version",
1418
- "ApiVersion"
1419
- ],
1420
- "noDevicesFoundMessage": "Could not find any balenaOS devices on the local network.",
1421
- "windowsTipMessage": "\n\nNote for Windows users:\n The 'device detect' command relies on the Bonjour service. Check whether Bonjour is\n installed (Control Panel > Programs and Features). If not, you can download\n Bonjour for Windows (included with Bonjour Print Services) from here:\n https://support.apple.com/kb/DL999\n\n After installing Bonjour, restart your PC and run the 'balena device detect' command\n again.",
1422
- "isESM": false,
1423
- "relativePath": [
1424
- "build",
1425
- "commands",
1426
- "device",
1427
- "detect.js"
1428
- ]
1429
- },
1430
- "device:identify": {
1431
- "aliases": [],
1432
- "args": {
1433
- "uuid": {
1434
- "description": "the uuid of the device to identify",
1435
- "name": "uuid",
1436
- "required": true
1437
- }
1438
- },
1439
- "description": "Identify a device.\n\nIdentify a device by making the ACT LED blink (Raspberry Pi).",
1440
- "examples": [
1441
- "$ balena device identify 23c73a1"
1142
+ "$ balena device identify 23c73a1"
1442
1143
  ],
1443
1144
  "flags": {},
1444
1145
  "hasDynamicHelp": false,
@@ -2461,80 +2162,379 @@
2461
2162
  "required": true
2462
2163
  }
2463
2164
  },
2464
- "description": "Make a device track the fleet's pinned release.\n\nMake a device track the fleet's pinned release.",
2465
- "examples": [
2466
- "$ balena device track-fleet 7cf02a6"
2467
- ],
2468
- "flags": {},
2165
+ "description": "Make a device track the fleet's pinned release.\n\nMake a device track the fleet's pinned release.",
2166
+ "examples": [
2167
+ "$ balena device track-fleet 7cf02a6"
2168
+ ],
2169
+ "flags": {},
2170
+ "hasDynamicHelp": false,
2171
+ "hiddenAliases": [],
2172
+ "id": "device:track-fleet",
2173
+ "pluginAlias": "balena-cli",
2174
+ "pluginName": "balena-cli",
2175
+ "pluginType": "core",
2176
+ "strict": true,
2177
+ "enableJsonFlag": false,
2178
+ "authenticated": true,
2179
+ "isESM": false,
2180
+ "relativePath": [
2181
+ "build",
2182
+ "commands",
2183
+ "device",
2184
+ "track-fleet.js"
2185
+ ]
2186
+ },
2187
+ "device:tunnel": {
2188
+ "aliases": [],
2189
+ "args": {
2190
+ "deviceOrFleet": {
2191
+ "description": "device UUID or fleet name/slug",
2192
+ "name": "deviceOrFleet",
2193
+ "required": true
2194
+ }
2195
+ },
2196
+ "description": "Tunnel local ports to your balenaOS device.\n\nUse this command to open local TCP ports that tunnel to listening sockets in a\nbalenaOS device.\n\nFor example, this command could be used to expose the ssh server of a balenaOS\ndevice (port number 22222) on the local machine, or to expose a web server\nrunning on the device. The port numbers do not have be the same between the\ndevice and the local machine, and multiple ports may be tunneled in a single\ncommand line.\n\nPort mappings are specified in the format: <remotePort>[:[localIP:]localPort]\nlocalIP defaults to 'localhost', and localPort defaults to the specified\nremotePort value.\n\nNote: the -p (--port) flag must be provided at the end of the command line,\nas per examples.\n\nIn the case of openBalena, the tunnel command in CLI v12.38.5 or later requires\nopenBalena v3.1.2 or later. Older CLI versions work with older openBalena\nversions.",
2197
+ "examples": [
2198
+ "# map remote port 22222 to localhost:22222",
2199
+ "$ balena device tunnel myFleet -p 22222",
2200
+ "",
2201
+ "# map remote port 22222 to localhost:222",
2202
+ "$ balena device tunnel 2ead211 -p 22222:222",
2203
+ "",
2204
+ "# map remote port 22222 to any address on your host machine, port 22222",
2205
+ "$ balena device tunnel 1546690 -p 22222:0.0.0.0",
2206
+ "",
2207
+ "# map remote port 22222 to any address on your host machine, port 222",
2208
+ "$ balena device tunnel myFleet -p 22222:0.0.0.0:222",
2209
+ "",
2210
+ "# multiple port tunnels can be specified at any one time",
2211
+ "$ balena device tunnel myFleet -p 8080:3000 -p 8081:9000"
2212
+ ],
2213
+ "flags": {
2214
+ "port": {
2215
+ "char": "p",
2216
+ "description": "port mapping in the format <remotePort>[:[localIP:]localPort]",
2217
+ "name": "port",
2218
+ "hasDynamicHelp": false,
2219
+ "multiple": true,
2220
+ "type": "option"
2221
+ }
2222
+ },
2223
+ "hasDynamicHelp": false,
2224
+ "hiddenAliases": [],
2225
+ "id": "device:tunnel",
2226
+ "pluginAlias": "balena-cli",
2227
+ "pluginName": "balena-cli",
2228
+ "pluginType": "core",
2229
+ "strict": true,
2230
+ "enableJsonFlag": false,
2231
+ "primary": true,
2232
+ "authenticated": true,
2233
+ "isESM": false,
2234
+ "relativePath": [
2235
+ "build",
2236
+ "commands",
2237
+ "device",
2238
+ "tunnel.js"
2239
+ ]
2240
+ },
2241
+ "env:list": {
2242
+ "aliases": [],
2243
+ "args": {},
2244
+ "description": "List the environment or config variables of a fleet, device or service.\n\nList the environment or configuration variables of a fleet, device or\nservice, as selected by the respective command-line options. (A service\ncorresponds to a Docker image/container in a microservices fleet.)\n\nThe results include fleet-wide (multiple devices), device-specific (multiple\nservices on a specific device) and service-specific variables that apply to the\nselected fleet, device or service. It can be thought of as including inherited\nvariables; for example, a service inherits device-wide variables, and a device\ninherits fleet-wide variables.\n\nThe printed output may include DEVICE and/or SERVICE columns to distinguish\nbetween fleet-wide, device-specific and service-specific variables.\nAn asterisk in these columns indicates that the variable applies to\n\"all devices\" or \"all services\".\n\nThe --config option is used to list \"configuration variables\" that control\nbalena platform features, as opposed to custom environment variables defined\nby the user. The --config and the --service options are mutually exclusive\nbecause configuration variables cannot be set for specific services.\n\nWhen --json is used, an empty JSON array ([]) is printed instead of an error \nmessage when no variables exist for the given query. When querying variables \nfor a device, note that the fleet name may be null in JSON output \n(or 'N/A' in tabular output) if the fleet that the device belonged to is no \nlonger accessible by the current user (for example, in case the current user \nwas removed from the fleet by the fleet's owner).\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
2245
+ "examples": [
2246
+ "$ balena env list --fleet myorg/myfleet",
2247
+ "$ balena env list --fleet MyFleet --service MyService",
2248
+ "$ balena env list --fleet MyFleet --config",
2249
+ "$ balena env list --device 7cf02a6",
2250
+ "$ balena env list --device 7cf02a6 --service MyService"
2251
+ ],
2252
+ "flags": {
2253
+ "json": {
2254
+ "description": "Format output as json.",
2255
+ "helpGroup": "GLOBAL",
2256
+ "name": "json",
2257
+ "allowNo": false,
2258
+ "type": "boolean"
2259
+ },
2260
+ "fleet": {
2261
+ "char": "f",
2262
+ "description": "fleet name or slug (preferred)",
2263
+ "exclusive": [
2264
+ "device"
2265
+ ],
2266
+ "name": "fleet",
2267
+ "hasDynamicHelp": false,
2268
+ "multiple": false,
2269
+ "type": "option"
2270
+ },
2271
+ "config": {
2272
+ "char": "c",
2273
+ "description": "show configuration variables only",
2274
+ "exclusive": [
2275
+ "service"
2276
+ ],
2277
+ "name": "config",
2278
+ "allowNo": false,
2279
+ "type": "boolean"
2280
+ },
2281
+ "device": {
2282
+ "char": "d",
2283
+ "description": "device UUID",
2284
+ "exclusive": [
2285
+ "fleet"
2286
+ ],
2287
+ "name": "device",
2288
+ "hasDynamicHelp": false,
2289
+ "multiple": false,
2290
+ "type": "option"
2291
+ },
2292
+ "service": {
2293
+ "char": "s",
2294
+ "description": "service name",
2295
+ "exclusive": [
2296
+ "config"
2297
+ ],
2298
+ "name": "service",
2299
+ "hasDynamicHelp": false,
2300
+ "multiple": false,
2301
+ "type": "option"
2302
+ }
2303
+ },
2304
+ "hasDynamicHelp": false,
2305
+ "hiddenAliases": [],
2306
+ "id": "env:list",
2307
+ "pluginAlias": "balena-cli",
2308
+ "pluginName": "balena-cli",
2309
+ "pluginType": "core",
2310
+ "strict": true,
2311
+ "enableJsonFlag": true,
2312
+ "isESM": false,
2313
+ "relativePath": [
2314
+ "build",
2315
+ "commands",
2316
+ "env",
2317
+ "list.js"
2318
+ ]
2319
+ },
2320
+ "env:rename": {
2321
+ "aliases": [],
2322
+ "args": {
2323
+ "id": {
2324
+ "description": "variable's numeric database ID",
2325
+ "name": "id",
2326
+ "required": true
2327
+ },
2328
+ "value": {
2329
+ "description": "variable value; if omitted, use value from this process' environment",
2330
+ "name": "value",
2331
+ "required": true
2332
+ }
2333
+ },
2334
+ "description": "Change the value of a config or env var for a fleet, device or service.\n\nChange the value of a configuration or environment variable for a fleet,\ndevice or service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.",
2335
+ "examples": [
2336
+ "$ balena env rename 123123 emacs",
2337
+ "$ balena env rename 234234 emacs --service",
2338
+ "$ balena env rename 345345 emacs --device",
2339
+ "$ balena env rename 456456 emacs --device --service",
2340
+ "$ balena env rename 567567 1 --config",
2341
+ "$ balena env rename 678678 1 --device --config"
2342
+ ],
2343
+ "flags": {
2344
+ "config": {
2345
+ "char": "c",
2346
+ "description": "select a configuration variable (may be used together with the --device option)",
2347
+ "exclusive": [
2348
+ "service"
2349
+ ],
2350
+ "name": "config",
2351
+ "allowNo": false,
2352
+ "type": "boolean"
2353
+ },
2354
+ "device": {
2355
+ "char": "d",
2356
+ "description": "select a device-specific variable instead of a fleet variable",
2357
+ "name": "device",
2358
+ "allowNo": false,
2359
+ "type": "boolean"
2360
+ },
2361
+ "service": {
2362
+ "char": "s",
2363
+ "description": "select a service variable (may be used together with the --device option)",
2364
+ "exclusive": [
2365
+ "config"
2366
+ ],
2367
+ "name": "service",
2368
+ "allowNo": false,
2369
+ "type": "boolean"
2370
+ }
2371
+ },
2372
+ "hasDynamicHelp": false,
2373
+ "hiddenAliases": [],
2374
+ "id": "env:rename",
2375
+ "pluginAlias": "balena-cli",
2376
+ "pluginName": "balena-cli",
2377
+ "pluginType": "core",
2378
+ "strict": true,
2379
+ "enableJsonFlag": false,
2380
+ "isESM": false,
2381
+ "relativePath": [
2382
+ "build",
2383
+ "commands",
2384
+ "env",
2385
+ "rename.js"
2386
+ ]
2387
+ },
2388
+ "env:rm": {
2389
+ "aliases": [],
2390
+ "args": {
2391
+ "id": {
2392
+ "description": "variable's numeric database ID",
2393
+ "name": "id",
2394
+ "required": true
2395
+ }
2396
+ },
2397
+ "description": "Remove a config or env var from a fleet, device or service.\n\nRemove a configuration or environment variable from a fleet, device\nor service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.\n\nInteractive confirmation is normally asked before the variable is deleted.\nThe --yes option disables this behavior.",
2398
+ "examples": [
2399
+ "$ balena env rm 123123",
2400
+ "$ balena env rm 234234 --yes",
2401
+ "$ balena env rm 345345 --config",
2402
+ "$ balena env rm 456456 --service",
2403
+ "$ balena env rm 567567 --device",
2404
+ "$ balena env rm 678678 --device --config",
2405
+ "$ balena env rm 789789 --device --service --yes"
2406
+ ],
2407
+ "flags": {
2408
+ "config": {
2409
+ "char": "c",
2410
+ "description": "select a configuration variable (may be used together with the --device option)",
2411
+ "exclusive": [
2412
+ "service"
2413
+ ],
2414
+ "name": "config",
2415
+ "allowNo": false,
2416
+ "type": "boolean"
2417
+ },
2418
+ "device": {
2419
+ "char": "d",
2420
+ "description": "select a device-specific variable instead of a fleet variable",
2421
+ "name": "device",
2422
+ "allowNo": false,
2423
+ "type": "boolean"
2424
+ },
2425
+ "service": {
2426
+ "char": "s",
2427
+ "description": "select a service variable (may be used together with the --device option)",
2428
+ "exclusive": [
2429
+ "config"
2430
+ ],
2431
+ "name": "service",
2432
+ "allowNo": false,
2433
+ "type": "boolean"
2434
+ },
2435
+ "yes": {
2436
+ "char": "y",
2437
+ "description": "do not prompt for confirmation before deleting the variable",
2438
+ "name": "yes",
2439
+ "allowNo": false,
2440
+ "type": "boolean"
2441
+ }
2442
+ },
2469
2443
  "hasDynamicHelp": false,
2470
2444
  "hiddenAliases": [],
2471
- "id": "device:track-fleet",
2445
+ "id": "env:rm",
2472
2446
  "pluginAlias": "balena-cli",
2473
2447
  "pluginName": "balena-cli",
2474
2448
  "pluginType": "core",
2475
2449
  "strict": true,
2476
2450
  "enableJsonFlag": false,
2477
- "authenticated": true,
2478
2451
  "isESM": false,
2479
2452
  "relativePath": [
2480
2453
  "build",
2481
2454
  "commands",
2482
- "device",
2483
- "track-fleet.js"
2455
+ "env",
2456
+ "rm.js"
2484
2457
  ]
2485
2458
  },
2486
- "device:tunnel": {
2459
+ "env:set": {
2487
2460
  "aliases": [],
2488
2461
  "args": {
2489
- "deviceOrFleet": {
2490
- "description": "device UUID or fleet name/slug",
2491
- "name": "deviceOrFleet",
2462
+ "name": {
2463
+ "description": "environment or config variable name",
2464
+ "name": "name",
2492
2465
  "required": true
2466
+ },
2467
+ "value": {
2468
+ "description": "variable value; if omitted, use value from this process' environment",
2469
+ "name": "value",
2470
+ "required": false
2493
2471
  }
2494
2472
  },
2495
- "description": "Tunnel local ports to your balenaOS device.\n\nUse this command to open local TCP ports that tunnel to listening sockets in a\nbalenaOS device.\n\nFor example, this command could be used to expose the ssh server of a balenaOS\ndevice (port number 22222) on the local machine, or to expose a web server\nrunning on the device. The port numbers do not have be the same between the\ndevice and the local machine, and multiple ports may be tunneled in a single\ncommand line.\n\nPort mappings are specified in the format: <remotePort>[:[localIP:]localPort]\nlocalIP defaults to 'localhost', and localPort defaults to the specified\nremotePort value.\n\nNote: the -p (--port) flag must be provided at the end of the command line,\nas per examples.\n\nIn the case of openBalena, the tunnel command in CLI v12.38.5 or later requires\nopenBalena v3.1.2 or later. Older CLI versions work with older openBalena\nversions.",
2473
+ "description": "Add or update env or config variable to fleets, devices or services.\n\nAdd or update an environment or config variable to one or more fleets, devices or\nservices, as selected by the respective command-line options. Either the\n--fleet or the --device option must be provided, and either may be be\nused alongside the --service option to define a service-specific variable.\n(A service corresponds to a Docker image/container in a microservices fleet.)\nWhen the --service option is used in conjunction with the --device option,\nthe service variable applies to the selected device only. Otherwise, it\napplies to all devices of the selected fleet. If the --service option is\nomitted, the variable applies to all services.\n\nIf VALUE is omitted, the CLI will attempt to use the value of the environment\nvariable of same name in the CLI process' environment. In this case, a warning\nmessage will be printed. Use `--quiet` to suppress it.\n\n'BALENA_' or 'RESIN_' are reserved variable name prefixes used to identify\n\"configuration variables\". Configuration variables control balena platform\nfeatures and are treated specially by balenaOS and the balena supervisor\nrunning on devices. They are also stored differently in the balenaCloud API\ndatabase. Configuration variables cannot be set for specific services,\ntherefore the --service option cannot be used when the variable name starts\nwith a reserved prefix. When defining custom fleet variables, please avoid\nthese reserved prefixes.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
2496
2474
  "examples": [
2497
- "# map remote port 22222 to localhost:22222",
2498
- "$ balena device tunnel myFleet -p 22222",
2499
- "",
2500
- "# map remote port 22222 to localhost:222",
2501
- "$ balena device tunnel 2ead211 -p 22222:222",
2502
- "",
2503
- "# map remote port 22222 to any address on your host machine, port 22222",
2504
- "$ balena device tunnel 1546690 -p 22222:0.0.0.0",
2505
- "",
2506
- "# map remote port 22222 to any address on your host machine, port 222",
2507
- "$ balena device tunnel myFleet -p 22222:0.0.0.0:222",
2508
- "",
2509
- "# multiple port tunnels can be specified at any one time",
2510
- "$ balena device tunnel myFleet -p 8080:3000 -p 8081:9000"
2475
+ "$ balena env set TERM --fleet MyFleet",
2476
+ "$ balena env set EDITOR vim -f myorg/myfleet",
2477
+ "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2",
2478
+ "$ balena env set EDITOR vim --fleet MyFleet --service MyService",
2479
+ "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2",
2480
+ "$ balena env set EDITOR vim --device 7cf02a6",
2481
+ "$ balena env set EDITOR vim --device 7cf02a6,d6f1433",
2482
+ "$ balena env set EDITOR vim --device 7cf02a6 --service MyService",
2483
+ "$ balena env set EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2"
2511
2484
  ],
2512
2485
  "flags": {
2513
- "port": {
2514
- "char": "p",
2515
- "description": "port mapping in the format <remotePort>[:[localIP:]localPort]",
2516
- "name": "port",
2486
+ "fleet": {
2487
+ "char": "f",
2488
+ "description": "fleet name or slug (preferred)",
2489
+ "exclusive": [
2490
+ "device"
2491
+ ],
2492
+ "name": "fleet",
2517
2493
  "hasDynamicHelp": false,
2518
- "multiple": true,
2494
+ "multiple": false,
2495
+ "type": "option"
2496
+ },
2497
+ "device": {
2498
+ "char": "d",
2499
+ "description": "device UUID",
2500
+ "exclusive": [
2501
+ "fleet"
2502
+ ],
2503
+ "name": "device",
2504
+ "hasDynamicHelp": false,
2505
+ "multiple": false,
2506
+ "type": "option"
2507
+ },
2508
+ "quiet": {
2509
+ "char": "q",
2510
+ "description": "suppress warning messages",
2511
+ "name": "quiet",
2512
+ "allowNo": false,
2513
+ "type": "boolean"
2514
+ },
2515
+ "service": {
2516
+ "char": "s",
2517
+ "description": "service name",
2518
+ "name": "service",
2519
+ "hasDynamicHelp": false,
2520
+ "multiple": false,
2519
2521
  "type": "option"
2520
2522
  }
2521
2523
  },
2522
2524
  "hasDynamicHelp": false,
2523
2525
  "hiddenAliases": [],
2524
- "id": "device:tunnel",
2526
+ "id": "env:set",
2525
2527
  "pluginAlias": "balena-cli",
2526
2528
  "pluginName": "balena-cli",
2527
2529
  "pluginType": "core",
2528
- "strict": true,
2530
+ "strict": false,
2529
2531
  "enableJsonFlag": false,
2530
- "primary": true,
2531
- "authenticated": true,
2532
2532
  "isESM": false,
2533
2533
  "relativePath": [
2534
2534
  "build",
2535
2535
  "commands",
2536
- "device",
2537
- "tunnel.js"
2536
+ "env",
2537
+ "set.js"
2538
2538
  ]
2539
2539
  },
2540
2540
  "fleet:create": {
@@ -2916,172 +2916,57 @@
2916
2916
  "osinit.js"
2917
2917
  ]
2918
2918
  },
2919
- "leave": {
2920
- "aliases": [],
2921
- "args": {
2922
- "deviceIpOrHostname": {
2923
- "description": "the device IP or hostname",
2924
- "name": "deviceIpOrHostname"
2925
- }
2926
- },
2927
- "description": "Remove a local device from its balena fleet.\n\nRemove a local device from its balena fleet, causing the device to\n\"leave\" the server it is provisioned on. This effectively makes the device\n\"unmanaged\". The device must be running balenaOS.\n\nThe device entry on the server is preserved after running this command,\nso the device can subsequently re-join the server if needed.\n\nIf you don't specify a device hostname or IP, this command will automatically\nscan the local network for balenaOS devices and prompt you to select one\nfrom an interactive picker. This may require administrator/root privileges.",
2928
- "examples": [
2929
- "$ balena leave",
2930
- "$ balena leave balena.local",
2931
- "$ balena leave 192.168.1.25"
2932
- ],
2933
- "flags": {},
2934
- "hasDynamicHelp": false,
2935
- "hiddenAliases": [],
2936
- "id": "leave",
2937
- "pluginAlias": "balena-cli",
2938
- "pluginName": "balena-cli",
2939
- "pluginType": "core",
2940
- "strict": true,
2941
- "enableJsonFlag": false,
2942
- "authenticated": true,
2943
- "primary": true,
2944
- "isESM": false,
2945
- "relativePath": [
2946
- "build",
2947
- "commands",
2948
- "leave",
2949
- "index.js"
2950
- ]
2951
- },
2952
- "join": {
2953
- "aliases": [],
2954
- "args": {
2955
- "deviceIpOrHostname": {
2956
- "description": "the IP or hostname of device",
2957
- "name": "deviceIpOrHostname"
2958
- }
2959
- },
2960
- "description": "Move a local device to a fleet on another balena server.\n\nMove a local device to a fleet on another balena server, causing\nthe device to \"join\" the new server. The device must be running balenaOS.\n\nFor example, you could provision a device against an openBalena installation\nwhere you perform end-to-end tests and then move it to balenaCloud when it's\nready for production.\n\nTo move a device between fleets on the same server, use the\n`balena device move` command instead of `balena join`.\n\nIf you don't specify a device hostname or IP, this command will automatically\nscan the local network for balenaOS devices and prompt you to select one\nfrom an interactive picker. This may require administrator/root privileges.\nLikewise, if the fleet option is not provided then a picker will be shown.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
2961
- "examples": [
2962
- "$ balena join",
2963
- "$ balena join balena.local",
2964
- "$ balena join balena.local --fleet MyFleet",
2965
- "$ balena join balena.local -f myorg/myfleet",
2966
- "$ balena join 192.168.1.25",
2967
- "$ balena join 192.168.1.25 --fleet MyFleet"
2968
- ],
2969
- "flags": {
2970
- "fleet": {
2971
- "char": "f",
2972
- "description": "fleet name or slug (preferred)",
2973
- "name": "fleet",
2974
- "hasDynamicHelp": false,
2975
- "multiple": false,
2976
- "type": "option"
2977
- },
2978
- "pollInterval": {
2979
- "char": "i",
2980
- "description": "the interval in minutes to check for updates",
2981
- "name": "pollInterval",
2982
- "hasDynamicHelp": false,
2983
- "multiple": false,
2984
- "type": "option"
2985
- }
2986
- },
2987
- "hasDynamicHelp": false,
2988
- "hiddenAliases": [],
2989
- "id": "join",
2990
- "pluginAlias": "balena-cli",
2991
- "pluginName": "balena-cli",
2992
- "pluginType": "core",
2993
- "strict": true,
2994
- "enableJsonFlag": false,
2995
- "authenticated": true,
2996
- "primary": true,
2997
- "isESM": false,
2998
- "relativePath": [
2999
- "build",
3000
- "commands",
3001
- "join",
3002
- "index.js"
3003
- ]
3004
- },
3005
- "local:configure": {
3006
- "aliases": [],
3007
- "args": {
3008
- "target": {
3009
- "description": "path of drive or image to configure",
3010
- "name": "target",
3011
- "required": true
3012
- }
3013
- },
3014
- "description": "(Re)configure a balenaOS drive or image.\n\nConfigure or reconfigure a balenaOS drive or image.",
3015
- "examples": [
3016
- "$ balena local configure /dev/sdc",
3017
- "$ balena local configure path/to/image.img"
3018
- ],
3019
- "flags": {},
3020
- "hasDynamicHelp": false,
3021
- "hiddenAliases": [],
3022
- "id": "local:configure",
3023
- "pluginAlias": "balena-cli",
3024
- "pluginName": "balena-cli",
3025
- "pluginType": "core",
3026
- "strict": true,
3027
- "enableJsonFlag": false,
3028
- "root": true,
3029
- "offlineCompatible": true,
3030
- "isESM": false,
3031
- "relativePath": [
3032
- "build",
3033
- "commands",
3034
- "local",
3035
- "configure.js"
3036
- ]
3037
- },
3038
- "local:flash": {
2919
+ "join": {
3039
2920
  "aliases": [],
3040
2921
  "args": {
3041
- "image": {
3042
- "description": "path to OS image",
3043
- "name": "image",
3044
- "required": true
2922
+ "deviceIpOrHostname": {
2923
+ "description": "the IP or hostname of device",
2924
+ "name": "deviceIpOrHostname"
3045
2925
  }
3046
2926
  },
3047
- "description": "Flash an image to a drive.\n\nFlash a balenaOS image to a drive.\nImage file may be one of: .img|.zip|.gz|.bz2|.xz\n\nIf --drive is not specified, then it will interactively\nshow a list of available drives for selection.",
2927
+ "description": "Move a local device to a fleet on another balena server.\n\nMove a local device to a fleet on another balena server, causing\nthe device to \"join\" the new server. The device must be running balenaOS.\n\nFor example, you could provision a device against an openBalena installation\nwhere you perform end-to-end tests and then move it to balenaCloud when it's\nready for production.\n\nTo move a device between fleets on the same server, use the\n`balena device move` command instead of `balena join`.\n\nIf you don't specify a device hostname or IP, this command will automatically\nscan the local network for balenaOS devices and prompt you to select one\nfrom an interactive picker. This may require administrator/root privileges.\nLikewise, if the fleet option is not provided then a picker will be shown.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
3048
2928
  "examples": [
3049
- "$ balena local flash path/to/balenaos.img",
3050
- "$ balena local flash path/to/balenaos.img --drive /dev/disk2",
3051
- "$ balena local flash path/to/balenaos.img --drive /dev/disk2 --yes"
2929
+ "$ balena join",
2930
+ "$ balena join balena.local",
2931
+ "$ balena join balena.local --fleet MyFleet",
2932
+ "$ balena join balena.local -f myorg/myfleet",
2933
+ "$ balena join 192.168.1.25",
2934
+ "$ balena join 192.168.1.25 --fleet MyFleet"
3052
2935
  ],
3053
2936
  "flags": {
3054
- "drive": {
3055
- "char": "d",
3056
- "description": "the drive to write the image to, eg. `/dev/sdb` or `/dev/mmcblk0`.\nCareful with this as you can erase your hard drive.\nCheck `balena util available-drives` for available options.",
3057
- "name": "drive",
2937
+ "fleet": {
2938
+ "char": "f",
2939
+ "description": "fleet name or slug (preferred)",
2940
+ "name": "fleet",
3058
2941
  "hasDynamicHelp": false,
3059
2942
  "multiple": false,
3060
2943
  "type": "option"
3061
2944
  },
3062
- "yes": {
3063
- "char": "y",
3064
- "description": "answer \"yes\" to all questions (non interactive use)",
3065
- "name": "yes",
3066
- "allowNo": false,
3067
- "type": "boolean"
2945
+ "pollInterval": {
2946
+ "char": "i",
2947
+ "description": "the interval in minutes to check for updates",
2948
+ "name": "pollInterval",
2949
+ "hasDynamicHelp": false,
2950
+ "multiple": false,
2951
+ "type": "option"
3068
2952
  }
3069
2953
  },
3070
2954
  "hasDynamicHelp": false,
3071
2955
  "hiddenAliases": [],
3072
- "id": "local:flash",
2956
+ "id": "join",
3073
2957
  "pluginAlias": "balena-cli",
3074
2958
  "pluginName": "balena-cli",
3075
2959
  "pluginType": "core",
3076
2960
  "strict": true,
3077
2961
  "enableJsonFlag": false,
3078
- "offlineCompatible": true,
2962
+ "authenticated": true,
2963
+ "primary": true,
3079
2964
  "isESM": false,
3080
2965
  "relativePath": [
3081
2966
  "build",
3082
2967
  "commands",
3083
- "local",
3084
- "flash.js"
2968
+ "join",
2969
+ "index.js"
3085
2970
  ]
3086
2971
  },
3087
2972
  "login": {
@@ -3209,6 +3094,121 @@
3209
3094
  "index.js"
3210
3095
  ]
3211
3096
  },
3097
+ "local:configure": {
3098
+ "aliases": [],
3099
+ "args": {
3100
+ "target": {
3101
+ "description": "path of drive or image to configure",
3102
+ "name": "target",
3103
+ "required": true
3104
+ }
3105
+ },
3106
+ "description": "(Re)configure a balenaOS drive or image.\n\nConfigure or reconfigure a balenaOS drive or image.",
3107
+ "examples": [
3108
+ "$ balena local configure /dev/sdc",
3109
+ "$ balena local configure path/to/image.img"
3110
+ ],
3111
+ "flags": {},
3112
+ "hasDynamicHelp": false,
3113
+ "hiddenAliases": [],
3114
+ "id": "local:configure",
3115
+ "pluginAlias": "balena-cli",
3116
+ "pluginName": "balena-cli",
3117
+ "pluginType": "core",
3118
+ "strict": true,
3119
+ "enableJsonFlag": false,
3120
+ "root": true,
3121
+ "offlineCompatible": true,
3122
+ "isESM": false,
3123
+ "relativePath": [
3124
+ "build",
3125
+ "commands",
3126
+ "local",
3127
+ "configure.js"
3128
+ ]
3129
+ },
3130
+ "local:flash": {
3131
+ "aliases": [],
3132
+ "args": {
3133
+ "image": {
3134
+ "description": "path to OS image",
3135
+ "name": "image",
3136
+ "required": true
3137
+ }
3138
+ },
3139
+ "description": "Flash an image to a drive.\n\nFlash a balenaOS image to a drive.\nImage file may be one of: .img|.zip|.gz|.bz2|.xz\n\nIf --drive is not specified, then it will interactively\nshow a list of available drives for selection.",
3140
+ "examples": [
3141
+ "$ balena local flash path/to/balenaos.img",
3142
+ "$ balena local flash path/to/balenaos.img --drive /dev/disk2",
3143
+ "$ balena local flash path/to/balenaos.img --drive /dev/disk2 --yes"
3144
+ ],
3145
+ "flags": {
3146
+ "drive": {
3147
+ "char": "d",
3148
+ "description": "the drive to write the image to, eg. `/dev/sdb` or `/dev/mmcblk0`.\nCareful with this as you can erase your hard drive.\nCheck `balena util available-drives` for available options.",
3149
+ "name": "drive",
3150
+ "hasDynamicHelp": false,
3151
+ "multiple": false,
3152
+ "type": "option"
3153
+ },
3154
+ "yes": {
3155
+ "char": "y",
3156
+ "description": "answer \"yes\" to all questions (non interactive use)",
3157
+ "name": "yes",
3158
+ "allowNo": false,
3159
+ "type": "boolean"
3160
+ }
3161
+ },
3162
+ "hasDynamicHelp": false,
3163
+ "hiddenAliases": [],
3164
+ "id": "local:flash",
3165
+ "pluginAlias": "balena-cli",
3166
+ "pluginName": "balena-cli",
3167
+ "pluginType": "core",
3168
+ "strict": true,
3169
+ "enableJsonFlag": false,
3170
+ "offlineCompatible": true,
3171
+ "isESM": false,
3172
+ "relativePath": [
3173
+ "build",
3174
+ "commands",
3175
+ "local",
3176
+ "flash.js"
3177
+ ]
3178
+ },
3179
+ "leave": {
3180
+ "aliases": [],
3181
+ "args": {
3182
+ "deviceIpOrHostname": {
3183
+ "description": "the device IP or hostname",
3184
+ "name": "deviceIpOrHostname"
3185
+ }
3186
+ },
3187
+ "description": "Remove a local device from its balena fleet.\n\nRemove a local device from its balena fleet, causing the device to\n\"leave\" the server it is provisioned on. This effectively makes the device\n\"unmanaged\". The device must be running balenaOS.\n\nThe device entry on the server is preserved after running this command,\nso the device can subsequently re-join the server if needed.\n\nIf you don't specify a device hostname or IP, this command will automatically\nscan the local network for balenaOS devices and prompt you to select one\nfrom an interactive picker. This may require administrator/root privileges.",
3188
+ "examples": [
3189
+ "$ balena leave",
3190
+ "$ balena leave balena.local",
3191
+ "$ balena leave 192.168.1.25"
3192
+ ],
3193
+ "flags": {},
3194
+ "hasDynamicHelp": false,
3195
+ "hiddenAliases": [],
3196
+ "id": "leave",
3197
+ "pluginAlias": "balena-cli",
3198
+ "pluginName": "balena-cli",
3199
+ "pluginType": "core",
3200
+ "strict": true,
3201
+ "enableJsonFlag": false,
3202
+ "authenticated": true,
3203
+ "primary": true,
3204
+ "isESM": false,
3205
+ "relativePath": [
3206
+ "build",
3207
+ "commands",
3208
+ "leave",
3209
+ "index.js"
3210
+ ]
3211
+ },
3212
3212
  "logout": {
3213
3213
  "aliases": [],
3214
3214
  "args": {},
@@ -4074,30 +4074,6 @@
4074
4074
  "validate.js"
4075
4075
  ]
4076
4076
  },
4077
- "settings": {
4078
- "aliases": [],
4079
- "args": {},
4080
- "description": "Print current settings.\n\nUse this command to display the current balena CLI settings.",
4081
- "examples": [
4082
- "$ balena settings"
4083
- ],
4084
- "flags": {},
4085
- "hasDynamicHelp": false,
4086
- "hiddenAliases": [],
4087
- "id": "settings",
4088
- "pluginAlias": "balena-cli",
4089
- "pluginName": "balena-cli",
4090
- "pluginType": "core",
4091
- "strict": true,
4092
- "enableJsonFlag": false,
4093
- "isESM": false,
4094
- "relativePath": [
4095
- "build",
4096
- "commands",
4097
- "settings",
4098
- "index.js"
4099
- ]
4100
- },
4101
4077
  "release-asset:delete": {
4102
4078
  "aliases": [],
4103
4079
  "args": {
@@ -4313,6 +4289,30 @@
4313
4289
  "upload.js"
4314
4290
  ]
4315
4291
  },
4292
+ "settings": {
4293
+ "aliases": [],
4294
+ "args": {},
4295
+ "description": "Print current settings.\n\nUse this command to display the current balena CLI settings.",
4296
+ "examples": [
4297
+ "$ balena settings"
4298
+ ],
4299
+ "flags": {},
4300
+ "hasDynamicHelp": false,
4301
+ "hiddenAliases": [],
4302
+ "id": "settings",
4303
+ "pluginAlias": "balena-cli",
4304
+ "pluginName": "balena-cli",
4305
+ "pluginType": "core",
4306
+ "strict": true,
4307
+ "enableJsonFlag": false,
4308
+ "isESM": false,
4309
+ "relativePath": [
4310
+ "build",
4311
+ "commands",
4312
+ "settings",
4313
+ "index.js"
4314
+ ]
4315
+ },
4316
4316
  "support": {
4317
4317
  "aliases": [],
4318
4318
  "args": {
@@ -4509,6 +4509,28 @@
4509
4509
  "rm.js"
4510
4510
  ]
4511
4511
  },
4512
+ "util:available-drives": {
4513
+ "aliases": [],
4514
+ "args": {},
4515
+ "description": "List available drives.\n\nList available drives which are usable for writing an OS image to.\nDoes not list system drives.",
4516
+ "flags": {},
4517
+ "hasDynamicHelp": false,
4518
+ "hiddenAliases": [],
4519
+ "id": "util:available-drives",
4520
+ "pluginAlias": "balena-cli",
4521
+ "pluginName": "balena-cli",
4522
+ "pluginType": "core",
4523
+ "strict": true,
4524
+ "enableJsonFlag": false,
4525
+ "offlineCompatible": true,
4526
+ "isESM": false,
4527
+ "relativePath": [
4528
+ "build",
4529
+ "commands",
4530
+ "util",
4531
+ "available-drives.js"
4532
+ ]
4533
+ },
4512
4534
  "tag:list": {
4513
4535
  "aliases": [],
4514
4536
  "args": {},
@@ -4753,29 +4775,7 @@
4753
4775
  "whoami",
4754
4776
  "index.js"
4755
4777
  ]
4756
- },
4757
- "util:available-drives": {
4758
- "aliases": [],
4759
- "args": {},
4760
- "description": "List available drives.\n\nList available drives which are usable for writing an OS image to.\nDoes not list system drives.",
4761
- "flags": {},
4762
- "hasDynamicHelp": false,
4763
- "hiddenAliases": [],
4764
- "id": "util:available-drives",
4765
- "pluginAlias": "balena-cli",
4766
- "pluginName": "balena-cli",
4767
- "pluginType": "core",
4768
- "strict": true,
4769
- "enableJsonFlag": false,
4770
- "offlineCompatible": true,
4771
- "isESM": false,
4772
- "relativePath": [
4773
- "build",
4774
- "commands",
4775
- "util",
4776
- "available-drives.js"
4777
- ]
4778
4778
  }
4779
4779
  },
4780
- "version": "23.2.12"
4780
+ "version": "23.2.13"
4781
4781
  }