balena-cli 23.2.15-build-update-compose-7-3-0-97bf26975807627a264274621ffcf8380aea838e-1 → 23.2.15-build-mockttp-6cb0abaec2656b73d1230e92f9e8a907f95bef98-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,255 +1093,191 @@
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"
1142
+ "$ balena device identify 23c73a1"
1122
1143
  ],
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
- },
1144
+ "flags": {},
1152
1145
  "hasDynamicHelp": false,
1153
1146
  "hiddenAliases": [],
1154
- "id": "env:rename",
1147
+ "id": "device:identify",
1155
1148
  "pluginAlias": "balena-cli",
1156
1149
  "pluginName": "balena-cli",
1157
1150
  "pluginType": "core",
1158
1151
  "strict": true,
1159
1152
  "enableJsonFlag": false,
1153
+ "authenticated": true,
1160
1154
  "isESM": false,
1161
1155
  "relativePath": [
1162
1156
  "build",
1163
1157
  "commands",
1164
- "env",
1165
- "rename.js"
1158
+ "device",
1159
+ "identify.js"
1166
1160
  ]
1167
1161
  },
1168
- "env:rm": {
1162
+ "device": {
1169
1163
  "aliases": [],
1170
1164
  "args": {
1171
- "id": {
1172
- "description": "variable's numeric database ID",
1173
- "name": "id",
1165
+ "uuid": {
1166
+ "description": "the device uuid",
1167
+ "name": "uuid",
1174
1168
  "required": true
1175
1169
  }
1176
1170
  },
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.",
1171
+ "description": "Show info about a single device.\n\nShow information about a single device.",
1178
1172
  "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"
1173
+ "$ balena device 7cf02a6",
1174
+ "$ balena device 7cf02a6 --view"
1186
1175
  ],
1187
1176
  "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",
1177
+ "json": {
1178
+ "description": "Format output as json.",
1179
+ "helpGroup": "GLOBAL",
1180
+ "name": "json",
1212
1181
  "allowNo": false,
1213
1182
  "type": "boolean"
1214
1183
  },
1215
- "yes": {
1216
- "char": "y",
1217
- "description": "do not prompt for confirmation before deleting the variable",
1218
- "name": "yes",
1184
+ "view": {
1185
+ "description": "open device dashboard page",
1186
+ "name": "view",
1219
1187
  "allowNo": false,
1220
1188
  "type": "boolean"
1221
1189
  }
1222
1190
  },
1223
1191
  "hasDynamicHelp": false,
1224
1192
  "hiddenAliases": [],
1225
- "id": "env:rm",
1193
+ "id": "device",
1226
1194
  "pluginAlias": "balena-cli",
1227
1195
  "pluginName": "balena-cli",
1228
1196
  "pluginType": "core",
1229
1197
  "strict": true,
1230
- "enableJsonFlag": false,
1198
+ "enableJsonFlag": true,
1199
+ "authenticated": true,
1200
+ "primary": true,
1231
1201
  "isESM": false,
1232
1202
  "relativePath": [
1233
1203
  "build",
1234
1204
  "commands",
1235
- "env",
1236
- "rm.js"
1205
+ "device",
1206
+ "index.js"
1237
1207
  ]
1238
1208
  },
1239
- "env:set": {
1209
+ "device:init": {
1240
1210
  "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).",
1211
+ "args": {},
1212
+ "description": "Initialize a device with balenaOS.\n\nRegister a new device in the selected fleet, download the OS image for the\nfleet's default device type, configure the image and write it to an SD card.\nThis command effectively combines several other balena CLI commands in one,\nnamely:\n\n'balena device register'\n'balena os download'\n'balena config generate'\n'balena os configure'\n'balena os local flash'\n\nPossible arguments for the '--fleet', '--os-version' and '--drive' options can\nbe listed respectively with the commands:\n\n'balena fleet list'\n'balena os versions'\n'balena util available-drives'\n\nIf the '--fleet' or '--drive' options are omitted, interactive menus will be\npresented with values to choose from. If the '--os-version' option is omitted,\nthe latest released OS version for the fleet's default device type will be used.\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).\n\nImage configuration questions will be asked interactively unless a pre-configured\n'config.json' file is provided with the '--config' option. The file can be\ngenerated with the 'balena config generate' command.",
1254
1213
  "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"
1214
+ "$ balena device init",
1215
+ "$ balena device init -f myorg/myfleet",
1216
+ "$ balena device init --fleet myFleet --os-version 2.101.7 --drive /dev/disk5",
1217
+ "$ balena device init --fleet myFleet --os-version 2.83.21+rev1.prod --drive /dev/disk5",
1218
+ "$ balena device init --config config.json --os-version 2.101.7 --drive /dev/disk5 --yes"
1264
1219
  ],
1265
1220
  "flags": {
1266
1221
  "fleet": {
1267
1222
  "char": "f",
1268
1223
  "description": "fleet name or slug (preferred)",
1269
1224
  "exclusive": [
1270
- "device"
1225
+ "config"
1271
1226
  ],
1272
1227
  "name": "fleet",
1273
1228
  "hasDynamicHelp": false,
1274
1229
  "multiple": false,
1275
1230
  "type": "option"
1276
1231
  },
1277
- "device": {
1278
- "char": "d",
1279
- "description": "device UUID",
1232
+ "config": {
1233
+ "description": "path to the config JSON file, see `balena config generate`",
1280
1234
  "exclusive": [
1281
- "fleet"
1235
+ "fleet",
1236
+ "advanced",
1237
+ "provisioning-key-name",
1238
+ "provisioning-key-expiry-date"
1282
1239
  ],
1283
- "name": "device",
1240
+ "name": "config",
1284
1241
  "hasDynamicHelp": false,
1285
1242
  "multiple": false,
1286
1243
  "type": "option"
1287
1244
  },
1288
- "quiet": {
1289
- "char": "q",
1290
- "description": "suppress warning messages",
1291
- "name": "quiet",
1245
+ "os-version": {
1246
+ "description": "exact version number, or a valid semver range,\nor 'latest' (includes pre-releases),\nor 'default' (excludes pre-releases if at least one stable version is available),\nor 'recommended' (excludes pre-releases, will fail if only pre-release versions are available),\nor 'menu' (will show the interactive menu)",
1247
+ "name": "os-version",
1248
+ "hasDynamicHelp": false,
1249
+ "multiple": false,
1250
+ "type": "option"
1251
+ },
1252
+ "advanced": {
1253
+ "char": "v",
1254
+ "description": "show advanced configuration options",
1255
+ "name": "advanced",
1292
1256
  "allowNo": false,
1293
1257
  "type": "boolean"
1294
1258
  },
1295
- "service": {
1296
- "char": "s",
1297
- "description": "service name",
1298
- "name": "service",
1259
+ "provisioning-key-name": {
1260
+ "description": "custom key name assigned to generated provisioning api key",
1261
+ "name": "provisioning-key-name",
1299
1262
  "hasDynamicHelp": false,
1300
1263
  "multiple": false,
1301
1264
  "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": {
1265
+ },
1266
+ "provisioning-key-expiry-date": {
1267
+ "description": "expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)",
1268
+ "name": "provisioning-key-expiry-date",
1269
+ "hasDynamicHelp": false,
1270
+ "multiple": false,
1271
+ "type": "option"
1272
+ },
1273
+ "drive": {
1274
+ "char": "d",
1275
+ "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.",
1276
+ "name": "drive",
1277
+ "hasDynamicHelp": false,
1278
+ "multiple": false,
1279
+ "type": "option"
1280
+ },
1335
1281
  "yes": {
1336
1282
  "char": "y",
1337
1283
  "description": "answer \"yes\" to all questions (non interactive use)",
@@ -1342,7 +1288,7 @@
1342
1288
  },
1343
1289
  "hasDynamicHelp": false,
1344
1290
  "hiddenAliases": [],
1345
- "id": "device:deactivate",
1291
+ "id": "device:init",
1346
1292
  "pluginAlias": "balena-cli",
1347
1293
  "pluginName": "balena-cli",
1348
1294
  "pluginType": "core",
@@ -1354,17 +1300,17 @@
1354
1300
  "build",
1355
1301
  "commands",
1356
1302
  "device",
1357
- "deactivate.js"
1303
+ "init.js"
1358
1304
  ]
1359
1305
  },
1360
- "device:detect": {
1306
+ "device:list": {
1361
1307
  "aliases": [],
1362
1308
  "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.",
1309
+ "description": "List all devices.\n\nList all of your devices.\n\nDevices can be filtered by fleet with the `--fleet` option.\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).",
1364
1310
  "examples": [
1365
- "$ balena device detect",
1366
- "$ balena device detect --timeout 120",
1367
- "$ balena device detect --verbose"
1311
+ "$ balena device list",
1312
+ "$ balena device list --fleet MyFleet",
1313
+ "$ balena device list -f myorg/myfleet"
1368
1314
  ],
1369
1315
  "flags": {
1370
1316
  "json": {
@@ -1374,17 +1320,10 @@
1374
1320
  "allowNo": false,
1375
1321
  "type": "boolean"
1376
1322
  },
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",
1323
+ "fleet": {
1324
+ "char": "f",
1325
+ "description": "fleet name or slug (preferred)",
1326
+ "name": "fleet",
1388
1327
  "hasDynamicHelp": false,
1389
1328
  "multiple": false,
1390
1329
  "type": "option"
@@ -1392,245 +1331,7 @@
1392
1331
  },
1393
1332
  "hasDynamicHelp": false,
1394
1333
  "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"
1442
- ],
1443
- "flags": {},
1444
- "hasDynamicHelp": false,
1445
- "hiddenAliases": [],
1446
- "id": "device:identify",
1447
- "pluginAlias": "balena-cli",
1448
- "pluginName": "balena-cli",
1449
- "pluginType": "core",
1450
- "strict": true,
1451
- "enableJsonFlag": false,
1452
- "authenticated": true,
1453
- "isESM": false,
1454
- "relativePath": [
1455
- "build",
1456
- "commands",
1457
- "device",
1458
- "identify.js"
1459
- ]
1460
- },
1461
- "device": {
1462
- "aliases": [],
1463
- "args": {
1464
- "uuid": {
1465
- "description": "the device uuid",
1466
- "name": "uuid",
1467
- "required": true
1468
- }
1469
- },
1470
- "description": "Show info about a single device.\n\nShow information about a single device.",
1471
- "examples": [
1472
- "$ balena device 7cf02a6",
1473
- "$ balena device 7cf02a6 --view"
1474
- ],
1475
- "flags": {
1476
- "json": {
1477
- "description": "Format output as json.",
1478
- "helpGroup": "GLOBAL",
1479
- "name": "json",
1480
- "allowNo": false,
1481
- "type": "boolean"
1482
- },
1483
- "view": {
1484
- "description": "open device dashboard page",
1485
- "name": "view",
1486
- "allowNo": false,
1487
- "type": "boolean"
1488
- }
1489
- },
1490
- "hasDynamicHelp": false,
1491
- "hiddenAliases": [],
1492
- "id": "device",
1493
- "pluginAlias": "balena-cli",
1494
- "pluginName": "balena-cli",
1495
- "pluginType": "core",
1496
- "strict": true,
1497
- "enableJsonFlag": true,
1498
- "authenticated": true,
1499
- "primary": true,
1500
- "isESM": false,
1501
- "relativePath": [
1502
- "build",
1503
- "commands",
1504
- "device",
1505
- "index.js"
1506
- ]
1507
- },
1508
- "device:init": {
1509
- "aliases": [],
1510
- "args": {},
1511
- "description": "Initialize a device with balenaOS.\n\nRegister a new device in the selected fleet, download the OS image for the\nfleet's default device type, configure the image and write it to an SD card.\nThis command effectively combines several other balena CLI commands in one,\nnamely:\n\n'balena device register'\n'balena os download'\n'balena config generate'\n'balena os configure'\n'balena os local flash'\n\nPossible arguments for the '--fleet', '--os-version' and '--drive' options can\nbe listed respectively with the commands:\n\n'balena fleet list'\n'balena os versions'\n'balena util available-drives'\n\nIf the '--fleet' or '--drive' options are omitted, interactive menus will be\npresented with values to choose from. If the '--os-version' option is omitted,\nthe latest released OS version for the fleet's default device type will be used.\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).\n\nImage configuration questions will be asked interactively unless a pre-configured\n'config.json' file is provided with the '--config' option. The file can be\ngenerated with the 'balena config generate' command.",
1512
- "examples": [
1513
- "$ balena device init",
1514
- "$ balena device init -f myorg/myfleet",
1515
- "$ balena device init --fleet myFleet --os-version 2.101.7 --drive /dev/disk5",
1516
- "$ balena device init --fleet myFleet --os-version 2.83.21+rev1.prod --drive /dev/disk5",
1517
- "$ balena device init --config config.json --os-version 2.101.7 --drive /dev/disk5 --yes"
1518
- ],
1519
- "flags": {
1520
- "fleet": {
1521
- "char": "f",
1522
- "description": "fleet name or slug (preferred)",
1523
- "exclusive": [
1524
- "config"
1525
- ],
1526
- "name": "fleet",
1527
- "hasDynamicHelp": false,
1528
- "multiple": false,
1529
- "type": "option"
1530
- },
1531
- "config": {
1532
- "description": "path to the config JSON file, see `balena config generate`",
1533
- "exclusive": [
1534
- "fleet",
1535
- "advanced",
1536
- "provisioning-key-name",
1537
- "provisioning-key-expiry-date"
1538
- ],
1539
- "name": "config",
1540
- "hasDynamicHelp": false,
1541
- "multiple": false,
1542
- "type": "option"
1543
- },
1544
- "os-version": {
1545
- "description": "exact version number, or a valid semver range,\nor 'latest' (includes pre-releases),\nor 'default' (excludes pre-releases if at least one stable version is available),\nor 'recommended' (excludes pre-releases, will fail if only pre-release versions are available),\nor 'menu' (will show the interactive menu)",
1546
- "name": "os-version",
1547
- "hasDynamicHelp": false,
1548
- "multiple": false,
1549
- "type": "option"
1550
- },
1551
- "advanced": {
1552
- "char": "v",
1553
- "description": "show advanced configuration options",
1554
- "name": "advanced",
1555
- "allowNo": false,
1556
- "type": "boolean"
1557
- },
1558
- "provisioning-key-name": {
1559
- "description": "custom key name assigned to generated provisioning api key",
1560
- "name": "provisioning-key-name",
1561
- "hasDynamicHelp": false,
1562
- "multiple": false,
1563
- "type": "option"
1564
- },
1565
- "provisioning-key-expiry-date": {
1566
- "description": "expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)",
1567
- "name": "provisioning-key-expiry-date",
1568
- "hasDynamicHelp": false,
1569
- "multiple": false,
1570
- "type": "option"
1571
- },
1572
- "drive": {
1573
- "char": "d",
1574
- "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.",
1575
- "name": "drive",
1576
- "hasDynamicHelp": false,
1577
- "multiple": false,
1578
- "type": "option"
1579
- },
1580
- "yes": {
1581
- "char": "y",
1582
- "description": "answer \"yes\" to all questions (non interactive use)",
1583
- "name": "yes",
1584
- "allowNo": false,
1585
- "type": "boolean"
1586
- }
1587
- },
1588
- "hasDynamicHelp": false,
1589
- "hiddenAliases": [],
1590
- "id": "device:init",
1591
- "pluginAlias": "balena-cli",
1592
- "pluginName": "balena-cli",
1593
- "pluginType": "core",
1594
- "strict": true,
1595
- "enableJsonFlag": false,
1596
- "authenticated": true,
1597
- "isESM": false,
1598
- "relativePath": [
1599
- "build",
1600
- "commands",
1601
- "device",
1602
- "init.js"
1603
- ]
1604
- },
1605
- "device:list": {
1606
- "aliases": [],
1607
- "args": {},
1608
- "description": "List all devices.\n\nList all of your devices.\n\nDevices can be filtered by fleet with the `--fleet` option.\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).",
1609
- "examples": [
1610
- "$ balena device list",
1611
- "$ balena device list --fleet MyFleet",
1612
- "$ balena device list -f myorg/myfleet"
1613
- ],
1614
- "flags": {
1615
- "json": {
1616
- "description": "Format output as json.",
1617
- "helpGroup": "GLOBAL",
1618
- "name": "json",
1619
- "allowNo": false,
1620
- "type": "boolean"
1621
- },
1622
- "fleet": {
1623
- "char": "f",
1624
- "description": "fleet name or slug (preferred)",
1625
- "name": "fleet",
1626
- "hasDynamicHelp": false,
1627
- "multiple": false,
1628
- "type": "option"
1629
- }
1630
- },
1631
- "hasDynamicHelp": false,
1632
- "hiddenAliases": [],
1633
- "id": "device:list",
1334
+ "id": "device:list",
1634
1335
  "pluginAlias": "balena-cli",
1635
1336
  "pluginName": "balena-cli",
1636
1337
  "pluginType": "core",
@@ -2461,80 +2162,416 @@
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
+ },
2443
+ "hasDynamicHelp": false,
2444
+ "hiddenAliases": [],
2445
+ "id": "env:rm",
2446
+ "pluginAlias": "balena-cli",
2447
+ "pluginName": "balena-cli",
2448
+ "pluginType": "core",
2449
+ "strict": true,
2450
+ "enableJsonFlag": false,
2451
+ "isESM": false,
2452
+ "relativePath": [
2453
+ "build",
2454
+ "commands",
2455
+ "env",
2456
+ "rm.js"
2457
+ ]
2458
+ },
2459
+ "env:set": {
2460
+ "aliases": [],
2461
+ "args": {
2462
+ "name": {
2463
+ "description": "environment or config variable name",
2464
+ "name": "name",
2465
+ "required": true
2466
+ },
2467
+ "value": {
2468
+ "description": "variable value; if omitted, use value from this process' environment",
2469
+ "name": "value",
2470
+ "required": false
2471
+ }
2472
+ },
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).",
2474
+ "examples": [
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"
2484
+ ],
2485
+ "flags": {
2486
+ "fleet": {
2487
+ "char": "f",
2488
+ "description": "fleet name or slug (preferred)",
2489
+ "exclusive": [
2490
+ "device"
2491
+ ],
2492
+ "name": "fleet",
2493
+ "hasDynamicHelp": false,
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,
2521
+ "type": "option"
2522
+ }
2523
+ },
2469
2524
  "hasDynamicHelp": false,
2470
2525
  "hiddenAliases": [],
2471
- "id": "device:track-fleet",
2526
+ "id": "env:set",
2472
2527
  "pluginAlias": "balena-cli",
2473
2528
  "pluginName": "balena-cli",
2474
2529
  "pluginType": "core",
2475
- "strict": true,
2530
+ "strict": false,
2476
2531
  "enableJsonFlag": false,
2477
- "authenticated": true,
2478
2532
  "isESM": false,
2479
2533
  "relativePath": [
2480
2534
  "build",
2481
2535
  "commands",
2482
- "device",
2483
- "track-fleet.js"
2536
+ "env",
2537
+ "set.js"
2484
2538
  ]
2485
2539
  },
2486
- "device:tunnel": {
2540
+ "internal:osinit": {
2487
2541
  "aliases": [],
2488
2542
  "args": {
2489
- "deviceOrFleet": {
2490
- "description": "device UUID or fleet name/slug",
2491
- "name": "deviceOrFleet",
2543
+ "image": {
2544
+ "name": "image",
2545
+ "required": true
2546
+ },
2547
+ "type": {
2548
+ "name": "type",
2549
+ "required": true
2550
+ },
2551
+ "config": {
2552
+ "name": "config",
2492
2553
  "required": true
2493
2554
  }
2494
2555
  },
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.",
2496
- "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"
2511
- ],
2512
- "flags": {
2513
- "port": {
2514
- "char": "p",
2515
- "description": "port mapping in the format <remotePort>[:[localIP:]localPort]",
2516
- "name": "port",
2517
- "hasDynamicHelp": false,
2518
- "multiple": true,
2519
- "type": "option"
2520
- }
2521
- },
2556
+ "description": "Do actual init of the device with the preconfigured os image.\n\nDon't use this command directly!\nUse `balena os initialize <image>` instead.",
2557
+ "flags": {},
2522
2558
  "hasDynamicHelp": false,
2559
+ "hidden": true,
2523
2560
  "hiddenAliases": [],
2524
- "id": "device:tunnel",
2561
+ "id": "internal:osinit",
2525
2562
  "pluginAlias": "balena-cli",
2526
2563
  "pluginName": "balena-cli",
2527
2564
  "pluginType": "core",
2528
2565
  "strict": true,
2529
2566
  "enableJsonFlag": false,
2530
- "primary": true,
2531
- "authenticated": true,
2567
+ "root": true,
2568
+ "offlineCompatible": true,
2532
2569
  "isESM": false,
2533
2570
  "relativePath": [
2534
2571
  "build",
2535
2572
  "commands",
2536
- "device",
2537
- "tunnel.js"
2573
+ "internal",
2574
+ "osinit.js"
2538
2575
  ]
2539
2576
  },
2540
2577
  "fleet:create": {
@@ -2879,43 +2916,6 @@
2879
2916
  "track-latest.js"
2880
2917
  ]
2881
2918
  },
2882
- "internal:osinit": {
2883
- "aliases": [],
2884
- "args": {
2885
- "image": {
2886
- "name": "image",
2887
- "required": true
2888
- },
2889
- "type": {
2890
- "name": "type",
2891
- "required": true
2892
- },
2893
- "config": {
2894
- "name": "config",
2895
- "required": true
2896
- }
2897
- },
2898
- "description": "Do actual init of the device with the preconfigured os image.\n\nDon't use this command directly!\nUse `balena os initialize <image>` instead.",
2899
- "flags": {},
2900
- "hasDynamicHelp": false,
2901
- "hidden": true,
2902
- "hiddenAliases": [],
2903
- "id": "internal:osinit",
2904
- "pluginAlias": "balena-cli",
2905
- "pluginName": "balena-cli",
2906
- "pluginType": "core",
2907
- "strict": true,
2908
- "enableJsonFlag": false,
2909
- "root": true,
2910
- "offlineCompatible": true,
2911
- "isESM": false,
2912
- "relativePath": [
2913
- "build",
2914
- "commands",
2915
- "internal",
2916
- "osinit.js"
2917
- ]
2918
- },
2919
2919
  "join": {
2920
2920
  "aliases": [],
2921
2921
  "args": {
@@ -3866,30 +3866,212 @@
3866
3866
  "name": "draft",
3867
3867
  "allowNo": false,
3868
3868
  "type": "boolean"
3869
- },
3870
- "note": {
3871
- "description": "The notes for this release",
3872
- "name": "note",
3873
- "hasDynamicHelp": false,
3874
- "multiple": false,
3875
- "type": "option"
3869
+ },
3870
+ "note": {
3871
+ "description": "The notes for this release",
3872
+ "name": "note",
3873
+ "hasDynamicHelp": false,
3874
+ "multiple": false,
3875
+ "type": "option"
3876
+ }
3877
+ },
3878
+ "hasDynamicHelp": false,
3879
+ "hiddenAliases": [],
3880
+ "id": "push",
3881
+ "pluginAlias": "balena-cli",
3882
+ "pluginName": "balena-cli",
3883
+ "pluginType": "core",
3884
+ "strict": true,
3885
+ "enableJsonFlag": false,
3886
+ "primary": true,
3887
+ "isESM": false,
3888
+ "relativePath": [
3889
+ "build",
3890
+ "commands",
3891
+ "push",
3892
+ "index.js"
3893
+ ]
3894
+ },
3895
+ "release:finalize": {
3896
+ "aliases": [],
3897
+ "args": {
3898
+ "commitOrId": {
3899
+ "description": "the commit or ID of the release to finalize",
3900
+ "name": "commitOrId",
3901
+ "required": true
3902
+ }
3903
+ },
3904
+ "description": "Finalize a release.\n\nFinalize a release. Releases can be \"draft\" or \"final\", and this command\nchanges a draft release into a final release. Draft releases can be created\nwith the `--draft` option of the `balena build` or `balena deploy`\ncommands.\n\nDraft releases are not automatically deployed to devices tracking the latest\nrelease. For a draft release to be deployed to a device, the device should be\nexplicity pinned to that release. Conversely, final releases may trigger immediate\ndeployment to unpinned devices (subject to a device's polling period) and, for\nthis reason, final releases cannot be changed back to draft status.",
3905
+ "examples": [
3906
+ "$ balena release finalize a777f7345fe3d655c1c981aa642e5555",
3907
+ "$ balena release finalize 1234567"
3908
+ ],
3909
+ "flags": {},
3910
+ "hasDynamicHelp": false,
3911
+ "hiddenAliases": [],
3912
+ "id": "release:finalize",
3913
+ "pluginAlias": "balena-cli",
3914
+ "pluginName": "balena-cli",
3915
+ "pluginType": "core",
3916
+ "strict": true,
3917
+ "enableJsonFlag": false,
3918
+ "authenticated": true,
3919
+ "isESM": false,
3920
+ "relativePath": [
3921
+ "build",
3922
+ "commands",
3923
+ "release",
3924
+ "finalize.js"
3925
+ ]
3926
+ },
3927
+ "release": {
3928
+ "aliases": [],
3929
+ "args": {
3930
+ "commitOrId": {
3931
+ "description": "the commit or ID of the release to get information",
3932
+ "name": "commitOrId",
3933
+ "required": true
3934
+ }
3935
+ },
3936
+ "description": "Get info for a release.",
3937
+ "examples": [
3938
+ "$ balena release a777f7345fe3d655c1c981aa642e5555",
3939
+ "$ balena release 1234567"
3940
+ ],
3941
+ "flags": {
3942
+ "json": {
3943
+ "description": "Format output as json.",
3944
+ "helpGroup": "GLOBAL",
3945
+ "name": "json",
3946
+ "allowNo": false,
3947
+ "type": "boolean"
3948
+ },
3949
+ "composition": {
3950
+ "char": "c",
3951
+ "description": "Return the release composition",
3952
+ "name": "composition",
3953
+ "allowNo": false,
3954
+ "type": "boolean"
3955
+ }
3956
+ },
3957
+ "hasDynamicHelp": false,
3958
+ "hiddenAliases": [],
3959
+ "id": "release",
3960
+ "pluginAlias": "balena-cli",
3961
+ "pluginName": "balena-cli",
3962
+ "pluginType": "core",
3963
+ "strict": true,
3964
+ "enableJsonFlag": true,
3965
+ "authenticated": true,
3966
+ "isESM": false,
3967
+ "relativePath": [
3968
+ "build",
3969
+ "commands",
3970
+ "release",
3971
+ "index.js"
3972
+ ]
3973
+ },
3974
+ "release:invalidate": {
3975
+ "aliases": [],
3976
+ "args": {
3977
+ "commitOrId": {
3978
+ "description": "the commit or ID of the release to invalidate",
3979
+ "name": "commitOrId",
3980
+ "required": true
3981
+ }
3982
+ },
3983
+ "description": "Invalidate a release.\n\nInvalidate a release.\n\nInvalid releases are not automatically deployed to devices tracking the latest\nrelease. For an invalid release to be deployed to a device, the device should be\nexplicity pinned to that release.",
3984
+ "examples": [
3985
+ "$ balena release invalidate a777f7345fe3d655c1c981aa642e5555",
3986
+ "$ balena release invalidate 1234567"
3987
+ ],
3988
+ "flags": {},
3989
+ "hasDynamicHelp": false,
3990
+ "hiddenAliases": [],
3991
+ "id": "release:invalidate",
3992
+ "pluginAlias": "balena-cli",
3993
+ "pluginName": "balena-cli",
3994
+ "pluginType": "core",
3995
+ "strict": true,
3996
+ "enableJsonFlag": false,
3997
+ "authenticated": true,
3998
+ "isESM": false,
3999
+ "relativePath": [
4000
+ "build",
4001
+ "commands",
4002
+ "release",
4003
+ "invalidate.js"
4004
+ ]
4005
+ },
4006
+ "release:list": {
4007
+ "aliases": [],
4008
+ "args": {
4009
+ "fleet": {
4010
+ "description": "fleet name or slug (preferred)",
4011
+ "name": "fleet",
4012
+ "required": true
4013
+ }
4014
+ },
4015
+ "description": "List all releases of a fleet.\n\nList all releases of the given fleet.\n\nFleets may be specified by fleet name or slug. Slugs are recommended because\nthey are unique and unambiguous. Slugs can be listed with the `balena fleet list`\ncommand. Note that slugs may change if the fleet is renamed. Fleet names are\nnot unique and may result in \"Fleet is ambiguous\" errors at any time (even if\n\"it used to work in the past\"), for example if the name clashes with a newly\ncreated public/open fleet, or with fleets from other balena accounts that you\nmay be invited to join under any role. For this reason, fleet names are\nespecially discouraged in scripts (e.g. CI environments).",
4016
+ "examples": [
4017
+ "$ balena release list myorg/myfleet"
4018
+ ],
4019
+ "flags": {
4020
+ "json": {
4021
+ "description": "Format output as json.",
4022
+ "helpGroup": "GLOBAL",
4023
+ "name": "json",
4024
+ "allowNo": false,
4025
+ "type": "boolean"
3876
4026
  }
3877
4027
  },
3878
4028
  "hasDynamicHelp": false,
3879
4029
  "hiddenAliases": [],
3880
- "id": "push",
4030
+ "id": "release:list",
4031
+ "pluginAlias": "balena-cli",
4032
+ "pluginName": "balena-cli",
4033
+ "pluginType": "core",
4034
+ "strict": true,
4035
+ "enableJsonFlag": true,
4036
+ "authenticated": true,
4037
+ "isESM": false,
4038
+ "relativePath": [
4039
+ "build",
4040
+ "commands",
4041
+ "release",
4042
+ "list.js"
4043
+ ]
4044
+ },
4045
+ "release:validate": {
4046
+ "aliases": [],
4047
+ "args": {
4048
+ "commitOrId": {
4049
+ "description": "the commit or ID of the release to validate",
4050
+ "name": "commitOrId",
4051
+ "required": true
4052
+ }
4053
+ },
4054
+ "description": "Validate a release.\n\nValidate a release.\n\nValid releases are automatically deployed to devices tracking the latest\nrelease if they are finalized.",
4055
+ "examples": [
4056
+ "$ balena release validate a777f7345fe3d655c1c981aa642e5555",
4057
+ "$ balena release validate 1234567"
4058
+ ],
4059
+ "flags": {},
4060
+ "hasDynamicHelp": false,
4061
+ "hiddenAliases": [],
4062
+ "id": "release:validate",
3881
4063
  "pluginAlias": "balena-cli",
3882
4064
  "pluginName": "balena-cli",
3883
4065
  "pluginType": "core",
3884
4066
  "strict": true,
3885
4067
  "enableJsonFlag": false,
3886
- "primary": true,
4068
+ "authenticated": true,
3887
4069
  "isESM": false,
3888
4070
  "relativePath": [
3889
4071
  "build",
3890
4072
  "commands",
3891
- "push",
3892
- "index.js"
4073
+ "release",
4074
+ "validate.js"
3893
4075
  ]
3894
4076
  },
3895
4077
  "release-asset:delete": {
@@ -4107,188 +4289,6 @@
4107
4289
  "upload.js"
4108
4290
  ]
4109
4291
  },
4110
- "release:finalize": {
4111
- "aliases": [],
4112
- "args": {
4113
- "commitOrId": {
4114
- "description": "the commit or ID of the release to finalize",
4115
- "name": "commitOrId",
4116
- "required": true
4117
- }
4118
- },
4119
- "description": "Finalize a release.\n\nFinalize a release. Releases can be \"draft\" or \"final\", and this command\nchanges a draft release into a final release. Draft releases can be created\nwith the `--draft` option of the `balena build` or `balena deploy`\ncommands.\n\nDraft releases are not automatically deployed to devices tracking the latest\nrelease. For a draft release to be deployed to a device, the device should be\nexplicity pinned to that release. Conversely, final releases may trigger immediate\ndeployment to unpinned devices (subject to a device's polling period) and, for\nthis reason, final releases cannot be changed back to draft status.",
4120
- "examples": [
4121
- "$ balena release finalize a777f7345fe3d655c1c981aa642e5555",
4122
- "$ balena release finalize 1234567"
4123
- ],
4124
- "flags": {},
4125
- "hasDynamicHelp": false,
4126
- "hiddenAliases": [],
4127
- "id": "release:finalize",
4128
- "pluginAlias": "balena-cli",
4129
- "pluginName": "balena-cli",
4130
- "pluginType": "core",
4131
- "strict": true,
4132
- "enableJsonFlag": false,
4133
- "authenticated": true,
4134
- "isESM": false,
4135
- "relativePath": [
4136
- "build",
4137
- "commands",
4138
- "release",
4139
- "finalize.js"
4140
- ]
4141
- },
4142
- "release": {
4143
- "aliases": [],
4144
- "args": {
4145
- "commitOrId": {
4146
- "description": "the commit or ID of the release to get information",
4147
- "name": "commitOrId",
4148
- "required": true
4149
- }
4150
- },
4151
- "description": "Get info for a release.",
4152
- "examples": [
4153
- "$ balena release a777f7345fe3d655c1c981aa642e5555",
4154
- "$ balena release 1234567"
4155
- ],
4156
- "flags": {
4157
- "json": {
4158
- "description": "Format output as json.",
4159
- "helpGroup": "GLOBAL",
4160
- "name": "json",
4161
- "allowNo": false,
4162
- "type": "boolean"
4163
- },
4164
- "composition": {
4165
- "char": "c",
4166
- "description": "Return the release composition",
4167
- "name": "composition",
4168
- "allowNo": false,
4169
- "type": "boolean"
4170
- }
4171
- },
4172
- "hasDynamicHelp": false,
4173
- "hiddenAliases": [],
4174
- "id": "release",
4175
- "pluginAlias": "balena-cli",
4176
- "pluginName": "balena-cli",
4177
- "pluginType": "core",
4178
- "strict": true,
4179
- "enableJsonFlag": true,
4180
- "authenticated": true,
4181
- "isESM": false,
4182
- "relativePath": [
4183
- "build",
4184
- "commands",
4185
- "release",
4186
- "index.js"
4187
- ]
4188
- },
4189
- "release:invalidate": {
4190
- "aliases": [],
4191
- "args": {
4192
- "commitOrId": {
4193
- "description": "the commit or ID of the release to invalidate",
4194
- "name": "commitOrId",
4195
- "required": true
4196
- }
4197
- },
4198
- "description": "Invalidate a release.\n\nInvalidate a release.\n\nInvalid releases are not automatically deployed to devices tracking the latest\nrelease. For an invalid release to be deployed to a device, the device should be\nexplicity pinned to that release.",
4199
- "examples": [
4200
- "$ balena release invalidate a777f7345fe3d655c1c981aa642e5555",
4201
- "$ balena release invalidate 1234567"
4202
- ],
4203
- "flags": {},
4204
- "hasDynamicHelp": false,
4205
- "hiddenAliases": [],
4206
- "id": "release:invalidate",
4207
- "pluginAlias": "balena-cli",
4208
- "pluginName": "balena-cli",
4209
- "pluginType": "core",
4210
- "strict": true,
4211
- "enableJsonFlag": false,
4212
- "authenticated": true,
4213
- "isESM": false,
4214
- "relativePath": [
4215
- "build",
4216
- "commands",
4217
- "release",
4218
- "invalidate.js"
4219
- ]
4220
- },
4221
- "release:list": {
4222
- "aliases": [],
4223
- "args": {
4224
- "fleet": {
4225
- "description": "fleet name or slug (preferred)",
4226
- "name": "fleet",
4227
- "required": true
4228
- }
4229
- },
4230
- "description": "List all releases of a fleet.\n\nList all releases of the given fleet.\n\nFleets may be specified by fleet name or slug. Slugs are recommended because\nthey are unique and unambiguous. Slugs can be listed with the `balena fleet list`\ncommand. Note that slugs may change if the fleet is renamed. Fleet names are\nnot unique and may result in \"Fleet is ambiguous\" errors at any time (even if\n\"it used to work in the past\"), for example if the name clashes with a newly\ncreated public/open fleet, or with fleets from other balena accounts that you\nmay be invited to join under any role. For this reason, fleet names are\nespecially discouraged in scripts (e.g. CI environments).",
4231
- "examples": [
4232
- "$ balena release list myorg/myfleet"
4233
- ],
4234
- "flags": {
4235
- "json": {
4236
- "description": "Format output as json.",
4237
- "helpGroup": "GLOBAL",
4238
- "name": "json",
4239
- "allowNo": false,
4240
- "type": "boolean"
4241
- }
4242
- },
4243
- "hasDynamicHelp": false,
4244
- "hiddenAliases": [],
4245
- "id": "release:list",
4246
- "pluginAlias": "balena-cli",
4247
- "pluginName": "balena-cli",
4248
- "pluginType": "core",
4249
- "strict": true,
4250
- "enableJsonFlag": true,
4251
- "authenticated": true,
4252
- "isESM": false,
4253
- "relativePath": [
4254
- "build",
4255
- "commands",
4256
- "release",
4257
- "list.js"
4258
- ]
4259
- },
4260
- "release:validate": {
4261
- "aliases": [],
4262
- "args": {
4263
- "commitOrId": {
4264
- "description": "the commit or ID of the release to validate",
4265
- "name": "commitOrId",
4266
- "required": true
4267
- }
4268
- },
4269
- "description": "Validate a release.\n\nValidate a release.\n\nValid releases are automatically deployed to devices tracking the latest\nrelease if they are finalized.",
4270
- "examples": [
4271
- "$ balena release validate a777f7345fe3d655c1c981aa642e5555",
4272
- "$ balena release validate 1234567"
4273
- ],
4274
- "flags": {},
4275
- "hasDynamicHelp": false,
4276
- "hiddenAliases": [],
4277
- "id": "release:validate",
4278
- "pluginAlias": "balena-cli",
4279
- "pluginName": "balena-cli",
4280
- "pluginType": "core",
4281
- "strict": true,
4282
- "enableJsonFlag": false,
4283
- "authenticated": true,
4284
- "isESM": false,
4285
- "relativePath": [
4286
- "build",
4287
- "commands",
4288
- "release",
4289
- "validate.js"
4290
- ]
4291
- },
4292
4292
  "settings": {
4293
4293
  "aliases": [],
4294
4294
  "args": {},