balena-cli 23.2.11 → 23.2.12-build-bump-oclif-4-22-61-aaaebf44c29b05c6b4c233ab54f2ffe1637bc608-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/npm-shrinkwrap.json +2323 -2008
- package/oclif.manifest.json +662 -662
- package/package.json +3 -3
package/oclif.manifest.json
CHANGED
|
@@ -160,6 +160,56 @@
|
|
|
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
|
+
},
|
|
163
213
|
"build": {
|
|
164
214
|
"aliases": [],
|
|
165
215
|
"args": {
|
|
@@ -362,56 +412,6 @@
|
|
|
362
412
|
"index.js"
|
|
363
413
|
]
|
|
364
414
|
},
|
|
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,54 +1018,16 @@
|
|
|
1018
1018
|
"list.js"
|
|
1019
1019
|
]
|
|
1020
1020
|
},
|
|
1021
|
-
"
|
|
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": {
|
|
1021
|
+
"env:list": {
|
|
1062
1022
|
"aliases": [],
|
|
1063
1023
|
"args": {},
|
|
1064
|
-
"description": "
|
|
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).",
|
|
1065
1025
|
"examples": [
|
|
1066
|
-
"$ balena
|
|
1067
|
-
"$ balena
|
|
1068
|
-
"$ balena
|
|
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"
|
|
1069
1031
|
],
|
|
1070
1032
|
"flags": {
|
|
1071
1033
|
"json": {
|
|
@@ -1075,17 +1037,45 @@
|
|
|
1075
1037
|
"allowNo": false,
|
|
1076
1038
|
"type": "boolean"
|
|
1077
1039
|
},
|
|
1078
|
-
"
|
|
1079
|
-
"char": "
|
|
1080
|
-
"description": "
|
|
1081
|
-
"
|
|
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",
|
|
1082
1058
|
"allowNo": false,
|
|
1083
1059
|
"type": "boolean"
|
|
1084
1060
|
},
|
|
1085
|
-
"
|
|
1086
|
-
"char": "
|
|
1087
|
-
"description": "
|
|
1088
|
-
"
|
|
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",
|
|
1089
1079
|
"hasDynamicHelp": false,
|
|
1090
1080
|
"multiple": false,
|
|
1091
1081
|
"type": "option"
|
|
@@ -1093,191 +1083,255 @@
|
|
|
1093
1083
|
},
|
|
1094
1084
|
"hasDynamicHelp": false,
|
|
1095
1085
|
"hiddenAliases": [],
|
|
1096
|
-
"id": "
|
|
1086
|
+
"id": "env:list",
|
|
1097
1087
|
"pluginAlias": "balena-cli",
|
|
1098
1088
|
"pluginName": "balena-cli",
|
|
1099
1089
|
"pluginType": "core",
|
|
1100
1090
|
"strict": true,
|
|
1101
1091
|
"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.",
|
|
1123
1092
|
"isESM": false,
|
|
1124
1093
|
"relativePath": [
|
|
1125
1094
|
"build",
|
|
1126
1095
|
"commands",
|
|
1127
|
-
"
|
|
1128
|
-
"
|
|
1096
|
+
"env",
|
|
1097
|
+
"list.js"
|
|
1129
1098
|
]
|
|
1130
1099
|
},
|
|
1131
|
-
"
|
|
1100
|
+
"env:rename": {
|
|
1132
1101
|
"aliases": [],
|
|
1133
1102
|
"args": {
|
|
1134
|
-
"
|
|
1135
|
-
"description": "
|
|
1136
|
-
"name": "
|
|
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",
|
|
1137
1111
|
"required": true
|
|
1138
1112
|
}
|
|
1139
1113
|
},
|
|
1140
|
-
"description": "
|
|
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.",
|
|
1141
1115
|
"examples": [
|
|
1142
|
-
"$ balena
|
|
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"
|
|
1143
1122
|
],
|
|
1144
|
-
"flags": {
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
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,
|
|
1155
1161
|
"relativePath": [
|
|
1156
1162
|
"build",
|
|
1157
1163
|
"commands",
|
|
1158
|
-
"
|
|
1159
|
-
"
|
|
1164
|
+
"env",
|
|
1165
|
+
"rename.js"
|
|
1160
1166
|
]
|
|
1161
1167
|
},
|
|
1162
|
-
"
|
|
1168
|
+
"env:rm": {
|
|
1163
1169
|
"aliases": [],
|
|
1164
1170
|
"args": {
|
|
1165
|
-
"
|
|
1166
|
-
"description": "
|
|
1167
|
-
"name": "
|
|
1171
|
+
"id": {
|
|
1172
|
+
"description": "variable's numeric database ID",
|
|
1173
|
+
"name": "id",
|
|
1168
1174
|
"required": true
|
|
1169
1175
|
}
|
|
1170
1176
|
},
|
|
1171
|
-
"description": "
|
|
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.",
|
|
1172
1178
|
"examples": [
|
|
1173
|
-
"$ balena
|
|
1174
|
-
"$ balena
|
|
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"
|
|
1175
1186
|
],
|
|
1176
1187
|
"flags": {
|
|
1177
|
-
"
|
|
1178
|
-
"
|
|
1179
|
-
"
|
|
1180
|
-
"
|
|
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",
|
|
1181
1195
|
"allowNo": false,
|
|
1182
1196
|
"type": "boolean"
|
|
1183
1197
|
},
|
|
1184
|
-
"
|
|
1185
|
-
"
|
|
1186
|
-
"
|
|
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",
|
|
1187
1219
|
"allowNo": false,
|
|
1188
1220
|
"type": "boolean"
|
|
1189
1221
|
}
|
|
1190
1222
|
},
|
|
1191
1223
|
"hasDynamicHelp": false,
|
|
1192
1224
|
"hiddenAliases": [],
|
|
1193
|
-
"id": "
|
|
1225
|
+
"id": "env:rm",
|
|
1194
1226
|
"pluginAlias": "balena-cli",
|
|
1195
1227
|
"pluginName": "balena-cli",
|
|
1196
1228
|
"pluginType": "core",
|
|
1197
1229
|
"strict": true,
|
|
1198
|
-
"enableJsonFlag":
|
|
1199
|
-
"authenticated": true,
|
|
1200
|
-
"primary": true,
|
|
1230
|
+
"enableJsonFlag": false,
|
|
1201
1231
|
"isESM": false,
|
|
1202
1232
|
"relativePath": [
|
|
1203
1233
|
"build",
|
|
1204
1234
|
"commands",
|
|
1205
|
-
"
|
|
1206
|
-
"
|
|
1235
|
+
"env",
|
|
1236
|
+
"rm.js"
|
|
1207
1237
|
]
|
|
1208
1238
|
},
|
|
1209
|
-
"
|
|
1239
|
+
"env:set": {
|
|
1210
1240
|
"aliases": [],
|
|
1211
|
-
"args": {
|
|
1212
|
-
|
|
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).",
|
|
1213
1254
|
"examples": [
|
|
1214
|
-
"$ balena
|
|
1215
|
-
"$ balena
|
|
1216
|
-
"$ balena
|
|
1217
|
-
"$ balena
|
|
1218
|
-
"$ balena
|
|
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"
|
|
1219
1264
|
],
|
|
1220
1265
|
"flags": {
|
|
1221
1266
|
"fleet": {
|
|
1222
1267
|
"char": "f",
|
|
1223
1268
|
"description": "fleet name or slug (preferred)",
|
|
1224
1269
|
"exclusive": [
|
|
1225
|
-
"
|
|
1270
|
+
"device"
|
|
1226
1271
|
],
|
|
1227
1272
|
"name": "fleet",
|
|
1228
1273
|
"hasDynamicHelp": false,
|
|
1229
1274
|
"multiple": false,
|
|
1230
1275
|
"type": "option"
|
|
1231
1276
|
},
|
|
1232
|
-
"
|
|
1233
|
-
"
|
|
1277
|
+
"device": {
|
|
1278
|
+
"char": "d",
|
|
1279
|
+
"description": "device UUID",
|
|
1234
1280
|
"exclusive": [
|
|
1235
|
-
"fleet"
|
|
1236
|
-
"advanced",
|
|
1237
|
-
"provisioning-key-name",
|
|
1238
|
-
"provisioning-key-expiry-date"
|
|
1281
|
+
"fleet"
|
|
1239
1282
|
],
|
|
1240
|
-
"name": "
|
|
1241
|
-
"hasDynamicHelp": false,
|
|
1242
|
-
"multiple": false,
|
|
1243
|
-
"type": "option"
|
|
1244
|
-
},
|
|
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",
|
|
1283
|
+
"name": "device",
|
|
1248
1284
|
"hasDynamicHelp": false,
|
|
1249
1285
|
"multiple": false,
|
|
1250
1286
|
"type": "option"
|
|
1251
1287
|
},
|
|
1252
|
-
"
|
|
1253
|
-
"char": "
|
|
1254
|
-
"description": "
|
|
1255
|
-
"name": "
|
|
1288
|
+
"quiet": {
|
|
1289
|
+
"char": "q",
|
|
1290
|
+
"description": "suppress warning messages",
|
|
1291
|
+
"name": "quiet",
|
|
1256
1292
|
"allowNo": false,
|
|
1257
1293
|
"type": "boolean"
|
|
1258
1294
|
},
|
|
1259
|
-
"
|
|
1260
|
-
"
|
|
1261
|
-
"
|
|
1262
|
-
"
|
|
1263
|
-
"multiple": false,
|
|
1264
|
-
"type": "option"
|
|
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",
|
|
1295
|
+
"service": {
|
|
1296
|
+
"char": "s",
|
|
1297
|
+
"description": "service name",
|
|
1298
|
+
"name": "service",
|
|
1277
1299
|
"hasDynamicHelp": false,
|
|
1278
1300
|
"multiple": false,
|
|
1279
1301
|
"type": "option"
|
|
1280
|
-
}
|
|
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": {
|
|
1281
1335
|
"yes": {
|
|
1282
1336
|
"char": "y",
|
|
1283
1337
|
"description": "answer \"yes\" to all questions (non interactive use)",
|
|
@@ -1288,7 +1342,7 @@
|
|
|
1288
1342
|
},
|
|
1289
1343
|
"hasDynamicHelp": false,
|
|
1290
1344
|
"hiddenAliases": [],
|
|
1291
|
-
"id": "device:
|
|
1345
|
+
"id": "device:deactivate",
|
|
1292
1346
|
"pluginAlias": "balena-cli",
|
|
1293
1347
|
"pluginName": "balena-cli",
|
|
1294
1348
|
"pluginType": "core",
|
|
@@ -1300,17 +1354,17 @@
|
|
|
1300
1354
|
"build",
|
|
1301
1355
|
"commands",
|
|
1302
1356
|
"device",
|
|
1303
|
-
"
|
|
1357
|
+
"deactivate.js"
|
|
1304
1358
|
]
|
|
1305
1359
|
},
|
|
1306
|
-
"device:
|
|
1360
|
+
"device:detect": {
|
|
1307
1361
|
"aliases": [],
|
|
1308
1362
|
"args": {},
|
|
1309
|
-
"description": "
|
|
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.",
|
|
1310
1364
|
"examples": [
|
|
1311
|
-
"$ balena device
|
|
1312
|
-
"$ balena device
|
|
1313
|
-
"$ balena device
|
|
1365
|
+
"$ balena device detect",
|
|
1366
|
+
"$ balena device detect --timeout 120",
|
|
1367
|
+
"$ balena device detect --verbose"
|
|
1314
1368
|
],
|
|
1315
1369
|
"flags": {
|
|
1316
1370
|
"json": {
|
|
@@ -1320,10 +1374,17 @@
|
|
|
1320
1374
|
"allowNo": false,
|
|
1321
1375
|
"type": "boolean"
|
|
1322
1376
|
},
|
|
1323
|
-
"
|
|
1324
|
-
"char": "
|
|
1325
|
-
"description": "
|
|
1326
|
-
"name": "
|
|
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",
|
|
1327
1388
|
"hasDynamicHelp": false,
|
|
1328
1389
|
"multiple": false,
|
|
1329
1390
|
"type": "option"
|
|
@@ -1331,16 +1392,254 @@
|
|
|
1331
1392
|
},
|
|
1332
1393
|
"hasDynamicHelp": false,
|
|
1333
1394
|
"hiddenAliases": [],
|
|
1334
|
-
"id": "device:
|
|
1395
|
+
"id": "device:detect",
|
|
1335
1396
|
"pluginAlias": "balena-cli",
|
|
1336
1397
|
"pluginName": "balena-cli",
|
|
1337
1398
|
"pluginType": "core",
|
|
1338
1399
|
"strict": true,
|
|
1339
1400
|
"enableJsonFlag": true,
|
|
1340
1401
|
"primary": true,
|
|
1341
|
-
"
|
|
1342
|
-
"
|
|
1343
|
-
"
|
|
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",
|
|
1634
|
+
"pluginAlias": "balena-cli",
|
|
1635
|
+
"pluginName": "balena-cli",
|
|
1636
|
+
"pluginType": "core",
|
|
1637
|
+
"strict": true,
|
|
1638
|
+
"enableJsonFlag": true,
|
|
1639
|
+
"primary": true,
|
|
1640
|
+
"authenticated": true,
|
|
1641
|
+
"isESM": false,
|
|
1642
|
+
"relativePath": [
|
|
1344
1643
|
"build",
|
|
1345
1644
|
"commands",
|
|
1346
1645
|
"device",
|
|
@@ -2203,338 +2502,39 @@
|
|
|
2203
2502
|
"",
|
|
2204
2503
|
"# map remote port 22222 to any address on your host machine, port 22222",
|
|
2205
2504
|
"$ 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",
|
|
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",
|
|
2519
2517
|
"hasDynamicHelp": false,
|
|
2520
|
-
"multiple":
|
|
2518
|
+
"multiple": true,
|
|
2521
2519
|
"type": "option"
|
|
2522
2520
|
}
|
|
2523
2521
|
},
|
|
2524
2522
|
"hasDynamicHelp": false,
|
|
2525
2523
|
"hiddenAliases": [],
|
|
2526
|
-
"id": "
|
|
2524
|
+
"id": "device:tunnel",
|
|
2527
2525
|
"pluginAlias": "balena-cli",
|
|
2528
2526
|
"pluginName": "balena-cli",
|
|
2529
2527
|
"pluginType": "core",
|
|
2530
|
-
"strict":
|
|
2528
|
+
"strict": true,
|
|
2531
2529
|
"enableJsonFlag": false,
|
|
2530
|
+
"primary": true,
|
|
2531
|
+
"authenticated": true,
|
|
2532
2532
|
"isESM": false,
|
|
2533
2533
|
"relativePath": [
|
|
2534
2534
|
"build",
|
|
2535
2535
|
"commands",
|
|
2536
|
-
"
|
|
2537
|
-
"
|
|
2536
|
+
"device",
|
|
2537
|
+
"tunnel.js"
|
|
2538
2538
|
]
|
|
2539
2539
|
},
|
|
2540
2540
|
"fleet:create": {
|
|
@@ -2916,6 +2916,39 @@
|
|
|
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
|
+
},
|
|
2919
2952
|
"join": {
|
|
2920
2953
|
"aliases": [],
|
|
2921
2954
|
"args": {
|
|
@@ -2969,39 +3002,6 @@
|
|
|
2969
3002
|
"index.js"
|
|
2970
3003
|
]
|
|
2971
3004
|
},
|
|
2972
|
-
"leave": {
|
|
2973
|
-
"aliases": [],
|
|
2974
|
-
"args": {
|
|
2975
|
-
"deviceIpOrHostname": {
|
|
2976
|
-
"description": "the device IP or hostname",
|
|
2977
|
-
"name": "deviceIpOrHostname"
|
|
2978
|
-
}
|
|
2979
|
-
},
|
|
2980
|
-
"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.",
|
|
2981
|
-
"examples": [
|
|
2982
|
-
"$ balena leave",
|
|
2983
|
-
"$ balena leave balena.local",
|
|
2984
|
-
"$ balena leave 192.168.1.25"
|
|
2985
|
-
],
|
|
2986
|
-
"flags": {},
|
|
2987
|
-
"hasDynamicHelp": false,
|
|
2988
|
-
"hiddenAliases": [],
|
|
2989
|
-
"id": "leave",
|
|
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
|
-
"leave",
|
|
3002
|
-
"index.js"
|
|
3003
|
-
]
|
|
3004
|
-
},
|
|
3005
3005
|
"local:configure": {
|
|
3006
3006
|
"aliases": [],
|
|
3007
3007
|
"args": {
|
|
@@ -4074,6 +4074,30 @@
|
|
|
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
|
+
},
|
|
4077
4101
|
"release-asset:delete": {
|
|
4078
4102
|
"aliases": [],
|
|
4079
4103
|
"args": {
|
|
@@ -4289,27 +4313,64 @@
|
|
|
4289
4313
|
"upload.js"
|
|
4290
4314
|
]
|
|
4291
4315
|
},
|
|
4292
|
-
"
|
|
4316
|
+
"support": {
|
|
4293
4317
|
"aliases": [],
|
|
4294
|
-
"args": {
|
|
4295
|
-
|
|
4318
|
+
"args": {
|
|
4319
|
+
"action": {
|
|
4320
|
+
"description": "enable|disable support access",
|
|
4321
|
+
"name": "action",
|
|
4322
|
+
"options": [
|
|
4323
|
+
"enable",
|
|
4324
|
+
"disable"
|
|
4325
|
+
]
|
|
4326
|
+
}
|
|
4327
|
+
},
|
|
4328
|
+
"description": "Grant or revoke support access for devices or fleets.\n\nGrant or revoke balena support agent access to devices or fleets\non balenaCloud. (This command does not apply to openBalena.)\nAccess will be automatically revoked once the specified duration has elapsed.\n\nDuration defaults to 24h, but can be specified using --duration flag in days\nor hours, e.g. '12h', '2d'.\n\nBoth --device and --fleet flags accept multiple values, specified as\na comma-separated list (with no spaces).\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).",
|
|
4296
4329
|
"examples": [
|
|
4297
|
-
"
|
|
4330
|
+
"balena support enable --device ab346f,cd457a --duration 3d",
|
|
4331
|
+
"balena support enable --fleet myFleet --duration 12h",
|
|
4332
|
+
"balena support disable -f myorg/myfleet"
|
|
4298
4333
|
],
|
|
4299
|
-
"flags": {
|
|
4334
|
+
"flags": {
|
|
4335
|
+
"device": {
|
|
4336
|
+
"char": "d",
|
|
4337
|
+
"description": "comma-separated list (no spaces) of device UUIDs",
|
|
4338
|
+
"name": "device",
|
|
4339
|
+
"hasDynamicHelp": false,
|
|
4340
|
+
"multiple": false,
|
|
4341
|
+
"type": "option"
|
|
4342
|
+
},
|
|
4343
|
+
"fleet": {
|
|
4344
|
+
"char": "f",
|
|
4345
|
+
"description": "comma-separated list (no spaces) of fleet names or slugs (preferred)",
|
|
4346
|
+
"name": "fleet",
|
|
4347
|
+
"hasDynamicHelp": false,
|
|
4348
|
+
"multiple": false,
|
|
4349
|
+
"type": "option"
|
|
4350
|
+
},
|
|
4351
|
+
"duration": {
|
|
4352
|
+
"char": "t",
|
|
4353
|
+
"description": "length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d",
|
|
4354
|
+
"name": "duration",
|
|
4355
|
+
"hasDynamicHelp": false,
|
|
4356
|
+
"multiple": false,
|
|
4357
|
+
"type": "option"
|
|
4358
|
+
}
|
|
4359
|
+
},
|
|
4300
4360
|
"hasDynamicHelp": false,
|
|
4301
4361
|
"hiddenAliases": [],
|
|
4302
|
-
"id": "
|
|
4362
|
+
"id": "support",
|
|
4303
4363
|
"pluginAlias": "balena-cli",
|
|
4304
4364
|
"pluginName": "balena-cli",
|
|
4305
4365
|
"pluginType": "core",
|
|
4306
4366
|
"strict": true,
|
|
4307
4367
|
"enableJsonFlag": false,
|
|
4368
|
+
"authenticated": true,
|
|
4308
4369
|
"isESM": false,
|
|
4309
4370
|
"relativePath": [
|
|
4310
4371
|
"build",
|
|
4311
4372
|
"commands",
|
|
4312
|
-
"
|
|
4373
|
+
"support",
|
|
4313
4374
|
"index.js"
|
|
4314
4375
|
]
|
|
4315
4376
|
},
|
|
@@ -4448,67 +4509,6 @@
|
|
|
4448
4509
|
"rm.js"
|
|
4449
4510
|
]
|
|
4450
4511
|
},
|
|
4451
|
-
"support": {
|
|
4452
|
-
"aliases": [],
|
|
4453
|
-
"args": {
|
|
4454
|
-
"action": {
|
|
4455
|
-
"description": "enable|disable support access",
|
|
4456
|
-
"name": "action",
|
|
4457
|
-
"options": [
|
|
4458
|
-
"enable",
|
|
4459
|
-
"disable"
|
|
4460
|
-
]
|
|
4461
|
-
}
|
|
4462
|
-
},
|
|
4463
|
-
"description": "Grant or revoke support access for devices or fleets.\n\nGrant or revoke balena support agent access to devices or fleets\non balenaCloud. (This command does not apply to openBalena.)\nAccess will be automatically revoked once the specified duration has elapsed.\n\nDuration defaults to 24h, but can be specified using --duration flag in days\nor hours, e.g. '12h', '2d'.\n\nBoth --device and --fleet flags accept multiple values, specified as\na comma-separated list (with no spaces).\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).",
|
|
4464
|
-
"examples": [
|
|
4465
|
-
"balena support enable --device ab346f,cd457a --duration 3d",
|
|
4466
|
-
"balena support enable --fleet myFleet --duration 12h",
|
|
4467
|
-
"balena support disable -f myorg/myfleet"
|
|
4468
|
-
],
|
|
4469
|
-
"flags": {
|
|
4470
|
-
"device": {
|
|
4471
|
-
"char": "d",
|
|
4472
|
-
"description": "comma-separated list (no spaces) of device UUIDs",
|
|
4473
|
-
"name": "device",
|
|
4474
|
-
"hasDynamicHelp": false,
|
|
4475
|
-
"multiple": false,
|
|
4476
|
-
"type": "option"
|
|
4477
|
-
},
|
|
4478
|
-
"fleet": {
|
|
4479
|
-
"char": "f",
|
|
4480
|
-
"description": "comma-separated list (no spaces) of fleet names or slugs (preferred)",
|
|
4481
|
-
"name": "fleet",
|
|
4482
|
-
"hasDynamicHelp": false,
|
|
4483
|
-
"multiple": false,
|
|
4484
|
-
"type": "option"
|
|
4485
|
-
},
|
|
4486
|
-
"duration": {
|
|
4487
|
-
"char": "t",
|
|
4488
|
-
"description": "length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d",
|
|
4489
|
-
"name": "duration",
|
|
4490
|
-
"hasDynamicHelp": false,
|
|
4491
|
-
"multiple": false,
|
|
4492
|
-
"type": "option"
|
|
4493
|
-
}
|
|
4494
|
-
},
|
|
4495
|
-
"hasDynamicHelp": false,
|
|
4496
|
-
"hiddenAliases": [],
|
|
4497
|
-
"id": "support",
|
|
4498
|
-
"pluginAlias": "balena-cli",
|
|
4499
|
-
"pluginName": "balena-cli",
|
|
4500
|
-
"pluginType": "core",
|
|
4501
|
-
"strict": true,
|
|
4502
|
-
"enableJsonFlag": false,
|
|
4503
|
-
"authenticated": true,
|
|
4504
|
-
"isESM": false,
|
|
4505
|
-
"relativePath": [
|
|
4506
|
-
"build",
|
|
4507
|
-
"commands",
|
|
4508
|
-
"support",
|
|
4509
|
-
"index.js"
|
|
4510
|
-
]
|
|
4511
|
-
},
|
|
4512
4512
|
"tag:list": {
|
|
4513
4513
|
"aliases": [],
|
|
4514
4514
|
"args": {},
|
|
@@ -4729,53 +4729,53 @@
|
|
|
4729
4729
|
"set.js"
|
|
4730
4730
|
]
|
|
4731
4731
|
},
|
|
4732
|
-
"
|
|
4732
|
+
"whoami": {
|
|
4733
4733
|
"aliases": [],
|
|
4734
4734
|
"args": {},
|
|
4735
|
-
"description": "
|
|
4735
|
+
"description": "Display account information for current user.\n\nGet the username and email address of the currently logged in user.",
|
|
4736
|
+
"examples": [
|
|
4737
|
+
"$ balena whoami"
|
|
4738
|
+
],
|
|
4736
4739
|
"flags": {},
|
|
4737
4740
|
"hasDynamicHelp": false,
|
|
4738
4741
|
"hiddenAliases": [],
|
|
4739
|
-
"id": "
|
|
4742
|
+
"id": "whoami",
|
|
4740
4743
|
"pluginAlias": "balena-cli",
|
|
4741
4744
|
"pluginName": "balena-cli",
|
|
4742
4745
|
"pluginType": "core",
|
|
4743
4746
|
"strict": true,
|
|
4744
4747
|
"enableJsonFlag": false,
|
|
4745
|
-
"
|
|
4748
|
+
"authenticated": true,
|
|
4746
4749
|
"isESM": false,
|
|
4747
4750
|
"relativePath": [
|
|
4748
4751
|
"build",
|
|
4749
4752
|
"commands",
|
|
4750
|
-
"
|
|
4751
|
-
"
|
|
4753
|
+
"whoami",
|
|
4754
|
+
"index.js"
|
|
4752
4755
|
]
|
|
4753
4756
|
},
|
|
4754
|
-
"
|
|
4757
|
+
"util:available-drives": {
|
|
4755
4758
|
"aliases": [],
|
|
4756
4759
|
"args": {},
|
|
4757
|
-
"description": "
|
|
4758
|
-
"examples": [
|
|
4759
|
-
"$ balena whoami"
|
|
4760
|
-
],
|
|
4760
|
+
"description": "List available drives.\n\nList available drives which are usable for writing an OS image to.\nDoes not list system drives.",
|
|
4761
4761
|
"flags": {},
|
|
4762
4762
|
"hasDynamicHelp": false,
|
|
4763
4763
|
"hiddenAliases": [],
|
|
4764
|
-
"id": "
|
|
4764
|
+
"id": "util:available-drives",
|
|
4765
4765
|
"pluginAlias": "balena-cli",
|
|
4766
4766
|
"pluginName": "balena-cli",
|
|
4767
4767
|
"pluginType": "core",
|
|
4768
4768
|
"strict": true,
|
|
4769
4769
|
"enableJsonFlag": false,
|
|
4770
|
-
"
|
|
4770
|
+
"offlineCompatible": true,
|
|
4771
4771
|
"isESM": false,
|
|
4772
4772
|
"relativePath": [
|
|
4773
4773
|
"build",
|
|
4774
4774
|
"commands",
|
|
4775
|
-
"
|
|
4776
|
-
"
|
|
4775
|
+
"util",
|
|
4776
|
+
"available-drives.js"
|
|
4777
4777
|
]
|
|
4778
4778
|
}
|
|
4779
4779
|
},
|
|
4780
|
-
"version": "23.2.
|
|
4780
|
+
"version": "23.2.12"
|
|
4781
4781
|
}
|