balena-cli 23.1.2 → 23.1.3
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/build/hooks/prerun.js +4 -2
- package/build/hooks/prerun.js.map +1 -1
- package/npm-shrinkwrap.json +105 -127
- package/oclif.manifest.json +334 -334
- package/package.json +2 -2
- package/src/hooks/prerun.ts +3 -0
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": {},
|
|
@@ -979,6 +979,45 @@
|
|
|
979
979
|
"index.js"
|
|
980
980
|
]
|
|
981
981
|
},
|
|
982
|
+
"device-type:list": {
|
|
983
|
+
"aliases": [],
|
|
984
|
+
"args": {},
|
|
985
|
+
"description": "List the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nList the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nBy default, only actively supported device types are listed.\nThe --all option can be used to list all device types, including those that are\nno longer supported by balena.",
|
|
986
|
+
"examples": [
|
|
987
|
+
"$ balena device-type list",
|
|
988
|
+
"$ balena device-type list --all"
|
|
989
|
+
],
|
|
990
|
+
"flags": {
|
|
991
|
+
"json": {
|
|
992
|
+
"description": "Format output as json.",
|
|
993
|
+
"helpGroup": "GLOBAL",
|
|
994
|
+
"name": "json",
|
|
995
|
+
"allowNo": false,
|
|
996
|
+
"type": "boolean"
|
|
997
|
+
},
|
|
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
|
+
},
|
|
982
1021
|
"device:deactivate": {
|
|
983
1022
|
"aliases": [],
|
|
984
1023
|
"args": {
|
|
@@ -2199,45 +2238,6 @@
|
|
|
2199
2238
|
"tunnel.js"
|
|
2200
2239
|
]
|
|
2201
2240
|
},
|
|
2202
|
-
"device-type:list": {
|
|
2203
|
-
"aliases": [],
|
|
2204
|
-
"args": {},
|
|
2205
|
-
"description": "List the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nList the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nBy default, only actively supported device types are listed.\nThe --all option can be used to list all device types, including those that are\nno longer supported by balena.",
|
|
2206
|
-
"examples": [
|
|
2207
|
-
"$ balena device-type list",
|
|
2208
|
-
"$ balena device-type list --all"
|
|
2209
|
-
],
|
|
2210
|
-
"flags": {
|
|
2211
|
-
"json": {
|
|
2212
|
-
"description": "Format output as json.",
|
|
2213
|
-
"helpGroup": "GLOBAL",
|
|
2214
|
-
"name": "json",
|
|
2215
|
-
"allowNo": false,
|
|
2216
|
-
"type": "boolean"
|
|
2217
|
-
},
|
|
2218
|
-
"all": {
|
|
2219
|
-
"description": "include device types no longer supported by balena",
|
|
2220
|
-
"name": "all",
|
|
2221
|
-
"allowNo": false,
|
|
2222
|
-
"type": "boolean"
|
|
2223
|
-
}
|
|
2224
|
-
},
|
|
2225
|
-
"hasDynamicHelp": false,
|
|
2226
|
-
"hiddenAliases": [],
|
|
2227
|
-
"id": "device-type:list",
|
|
2228
|
-
"pluginAlias": "balena-cli",
|
|
2229
|
-
"pluginName": "balena-cli",
|
|
2230
|
-
"pluginType": "core",
|
|
2231
|
-
"strict": true,
|
|
2232
|
-
"enableJsonFlag": true,
|
|
2233
|
-
"isESM": false,
|
|
2234
|
-
"relativePath": [
|
|
2235
|
-
"build",
|
|
2236
|
-
"commands",
|
|
2237
|
-
"device-type",
|
|
2238
|
-
"list.js"
|
|
2239
|
-
]
|
|
2240
|
-
},
|
|
2241
2241
|
"env:list": {
|
|
2242
2242
|
"aliases": [],
|
|
2243
2243
|
"args": {},
|
|
@@ -2537,6 +2537,43 @@
|
|
|
2537
2537
|
"set.js"
|
|
2538
2538
|
]
|
|
2539
2539
|
},
|
|
2540
|
+
"internal:osinit": {
|
|
2541
|
+
"aliases": [],
|
|
2542
|
+
"args": {
|
|
2543
|
+
"image": {
|
|
2544
|
+
"name": "image",
|
|
2545
|
+
"required": true
|
|
2546
|
+
},
|
|
2547
|
+
"type": {
|
|
2548
|
+
"name": "type",
|
|
2549
|
+
"required": true
|
|
2550
|
+
},
|
|
2551
|
+
"config": {
|
|
2552
|
+
"name": "config",
|
|
2553
|
+
"required": true
|
|
2554
|
+
}
|
|
2555
|
+
},
|
|
2556
|
+
"description": "Do actual init of the device with the preconfigured os image.\n\nDon't use this command directly!\nUse `balena os initialize <image>` instead.",
|
|
2557
|
+
"flags": {},
|
|
2558
|
+
"hasDynamicHelp": false,
|
|
2559
|
+
"hidden": true,
|
|
2560
|
+
"hiddenAliases": [],
|
|
2561
|
+
"id": "internal:osinit",
|
|
2562
|
+
"pluginAlias": "balena-cli",
|
|
2563
|
+
"pluginName": "balena-cli",
|
|
2564
|
+
"pluginType": "core",
|
|
2565
|
+
"strict": true,
|
|
2566
|
+
"enableJsonFlag": false,
|
|
2567
|
+
"root": true,
|
|
2568
|
+
"offlineCompatible": true,
|
|
2569
|
+
"isESM": false,
|
|
2570
|
+
"relativePath": [
|
|
2571
|
+
"build",
|
|
2572
|
+
"commands",
|
|
2573
|
+
"internal",
|
|
2574
|
+
"osinit.js"
|
|
2575
|
+
]
|
|
2576
|
+
},
|
|
2540
2577
|
"fleet:create": {
|
|
2541
2578
|
"aliases": [],
|
|
2542
2579
|
"args": {
|
|
@@ -2879,43 +2916,6 @@
|
|
|
2879
2916
|
"track-latest.js"
|
|
2880
2917
|
]
|
|
2881
2918
|
},
|
|
2882
|
-
"internal:osinit": {
|
|
2883
|
-
"aliases": [],
|
|
2884
|
-
"args": {
|
|
2885
|
-
"image": {
|
|
2886
|
-
"name": "image",
|
|
2887
|
-
"required": true
|
|
2888
|
-
},
|
|
2889
|
-
"type": {
|
|
2890
|
-
"name": "type",
|
|
2891
|
-
"required": true
|
|
2892
|
-
},
|
|
2893
|
-
"config": {
|
|
2894
|
-
"name": "config",
|
|
2895
|
-
"required": true
|
|
2896
|
-
}
|
|
2897
|
-
},
|
|
2898
|
-
"description": "Do actual init of the device with the preconfigured os image.\n\nDon't use this command directly!\nUse `balena os initialize <image>` instead.",
|
|
2899
|
-
"flags": {},
|
|
2900
|
-
"hasDynamicHelp": false,
|
|
2901
|
-
"hidden": true,
|
|
2902
|
-
"hiddenAliases": [],
|
|
2903
|
-
"id": "internal:osinit",
|
|
2904
|
-
"pluginAlias": "balena-cli",
|
|
2905
|
-
"pluginName": "balena-cli",
|
|
2906
|
-
"pluginType": "core",
|
|
2907
|
-
"strict": true,
|
|
2908
|
-
"enableJsonFlag": false,
|
|
2909
|
-
"root": true,
|
|
2910
|
-
"offlineCompatible": true,
|
|
2911
|
-
"isESM": false,
|
|
2912
|
-
"relativePath": [
|
|
2913
|
-
"build",
|
|
2914
|
-
"commands",
|
|
2915
|
-
"internal",
|
|
2916
|
-
"osinit.js"
|
|
2917
|
-
]
|
|
2918
|
-
},
|
|
2919
2919
|
"join": {
|
|
2920
2920
|
"aliases": [],
|
|
2921
2921
|
"args": {
|
|
@@ -3597,137 +3597,7 @@
|
|
|
3597
3597
|
"versions.js"
|
|
3598
3598
|
]
|
|
3599
3599
|
},
|
|
3600
|
-
"
|
|
3601
|
-
"aliases": [],
|
|
3602
|
-
"args": {
|
|
3603
|
-
"image": {
|
|
3604
|
-
"description": "the image file path",
|
|
3605
|
-
"name": "image",
|
|
3606
|
-
"required": true
|
|
3607
|
-
}
|
|
3608
|
-
},
|
|
3609
|
-
"description": "Preload a release on a disk image (or Edison zip archive).\n\nPreload a release (service images/containers) from a balena fleet, and optionally\na balenaOS splash screen, in a previously downloaded '.img' balenaOS image file\nin the local disk (a zip file is only accepted for the Intel Edison device type).\nAfter preloading, the balenaOS image file can be flashed to a device's SD card.\nWhen the device boots, it will not need to download the release, as it was\npreloaded. This is usually combined with release pinning\n(https://www.balena.io/docs/learn/deploy/release-strategy/release-policy/)\nto avoid the device downloading a newer release straight away, if available.\nCheck also the Preloading and Preregistering section of the balena CLI's advanced\nmasterclass document:\nhttps://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-and-preregistering\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\nNote that the this command requires Docker to be installed, as further detailed\nin the balena CLI's installation instructions:\nhttps://github.com/balena-io/balena-cli/blob/master/INSTALL.md\nThe `--dockerHost` and `--dockerPort` flags allow a remote Docker engine to\nbe used, however the image file must be accessible to the remote Docker engine\non the same path given on the command line. This is because Docker's bind mount\nfeature is used to \"share\" the image with a container that performs the preload.",
|
|
3610
|
-
"examples": [
|
|
3611
|
-
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3612
|
-
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3613
|
-
"$ balena preload balena.img"
|
|
3614
|
-
],
|
|
3615
|
-
"flags": {
|
|
3616
|
-
"fleet": {
|
|
3617
|
-
"char": "f",
|
|
3618
|
-
"description": "fleet name or slug (preferred)",
|
|
3619
|
-
"name": "fleet",
|
|
3620
|
-
"hasDynamicHelp": false,
|
|
3621
|
-
"multiple": false,
|
|
3622
|
-
"type": "option"
|
|
3623
|
-
},
|
|
3624
|
-
"commit": {
|
|
3625
|
-
"char": "c",
|
|
3626
|
-
"description": "The commit hash of the release to preload. Use \"current\" to specify the current\nrelease (ignored if no appId is given). The current release is usually also the\nlatest, but can be pinned to a specific release. See:\nhttps://www.balena.io/docs/learn/deploy/release-strategy/release-policy/\nhttps://www.balena.io/docs/learn/more/masterclasses/fleet-management/#63-pin-using-the-api\nhttps://github.com/balena-io-examples/staged-releases",
|
|
3627
|
-
"name": "commit",
|
|
3628
|
-
"hasDynamicHelp": false,
|
|
3629
|
-
"multiple": false,
|
|
3630
|
-
"type": "option"
|
|
3631
|
-
},
|
|
3632
|
-
"splash-image": {
|
|
3633
|
-
"char": "s",
|
|
3634
|
-
"description": "path to a png image to replace the splash screen",
|
|
3635
|
-
"name": "splash-image",
|
|
3636
|
-
"hasDynamicHelp": false,
|
|
3637
|
-
"multiple": false,
|
|
3638
|
-
"type": "option"
|
|
3639
|
-
},
|
|
3640
|
-
"dont-check-arch": {
|
|
3641
|
-
"description": "disable architecture compatibility check between image and fleet",
|
|
3642
|
-
"name": "dont-check-arch",
|
|
3643
|
-
"allowNo": false,
|
|
3644
|
-
"type": "boolean"
|
|
3645
|
-
},
|
|
3646
|
-
"pin-device-to-release": {
|
|
3647
|
-
"char": "p",
|
|
3648
|
-
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3649
|
-
"name": "pin-device-to-release",
|
|
3650
|
-
"allowNo": true,
|
|
3651
|
-
"type": "boolean"
|
|
3652
|
-
},
|
|
3653
|
-
"additional-space": {
|
|
3654
|
-
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3655
|
-
"name": "additional-space",
|
|
3656
|
-
"hasDynamicHelp": false,
|
|
3657
|
-
"multiple": false,
|
|
3658
|
-
"type": "option"
|
|
3659
|
-
},
|
|
3660
|
-
"add-certificate": {
|
|
3661
|
-
"description": "Add the given certificate (in PEM format) to /etc/ssl/certs in the preloading container.\nThe file name must end with '.crt' and must not be already contained in the preloader's\n/etc/ssl/certs folder.\nCan be repeated to add multiple certificates.",
|
|
3662
|
-
"name": "add-certificate",
|
|
3663
|
-
"hasDynamicHelp": false,
|
|
3664
|
-
"multiple": true,
|
|
3665
|
-
"type": "option"
|
|
3666
|
-
},
|
|
3667
|
-
"docker": {
|
|
3668
|
-
"char": "P",
|
|
3669
|
-
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3670
|
-
"name": "docker",
|
|
3671
|
-
"hasDynamicHelp": false,
|
|
3672
|
-
"multiple": false,
|
|
3673
|
-
"type": "option"
|
|
3674
|
-
},
|
|
3675
|
-
"dockerHost": {
|
|
3676
|
-
"char": "h",
|
|
3677
|
-
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3678
|
-
"name": "dockerHost",
|
|
3679
|
-
"hasDynamicHelp": false,
|
|
3680
|
-
"multiple": false,
|
|
3681
|
-
"type": "option"
|
|
3682
|
-
},
|
|
3683
|
-
"dockerPort": {
|
|
3684
|
-
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3685
|
-
"name": "dockerPort",
|
|
3686
|
-
"hasDynamicHelp": false,
|
|
3687
|
-
"multiple": false,
|
|
3688
|
-
"type": "option"
|
|
3689
|
-
},
|
|
3690
|
-
"ca": {
|
|
3691
|
-
"description": "Docker host TLS certificate authority file",
|
|
3692
|
-
"name": "ca",
|
|
3693
|
-
"hasDynamicHelp": false,
|
|
3694
|
-
"multiple": false,
|
|
3695
|
-
"type": "option"
|
|
3696
|
-
},
|
|
3697
|
-
"cert": {
|
|
3698
|
-
"description": "Docker host TLS certificate file",
|
|
3699
|
-
"name": "cert",
|
|
3700
|
-
"hasDynamicHelp": false,
|
|
3701
|
-
"multiple": false,
|
|
3702
|
-
"type": "option"
|
|
3703
|
-
},
|
|
3704
|
-
"key": {
|
|
3705
|
-
"description": "Docker host TLS key file",
|
|
3706
|
-
"name": "key",
|
|
3707
|
-
"hasDynamicHelp": false,
|
|
3708
|
-
"multiple": false,
|
|
3709
|
-
"type": "option"
|
|
3710
|
-
}
|
|
3711
|
-
},
|
|
3712
|
-
"hasDynamicHelp": false,
|
|
3713
|
-
"hiddenAliases": [],
|
|
3714
|
-
"id": "preload",
|
|
3715
|
-
"pluginAlias": "balena-cli",
|
|
3716
|
-
"pluginName": "balena-cli",
|
|
3717
|
-
"pluginType": "core",
|
|
3718
|
-
"strict": true,
|
|
3719
|
-
"enableJsonFlag": false,
|
|
3720
|
-
"authenticated": true,
|
|
3721
|
-
"primary": true,
|
|
3722
|
-
"isESM": false,
|
|
3723
|
-
"relativePath": [
|
|
3724
|
-
"build",
|
|
3725
|
-
"commands",
|
|
3726
|
-
"preload",
|
|
3727
|
-
"index.js"
|
|
3728
|
-
]
|
|
3729
|
-
},
|
|
3730
|
-
"push": {
|
|
3600
|
+
"push": {
|
|
3731
3601
|
"aliases": [],
|
|
3732
3602
|
"args": {
|
|
3733
3603
|
"fleetOrDevice": {
|
|
@@ -3892,6 +3762,136 @@
|
|
|
3892
3762
|
"index.js"
|
|
3893
3763
|
]
|
|
3894
3764
|
},
|
|
3765
|
+
"preload": {
|
|
3766
|
+
"aliases": [],
|
|
3767
|
+
"args": {
|
|
3768
|
+
"image": {
|
|
3769
|
+
"description": "the image file path",
|
|
3770
|
+
"name": "image",
|
|
3771
|
+
"required": true
|
|
3772
|
+
}
|
|
3773
|
+
},
|
|
3774
|
+
"description": "Preload a release on a disk image (or Edison zip archive).\n\nPreload a release (service images/containers) from a balena fleet, and optionally\na balenaOS splash screen, in a previously downloaded '.img' balenaOS image file\nin the local disk (a zip file is only accepted for the Intel Edison device type).\nAfter preloading, the balenaOS image file can be flashed to a device's SD card.\nWhen the device boots, it will not need to download the release, as it was\npreloaded. This is usually combined with release pinning\n(https://www.balena.io/docs/learn/deploy/release-strategy/release-policy/)\nto avoid the device downloading a newer release straight away, if available.\nCheck also the Preloading and Preregistering section of the balena CLI's advanced\nmasterclass document:\nhttps://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-and-preregistering\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\nNote that the this command requires Docker to be installed, as further detailed\nin the balena CLI's installation instructions:\nhttps://github.com/balena-io/balena-cli/blob/master/INSTALL.md\nThe `--dockerHost` and `--dockerPort` flags allow a remote Docker engine to\nbe used, however the image file must be accessible to the remote Docker engine\non the same path given on the command line. This is because Docker's bind mount\nfeature is used to \"share\" the image with a container that performs the preload.",
|
|
3775
|
+
"examples": [
|
|
3776
|
+
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3777
|
+
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3778
|
+
"$ balena preload balena.img"
|
|
3779
|
+
],
|
|
3780
|
+
"flags": {
|
|
3781
|
+
"fleet": {
|
|
3782
|
+
"char": "f",
|
|
3783
|
+
"description": "fleet name or slug (preferred)",
|
|
3784
|
+
"name": "fleet",
|
|
3785
|
+
"hasDynamicHelp": false,
|
|
3786
|
+
"multiple": false,
|
|
3787
|
+
"type": "option"
|
|
3788
|
+
},
|
|
3789
|
+
"commit": {
|
|
3790
|
+
"char": "c",
|
|
3791
|
+
"description": "The commit hash of the release to preload. Use \"current\" to specify the current\nrelease (ignored if no appId is given). The current release is usually also the\nlatest, but can be pinned to a specific release. See:\nhttps://www.balena.io/docs/learn/deploy/release-strategy/release-policy/\nhttps://www.balena.io/docs/learn/more/masterclasses/fleet-management/#63-pin-using-the-api\nhttps://github.com/balena-io-examples/staged-releases",
|
|
3792
|
+
"name": "commit",
|
|
3793
|
+
"hasDynamicHelp": false,
|
|
3794
|
+
"multiple": false,
|
|
3795
|
+
"type": "option"
|
|
3796
|
+
},
|
|
3797
|
+
"splash-image": {
|
|
3798
|
+
"char": "s",
|
|
3799
|
+
"description": "path to a png image to replace the splash screen",
|
|
3800
|
+
"name": "splash-image",
|
|
3801
|
+
"hasDynamicHelp": false,
|
|
3802
|
+
"multiple": false,
|
|
3803
|
+
"type": "option"
|
|
3804
|
+
},
|
|
3805
|
+
"dont-check-arch": {
|
|
3806
|
+
"description": "disable architecture compatibility check between image and fleet",
|
|
3807
|
+
"name": "dont-check-arch",
|
|
3808
|
+
"allowNo": false,
|
|
3809
|
+
"type": "boolean"
|
|
3810
|
+
},
|
|
3811
|
+
"pin-device-to-release": {
|
|
3812
|
+
"char": "p",
|
|
3813
|
+
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3814
|
+
"name": "pin-device-to-release",
|
|
3815
|
+
"allowNo": true,
|
|
3816
|
+
"type": "boolean"
|
|
3817
|
+
},
|
|
3818
|
+
"additional-space": {
|
|
3819
|
+
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3820
|
+
"name": "additional-space",
|
|
3821
|
+
"hasDynamicHelp": false,
|
|
3822
|
+
"multiple": false,
|
|
3823
|
+
"type": "option"
|
|
3824
|
+
},
|
|
3825
|
+
"add-certificate": {
|
|
3826
|
+
"description": "Add the given certificate (in PEM format) to /etc/ssl/certs in the preloading container.\nThe file name must end with '.crt' and must not be already contained in the preloader's\n/etc/ssl/certs folder.\nCan be repeated to add multiple certificates.",
|
|
3827
|
+
"name": "add-certificate",
|
|
3828
|
+
"hasDynamicHelp": false,
|
|
3829
|
+
"multiple": true,
|
|
3830
|
+
"type": "option"
|
|
3831
|
+
},
|
|
3832
|
+
"docker": {
|
|
3833
|
+
"char": "P",
|
|
3834
|
+
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3835
|
+
"name": "docker",
|
|
3836
|
+
"hasDynamicHelp": false,
|
|
3837
|
+
"multiple": false,
|
|
3838
|
+
"type": "option"
|
|
3839
|
+
},
|
|
3840
|
+
"dockerHost": {
|
|
3841
|
+
"char": "h",
|
|
3842
|
+
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3843
|
+
"name": "dockerHost",
|
|
3844
|
+
"hasDynamicHelp": false,
|
|
3845
|
+
"multiple": false,
|
|
3846
|
+
"type": "option"
|
|
3847
|
+
},
|
|
3848
|
+
"dockerPort": {
|
|
3849
|
+
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3850
|
+
"name": "dockerPort",
|
|
3851
|
+
"hasDynamicHelp": false,
|
|
3852
|
+
"multiple": false,
|
|
3853
|
+
"type": "option"
|
|
3854
|
+
},
|
|
3855
|
+
"ca": {
|
|
3856
|
+
"description": "Docker host TLS certificate authority file",
|
|
3857
|
+
"name": "ca",
|
|
3858
|
+
"hasDynamicHelp": false,
|
|
3859
|
+
"multiple": false,
|
|
3860
|
+
"type": "option"
|
|
3861
|
+
},
|
|
3862
|
+
"cert": {
|
|
3863
|
+
"description": "Docker host TLS certificate file",
|
|
3864
|
+
"name": "cert",
|
|
3865
|
+
"hasDynamicHelp": false,
|
|
3866
|
+
"multiple": false,
|
|
3867
|
+
"type": "option"
|
|
3868
|
+
},
|
|
3869
|
+
"key": {
|
|
3870
|
+
"description": "Docker host TLS key file",
|
|
3871
|
+
"name": "key",
|
|
3872
|
+
"hasDynamicHelp": false,
|
|
3873
|
+
"multiple": false,
|
|
3874
|
+
"type": "option"
|
|
3875
|
+
}
|
|
3876
|
+
},
|
|
3877
|
+
"hasDynamicHelp": false,
|
|
3878
|
+
"hiddenAliases": [],
|
|
3879
|
+
"id": "preload",
|
|
3880
|
+
"pluginAlias": "balena-cli",
|
|
3881
|
+
"pluginName": "balena-cli",
|
|
3882
|
+
"pluginType": "core",
|
|
3883
|
+
"strict": true,
|
|
3884
|
+
"enableJsonFlag": false,
|
|
3885
|
+
"authenticated": true,
|
|
3886
|
+
"primary": true,
|
|
3887
|
+
"isESM": false,
|
|
3888
|
+
"relativePath": [
|
|
3889
|
+
"build",
|
|
3890
|
+
"commands",
|
|
3891
|
+
"preload",
|
|
3892
|
+
"index.js"
|
|
3893
|
+
]
|
|
3894
|
+
},
|
|
3895
3895
|
"release:finalize": {
|
|
3896
3896
|
"aliases": [],
|
|
3897
3897
|
"args": {
|
|
@@ -4313,6 +4313,67 @@
|
|
|
4313
4313
|
"index.js"
|
|
4314
4314
|
]
|
|
4315
4315
|
},
|
|
4316
|
+
"support": {
|
|
4317
|
+
"aliases": [],
|
|
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).",
|
|
4329
|
+
"examples": [
|
|
4330
|
+
"balena support enable --device ab346f,cd457a --duration 3d",
|
|
4331
|
+
"balena support enable --fleet myFleet --duration 12h",
|
|
4332
|
+
"balena support disable -f myorg/myfleet"
|
|
4333
|
+
],
|
|
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
|
+
},
|
|
4360
|
+
"hasDynamicHelp": false,
|
|
4361
|
+
"hiddenAliases": [],
|
|
4362
|
+
"id": "support",
|
|
4363
|
+
"pluginAlias": "balena-cli",
|
|
4364
|
+
"pluginName": "balena-cli",
|
|
4365
|
+
"pluginType": "core",
|
|
4366
|
+
"strict": true,
|
|
4367
|
+
"enableJsonFlag": false,
|
|
4368
|
+
"authenticated": true,
|
|
4369
|
+
"isESM": false,
|
|
4370
|
+
"relativePath": [
|
|
4371
|
+
"build",
|
|
4372
|
+
"commands",
|
|
4373
|
+
"support",
|
|
4374
|
+
"index.js"
|
|
4375
|
+
]
|
|
4376
|
+
},
|
|
4316
4377
|
"ssh-key:add": {
|
|
4317
4378
|
"aliases": [],
|
|
4318
4379
|
"args": {
|
|
@@ -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.1.
|
|
4780
|
+
"version": "23.1.3"
|
|
4781
4781
|
}
|