balena-cli 23.2.6 → 23.2.7-build-renovate-aws-actions-configure-aws-credentials-5-x-901627565d5c6179c0d1c2cb1b3cf932349b55a4-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 +2 -2
- package/oclif.manifest.json +441 -441
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file
|
|
|
4
4
|
automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
|
|
5
5
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
|
6
6
|
|
|
7
|
+
## 23.2.7 - 2025-12-05
|
|
8
|
+
|
|
9
|
+
* Update aws-actions/configure-aws-credentials action to v5 [balena-renovate[bot]]
|
|
10
|
+
|
|
7
11
|
## 23.2.6 - 2025-12-05
|
|
8
12
|
|
|
9
13
|
* Update apple-actions/import-codesign-certs action to v3 [balena-renovate[bot]]
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "balena-cli",
|
|
3
|
-
"version": "23.2.
|
|
3
|
+
"version": "23.2.7-build-renovate-aws-actions-configure-aws-credentials-5-x-901627565d5c6179c0d1c2cb1b3cf932349b55a4-1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "balena-cli",
|
|
9
|
-
"version": "23.2.
|
|
9
|
+
"version": "23.2.7-build-renovate-aws-actions-configure-aws-credentials-5-x-901627565d5c6179c0d1c2cb1b3cf932349b55a4-1",
|
|
10
10
|
"hasInstallScript": true,
|
|
11
11
|
"license": "Apache-2.0",
|
|
12
12
|
"dependencies": {
|
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": {},
|
|
@@ -995,27 +995,326 @@
|
|
|
995
995
|
"allowNo": false,
|
|
996
996
|
"type": "boolean"
|
|
997
997
|
},
|
|
998
|
-
"all": {
|
|
999
|
-
"description": "include device types no longer supported by balena",
|
|
1000
|
-
"name": "all",
|
|
998
|
+
"all": {
|
|
999
|
+
"description": "include device types no longer supported by balena",
|
|
1000
|
+
"name": "all",
|
|
1001
|
+
"allowNo": false,
|
|
1002
|
+
"type": "boolean"
|
|
1003
|
+
}
|
|
1004
|
+
},
|
|
1005
|
+
"hasDynamicHelp": false,
|
|
1006
|
+
"hiddenAliases": [],
|
|
1007
|
+
"id": "device-type:list",
|
|
1008
|
+
"pluginAlias": "balena-cli",
|
|
1009
|
+
"pluginName": "balena-cli",
|
|
1010
|
+
"pluginType": "core",
|
|
1011
|
+
"strict": true,
|
|
1012
|
+
"enableJsonFlag": true,
|
|
1013
|
+
"isESM": false,
|
|
1014
|
+
"relativePath": [
|
|
1015
|
+
"build",
|
|
1016
|
+
"commands",
|
|
1017
|
+
"device-type",
|
|
1018
|
+
"list.js"
|
|
1019
|
+
]
|
|
1020
|
+
},
|
|
1021
|
+
"env:list": {
|
|
1022
|
+
"aliases": [],
|
|
1023
|
+
"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).",
|
|
1025
|
+
"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"
|
|
1031
|
+
],
|
|
1032
|
+
"flags": {
|
|
1033
|
+
"json": {
|
|
1034
|
+
"description": "Format output as json.",
|
|
1035
|
+
"helpGroup": "GLOBAL",
|
|
1036
|
+
"name": "json",
|
|
1037
|
+
"allowNo": false,
|
|
1038
|
+
"type": "boolean"
|
|
1039
|
+
},
|
|
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",
|
|
1058
|
+
"allowNo": false,
|
|
1059
|
+
"type": "boolean"
|
|
1060
|
+
},
|
|
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",
|
|
1079
|
+
"hasDynamicHelp": false,
|
|
1080
|
+
"multiple": false,
|
|
1081
|
+
"type": "option"
|
|
1082
|
+
}
|
|
1083
|
+
},
|
|
1084
|
+
"hasDynamicHelp": false,
|
|
1085
|
+
"hiddenAliases": [],
|
|
1086
|
+
"id": "env:list",
|
|
1087
|
+
"pluginAlias": "balena-cli",
|
|
1088
|
+
"pluginName": "balena-cli",
|
|
1089
|
+
"pluginType": "core",
|
|
1090
|
+
"strict": true,
|
|
1091
|
+
"enableJsonFlag": true,
|
|
1092
|
+
"isESM": false,
|
|
1093
|
+
"relativePath": [
|
|
1094
|
+
"build",
|
|
1095
|
+
"commands",
|
|
1096
|
+
"env",
|
|
1097
|
+
"list.js"
|
|
1098
|
+
]
|
|
1099
|
+
},
|
|
1100
|
+
"env:rename": {
|
|
1101
|
+
"aliases": [],
|
|
1102
|
+
"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",
|
|
1111
|
+
"required": true
|
|
1112
|
+
}
|
|
1113
|
+
},
|
|
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.",
|
|
1115
|
+
"examples": [
|
|
1116
|
+
"$ balena env rename 123123 emacs",
|
|
1117
|
+
"$ balena env rename 234234 emacs --service",
|
|
1118
|
+
"$ balena env rename 345345 emacs --device",
|
|
1119
|
+
"$ balena env rename 456456 emacs --device --service",
|
|
1120
|
+
"$ balena env rename 567567 1 --config",
|
|
1121
|
+
"$ balena env rename 678678 1 --device --config"
|
|
1122
|
+
],
|
|
1123
|
+
"flags": {
|
|
1124
|
+
"config": {
|
|
1125
|
+
"char": "c",
|
|
1126
|
+
"description": "select a configuration variable (may be used together with the --device option)",
|
|
1127
|
+
"exclusive": [
|
|
1128
|
+
"service"
|
|
1129
|
+
],
|
|
1130
|
+
"name": "config",
|
|
1131
|
+
"allowNo": false,
|
|
1132
|
+
"type": "boolean"
|
|
1133
|
+
},
|
|
1134
|
+
"device": {
|
|
1135
|
+
"char": "d",
|
|
1136
|
+
"description": "select a device-specific variable instead of a fleet variable",
|
|
1137
|
+
"name": "device",
|
|
1138
|
+
"allowNo": false,
|
|
1139
|
+
"type": "boolean"
|
|
1140
|
+
},
|
|
1141
|
+
"service": {
|
|
1142
|
+
"char": "s",
|
|
1143
|
+
"description": "select a service variable (may be used together with the --device option)",
|
|
1144
|
+
"exclusive": [
|
|
1145
|
+
"config"
|
|
1146
|
+
],
|
|
1147
|
+
"name": "service",
|
|
1148
|
+
"allowNo": false,
|
|
1149
|
+
"type": "boolean"
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1152
|
+
"hasDynamicHelp": false,
|
|
1153
|
+
"hiddenAliases": [],
|
|
1154
|
+
"id": "env:rename",
|
|
1155
|
+
"pluginAlias": "balena-cli",
|
|
1156
|
+
"pluginName": "balena-cli",
|
|
1157
|
+
"pluginType": "core",
|
|
1158
|
+
"strict": true,
|
|
1159
|
+
"enableJsonFlag": false,
|
|
1160
|
+
"isESM": false,
|
|
1161
|
+
"relativePath": [
|
|
1162
|
+
"build",
|
|
1163
|
+
"commands",
|
|
1164
|
+
"env",
|
|
1165
|
+
"rename.js"
|
|
1166
|
+
]
|
|
1167
|
+
},
|
|
1168
|
+
"env:rm": {
|
|
1169
|
+
"aliases": [],
|
|
1170
|
+
"args": {
|
|
1171
|
+
"id": {
|
|
1172
|
+
"description": "variable's numeric database ID",
|
|
1173
|
+
"name": "id",
|
|
1174
|
+
"required": true
|
|
1175
|
+
}
|
|
1176
|
+
},
|
|
1177
|
+
"description": "Remove a config or env var from a fleet, device or service.\n\nRemove a configuration or environment variable from a fleet, device\nor service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.\n\nInteractive confirmation is normally asked before the variable is deleted.\nThe --yes option disables this behavior.",
|
|
1178
|
+
"examples": [
|
|
1179
|
+
"$ balena env rm 123123",
|
|
1180
|
+
"$ balena env rm 234234 --yes",
|
|
1181
|
+
"$ balena env rm 345345 --config",
|
|
1182
|
+
"$ balena env rm 456456 --service",
|
|
1183
|
+
"$ balena env rm 567567 --device",
|
|
1184
|
+
"$ balena env rm 678678 --device --config",
|
|
1185
|
+
"$ balena env rm 789789 --device --service --yes"
|
|
1186
|
+
],
|
|
1187
|
+
"flags": {
|
|
1188
|
+
"config": {
|
|
1189
|
+
"char": "c",
|
|
1190
|
+
"description": "select a configuration variable (may be used together with the --device option)",
|
|
1191
|
+
"exclusive": [
|
|
1192
|
+
"service"
|
|
1193
|
+
],
|
|
1194
|
+
"name": "config",
|
|
1195
|
+
"allowNo": false,
|
|
1196
|
+
"type": "boolean"
|
|
1197
|
+
},
|
|
1198
|
+
"device": {
|
|
1199
|
+
"char": "d",
|
|
1200
|
+
"description": "select a device-specific variable instead of a fleet variable",
|
|
1201
|
+
"name": "device",
|
|
1202
|
+
"allowNo": false,
|
|
1203
|
+
"type": "boolean"
|
|
1204
|
+
},
|
|
1205
|
+
"service": {
|
|
1206
|
+
"char": "s",
|
|
1207
|
+
"description": "select a service variable (may be used together with the --device option)",
|
|
1208
|
+
"exclusive": [
|
|
1209
|
+
"config"
|
|
1210
|
+
],
|
|
1211
|
+
"name": "service",
|
|
1212
|
+
"allowNo": false,
|
|
1213
|
+
"type": "boolean"
|
|
1214
|
+
},
|
|
1215
|
+
"yes": {
|
|
1216
|
+
"char": "y",
|
|
1217
|
+
"description": "do not prompt for confirmation before deleting the variable",
|
|
1218
|
+
"name": "yes",
|
|
1219
|
+
"allowNo": false,
|
|
1220
|
+
"type": "boolean"
|
|
1221
|
+
}
|
|
1222
|
+
},
|
|
1223
|
+
"hasDynamicHelp": false,
|
|
1224
|
+
"hiddenAliases": [],
|
|
1225
|
+
"id": "env:rm",
|
|
1226
|
+
"pluginAlias": "balena-cli",
|
|
1227
|
+
"pluginName": "balena-cli",
|
|
1228
|
+
"pluginType": "core",
|
|
1229
|
+
"strict": true,
|
|
1230
|
+
"enableJsonFlag": false,
|
|
1231
|
+
"isESM": false,
|
|
1232
|
+
"relativePath": [
|
|
1233
|
+
"build",
|
|
1234
|
+
"commands",
|
|
1235
|
+
"env",
|
|
1236
|
+
"rm.js"
|
|
1237
|
+
]
|
|
1238
|
+
},
|
|
1239
|
+
"env:set": {
|
|
1240
|
+
"aliases": [],
|
|
1241
|
+
"args": {
|
|
1242
|
+
"name": {
|
|
1243
|
+
"description": "environment or config variable name",
|
|
1244
|
+
"name": "name",
|
|
1245
|
+
"required": true
|
|
1246
|
+
},
|
|
1247
|
+
"value": {
|
|
1248
|
+
"description": "variable value; if omitted, use value from this process' environment",
|
|
1249
|
+
"name": "value",
|
|
1250
|
+
"required": false
|
|
1251
|
+
}
|
|
1252
|
+
},
|
|
1253
|
+
"description": "Add or update env or config variable to fleets, devices or services.\n\nAdd or update an environment or config variable to one or more fleets, devices or\nservices, as selected by the respective command-line options. Either the\n--fleet or the --device option must be provided, and either may be be\nused alongside the --service option to define a service-specific variable.\n(A service corresponds to a Docker image/container in a microservices fleet.)\nWhen the --service option is used in conjunction with the --device option,\nthe service variable applies to the selected device only. Otherwise, it\napplies to all devices of the selected fleet. If the --service option is\nomitted, the variable applies to all services.\n\nIf VALUE is omitted, the CLI will attempt to use the value of the environment\nvariable of same name in the CLI process' environment. In this case, a warning\nmessage will be printed. Use `--quiet` to suppress it.\n\n'BALENA_' or 'RESIN_' are reserved variable name prefixes used to identify\n\"configuration variables\". Configuration variables control balena platform\nfeatures and are treated specially by balenaOS and the balena supervisor\nrunning on devices. They are also stored differently in the balenaCloud API\ndatabase. Configuration variables cannot be set for specific services,\ntherefore the --service option cannot be used when the variable name starts\nwith a reserved prefix. When defining custom fleet variables, please avoid\nthese reserved prefixes.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
|
|
1254
|
+
"examples": [
|
|
1255
|
+
"$ balena env set TERM --fleet MyFleet",
|
|
1256
|
+
"$ balena env set EDITOR vim -f myorg/myfleet",
|
|
1257
|
+
"$ balena env set EDITOR vim --fleet MyFleet,MyFleet2",
|
|
1258
|
+
"$ balena env set EDITOR vim --fleet MyFleet --service MyService",
|
|
1259
|
+
"$ balena env set EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2",
|
|
1260
|
+
"$ balena env set EDITOR vim --device 7cf02a6",
|
|
1261
|
+
"$ balena env set EDITOR vim --device 7cf02a6,d6f1433",
|
|
1262
|
+
"$ balena env set EDITOR vim --device 7cf02a6 --service MyService",
|
|
1263
|
+
"$ balena env set EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2"
|
|
1264
|
+
],
|
|
1265
|
+
"flags": {
|
|
1266
|
+
"fleet": {
|
|
1267
|
+
"char": "f",
|
|
1268
|
+
"description": "fleet name or slug (preferred)",
|
|
1269
|
+
"exclusive": [
|
|
1270
|
+
"device"
|
|
1271
|
+
],
|
|
1272
|
+
"name": "fleet",
|
|
1273
|
+
"hasDynamicHelp": false,
|
|
1274
|
+
"multiple": false,
|
|
1275
|
+
"type": "option"
|
|
1276
|
+
},
|
|
1277
|
+
"device": {
|
|
1278
|
+
"char": "d",
|
|
1279
|
+
"description": "device UUID",
|
|
1280
|
+
"exclusive": [
|
|
1281
|
+
"fleet"
|
|
1282
|
+
],
|
|
1283
|
+
"name": "device",
|
|
1284
|
+
"hasDynamicHelp": false,
|
|
1285
|
+
"multiple": false,
|
|
1286
|
+
"type": "option"
|
|
1287
|
+
},
|
|
1288
|
+
"quiet": {
|
|
1289
|
+
"char": "q",
|
|
1290
|
+
"description": "suppress warning messages",
|
|
1291
|
+
"name": "quiet",
|
|
1001
1292
|
"allowNo": false,
|
|
1002
1293
|
"type": "boolean"
|
|
1294
|
+
},
|
|
1295
|
+
"service": {
|
|
1296
|
+
"char": "s",
|
|
1297
|
+
"description": "service name",
|
|
1298
|
+
"name": "service",
|
|
1299
|
+
"hasDynamicHelp": false,
|
|
1300
|
+
"multiple": false,
|
|
1301
|
+
"type": "option"
|
|
1003
1302
|
}
|
|
1004
1303
|
},
|
|
1005
1304
|
"hasDynamicHelp": false,
|
|
1006
1305
|
"hiddenAliases": [],
|
|
1007
|
-
"id": "
|
|
1306
|
+
"id": "env:set",
|
|
1008
1307
|
"pluginAlias": "balena-cli",
|
|
1009
1308
|
"pluginName": "balena-cli",
|
|
1010
1309
|
"pluginType": "core",
|
|
1011
|
-
"strict":
|
|
1012
|
-
"enableJsonFlag":
|
|
1310
|
+
"strict": false,
|
|
1311
|
+
"enableJsonFlag": false,
|
|
1013
1312
|
"isESM": false,
|
|
1014
1313
|
"relativePath": [
|
|
1015
1314
|
"build",
|
|
1016
1315
|
"commands",
|
|
1017
|
-
"
|
|
1018
|
-
"
|
|
1316
|
+
"env",
|
|
1317
|
+
"set.js"
|
|
1019
1318
|
]
|
|
1020
1319
|
},
|
|
1021
1320
|
"device:deactivate": {
|
|
@@ -2090,451 +2389,152 @@
|
|
|
2090
2389
|
"service": {
|
|
2091
2390
|
"description": "comma-separated list (no blank spaces) of service names",
|
|
2092
2391
|
"name": "service",
|
|
2093
|
-
"required": true
|
|
2094
|
-
}
|
|
2095
|
-
},
|
|
2096
|
-
"description": "Start containers on a device.\n\nStart containers on a device.\n\nMultiple devices and services may be specified with a comma-separated list\nof values (no spaces).",
|
|
2097
|
-
"examples": [
|
|
2098
|
-
"$ balena device start-service 23c73a1 myService",
|
|
2099
|
-
"$ balena device start-service 23c73a1 myService1,myService2"
|
|
2100
|
-
],
|
|
2101
|
-
"flags": {},
|
|
2102
|
-
"hasDynamicHelp": false,
|
|
2103
|
-
"hiddenAliases": [],
|
|
2104
|
-
"id": "device:start-service",
|
|
2105
|
-
"pluginAlias": "balena-cli",
|
|
2106
|
-
"pluginName": "balena-cli",
|
|
2107
|
-
"pluginType": "core",
|
|
2108
|
-
"strict": true,
|
|
2109
|
-
"enableJsonFlag": false,
|
|
2110
|
-
"authenticated": true,
|
|
2111
|
-
"isESM": false,
|
|
2112
|
-
"relativePath": [
|
|
2113
|
-
"build",
|
|
2114
|
-
"commands",
|
|
2115
|
-
"device",
|
|
2116
|
-
"start-service.js"
|
|
2117
|
-
]
|
|
2118
|
-
},
|
|
2119
|
-
"device:stop-service": {
|
|
2120
|
-
"aliases": [],
|
|
2121
|
-
"args": {
|
|
2122
|
-
"uuid": {
|
|
2123
|
-
"description": "comma-separated list (no blank spaces) of device UUIDs",
|
|
2124
|
-
"name": "uuid",
|
|
2125
|
-
"required": true
|
|
2126
|
-
},
|
|
2127
|
-
"service": {
|
|
2128
|
-
"description": "comma-separated list (no blank spaces) of service names",
|
|
2129
|
-
"name": "service",
|
|
2130
|
-
"required": true
|
|
2131
|
-
}
|
|
2132
|
-
},
|
|
2133
|
-
"description": "Stop containers on a device.\n\nStop containers on a device.\n\nMultiple devices and services may be specified with a comma-separated list\nof values (no spaces).",
|
|
2134
|
-
"examples": [
|
|
2135
|
-
"$ balena device stop-service 23c73a1 myService",
|
|
2136
|
-
"$ balena device stop-service 23c73a1 myService1,myService2"
|
|
2137
|
-
],
|
|
2138
|
-
"flags": {},
|
|
2139
|
-
"hasDynamicHelp": false,
|
|
2140
|
-
"hiddenAliases": [],
|
|
2141
|
-
"id": "device:stop-service",
|
|
2142
|
-
"pluginAlias": "balena-cli",
|
|
2143
|
-
"pluginName": "balena-cli",
|
|
2144
|
-
"pluginType": "core",
|
|
2145
|
-
"strict": true,
|
|
2146
|
-
"enableJsonFlag": false,
|
|
2147
|
-
"authenticated": true,
|
|
2148
|
-
"isESM": false,
|
|
2149
|
-
"relativePath": [
|
|
2150
|
-
"build",
|
|
2151
|
-
"commands",
|
|
2152
|
-
"device",
|
|
2153
|
-
"stop-service.js"
|
|
2154
|
-
]
|
|
2155
|
-
},
|
|
2156
|
-
"device:track-fleet": {
|
|
2157
|
-
"aliases": [],
|
|
2158
|
-
"args": {
|
|
2159
|
-
"uuid": {
|
|
2160
|
-
"description": "the uuid of the device to make track the fleet's release",
|
|
2161
|
-
"name": "uuid",
|
|
2162
|
-
"required": true
|
|
2163
|
-
}
|
|
2164
|
-
},
|
|
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"
|
|
2392
|
+
"required": true
|
|
2302
2393
|
}
|
|
2303
2394
|
},
|
|
2395
|
+
"description": "Start containers on a device.\n\nStart containers on a device.\n\nMultiple devices and services may be specified with a comma-separated list\nof values (no spaces).",
|
|
2396
|
+
"examples": [
|
|
2397
|
+
"$ balena device start-service 23c73a1 myService",
|
|
2398
|
+
"$ balena device start-service 23c73a1 myService1,myService2"
|
|
2399
|
+
],
|
|
2400
|
+
"flags": {},
|
|
2304
2401
|
"hasDynamicHelp": false,
|
|
2305
2402
|
"hiddenAliases": [],
|
|
2306
|
-
"id": "
|
|
2403
|
+
"id": "device:start-service",
|
|
2307
2404
|
"pluginAlias": "balena-cli",
|
|
2308
2405
|
"pluginName": "balena-cli",
|
|
2309
2406
|
"pluginType": "core",
|
|
2310
2407
|
"strict": true,
|
|
2311
|
-
"enableJsonFlag":
|
|
2408
|
+
"enableJsonFlag": false,
|
|
2409
|
+
"authenticated": true,
|
|
2312
2410
|
"isESM": false,
|
|
2313
2411
|
"relativePath": [
|
|
2314
2412
|
"build",
|
|
2315
2413
|
"commands",
|
|
2316
|
-
"
|
|
2317
|
-
"
|
|
2414
|
+
"device",
|
|
2415
|
+
"start-service.js"
|
|
2318
2416
|
]
|
|
2319
2417
|
},
|
|
2320
|
-
"
|
|
2418
|
+
"device:stop-service": {
|
|
2321
2419
|
"aliases": [],
|
|
2322
2420
|
"args": {
|
|
2323
|
-
"
|
|
2324
|
-
"description": "
|
|
2325
|
-
"name": "
|
|
2421
|
+
"uuid": {
|
|
2422
|
+
"description": "comma-separated list (no blank spaces) of device UUIDs",
|
|
2423
|
+
"name": "uuid",
|
|
2326
2424
|
"required": true
|
|
2327
2425
|
},
|
|
2328
|
-
"
|
|
2329
|
-
"description": "
|
|
2330
|
-
"name": "
|
|
2426
|
+
"service": {
|
|
2427
|
+
"description": "comma-separated list (no blank spaces) of service names",
|
|
2428
|
+
"name": "service",
|
|
2331
2429
|
"required": true
|
|
2332
2430
|
}
|
|
2333
2431
|
},
|
|
2334
|
-
"description": "
|
|
2432
|
+
"description": "Stop containers on a device.\n\nStop containers on a device.\n\nMultiple devices and services may be specified with a comma-separated list\nof values (no spaces).",
|
|
2335
2433
|
"examples": [
|
|
2336
|
-
"$ balena
|
|
2337
|
-
"$ balena
|
|
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"
|
|
2434
|
+
"$ balena device stop-service 23c73a1 myService",
|
|
2435
|
+
"$ balena device stop-service 23c73a1 myService1,myService2"
|
|
2342
2436
|
],
|
|
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
|
-
},
|
|
2437
|
+
"flags": {},
|
|
2372
2438
|
"hasDynamicHelp": false,
|
|
2373
2439
|
"hiddenAliases": [],
|
|
2374
|
-
"id": "
|
|
2440
|
+
"id": "device:stop-service",
|
|
2375
2441
|
"pluginAlias": "balena-cli",
|
|
2376
2442
|
"pluginName": "balena-cli",
|
|
2377
2443
|
"pluginType": "core",
|
|
2378
2444
|
"strict": true,
|
|
2379
2445
|
"enableJsonFlag": false,
|
|
2446
|
+
"authenticated": true,
|
|
2380
2447
|
"isESM": false,
|
|
2381
2448
|
"relativePath": [
|
|
2382
2449
|
"build",
|
|
2383
2450
|
"commands",
|
|
2384
|
-
"
|
|
2385
|
-
"
|
|
2451
|
+
"device",
|
|
2452
|
+
"stop-service.js"
|
|
2386
2453
|
]
|
|
2387
2454
|
},
|
|
2388
|
-
"
|
|
2455
|
+
"device:track-fleet": {
|
|
2389
2456
|
"aliases": [],
|
|
2390
2457
|
"args": {
|
|
2391
|
-
"
|
|
2392
|
-
"description": "
|
|
2393
|
-
"name": "
|
|
2458
|
+
"uuid": {
|
|
2459
|
+
"description": "the uuid of the device to make track the fleet's release",
|
|
2460
|
+
"name": "uuid",
|
|
2394
2461
|
"required": true
|
|
2395
2462
|
}
|
|
2396
2463
|
},
|
|
2397
|
-
"description": "
|
|
2464
|
+
"description": "Make a device track the fleet's pinned release.\n\nMake a device track the fleet's pinned release.",
|
|
2398
2465
|
"examples": [
|
|
2399
|
-
"$ balena
|
|
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"
|
|
2466
|
+
"$ balena device track-fleet 7cf02a6"
|
|
2406
2467
|
],
|
|
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
|
-
},
|
|
2468
|
+
"flags": {},
|
|
2443
2469
|
"hasDynamicHelp": false,
|
|
2444
2470
|
"hiddenAliases": [],
|
|
2445
|
-
"id": "
|
|
2471
|
+
"id": "device:track-fleet",
|
|
2446
2472
|
"pluginAlias": "balena-cli",
|
|
2447
2473
|
"pluginName": "balena-cli",
|
|
2448
2474
|
"pluginType": "core",
|
|
2449
2475
|
"strict": true,
|
|
2450
2476
|
"enableJsonFlag": false,
|
|
2477
|
+
"authenticated": true,
|
|
2451
2478
|
"isESM": false,
|
|
2452
2479
|
"relativePath": [
|
|
2453
2480
|
"build",
|
|
2454
2481
|
"commands",
|
|
2455
|
-
"
|
|
2456
|
-
"
|
|
2482
|
+
"device",
|
|
2483
|
+
"track-fleet.js"
|
|
2457
2484
|
]
|
|
2458
2485
|
},
|
|
2459
|
-
"
|
|
2486
|
+
"device:tunnel": {
|
|
2460
2487
|
"aliases": [],
|
|
2461
2488
|
"args": {
|
|
2462
|
-
"
|
|
2463
|
-
"description": "
|
|
2464
|
-
"name": "
|
|
2489
|
+
"deviceOrFleet": {
|
|
2490
|
+
"description": "device UUID or fleet name/slug",
|
|
2491
|
+
"name": "deviceOrFleet",
|
|
2465
2492
|
"required": true
|
|
2466
|
-
},
|
|
2467
|
-
"value": {
|
|
2468
|
-
"description": "variable value; if omitted, use value from this process' environment",
|
|
2469
|
-
"name": "value",
|
|
2470
|
-
"required": false
|
|
2471
2493
|
}
|
|
2472
2494
|
},
|
|
2473
|
-
"description": "
|
|
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.",
|
|
2474
2496
|
"examples": [
|
|
2475
|
-
"
|
|
2476
|
-
"$ balena
|
|
2477
|
-
"
|
|
2478
|
-
"
|
|
2479
|
-
"$ balena
|
|
2480
|
-
"
|
|
2481
|
-
"
|
|
2482
|
-
"$ balena
|
|
2483
|
-
"
|
|
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"
|
|
2484
2511
|
],
|
|
2485
2512
|
"flags": {
|
|
2486
|
-
"
|
|
2487
|
-
"char": "
|
|
2488
|
-
"description": "
|
|
2489
|
-
"
|
|
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",
|
|
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": {
|
|
@@ -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.7"
|
|
4781
4781
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "balena-cli",
|
|
3
|
-
"version": "23.2.
|
|
3
|
+
"version": "23.2.7-build-renovate-aws-actions-configure-aws-credentials-5-x-901627565d5c6179c0d1c2cb1b3cf932349b55a4-1",
|
|
4
4
|
"description": "The official balena Command Line Interface",
|
|
5
5
|
"main": "./build/app.js",
|
|
6
6
|
"homepage": "https://github.com/balena-io/balena-cli",
|
|
@@ -262,6 +262,6 @@
|
|
|
262
262
|
"balena-request": "14.0.6"
|
|
263
263
|
},
|
|
264
264
|
"versionist": {
|
|
265
|
-
"publishedAt": "2025-12-
|
|
265
|
+
"publishedAt": "2025-12-05T12:10:52.044Z"
|
|
266
266
|
}
|
|
267
267
|
}
|