balena-cli 25.1.3 → 25.1.4
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 +169 -172
- package/oclif.manifest.json +948 -948
- package/package.json +4 -4
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": {},
|
|
@@ -3365,319 +3365,299 @@
|
|
|
3365
3365
|
"rm.js"
|
|
3366
3366
|
]
|
|
3367
3367
|
},
|
|
3368
|
-
"
|
|
3368
|
+
"os:configure": {
|
|
3369
3369
|
"aliases": [],
|
|
3370
3370
|
"args": {
|
|
3371
3371
|
"image": {
|
|
3372
|
-
"description": "
|
|
3372
|
+
"description": "path to a balenaOS image file, e.g. \"rpi3.img\"",
|
|
3373
3373
|
"name": "image",
|
|
3374
3374
|
"required": true
|
|
3375
3375
|
}
|
|
3376
3376
|
},
|
|
3377
|
-
"description": "
|
|
3377
|
+
"description": "Configure a previously downloaded balenaOS image.\n\nConfigure a previously downloaded balenaOS image for a specific device type\nor fleet.\n\nConfiguration settings such as WiFi authentication will be taken from the\nfollowing sources, in precedence order:\n1. Command-line options like `--config-wifi-ssid`\n2. A given `config.json` file specified with the `--config` option.\n3. User input through interactive prompts (text menus).\n\nThe --device-type option is used to override the fleet's default device type,\nin case of a fleet with mixed device types.\n\nThe '--dev' option is used to configure balenaOS to operate in development mode,\nallowing unauthenticated root ssh access and exposing network ports such as\nbalenaEngine's 2375 (unencrypted). This option causes `\"developmentMode\": true`\nto be inserted in the 'config.json' file in the image's boot partition. Development\nmode (as a configurable option) is applicable to balenaOS releases from early\n2022. Older releases have separate development and production balenaOS images\nthat cannot be reconfigured through 'config.json' or the '--dev' option. Do not\nconfuse the balenaOS \"development mode\" with a device's \"local mode\", the latter\nbeing a supervisor feature that allows the \"balena push\" command to push a user's\napplication directly to a device in the local network.\n\nThe '--secureBoot' option is used to configure a balenaOS installer image to opt-in\nsecure boot and disk encryption.\n\nThe --system-connection (-c) option is used to inject NetworkManager connection\nprofiles for additional network interfaces, such as cellular/GSM or additional\nWiFi or ethernet connections. This option may be passed multiple times in case there\nare multiple files to inject. See connection profile examples and reference at:\nhttps://www.balena.io/docs/reference/OS/network/2.x/\nhttps://developer.gnome.org/NetworkManager/stable/ref-settings.html\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).",
|
|
3378
3378
|
"examples": [
|
|
3379
|
-
"$ balena
|
|
3380
|
-
"$ balena
|
|
3381
|
-
"$ balena
|
|
3379
|
+
"$ balena os configure ../path/rpi3.img --device 7cf02a6",
|
|
3380
|
+
"$ balena os configure ../path/rpi3.img --fleet myorg/myfleet",
|
|
3381
|
+
"$ balena os configure ../path/rpi3.img -f myorg/myfleet --device-type raspberrypi3",
|
|
3382
|
+
"$ balena os configure ../path/rpi3.img --config myWifiConfig.json"
|
|
3382
3383
|
],
|
|
3383
3384
|
"flags": {
|
|
3384
3385
|
"fleet": {
|
|
3385
3386
|
"char": "f",
|
|
3386
3387
|
"description": "fleet name or slug (preferred)",
|
|
3388
|
+
"exclusive": [
|
|
3389
|
+
"device",
|
|
3390
|
+
"config"
|
|
3391
|
+
],
|
|
3387
3392
|
"name": "fleet",
|
|
3388
3393
|
"hasDynamicHelp": false,
|
|
3389
3394
|
"multiple": false,
|
|
3390
3395
|
"type": "option"
|
|
3391
3396
|
},
|
|
3392
|
-
"
|
|
3393
|
-
"char": "
|
|
3394
|
-
"description": "
|
|
3395
|
-
"
|
|
3397
|
+
"device": {
|
|
3398
|
+
"char": "d",
|
|
3399
|
+
"description": "device UUID",
|
|
3400
|
+
"exclusive": [
|
|
3401
|
+
"fleet",
|
|
3402
|
+
"device-type",
|
|
3403
|
+
"config",
|
|
3404
|
+
"provisioning-key-name",
|
|
3405
|
+
"provisioning-key-expiry-date"
|
|
3406
|
+
],
|
|
3407
|
+
"name": "device",
|
|
3396
3408
|
"hasDynamicHelp": false,
|
|
3397
3409
|
"multiple": false,
|
|
3398
3410
|
"type": "option"
|
|
3399
3411
|
},
|
|
3400
|
-
"
|
|
3401
|
-
"
|
|
3402
|
-
"
|
|
3403
|
-
|
|
3412
|
+
"config": {
|
|
3413
|
+
"description": "path to a pre-generated config.json file to be injected in the OS image",
|
|
3414
|
+
"exclusive": [
|
|
3415
|
+
"fleet",
|
|
3416
|
+
"device",
|
|
3417
|
+
"advanced",
|
|
3418
|
+
"config-app-update-poll-interval",
|
|
3419
|
+
"config-network",
|
|
3420
|
+
"config-wifi-key",
|
|
3421
|
+
"config-wifi-ssid",
|
|
3422
|
+
"dev",
|
|
3423
|
+
"secureBoot",
|
|
3424
|
+
"device-type",
|
|
3425
|
+
"initial-device-name",
|
|
3426
|
+
"provisioning-key-name",
|
|
3427
|
+
"provisioning-key-expiry-date"
|
|
3428
|
+
],
|
|
3429
|
+
"name": "config",
|
|
3404
3430
|
"hasDynamicHelp": false,
|
|
3405
3431
|
"multiple": false,
|
|
3406
3432
|
"type": "option"
|
|
3407
3433
|
},
|
|
3408
|
-
"
|
|
3409
|
-
"
|
|
3410
|
-
"
|
|
3434
|
+
"advanced": {
|
|
3435
|
+
"char": "v",
|
|
3436
|
+
"description": "ask advanced configuration questions (when in interactive mode)",
|
|
3437
|
+
"name": "advanced",
|
|
3411
3438
|
"allowNo": false,
|
|
3412
3439
|
"type": "boolean"
|
|
3413
3440
|
},
|
|
3414
|
-
"
|
|
3415
|
-
"
|
|
3416
|
-
"
|
|
3417
|
-
"name": "pin-device-to-release",
|
|
3418
|
-
"allowNo": true,
|
|
3419
|
-
"type": "boolean"
|
|
3420
|
-
},
|
|
3421
|
-
"additional-space": {
|
|
3422
|
-
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3423
|
-
"name": "additional-space",
|
|
3441
|
+
"config-app-update-poll-interval": {
|
|
3442
|
+
"description": "supervisor cloud polling interval in minutes (e.g. for variable updates)",
|
|
3443
|
+
"name": "config-app-update-poll-interval",
|
|
3424
3444
|
"hasDynamicHelp": false,
|
|
3425
3445
|
"multiple": false,
|
|
3426
3446
|
"type": "option"
|
|
3427
3447
|
},
|
|
3428
|
-
"
|
|
3429
|
-
"description": "
|
|
3430
|
-
"name": "
|
|
3448
|
+
"config-network": {
|
|
3449
|
+
"description": "device network type (non-interactive configuration)",
|
|
3450
|
+
"name": "config-network",
|
|
3431
3451
|
"hasDynamicHelp": false,
|
|
3432
|
-
"multiple":
|
|
3452
|
+
"multiple": false,
|
|
3453
|
+
"options": [
|
|
3454
|
+
"ethernet",
|
|
3455
|
+
"wifi"
|
|
3456
|
+
],
|
|
3433
3457
|
"type": "option"
|
|
3434
3458
|
},
|
|
3435
|
-
"
|
|
3436
|
-
"
|
|
3437
|
-
"
|
|
3438
|
-
"name": "docker",
|
|
3459
|
+
"config-wifi-key": {
|
|
3460
|
+
"description": "WiFi key (password) (non-interactive configuration)",
|
|
3461
|
+
"name": "config-wifi-key",
|
|
3439
3462
|
"hasDynamicHelp": false,
|
|
3440
3463
|
"multiple": false,
|
|
3441
3464
|
"type": "option"
|
|
3442
3465
|
},
|
|
3443
|
-
"
|
|
3444
|
-
"
|
|
3445
|
-
"
|
|
3446
|
-
"name": "dockerHost",
|
|
3466
|
+
"config-wifi-ssid": {
|
|
3467
|
+
"description": "WiFi SSID (network name) (non-interactive configuration)",
|
|
3468
|
+
"name": "config-wifi-ssid",
|
|
3447
3469
|
"hasDynamicHelp": false,
|
|
3448
3470
|
"multiple": false,
|
|
3449
3471
|
"type": "option"
|
|
3450
3472
|
},
|
|
3451
|
-
"
|
|
3452
|
-
"description": "
|
|
3453
|
-
"name": "
|
|
3473
|
+
"dev": {
|
|
3474
|
+
"description": "Configure balenaOS to operate in development mode",
|
|
3475
|
+
"name": "dev",
|
|
3476
|
+
"allowNo": false,
|
|
3477
|
+
"type": "boolean"
|
|
3478
|
+
},
|
|
3479
|
+
"secureBoot": {
|
|
3480
|
+
"description": "Configure balenaOS installer to opt-in secure boot and disk encryption",
|
|
3481
|
+
"name": "secureBoot",
|
|
3482
|
+
"allowNo": false,
|
|
3483
|
+
"type": "boolean"
|
|
3484
|
+
},
|
|
3485
|
+
"device-type": {
|
|
3486
|
+
"dependsOn": [
|
|
3487
|
+
"fleet"
|
|
3488
|
+
],
|
|
3489
|
+
"description": "device type slug (e.g. \"raspberrypi3\") to override the fleet device type",
|
|
3490
|
+
"name": "device-type",
|
|
3454
3491
|
"hasDynamicHelp": false,
|
|
3455
3492
|
"multiple": false,
|
|
3456
3493
|
"type": "option"
|
|
3457
3494
|
},
|
|
3458
|
-
"
|
|
3459
|
-
"description": "
|
|
3460
|
-
"name": "
|
|
3495
|
+
"initial-device-name": {
|
|
3496
|
+
"description": "This option will set the device name when the device provisions",
|
|
3497
|
+
"name": "initial-device-name",
|
|
3461
3498
|
"hasDynamicHelp": false,
|
|
3462
3499
|
"multiple": false,
|
|
3463
3500
|
"type": "option"
|
|
3464
3501
|
},
|
|
3465
|
-
"
|
|
3466
|
-
"description": "
|
|
3467
|
-
"
|
|
3502
|
+
"provisioning-key-name": {
|
|
3503
|
+
"description": "custom key name assigned to generated provisioning api key",
|
|
3504
|
+
"exclusive": [
|
|
3505
|
+
"config",
|
|
3506
|
+
"device"
|
|
3507
|
+
],
|
|
3508
|
+
"name": "provisioning-key-name",
|
|
3468
3509
|
"hasDynamicHelp": false,
|
|
3469
3510
|
"multiple": false,
|
|
3470
3511
|
"type": "option"
|
|
3471
3512
|
},
|
|
3472
|
-
"key": {
|
|
3473
|
-
"description": "
|
|
3474
|
-
"
|
|
3513
|
+
"provisioning-key-expiry-date": {
|
|
3514
|
+
"description": "expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)",
|
|
3515
|
+
"exclusive": [
|
|
3516
|
+
"config",
|
|
3517
|
+
"device"
|
|
3518
|
+
],
|
|
3519
|
+
"name": "provisioning-key-expiry-date",
|
|
3475
3520
|
"hasDynamicHelp": false,
|
|
3476
3521
|
"multiple": false,
|
|
3477
3522
|
"type": "option"
|
|
3523
|
+
},
|
|
3524
|
+
"system-connection": {
|
|
3525
|
+
"char": "c",
|
|
3526
|
+
"description": "paths to local files to place into the 'system-connections' directory",
|
|
3527
|
+
"name": "system-connection",
|
|
3528
|
+
"required": false,
|
|
3529
|
+
"hasDynamicHelp": false,
|
|
3530
|
+
"multiple": true,
|
|
3531
|
+
"type": "option"
|
|
3478
3532
|
}
|
|
3479
3533
|
},
|
|
3480
3534
|
"hasDynamicHelp": false,
|
|
3481
3535
|
"hiddenAliases": [],
|
|
3482
|
-
"id": "
|
|
3536
|
+
"id": "os:configure",
|
|
3483
3537
|
"pluginAlias": "balena-cli",
|
|
3484
3538
|
"pluginName": "balena-cli",
|
|
3485
3539
|
"pluginType": "core",
|
|
3486
3540
|
"strict": true,
|
|
3487
3541
|
"enableJsonFlag": false,
|
|
3488
3542
|
"authenticated": true,
|
|
3489
|
-
"primary": true,
|
|
3490
3543
|
"isESM": false,
|
|
3491
3544
|
"relativePath": [
|
|
3492
3545
|
"build",
|
|
3493
3546
|
"commands",
|
|
3494
|
-
"
|
|
3495
|
-
"
|
|
3547
|
+
"os",
|
|
3548
|
+
"configure.js"
|
|
3496
3549
|
]
|
|
3497
3550
|
},
|
|
3498
|
-
"
|
|
3551
|
+
"os:download": {
|
|
3499
3552
|
"aliases": [],
|
|
3500
3553
|
"args": {
|
|
3501
|
-
"
|
|
3502
|
-
"description": "
|
|
3503
|
-
"name": "
|
|
3554
|
+
"type": {
|
|
3555
|
+
"description": "the device type",
|
|
3556
|
+
"name": "type",
|
|
3504
3557
|
"required": true
|
|
3505
3558
|
}
|
|
3506
3559
|
},
|
|
3507
|
-
"description": "
|
|
3560
|
+
"description": "Download an unconfigured OS image.\n\nDownload an unconfigured OS image for the specified device type.\nCheck available device types with 'balena device-type list'.\n\nNote: Currently this command only works with balenaCloud, not openBalena.\nIf using openBalena, please download the OS from: https://www.balena.io/os/\n\nThe '--version' option is used to select the balenaOS version. If omitted,\nthe latest released version is downloaded (and if only pre-release versions\nexist, the latest pre-release version is downloaded).\n\nUse '--type' to specify the type of OS download\nIf omitted, the default type for the specified device type-version combination is used.\nSome OS download types may not be available for certain device types and versions.\n\nUse '--version menu' or '--version menu-esr' to interactively select the\nOS version. The latter lists ESR versions which are only available for\ndownload on Production and Enterprise plans. See also:\nhttps://www.balena.io/docs/reference/OS/extended-support-release/\n\nDevelopment images can be selected by appending `.dev` to the version.",
|
|
3508
3561
|
"examples": [
|
|
3509
|
-
"$ balena
|
|
3510
|
-
"$ balena
|
|
3511
|
-
"$ balena
|
|
3512
|
-
"$ balena
|
|
3513
|
-
"$ balena
|
|
3514
|
-
"$ balena
|
|
3515
|
-
"",
|
|
3516
|
-
"$ balena
|
|
3517
|
-
"$ balena
|
|
3518
|
-
"$ balena
|
|
3519
|
-
"$ balena
|
|
3520
|
-
"$ balena push 10.0.0.1 --nolive",
|
|
3521
|
-
"",
|
|
3522
|
-
"$ balena push 23c73a1.local --system",
|
|
3523
|
-
"$ balena push 23c73a1.local --system --service my-service"
|
|
3562
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img",
|
|
3563
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2.101.7",
|
|
3564
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2022.7.0",
|
|
3565
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version ^2.90.0",
|
|
3566
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2.60.1+rev1",
|
|
3567
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2.60.1+rev1.dev",
|
|
3568
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2021.10.2.prod",
|
|
3569
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version latest",
|
|
3570
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version menu",
|
|
3571
|
+
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version menu-esr",
|
|
3572
|
+
"$ balena os download generic-amd64 -o ../foo/bar/generic-amd64.img --type installation-media"
|
|
3524
3573
|
],
|
|
3525
3574
|
"flags": {
|
|
3526
|
-
"
|
|
3527
|
-
"char": "
|
|
3528
|
-
"description": "
|
|
3529
|
-
"name": "
|
|
3530
|
-
"
|
|
3575
|
+
"output": {
|
|
3576
|
+
"char": "o",
|
|
3577
|
+
"description": "output path",
|
|
3578
|
+
"name": "output",
|
|
3579
|
+
"required": true,
|
|
3531
3580
|
"hasDynamicHelp": false,
|
|
3532
3581
|
"multiple": false,
|
|
3533
3582
|
"type": "option"
|
|
3534
3583
|
},
|
|
3535
|
-
"
|
|
3536
|
-
"
|
|
3537
|
-
"
|
|
3538
|
-
"name": "emulated",
|
|
3539
|
-
"allowNo": false,
|
|
3540
|
-
"type": "boolean"
|
|
3541
|
-
},
|
|
3542
|
-
"dockerfile": {
|
|
3543
|
-
"description": "Alternative Dockerfile name/path, relative to the source folder",
|
|
3544
|
-
"name": "dockerfile",
|
|
3584
|
+
"version": {
|
|
3585
|
+
"description": "version number (ESR or non-ESR versions),\nor semver range (non-ESR versions only),\nor 'latest' (excludes invalidated & pre-releases),\nor 'menu' (interactive menu, non-ESR versions),\nor 'menu-esr' (interactive menu, ESR versions)",
|
|
3586
|
+
"name": "version",
|
|
3545
3587
|
"hasDynamicHelp": false,
|
|
3546
3588
|
"multiple": false,
|
|
3547
3589
|
"type": "option"
|
|
3548
3590
|
},
|
|
3549
|
-
"
|
|
3550
|
-
"
|
|
3551
|
-
"
|
|
3552
|
-
"name": "nocache",
|
|
3553
|
-
"allowNo": false,
|
|
3554
|
-
"type": "boolean"
|
|
3555
|
-
},
|
|
3556
|
-
"pull": {
|
|
3557
|
-
"description": "When pushing to a local device, force the base images to be pulled again.\nCurrently this option is ignored when pushing to the balenaCloud builders.",
|
|
3558
|
-
"name": "pull",
|
|
3559
|
-
"allowNo": false,
|
|
3560
|
-
"type": "boolean"
|
|
3561
|
-
},
|
|
3562
|
-
"noparent-check": {
|
|
3563
|
-
"description": "Disable project validation check of 'docker-compose.yml' file in parent folder",
|
|
3564
|
-
"name": "noparent-check",
|
|
3565
|
-
"allowNo": false,
|
|
3566
|
-
"type": "boolean"
|
|
3567
|
-
},
|
|
3568
|
-
"registry-secrets": {
|
|
3569
|
-
"char": "R",
|
|
3570
|
-
"description": "Path to a local YAML or JSON file containing Docker registry passwords used\nto pull base images. Note that if registry-secrets are not provided on the\ncommand line, a secrets configuration file from the balena directory will be\nused (usually $HOME/.balena/secrets.yml|.json)",
|
|
3571
|
-
"name": "registry-secrets",
|
|
3591
|
+
"type": {
|
|
3592
|
+
"description": "'disk-image' (for flashing onto device system disk/storage)\nor 'installation-media' (for creating installation media to automatically erase, format, and install balenaOS on a device)",
|
|
3593
|
+
"name": "type",
|
|
3572
3594
|
"hasDynamicHelp": false,
|
|
3573
3595
|
"multiple": false,
|
|
3574
|
-
"
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
"description": "Don't run a live session on this push. The filesystem will not be monitored,\nand changes will not be synchronized to any running containers. Note that both\nthis flag and --detached are required to cause the process to end once the\ninitial build has completed.",
|
|
3578
|
-
"name": "nolive",
|
|
3579
|
-
"allowNo": false,
|
|
3580
|
-
"type": "boolean"
|
|
3581
|
-
},
|
|
3582
|
-
"detached": {
|
|
3583
|
-
"char": "d",
|
|
3584
|
-
"description": "When pushing to the cloud, this option will cause the build to start, then\nreturn execution back to the shell, with the status and release ID (if\napplicable). When pushing to a local mode device, this option will cause\nthe command to not tail logs when the build has completed.",
|
|
3585
|
-
"name": "detached",
|
|
3586
|
-
"allowNo": false,
|
|
3587
|
-
"type": "boolean"
|
|
3588
|
-
},
|
|
3589
|
-
"service": {
|
|
3590
|
-
"description": "Reject logs not originating from this service.\nThis can be used in combination with --system and other --service flags.\nOnly valid when pushing to a local mode device.",
|
|
3591
|
-
"name": "service",
|
|
3592
|
-
"hasDynamicHelp": false,
|
|
3593
|
-
"multiple": true,
|
|
3594
|
-
"type": "option"
|
|
3595
|
-
},
|
|
3596
|
-
"system": {
|
|
3597
|
-
"description": "Only show system logs. This can be used in combination with --service.\nOnly valid when pushing to a local mode device.",
|
|
3598
|
-
"name": "system",
|
|
3599
|
-
"allowNo": false,
|
|
3600
|
-
"type": "boolean"
|
|
3601
|
-
},
|
|
3602
|
-
"env": {
|
|
3603
|
-
"description": "When performing a push to device, run the built containers with environment\nvariables provided with this argument. Environment variables can be applied\nto individual services by adding their service name before the argument,\nseparated by a colon, e.g:\n\t--env main:MY_ENV=value\nNote that if the service name cannot be found in the composition, the entire\nleft hand side of the = character will be treated as the variable name.",
|
|
3604
|
-
"name": "env",
|
|
3605
|
-
"hasDynamicHelp": false,
|
|
3606
|
-
"multiple": true,
|
|
3607
|
-
"type": "option"
|
|
3608
|
-
},
|
|
3609
|
-
"noconvert-eol": {
|
|
3610
|
-
"description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
|
|
3611
|
-
"name": "noconvert-eol",
|
|
3612
|
-
"allowNo": false,
|
|
3613
|
-
"type": "boolean"
|
|
3614
|
-
},
|
|
3615
|
-
"multi-dockerignore": {
|
|
3616
|
-
"char": "m",
|
|
3617
|
-
"description": "Have each service use its own .dockerignore file. See \"balena help push\".",
|
|
3618
|
-
"name": "multi-dockerignore",
|
|
3619
|
-
"allowNo": false,
|
|
3620
|
-
"type": "boolean"
|
|
3621
|
-
},
|
|
3622
|
-
"release-tag": {
|
|
3623
|
-
"description": "Set release tags if the image build is successful (balenaCloud only). Multiple\narguments may be provided, alternating tag keys and values (see examples).\nHint: Empty values may be specified with \"\" (bash, cmd.exe) or '\"\"' (PowerShell).",
|
|
3624
|
-
"exclusive": [
|
|
3625
|
-
"detached"
|
|
3596
|
+
"options": [
|
|
3597
|
+
"installation-media",
|
|
3598
|
+
"disk-image"
|
|
3626
3599
|
],
|
|
3627
|
-
"name": "release-tag",
|
|
3628
|
-
"hasDynamicHelp": false,
|
|
3629
|
-
"multiple": true,
|
|
3630
|
-
"type": "option"
|
|
3631
|
-
},
|
|
3632
|
-
"draft": {
|
|
3633
|
-
"description": "Instruct the builder to create the release as a draft. Draft releases are ignored\nby the 'track latest' release policy but can be used through release pinning.\nDraft releases can be marked as final through the API. Releases are created\nas final by default unless this option is given.",
|
|
3634
|
-
"name": "draft",
|
|
3635
|
-
"allowNo": false,
|
|
3636
|
-
"type": "boolean"
|
|
3637
|
-
},
|
|
3638
|
-
"note": {
|
|
3639
|
-
"description": "The notes for this release",
|
|
3640
|
-
"name": "note",
|
|
3641
|
-
"hasDynamicHelp": false,
|
|
3642
|
-
"multiple": false,
|
|
3643
3600
|
"type": "option"
|
|
3644
3601
|
}
|
|
3645
3602
|
},
|
|
3646
3603
|
"hasDynamicHelp": false,
|
|
3647
3604
|
"hiddenAliases": [],
|
|
3648
|
-
"id": "
|
|
3605
|
+
"id": "os:download",
|
|
3649
3606
|
"pluginAlias": "balena-cli",
|
|
3650
3607
|
"pluginName": "balena-cli",
|
|
3651
3608
|
"pluginType": "core",
|
|
3652
3609
|
"strict": true,
|
|
3653
3610
|
"enableJsonFlag": false,
|
|
3654
|
-
"primary": true,
|
|
3655
3611
|
"isESM": false,
|
|
3656
3612
|
"relativePath": [
|
|
3657
3613
|
"build",
|
|
3658
3614
|
"commands",
|
|
3659
|
-
"
|
|
3660
|
-
"
|
|
3615
|
+
"os",
|
|
3616
|
+
"download.js"
|
|
3661
3617
|
]
|
|
3662
3618
|
},
|
|
3663
|
-
"
|
|
3619
|
+
"os:initialize": {
|
|
3664
3620
|
"aliases": [],
|
|
3665
3621
|
"args": {
|
|
3666
|
-
"
|
|
3667
|
-
"description": "
|
|
3668
|
-
"name": "
|
|
3622
|
+
"image": {
|
|
3623
|
+
"description": "path to OS image",
|
|
3624
|
+
"name": "image",
|
|
3669
3625
|
"required": true
|
|
3670
3626
|
}
|
|
3671
3627
|
},
|
|
3672
|
-
"description": "
|
|
3628
|
+
"description": "Initialize an os image for a device.\n\n\t\tInitialize an os image for a device with a previously\n\t\tconfigured operating system image and flash the\n\t\tan external storage drive or the device's storage\n\t\tmedium depending on the device type.\n\t\t\n\nNote: Initializing the device may ask for administrative permissions\nbecause we need to access the raw devices directly.",
|
|
3673
3629
|
"examples": [
|
|
3674
|
-
"$ balena
|
|
3675
|
-
"$ balena release finalize 1234567"
|
|
3630
|
+
"$ balena os initialize ../path/rpi.img --type raspberry-pi"
|
|
3676
3631
|
],
|
|
3677
|
-
"flags": {
|
|
3632
|
+
"flags": {
|
|
3633
|
+
"type": {
|
|
3634
|
+
"char": "t",
|
|
3635
|
+
"description": "device type (Check available types with `balena device-type list`)",
|
|
3636
|
+
"name": "type",
|
|
3637
|
+
"required": true,
|
|
3638
|
+
"hasDynamicHelp": false,
|
|
3639
|
+
"multiple": false,
|
|
3640
|
+
"type": "option"
|
|
3641
|
+
},
|
|
3642
|
+
"drive": {
|
|
3643
|
+
"char": "d",
|
|
3644
|
+
"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.",
|
|
3645
|
+
"name": "drive",
|
|
3646
|
+
"hasDynamicHelp": false,
|
|
3647
|
+
"multiple": false,
|
|
3648
|
+
"type": "option"
|
|
3649
|
+
},
|
|
3650
|
+
"yes": {
|
|
3651
|
+
"char": "y",
|
|
3652
|
+
"description": "answer \"yes\" to all questions (non interactive use)",
|
|
3653
|
+
"name": "yes",
|
|
3654
|
+
"allowNo": false,
|
|
3655
|
+
"type": "boolean"
|
|
3656
|
+
}
|
|
3657
|
+
},
|
|
3678
3658
|
"hasDynamicHelp": false,
|
|
3679
3659
|
"hiddenAliases": [],
|
|
3680
|
-
"id": "
|
|
3660
|
+
"id": "os:initialize",
|
|
3681
3661
|
"pluginAlias": "balena-cli",
|
|
3682
3662
|
"pluginName": "balena-cli",
|
|
3683
3663
|
"pluginType": "core",
|
|
@@ -3688,455 +3668,516 @@
|
|
|
3688
3668
|
"relativePath": [
|
|
3689
3669
|
"build",
|
|
3690
3670
|
"commands",
|
|
3691
|
-
"
|
|
3692
|
-
"
|
|
3671
|
+
"os",
|
|
3672
|
+
"initialize.js"
|
|
3693
3673
|
]
|
|
3694
3674
|
},
|
|
3695
|
-
"
|
|
3675
|
+
"os:versions": {
|
|
3696
3676
|
"aliases": [],
|
|
3697
3677
|
"args": {
|
|
3698
|
-
"
|
|
3699
|
-
"description": "
|
|
3700
|
-
"name": "
|
|
3678
|
+
"type": {
|
|
3679
|
+
"description": "device type",
|
|
3680
|
+
"name": "type",
|
|
3701
3681
|
"required": true
|
|
3702
3682
|
}
|
|
3703
3683
|
},
|
|
3704
|
-
"description": "
|
|
3684
|
+
"description": "Show available balenaOS versions for the given device type.\n\nShow the available balenaOS versions for the given device type.\nCheck available types with `balena device-type list`.\n\nbalenaOS ESR versions can be listed with the '--esr' option. See also:\nhttps://www.balena.io/docs/reference/OS/extended-support-release/",
|
|
3705
3685
|
"examples": [
|
|
3706
|
-
"$ balena
|
|
3707
|
-
"$ balena release 1234567"
|
|
3686
|
+
"$ balena os versions raspberrypi3"
|
|
3708
3687
|
],
|
|
3709
3688
|
"flags": {
|
|
3710
|
-
"
|
|
3711
|
-
"description": "
|
|
3712
|
-
"
|
|
3713
|
-
"name": "json",
|
|
3689
|
+
"esr": {
|
|
3690
|
+
"description": "select balenaOS ESR versions",
|
|
3691
|
+
"name": "esr",
|
|
3714
3692
|
"allowNo": false,
|
|
3715
3693
|
"type": "boolean"
|
|
3716
3694
|
},
|
|
3717
|
-
"
|
|
3718
|
-
"
|
|
3719
|
-
"
|
|
3720
|
-
"name": "composition",
|
|
3695
|
+
"include-draft": {
|
|
3696
|
+
"description": "include pre-release balenaOS versions",
|
|
3697
|
+
"name": "include-draft",
|
|
3721
3698
|
"allowNo": false,
|
|
3722
3699
|
"type": "boolean"
|
|
3723
3700
|
}
|
|
3724
3701
|
},
|
|
3725
3702
|
"hasDynamicHelp": false,
|
|
3726
3703
|
"hiddenAliases": [],
|
|
3727
|
-
"id": "
|
|
3704
|
+
"id": "os:versions",
|
|
3728
3705
|
"pluginAlias": "balena-cli",
|
|
3729
3706
|
"pluginName": "balena-cli",
|
|
3730
3707
|
"pluginType": "core",
|
|
3731
3708
|
"strict": true,
|
|
3732
|
-
"enableJsonFlag":
|
|
3733
|
-
"authenticated": true,
|
|
3709
|
+
"enableJsonFlag": false,
|
|
3734
3710
|
"isESM": false,
|
|
3735
3711
|
"relativePath": [
|
|
3736
3712
|
"build",
|
|
3737
3713
|
"commands",
|
|
3738
|
-
"
|
|
3739
|
-
"
|
|
3714
|
+
"os",
|
|
3715
|
+
"versions.js"
|
|
3740
3716
|
]
|
|
3741
3717
|
},
|
|
3742
|
-
"
|
|
3718
|
+
"preload": {
|
|
3743
3719
|
"aliases": [],
|
|
3744
3720
|
"args": {
|
|
3745
|
-
"
|
|
3746
|
-
"description": "the
|
|
3747
|
-
"name": "
|
|
3721
|
+
"image": {
|
|
3722
|
+
"description": "the image file path",
|
|
3723
|
+
"name": "image",
|
|
3748
3724
|
"required": true
|
|
3749
3725
|
}
|
|
3750
3726
|
},
|
|
3751
|
-
"description": "
|
|
3727
|
+
"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.",
|
|
3752
3728
|
"examples": [
|
|
3753
|
-
"$ balena
|
|
3754
|
-
"$ balena
|
|
3729
|
+
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3730
|
+
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3731
|
+
"$ balena preload balena.img"
|
|
3755
3732
|
],
|
|
3756
|
-
"flags": {
|
|
3757
|
-
"hasDynamicHelp": false,
|
|
3758
|
-
"hiddenAliases": [],
|
|
3759
|
-
"id": "release:invalidate",
|
|
3760
|
-
"pluginAlias": "balena-cli",
|
|
3761
|
-
"pluginName": "balena-cli",
|
|
3762
|
-
"pluginType": "core",
|
|
3763
|
-
"strict": true,
|
|
3764
|
-
"enableJsonFlag": false,
|
|
3765
|
-
"authenticated": true,
|
|
3766
|
-
"isESM": false,
|
|
3767
|
-
"relativePath": [
|
|
3768
|
-
"build",
|
|
3769
|
-
"commands",
|
|
3770
|
-
"release",
|
|
3771
|
-
"invalidate.js"
|
|
3772
|
-
]
|
|
3773
|
-
},
|
|
3774
|
-
"release:list": {
|
|
3775
|
-
"aliases": [],
|
|
3776
|
-
"args": {
|
|
3733
|
+
"flags": {
|
|
3777
3734
|
"fleet": {
|
|
3735
|
+
"char": "f",
|
|
3778
3736
|
"description": "fleet name or slug (preferred)",
|
|
3779
3737
|
"name": "fleet",
|
|
3780
|
-
"
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
"
|
|
3790
|
-
"
|
|
3791
|
-
|
|
3738
|
+
"hasDynamicHelp": false,
|
|
3739
|
+
"multiple": false,
|
|
3740
|
+
"type": "option"
|
|
3741
|
+
},
|
|
3742
|
+
"commit": {
|
|
3743
|
+
"char": "c",
|
|
3744
|
+
"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",
|
|
3745
|
+
"name": "commit",
|
|
3746
|
+
"hasDynamicHelp": false,
|
|
3747
|
+
"multiple": false,
|
|
3748
|
+
"type": "option"
|
|
3749
|
+
},
|
|
3750
|
+
"splash-image": {
|
|
3751
|
+
"char": "s",
|
|
3752
|
+
"description": "path to a png image to replace the splash screen",
|
|
3753
|
+
"name": "splash-image",
|
|
3754
|
+
"hasDynamicHelp": false,
|
|
3755
|
+
"multiple": false,
|
|
3756
|
+
"type": "option"
|
|
3757
|
+
},
|
|
3758
|
+
"dont-check-arch": {
|
|
3759
|
+
"description": "disable architecture compatibility check between image and fleet",
|
|
3760
|
+
"name": "dont-check-arch",
|
|
3792
3761
|
"allowNo": false,
|
|
3793
3762
|
"type": "boolean"
|
|
3763
|
+
},
|
|
3764
|
+
"pin-device-to-release": {
|
|
3765
|
+
"char": "p",
|
|
3766
|
+
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3767
|
+
"name": "pin-device-to-release",
|
|
3768
|
+
"allowNo": true,
|
|
3769
|
+
"type": "boolean"
|
|
3770
|
+
},
|
|
3771
|
+
"additional-space": {
|
|
3772
|
+
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3773
|
+
"name": "additional-space",
|
|
3774
|
+
"hasDynamicHelp": false,
|
|
3775
|
+
"multiple": false,
|
|
3776
|
+
"type": "option"
|
|
3777
|
+
},
|
|
3778
|
+
"add-certificate": {
|
|
3779
|
+
"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.",
|
|
3780
|
+
"name": "add-certificate",
|
|
3781
|
+
"hasDynamicHelp": false,
|
|
3782
|
+
"multiple": true,
|
|
3783
|
+
"type": "option"
|
|
3784
|
+
},
|
|
3785
|
+
"docker": {
|
|
3786
|
+
"char": "P",
|
|
3787
|
+
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3788
|
+
"name": "docker",
|
|
3789
|
+
"hasDynamicHelp": false,
|
|
3790
|
+
"multiple": false,
|
|
3791
|
+
"type": "option"
|
|
3792
|
+
},
|
|
3793
|
+
"dockerHost": {
|
|
3794
|
+
"char": "h",
|
|
3795
|
+
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3796
|
+
"name": "dockerHost",
|
|
3797
|
+
"hasDynamicHelp": false,
|
|
3798
|
+
"multiple": false,
|
|
3799
|
+
"type": "option"
|
|
3800
|
+
},
|
|
3801
|
+
"dockerPort": {
|
|
3802
|
+
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3803
|
+
"name": "dockerPort",
|
|
3804
|
+
"hasDynamicHelp": false,
|
|
3805
|
+
"multiple": false,
|
|
3806
|
+
"type": "option"
|
|
3807
|
+
},
|
|
3808
|
+
"ca": {
|
|
3809
|
+
"description": "Docker host TLS certificate authority file",
|
|
3810
|
+
"name": "ca",
|
|
3811
|
+
"hasDynamicHelp": false,
|
|
3812
|
+
"multiple": false,
|
|
3813
|
+
"type": "option"
|
|
3814
|
+
},
|
|
3815
|
+
"cert": {
|
|
3816
|
+
"description": "Docker host TLS certificate file",
|
|
3817
|
+
"name": "cert",
|
|
3818
|
+
"hasDynamicHelp": false,
|
|
3819
|
+
"multiple": false,
|
|
3820
|
+
"type": "option"
|
|
3821
|
+
},
|
|
3822
|
+
"key": {
|
|
3823
|
+
"description": "Docker host TLS key file",
|
|
3824
|
+
"name": "key",
|
|
3825
|
+
"hasDynamicHelp": false,
|
|
3826
|
+
"multiple": false,
|
|
3827
|
+
"type": "option"
|
|
3794
3828
|
}
|
|
3795
3829
|
},
|
|
3796
3830
|
"hasDynamicHelp": false,
|
|
3797
3831
|
"hiddenAliases": [],
|
|
3798
|
-
"id": "
|
|
3799
|
-
"pluginAlias": "balena-cli",
|
|
3800
|
-
"pluginName": "balena-cli",
|
|
3801
|
-
"pluginType": "core",
|
|
3802
|
-
"strict": true,
|
|
3803
|
-
"enableJsonFlag": true,
|
|
3804
|
-
"authenticated": true,
|
|
3805
|
-
"isESM": false,
|
|
3806
|
-
"relativePath": [
|
|
3807
|
-
"build",
|
|
3808
|
-
"commands",
|
|
3809
|
-
"release",
|
|
3810
|
-
"list.js"
|
|
3811
|
-
]
|
|
3812
|
-
},
|
|
3813
|
-
"release:validate": {
|
|
3814
|
-
"aliases": [],
|
|
3815
|
-
"args": {
|
|
3816
|
-
"commitOrId": {
|
|
3817
|
-
"description": "the commit or ID of the release to validate",
|
|
3818
|
-
"name": "commitOrId",
|
|
3819
|
-
"required": true
|
|
3820
|
-
}
|
|
3821
|
-
},
|
|
3822
|
-
"description": "Validate a release.\n\nValidate a release.\n\nValid releases are automatically deployed to devices tracking the latest\nrelease if they are finalized.",
|
|
3823
|
-
"examples": [
|
|
3824
|
-
"$ balena release validate a777f7345fe3d655c1c981aa642e5555",
|
|
3825
|
-
"$ balena release validate 1234567"
|
|
3826
|
-
],
|
|
3827
|
-
"flags": {},
|
|
3828
|
-
"hasDynamicHelp": false,
|
|
3829
|
-
"hiddenAliases": [],
|
|
3830
|
-
"id": "release:validate",
|
|
3832
|
+
"id": "preload",
|
|
3831
3833
|
"pluginAlias": "balena-cli",
|
|
3832
3834
|
"pluginName": "balena-cli",
|
|
3833
3835
|
"pluginType": "core",
|
|
3834
3836
|
"strict": true,
|
|
3835
3837
|
"enableJsonFlag": false,
|
|
3836
3838
|
"authenticated": true,
|
|
3839
|
+
"primary": true,
|
|
3837
3840
|
"isESM": false,
|
|
3838
3841
|
"relativePath": [
|
|
3839
3842
|
"build",
|
|
3840
3843
|
"commands",
|
|
3841
|
-
"
|
|
3842
|
-
"
|
|
3844
|
+
"preload",
|
|
3845
|
+
"index.js"
|
|
3843
3846
|
]
|
|
3844
3847
|
},
|
|
3845
|
-
"
|
|
3848
|
+
"push": {
|
|
3846
3849
|
"aliases": [],
|
|
3847
3850
|
"args": {
|
|
3848
|
-
"
|
|
3849
|
-
"description": "
|
|
3850
|
-
"name": "
|
|
3851
|
+
"fleetOrDevice": {
|
|
3852
|
+
"description": "fleet name or slug, or local device IP address or \".local\" hostname",
|
|
3853
|
+
"name": "fleetOrDevice",
|
|
3851
3854
|
"required": true
|
|
3852
3855
|
}
|
|
3853
3856
|
},
|
|
3854
|
-
"description": "
|
|
3857
|
+
"description": "Build release images on balenaCloud servers or on a local mode device.\n\nBuild release images on balenaCloud servers or on a local mode device.\n\nWhen building on the balenaCloud servers, the given source directory will be\nsent to the remote server. This can be used as a drop-in replacement for the\n\"git push\" deployment method.\n\nWhen building on a local mode device, the given source directory will be\nbuilt on the device, and the resulting containers will be run on the device.\nLogs will be streamed back from the device as part of the same invocation.\nThe web dashboard can be used to switch a device to local mode:\nhttps://www.balena.io/docs/learn/develop/local-mode/\nNote that local mode requires a supervisor version of at least v7.21.0.\nThe logs from only a single service can be shown with the --service flag, and\nshowing only the system logs can be achieved with --system. Note that these\nflags can be used together.\n\nWhen pushing to a local device a live session will be started.\nThe project source folder is watched for filesystem events, and changes\nto files and folders are automatically synchronized to the running\ncontainers. The synchronization is only in one direction, from this machine to\nthe device, and changes made on the device itself may be overwritten.\nThis feature requires a device running supervisor version v9.7.0 or greater.\n\nREGISTRY SECRETS \nThe --registry-secrets option specifies a JSON or YAML file containing private\nDocker registry usernames and passwords to be used when pulling base images.\nSample registry-secrets YAML file:\n```\n\t'my-registry-server.com:25000':\n\t\tusername: ann\n\t\tpassword: hunter2\n\t'': # Use the empty string to refer to the Docker Hub\n\t\tusername: mike\n\t\tpassword: cze14\n\t'eu.gcr.io': # Google Container Registry\n\t\tusername: '_json_key'\n\t\tpassword: '{escaped contents of the GCR keyfile.json file}'\n```\nFor a sample project using registry secrets with the Google Container Registry,\ncheck: https://github.com/balena-io-examples/sample-gcr-registry-secrets\n\nIf the --registry-secrets option is not specified, and a secrets.yml or\nsecrets.json file exists in the balena directory (usually $HOME/.balena),\nthis file will be used instead.\n\nDOCKERIGNORE AND GITIGNORE FILES \nBy default, the balena CLI will use a single \".dockerignore\" file (if any) at\nthe project root (--source directory) in order to decide which source files to\nexclude from the \"build context\" (tar stream) sent to balenaCloud, Docker\ndaemon or balenaEngine. In a microservices (multicontainer) fleet, the\nsource directory is the directory that contains the \"docker-compose.yml\" file.\n\nThe --multi-dockerignore (-m) option may be used with microservices\n(multicontainer) fleets that define a docker-compose.yml file. When this\noption is used, each service subdirectory (defined by the `build` or\n`build.context` service properties in the docker-compose.yml file) is\nfiltered separately according to a .dockerignore file defined in the service\nsubdirectory. If no .dockerignore file exists in a service subdirectory, then\nonly the default .dockerignore patterns (see below) apply for that service\nsubdirectory.\n\nWhen the --multi-dockerignore (-m) option is used, the .dockerignore file (if\nany) defined at the overall project root will be used to filter files and\nsubdirectories other than service subdirectories. It will not have any effect\non service subdirectories, whether or not a service subdirectory defines its\nown .dockerignore file. Multiple .dockerignore files are not merged or added\ntogether, and cannot override or extend other files. This behavior maximizes\ncompatibility with the standard docker-compose tool, while still allowing a\nroot .dockerignore file (at the overall project root) to filter files and\nfolders that are outside service subdirectories.\n\nbalena CLI v11 also took .gitignore files into account. This behavior was\ndeprecated in CLI v12 and removed in CLI v13. Please use .dockerignore files\ninstead.\n\nDefault .dockerignore patterns \nA few default/hardcoded dockerignore patterns are \"merged\" (in memory) with the\npatterns found in the applicable .dockerignore files, in the following order:\n```\n **/.git\n < user's patterns from the applicable '.dockerignore' file, if any >\n !**/.balena\n !**/.resin\n !**/Dockerfile\n !**/Dockerfile.*\n !**/docker-compose.yml\n```\nThese patterns always apply, whether or not .dockerignore files exist in the\nproject. If necessary, the effect of the `**/.git` pattern may be modified by\nadding exception patterns to the applicable .dockerignore file(s), for example\n`!mysubmodule/.git`. For documentation on pattern format, see:\n- https://docs.docker.com/engine/reference/builder/#dockerignore-file\n- https://www.npmjs.com/package/@balena/dockerignore\n\nNote: the --service and --env flags must come after the fleetOrDevice\nparameter, as per examples.",
|
|
3855
3858
|
"examples": [
|
|
3856
|
-
"$ balena
|
|
3857
|
-
"$ balena
|
|
3858
|
-
"$ balena
|
|
3859
|
+
"$ balena push myFleet",
|
|
3860
|
+
"$ balena push myFleet --source <source directory>",
|
|
3861
|
+
"$ balena push myFleet -s <source directory>",
|
|
3862
|
+
"$ balena push myFleet --source <source directory> --note \"this is the note for this release\"",
|
|
3863
|
+
"$ balena push myFleet --release-tag key1 \"\" key2 \"value2 with spaces\"",
|
|
3864
|
+
"$ balena push myorg/myfleet",
|
|
3865
|
+
"",
|
|
3866
|
+
"$ balena push 10.0.0.1",
|
|
3867
|
+
"$ balena push 10.0.0.1 --source <source directory>",
|
|
3868
|
+
"$ balena push 10.0.0.1 --service my-service",
|
|
3869
|
+
"$ balena push 10.0.0.1 --env MY_ENV_VAR=value --env my-service:SERVICE_VAR=value",
|
|
3870
|
+
"$ balena push 10.0.0.1 --nolive",
|
|
3871
|
+
"",
|
|
3872
|
+
"$ balena push 23c73a1.local --system",
|
|
3873
|
+
"$ balena push 23c73a1.local --system --service my-service"
|
|
3859
3874
|
],
|
|
3860
3875
|
"flags": {
|
|
3861
|
-
"
|
|
3862
|
-
"
|
|
3863
|
-
"
|
|
3864
|
-
"
|
|
3876
|
+
"source": {
|
|
3877
|
+
"char": "s",
|
|
3878
|
+
"description": "Source directory to be sent to balenaCloud or balenaOS device\n(default: current working dir)",
|
|
3879
|
+
"name": "source",
|
|
3880
|
+
"default": ".",
|
|
3865
3881
|
"hasDynamicHelp": false,
|
|
3866
3882
|
"multiple": false,
|
|
3867
3883
|
"type": "option"
|
|
3868
3884
|
},
|
|
3869
|
-
"
|
|
3870
|
-
"char": "
|
|
3871
|
-
"description": "
|
|
3872
|
-
"name": "
|
|
3885
|
+
"emulated": {
|
|
3886
|
+
"char": "e",
|
|
3887
|
+
"description": "Don't use the faster, native balenaCloud ARM builders; force slower QEMU ARM\nemulation on Intel x86-64 builders. This flag is sometimes used to investigate\nsuspected issues with the balenaCloud backend.",
|
|
3888
|
+
"name": "emulated",
|
|
3873
3889
|
"allowNo": false,
|
|
3874
3890
|
"type": "boolean"
|
|
3875
|
-
}
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
|
|
3879
|
-
"id": "release-asset:delete",
|
|
3880
|
-
"pluginAlias": "balena-cli",
|
|
3881
|
-
"pluginName": "balena-cli",
|
|
3882
|
-
"pluginType": "core",
|
|
3883
|
-
"strict": true,
|
|
3884
|
-
"enableJsonFlag": false,
|
|
3885
|
-
"authenticated": true,
|
|
3886
|
-
"isESM": false,
|
|
3887
|
-
"relativePath": [
|
|
3888
|
-
"build",
|
|
3889
|
-
"commands",
|
|
3890
|
-
"release-asset",
|
|
3891
|
-
"delete.js"
|
|
3892
|
-
]
|
|
3893
|
-
},
|
|
3894
|
-
"release-asset:download": {
|
|
3895
|
-
"aliases": [],
|
|
3896
|
-
"args": {
|
|
3897
|
-
"commitOrId": {
|
|
3898
|
-
"description": "the commit or ID of the release",
|
|
3899
|
-
"name": "commitOrId",
|
|
3900
|
-
"required": true
|
|
3901
|
-
}
|
|
3902
|
-
},
|
|
3903
|
-
"description": "Download a release asset.\n\nDownload a release asset with the specified key. By default, the file will be saved\nwith the original filename. Use the --output flag to specify a different output path.\n\nIf the output file already exists, the command will prompt for confirmation before\noverwriting, unless the --overwrite flag is specified.",
|
|
3904
|
-
"examples": [
|
|
3905
|
-
"$ balena release-asset download 1234567 --key config.json",
|
|
3906
|
-
"$ balena release-asset download a777f7345fe3d655c1c981aa642e5555 --key app.tar.gz --output ./downloads/app.tar.gz",
|
|
3907
|
-
"$ balena release-asset download 1234567 --key large-file.bin -o output.bin",
|
|
3908
|
-
"$ balena release-asset download 1234567 --key config.json --overwrite"
|
|
3909
|
-
],
|
|
3910
|
-
"flags": {
|
|
3911
|
-
"key": {
|
|
3912
|
-
"description": "the key of the release asset to download",
|
|
3913
|
-
"name": "key",
|
|
3914
|
-
"required": true,
|
|
3891
|
+
},
|
|
3892
|
+
"dockerfile": {
|
|
3893
|
+
"description": "Alternative Dockerfile name/path, relative to the source folder",
|
|
3894
|
+
"name": "dockerfile",
|
|
3915
3895
|
"hasDynamicHelp": false,
|
|
3916
3896
|
"multiple": false,
|
|
3917
3897
|
"type": "option"
|
|
3918
3898
|
},
|
|
3919
|
-
"
|
|
3920
|
-
"char": "
|
|
3921
|
-
"description": "
|
|
3922
|
-
"name": "
|
|
3899
|
+
"nocache": {
|
|
3900
|
+
"char": "c",
|
|
3901
|
+
"description": "Don't use cached layers of previously built images for this project. This\nensures that the latest base image and packages are pulled. Note that build\nlogs may still display the message _\"Pulling previous images for caching\npurposes\" (as the cloud builder needs previous images to compute delta\nupdates), but the logs will not display the \"Using cache\" lines for each\nbuild step of a Dockerfile.",
|
|
3902
|
+
"name": "nocache",
|
|
3903
|
+
"allowNo": false,
|
|
3904
|
+
"type": "boolean"
|
|
3905
|
+
},
|
|
3906
|
+
"pull": {
|
|
3907
|
+
"description": "When pushing to a local device, force the base images to be pulled again.\nCurrently this option is ignored when pushing to the balenaCloud builders.",
|
|
3908
|
+
"name": "pull",
|
|
3909
|
+
"allowNo": false,
|
|
3910
|
+
"type": "boolean"
|
|
3911
|
+
},
|
|
3912
|
+
"noparent-check": {
|
|
3913
|
+
"description": "Disable project validation check of 'docker-compose.yml' file in parent folder",
|
|
3914
|
+
"name": "noparent-check",
|
|
3915
|
+
"allowNo": false,
|
|
3916
|
+
"type": "boolean"
|
|
3917
|
+
},
|
|
3918
|
+
"registry-secrets": {
|
|
3919
|
+
"char": "R",
|
|
3920
|
+
"description": "Path to a local YAML or JSON file containing Docker registry passwords used\nto pull base images. Note that if registry-secrets are not provided on the\ncommand line, a secrets configuration file from the balena directory will be\nused (usually $HOME/.balena/secrets.yml|.json)",
|
|
3921
|
+
"name": "registry-secrets",
|
|
3922
|
+
"hasDynamicHelp": false,
|
|
3923
|
+
"multiple": false,
|
|
3924
|
+
"type": "option"
|
|
3925
|
+
},
|
|
3926
|
+
"nolive": {
|
|
3927
|
+
"description": "Don't run a live session on this push. The filesystem will not be monitored,\nand changes will not be synchronized to any running containers. Note that both\nthis flag and --detached are required to cause the process to end once the\ninitial build has completed.",
|
|
3928
|
+
"name": "nolive",
|
|
3929
|
+
"allowNo": false,
|
|
3930
|
+
"type": "boolean"
|
|
3931
|
+
},
|
|
3932
|
+
"detached": {
|
|
3933
|
+
"char": "d",
|
|
3934
|
+
"description": "When pushing to the cloud, this option will cause the build to start, then\nreturn execution back to the shell, with the status and release ID (if\napplicable). When pushing to a local mode device, this option will cause\nthe command to not tail logs when the build has completed.",
|
|
3935
|
+
"name": "detached",
|
|
3936
|
+
"allowNo": false,
|
|
3937
|
+
"type": "boolean"
|
|
3938
|
+
},
|
|
3939
|
+
"service": {
|
|
3940
|
+
"description": "Reject logs not originating from this service.\nThis can be used in combination with --system and other --service flags.\nOnly valid when pushing to a local mode device.",
|
|
3941
|
+
"name": "service",
|
|
3942
|
+
"hasDynamicHelp": false,
|
|
3943
|
+
"multiple": true,
|
|
3944
|
+
"type": "option"
|
|
3945
|
+
},
|
|
3946
|
+
"system": {
|
|
3947
|
+
"description": "Only show system logs. This can be used in combination with --service.\nOnly valid when pushing to a local mode device.",
|
|
3948
|
+
"name": "system",
|
|
3949
|
+
"allowNo": false,
|
|
3950
|
+
"type": "boolean"
|
|
3951
|
+
},
|
|
3952
|
+
"env": {
|
|
3953
|
+
"description": "When performing a push to device, run the built containers with environment\nvariables provided with this argument. Environment variables can be applied\nto individual services by adding their service name before the argument,\nseparated by a colon, e.g:\n\t--env main:MY_ENV=value\nNote that if the service name cannot be found in the composition, the entire\nleft hand side of the = character will be treated as the variable name.",
|
|
3954
|
+
"name": "env",
|
|
3955
|
+
"hasDynamicHelp": false,
|
|
3956
|
+
"multiple": true,
|
|
3957
|
+
"type": "option"
|
|
3958
|
+
},
|
|
3959
|
+
"noconvert-eol": {
|
|
3960
|
+
"description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
|
|
3961
|
+
"name": "noconvert-eol",
|
|
3962
|
+
"allowNo": false,
|
|
3963
|
+
"type": "boolean"
|
|
3964
|
+
},
|
|
3965
|
+
"multi-dockerignore": {
|
|
3966
|
+
"char": "m",
|
|
3967
|
+
"description": "Have each service use its own .dockerignore file. See \"balena help push\".",
|
|
3968
|
+
"name": "multi-dockerignore",
|
|
3969
|
+
"allowNo": false,
|
|
3970
|
+
"type": "boolean"
|
|
3971
|
+
},
|
|
3972
|
+
"release-tag": {
|
|
3973
|
+
"description": "Set release tags if the image build is successful (balenaCloud only). Multiple\narguments may be provided, alternating tag keys and values (see examples).\nHint: Empty values may be specified with \"\" (bash, cmd.exe) or '\"\"' (PowerShell).",
|
|
3974
|
+
"exclusive": [
|
|
3975
|
+
"detached"
|
|
3976
|
+
],
|
|
3977
|
+
"name": "release-tag",
|
|
3978
|
+
"hasDynamicHelp": false,
|
|
3979
|
+
"multiple": true,
|
|
3980
|
+
"type": "option"
|
|
3981
|
+
},
|
|
3982
|
+
"draft": {
|
|
3983
|
+
"description": "Instruct the builder to create the release as a draft. Draft releases are ignored\nby the 'track latest' release policy but can be used through release pinning.\nDraft releases can be marked as final through the API. Releases are created\nas final by default unless this option is given.",
|
|
3984
|
+
"name": "draft",
|
|
3985
|
+
"allowNo": false,
|
|
3986
|
+
"type": "boolean"
|
|
3987
|
+
},
|
|
3988
|
+
"note": {
|
|
3989
|
+
"description": "The notes for this release",
|
|
3990
|
+
"name": "note",
|
|
3923
3991
|
"hasDynamicHelp": false,
|
|
3924
3992
|
"multiple": false,
|
|
3925
3993
|
"type": "option"
|
|
3926
|
-
},
|
|
3927
|
-
"overwrite": {
|
|
3928
|
-
"description": "overwrite existing file without confirmation",
|
|
3929
|
-
"name": "overwrite",
|
|
3930
|
-
"allowNo": false,
|
|
3931
|
-
"type": "boolean"
|
|
3932
3994
|
}
|
|
3933
3995
|
},
|
|
3934
3996
|
"hasDynamicHelp": false,
|
|
3935
3997
|
"hiddenAliases": [],
|
|
3936
|
-
"id": "
|
|
3998
|
+
"id": "push",
|
|
3937
3999
|
"pluginAlias": "balena-cli",
|
|
3938
4000
|
"pluginName": "balena-cli",
|
|
3939
4001
|
"pluginType": "core",
|
|
3940
4002
|
"strict": true,
|
|
3941
4003
|
"enableJsonFlag": false,
|
|
3942
|
-
"
|
|
4004
|
+
"primary": true,
|
|
3943
4005
|
"isESM": false,
|
|
3944
4006
|
"relativePath": [
|
|
3945
4007
|
"build",
|
|
3946
4008
|
"commands",
|
|
3947
|
-
"
|
|
3948
|
-
"
|
|
4009
|
+
"push",
|
|
4010
|
+
"index.js"
|
|
3949
4011
|
]
|
|
3950
4012
|
},
|
|
3951
|
-
"release
|
|
4013
|
+
"release:finalize": {
|
|
3952
4014
|
"aliases": [],
|
|
3953
4015
|
"args": {
|
|
3954
4016
|
"commitOrId": {
|
|
3955
|
-
"description": "the commit or ID of the release",
|
|
4017
|
+
"description": "the commit or ID of the release to finalize",
|
|
3956
4018
|
"name": "commitOrId",
|
|
3957
4019
|
"required": true
|
|
3958
4020
|
}
|
|
3959
4021
|
},
|
|
3960
|
-
"description": "
|
|
4022
|
+
"description": "Finalize a release.\n\nFinalize a release. Releases can be \"draft\" or \"final\", and this command\nchanges a draft release into a final release. Draft releases can be created\nwith the `--draft` option of the `balena build` or `balena deploy`\ncommands.\n\nDraft releases are not automatically deployed to devices tracking the latest\nrelease. For a draft release to be deployed to a device, the device should be\nexplicity pinned to that release. Conversely, final releases may trigger immediate\ndeployment to unpinned devices (subject to a device's polling period) and, for\nthis reason, final releases cannot be changed back to draft status.",
|
|
3961
4023
|
"examples": [
|
|
3962
|
-
"$ balena release
|
|
3963
|
-
"$ balena release
|
|
4024
|
+
"$ balena release finalize a777f7345fe3d655c1c981aa642e5555",
|
|
4025
|
+
"$ balena release finalize 1234567"
|
|
3964
4026
|
],
|
|
3965
|
-
"flags": {
|
|
3966
|
-
"json": {
|
|
3967
|
-
"description": "Format output as json.",
|
|
3968
|
-
"helpGroup": "GLOBAL",
|
|
3969
|
-
"name": "json",
|
|
3970
|
-
"allowNo": false,
|
|
3971
|
-
"type": "boolean"
|
|
3972
|
-
}
|
|
3973
|
-
},
|
|
4027
|
+
"flags": {},
|
|
3974
4028
|
"hasDynamicHelp": false,
|
|
3975
4029
|
"hiddenAliases": [],
|
|
3976
|
-
"id": "release
|
|
4030
|
+
"id": "release:finalize",
|
|
3977
4031
|
"pluginAlias": "balena-cli",
|
|
3978
4032
|
"pluginName": "balena-cli",
|
|
3979
4033
|
"pluginType": "core",
|
|
3980
4034
|
"strict": true,
|
|
3981
|
-
"enableJsonFlag":
|
|
4035
|
+
"enableJsonFlag": false,
|
|
3982
4036
|
"authenticated": true,
|
|
3983
4037
|
"isESM": false,
|
|
3984
4038
|
"relativePath": [
|
|
3985
4039
|
"build",
|
|
3986
4040
|
"commands",
|
|
3987
|
-
"release
|
|
3988
|
-
"
|
|
4041
|
+
"release",
|
|
4042
|
+
"finalize.js"
|
|
3989
4043
|
]
|
|
3990
4044
|
},
|
|
3991
|
-
"release
|
|
4045
|
+
"release": {
|
|
3992
4046
|
"aliases": [],
|
|
3993
4047
|
"args": {
|
|
3994
4048
|
"commitOrId": {
|
|
3995
|
-
"description": "the commit or ID of the release",
|
|
4049
|
+
"description": "the commit or ID of the release to get information",
|
|
3996
4050
|
"name": "commitOrId",
|
|
3997
4051
|
"required": true
|
|
3998
|
-
},
|
|
3999
|
-
"filePath": {
|
|
4000
|
-
"description": "path to the file to upload",
|
|
4001
|
-
"name": "filePath",
|
|
4002
|
-
"required": true
|
|
4003
4052
|
}
|
|
4004
4053
|
},
|
|
4005
|
-
"description": "
|
|
4054
|
+
"description": "Get info for a release.",
|
|
4006
4055
|
"examples": [
|
|
4007
|
-
"$ balena release
|
|
4008
|
-
"$ balena release
|
|
4009
|
-
"$ balena release-asset upload 1234567 ./file.bin --key large-file.bin --chunk-size 10485760 --parallel-chunks 10"
|
|
4056
|
+
"$ balena release a777f7345fe3d655c1c981aa642e5555",
|
|
4057
|
+
"$ balena release 1234567"
|
|
4010
4058
|
],
|
|
4011
4059
|
"flags": {
|
|
4012
|
-
"
|
|
4013
|
-
"description": "
|
|
4014
|
-
"
|
|
4015
|
-
"
|
|
4016
|
-
"hasDynamicHelp": false,
|
|
4017
|
-
"multiple": false,
|
|
4018
|
-
"type": "option"
|
|
4019
|
-
},
|
|
4020
|
-
"overwrite": {
|
|
4021
|
-
"description": "overwrite the asset if it already exists",
|
|
4022
|
-
"name": "overwrite",
|
|
4060
|
+
"json": {
|
|
4061
|
+
"description": "Format output as json.",
|
|
4062
|
+
"helpGroup": "GLOBAL",
|
|
4063
|
+
"name": "json",
|
|
4023
4064
|
"allowNo": false,
|
|
4024
4065
|
"type": "boolean"
|
|
4025
4066
|
},
|
|
4026
|
-
"
|
|
4027
|
-
"
|
|
4028
|
-
"
|
|
4029
|
-
"
|
|
4030
|
-
"
|
|
4031
|
-
"
|
|
4032
|
-
"type": "option"
|
|
4033
|
-
},
|
|
4034
|
-
"parallel-chunks": {
|
|
4035
|
-
"description": "number of chunks to upload in parallel",
|
|
4036
|
-
"name": "parallel-chunks",
|
|
4037
|
-
"default": 5,
|
|
4038
|
-
"hasDynamicHelp": false,
|
|
4039
|
-
"multiple": false,
|
|
4040
|
-
"type": "option"
|
|
4067
|
+
"composition": {
|
|
4068
|
+
"char": "c",
|
|
4069
|
+
"description": "Return the release composition",
|
|
4070
|
+
"name": "composition",
|
|
4071
|
+
"allowNo": false,
|
|
4072
|
+
"type": "boolean"
|
|
4041
4073
|
}
|
|
4042
4074
|
},
|
|
4043
4075
|
"hasDynamicHelp": false,
|
|
4044
4076
|
"hiddenAliases": [],
|
|
4045
|
-
"id": "release
|
|
4077
|
+
"id": "release",
|
|
4046
4078
|
"pluginAlias": "balena-cli",
|
|
4047
4079
|
"pluginName": "balena-cli",
|
|
4048
4080
|
"pluginType": "core",
|
|
4049
4081
|
"strict": true,
|
|
4050
|
-
"enableJsonFlag":
|
|
4082
|
+
"enableJsonFlag": true,
|
|
4051
4083
|
"authenticated": true,
|
|
4052
4084
|
"isESM": false,
|
|
4053
4085
|
"relativePath": [
|
|
4054
4086
|
"build",
|
|
4055
4087
|
"commands",
|
|
4056
|
-
"release
|
|
4057
|
-
"
|
|
4088
|
+
"release",
|
|
4089
|
+
"index.js"
|
|
4058
4090
|
]
|
|
4059
4091
|
},
|
|
4060
|
-
"
|
|
4092
|
+
"release:invalidate": {
|
|
4061
4093
|
"aliases": [],
|
|
4062
|
-
"args": {
|
|
4063
|
-
|
|
4094
|
+
"args": {
|
|
4095
|
+
"commitOrId": {
|
|
4096
|
+
"description": "the commit or ID of the release to invalidate",
|
|
4097
|
+
"name": "commitOrId",
|
|
4098
|
+
"required": true
|
|
4099
|
+
}
|
|
4100
|
+
},
|
|
4101
|
+
"description": "Invalidate a release.\n\nInvalidate a release.\n\nInvalid releases are not automatically deployed to devices tracking the latest\nrelease. For an invalid release to be deployed to a device, the device should be\nexplicity pinned to that release.",
|
|
4064
4102
|
"examples": [
|
|
4065
|
-
"$ balena
|
|
4103
|
+
"$ balena release invalidate a777f7345fe3d655c1c981aa642e5555",
|
|
4104
|
+
"$ balena release invalidate 1234567"
|
|
4066
4105
|
],
|
|
4067
4106
|
"flags": {},
|
|
4068
4107
|
"hasDynamicHelp": false,
|
|
4069
4108
|
"hiddenAliases": [],
|
|
4070
|
-
"id": "
|
|
4109
|
+
"id": "release:invalidate",
|
|
4071
4110
|
"pluginAlias": "balena-cli",
|
|
4072
4111
|
"pluginName": "balena-cli",
|
|
4073
4112
|
"pluginType": "core",
|
|
4074
4113
|
"strict": true,
|
|
4075
4114
|
"enableJsonFlag": false,
|
|
4115
|
+
"authenticated": true,
|
|
4076
4116
|
"isESM": false,
|
|
4077
4117
|
"relativePath": [
|
|
4078
4118
|
"build",
|
|
4079
4119
|
"commands",
|
|
4080
|
-
"
|
|
4081
|
-
"
|
|
4120
|
+
"release",
|
|
4121
|
+
"invalidate.js"
|
|
4082
4122
|
]
|
|
4083
4123
|
},
|
|
4084
|
-
"
|
|
4124
|
+
"release:list": {
|
|
4085
4125
|
"aliases": [],
|
|
4086
4126
|
"args": {
|
|
4087
|
-
"
|
|
4088
|
-
"description": "
|
|
4089
|
-
"name": "
|
|
4090
|
-
"required": true
|
|
4091
|
-
},
|
|
4092
|
-
"path": {
|
|
4093
|
-
"description": "the path to the public key file",
|
|
4094
|
-
"name": "path",
|
|
4127
|
+
"fleet": {
|
|
4128
|
+
"description": "fleet name or slug (preferred)",
|
|
4129
|
+
"name": "fleet",
|
|
4095
4130
|
"required": true
|
|
4096
4131
|
}
|
|
4097
4132
|
},
|
|
4098
|
-
"description": "
|
|
4133
|
+
"description": "List all releases of a fleet.\n\nList all releases of the given fleet.\n\nFleets may be specified by fleet name or slug. Slugs are recommended because\nthey are unique and unambiguous. Slugs can be listed with the `balena fleet list`\ncommand. Note that slugs may change if the fleet is renamed. Fleet names are\nnot unique and may result in \"Fleet is ambiguous\" errors at any time (even if\n\"it used to work in the past\"), for example if the name clashes with a newly\ncreated public/open fleet, or with fleets from other balena accounts that you\nmay be invited to join under any role. For this reason, fleet names are\nespecially discouraged in scripts (e.g. CI environments).",
|
|
4099
4134
|
"examples": [
|
|
4100
|
-
"$ balena
|
|
4101
|
-
"$ cat ~/.ssh/id_rsa.pub | balena ssh-key add Main",
|
|
4102
|
-
"# Windows 10 (cmd.exe prompt) example",
|
|
4103
|
-
"$ balena ssh-key add Main %userprofile%.sshid_rsa.pub"
|
|
4135
|
+
"$ balena release list myorg/myfleet"
|
|
4104
4136
|
],
|
|
4105
|
-
"flags": {
|
|
4137
|
+
"flags": {
|
|
4138
|
+
"json": {
|
|
4139
|
+
"description": "Format output as json.",
|
|
4140
|
+
"helpGroup": "GLOBAL",
|
|
4141
|
+
"name": "json",
|
|
4142
|
+
"allowNo": false,
|
|
4143
|
+
"type": "boolean"
|
|
4144
|
+
}
|
|
4145
|
+
},
|
|
4106
4146
|
"hasDynamicHelp": false,
|
|
4107
4147
|
"hiddenAliases": [],
|
|
4108
|
-
"id": "
|
|
4148
|
+
"id": "release:list",
|
|
4109
4149
|
"pluginAlias": "balena-cli",
|
|
4110
4150
|
"pluginName": "balena-cli",
|
|
4111
4151
|
"pluginType": "core",
|
|
4112
4152
|
"strict": true,
|
|
4113
|
-
"enableJsonFlag":
|
|
4153
|
+
"enableJsonFlag": true,
|
|
4114
4154
|
"authenticated": true,
|
|
4115
4155
|
"isESM": false,
|
|
4116
4156
|
"relativePath": [
|
|
4117
4157
|
"build",
|
|
4118
4158
|
"commands",
|
|
4119
|
-
"
|
|
4120
|
-
"
|
|
4159
|
+
"release",
|
|
4160
|
+
"list.js"
|
|
4121
4161
|
]
|
|
4122
4162
|
},
|
|
4123
|
-
"
|
|
4163
|
+
"release:validate": {
|
|
4124
4164
|
"aliases": [],
|
|
4125
4165
|
"args": {
|
|
4126
|
-
"
|
|
4127
|
-
"description": "
|
|
4128
|
-
"name": "
|
|
4166
|
+
"commitOrId": {
|
|
4167
|
+
"description": "the commit or ID of the release to validate",
|
|
4168
|
+
"name": "commitOrId",
|
|
4129
4169
|
"required": true
|
|
4130
4170
|
}
|
|
4131
4171
|
},
|
|
4132
|
-
"description": "
|
|
4172
|
+
"description": "Validate a release.\n\nValidate a release.\n\nValid releases are automatically deployed to devices tracking the latest\nrelease if they are finalized.",
|
|
4133
4173
|
"examples": [
|
|
4134
|
-
"$ balena
|
|
4174
|
+
"$ balena release validate a777f7345fe3d655c1c981aa642e5555",
|
|
4175
|
+
"$ balena release validate 1234567"
|
|
4135
4176
|
],
|
|
4136
4177
|
"flags": {},
|
|
4137
4178
|
"hasDynamicHelp": false,
|
|
4138
4179
|
"hiddenAliases": [],
|
|
4139
|
-
"id": "
|
|
4180
|
+
"id": "release:validate",
|
|
4140
4181
|
"pluginAlias": "balena-cli",
|
|
4141
4182
|
"pluginName": "balena-cli",
|
|
4142
4183
|
"pluginType": "core",
|
|
@@ -4147,21 +4188,45 @@
|
|
|
4147
4188
|
"relativePath": [
|
|
4148
4189
|
"build",
|
|
4149
4190
|
"commands",
|
|
4150
|
-
"
|
|
4151
|
-
"
|
|
4191
|
+
"release",
|
|
4192
|
+
"validate.js"
|
|
4152
4193
|
]
|
|
4153
4194
|
},
|
|
4154
|
-
"
|
|
4195
|
+
"release-asset:delete": {
|
|
4155
4196
|
"aliases": [],
|
|
4156
|
-
"args": {
|
|
4157
|
-
|
|
4197
|
+
"args": {
|
|
4198
|
+
"commitOrId": {
|
|
4199
|
+
"description": "the commit or ID of the release",
|
|
4200
|
+
"name": "commitOrId",
|
|
4201
|
+
"required": true
|
|
4202
|
+
}
|
|
4203
|
+
},
|
|
4204
|
+
"description": "Delete a release asset.\n\nDelete a release asset with the specified key. This action cannot be undone.",
|
|
4158
4205
|
"examples": [
|
|
4159
|
-
"$ balena
|
|
4206
|
+
"$ balena release-asset delete 1234567 --key config.json",
|
|
4207
|
+
"$ balena release-asset delete a777f7345fe3d655c1c981aa642e5555 --key app.tar.gz",
|
|
4208
|
+
"$ balena release-asset delete 1234567 --key old-asset --yes"
|
|
4160
4209
|
],
|
|
4161
|
-
"flags": {
|
|
4210
|
+
"flags": {
|
|
4211
|
+
"key": {
|
|
4212
|
+
"description": "the key of the release asset to delete",
|
|
4213
|
+
"name": "key",
|
|
4214
|
+
"required": true,
|
|
4215
|
+
"hasDynamicHelp": false,
|
|
4216
|
+
"multiple": false,
|
|
4217
|
+
"type": "option"
|
|
4218
|
+
},
|
|
4219
|
+
"yes": {
|
|
4220
|
+
"char": "y",
|
|
4221
|
+
"description": "skip confirmation prompt",
|
|
4222
|
+
"name": "yes",
|
|
4223
|
+
"allowNo": false,
|
|
4224
|
+
"type": "boolean"
|
|
4225
|
+
}
|
|
4226
|
+
},
|
|
4162
4227
|
"hasDynamicHelp": false,
|
|
4163
4228
|
"hiddenAliases": [],
|
|
4164
|
-
"id": "
|
|
4229
|
+
"id": "release-asset:delete",
|
|
4165
4230
|
"pluginAlias": "balena-cli",
|
|
4166
4231
|
"pluginName": "balena-cli",
|
|
4167
4232
|
"pluginType": "core",
|
|
@@ -4172,36 +4237,53 @@
|
|
|
4172
4237
|
"relativePath": [
|
|
4173
4238
|
"build",
|
|
4174
4239
|
"commands",
|
|
4175
|
-
"
|
|
4176
|
-
"
|
|
4240
|
+
"release-asset",
|
|
4241
|
+
"delete.js"
|
|
4177
4242
|
]
|
|
4178
4243
|
},
|
|
4179
|
-
"
|
|
4244
|
+
"release-asset:download": {
|
|
4180
4245
|
"aliases": [],
|
|
4181
4246
|
"args": {
|
|
4182
|
-
"
|
|
4183
|
-
"description": "
|
|
4184
|
-
"name": "
|
|
4247
|
+
"commitOrId": {
|
|
4248
|
+
"description": "the commit or ID of the release",
|
|
4249
|
+
"name": "commitOrId",
|
|
4185
4250
|
"required": true
|
|
4186
4251
|
}
|
|
4187
4252
|
},
|
|
4188
|
-
"description": "
|
|
4253
|
+
"description": "Download a release asset.\n\nDownload a release asset with the specified key. By default, the file will be saved\nwith the original filename. Use the --output flag to specify a different output path.\n\nIf the output file already exists, the command will prompt for confirmation before\noverwriting, unless the --overwrite flag is specified.",
|
|
4189
4254
|
"examples": [
|
|
4190
|
-
"$ balena
|
|
4191
|
-
"$ balena
|
|
4255
|
+
"$ balena release-asset download 1234567 --key config.json",
|
|
4256
|
+
"$ balena release-asset download a777f7345fe3d655c1c981aa642e5555 --key app.tar.gz --output ./downloads/app.tar.gz",
|
|
4257
|
+
"$ balena release-asset download 1234567 --key large-file.bin -o output.bin",
|
|
4258
|
+
"$ balena release-asset download 1234567 --key config.json --overwrite"
|
|
4192
4259
|
],
|
|
4193
4260
|
"flags": {
|
|
4194
|
-
"
|
|
4195
|
-
"
|
|
4196
|
-
"
|
|
4197
|
-
"
|
|
4261
|
+
"key": {
|
|
4262
|
+
"description": "the key of the release asset to download",
|
|
4263
|
+
"name": "key",
|
|
4264
|
+
"required": true,
|
|
4265
|
+
"hasDynamicHelp": false,
|
|
4266
|
+
"multiple": false,
|
|
4267
|
+
"type": "option"
|
|
4268
|
+
},
|
|
4269
|
+
"output": {
|
|
4270
|
+
"char": "o",
|
|
4271
|
+
"description": "output path for the downloaded file",
|
|
4272
|
+
"name": "output",
|
|
4273
|
+
"hasDynamicHelp": false,
|
|
4274
|
+
"multiple": false,
|
|
4275
|
+
"type": "option"
|
|
4276
|
+
},
|
|
4277
|
+
"overwrite": {
|
|
4278
|
+
"description": "overwrite existing file without confirmation",
|
|
4279
|
+
"name": "overwrite",
|
|
4198
4280
|
"allowNo": false,
|
|
4199
4281
|
"type": "boolean"
|
|
4200
4282
|
}
|
|
4201
4283
|
},
|
|
4202
4284
|
"hasDynamicHelp": false,
|
|
4203
4285
|
"hiddenAliases": [],
|
|
4204
|
-
"id": "
|
|
4286
|
+
"id": "release-asset:download",
|
|
4205
4287
|
"pluginAlias": "balena-cli",
|
|
4206
4288
|
"pluginName": "balena-cli",
|
|
4207
4289
|
"pluginType": "core",
|
|
@@ -4212,115 +4294,97 @@
|
|
|
4212
4294
|
"relativePath": [
|
|
4213
4295
|
"build",
|
|
4214
4296
|
"commands",
|
|
4215
|
-
"
|
|
4216
|
-
"
|
|
4297
|
+
"release-asset",
|
|
4298
|
+
"download.js"
|
|
4217
4299
|
]
|
|
4218
4300
|
},
|
|
4219
|
-
"
|
|
4301
|
+
"release-asset:list": {
|
|
4220
4302
|
"aliases": [],
|
|
4221
4303
|
"args": {
|
|
4222
|
-
"
|
|
4223
|
-
"description": "
|
|
4224
|
-
"name": "
|
|
4225
|
-
"
|
|
4226
|
-
"enable",
|
|
4227
|
-
"disable"
|
|
4228
|
-
]
|
|
4304
|
+
"commitOrId": {
|
|
4305
|
+
"description": "the commit or ID of the release",
|
|
4306
|
+
"name": "commitOrId",
|
|
4307
|
+
"required": true
|
|
4229
4308
|
}
|
|
4230
4309
|
},
|
|
4231
|
-
"description": "
|
|
4310
|
+
"description": "List all release assets.\n\nList all assets for a specific release.",
|
|
4232
4311
|
"examples": [
|
|
4233
|
-
"balena
|
|
4234
|
-
"balena
|
|
4235
|
-
"balena support disable -f myorg/myfleet"
|
|
4312
|
+
"$ balena release-asset list 1234567",
|
|
4313
|
+
"$ balena release-asset list a777f7345fe3d655c1c981aa642e5555"
|
|
4236
4314
|
],
|
|
4237
4315
|
"flags": {
|
|
4238
|
-
"
|
|
4239
|
-
"
|
|
4240
|
-
"
|
|
4241
|
-
"name": "
|
|
4242
|
-
"
|
|
4243
|
-
"
|
|
4244
|
-
"type": "option"
|
|
4245
|
-
},
|
|
4246
|
-
"fleet": {
|
|
4247
|
-
"char": "f",
|
|
4248
|
-
"description": "comma-separated list (no spaces) of fleet names or slugs (preferred)",
|
|
4249
|
-
"name": "fleet",
|
|
4250
|
-
"hasDynamicHelp": false,
|
|
4251
|
-
"multiple": false,
|
|
4252
|
-
"type": "option"
|
|
4253
|
-
},
|
|
4254
|
-
"duration": {
|
|
4255
|
-
"char": "t",
|
|
4256
|
-
"description": "length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d",
|
|
4257
|
-
"name": "duration",
|
|
4258
|
-
"hasDynamicHelp": false,
|
|
4259
|
-
"multiple": false,
|
|
4260
|
-
"type": "option"
|
|
4316
|
+
"json": {
|
|
4317
|
+
"description": "Format output as json.",
|
|
4318
|
+
"helpGroup": "GLOBAL",
|
|
4319
|
+
"name": "json",
|
|
4320
|
+
"allowNo": false,
|
|
4321
|
+
"type": "boolean"
|
|
4261
4322
|
}
|
|
4262
4323
|
},
|
|
4263
4324
|
"hasDynamicHelp": false,
|
|
4264
4325
|
"hiddenAliases": [],
|
|
4265
|
-
"id": "
|
|
4326
|
+
"id": "release-asset:list",
|
|
4266
4327
|
"pluginAlias": "balena-cli",
|
|
4267
4328
|
"pluginName": "balena-cli",
|
|
4268
4329
|
"pluginType": "core",
|
|
4269
4330
|
"strict": true,
|
|
4270
|
-
"enableJsonFlag":
|
|
4331
|
+
"enableJsonFlag": true,
|
|
4271
4332
|
"authenticated": true,
|
|
4272
4333
|
"isESM": false,
|
|
4273
4334
|
"relativePath": [
|
|
4274
4335
|
"build",
|
|
4275
4336
|
"commands",
|
|
4276
|
-
"
|
|
4277
|
-
"
|
|
4337
|
+
"release-asset",
|
|
4338
|
+
"list.js"
|
|
4278
4339
|
]
|
|
4279
4340
|
},
|
|
4280
|
-
"
|
|
4341
|
+
"release-asset:upload": {
|
|
4281
4342
|
"aliases": [],
|
|
4282
|
-
"args": {
|
|
4283
|
-
|
|
4343
|
+
"args": {
|
|
4344
|
+
"commitOrId": {
|
|
4345
|
+
"description": "the commit or ID of the release",
|
|
4346
|
+
"name": "commitOrId",
|
|
4347
|
+
"required": true
|
|
4348
|
+
},
|
|
4349
|
+
"filePath": {
|
|
4350
|
+
"description": "path to the file to upload",
|
|
4351
|
+
"name": "filePath",
|
|
4352
|
+
"required": true
|
|
4353
|
+
}
|
|
4354
|
+
},
|
|
4355
|
+
"description": "Upload a release asset.\n\nUpload a file as a release asset with the specified key. If the asset already exists,\nyou can use the --overwrite flag to replace it. You can customize the upload behavior with\n--chunk-size and --parallel-chunks options for larger files.",
|
|
4284
4356
|
"examples": [
|
|
4285
|
-
"$ balena
|
|
4286
|
-
"$ balena
|
|
4287
|
-
"$ balena
|
|
4288
|
-
"$ balena tag list --release 1234",
|
|
4289
|
-
"$ balena tag list --release b376b0e544e9429483b656490e5b9443b4349bd6"
|
|
4357
|
+
"$ balena release-asset upload 1234567 ./path/to/config.json --key config.json",
|
|
4358
|
+
"$ balena release-asset upload a777f7345fe3d655c1c981aa642e5555 ./app.tar.gz --key app.tar.gz --overwrite",
|
|
4359
|
+
"$ balena release-asset upload 1234567 ./file.bin --key large-file.bin --chunk-size 10485760 --parallel-chunks 10"
|
|
4290
4360
|
],
|
|
4291
4361
|
"flags": {
|
|
4292
|
-
"
|
|
4293
|
-
"
|
|
4294
|
-
"
|
|
4295
|
-
"
|
|
4296
|
-
"device",
|
|
4297
|
-
"release"
|
|
4298
|
-
],
|
|
4299
|
-
"name": "fleet",
|
|
4362
|
+
"key": {
|
|
4363
|
+
"description": "the key for the release asset",
|
|
4364
|
+
"name": "key",
|
|
4365
|
+
"required": true,
|
|
4300
4366
|
"hasDynamicHelp": false,
|
|
4301
4367
|
"multiple": false,
|
|
4302
4368
|
"type": "option"
|
|
4303
4369
|
},
|
|
4304
|
-
"
|
|
4305
|
-
"
|
|
4306
|
-
"
|
|
4307
|
-
"
|
|
4308
|
-
|
|
4309
|
-
|
|
4310
|
-
|
|
4311
|
-
"
|
|
4370
|
+
"overwrite": {
|
|
4371
|
+
"description": "overwrite the asset if it already exists",
|
|
4372
|
+
"name": "overwrite",
|
|
4373
|
+
"allowNo": false,
|
|
4374
|
+
"type": "boolean"
|
|
4375
|
+
},
|
|
4376
|
+
"chunk-size": {
|
|
4377
|
+
"description": "chunk size in bytes for multipart upload (minimum 5MB)",
|
|
4378
|
+
"name": "chunk-size",
|
|
4379
|
+
"default": 5242880,
|
|
4312
4380
|
"hasDynamicHelp": false,
|
|
4313
4381
|
"multiple": false,
|
|
4314
4382
|
"type": "option"
|
|
4315
4383
|
},
|
|
4316
|
-
"
|
|
4317
|
-
"
|
|
4318
|
-
"
|
|
4319
|
-
"
|
|
4320
|
-
"fleet",
|
|
4321
|
-
"device"
|
|
4322
|
-
],
|
|
4323
|
-
"name": "release",
|
|
4384
|
+
"parallel-chunks": {
|
|
4385
|
+
"description": "number of chunks to upload in parallel",
|
|
4386
|
+
"name": "parallel-chunks",
|
|
4387
|
+
"default": 5,
|
|
4324
4388
|
"hasDynamicHelp": false,
|
|
4325
4389
|
"multiple": false,
|
|
4326
4390
|
"type": "option"
|
|
@@ -4328,7 +4392,7 @@
|
|
|
4328
4392
|
},
|
|
4329
4393
|
"hasDynamicHelp": false,
|
|
4330
4394
|
"hiddenAliases": [],
|
|
4331
|
-
"id": "
|
|
4395
|
+
"id": "release-asset:upload",
|
|
4332
4396
|
"pluginAlias": "balena-cli",
|
|
4333
4397
|
"pluginName": "balena-cli",
|
|
4334
4398
|
"pluginType": "core",
|
|
@@ -4339,197 +4403,115 @@
|
|
|
4339
4403
|
"relativePath": [
|
|
4340
4404
|
"build",
|
|
4341
4405
|
"commands",
|
|
4342
|
-
"
|
|
4343
|
-
"
|
|
4406
|
+
"release-asset",
|
|
4407
|
+
"upload.js"
|
|
4344
4408
|
]
|
|
4345
4409
|
},
|
|
4346
|
-
"
|
|
4410
|
+
"settings": {
|
|
4347
4411
|
"aliases": [],
|
|
4348
|
-
"args": {
|
|
4349
|
-
|
|
4350
|
-
"description": "the key string of the tag",
|
|
4351
|
-
"name": "tagKey",
|
|
4352
|
-
"required": true
|
|
4353
|
-
}
|
|
4354
|
-
},
|
|
4355
|
-
"description": "Remove a tag from a fleet, device or release.\n\nRemove a tag from a fleet, device or release.\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).",
|
|
4412
|
+
"args": {},
|
|
4413
|
+
"description": "Print current settings.\n\nUse this command to display the current balena CLI settings.",
|
|
4356
4414
|
"examples": [
|
|
4357
|
-
"$ balena
|
|
4358
|
-
"$ balena tag rm myTagKey -f myorg/myfleet",
|
|
4359
|
-
"$ balena tag rm myTagKey --device 7cf02a6",
|
|
4360
|
-
"$ balena tag rm myTagKey --release 1234",
|
|
4361
|
-
"$ balena tag rm myTagKey --release b376b0e544e9429483b656490e5b9443b4349bd6"
|
|
4415
|
+
"$ balena settings"
|
|
4362
4416
|
],
|
|
4363
|
-
"flags": {
|
|
4364
|
-
"fleet": {
|
|
4365
|
-
"char": "f",
|
|
4366
|
-
"description": "fleet name or slug (preferred)",
|
|
4367
|
-
"exclusive": [
|
|
4368
|
-
"device",
|
|
4369
|
-
"release"
|
|
4370
|
-
],
|
|
4371
|
-
"name": "fleet",
|
|
4372
|
-
"hasDynamicHelp": false,
|
|
4373
|
-
"multiple": false,
|
|
4374
|
-
"type": "option"
|
|
4375
|
-
},
|
|
4376
|
-
"device": {
|
|
4377
|
-
"char": "d",
|
|
4378
|
-
"description": "device UUID",
|
|
4379
|
-
"exclusive": [
|
|
4380
|
-
"fleet",
|
|
4381
|
-
"release"
|
|
4382
|
-
],
|
|
4383
|
-
"name": "device",
|
|
4384
|
-
"hasDynamicHelp": false,
|
|
4385
|
-
"multiple": false,
|
|
4386
|
-
"type": "option"
|
|
4387
|
-
},
|
|
4388
|
-
"release": {
|
|
4389
|
-
"char": "r",
|
|
4390
|
-
"description": "release id",
|
|
4391
|
-
"exclusive": [
|
|
4392
|
-
"fleet",
|
|
4393
|
-
"device"
|
|
4394
|
-
],
|
|
4395
|
-
"name": "release",
|
|
4396
|
-
"hasDynamicHelp": false,
|
|
4397
|
-
"multiple": false,
|
|
4398
|
-
"type": "option"
|
|
4399
|
-
}
|
|
4400
|
-
},
|
|
4417
|
+
"flags": {},
|
|
4401
4418
|
"hasDynamicHelp": false,
|
|
4402
4419
|
"hiddenAliases": [],
|
|
4403
|
-
"id": "
|
|
4420
|
+
"id": "settings",
|
|
4404
4421
|
"pluginAlias": "balena-cli",
|
|
4405
4422
|
"pluginName": "balena-cli",
|
|
4406
4423
|
"pluginType": "core",
|
|
4407
4424
|
"strict": true,
|
|
4408
4425
|
"enableJsonFlag": false,
|
|
4409
|
-
"authenticated": true,
|
|
4410
|
-
"missingResourceMessage": "To remove a resource tag, you must provide exactly one of:\n\n * A fleet, with --fleet <fleetNameOrSlug>\n * A device, with --device <UUID>\n * A release, with --release <ID or commit>\n\nSee the help page for examples:\n\n $ balena help tag rm",
|
|
4411
4426
|
"isESM": false,
|
|
4412
4427
|
"relativePath": [
|
|
4413
4428
|
"build",
|
|
4414
4429
|
"commands",
|
|
4415
|
-
"
|
|
4416
|
-
"
|
|
4430
|
+
"settings",
|
|
4431
|
+
"index.js"
|
|
4417
4432
|
]
|
|
4418
4433
|
},
|
|
4419
|
-
"
|
|
4434
|
+
"ssh-key:add": {
|
|
4420
4435
|
"aliases": [],
|
|
4421
4436
|
"args": {
|
|
4422
|
-
"
|
|
4423
|
-
"description": "the key
|
|
4424
|
-
"name": "
|
|
4425
|
-
"required": true
|
|
4426
|
-
},
|
|
4427
|
-
"value": {
|
|
4428
|
-
"description": "the optional value associated with the tag",
|
|
4429
|
-
"name": "value",
|
|
4430
|
-
"required": false
|
|
4431
|
-
}
|
|
4432
|
-
},
|
|
4433
|
-
"description": "Set a tag on a fleet, device or release.\n\nSet a tag on a fleet, device or release.\n\nYou can optionally provide a value to be associated with the created\ntag, as an extra argument after the tag key. If a value isn't\nprovided, a tag with an empty value is created.\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).",
|
|
4434
|
-
"examples": [
|
|
4435
|
-
"$ balena tag set mySimpleTag --fleet MyFleet",
|
|
4436
|
-
"$ balena tag set mySimpleTag -f myorg/myfleet",
|
|
4437
|
-
"$ balena tag set myCompositeTag myTagValue --fleet MyFleet",
|
|
4438
|
-
"$ balena tag set myCompositeTag myTagValue --device 7cf02a6",
|
|
4439
|
-
"$ balena tag set myCompositeTag \"my tag value with whitespaces\" --device 7cf02a6",
|
|
4440
|
-
"$ balena tag set myCompositeTag myTagValue --release 1234",
|
|
4441
|
-
"$ balena tag set myCompositeTag --release 1234",
|
|
4442
|
-
"$ balena tag set myCompositeTag --release b376b0e544e9429483b656490e5b9443b4349bd6"
|
|
4443
|
-
],
|
|
4444
|
-
"flags": {
|
|
4445
|
-
"fleet": {
|
|
4446
|
-
"char": "f",
|
|
4447
|
-
"description": "fleet name or slug (preferred)",
|
|
4448
|
-
"exclusive": [
|
|
4449
|
-
"device",
|
|
4450
|
-
"release"
|
|
4451
|
-
],
|
|
4452
|
-
"name": "fleet",
|
|
4453
|
-
"hasDynamicHelp": false,
|
|
4454
|
-
"multiple": false,
|
|
4455
|
-
"type": "option"
|
|
4456
|
-
},
|
|
4457
|
-
"device": {
|
|
4458
|
-
"char": "d",
|
|
4459
|
-
"description": "device UUID",
|
|
4460
|
-
"exclusive": [
|
|
4461
|
-
"fleet",
|
|
4462
|
-
"release"
|
|
4463
|
-
],
|
|
4464
|
-
"name": "device",
|
|
4465
|
-
"hasDynamicHelp": false,
|
|
4466
|
-
"multiple": false,
|
|
4467
|
-
"type": "option"
|
|
4437
|
+
"name": {
|
|
4438
|
+
"description": "the SSH key name",
|
|
4439
|
+
"name": "name",
|
|
4440
|
+
"required": true
|
|
4468
4441
|
},
|
|
4469
|
-
"
|
|
4470
|
-
"
|
|
4471
|
-
"
|
|
4472
|
-
"
|
|
4473
|
-
"fleet",
|
|
4474
|
-
"device"
|
|
4475
|
-
],
|
|
4476
|
-
"name": "release",
|
|
4477
|
-
"hasDynamicHelp": false,
|
|
4478
|
-
"multiple": false,
|
|
4479
|
-
"type": "option"
|
|
4442
|
+
"path": {
|
|
4443
|
+
"description": "the path to the public key file",
|
|
4444
|
+
"name": "path",
|
|
4445
|
+
"required": true
|
|
4480
4446
|
}
|
|
4481
4447
|
},
|
|
4448
|
+
"description": "Add an SSH key to balenaCloud.\n\nAdd an SSH key to the balenaCloud account of the logged in user.\n\nIf `path` is omitted, the command will attempt to read the SSH key from stdin.\n\nAbout SSH keys\nAn \"SSH key\" actually consists of a public/private key pair. A typical name\nfor the private key file is \"id_rsa\", and a typical name for the public key\nfile is \"id_rsa.pub\". Both key files are saved to your computer (with the\nprivate key optionally protected by a password), but only the public key is\nsaved to your balena account. This means that if you change computers or\notherwise lose the private key, you cannot recover the private key through\nyour balena account. You can however add new keys, and delete the old ones.\n\nTo generate a new SSH key pair, a nice guide can be found in GitHub's docs:\nhttps://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent\nSkip the step about adding the key to a GitHub account, and instead add it to\nyour balena account.",
|
|
4449
|
+
"examples": [
|
|
4450
|
+
"$ balena ssh-key add Main ~/.ssh/id_rsa.pub",
|
|
4451
|
+
"$ cat ~/.ssh/id_rsa.pub | balena ssh-key add Main",
|
|
4452
|
+
"# Windows 10 (cmd.exe prompt) example",
|
|
4453
|
+
"$ balena ssh-key add Main %userprofile%.sshid_rsa.pub"
|
|
4454
|
+
],
|
|
4455
|
+
"flags": {},
|
|
4482
4456
|
"hasDynamicHelp": false,
|
|
4483
4457
|
"hiddenAliases": [],
|
|
4484
|
-
"id": "
|
|
4458
|
+
"id": "ssh-key:add",
|
|
4485
4459
|
"pluginAlias": "balena-cli",
|
|
4486
4460
|
"pluginName": "balena-cli",
|
|
4487
4461
|
"pluginType": "core",
|
|
4488
|
-
"strict":
|
|
4462
|
+
"strict": true,
|
|
4489
4463
|
"enableJsonFlag": false,
|
|
4490
4464
|
"authenticated": true,
|
|
4491
|
-
"missingResourceMessage": "To set a resource tag, you must provide exactly one of:\n\n * A fleet, with --fleet <fleetNameOrSlug>\n * A device, with --device <UUID>\n * A release, with --release <ID or commit>\n\nSee the help page for examples:\n\n $ balena help tag set",
|
|
4492
4465
|
"isESM": false,
|
|
4493
4466
|
"relativePath": [
|
|
4494
4467
|
"build",
|
|
4495
4468
|
"commands",
|
|
4496
|
-
"
|
|
4497
|
-
"
|
|
4469
|
+
"ssh-key",
|
|
4470
|
+
"add.js"
|
|
4498
4471
|
]
|
|
4499
4472
|
},
|
|
4500
|
-
"
|
|
4473
|
+
"ssh-key": {
|
|
4501
4474
|
"aliases": [],
|
|
4502
|
-
"args": {
|
|
4503
|
-
|
|
4475
|
+
"args": {
|
|
4476
|
+
"id": {
|
|
4477
|
+
"description": "balenaCloud ID for the SSH key",
|
|
4478
|
+
"name": "id",
|
|
4479
|
+
"required": true
|
|
4480
|
+
}
|
|
4481
|
+
},
|
|
4482
|
+
"description": "Display an SSH key.\n\nDisplay a single SSH key registered in balenaCloud for the logged in user.",
|
|
4483
|
+
"examples": [
|
|
4484
|
+
"$ balena ssh-key 17"
|
|
4485
|
+
],
|
|
4504
4486
|
"flags": {},
|
|
4505
4487
|
"hasDynamicHelp": false,
|
|
4506
4488
|
"hiddenAliases": [],
|
|
4507
|
-
"id": "
|
|
4489
|
+
"id": "ssh-key",
|
|
4508
4490
|
"pluginAlias": "balena-cli",
|
|
4509
4491
|
"pluginName": "balena-cli",
|
|
4510
4492
|
"pluginType": "core",
|
|
4511
4493
|
"strict": true,
|
|
4512
4494
|
"enableJsonFlag": false,
|
|
4513
|
-
"
|
|
4495
|
+
"authenticated": true,
|
|
4514
4496
|
"isESM": false,
|
|
4515
4497
|
"relativePath": [
|
|
4516
4498
|
"build",
|
|
4517
4499
|
"commands",
|
|
4518
|
-
"
|
|
4519
|
-
"
|
|
4500
|
+
"ssh-key",
|
|
4501
|
+
"index.js"
|
|
4520
4502
|
]
|
|
4521
4503
|
},
|
|
4522
|
-
"
|
|
4504
|
+
"ssh-key:list": {
|
|
4523
4505
|
"aliases": [],
|
|
4524
4506
|
"args": {},
|
|
4525
|
-
"description": "
|
|
4507
|
+
"description": "List the SSH keys in balenaCloud.\n\nList all SSH keys registered in balenaCloud for the logged in user.",
|
|
4526
4508
|
"examples": [
|
|
4527
|
-
"$ balena
|
|
4509
|
+
"$ balena ssh-key list"
|
|
4528
4510
|
],
|
|
4529
4511
|
"flags": {},
|
|
4530
4512
|
"hasDynamicHelp": false,
|
|
4531
4513
|
"hiddenAliases": [],
|
|
4532
|
-
"id": "
|
|
4514
|
+
"id": "ssh-key:list",
|
|
4533
4515
|
"pluginAlias": "balena-cli",
|
|
4534
4516
|
"pluginName": "balena-cli",
|
|
4535
4517
|
"pluginType": "core",
|
|
@@ -4540,179 +4522,163 @@
|
|
|
4540
4522
|
"relativePath": [
|
|
4541
4523
|
"build",
|
|
4542
4524
|
"commands",
|
|
4543
|
-
"
|
|
4544
|
-
"
|
|
4525
|
+
"ssh-key",
|
|
4526
|
+
"list.js"
|
|
4545
4527
|
]
|
|
4546
4528
|
},
|
|
4547
|
-
"
|
|
4529
|
+
"ssh-key:rm": {
|
|
4548
4530
|
"aliases": [],
|
|
4549
4531
|
"args": {
|
|
4550
|
-
"
|
|
4551
|
-
"description": "
|
|
4552
|
-
"name": "
|
|
4532
|
+
"id": {
|
|
4533
|
+
"description": "balenaCloud ID for the SSH key",
|
|
4534
|
+
"name": "id",
|
|
4553
4535
|
"required": true
|
|
4554
4536
|
}
|
|
4555
4537
|
},
|
|
4556
|
-
"description": "
|
|
4538
|
+
"description": "Remove an SSH key from balenaCloud.\n\nRemove a single SSH key registered in balenaCloud for the logged in user.\n\nThe --yes option may be used to avoid interactive confirmation.",
|
|
4557
4539
|
"examples": [
|
|
4558
|
-
"$ balena
|
|
4559
|
-
"$ balena
|
|
4560
|
-
|
|
4561
|
-
|
|
4540
|
+
"$ balena ssh-key rm 17",
|
|
4541
|
+
"$ balena ssh-key rm 17 --yes"
|
|
4542
|
+
],
|
|
4543
|
+
"flags": {
|
|
4544
|
+
"yes": {
|
|
4545
|
+
"char": "y",
|
|
4546
|
+
"description": "answer \"yes\" to all questions (non interactive use)",
|
|
4547
|
+
"name": "yes",
|
|
4548
|
+
"allowNo": false,
|
|
4549
|
+
"type": "boolean"
|
|
4550
|
+
}
|
|
4551
|
+
},
|
|
4552
|
+
"hasDynamicHelp": false,
|
|
4553
|
+
"hiddenAliases": [],
|
|
4554
|
+
"id": "ssh-key:rm",
|
|
4555
|
+
"pluginAlias": "balena-cli",
|
|
4556
|
+
"pluginName": "balena-cli",
|
|
4557
|
+
"pluginType": "core",
|
|
4558
|
+
"strict": true,
|
|
4559
|
+
"enableJsonFlag": false,
|
|
4560
|
+
"authenticated": true,
|
|
4561
|
+
"isESM": false,
|
|
4562
|
+
"relativePath": [
|
|
4563
|
+
"build",
|
|
4564
|
+
"commands",
|
|
4565
|
+
"ssh-key",
|
|
4566
|
+
"rm.js"
|
|
4567
|
+
]
|
|
4568
|
+
},
|
|
4569
|
+
"support": {
|
|
4570
|
+
"aliases": [],
|
|
4571
|
+
"args": {
|
|
4572
|
+
"action": {
|
|
4573
|
+
"description": "enable|disable support access",
|
|
4574
|
+
"name": "action",
|
|
4575
|
+
"options": [
|
|
4576
|
+
"enable",
|
|
4577
|
+
"disable"
|
|
4578
|
+
]
|
|
4579
|
+
}
|
|
4580
|
+
},
|
|
4581
|
+
"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).",
|
|
4582
|
+
"examples": [
|
|
4583
|
+
"balena support enable --device ab346f,cd457a --duration 3d",
|
|
4584
|
+
"balena support enable --fleet myFleet --duration 12h",
|
|
4585
|
+
"balena support disable -f myorg/myfleet"
|
|
4562
4586
|
],
|
|
4563
4587
|
"flags": {
|
|
4564
|
-
"fleet": {
|
|
4565
|
-
"char": "f",
|
|
4566
|
-
"description": "fleet name or slug (preferred)",
|
|
4567
|
-
"exclusive": [
|
|
4568
|
-
"device",
|
|
4569
|
-
"config"
|
|
4570
|
-
],
|
|
4571
|
-
"name": "fleet",
|
|
4572
|
-
"hasDynamicHelp": false,
|
|
4573
|
-
"multiple": false,
|
|
4574
|
-
"type": "option"
|
|
4575
|
-
},
|
|
4576
4588
|
"device": {
|
|
4577
4589
|
"char": "d",
|
|
4578
|
-
"description": "device
|
|
4579
|
-
"exclusive": [
|
|
4580
|
-
"fleet",
|
|
4581
|
-
"device-type",
|
|
4582
|
-
"config",
|
|
4583
|
-
"provisioning-key-name",
|
|
4584
|
-
"provisioning-key-expiry-date"
|
|
4585
|
-
],
|
|
4590
|
+
"description": "comma-separated list (no spaces) of device UUIDs",
|
|
4586
4591
|
"name": "device",
|
|
4587
4592
|
"hasDynamicHelp": false,
|
|
4588
4593
|
"multiple": false,
|
|
4589
4594
|
"type": "option"
|
|
4590
4595
|
},
|
|
4591
|
-
"
|
|
4592
|
-
"
|
|
4593
|
-
"
|
|
4594
|
-
|
|
4595
|
-
"device",
|
|
4596
|
-
"advanced",
|
|
4597
|
-
"config-app-update-poll-interval",
|
|
4598
|
-
"config-network",
|
|
4599
|
-
"config-wifi-key",
|
|
4600
|
-
"config-wifi-ssid",
|
|
4601
|
-
"dev",
|
|
4602
|
-
"secureBoot",
|
|
4603
|
-
"device-type",
|
|
4604
|
-
"initial-device-name",
|
|
4605
|
-
"provisioning-key-name",
|
|
4606
|
-
"provisioning-key-expiry-date"
|
|
4607
|
-
],
|
|
4608
|
-
"name": "config",
|
|
4609
|
-
"hasDynamicHelp": false,
|
|
4610
|
-
"multiple": false,
|
|
4611
|
-
"type": "option"
|
|
4612
|
-
},
|
|
4613
|
-
"advanced": {
|
|
4614
|
-
"char": "v",
|
|
4615
|
-
"description": "ask advanced configuration questions (when in interactive mode)",
|
|
4616
|
-
"name": "advanced",
|
|
4617
|
-
"allowNo": false,
|
|
4618
|
-
"type": "boolean"
|
|
4619
|
-
},
|
|
4620
|
-
"config-app-update-poll-interval": {
|
|
4621
|
-
"description": "supervisor cloud polling interval in minutes (e.g. for variable updates)",
|
|
4622
|
-
"name": "config-app-update-poll-interval",
|
|
4623
|
-
"hasDynamicHelp": false,
|
|
4624
|
-
"multiple": false,
|
|
4625
|
-
"type": "option"
|
|
4626
|
-
},
|
|
4627
|
-
"config-network": {
|
|
4628
|
-
"description": "device network type (non-interactive configuration)",
|
|
4629
|
-
"name": "config-network",
|
|
4630
|
-
"hasDynamicHelp": false,
|
|
4631
|
-
"multiple": false,
|
|
4632
|
-
"options": [
|
|
4633
|
-
"ethernet",
|
|
4634
|
-
"wifi"
|
|
4635
|
-
],
|
|
4636
|
-
"type": "option"
|
|
4637
|
-
},
|
|
4638
|
-
"config-wifi-key": {
|
|
4639
|
-
"description": "WiFi key (password) (non-interactive configuration)",
|
|
4640
|
-
"name": "config-wifi-key",
|
|
4596
|
+
"fleet": {
|
|
4597
|
+
"char": "f",
|
|
4598
|
+
"description": "comma-separated list (no spaces) of fleet names or slugs (preferred)",
|
|
4599
|
+
"name": "fleet",
|
|
4641
4600
|
"hasDynamicHelp": false,
|
|
4642
4601
|
"multiple": false,
|
|
4643
4602
|
"type": "option"
|
|
4644
4603
|
},
|
|
4645
|
-
"
|
|
4646
|
-
"
|
|
4647
|
-
"
|
|
4604
|
+
"duration": {
|
|
4605
|
+
"char": "t",
|
|
4606
|
+
"description": "length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d",
|
|
4607
|
+
"name": "duration",
|
|
4648
4608
|
"hasDynamicHelp": false,
|
|
4649
4609
|
"multiple": false,
|
|
4650
4610
|
"type": "option"
|
|
4651
|
-
}
|
|
4652
|
-
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4658
|
-
|
|
4659
|
-
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
|
|
4664
|
-
"
|
|
4665
|
-
|
|
4666
|
-
|
|
4611
|
+
}
|
|
4612
|
+
},
|
|
4613
|
+
"hasDynamicHelp": false,
|
|
4614
|
+
"hiddenAliases": [],
|
|
4615
|
+
"id": "support",
|
|
4616
|
+
"pluginAlias": "balena-cli",
|
|
4617
|
+
"pluginName": "balena-cli",
|
|
4618
|
+
"pluginType": "core",
|
|
4619
|
+
"strict": true,
|
|
4620
|
+
"enableJsonFlag": false,
|
|
4621
|
+
"authenticated": true,
|
|
4622
|
+
"isESM": false,
|
|
4623
|
+
"relativePath": [
|
|
4624
|
+
"build",
|
|
4625
|
+
"commands",
|
|
4626
|
+
"support",
|
|
4627
|
+
"index.js"
|
|
4628
|
+
]
|
|
4629
|
+
},
|
|
4630
|
+
"tag:list": {
|
|
4631
|
+
"aliases": [],
|
|
4632
|
+
"args": {},
|
|
4633
|
+
"description": "List all tags for a fleet, device or release.\n\nList all tags and their values for the specified fleet, device or release.\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).",
|
|
4634
|
+
"examples": [
|
|
4635
|
+
"$ balena tag list --fleet MyFleet",
|
|
4636
|
+
"$ balena tag list -f myorg/myfleet",
|
|
4637
|
+
"$ balena tag list --device 7cf02a6",
|
|
4638
|
+
"$ balena tag list --release 1234",
|
|
4639
|
+
"$ balena tag list --release b376b0e544e9429483b656490e5b9443b4349bd6"
|
|
4640
|
+
],
|
|
4641
|
+
"flags": {
|
|
4642
|
+
"fleet": {
|
|
4643
|
+
"char": "f",
|
|
4644
|
+
"description": "fleet name or slug (preferred)",
|
|
4645
|
+
"exclusive": [
|
|
4646
|
+
"device",
|
|
4647
|
+
"release"
|
|
4667
4648
|
],
|
|
4668
|
-
"
|
|
4669
|
-
"name": "device-type",
|
|
4670
|
-
"hasDynamicHelp": false,
|
|
4671
|
-
"multiple": false,
|
|
4672
|
-
"type": "option"
|
|
4673
|
-
},
|
|
4674
|
-
"initial-device-name": {
|
|
4675
|
-
"description": "This option will set the device name when the device provisions",
|
|
4676
|
-
"name": "initial-device-name",
|
|
4649
|
+
"name": "fleet",
|
|
4677
4650
|
"hasDynamicHelp": false,
|
|
4678
4651
|
"multiple": false,
|
|
4679
4652
|
"type": "option"
|
|
4680
4653
|
},
|
|
4681
|
-
"
|
|
4682
|
-
"
|
|
4654
|
+
"device": {
|
|
4655
|
+
"char": "d",
|
|
4656
|
+
"description": "device UUID",
|
|
4683
4657
|
"exclusive": [
|
|
4684
|
-
"
|
|
4685
|
-
"
|
|
4658
|
+
"fleet",
|
|
4659
|
+
"release"
|
|
4686
4660
|
],
|
|
4687
|
-
"name": "
|
|
4661
|
+
"name": "device",
|
|
4688
4662
|
"hasDynamicHelp": false,
|
|
4689
4663
|
"multiple": false,
|
|
4690
4664
|
"type": "option"
|
|
4691
4665
|
},
|
|
4692
|
-
"
|
|
4693
|
-
"
|
|
4666
|
+
"release": {
|
|
4667
|
+
"char": "r",
|
|
4668
|
+
"description": "release id",
|
|
4694
4669
|
"exclusive": [
|
|
4695
|
-
"
|
|
4670
|
+
"fleet",
|
|
4696
4671
|
"device"
|
|
4697
4672
|
],
|
|
4698
|
-
"name": "
|
|
4673
|
+
"name": "release",
|
|
4699
4674
|
"hasDynamicHelp": false,
|
|
4700
4675
|
"multiple": false,
|
|
4701
4676
|
"type": "option"
|
|
4702
|
-
},
|
|
4703
|
-
"system-connection": {
|
|
4704
|
-
"char": "c",
|
|
4705
|
-
"description": "paths to local files to place into the 'system-connections' directory",
|
|
4706
|
-
"name": "system-connection",
|
|
4707
|
-
"required": false,
|
|
4708
|
-
"hasDynamicHelp": false,
|
|
4709
|
-
"multiple": true,
|
|
4710
|
-
"type": "option"
|
|
4711
4677
|
}
|
|
4712
4678
|
},
|
|
4713
4679
|
"hasDynamicHelp": false,
|
|
4714
4680
|
"hiddenAliases": [],
|
|
4715
|
-
"id": "
|
|
4681
|
+
"id": "tag:list",
|
|
4716
4682
|
"pluginAlias": "balena-cli",
|
|
4717
4683
|
"pluginName": "balena-cli",
|
|
4718
4684
|
"pluginType": "core",
|
|
@@ -4723,177 +4689,211 @@
|
|
|
4723
4689
|
"relativePath": [
|
|
4724
4690
|
"build",
|
|
4725
4691
|
"commands",
|
|
4726
|
-
"
|
|
4727
|
-
"
|
|
4692
|
+
"tag",
|
|
4693
|
+
"list.js"
|
|
4728
4694
|
]
|
|
4729
4695
|
},
|
|
4730
|
-
"
|
|
4696
|
+
"tag:rm": {
|
|
4731
4697
|
"aliases": [],
|
|
4732
4698
|
"args": {
|
|
4733
|
-
"
|
|
4734
|
-
"description": "the
|
|
4735
|
-
"name": "
|
|
4699
|
+
"tagKey": {
|
|
4700
|
+
"description": "the key string of the tag",
|
|
4701
|
+
"name": "tagKey",
|
|
4736
4702
|
"required": true
|
|
4737
4703
|
}
|
|
4738
4704
|
},
|
|
4739
|
-
"description": "
|
|
4705
|
+
"description": "Remove a tag from a fleet, device or release.\n\nRemove a tag from a fleet, device or release.\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).",
|
|
4740
4706
|
"examples": [
|
|
4741
|
-
"$ balena
|
|
4742
|
-
"$ balena
|
|
4743
|
-
"$ balena
|
|
4744
|
-
"$ balena
|
|
4745
|
-
"$ balena
|
|
4746
|
-
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2.60.1+rev1.dev",
|
|
4747
|
-
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version 2021.10.2.prod",
|
|
4748
|
-
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version latest",
|
|
4749
|
-
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version menu",
|
|
4750
|
-
"$ balena os download raspberrypi3 -o ../foo/bar/raspberrypi3.img --version menu-esr",
|
|
4751
|
-
"$ balena os download generic-amd64 -o ../foo/bar/generic-amd64.img --type installation-media"
|
|
4707
|
+
"$ balena tag rm myTagKey --fleet MyFleet",
|
|
4708
|
+
"$ balena tag rm myTagKey -f myorg/myfleet",
|
|
4709
|
+
"$ balena tag rm myTagKey --device 7cf02a6",
|
|
4710
|
+
"$ balena tag rm myTagKey --release 1234",
|
|
4711
|
+
"$ balena tag rm myTagKey --release b376b0e544e9429483b656490e5b9443b4349bd6"
|
|
4752
4712
|
],
|
|
4753
4713
|
"flags": {
|
|
4754
|
-
"
|
|
4755
|
-
"char": "
|
|
4756
|
-
"description": "
|
|
4757
|
-
"
|
|
4758
|
-
|
|
4714
|
+
"fleet": {
|
|
4715
|
+
"char": "f",
|
|
4716
|
+
"description": "fleet name or slug (preferred)",
|
|
4717
|
+
"exclusive": [
|
|
4718
|
+
"device",
|
|
4719
|
+
"release"
|
|
4720
|
+
],
|
|
4721
|
+
"name": "fleet",
|
|
4759
4722
|
"hasDynamicHelp": false,
|
|
4760
4723
|
"multiple": false,
|
|
4761
4724
|
"type": "option"
|
|
4762
4725
|
},
|
|
4763
|
-
"
|
|
4764
|
-
"
|
|
4765
|
-
"
|
|
4726
|
+
"device": {
|
|
4727
|
+
"char": "d",
|
|
4728
|
+
"description": "device UUID",
|
|
4729
|
+
"exclusive": [
|
|
4730
|
+
"fleet",
|
|
4731
|
+
"release"
|
|
4732
|
+
],
|
|
4733
|
+
"name": "device",
|
|
4766
4734
|
"hasDynamicHelp": false,
|
|
4767
4735
|
"multiple": false,
|
|
4768
4736
|
"type": "option"
|
|
4769
4737
|
},
|
|
4770
|
-
"
|
|
4771
|
-
"
|
|
4772
|
-
"
|
|
4738
|
+
"release": {
|
|
4739
|
+
"char": "r",
|
|
4740
|
+
"description": "release id",
|
|
4741
|
+
"exclusive": [
|
|
4742
|
+
"fleet",
|
|
4743
|
+
"device"
|
|
4744
|
+
],
|
|
4745
|
+
"name": "release",
|
|
4773
4746
|
"hasDynamicHelp": false,
|
|
4774
4747
|
"multiple": false,
|
|
4775
|
-
"options": [
|
|
4776
|
-
"installation-media",
|
|
4777
|
-
"disk-image"
|
|
4778
|
-
],
|
|
4779
4748
|
"type": "option"
|
|
4780
4749
|
}
|
|
4781
4750
|
},
|
|
4782
4751
|
"hasDynamicHelp": false,
|
|
4783
4752
|
"hiddenAliases": [],
|
|
4784
|
-
"id": "
|
|
4753
|
+
"id": "tag:rm",
|
|
4785
4754
|
"pluginAlias": "balena-cli",
|
|
4786
4755
|
"pluginName": "balena-cli",
|
|
4787
4756
|
"pluginType": "core",
|
|
4788
4757
|
"strict": true,
|
|
4789
4758
|
"enableJsonFlag": false,
|
|
4759
|
+
"authenticated": true,
|
|
4760
|
+
"missingResourceMessage": "To remove a resource tag, you must provide exactly one of:\n\n * A fleet, with --fleet <fleetNameOrSlug>\n * A device, with --device <UUID>\n * A release, with --release <ID or commit>\n\nSee the help page for examples:\n\n $ balena help tag rm",
|
|
4790
4761
|
"isESM": false,
|
|
4791
4762
|
"relativePath": [
|
|
4792
4763
|
"build",
|
|
4793
4764
|
"commands",
|
|
4794
|
-
"
|
|
4795
|
-
"
|
|
4765
|
+
"tag",
|
|
4766
|
+
"rm.js"
|
|
4796
4767
|
]
|
|
4797
4768
|
},
|
|
4798
|
-
"
|
|
4769
|
+
"tag:set": {
|
|
4799
4770
|
"aliases": [],
|
|
4800
4771
|
"args": {
|
|
4801
|
-
"
|
|
4802
|
-
"description": "
|
|
4803
|
-
"name": "
|
|
4772
|
+
"tagKey": {
|
|
4773
|
+
"description": "the key string of the tag",
|
|
4774
|
+
"name": "tagKey",
|
|
4804
4775
|
"required": true
|
|
4776
|
+
},
|
|
4777
|
+
"value": {
|
|
4778
|
+
"description": "the optional value associated with the tag",
|
|
4779
|
+
"name": "value",
|
|
4780
|
+
"required": false
|
|
4805
4781
|
}
|
|
4806
4782
|
},
|
|
4807
|
-
"description": "
|
|
4783
|
+
"description": "Set a tag on a fleet, device or release.\n\nSet a tag on a fleet, device or release.\n\nYou can optionally provide a value to be associated with the created\ntag, as an extra argument after the tag key. If a value isn't\nprovided, a tag with an empty value is created.\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).",
|
|
4808
4784
|
"examples": [
|
|
4809
|
-
"$ balena
|
|
4785
|
+
"$ balena tag set mySimpleTag --fleet MyFleet",
|
|
4786
|
+
"$ balena tag set mySimpleTag -f myorg/myfleet",
|
|
4787
|
+
"$ balena tag set myCompositeTag myTagValue --fleet MyFleet",
|
|
4788
|
+
"$ balena tag set myCompositeTag myTagValue --device 7cf02a6",
|
|
4789
|
+
"$ balena tag set myCompositeTag \"my tag value with whitespaces\" --device 7cf02a6",
|
|
4790
|
+
"$ balena tag set myCompositeTag myTagValue --release 1234",
|
|
4791
|
+
"$ balena tag set myCompositeTag --release 1234",
|
|
4792
|
+
"$ balena tag set myCompositeTag --release b376b0e544e9429483b656490e5b9443b4349bd6"
|
|
4810
4793
|
],
|
|
4811
4794
|
"flags": {
|
|
4812
|
-
"
|
|
4813
|
-
"char": "
|
|
4814
|
-
"description": "
|
|
4815
|
-
"
|
|
4816
|
-
|
|
4795
|
+
"fleet": {
|
|
4796
|
+
"char": "f",
|
|
4797
|
+
"description": "fleet name or slug (preferred)",
|
|
4798
|
+
"exclusive": [
|
|
4799
|
+
"device",
|
|
4800
|
+
"release"
|
|
4801
|
+
],
|
|
4802
|
+
"name": "fleet",
|
|
4817
4803
|
"hasDynamicHelp": false,
|
|
4818
4804
|
"multiple": false,
|
|
4819
4805
|
"type": "option"
|
|
4820
4806
|
},
|
|
4821
|
-
"
|
|
4807
|
+
"device": {
|
|
4822
4808
|
"char": "d",
|
|
4823
|
-
"description": "
|
|
4824
|
-
"
|
|
4809
|
+
"description": "device UUID",
|
|
4810
|
+
"exclusive": [
|
|
4811
|
+
"fleet",
|
|
4812
|
+
"release"
|
|
4813
|
+
],
|
|
4814
|
+
"name": "device",
|
|
4825
4815
|
"hasDynamicHelp": false,
|
|
4826
4816
|
"multiple": false,
|
|
4827
4817
|
"type": "option"
|
|
4828
4818
|
},
|
|
4829
|
-
"
|
|
4830
|
-
"char": "
|
|
4831
|
-
"description": "
|
|
4832
|
-
"
|
|
4833
|
-
|
|
4834
|
-
|
|
4819
|
+
"release": {
|
|
4820
|
+
"char": "r",
|
|
4821
|
+
"description": "release id",
|
|
4822
|
+
"exclusive": [
|
|
4823
|
+
"fleet",
|
|
4824
|
+
"device"
|
|
4825
|
+
],
|
|
4826
|
+
"name": "release",
|
|
4827
|
+
"hasDynamicHelp": false,
|
|
4828
|
+
"multiple": false,
|
|
4829
|
+
"type": "option"
|
|
4835
4830
|
}
|
|
4836
4831
|
},
|
|
4837
4832
|
"hasDynamicHelp": false,
|
|
4838
4833
|
"hiddenAliases": [],
|
|
4839
|
-
"id": "
|
|
4834
|
+
"id": "tag:set",
|
|
4840
4835
|
"pluginAlias": "balena-cli",
|
|
4841
4836
|
"pluginName": "balena-cli",
|
|
4842
4837
|
"pluginType": "core",
|
|
4843
|
-
"strict":
|
|
4838
|
+
"strict": false,
|
|
4844
4839
|
"enableJsonFlag": false,
|
|
4845
4840
|
"authenticated": true,
|
|
4841
|
+
"missingResourceMessage": "To set a resource tag, you must provide exactly one of:\n\n * A fleet, with --fleet <fleetNameOrSlug>\n * A device, with --device <UUID>\n * A release, with --release <ID or commit>\n\nSee the help page for examples:\n\n $ balena help tag set",
|
|
4846
4842
|
"isESM": false,
|
|
4847
4843
|
"relativePath": [
|
|
4848
4844
|
"build",
|
|
4849
4845
|
"commands",
|
|
4850
|
-
"
|
|
4851
|
-
"
|
|
4846
|
+
"tag",
|
|
4847
|
+
"set.js"
|
|
4852
4848
|
]
|
|
4853
4849
|
},
|
|
4854
|
-
"
|
|
4850
|
+
"util:available-drives": {
|
|
4855
4851
|
"aliases": [],
|
|
4856
|
-
"args": {
|
|
4857
|
-
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
"
|
|
4852
|
+
"args": {},
|
|
4853
|
+
"description": "List available drives.\n\nList available drives which are usable for writing an OS image to.\nDoes not list system drives.",
|
|
4854
|
+
"flags": {},
|
|
4855
|
+
"hasDynamicHelp": false,
|
|
4856
|
+
"hiddenAliases": [],
|
|
4857
|
+
"id": "util:available-drives",
|
|
4858
|
+
"pluginAlias": "balena-cli",
|
|
4859
|
+
"pluginName": "balena-cli",
|
|
4860
|
+
"pluginType": "core",
|
|
4861
|
+
"strict": true,
|
|
4862
|
+
"enableJsonFlag": false,
|
|
4863
|
+
"offlineCompatible": true,
|
|
4864
|
+
"isESM": false,
|
|
4865
|
+
"relativePath": [
|
|
4866
|
+
"build",
|
|
4867
|
+
"commands",
|
|
4868
|
+
"util",
|
|
4869
|
+
"available-drives.js"
|
|
4870
|
+
]
|
|
4871
|
+
},
|
|
4872
|
+
"whoami": {
|
|
4873
|
+
"aliases": [],
|
|
4874
|
+
"args": {},
|
|
4875
|
+
"description": "Display account information for current user.\n\nGet the username and email address of the currently logged in user.",
|
|
4864
4876
|
"examples": [
|
|
4865
|
-
"$ balena
|
|
4877
|
+
"$ balena whoami"
|
|
4866
4878
|
],
|
|
4867
|
-
"flags": {
|
|
4868
|
-
"esr": {
|
|
4869
|
-
"description": "select balenaOS ESR versions",
|
|
4870
|
-
"name": "esr",
|
|
4871
|
-
"allowNo": false,
|
|
4872
|
-
"type": "boolean"
|
|
4873
|
-
},
|
|
4874
|
-
"include-draft": {
|
|
4875
|
-
"description": "include pre-release balenaOS versions",
|
|
4876
|
-
"name": "include-draft",
|
|
4877
|
-
"allowNo": false,
|
|
4878
|
-
"type": "boolean"
|
|
4879
|
-
}
|
|
4880
|
-
},
|
|
4879
|
+
"flags": {},
|
|
4881
4880
|
"hasDynamicHelp": false,
|
|
4882
4881
|
"hiddenAliases": [],
|
|
4883
|
-
"id": "
|
|
4882
|
+
"id": "whoami",
|
|
4884
4883
|
"pluginAlias": "balena-cli",
|
|
4885
4884
|
"pluginName": "balena-cli",
|
|
4886
4885
|
"pluginType": "core",
|
|
4887
4886
|
"strict": true,
|
|
4888
4887
|
"enableJsonFlag": false,
|
|
4888
|
+
"authenticated": true,
|
|
4889
4889
|
"isESM": false,
|
|
4890
4890
|
"relativePath": [
|
|
4891
4891
|
"build",
|
|
4892
4892
|
"commands",
|
|
4893
|
-
"
|
|
4894
|
-
"
|
|
4893
|
+
"whoami",
|
|
4894
|
+
"index.js"
|
|
4895
4895
|
]
|
|
4896
4896
|
}
|
|
4897
4897
|
},
|
|
4898
|
-
"version": "25.1.
|
|
4898
|
+
"version": "25.1.4"
|
|
4899
4899
|
}
|