balena-cli 22.2.0 → 22.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -1
- package/npm-shrinkwrap.json +12 -11
- package/oclif.manifest.json +445 -445
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -4,7 +4,11 @@ All notable changes to this project will be documented in this file
|
|
|
4
4
|
automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
|
|
5
5
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
|
6
6
|
|
|
7
|
-
## 22.2.
|
|
7
|
+
## 22.2.1 - 2025-08-06
|
|
8
|
+
|
|
9
|
+
* Fix finalize step oclif promote command [Otavio Jacobi]
|
|
10
|
+
|
|
11
|
+
## 22.2.0 - 2025-08-05
|
|
8
12
|
|
|
9
13
|
* Upload built assets to s3 as standard oclif packages [Otavio Jacobi]
|
|
10
14
|
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "balena-cli",
|
|
3
|
-
"version": "22.2.
|
|
3
|
+
"version": "22.2.1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "balena-cli",
|
|
9
|
-
"version": "22.2.
|
|
9
|
+
"version": "22.2.1",
|
|
10
10
|
"hasInstallScript": true,
|
|
11
11
|
"license": "Apache-2.0",
|
|
12
12
|
"dependencies": {
|
|
@@ -15883,9 +15883,9 @@
|
|
|
15883
15883
|
"integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow=="
|
|
15884
15884
|
},
|
|
15885
15885
|
"node_modules/fs-extra": {
|
|
15886
|
-
"version": "11.3.
|
|
15887
|
-
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.
|
|
15888
|
-
"integrity": "sha512-
|
|
15886
|
+
"version": "11.3.1",
|
|
15887
|
+
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz",
|
|
15888
|
+
"integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==",
|
|
15889
15889
|
"dev": true,
|
|
15890
15890
|
"license": "MIT",
|
|
15891
15891
|
"dependencies": {
|
|
@@ -20427,9 +20427,9 @@
|
|
|
20427
20427
|
}
|
|
20428
20428
|
},
|
|
20429
20429
|
"node_modules/patch-package/node_modules/yaml": {
|
|
20430
|
-
"version": "2.8.
|
|
20431
|
-
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.
|
|
20432
|
-
"integrity": "sha512-
|
|
20430
|
+
"version": "2.8.1",
|
|
20431
|
+
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.1.tgz",
|
|
20432
|
+
"integrity": "sha512-lcYcMxX2PO9XMGvAJkJ3OsNMw+/7FKes7/hgerGUYWIoWu5j/+YQqcZr5JnPZWzOsEBgMbSbiSTn/dv/69Mkpw==",
|
|
20433
20433
|
"license": "ISC",
|
|
20434
20434
|
"bin": {
|
|
20435
20435
|
"yaml": "bin.mjs"
|
|
@@ -23122,9 +23122,10 @@
|
|
|
23122
23122
|
}
|
|
23123
23123
|
},
|
|
23124
23124
|
"node_modules/tmp": {
|
|
23125
|
-
"version": "0.2.
|
|
23126
|
-
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.
|
|
23127
|
-
"integrity": "sha512-
|
|
23125
|
+
"version": "0.2.4",
|
|
23126
|
+
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.4.tgz",
|
|
23127
|
+
"integrity": "sha512-UdiSoX6ypifLmrfQ/XfiawN6hkjSBpCjhKxxZcWlUUmoXLaCKQU0bx4HF/tdDK2uzRuchf1txGvrWBzYREssoQ==",
|
|
23128
|
+
"license": "MIT",
|
|
23128
23129
|
"engines": {
|
|
23129
23130
|
"node": ">=14.14"
|
|
23130
23131
|
}
|
package/oclif.manifest.json
CHANGED
|
@@ -163,34 +163,186 @@
|
|
|
163
163
|
"create.js"
|
|
164
164
|
]
|
|
165
165
|
},
|
|
166
|
-
"
|
|
166
|
+
"build": {
|
|
167
167
|
"aliases": [],
|
|
168
168
|
"args": {
|
|
169
|
-
"
|
|
170
|
-
"description": "
|
|
171
|
-
"name": "
|
|
172
|
-
"required": true
|
|
169
|
+
"source": {
|
|
170
|
+
"description": "path of project source directory",
|
|
171
|
+
"name": "source"
|
|
173
172
|
}
|
|
174
173
|
},
|
|
175
|
-
"description": "
|
|
174
|
+
"description": "Build a project locally.\n\nUse this command to build an image or a complete multicontainer project with\nthe provided docker daemon in your development machine or balena device.\n(See also the `balena push` command for the option of building images in the\nbalenaCloud build servers.)\n\nYou must specify either a fleet, or the device type and architecture.\n\nThis command will look into the given source directory (or the current working\ndirectory if one isn't specified) for a docker-compose.yml file, and if found,\neach service defined in the compose file will be built. If a compose file isn't\nfound, it will look for a Dockerfile[.template] file (or alternative Dockerfile\nspecified with the `--dockerfile` option), and if no dockerfile is found, it\nwill try to generate one.\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",
|
|
176
175
|
"examples": [
|
|
177
|
-
"$ balena
|
|
178
|
-
"$ balena
|
|
179
|
-
"$ balena
|
|
176
|
+
"$ balena build --fleet myFleet",
|
|
177
|
+
"$ balena build ./source/ --fleet myorg/myfleet",
|
|
178
|
+
"$ balena build --deviceType raspberrypi3 --emulated",
|
|
179
|
+
"$ balena build --deviceType raspberrypi3 --arch armv7hf --emulated",
|
|
180
|
+
"$ balena build --docker /var/run/docker.sock --fleet myFleet # Linux, Mac",
|
|
181
|
+
"$ balena build --docker //./pipe/docker_engine --fleet myFleet # Windows",
|
|
182
|
+
"$ balena build --dockerHost my.docker.host --dockerPort 2376 --ca ca.pem --key key.pem --cert cert.pem -f myFleet"
|
|
180
183
|
],
|
|
181
184
|
"flags": {
|
|
182
|
-
"
|
|
183
|
-
"char": "
|
|
184
|
-
"description": "
|
|
185
|
-
"name": "
|
|
185
|
+
"arch": {
|
|
186
|
+
"char": "A",
|
|
187
|
+
"description": "the architecture to build for",
|
|
188
|
+
"name": "arch",
|
|
186
189
|
"hasDynamicHelp": false,
|
|
187
190
|
"multiple": false,
|
|
188
191
|
"type": "option"
|
|
189
192
|
},
|
|
190
|
-
"
|
|
193
|
+
"deviceType": {
|
|
194
|
+
"char": "d",
|
|
195
|
+
"description": "the type of device this build is for",
|
|
196
|
+
"name": "deviceType",
|
|
197
|
+
"hasDynamicHelp": false,
|
|
198
|
+
"multiple": false,
|
|
199
|
+
"type": "option"
|
|
200
|
+
},
|
|
201
|
+
"fleet": {
|
|
202
|
+
"char": "f",
|
|
203
|
+
"description": "fleet name or slug (preferred)",
|
|
204
|
+
"name": "fleet",
|
|
205
|
+
"hasDynamicHelp": false,
|
|
206
|
+
"multiple": false,
|
|
207
|
+
"type": "option"
|
|
208
|
+
},
|
|
209
|
+
"emulated": {
|
|
210
|
+
"char": "e",
|
|
211
|
+
"description": "Use QEMU for ARM architecture emulation during the image build",
|
|
212
|
+
"name": "emulated",
|
|
213
|
+
"allowNo": false,
|
|
214
|
+
"type": "boolean"
|
|
215
|
+
},
|
|
216
|
+
"dockerfile": {
|
|
217
|
+
"description": "Alternative Dockerfile name/path, relative to the source folder",
|
|
218
|
+
"name": "dockerfile",
|
|
219
|
+
"hasDynamicHelp": false,
|
|
220
|
+
"multiple": false,
|
|
221
|
+
"type": "option"
|
|
222
|
+
},
|
|
223
|
+
"nologs": {
|
|
224
|
+
"description": "Hide the image build log output (produce less verbose output)",
|
|
225
|
+
"name": "nologs",
|
|
226
|
+
"allowNo": false,
|
|
227
|
+
"type": "boolean"
|
|
228
|
+
},
|
|
229
|
+
"multi-dockerignore": {
|
|
230
|
+
"char": "m",
|
|
231
|
+
"description": "Have each service use its own .dockerignore file. See \"balena help build\".",
|
|
232
|
+
"name": "multi-dockerignore",
|
|
233
|
+
"allowNo": false,
|
|
234
|
+
"type": "boolean"
|
|
235
|
+
},
|
|
236
|
+
"noparent-check": {
|
|
237
|
+
"description": "Disable project validation check of 'docker-compose.yml' file in parent folder",
|
|
238
|
+
"name": "noparent-check",
|
|
239
|
+
"allowNo": false,
|
|
240
|
+
"type": "boolean"
|
|
241
|
+
},
|
|
242
|
+
"registry-secrets": {
|
|
243
|
+
"char": "R",
|
|
244
|
+
"description": "Path to a YAML or JSON file with passwords for a private Docker registry",
|
|
245
|
+
"name": "registry-secrets",
|
|
246
|
+
"hasDynamicHelp": false,
|
|
247
|
+
"multiple": false,
|
|
248
|
+
"type": "option"
|
|
249
|
+
},
|
|
250
|
+
"noconvert-eol": {
|
|
251
|
+
"description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
|
|
252
|
+
"name": "noconvert-eol",
|
|
253
|
+
"allowNo": false,
|
|
254
|
+
"type": "boolean"
|
|
255
|
+
},
|
|
256
|
+
"projectName": {
|
|
257
|
+
"char": "n",
|
|
258
|
+
"description": "Name prefix for locally built images. This is the 'projectName' portion\nin 'projectName_serviceName:tag'. The default is the directory name.",
|
|
259
|
+
"name": "projectName",
|
|
260
|
+
"hasDynamicHelp": false,
|
|
261
|
+
"multiple": false,
|
|
262
|
+
"type": "option"
|
|
263
|
+
},
|
|
264
|
+
"tag": {
|
|
191
265
|
"char": "t",
|
|
192
|
-
"description": "
|
|
193
|
-
"name": "
|
|
266
|
+
"description": "Tag locally built Docker images. This is the 'tag' portion\nin 'projectName_serviceName:tag'. The default is 'latest'.",
|
|
267
|
+
"name": "tag",
|
|
268
|
+
"hasDynamicHelp": false,
|
|
269
|
+
"multiple": false,
|
|
270
|
+
"type": "option"
|
|
271
|
+
},
|
|
272
|
+
"buildArg": {
|
|
273
|
+
"char": "B",
|
|
274
|
+
"description": "[Deprecated] Set a build-time variable (eg. \"-B 'ARG=value'\"). Can be specified multiple times.",
|
|
275
|
+
"name": "buildArg",
|
|
276
|
+
"hasDynamicHelp": false,
|
|
277
|
+
"multiple": true,
|
|
278
|
+
"type": "option"
|
|
279
|
+
},
|
|
280
|
+
"cache-from": {
|
|
281
|
+
"description": "Comma-separated list (no spaces) of image names for build cache resolution. Implements the same feature as the \"docker build --cache-from\" option.",
|
|
282
|
+
"name": "cache-from",
|
|
283
|
+
"hasDynamicHelp": false,
|
|
284
|
+
"multiple": false,
|
|
285
|
+
"type": "option"
|
|
286
|
+
},
|
|
287
|
+
"nocache": {
|
|
288
|
+
"description": "Don't use docker layer caching when building",
|
|
289
|
+
"name": "nocache",
|
|
290
|
+
"allowNo": false,
|
|
291
|
+
"type": "boolean"
|
|
292
|
+
},
|
|
293
|
+
"pull": {
|
|
294
|
+
"description": "Pull the base images again even if they exist locally",
|
|
295
|
+
"name": "pull",
|
|
296
|
+
"allowNo": false,
|
|
297
|
+
"type": "boolean"
|
|
298
|
+
},
|
|
299
|
+
"squash": {
|
|
300
|
+
"description": "Squash newly built layers into a single new layer",
|
|
301
|
+
"name": "squash",
|
|
302
|
+
"allowNo": false,
|
|
303
|
+
"type": "boolean"
|
|
304
|
+
},
|
|
305
|
+
"docker": {
|
|
306
|
+
"char": "P",
|
|
307
|
+
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
308
|
+
"name": "docker",
|
|
309
|
+
"hasDynamicHelp": false,
|
|
310
|
+
"multiple": false,
|
|
311
|
+
"type": "option"
|
|
312
|
+
},
|
|
313
|
+
"dockerHost": {
|
|
314
|
+
"char": "h",
|
|
315
|
+
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
316
|
+
"name": "dockerHost",
|
|
317
|
+
"hasDynamicHelp": false,
|
|
318
|
+
"multiple": false,
|
|
319
|
+
"type": "option"
|
|
320
|
+
},
|
|
321
|
+
"dockerPort": {
|
|
322
|
+
"char": "p",
|
|
323
|
+
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
324
|
+
"name": "dockerPort",
|
|
325
|
+
"hasDynamicHelp": false,
|
|
326
|
+
"multiple": false,
|
|
327
|
+
"type": "option"
|
|
328
|
+
},
|
|
329
|
+
"ca": {
|
|
330
|
+
"description": "Docker host TLS certificate authority file",
|
|
331
|
+
"name": "ca",
|
|
332
|
+
"hasDynamicHelp": false,
|
|
333
|
+
"multiple": false,
|
|
334
|
+
"type": "option"
|
|
335
|
+
},
|
|
336
|
+
"cert": {
|
|
337
|
+
"description": "Docker host TLS certificate file",
|
|
338
|
+
"name": "cert",
|
|
339
|
+
"hasDynamicHelp": false,
|
|
340
|
+
"multiple": false,
|
|
341
|
+
"type": "option"
|
|
342
|
+
},
|
|
343
|
+
"key": {
|
|
344
|
+
"description": "Docker host TLS key file",
|
|
345
|
+
"name": "key",
|
|
194
346
|
"hasDynamicHelp": false,
|
|
195
347
|
"multiple": false,
|
|
196
348
|
"type": "option"
|
|
@@ -198,19 +350,19 @@
|
|
|
198
350
|
},
|
|
199
351
|
"hasDynamicHelp": false,
|
|
200
352
|
"hiddenAliases": [],
|
|
201
|
-
"id": "
|
|
353
|
+
"id": "build",
|
|
202
354
|
"pluginAlias": "balena-cli",
|
|
203
355
|
"pluginName": "balena-cli",
|
|
204
356
|
"pluginType": "core",
|
|
205
357
|
"strict": true,
|
|
206
358
|
"enableJsonFlag": false,
|
|
207
|
-
"
|
|
359
|
+
"primary": true,
|
|
208
360
|
"isESM": false,
|
|
209
361
|
"relativePath": [
|
|
210
362
|
"build",
|
|
211
363
|
"commands",
|
|
212
|
-
"
|
|
213
|
-
"
|
|
364
|
+
"build",
|
|
365
|
+
"index.js"
|
|
214
366
|
]
|
|
215
367
|
},
|
|
216
368
|
"config:generate": {
|
|
@@ -557,186 +709,34 @@
|
|
|
557
709
|
"write.js"
|
|
558
710
|
]
|
|
559
711
|
},
|
|
560
|
-
"
|
|
712
|
+
"block:create": {
|
|
561
713
|
"aliases": [],
|
|
562
714
|
"args": {
|
|
563
|
-
"
|
|
564
|
-
"description": "
|
|
565
|
-
"name": "
|
|
715
|
+
"name": {
|
|
716
|
+
"description": "block name",
|
|
717
|
+
"name": "name",
|
|
718
|
+
"required": true
|
|
566
719
|
}
|
|
567
720
|
},
|
|
568
|
-
"description": "
|
|
721
|
+
"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.",
|
|
569
722
|
"examples": [
|
|
570
|
-
"$ balena
|
|
571
|
-
"$ balena
|
|
572
|
-
"$ balena
|
|
573
|
-
"$ balena build --deviceType raspberrypi3 --arch armv7hf --emulated",
|
|
574
|
-
"$ balena build --docker /var/run/docker.sock --fleet myFleet # Linux, Mac",
|
|
575
|
-
"$ balena build --docker //./pipe/docker_engine --fleet myFleet # Windows",
|
|
576
|
-
"$ balena build --dockerHost my.docker.host --dockerPort 2376 --ca ca.pem --key key.pem --cert cert.pem -f myFleet"
|
|
723
|
+
"$ balena block create MyBlock",
|
|
724
|
+
"$ balena block create MyBlock --organization mmyorg",
|
|
725
|
+
"$ balena block create MyBlock -o myorg --type raspberry-pi"
|
|
577
726
|
],
|
|
578
727
|
"flags": {
|
|
579
|
-
"
|
|
580
|
-
"char": "
|
|
581
|
-
"description": "the
|
|
582
|
-
"name": "
|
|
583
|
-
"hasDynamicHelp": false,
|
|
584
|
-
"multiple": false,
|
|
585
|
-
"type": "option"
|
|
586
|
-
},
|
|
587
|
-
"deviceType": {
|
|
588
|
-
"char": "d",
|
|
589
|
-
"description": "the type of device this build is for",
|
|
590
|
-
"name": "deviceType",
|
|
591
|
-
"hasDynamicHelp": false,
|
|
592
|
-
"multiple": false,
|
|
593
|
-
"type": "option"
|
|
594
|
-
},
|
|
595
|
-
"fleet": {
|
|
596
|
-
"char": "f",
|
|
597
|
-
"description": "fleet name or slug (preferred)",
|
|
598
|
-
"name": "fleet",
|
|
599
|
-
"hasDynamicHelp": false,
|
|
600
|
-
"multiple": false,
|
|
601
|
-
"type": "option"
|
|
602
|
-
},
|
|
603
|
-
"emulated": {
|
|
604
|
-
"char": "e",
|
|
605
|
-
"description": "Use QEMU for ARM architecture emulation during the image build",
|
|
606
|
-
"name": "emulated",
|
|
607
|
-
"allowNo": false,
|
|
608
|
-
"type": "boolean"
|
|
609
|
-
},
|
|
610
|
-
"dockerfile": {
|
|
611
|
-
"description": "Alternative Dockerfile name/path, relative to the source folder",
|
|
612
|
-
"name": "dockerfile",
|
|
613
|
-
"hasDynamicHelp": false,
|
|
614
|
-
"multiple": false,
|
|
615
|
-
"type": "option"
|
|
616
|
-
},
|
|
617
|
-
"nologs": {
|
|
618
|
-
"description": "Hide the image build log output (produce less verbose output)",
|
|
619
|
-
"name": "nologs",
|
|
620
|
-
"allowNo": false,
|
|
621
|
-
"type": "boolean"
|
|
622
|
-
},
|
|
623
|
-
"multi-dockerignore": {
|
|
624
|
-
"char": "m",
|
|
625
|
-
"description": "Have each service use its own .dockerignore file. See \"balena help build\".",
|
|
626
|
-
"name": "multi-dockerignore",
|
|
627
|
-
"allowNo": false,
|
|
628
|
-
"type": "boolean"
|
|
629
|
-
},
|
|
630
|
-
"noparent-check": {
|
|
631
|
-
"description": "Disable project validation check of 'docker-compose.yml' file in parent folder",
|
|
632
|
-
"name": "noparent-check",
|
|
633
|
-
"allowNo": false,
|
|
634
|
-
"type": "boolean"
|
|
635
|
-
},
|
|
636
|
-
"registry-secrets": {
|
|
637
|
-
"char": "R",
|
|
638
|
-
"description": "Path to a YAML or JSON file with passwords for a private Docker registry",
|
|
639
|
-
"name": "registry-secrets",
|
|
640
|
-
"hasDynamicHelp": false,
|
|
641
|
-
"multiple": false,
|
|
642
|
-
"type": "option"
|
|
643
|
-
},
|
|
644
|
-
"noconvert-eol": {
|
|
645
|
-
"description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
|
|
646
|
-
"name": "noconvert-eol",
|
|
647
|
-
"allowNo": false,
|
|
648
|
-
"type": "boolean"
|
|
649
|
-
},
|
|
650
|
-
"projectName": {
|
|
651
|
-
"char": "n",
|
|
652
|
-
"description": "Name prefix for locally built images. This is the 'projectName' portion\nin 'projectName_serviceName:tag'. The default is the directory name.",
|
|
653
|
-
"name": "projectName",
|
|
728
|
+
"organization": {
|
|
729
|
+
"char": "o",
|
|
730
|
+
"description": "handle of the organization the block should belong to",
|
|
731
|
+
"name": "organization",
|
|
654
732
|
"hasDynamicHelp": false,
|
|
655
733
|
"multiple": false,
|
|
656
734
|
"type": "option"
|
|
657
735
|
},
|
|
658
|
-
"
|
|
736
|
+
"type": {
|
|
659
737
|
"char": "t",
|
|
660
|
-
"description": "
|
|
661
|
-
"name": "
|
|
662
|
-
"hasDynamicHelp": false,
|
|
663
|
-
"multiple": false,
|
|
664
|
-
"type": "option"
|
|
665
|
-
},
|
|
666
|
-
"buildArg": {
|
|
667
|
-
"char": "B",
|
|
668
|
-
"description": "[Deprecated] Set a build-time variable (eg. \"-B 'ARG=value'\"). Can be specified multiple times.",
|
|
669
|
-
"name": "buildArg",
|
|
670
|
-
"hasDynamicHelp": false,
|
|
671
|
-
"multiple": true,
|
|
672
|
-
"type": "option"
|
|
673
|
-
},
|
|
674
|
-
"cache-from": {
|
|
675
|
-
"description": "Comma-separated list (no spaces) of image names for build cache resolution. Implements the same feature as the \"docker build --cache-from\" option.",
|
|
676
|
-
"name": "cache-from",
|
|
677
|
-
"hasDynamicHelp": false,
|
|
678
|
-
"multiple": false,
|
|
679
|
-
"type": "option"
|
|
680
|
-
},
|
|
681
|
-
"nocache": {
|
|
682
|
-
"description": "Don't use docker layer caching when building",
|
|
683
|
-
"name": "nocache",
|
|
684
|
-
"allowNo": false,
|
|
685
|
-
"type": "boolean"
|
|
686
|
-
},
|
|
687
|
-
"pull": {
|
|
688
|
-
"description": "Pull the base images again even if they exist locally",
|
|
689
|
-
"name": "pull",
|
|
690
|
-
"allowNo": false,
|
|
691
|
-
"type": "boolean"
|
|
692
|
-
},
|
|
693
|
-
"squash": {
|
|
694
|
-
"description": "Squash newly built layers into a single new layer",
|
|
695
|
-
"name": "squash",
|
|
696
|
-
"allowNo": false,
|
|
697
|
-
"type": "boolean"
|
|
698
|
-
},
|
|
699
|
-
"docker": {
|
|
700
|
-
"char": "P",
|
|
701
|
-
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
702
|
-
"name": "docker",
|
|
703
|
-
"hasDynamicHelp": false,
|
|
704
|
-
"multiple": false,
|
|
705
|
-
"type": "option"
|
|
706
|
-
},
|
|
707
|
-
"dockerHost": {
|
|
708
|
-
"char": "h",
|
|
709
|
-
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
710
|
-
"name": "dockerHost",
|
|
711
|
-
"hasDynamicHelp": false,
|
|
712
|
-
"multiple": false,
|
|
713
|
-
"type": "option"
|
|
714
|
-
},
|
|
715
|
-
"dockerPort": {
|
|
716
|
-
"char": "p",
|
|
717
|
-
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
718
|
-
"name": "dockerPort",
|
|
719
|
-
"hasDynamicHelp": false,
|
|
720
|
-
"multiple": false,
|
|
721
|
-
"type": "option"
|
|
722
|
-
},
|
|
723
|
-
"ca": {
|
|
724
|
-
"description": "Docker host TLS certificate authority file",
|
|
725
|
-
"name": "ca",
|
|
726
|
-
"hasDynamicHelp": false,
|
|
727
|
-
"multiple": false,
|
|
728
|
-
"type": "option"
|
|
729
|
-
},
|
|
730
|
-
"cert": {
|
|
731
|
-
"description": "Docker host TLS certificate file",
|
|
732
|
-
"name": "cert",
|
|
733
|
-
"hasDynamicHelp": false,
|
|
734
|
-
"multiple": false,
|
|
735
|
-
"type": "option"
|
|
736
|
-
},
|
|
737
|
-
"key": {
|
|
738
|
-
"description": "Docker host TLS key file",
|
|
739
|
-
"name": "key",
|
|
738
|
+
"description": "block device type (Check available types with `balena device-type list`)",
|
|
739
|
+
"name": "type",
|
|
740
740
|
"hasDynamicHelp": false,
|
|
741
741
|
"multiple": false,
|
|
742
742
|
"type": "option"
|
|
@@ -744,19 +744,19 @@
|
|
|
744
744
|
},
|
|
745
745
|
"hasDynamicHelp": false,
|
|
746
746
|
"hiddenAliases": [],
|
|
747
|
-
"id": "
|
|
747
|
+
"id": "block:create",
|
|
748
748
|
"pluginAlias": "balena-cli",
|
|
749
749
|
"pluginName": "balena-cli",
|
|
750
750
|
"pluginType": "core",
|
|
751
751
|
"strict": true,
|
|
752
752
|
"enableJsonFlag": false,
|
|
753
|
-
"
|
|
753
|
+
"authenticated": true,
|
|
754
754
|
"isESM": false,
|
|
755
755
|
"relativePath": [
|
|
756
756
|
"build",
|
|
757
757
|
"commands",
|
|
758
|
-
"
|
|
759
|
-
"
|
|
758
|
+
"block",
|
|
759
|
+
"create.js"
|
|
760
760
|
]
|
|
761
761
|
},
|
|
762
762
|
"deploy": {
|
|
@@ -3686,136 +3686,6 @@
|
|
|
3686
3686
|
"versions.js"
|
|
3687
3687
|
]
|
|
3688
3688
|
},
|
|
3689
|
-
"preload": {
|
|
3690
|
-
"aliases": [],
|
|
3691
|
-
"args": {
|
|
3692
|
-
"image": {
|
|
3693
|
-
"description": "the image file path",
|
|
3694
|
-
"name": "image",
|
|
3695
|
-
"required": true
|
|
3696
|
-
}
|
|
3697
|
-
},
|
|
3698
|
-
"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.",
|
|
3699
|
-
"examples": [
|
|
3700
|
-
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3701
|
-
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3702
|
-
"$ balena preload balena.img"
|
|
3703
|
-
],
|
|
3704
|
-
"flags": {
|
|
3705
|
-
"fleet": {
|
|
3706
|
-
"char": "f",
|
|
3707
|
-
"description": "fleet name or slug (preferred)",
|
|
3708
|
-
"name": "fleet",
|
|
3709
|
-
"hasDynamicHelp": false,
|
|
3710
|
-
"multiple": false,
|
|
3711
|
-
"type": "option"
|
|
3712
|
-
},
|
|
3713
|
-
"commit": {
|
|
3714
|
-
"char": "c",
|
|
3715
|
-
"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",
|
|
3716
|
-
"name": "commit",
|
|
3717
|
-
"hasDynamicHelp": false,
|
|
3718
|
-
"multiple": false,
|
|
3719
|
-
"type": "option"
|
|
3720
|
-
},
|
|
3721
|
-
"splash-image": {
|
|
3722
|
-
"char": "s",
|
|
3723
|
-
"description": "path to a png image to replace the splash screen",
|
|
3724
|
-
"name": "splash-image",
|
|
3725
|
-
"hasDynamicHelp": false,
|
|
3726
|
-
"multiple": false,
|
|
3727
|
-
"type": "option"
|
|
3728
|
-
},
|
|
3729
|
-
"dont-check-arch": {
|
|
3730
|
-
"description": "disable architecture compatibility check between image and fleet",
|
|
3731
|
-
"name": "dont-check-arch",
|
|
3732
|
-
"allowNo": false,
|
|
3733
|
-
"type": "boolean"
|
|
3734
|
-
},
|
|
3735
|
-
"pin-device-to-release": {
|
|
3736
|
-
"char": "p",
|
|
3737
|
-
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3738
|
-
"name": "pin-device-to-release",
|
|
3739
|
-
"allowNo": true,
|
|
3740
|
-
"type": "boolean"
|
|
3741
|
-
},
|
|
3742
|
-
"additional-space": {
|
|
3743
|
-
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3744
|
-
"name": "additional-space",
|
|
3745
|
-
"hasDynamicHelp": false,
|
|
3746
|
-
"multiple": false,
|
|
3747
|
-
"type": "option"
|
|
3748
|
-
},
|
|
3749
|
-
"add-certificate": {
|
|
3750
|
-
"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.",
|
|
3751
|
-
"name": "add-certificate",
|
|
3752
|
-
"hasDynamicHelp": false,
|
|
3753
|
-
"multiple": true,
|
|
3754
|
-
"type": "option"
|
|
3755
|
-
},
|
|
3756
|
-
"docker": {
|
|
3757
|
-
"char": "P",
|
|
3758
|
-
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3759
|
-
"name": "docker",
|
|
3760
|
-
"hasDynamicHelp": false,
|
|
3761
|
-
"multiple": false,
|
|
3762
|
-
"type": "option"
|
|
3763
|
-
},
|
|
3764
|
-
"dockerHost": {
|
|
3765
|
-
"char": "h",
|
|
3766
|
-
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3767
|
-
"name": "dockerHost",
|
|
3768
|
-
"hasDynamicHelp": false,
|
|
3769
|
-
"multiple": false,
|
|
3770
|
-
"type": "option"
|
|
3771
|
-
},
|
|
3772
|
-
"dockerPort": {
|
|
3773
|
-
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3774
|
-
"name": "dockerPort",
|
|
3775
|
-
"hasDynamicHelp": false,
|
|
3776
|
-
"multiple": false,
|
|
3777
|
-
"type": "option"
|
|
3778
|
-
},
|
|
3779
|
-
"ca": {
|
|
3780
|
-
"description": "Docker host TLS certificate authority file",
|
|
3781
|
-
"name": "ca",
|
|
3782
|
-
"hasDynamicHelp": false,
|
|
3783
|
-
"multiple": false,
|
|
3784
|
-
"type": "option"
|
|
3785
|
-
},
|
|
3786
|
-
"cert": {
|
|
3787
|
-
"description": "Docker host TLS certificate file",
|
|
3788
|
-
"name": "cert",
|
|
3789
|
-
"hasDynamicHelp": false,
|
|
3790
|
-
"multiple": false,
|
|
3791
|
-
"type": "option"
|
|
3792
|
-
},
|
|
3793
|
-
"key": {
|
|
3794
|
-
"description": "Docker host TLS key file",
|
|
3795
|
-
"name": "key",
|
|
3796
|
-
"hasDynamicHelp": false,
|
|
3797
|
-
"multiple": false,
|
|
3798
|
-
"type": "option"
|
|
3799
|
-
}
|
|
3800
|
-
},
|
|
3801
|
-
"hasDynamicHelp": false,
|
|
3802
|
-
"hiddenAliases": [],
|
|
3803
|
-
"id": "preload",
|
|
3804
|
-
"pluginAlias": "balena-cli",
|
|
3805
|
-
"pluginName": "balena-cli",
|
|
3806
|
-
"pluginType": "core",
|
|
3807
|
-
"strict": true,
|
|
3808
|
-
"enableJsonFlag": false,
|
|
3809
|
-
"authenticated": true,
|
|
3810
|
-
"primary": true,
|
|
3811
|
-
"isESM": false,
|
|
3812
|
-
"relativePath": [
|
|
3813
|
-
"build",
|
|
3814
|
-
"commands",
|
|
3815
|
-
"preload",
|
|
3816
|
-
"index.js"
|
|
3817
|
-
]
|
|
3818
|
-
},
|
|
3819
3689
|
"push": {
|
|
3820
3690
|
"aliases": [],
|
|
3821
3691
|
"args": {
|
|
@@ -3886,79 +3756,208 @@
|
|
|
3886
3756
|
"allowNo": false,
|
|
3887
3757
|
"type": "boolean"
|
|
3888
3758
|
},
|
|
3889
|
-
"registry-secrets": {
|
|
3890
|
-
"char": "R",
|
|
3891
|
-
"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)",
|
|
3892
|
-
"name": "registry-secrets",
|
|
3759
|
+
"registry-secrets": {
|
|
3760
|
+
"char": "R",
|
|
3761
|
+
"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)",
|
|
3762
|
+
"name": "registry-secrets",
|
|
3763
|
+
"hasDynamicHelp": false,
|
|
3764
|
+
"multiple": false,
|
|
3765
|
+
"type": "option"
|
|
3766
|
+
},
|
|
3767
|
+
"nolive": {
|
|
3768
|
+
"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.",
|
|
3769
|
+
"name": "nolive",
|
|
3770
|
+
"allowNo": false,
|
|
3771
|
+
"type": "boolean"
|
|
3772
|
+
},
|
|
3773
|
+
"detached": {
|
|
3774
|
+
"char": "d",
|
|
3775
|
+
"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.",
|
|
3776
|
+
"name": "detached",
|
|
3777
|
+
"allowNo": false,
|
|
3778
|
+
"type": "boolean"
|
|
3779
|
+
},
|
|
3780
|
+
"service": {
|
|
3781
|
+
"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.",
|
|
3782
|
+
"name": "service",
|
|
3783
|
+
"hasDynamicHelp": false,
|
|
3784
|
+
"multiple": true,
|
|
3785
|
+
"type": "option"
|
|
3786
|
+
},
|
|
3787
|
+
"system": {
|
|
3788
|
+
"description": "Only show system logs. This can be used in combination with --service.\nOnly valid when pushing to a local mode device.",
|
|
3789
|
+
"name": "system",
|
|
3790
|
+
"allowNo": false,
|
|
3791
|
+
"type": "boolean"
|
|
3792
|
+
},
|
|
3793
|
+
"env": {
|
|
3794
|
+
"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.",
|
|
3795
|
+
"name": "env",
|
|
3796
|
+
"hasDynamicHelp": false,
|
|
3797
|
+
"multiple": true,
|
|
3798
|
+
"type": "option"
|
|
3799
|
+
},
|
|
3800
|
+
"noconvert-eol": {
|
|
3801
|
+
"description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
|
|
3802
|
+
"name": "noconvert-eol",
|
|
3803
|
+
"allowNo": false,
|
|
3804
|
+
"type": "boolean"
|
|
3805
|
+
},
|
|
3806
|
+
"multi-dockerignore": {
|
|
3807
|
+
"char": "m",
|
|
3808
|
+
"description": "Have each service use its own .dockerignore file. See \"balena help push\".",
|
|
3809
|
+
"name": "multi-dockerignore",
|
|
3810
|
+
"allowNo": false,
|
|
3811
|
+
"type": "boolean"
|
|
3812
|
+
},
|
|
3813
|
+
"release-tag": {
|
|
3814
|
+
"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).",
|
|
3815
|
+
"exclusive": [
|
|
3816
|
+
"detached"
|
|
3817
|
+
],
|
|
3818
|
+
"name": "release-tag",
|
|
3819
|
+
"hasDynamicHelp": false,
|
|
3820
|
+
"multiple": true,
|
|
3821
|
+
"type": "option"
|
|
3822
|
+
},
|
|
3823
|
+
"draft": {
|
|
3824
|
+
"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.",
|
|
3825
|
+
"name": "draft",
|
|
3826
|
+
"allowNo": false,
|
|
3827
|
+
"type": "boolean"
|
|
3828
|
+
},
|
|
3829
|
+
"note": {
|
|
3830
|
+
"description": "The notes for this release",
|
|
3831
|
+
"name": "note",
|
|
3832
|
+
"hasDynamicHelp": false,
|
|
3833
|
+
"multiple": false,
|
|
3834
|
+
"type": "option"
|
|
3835
|
+
}
|
|
3836
|
+
},
|
|
3837
|
+
"hasDynamicHelp": false,
|
|
3838
|
+
"hiddenAliases": [],
|
|
3839
|
+
"id": "push",
|
|
3840
|
+
"pluginAlias": "balena-cli",
|
|
3841
|
+
"pluginName": "balena-cli",
|
|
3842
|
+
"pluginType": "core",
|
|
3843
|
+
"strict": true,
|
|
3844
|
+
"enableJsonFlag": false,
|
|
3845
|
+
"primary": true,
|
|
3846
|
+
"isESM": false,
|
|
3847
|
+
"relativePath": [
|
|
3848
|
+
"build",
|
|
3849
|
+
"commands",
|
|
3850
|
+
"push",
|
|
3851
|
+
"index.js"
|
|
3852
|
+
]
|
|
3853
|
+
},
|
|
3854
|
+
"preload": {
|
|
3855
|
+
"aliases": [],
|
|
3856
|
+
"args": {
|
|
3857
|
+
"image": {
|
|
3858
|
+
"description": "the image file path",
|
|
3859
|
+
"name": "image",
|
|
3860
|
+
"required": true
|
|
3861
|
+
}
|
|
3862
|
+
},
|
|
3863
|
+
"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.",
|
|
3864
|
+
"examples": [
|
|
3865
|
+
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3866
|
+
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3867
|
+
"$ balena preload balena.img"
|
|
3868
|
+
],
|
|
3869
|
+
"flags": {
|
|
3870
|
+
"fleet": {
|
|
3871
|
+
"char": "f",
|
|
3872
|
+
"description": "fleet name or slug (preferred)",
|
|
3873
|
+
"name": "fleet",
|
|
3874
|
+
"hasDynamicHelp": false,
|
|
3875
|
+
"multiple": false,
|
|
3876
|
+
"type": "option"
|
|
3877
|
+
},
|
|
3878
|
+
"commit": {
|
|
3879
|
+
"char": "c",
|
|
3880
|
+
"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",
|
|
3881
|
+
"name": "commit",
|
|
3893
3882
|
"hasDynamicHelp": false,
|
|
3894
3883
|
"multiple": false,
|
|
3895
3884
|
"type": "option"
|
|
3896
3885
|
},
|
|
3897
|
-
"
|
|
3898
|
-
"
|
|
3899
|
-
"
|
|
3886
|
+
"splash-image": {
|
|
3887
|
+
"char": "s",
|
|
3888
|
+
"description": "path to a png image to replace the splash screen",
|
|
3889
|
+
"name": "splash-image",
|
|
3890
|
+
"hasDynamicHelp": false,
|
|
3891
|
+
"multiple": false,
|
|
3892
|
+
"type": "option"
|
|
3893
|
+
},
|
|
3894
|
+
"dont-check-arch": {
|
|
3895
|
+
"description": "disable architecture compatibility check between image and fleet",
|
|
3896
|
+
"name": "dont-check-arch",
|
|
3900
3897
|
"allowNo": false,
|
|
3901
3898
|
"type": "boolean"
|
|
3902
3899
|
},
|
|
3903
|
-
"
|
|
3904
|
-
"char": "
|
|
3905
|
-
"description": "
|
|
3906
|
-
"name": "
|
|
3907
|
-
"allowNo":
|
|
3900
|
+
"pin-device-to-release": {
|
|
3901
|
+
"char": "p",
|
|
3902
|
+
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3903
|
+
"name": "pin-device-to-release",
|
|
3904
|
+
"allowNo": true,
|
|
3908
3905
|
"type": "boolean"
|
|
3909
3906
|
},
|
|
3910
|
-
"
|
|
3911
|
-
"description": "
|
|
3912
|
-
"name": "
|
|
3907
|
+
"additional-space": {
|
|
3908
|
+
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3909
|
+
"name": "additional-space",
|
|
3913
3910
|
"hasDynamicHelp": false,
|
|
3914
|
-
"multiple":
|
|
3911
|
+
"multiple": false,
|
|
3915
3912
|
"type": "option"
|
|
3916
3913
|
},
|
|
3917
|
-
"
|
|
3918
|
-
"description": "
|
|
3919
|
-
"name": "
|
|
3920
|
-
"allowNo": false,
|
|
3921
|
-
"type": "boolean"
|
|
3922
|
-
},
|
|
3923
|
-
"env": {
|
|
3924
|
-
"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.",
|
|
3925
|
-
"name": "env",
|
|
3914
|
+
"add-certificate": {
|
|
3915
|
+
"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.",
|
|
3916
|
+
"name": "add-certificate",
|
|
3926
3917
|
"hasDynamicHelp": false,
|
|
3927
3918
|
"multiple": true,
|
|
3928
3919
|
"type": "option"
|
|
3929
3920
|
},
|
|
3930
|
-
"
|
|
3931
|
-
"
|
|
3932
|
-
"
|
|
3933
|
-
"
|
|
3934
|
-
"
|
|
3921
|
+
"docker": {
|
|
3922
|
+
"char": "P",
|
|
3923
|
+
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3924
|
+
"name": "docker",
|
|
3925
|
+
"hasDynamicHelp": false,
|
|
3926
|
+
"multiple": false,
|
|
3927
|
+
"type": "option"
|
|
3935
3928
|
},
|
|
3936
|
-
"
|
|
3937
|
-
"char": "
|
|
3938
|
-
"description": "
|
|
3939
|
-
"name": "
|
|
3940
|
-
"
|
|
3941
|
-
"
|
|
3929
|
+
"dockerHost": {
|
|
3930
|
+
"char": "h",
|
|
3931
|
+
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3932
|
+
"name": "dockerHost",
|
|
3933
|
+
"hasDynamicHelp": false,
|
|
3934
|
+
"multiple": false,
|
|
3935
|
+
"type": "option"
|
|
3942
3936
|
},
|
|
3943
|
-
"
|
|
3944
|
-
"description": "
|
|
3945
|
-
"
|
|
3946
|
-
"detached"
|
|
3947
|
-
],
|
|
3948
|
-
"name": "release-tag",
|
|
3937
|
+
"dockerPort": {
|
|
3938
|
+
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3939
|
+
"name": "dockerPort",
|
|
3949
3940
|
"hasDynamicHelp": false,
|
|
3950
|
-
"multiple":
|
|
3941
|
+
"multiple": false,
|
|
3951
3942
|
"type": "option"
|
|
3952
3943
|
},
|
|
3953
|
-
"
|
|
3954
|
-
"description": "
|
|
3955
|
-
"name": "
|
|
3956
|
-
"
|
|
3957
|
-
"
|
|
3944
|
+
"ca": {
|
|
3945
|
+
"description": "Docker host TLS certificate authority file",
|
|
3946
|
+
"name": "ca",
|
|
3947
|
+
"hasDynamicHelp": false,
|
|
3948
|
+
"multiple": false,
|
|
3949
|
+
"type": "option"
|
|
3958
3950
|
},
|
|
3959
|
-
"
|
|
3960
|
-
"description": "
|
|
3961
|
-
"name": "
|
|
3951
|
+
"cert": {
|
|
3952
|
+
"description": "Docker host TLS certificate file",
|
|
3953
|
+
"name": "cert",
|
|
3954
|
+
"hasDynamicHelp": false,
|
|
3955
|
+
"multiple": false,
|
|
3956
|
+
"type": "option"
|
|
3957
|
+
},
|
|
3958
|
+
"key": {
|
|
3959
|
+
"description": "Docker host TLS key file",
|
|
3960
|
+
"name": "key",
|
|
3962
3961
|
"hasDynamicHelp": false,
|
|
3963
3962
|
"multiple": false,
|
|
3964
3963
|
"type": "option"
|
|
@@ -3966,18 +3965,19 @@
|
|
|
3966
3965
|
},
|
|
3967
3966
|
"hasDynamicHelp": false,
|
|
3968
3967
|
"hiddenAliases": [],
|
|
3969
|
-
"id": "
|
|
3968
|
+
"id": "preload",
|
|
3970
3969
|
"pluginAlias": "balena-cli",
|
|
3971
3970
|
"pluginName": "balena-cli",
|
|
3972
3971
|
"pluginType": "core",
|
|
3973
3972
|
"strict": true,
|
|
3974
3973
|
"enableJsonFlag": false,
|
|
3974
|
+
"authenticated": true,
|
|
3975
3975
|
"primary": true,
|
|
3976
3976
|
"isESM": false,
|
|
3977
3977
|
"relativePath": [
|
|
3978
3978
|
"build",
|
|
3979
3979
|
"commands",
|
|
3980
|
-
"
|
|
3980
|
+
"preload",
|
|
3981
3981
|
"index.js"
|
|
3982
3982
|
]
|
|
3983
3983
|
},
|
|
@@ -4192,67 +4192,6 @@
|
|
|
4192
4192
|
"index.js"
|
|
4193
4193
|
]
|
|
4194
4194
|
},
|
|
4195
|
-
"support": {
|
|
4196
|
-
"aliases": [],
|
|
4197
|
-
"args": {
|
|
4198
|
-
"action": {
|
|
4199
|
-
"description": "enable|disable support access",
|
|
4200
|
-
"name": "action",
|
|
4201
|
-
"options": [
|
|
4202
|
-
"enable",
|
|
4203
|
-
"disable"
|
|
4204
|
-
]
|
|
4205
|
-
}
|
|
4206
|
-
},
|
|
4207
|
-
"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).",
|
|
4208
|
-
"examples": [
|
|
4209
|
-
"balena support enable --device ab346f,cd457a --duration 3d",
|
|
4210
|
-
"balena support enable --fleet myFleet --duration 12h",
|
|
4211
|
-
"balena support disable -f myorg/myfleet"
|
|
4212
|
-
],
|
|
4213
|
-
"flags": {
|
|
4214
|
-
"device": {
|
|
4215
|
-
"char": "d",
|
|
4216
|
-
"description": "comma-separated list (no spaces) of device UUIDs",
|
|
4217
|
-
"name": "device",
|
|
4218
|
-
"hasDynamicHelp": false,
|
|
4219
|
-
"multiple": false,
|
|
4220
|
-
"type": "option"
|
|
4221
|
-
},
|
|
4222
|
-
"fleet": {
|
|
4223
|
-
"char": "f",
|
|
4224
|
-
"description": "comma-separated list (no spaces) of fleet names or slugs (preferred)",
|
|
4225
|
-
"name": "fleet",
|
|
4226
|
-
"hasDynamicHelp": false,
|
|
4227
|
-
"multiple": false,
|
|
4228
|
-
"type": "option"
|
|
4229
|
-
},
|
|
4230
|
-
"duration": {
|
|
4231
|
-
"char": "t",
|
|
4232
|
-
"description": "length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d",
|
|
4233
|
-
"name": "duration",
|
|
4234
|
-
"hasDynamicHelp": false,
|
|
4235
|
-
"multiple": false,
|
|
4236
|
-
"type": "option"
|
|
4237
|
-
}
|
|
4238
|
-
},
|
|
4239
|
-
"hasDynamicHelp": false,
|
|
4240
|
-
"hiddenAliases": [],
|
|
4241
|
-
"id": "support",
|
|
4242
|
-
"pluginAlias": "balena-cli",
|
|
4243
|
-
"pluginName": "balena-cli",
|
|
4244
|
-
"pluginType": "core",
|
|
4245
|
-
"strict": true,
|
|
4246
|
-
"enableJsonFlag": false,
|
|
4247
|
-
"authenticated": true,
|
|
4248
|
-
"isESM": false,
|
|
4249
|
-
"relativePath": [
|
|
4250
|
-
"build",
|
|
4251
|
-
"commands",
|
|
4252
|
-
"support",
|
|
4253
|
-
"index.js"
|
|
4254
|
-
]
|
|
4255
|
-
},
|
|
4256
4195
|
"ssh-key:add": {
|
|
4257
4196
|
"aliases": [
|
|
4258
4197
|
"key add"
|
|
@@ -4401,26 +4340,65 @@
|
|
|
4401
4340
|
"rm.js"
|
|
4402
4341
|
]
|
|
4403
4342
|
},
|
|
4404
|
-
"
|
|
4343
|
+
"support": {
|
|
4405
4344
|
"aliases": [],
|
|
4406
|
-
"args": {
|
|
4407
|
-
|
|
4408
|
-
|
|
4345
|
+
"args": {
|
|
4346
|
+
"action": {
|
|
4347
|
+
"description": "enable|disable support access",
|
|
4348
|
+
"name": "action",
|
|
4349
|
+
"options": [
|
|
4350
|
+
"enable",
|
|
4351
|
+
"disable"
|
|
4352
|
+
]
|
|
4353
|
+
}
|
|
4354
|
+
},
|
|
4355
|
+
"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).",
|
|
4356
|
+
"examples": [
|
|
4357
|
+
"balena support enable --device ab346f,cd457a --duration 3d",
|
|
4358
|
+
"balena support enable --fleet myFleet --duration 12h",
|
|
4359
|
+
"balena support disable -f myorg/myfleet"
|
|
4360
|
+
],
|
|
4361
|
+
"flags": {
|
|
4362
|
+
"device": {
|
|
4363
|
+
"char": "d",
|
|
4364
|
+
"description": "comma-separated list (no spaces) of device UUIDs",
|
|
4365
|
+
"name": "device",
|
|
4366
|
+
"hasDynamicHelp": false,
|
|
4367
|
+
"multiple": false,
|
|
4368
|
+
"type": "option"
|
|
4369
|
+
},
|
|
4370
|
+
"fleet": {
|
|
4371
|
+
"char": "f",
|
|
4372
|
+
"description": "comma-separated list (no spaces) of fleet names or slugs (preferred)",
|
|
4373
|
+
"name": "fleet",
|
|
4374
|
+
"hasDynamicHelp": false,
|
|
4375
|
+
"multiple": false,
|
|
4376
|
+
"type": "option"
|
|
4377
|
+
},
|
|
4378
|
+
"duration": {
|
|
4379
|
+
"char": "t",
|
|
4380
|
+
"description": "length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d",
|
|
4381
|
+
"name": "duration",
|
|
4382
|
+
"hasDynamicHelp": false,
|
|
4383
|
+
"multiple": false,
|
|
4384
|
+
"type": "option"
|
|
4385
|
+
}
|
|
4386
|
+
},
|
|
4409
4387
|
"hasDynamicHelp": false,
|
|
4410
4388
|
"hiddenAliases": [],
|
|
4411
|
-
"id": "
|
|
4389
|
+
"id": "support",
|
|
4412
4390
|
"pluginAlias": "balena-cli",
|
|
4413
4391
|
"pluginName": "balena-cli",
|
|
4414
4392
|
"pluginType": "core",
|
|
4415
4393
|
"strict": true,
|
|
4416
4394
|
"enableJsonFlag": false,
|
|
4417
|
-
"
|
|
4395
|
+
"authenticated": true,
|
|
4418
4396
|
"isESM": false,
|
|
4419
4397
|
"relativePath": [
|
|
4420
4398
|
"build",
|
|
4421
4399
|
"commands",
|
|
4422
|
-
"
|
|
4423
|
-
"
|
|
4400
|
+
"support",
|
|
4401
|
+
"index.js"
|
|
4424
4402
|
]
|
|
4425
4403
|
},
|
|
4426
4404
|
"tag:list": {
|
|
@@ -4646,6 +4624,28 @@
|
|
|
4646
4624
|
"set.js"
|
|
4647
4625
|
]
|
|
4648
4626
|
},
|
|
4627
|
+
"util:available-drives": {
|
|
4628
|
+
"aliases": [],
|
|
4629
|
+
"args": {},
|
|
4630
|
+
"description": "List available drives.\n\nList available drives which are usable for writing an OS image to.\nDoes not list system drives.",
|
|
4631
|
+
"flags": {},
|
|
4632
|
+
"hasDynamicHelp": false,
|
|
4633
|
+
"hiddenAliases": [],
|
|
4634
|
+
"id": "util:available-drives",
|
|
4635
|
+
"pluginAlias": "balena-cli",
|
|
4636
|
+
"pluginName": "balena-cli",
|
|
4637
|
+
"pluginType": "core",
|
|
4638
|
+
"strict": true,
|
|
4639
|
+
"enableJsonFlag": false,
|
|
4640
|
+
"offlineCompatible": true,
|
|
4641
|
+
"isESM": false,
|
|
4642
|
+
"relativePath": [
|
|
4643
|
+
"build",
|
|
4644
|
+
"commands",
|
|
4645
|
+
"util",
|
|
4646
|
+
"available-drives.js"
|
|
4647
|
+
]
|
|
4648
|
+
},
|
|
4649
4649
|
"version": {
|
|
4650
4650
|
"aliases": [],
|
|
4651
4651
|
"args": {},
|
|
@@ -4716,5 +4716,5 @@
|
|
|
4716
4716
|
]
|
|
4717
4717
|
}
|
|
4718
4718
|
},
|
|
4719
|
-
"version": "22.2.
|
|
4719
|
+
"version": "22.2.1"
|
|
4720
4720
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "balena-cli",
|
|
3
|
-
"version": "22.2.
|
|
3
|
+
"version": "22.2.1",
|
|
4
4
|
"description": "The official balena Command Line Interface",
|
|
5
5
|
"main": "./build/app.js",
|
|
6
6
|
"homepage": "https://github.com/balena-io/balena-cli",
|
|
@@ -255,6 +255,6 @@
|
|
|
255
255
|
}
|
|
256
256
|
},
|
|
257
257
|
"versionist": {
|
|
258
|
-
"publishedAt": "2025-08-
|
|
258
|
+
"publishedAt": "2025-08-06T11:19:26.259Z"
|
|
259
259
|
}
|
|
260
260
|
}
|