balena-cli 23.2.9 → 23.2.10-build-renovate-apple-actions-import-codesign-certs-4-x-5c236f1de0330a023179908762a32ccbbe76c071-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.
@@ -160,56 +160,6 @@
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
- },
213
163
  "build": {
214
164
  "aliases": [],
215
165
  "args": {
@@ -412,6 +362,56 @@
412
362
  "index.js"
413
363
  ]
414
364
  },
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": {},
@@ -756,138 +756,361 @@
756
756
  "write.js"
757
757
  ]
758
758
  },
759
- "device-type:list": {
760
- "aliases": [],
761
- "args": {},
762
- "description": "List the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nList the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nBy default, only actively supported device types are listed.\nThe --all option can be used to list all device types, including those that are\nno longer supported by balena.",
763
- "examples": [
764
- "$ balena device-type list",
765
- "$ balena device-type list --all"
766
- ],
767
- "flags": {
768
- "json": {
769
- "description": "Format output as json.",
770
- "helpGroup": "GLOBAL",
771
- "name": "json",
772
- "allowNo": false,
773
- "type": "boolean"
774
- },
775
- "all": {
776
- "description": "include device types no longer supported by balena",
777
- "name": "all",
778
- "allowNo": false,
779
- "type": "boolean"
780
- }
781
- },
782
- "hasDynamicHelp": false,
783
- "hiddenAliases": [],
784
- "id": "device-type:list",
785
- "pluginAlias": "balena-cli",
786
- "pluginName": "balena-cli",
787
- "pluginType": "core",
788
- "strict": true,
789
- "enableJsonFlag": true,
790
- "isESM": false,
791
- "relativePath": [
792
- "build",
793
- "commands",
794
- "device-type",
795
- "list.js"
796
- ]
797
- },
798
- "device:deactivate": {
759
+ "deploy": {
799
760
  "aliases": [],
800
761
  "args": {
801
- "uuid": {
802
- "description": "the UUID of the device to be deactivated",
803
- "name": "uuid",
762
+ "fleet": {
763
+ "description": "fleet name or slug (preferred)",
764
+ "name": "fleet",
804
765
  "required": true
766
+ },
767
+ "image": {
768
+ "description": "the image to deploy",
769
+ "name": "image"
805
770
  }
806
771
  },
807
- "description": "Deactivate a device.\n\nDeactivate a device.\n\nNote this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` option.",
772
+ "description": "Deploy a single image or a multicontainer project to a balena fleet.\n\nUsage: `deploy <fleet> ([image] | --build [--source build-dir])`\n\nUse this command to deploy an image or a complete multicontainer project to a\nfleet, optionally building it first. The source images are searched for\n(and optionally built) using the docker daemon in your development machine or\nbalena device. (See also the `balena push` command for the option of building\nthe image in the balenaCloud build servers.)\n\nUnless an image is specified, this command will look into the current directory\n(or the one specified by --source) for a docker-compose.yml file. If one is\nfound, this command will deploy each service defined in the compose file,\nbuilding it first if an image for it doesn't exist. Image names will be looked\nup according to the scheme: `<projectName>_<serviceName>`.\n\nIf a compose file isn't found, the command will look for a Dockerfile[.template]\nfile (or alternative Dockerfile specified with the `-f` option), and if yet\nthat isn't found, it will try to generate one.\n\nTo deploy to a fleet where you are a collaborator, use fleet slug including the\norganization: `balena deploy <organization>/<fleet>`.\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",
808
773
  "examples": [
809
- "$ balena device deactivate 7cf02a6",
810
- "$ balena device deactivate 7cf02a6 --yes"
774
+ "$ balena deploy myFleet",
775
+ "$ balena deploy myorg/myfleet --build --source myBuildDir/",
776
+ "$ balena deploy myorg/myfleet --build --source myBuildDir/ --note \"this is the note for this release\"",
777
+ "$ balena deploy myorg/myfleet myRepo/myImage",
778
+ "$ balena deploy myFleet myRepo/myImage --release-tag key1 \"\" key2 \"value2 with spaces\""
811
779
  ],
812
780
  "flags": {
813
- "yes": {
814
- "char": "y",
815
- "description": "answer \"yes\" to all questions (non interactive use)",
816
- "name": "yes",
781
+ "source": {
782
+ "char": "s",
783
+ "description": "specify an alternate source directory; default is the working directory",
784
+ "name": "source",
785
+ "hasDynamicHelp": false,
786
+ "multiple": false,
787
+ "type": "option"
788
+ },
789
+ "build": {
790
+ "char": "b",
791
+ "description": "force a rebuild before deploy",
792
+ "name": "build",
817
793
  "allowNo": false,
818
794
  "type": "boolean"
819
- }
820
- },
821
- "hasDynamicHelp": false,
822
- "hiddenAliases": [],
823
- "id": "device:deactivate",
824
- "pluginAlias": "balena-cli",
825
- "pluginName": "balena-cli",
826
- "pluginType": "core",
827
- "strict": true,
828
- "enableJsonFlag": false,
829
- "authenticated": true,
830
- "isESM": false,
831
- "relativePath": [
832
- "build",
833
- "commands",
834
- "device",
835
- "deactivate.js"
836
- ]
837
- },
838
- "device:detect": {
839
- "aliases": [],
840
- "args": {},
841
- "description": "Scan for balenaOS devices on your local network.\n\nScan for balenaOS devices on your local network.\n\nThe output includes device information collected through balenaEngine for\ndevices running a development image of balenaOS. Devices running a production\nimage do not expose balenaEngine (on TCP port 2375), which is why less\ninformation is printed about them.",
842
- "examples": [
843
- "$ balena device detect",
844
- "$ balena device detect --timeout 120",
845
- "$ balena device detect --verbose"
846
- ],
847
- "flags": {
848
- "json": {
849
- "description": "Format output as json.",
850
- "helpGroup": "GLOBAL",
851
- "name": "json",
795
+ },
796
+ "nologupload": {
797
+ "description": "don't upload build logs to the dashboard with image (if building)",
798
+ "name": "nologupload",
852
799
  "allowNo": false,
853
800
  "type": "boolean"
854
801
  },
855
- "verbose": {
856
- "char": "v",
857
- "description": "display full info",
858
- "name": "verbose",
802
+ "release-tag": {
803
+ "description": "Set release tags if the image deployment is successful. Multiple\narguments may be provided, alternating tag keys and values (see examples).\nHint: Empty values may be specified with \"\" (bash, cmd.exe) or '\"\"' (PowerShell).",
804
+ "name": "release-tag",
805
+ "hasDynamicHelp": false,
806
+ "multiple": true,
807
+ "type": "option"
808
+ },
809
+ "draft": {
810
+ "description": "Deploy 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.",
811
+ "name": "draft",
859
812
  "allowNo": false,
860
813
  "type": "boolean"
861
814
  },
862
- "timeout": {
863
- "char": "t",
864
- "description": "scan timeout in seconds",
865
- "name": "timeout",
815
+ "note": {
816
+ "description": "The notes for this release",
817
+ "name": "note",
866
818
  "hasDynamicHelp": false,
867
819
  "multiple": false,
868
820
  "type": "option"
869
- }
870
- },
871
- "hasDynamicHelp": false,
872
- "hiddenAliases": [],
873
- "id": "device:detect",
874
- "pluginAlias": "balena-cli",
875
- "pluginName": "balena-cli",
876
- "pluginType": "core",
877
- "strict": true,
878
- "enableJsonFlag": true,
879
- "primary": true,
880
- "root": true,
881
- "offlineCompatible": true,
882
- "dockerInfoProperties": [
883
- "Containers",
884
- "ContainersRunning",
885
- "ContainersPaused",
886
- "ContainersStopped",
887
- "Images",
888
- "Driver",
889
- "SystemTime",
890
- "KernelVersion",
821
+ },
822
+ "emulated": {
823
+ "char": "e",
824
+ "description": "Use QEMU for ARM architecture emulation during the image build",
825
+ "name": "emulated",
826
+ "allowNo": false,
827
+ "type": "boolean"
828
+ },
829
+ "dockerfile": {
830
+ "description": "Alternative Dockerfile name/path, relative to the source folder",
831
+ "name": "dockerfile",
832
+ "hasDynamicHelp": false,
833
+ "multiple": false,
834
+ "type": "option"
835
+ },
836
+ "nologs": {
837
+ "description": "Hide the image build log output (produce less verbose output)",
838
+ "name": "nologs",
839
+ "allowNo": false,
840
+ "type": "boolean"
841
+ },
842
+ "multi-dockerignore": {
843
+ "char": "m",
844
+ "description": "Have each service use its own .dockerignore file. See \"balena help build\".",
845
+ "name": "multi-dockerignore",
846
+ "allowNo": false,
847
+ "type": "boolean"
848
+ },
849
+ "noparent-check": {
850
+ "description": "Disable project validation check of 'docker-compose.yml' file in parent folder",
851
+ "name": "noparent-check",
852
+ "allowNo": false,
853
+ "type": "boolean"
854
+ },
855
+ "registry-secrets": {
856
+ "char": "R",
857
+ "description": "Path to a YAML or JSON file with passwords for a private Docker registry",
858
+ "name": "registry-secrets",
859
+ "hasDynamicHelp": false,
860
+ "multiple": false,
861
+ "type": "option"
862
+ },
863
+ "noconvert-eol": {
864
+ "description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
865
+ "name": "noconvert-eol",
866
+ "allowNo": false,
867
+ "type": "boolean"
868
+ },
869
+ "projectName": {
870
+ "char": "n",
871
+ "description": "Name prefix for locally built images. This is the 'projectName' portion\nin 'projectName_serviceName:tag'. The default is the directory name.",
872
+ "name": "projectName",
873
+ "hasDynamicHelp": false,
874
+ "multiple": false,
875
+ "type": "option"
876
+ },
877
+ "tag": {
878
+ "char": "t",
879
+ "description": "Tag locally built Docker images. This is the 'tag' portion\nin 'projectName_serviceName:tag'. The default is 'latest'.",
880
+ "name": "tag",
881
+ "hasDynamicHelp": false,
882
+ "multiple": false,
883
+ "type": "option"
884
+ },
885
+ "buildArg": {
886
+ "char": "B",
887
+ "description": "[Deprecated] Set a build-time variable (eg. \"-B 'ARG=value'\"). Can be specified multiple times.",
888
+ "name": "buildArg",
889
+ "hasDynamicHelp": false,
890
+ "multiple": true,
891
+ "type": "option"
892
+ },
893
+ "cache-from": {
894
+ "description": "Comma-separated list (no spaces) of image names for build cache resolution. Implements the same feature as the \"docker build --cache-from\" option.",
895
+ "name": "cache-from",
896
+ "hasDynamicHelp": false,
897
+ "multiple": false,
898
+ "type": "option"
899
+ },
900
+ "nocache": {
901
+ "description": "Don't use docker layer caching when building",
902
+ "name": "nocache",
903
+ "allowNo": false,
904
+ "type": "boolean"
905
+ },
906
+ "pull": {
907
+ "description": "Pull the base images again even if they exist locally",
908
+ "name": "pull",
909
+ "allowNo": false,
910
+ "type": "boolean"
911
+ },
912
+ "squash": {
913
+ "description": "Squash newly built layers into a single new layer",
914
+ "name": "squash",
915
+ "allowNo": false,
916
+ "type": "boolean"
917
+ },
918
+ "docker": {
919
+ "char": "P",
920
+ "description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
921
+ "name": "docker",
922
+ "hasDynamicHelp": false,
923
+ "multiple": false,
924
+ "type": "option"
925
+ },
926
+ "dockerHost": {
927
+ "char": "h",
928
+ "description": "Docker daemon hostname or IP address (dev machine or balena device) ",
929
+ "name": "dockerHost",
930
+ "hasDynamicHelp": false,
931
+ "multiple": false,
932
+ "type": "option"
933
+ },
934
+ "dockerPort": {
935
+ "char": "p",
936
+ "description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
937
+ "name": "dockerPort",
938
+ "hasDynamicHelp": false,
939
+ "multiple": false,
940
+ "type": "option"
941
+ },
942
+ "ca": {
943
+ "description": "Docker host TLS certificate authority file",
944
+ "name": "ca",
945
+ "hasDynamicHelp": false,
946
+ "multiple": false,
947
+ "type": "option"
948
+ },
949
+ "cert": {
950
+ "description": "Docker host TLS certificate file",
951
+ "name": "cert",
952
+ "hasDynamicHelp": false,
953
+ "multiple": false,
954
+ "type": "option"
955
+ },
956
+ "key": {
957
+ "description": "Docker host TLS key file",
958
+ "name": "key",
959
+ "hasDynamicHelp": false,
960
+ "multiple": false,
961
+ "type": "option"
962
+ }
963
+ },
964
+ "hasDynamicHelp": false,
965
+ "hiddenAliases": [],
966
+ "id": "deploy",
967
+ "pluginAlias": "balena-cli",
968
+ "pluginName": "balena-cli",
969
+ "pluginType": "core",
970
+ "strict": true,
971
+ "enableJsonFlag": false,
972
+ "authenticated": true,
973
+ "primary": true,
974
+ "isESM": false,
975
+ "relativePath": [
976
+ "build",
977
+ "commands",
978
+ "deploy",
979
+ "index.js"
980
+ ]
981
+ },
982
+ "device-type:list": {
983
+ "aliases": [],
984
+ "args": {},
985
+ "description": "List the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nList the device types supported by balena (like 'raspberrypi3' or 'intel-nuc').\n\nBy default, only actively supported device types are listed.\nThe --all option can be used to list all device types, including those that are\nno longer supported by balena.",
986
+ "examples": [
987
+ "$ balena device-type list",
988
+ "$ balena device-type list --all"
989
+ ],
990
+ "flags": {
991
+ "json": {
992
+ "description": "Format output as json.",
993
+ "helpGroup": "GLOBAL",
994
+ "name": "json",
995
+ "allowNo": false,
996
+ "type": "boolean"
997
+ },
998
+ "all": {
999
+ "description": "include device types no longer supported by balena",
1000
+ "name": "all",
1001
+ "allowNo": false,
1002
+ "type": "boolean"
1003
+ }
1004
+ },
1005
+ "hasDynamicHelp": false,
1006
+ "hiddenAliases": [],
1007
+ "id": "device-type:list",
1008
+ "pluginAlias": "balena-cli",
1009
+ "pluginName": "balena-cli",
1010
+ "pluginType": "core",
1011
+ "strict": true,
1012
+ "enableJsonFlag": true,
1013
+ "isESM": false,
1014
+ "relativePath": [
1015
+ "build",
1016
+ "commands",
1017
+ "device-type",
1018
+ "list.js"
1019
+ ]
1020
+ },
1021
+ "device:deactivate": {
1022
+ "aliases": [],
1023
+ "args": {
1024
+ "uuid": {
1025
+ "description": "the UUID of the device to be deactivated",
1026
+ "name": "uuid",
1027
+ "required": true
1028
+ }
1029
+ },
1030
+ "description": "Deactivate a device.\n\nDeactivate a device.\n\nNote this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` option.",
1031
+ "examples": [
1032
+ "$ balena device deactivate 7cf02a6",
1033
+ "$ balena device deactivate 7cf02a6 --yes"
1034
+ ],
1035
+ "flags": {
1036
+ "yes": {
1037
+ "char": "y",
1038
+ "description": "answer \"yes\" to all questions (non interactive use)",
1039
+ "name": "yes",
1040
+ "allowNo": false,
1041
+ "type": "boolean"
1042
+ }
1043
+ },
1044
+ "hasDynamicHelp": false,
1045
+ "hiddenAliases": [],
1046
+ "id": "device:deactivate",
1047
+ "pluginAlias": "balena-cli",
1048
+ "pluginName": "balena-cli",
1049
+ "pluginType": "core",
1050
+ "strict": true,
1051
+ "enableJsonFlag": false,
1052
+ "authenticated": true,
1053
+ "isESM": false,
1054
+ "relativePath": [
1055
+ "build",
1056
+ "commands",
1057
+ "device",
1058
+ "deactivate.js"
1059
+ ]
1060
+ },
1061
+ "device:detect": {
1062
+ "aliases": [],
1063
+ "args": {},
1064
+ "description": "Scan for balenaOS devices on your local network.\n\nScan for balenaOS devices on your local network.\n\nThe output includes device information collected through balenaEngine for\ndevices running a development image of balenaOS. Devices running a production\nimage do not expose balenaEngine (on TCP port 2375), which is why less\ninformation is printed about them.",
1065
+ "examples": [
1066
+ "$ balena device detect",
1067
+ "$ balena device detect --timeout 120",
1068
+ "$ balena device detect --verbose"
1069
+ ],
1070
+ "flags": {
1071
+ "json": {
1072
+ "description": "Format output as json.",
1073
+ "helpGroup": "GLOBAL",
1074
+ "name": "json",
1075
+ "allowNo": false,
1076
+ "type": "boolean"
1077
+ },
1078
+ "verbose": {
1079
+ "char": "v",
1080
+ "description": "display full info",
1081
+ "name": "verbose",
1082
+ "allowNo": false,
1083
+ "type": "boolean"
1084
+ },
1085
+ "timeout": {
1086
+ "char": "t",
1087
+ "description": "scan timeout in seconds",
1088
+ "name": "timeout",
1089
+ "hasDynamicHelp": false,
1090
+ "multiple": false,
1091
+ "type": "option"
1092
+ }
1093
+ },
1094
+ "hasDynamicHelp": false,
1095
+ "hiddenAliases": [],
1096
+ "id": "device:detect",
1097
+ "pluginAlias": "balena-cli",
1098
+ "pluginName": "balena-cli",
1099
+ "pluginType": "core",
1100
+ "strict": true,
1101
+ "enableJsonFlag": true,
1102
+ "primary": true,
1103
+ "root": true,
1104
+ "offlineCompatible": true,
1105
+ "dockerInfoProperties": [
1106
+ "Containers",
1107
+ "ContainersRunning",
1108
+ "ContainersPaused",
1109
+ "ContainersStopped",
1110
+ "Images",
1111
+ "Driver",
1112
+ "SystemTime",
1113
+ "KernelVersion",
891
1114
  "OperatingSystem",
892
1115
  "Architecture"
893
1116
  ],
@@ -2167,353 +2390,132 @@
2167
2390
  "args": {
2168
2391
  "id": {
2169
2392
  "description": "variable's numeric database ID",
2170
- "name": "id",
2171
- "required": true
2172
- }
2173
- },
2174
- "description": "Remove a config or env var from a fleet, device or service.\n\nRemove a configuration or environment variable from a fleet, device\nor service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.\n\nInteractive confirmation is normally asked before the variable is deleted.\nThe --yes option disables this behavior.",
2175
- "examples": [
2176
- "$ balena env rm 123123",
2177
- "$ balena env rm 234234 --yes",
2178
- "$ balena env rm 345345 --config",
2179
- "$ balena env rm 456456 --service",
2180
- "$ balena env rm 567567 --device",
2181
- "$ balena env rm 678678 --device --config",
2182
- "$ balena env rm 789789 --device --service --yes"
2183
- ],
2184
- "flags": {
2185
- "config": {
2186
- "char": "c",
2187
- "description": "select a configuration variable (may be used together with the --device option)",
2188
- "exclusive": [
2189
- "service"
2190
- ],
2191
- "name": "config",
2192
- "allowNo": false,
2193
- "type": "boolean"
2194
- },
2195
- "device": {
2196
- "char": "d",
2197
- "description": "select a device-specific variable instead of a fleet variable",
2198
- "name": "device",
2199
- "allowNo": false,
2200
- "type": "boolean"
2201
- },
2202
- "service": {
2203
- "char": "s",
2204
- "description": "select a service variable (may be used together with the --device option)",
2205
- "exclusive": [
2206
- "config"
2207
- ],
2208
- "name": "service",
2209
- "allowNo": false,
2210
- "type": "boolean"
2211
- },
2212
- "yes": {
2213
- "char": "y",
2214
- "description": "do not prompt for confirmation before deleting the variable",
2215
- "name": "yes",
2216
- "allowNo": false,
2217
- "type": "boolean"
2218
- }
2219
- },
2220
- "hasDynamicHelp": false,
2221
- "hiddenAliases": [],
2222
- "id": "env:rm",
2223
- "pluginAlias": "balena-cli",
2224
- "pluginName": "balena-cli",
2225
- "pluginType": "core",
2226
- "strict": true,
2227
- "enableJsonFlag": false,
2228
- "isESM": false,
2229
- "relativePath": [
2230
- "build",
2231
- "commands",
2232
- "env",
2233
- "rm.js"
2234
- ]
2235
- },
2236
- "env:set": {
2237
- "aliases": [],
2238
- "args": {
2239
- "name": {
2240
- "description": "environment or config variable name",
2241
- "name": "name",
2242
- "required": true
2243
- },
2244
- "value": {
2245
- "description": "variable value; if omitted, use value from this process' environment",
2246
- "name": "value",
2247
- "required": false
2248
- }
2249
- },
2250
- "description": "Add or update env or config variable to fleets, devices or services.\n\nAdd or update an environment or config variable to one or more fleets, devices or\nservices, as selected by the respective command-line options. Either the\n--fleet or the --device option must be provided, and either may be be\nused alongside the --service option to define a service-specific variable.\n(A service corresponds to a Docker image/container in a microservices fleet.)\nWhen the --service option is used in conjunction with the --device option,\nthe service variable applies to the selected device only. Otherwise, it\napplies to all devices of the selected fleet. If the --service option is\nomitted, the variable applies to all services.\n\nIf VALUE is omitted, the CLI will attempt to use the value of the environment\nvariable of same name in the CLI process' environment. In this case, a warning\nmessage will be printed. Use `--quiet` to suppress it.\n\n'BALENA_' or 'RESIN_' are reserved variable name prefixes used to identify\n\"configuration variables\". Configuration variables control balena platform\nfeatures and are treated specially by balenaOS and the balena supervisor\nrunning on devices. They are also stored differently in the balenaCloud API\ndatabase. Configuration variables cannot be set for specific services,\ntherefore the --service option cannot be used when the variable name starts\nwith a reserved prefix. When defining custom fleet variables, please avoid\nthese reserved prefixes.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
2251
- "examples": [
2252
- "$ balena env set TERM --fleet MyFleet",
2253
- "$ balena env set EDITOR vim -f myorg/myfleet",
2254
- "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2",
2255
- "$ balena env set EDITOR vim --fleet MyFleet --service MyService",
2256
- "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2",
2257
- "$ balena env set EDITOR vim --device 7cf02a6",
2258
- "$ balena env set EDITOR vim --device 7cf02a6,d6f1433",
2259
- "$ balena env set EDITOR vim --device 7cf02a6 --service MyService",
2260
- "$ balena env set EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2"
2261
- ],
2262
- "flags": {
2263
- "fleet": {
2264
- "char": "f",
2265
- "description": "fleet name or slug (preferred)",
2266
- "exclusive": [
2267
- "device"
2268
- ],
2269
- "name": "fleet",
2270
- "hasDynamicHelp": false,
2271
- "multiple": false,
2272
- "type": "option"
2273
- },
2274
- "device": {
2275
- "char": "d",
2276
- "description": "device UUID",
2277
- "exclusive": [
2278
- "fleet"
2279
- ],
2280
- "name": "device",
2281
- "hasDynamicHelp": false,
2282
- "multiple": false,
2283
- "type": "option"
2284
- },
2285
- "quiet": {
2286
- "char": "q",
2287
- "description": "suppress warning messages",
2288
- "name": "quiet",
2289
- "allowNo": false,
2290
- "type": "boolean"
2291
- },
2292
- "service": {
2293
- "char": "s",
2294
- "description": "service name",
2295
- "name": "service",
2296
- "hasDynamicHelp": false,
2297
- "multiple": false,
2298
- "type": "option"
2299
- }
2300
- },
2301
- "hasDynamicHelp": false,
2302
- "hiddenAliases": [],
2303
- "id": "env:set",
2304
- "pluginAlias": "balena-cli",
2305
- "pluginName": "balena-cli",
2306
- "pluginType": "core",
2307
- "strict": false,
2308
- "enableJsonFlag": false,
2309
- "isESM": false,
2310
- "relativePath": [
2311
- "build",
2312
- "commands",
2313
- "env",
2314
- "set.js"
2315
- ]
2316
- },
2317
- "deploy": {
2318
- "aliases": [],
2319
- "args": {
2320
- "fleet": {
2321
- "description": "fleet name or slug (preferred)",
2322
- "name": "fleet",
2323
- "required": true
2324
- },
2325
- "image": {
2326
- "description": "the image to deploy",
2327
- "name": "image"
2328
- }
2329
- },
2330
- "description": "Deploy a single image or a multicontainer project to a balena fleet.\n\nUsage: `deploy <fleet> ([image] | --build [--source build-dir])`\n\nUse this command to deploy an image or a complete multicontainer project to a\nfleet, optionally building it first. The source images are searched for\n(and optionally built) using the docker daemon in your development machine or\nbalena device. (See also the `balena push` command for the option of building\nthe image in the balenaCloud build servers.)\n\nUnless an image is specified, this command will look into the current directory\n(or the one specified by --source) for a docker-compose.yml file. If one is\nfound, this command will deploy each service defined in the compose file,\nbuilding it first if an image for it doesn't exist. Image names will be looked\nup according to the scheme: `<projectName>_<serviceName>`.\n\nIf a compose file isn't found, the command will look for a Dockerfile[.template]\nfile (or alternative Dockerfile specified with the `-f` option), and if yet\nthat isn't found, it will try to generate one.\n\nTo deploy to a fleet where you are a collaborator, use fleet slug including the\norganization: `balena deploy <organization>/<fleet>`.\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",
2331
- "examples": [
2332
- "$ balena deploy myFleet",
2333
- "$ balena deploy myorg/myfleet --build --source myBuildDir/",
2334
- "$ balena deploy myorg/myfleet --build --source myBuildDir/ --note \"this is the note for this release\"",
2335
- "$ balena deploy myorg/myfleet myRepo/myImage",
2336
- "$ balena deploy myFleet myRepo/myImage --release-tag key1 \"\" key2 \"value2 with spaces\""
2337
- ],
2338
- "flags": {
2339
- "source": {
2340
- "char": "s",
2341
- "description": "specify an alternate source directory; default is the working directory",
2342
- "name": "source",
2343
- "hasDynamicHelp": false,
2344
- "multiple": false,
2345
- "type": "option"
2346
- },
2347
- "build": {
2348
- "char": "b",
2349
- "description": "force a rebuild before deploy",
2350
- "name": "build",
2351
- "allowNo": false,
2352
- "type": "boolean"
2353
- },
2354
- "nologupload": {
2355
- "description": "don't upload build logs to the dashboard with image (if building)",
2356
- "name": "nologupload",
2357
- "allowNo": false,
2358
- "type": "boolean"
2359
- },
2360
- "release-tag": {
2361
- "description": "Set release tags if the image deployment is successful. Multiple\narguments may be provided, alternating tag keys and values (see examples).\nHint: Empty values may be specified with \"\" (bash, cmd.exe) or '\"\"' (PowerShell).",
2362
- "name": "release-tag",
2363
- "hasDynamicHelp": false,
2364
- "multiple": true,
2365
- "type": "option"
2366
- },
2367
- "draft": {
2368
- "description": "Deploy 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.",
2369
- "name": "draft",
2370
- "allowNo": false,
2371
- "type": "boolean"
2372
- },
2373
- "note": {
2374
- "description": "The notes for this release",
2375
- "name": "note",
2376
- "hasDynamicHelp": false,
2377
- "multiple": false,
2378
- "type": "option"
2379
- },
2380
- "emulated": {
2381
- "char": "e",
2382
- "description": "Use QEMU for ARM architecture emulation during the image build",
2383
- "name": "emulated",
2384
- "allowNo": false,
2385
- "type": "boolean"
2386
- },
2387
- "dockerfile": {
2388
- "description": "Alternative Dockerfile name/path, relative to the source folder",
2389
- "name": "dockerfile",
2390
- "hasDynamicHelp": false,
2391
- "multiple": false,
2392
- "type": "option"
2393
- },
2394
- "nologs": {
2395
- "description": "Hide the image build log output (produce less verbose output)",
2396
- "name": "nologs",
2393
+ "name": "id",
2394
+ "required": true
2395
+ }
2396
+ },
2397
+ "description": "Remove a config or env var from a fleet, device or service.\n\nRemove a configuration or environment variable from a fleet, device\nor service, as selected by command-line options.\n\nVariables are selected by their database ID (as reported by the 'balena env list'\ncommand) and one of six database \"resource types\":\n\n- fleet environment variable\n- fleet configuration variable (--config)\n- fleet service variable (--service)\n- device environment variable (--device)\n- device configuration variable (--device --config)\n- device service variable (--device --service)\n\nThe --device option selects a device-specific variable instead of a fleet\nvariable.\n\nThe --config option selects a configuration variable. Configuration variable\nnames typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to\nconfigure balena platform features.\n\nThe --service option selects a service variable, which is an environment variable\nthat applies to a specifc service (container) in a microservices (multicontainer)\nfleet.\n\nThe --service and --config options cannot be used together, but they can be\nused alongside the --device option to select a device-specific service or\nconfiguration variable.\n\nInteractive confirmation is normally asked before the variable is deleted.\nThe --yes option disables this behavior.",
2398
+ "examples": [
2399
+ "$ balena env rm 123123",
2400
+ "$ balena env rm 234234 --yes",
2401
+ "$ balena env rm 345345 --config",
2402
+ "$ balena env rm 456456 --service",
2403
+ "$ balena env rm 567567 --device",
2404
+ "$ balena env rm 678678 --device --config",
2405
+ "$ balena env rm 789789 --device --service --yes"
2406
+ ],
2407
+ "flags": {
2408
+ "config": {
2409
+ "char": "c",
2410
+ "description": "select a configuration variable (may be used together with the --device option)",
2411
+ "exclusive": [
2412
+ "service"
2413
+ ],
2414
+ "name": "config",
2397
2415
  "allowNo": false,
2398
2416
  "type": "boolean"
2399
2417
  },
2400
- "multi-dockerignore": {
2401
- "char": "m",
2402
- "description": "Have each service use its own .dockerignore file. See \"balena help build\".",
2403
- "name": "multi-dockerignore",
2418
+ "device": {
2419
+ "char": "d",
2420
+ "description": "select a device-specific variable instead of a fleet variable",
2421
+ "name": "device",
2404
2422
  "allowNo": false,
2405
2423
  "type": "boolean"
2406
2424
  },
2407
- "noparent-check": {
2408
- "description": "Disable project validation check of 'docker-compose.yml' file in parent folder",
2409
- "name": "noparent-check",
2425
+ "service": {
2426
+ "char": "s",
2427
+ "description": "select a service variable (may be used together with the --device option)",
2428
+ "exclusive": [
2429
+ "config"
2430
+ ],
2431
+ "name": "service",
2410
2432
  "allowNo": false,
2411
2433
  "type": "boolean"
2412
2434
  },
2413
- "registry-secrets": {
2414
- "char": "R",
2415
- "description": "Path to a YAML or JSON file with passwords for a private Docker registry",
2416
- "name": "registry-secrets",
2417
- "hasDynamicHelp": false,
2418
- "multiple": false,
2419
- "type": "option"
2420
- },
2421
- "noconvert-eol": {
2422
- "description": "Don't convert line endings from CRLF (Windows format) to LF (Unix format).",
2423
- "name": "noconvert-eol",
2435
+ "yes": {
2436
+ "char": "y",
2437
+ "description": "do not prompt for confirmation before deleting the variable",
2438
+ "name": "yes",
2424
2439
  "allowNo": false,
2425
2440
  "type": "boolean"
2441
+ }
2442
+ },
2443
+ "hasDynamicHelp": false,
2444
+ "hiddenAliases": [],
2445
+ "id": "env:rm",
2446
+ "pluginAlias": "balena-cli",
2447
+ "pluginName": "balena-cli",
2448
+ "pluginType": "core",
2449
+ "strict": true,
2450
+ "enableJsonFlag": false,
2451
+ "isESM": false,
2452
+ "relativePath": [
2453
+ "build",
2454
+ "commands",
2455
+ "env",
2456
+ "rm.js"
2457
+ ]
2458
+ },
2459
+ "env:set": {
2460
+ "aliases": [],
2461
+ "args": {
2462
+ "name": {
2463
+ "description": "environment or config variable name",
2464
+ "name": "name",
2465
+ "required": true
2426
2466
  },
2427
- "projectName": {
2428
- "char": "n",
2429
- "description": "Name prefix for locally built images. This is the 'projectName' portion\nin 'projectName_serviceName:tag'. The default is the directory name.",
2430
- "name": "projectName",
2431
- "hasDynamicHelp": false,
2432
- "multiple": false,
2433
- "type": "option"
2434
- },
2435
- "tag": {
2436
- "char": "t",
2437
- "description": "Tag locally built Docker images. This is the 'tag' portion\nin 'projectName_serviceName:tag'. The default is 'latest'.",
2438
- "name": "tag",
2467
+ "value": {
2468
+ "description": "variable value; if omitted, use value from this process' environment",
2469
+ "name": "value",
2470
+ "required": false
2471
+ }
2472
+ },
2473
+ "description": "Add or update env or config variable to fleets, devices or services.\n\nAdd or update an environment or config variable to one or more fleets, devices or\nservices, as selected by the respective command-line options. Either the\n--fleet or the --device option must be provided, and either may be be\nused alongside the --service option to define a service-specific variable.\n(A service corresponds to a Docker image/container in a microservices fleet.)\nWhen the --service option is used in conjunction with the --device option,\nthe service variable applies to the selected device only. Otherwise, it\napplies to all devices of the selected fleet. If the --service option is\nomitted, the variable applies to all services.\n\nIf VALUE is omitted, the CLI will attempt to use the value of the environment\nvariable of same name in the CLI process' environment. In this case, a warning\nmessage will be printed. Use `--quiet` to suppress it.\n\n'BALENA_' or 'RESIN_' are reserved variable name prefixes used to identify\n\"configuration variables\". Configuration variables control balena platform\nfeatures and are treated specially by balenaOS and the balena supervisor\nrunning on devices. They are also stored differently in the balenaCloud API\ndatabase. Configuration variables cannot be set for specific services,\ntherefore the --service option cannot be used when the variable name starts\nwith a reserved prefix. When defining custom fleet variables, please avoid\nthese reserved prefixes.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
2474
+ "examples": [
2475
+ "$ balena env set TERM --fleet MyFleet",
2476
+ "$ balena env set EDITOR vim -f myorg/myfleet",
2477
+ "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2",
2478
+ "$ balena env set EDITOR vim --fleet MyFleet --service MyService",
2479
+ "$ balena env set EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2",
2480
+ "$ balena env set EDITOR vim --device 7cf02a6",
2481
+ "$ balena env set EDITOR vim --device 7cf02a6,d6f1433",
2482
+ "$ balena env set EDITOR vim --device 7cf02a6 --service MyService",
2483
+ "$ balena env set EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2"
2484
+ ],
2485
+ "flags": {
2486
+ "fleet": {
2487
+ "char": "f",
2488
+ "description": "fleet name or slug (preferred)",
2489
+ "exclusive": [
2490
+ "device"
2491
+ ],
2492
+ "name": "fleet",
2439
2493
  "hasDynamicHelp": false,
2440
2494
  "multiple": false,
2441
2495
  "type": "option"
2442
2496
  },
2443
- "buildArg": {
2444
- "char": "B",
2445
- "description": "[Deprecated] Set a build-time variable (eg. \"-B 'ARG=value'\"). Can be specified multiple times.",
2446
- "name": "buildArg",
2447
- "hasDynamicHelp": false,
2448
- "multiple": true,
2449
- "type": "option"
2450
- },
2451
- "cache-from": {
2452
- "description": "Comma-separated list (no spaces) of image names for build cache resolution. Implements the same feature as the \"docker build --cache-from\" option.",
2453
- "name": "cache-from",
2497
+ "device": {
2498
+ "char": "d",
2499
+ "description": "device UUID",
2500
+ "exclusive": [
2501
+ "fleet"
2502
+ ],
2503
+ "name": "device",
2454
2504
  "hasDynamicHelp": false,
2455
2505
  "multiple": false,
2456
2506
  "type": "option"
2457
2507
  },
2458
- "nocache": {
2459
- "description": "Don't use docker layer caching when building",
2460
- "name": "nocache",
2461
- "allowNo": false,
2462
- "type": "boolean"
2463
- },
2464
- "pull": {
2465
- "description": "Pull the base images again even if they exist locally",
2466
- "name": "pull",
2467
- "allowNo": false,
2468
- "type": "boolean"
2469
- },
2470
- "squash": {
2471
- "description": "Squash newly built layers into a single new layer",
2472
- "name": "squash",
2508
+ "quiet": {
2509
+ "char": "q",
2510
+ "description": "suppress warning messages",
2511
+ "name": "quiet",
2473
2512
  "allowNo": false,
2474
2513
  "type": "boolean"
2475
2514
  },
2476
- "docker": {
2477
- "char": "P",
2478
- "description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
2479
- "name": "docker",
2480
- "hasDynamicHelp": false,
2481
- "multiple": false,
2482
- "type": "option"
2483
- },
2484
- "dockerHost": {
2485
- "char": "h",
2486
- "description": "Docker daemon hostname or IP address (dev machine or balena device) ",
2487
- "name": "dockerHost",
2488
- "hasDynamicHelp": false,
2489
- "multiple": false,
2490
- "type": "option"
2491
- },
2492
- "dockerPort": {
2493
- "char": "p",
2494
- "description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
2495
- "name": "dockerPort",
2496
- "hasDynamicHelp": false,
2497
- "multiple": false,
2498
- "type": "option"
2499
- },
2500
- "ca": {
2501
- "description": "Docker host TLS certificate authority file",
2502
- "name": "ca",
2503
- "hasDynamicHelp": false,
2504
- "multiple": false,
2505
- "type": "option"
2506
- },
2507
- "cert": {
2508
- "description": "Docker host TLS certificate file",
2509
- "name": "cert",
2510
- "hasDynamicHelp": false,
2511
- "multiple": false,
2512
- "type": "option"
2513
- },
2514
- "key": {
2515
- "description": "Docker host TLS key file",
2516
- "name": "key",
2515
+ "service": {
2516
+ "char": "s",
2517
+ "description": "service name",
2518
+ "name": "service",
2517
2519
  "hasDynamicHelp": false,
2518
2520
  "multiple": false,
2519
2521
  "type": "option"
@@ -2521,20 +2523,18 @@
2521
2523
  },
2522
2524
  "hasDynamicHelp": false,
2523
2525
  "hiddenAliases": [],
2524
- "id": "deploy",
2526
+ "id": "env:set",
2525
2527
  "pluginAlias": "balena-cli",
2526
2528
  "pluginName": "balena-cli",
2527
2529
  "pluginType": "core",
2528
- "strict": true,
2530
+ "strict": false,
2529
2531
  "enableJsonFlag": false,
2530
- "authenticated": true,
2531
- "primary": true,
2532
2532
  "isESM": false,
2533
2533
  "relativePath": [
2534
2534
  "build",
2535
2535
  "commands",
2536
- "deploy",
2537
- "index.js"
2536
+ "env",
2537
+ "set.js"
2538
2538
  ]
2539
2539
  },
2540
2540
  "fleet:create": {
@@ -3531,200 +3531,70 @@
3531
3531
  },
3532
3532
  "yes": {
3533
3533
  "char": "y",
3534
- "description": "answer \"yes\" to all questions (non interactive use)",
3535
- "name": "yes",
3536
- "allowNo": false,
3537
- "type": "boolean"
3538
- }
3539
- },
3540
- "hasDynamicHelp": false,
3541
- "hiddenAliases": [],
3542
- "id": "os:initialize",
3543
- "pluginAlias": "balena-cli",
3544
- "pluginName": "balena-cli",
3545
- "pluginType": "core",
3546
- "strict": true,
3547
- "enableJsonFlag": false,
3548
- "authenticated": true,
3549
- "isESM": false,
3550
- "relativePath": [
3551
- "build",
3552
- "commands",
3553
- "os",
3554
- "initialize.js"
3555
- ]
3556
- },
3557
- "os:versions": {
3558
- "aliases": [],
3559
- "args": {
3560
- "type": {
3561
- "description": "device type",
3562
- "name": "type",
3563
- "required": true
3564
- }
3565
- },
3566
- "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/",
3567
- "examples": [
3568
- "$ balena os versions raspberrypi3"
3569
- ],
3570
- "flags": {
3571
- "esr": {
3572
- "description": "select balenaOS ESR versions",
3573
- "name": "esr",
3574
- "allowNo": false,
3575
- "type": "boolean"
3576
- },
3577
- "include-draft": {
3578
- "description": "include pre-release balenaOS versions",
3579
- "name": "include-draft",
3534
+ "description": "answer \"yes\" to all questions (non interactive use)",
3535
+ "name": "yes",
3580
3536
  "allowNo": false,
3581
3537
  "type": "boolean"
3582
3538
  }
3583
3539
  },
3584
3540
  "hasDynamicHelp": false,
3585
3541
  "hiddenAliases": [],
3586
- "id": "os:versions",
3542
+ "id": "os:initialize",
3587
3543
  "pluginAlias": "balena-cli",
3588
3544
  "pluginName": "balena-cli",
3589
3545
  "pluginType": "core",
3590
3546
  "strict": true,
3591
3547
  "enableJsonFlag": false,
3548
+ "authenticated": true,
3592
3549
  "isESM": false,
3593
3550
  "relativePath": [
3594
3551
  "build",
3595
3552
  "commands",
3596
3553
  "os",
3597
- "versions.js"
3554
+ "initialize.js"
3598
3555
  ]
3599
3556
  },
3600
- "preload": {
3557
+ "os:versions": {
3601
3558
  "aliases": [],
3602
3559
  "args": {
3603
- "image": {
3604
- "description": "the image file path",
3605
- "name": "image",
3560
+ "type": {
3561
+ "description": "device type",
3562
+ "name": "type",
3606
3563
  "required": true
3607
3564
  }
3608
3565
  },
3609
- "description": "Preload a release on a disk image (or Edison zip archive).\n\nPreload a release (service images/containers) from a balena fleet, and optionally\na balenaOS splash screen, in a previously downloaded '.img' balenaOS image file\nin the local disk (a zip file is only accepted for the Intel Edison device type).\nAfter preloading, the balenaOS image file can be flashed to a device's SD card.\nWhen the device boots, it will not need to download the release, as it was\npreloaded. This is usually combined with release pinning\n(https://www.balena.io/docs/learn/deploy/release-strategy/release-policy/)\nto avoid the device downloading a newer release straight away, if available.\nCheck also the Preloading and Preregistering section of the balena CLI's advanced\nmasterclass document:\nhttps://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-and-preregistering\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).\n\nNote that the this command requires Docker to be installed, as further detailed\nin the balena CLI's installation instructions:\nhttps://github.com/balena-io/balena-cli/blob/master/INSTALL.md\nThe `--dockerHost` and `--dockerPort` flags allow a remote Docker engine to\nbe used, however the image file must be accessible to the remote Docker engine\non the same path given on the command line. This is because Docker's bind mount\nfeature is used to \"share\" the image with a container that performs the preload.",
3566
+ "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/",
3610
3567
  "examples": [
3611
- "$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
3612
- "$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
3613
- "$ balena preload balena.img"
3568
+ "$ balena os versions raspberrypi3"
3614
3569
  ],
3615
3570
  "flags": {
3616
- "fleet": {
3617
- "char": "f",
3618
- "description": "fleet name or slug (preferred)",
3619
- "name": "fleet",
3620
- "hasDynamicHelp": false,
3621
- "multiple": false,
3622
- "type": "option"
3623
- },
3624
- "commit": {
3625
- "char": "c",
3626
- "description": "The commit hash of the release to preload. Use \"current\" to specify the current\nrelease (ignored if no appId is given). The current release is usually also the\nlatest, but can be pinned to a specific release. See:\nhttps://www.balena.io/docs/learn/deploy/release-strategy/release-policy/\nhttps://www.balena.io/docs/learn/more/masterclasses/fleet-management/#63-pin-using-the-api\nhttps://github.com/balena-io-examples/staged-releases",
3627
- "name": "commit",
3628
- "hasDynamicHelp": false,
3629
- "multiple": false,
3630
- "type": "option"
3631
- },
3632
- "splash-image": {
3633
- "char": "s",
3634
- "description": "path to a png image to replace the splash screen",
3635
- "name": "splash-image",
3636
- "hasDynamicHelp": false,
3637
- "multiple": false,
3638
- "type": "option"
3639
- },
3640
- "dont-check-arch": {
3641
- "description": "disable architecture compatibility check between image and fleet",
3642
- "name": "dont-check-arch",
3571
+ "esr": {
3572
+ "description": "select balenaOS ESR versions",
3573
+ "name": "esr",
3643
3574
  "allowNo": false,
3644
3575
  "type": "boolean"
3645
3576
  },
3646
- "pin-device-to-release": {
3647
- "char": "p",
3648
- "description": "pin the preloaded device to the preloaded release on provision",
3649
- "name": "pin-device-to-release",
3650
- "allowNo": true,
3577
+ "include-draft": {
3578
+ "description": "include pre-release balenaOS versions",
3579
+ "name": "include-draft",
3580
+ "allowNo": false,
3651
3581
  "type": "boolean"
3652
- },
3653
- "additional-space": {
3654
- "description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
3655
- "name": "additional-space",
3656
- "hasDynamicHelp": false,
3657
- "multiple": false,
3658
- "type": "option"
3659
- },
3660
- "add-certificate": {
3661
- "description": "Add the given certificate (in PEM format) to /etc/ssl/certs in the preloading container.\nThe file name must end with '.crt' and must not be already contained in the preloader's\n/etc/ssl/certs folder.\nCan be repeated to add multiple certificates.",
3662
- "name": "add-certificate",
3663
- "hasDynamicHelp": false,
3664
- "multiple": true,
3665
- "type": "option"
3666
- },
3667
- "docker": {
3668
- "char": "P",
3669
- "description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
3670
- "name": "docker",
3671
- "hasDynamicHelp": false,
3672
- "multiple": false,
3673
- "type": "option"
3674
- },
3675
- "dockerHost": {
3676
- "char": "h",
3677
- "description": "Docker daemon hostname or IP address (dev machine or balena device) ",
3678
- "name": "dockerHost",
3679
- "hasDynamicHelp": false,
3680
- "multiple": false,
3681
- "type": "option"
3682
- },
3683
- "dockerPort": {
3684
- "description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
3685
- "name": "dockerPort",
3686
- "hasDynamicHelp": false,
3687
- "multiple": false,
3688
- "type": "option"
3689
- },
3690
- "ca": {
3691
- "description": "Docker host TLS certificate authority file",
3692
- "name": "ca",
3693
- "hasDynamicHelp": false,
3694
- "multiple": false,
3695
- "type": "option"
3696
- },
3697
- "cert": {
3698
- "description": "Docker host TLS certificate file",
3699
- "name": "cert",
3700
- "hasDynamicHelp": false,
3701
- "multiple": false,
3702
- "type": "option"
3703
- },
3704
- "key": {
3705
- "description": "Docker host TLS key file",
3706
- "name": "key",
3707
- "hasDynamicHelp": false,
3708
- "multiple": false,
3709
- "type": "option"
3710
3582
  }
3711
3583
  },
3712
3584
  "hasDynamicHelp": false,
3713
3585
  "hiddenAliases": [],
3714
- "id": "preload",
3586
+ "id": "os:versions",
3715
3587
  "pluginAlias": "balena-cli",
3716
3588
  "pluginName": "balena-cli",
3717
3589
  "pluginType": "core",
3718
3590
  "strict": true,
3719
3591
  "enableJsonFlag": false,
3720
- "authenticated": true,
3721
- "primary": true,
3722
3592
  "isESM": false,
3723
3593
  "relativePath": [
3724
3594
  "build",
3725
3595
  "commands",
3726
- "preload",
3727
- "index.js"
3596
+ "os",
3597
+ "versions.js"
3728
3598
  ]
3729
3599
  },
3730
3600
  "push": {
@@ -3892,6 +3762,136 @@
3892
3762
  "index.js"
3893
3763
  ]
3894
3764
  },
3765
+ "preload": {
3766
+ "aliases": [],
3767
+ "args": {
3768
+ "image": {
3769
+ "description": "the image file path",
3770
+ "name": "image",
3771
+ "required": true
3772
+ }
3773
+ },
3774
+ "description": "Preload a release on a disk image (or Edison zip archive).\n\nPreload a release (service images/containers) from a balena fleet, and optionally\na balenaOS splash screen, in a previously downloaded '.img' balenaOS image file\nin the local disk (a zip file is only accepted for the Intel Edison device type).\nAfter preloading, the balenaOS image file can be flashed to a device's SD card.\nWhen the device boots, it will not need to download the release, as it was\npreloaded. This is usually combined with release pinning\n(https://www.balena.io/docs/learn/deploy/release-strategy/release-policy/)\nto avoid the device downloading a newer release straight away, if available.\nCheck also the Preloading and Preregistering section of the balena CLI's advanced\nmasterclass document:\nhttps://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-and-preregistering\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).\n\nNote that the this command requires Docker to be installed, as further detailed\nin the balena CLI's installation instructions:\nhttps://github.com/balena-io/balena-cli/blob/master/INSTALL.md\nThe `--dockerHost` and `--dockerPort` flags allow a remote Docker engine to\nbe used, however the image file must be accessible to the remote Docker engine\non the same path given on the command line. This is because Docker's bind mount\nfeature is used to \"share\" the image with a container that performs the preload.",
3775
+ "examples": [
3776
+ "$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
3777
+ "$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
3778
+ "$ balena preload balena.img"
3779
+ ],
3780
+ "flags": {
3781
+ "fleet": {
3782
+ "char": "f",
3783
+ "description": "fleet name or slug (preferred)",
3784
+ "name": "fleet",
3785
+ "hasDynamicHelp": false,
3786
+ "multiple": false,
3787
+ "type": "option"
3788
+ },
3789
+ "commit": {
3790
+ "char": "c",
3791
+ "description": "The commit hash of the release to preload. Use \"current\" to specify the current\nrelease (ignored if no appId is given). The current release is usually also the\nlatest, but can be pinned to a specific release. See:\nhttps://www.balena.io/docs/learn/deploy/release-strategy/release-policy/\nhttps://www.balena.io/docs/learn/more/masterclasses/fleet-management/#63-pin-using-the-api\nhttps://github.com/balena-io-examples/staged-releases",
3792
+ "name": "commit",
3793
+ "hasDynamicHelp": false,
3794
+ "multiple": false,
3795
+ "type": "option"
3796
+ },
3797
+ "splash-image": {
3798
+ "char": "s",
3799
+ "description": "path to a png image to replace the splash screen",
3800
+ "name": "splash-image",
3801
+ "hasDynamicHelp": false,
3802
+ "multiple": false,
3803
+ "type": "option"
3804
+ },
3805
+ "dont-check-arch": {
3806
+ "description": "disable architecture compatibility check between image and fleet",
3807
+ "name": "dont-check-arch",
3808
+ "allowNo": false,
3809
+ "type": "boolean"
3810
+ },
3811
+ "pin-device-to-release": {
3812
+ "char": "p",
3813
+ "description": "pin the preloaded device to the preloaded release on provision",
3814
+ "name": "pin-device-to-release",
3815
+ "allowNo": true,
3816
+ "type": "boolean"
3817
+ },
3818
+ "additional-space": {
3819
+ "description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
3820
+ "name": "additional-space",
3821
+ "hasDynamicHelp": false,
3822
+ "multiple": false,
3823
+ "type": "option"
3824
+ },
3825
+ "add-certificate": {
3826
+ "description": "Add the given certificate (in PEM format) to /etc/ssl/certs in the preloading container.\nThe file name must end with '.crt' and must not be already contained in the preloader's\n/etc/ssl/certs folder.\nCan be repeated to add multiple certificates.",
3827
+ "name": "add-certificate",
3828
+ "hasDynamicHelp": false,
3829
+ "multiple": true,
3830
+ "type": "option"
3831
+ },
3832
+ "docker": {
3833
+ "char": "P",
3834
+ "description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
3835
+ "name": "docker",
3836
+ "hasDynamicHelp": false,
3837
+ "multiple": false,
3838
+ "type": "option"
3839
+ },
3840
+ "dockerHost": {
3841
+ "char": "h",
3842
+ "description": "Docker daemon hostname or IP address (dev machine or balena device) ",
3843
+ "name": "dockerHost",
3844
+ "hasDynamicHelp": false,
3845
+ "multiple": false,
3846
+ "type": "option"
3847
+ },
3848
+ "dockerPort": {
3849
+ "description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
3850
+ "name": "dockerPort",
3851
+ "hasDynamicHelp": false,
3852
+ "multiple": false,
3853
+ "type": "option"
3854
+ },
3855
+ "ca": {
3856
+ "description": "Docker host TLS certificate authority file",
3857
+ "name": "ca",
3858
+ "hasDynamicHelp": false,
3859
+ "multiple": false,
3860
+ "type": "option"
3861
+ },
3862
+ "cert": {
3863
+ "description": "Docker host TLS certificate file",
3864
+ "name": "cert",
3865
+ "hasDynamicHelp": false,
3866
+ "multiple": false,
3867
+ "type": "option"
3868
+ },
3869
+ "key": {
3870
+ "description": "Docker host TLS key file",
3871
+ "name": "key",
3872
+ "hasDynamicHelp": false,
3873
+ "multiple": false,
3874
+ "type": "option"
3875
+ }
3876
+ },
3877
+ "hasDynamicHelp": false,
3878
+ "hiddenAliases": [],
3879
+ "id": "preload",
3880
+ "pluginAlias": "balena-cli",
3881
+ "pluginName": "balena-cli",
3882
+ "pluginType": "core",
3883
+ "strict": true,
3884
+ "enableJsonFlag": false,
3885
+ "authenticated": true,
3886
+ "primary": true,
3887
+ "isESM": false,
3888
+ "relativePath": [
3889
+ "build",
3890
+ "commands",
3891
+ "preload",
3892
+ "index.js"
3893
+ ]
3894
+ },
3895
3895
  "release:finalize": {
3896
3896
  "aliases": [],
3897
3897
  "args": {
@@ -4777,5 +4777,5 @@
4777
4777
  ]
4778
4778
  }
4779
4779
  },
4780
- "version": "23.2.9"
4780
+ "version": "23.2.10"
4781
4781
  }