Add note about global flag in advanced install.

Change-type: patch

.github/actions/publish/action.yml

@@ -18,7 +18,7 @@ inputs:
     default: 'accounts+apple@balena.io'
   NODE_VERSION:
     type: string
-    default: '20.x'
+    default: '18.x'
   VERBOSE:
     type: string
     default: 'true'
@@ -28,7 +28,7 @@ runs:
   using: 'composite'
   steps:
     - name: Download custom source artifact
-      uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+      uses: actions/download-artifact@f44cd7b40bfd40b6aa1cc1b9b5b7bf03d3c67110 # v4.1.0
       with:
         name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
         path: ${{ runner.temp }}
@@ -39,17 +39,11 @@ runs:
       run: tar -xf ${{ runner.temp }}/custom.tgz
 
     - name: Setup Node.js
-      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ inputs.NODE_VERSION }}
         cache: npm
 
-    - name: Set up Python 3.11
-      if: runner.os == 'macOS'
-      uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4
-      with:
-        python-version: "3.11"
-
     - name: Install additional tools
       if: runner.os == 'Windows'
       shell: bash
@@ -66,7 +60,7 @@ runs:
     # https://github.com/Apple-Actions/import-codesign-certs
     - name: Import Apple code signing certificate
       if: runner.os == 'macOS'
-      uses: apple-actions/import-codesign-certs@253ddeeac23f2bdad1646faac5c8c2832e800071 # v1
+      uses: apple-actions/import-codesign-certs@v1
       with:
         p12-file-base64: ${{ fromJSON(inputs.secrets).APPLE_SIGNING }}
         p12-password: ${{ fromJSON(inputs.secrets).APPLE_SIGNING_PASSWORD }}
@@ -75,11 +69,18 @@ runs:
       if: runner.os == 'Windows'
       shell: powershell
       run: |
-        Set-Content -Path ${{ runner.temp }}/certificate.base64 -Value $env:SM_CLIENT_CERT_FILE_B64
-        certutil -decode ${{ runner.temp }}/certificate.base64 ${{ runner.temp }}/Certificate_pkcs12.p12
+        Set-Content -Path ${{ runner.temp }}/certificate.base64 -Value $env:WINDOWS_CERTIFICATE
+        certutil -decode ${{ runner.temp }}/certificate.base64 ${{ runner.temp }}/certificate.pfx
         Remove-Item -path ${{ runner.temp }} -include certificate.base64
+
+        Import-PfxCertificate `
+          -FilePath ${{ runner.temp }}/certificate.pfx `
+          -CertStoreLocation Cert:\CurrentUser\My `
+          -Password (ConvertTo-SecureString -String $env:WINDOWS_CERTIFICATE_PASSWORD -Force -AsPlainText)
+
       env:
-        SM_CLIENT_CERT_FILE_B64: ${{ fromJSON(inputs.secrets).SM_CLIENT_CERT_FILE_B64 }}
+        WINDOWS_CERTIFICATE: ${{ fromJSON(inputs.secrets).WINDOWS_SIGNING }}
+        WINDOWS_CERTIFICATE_PASSWORD: ${{ fromJSON(inputs.secrets).WINDOWS_SIGNING_PASSWORD }}
 
     # https://github.com/product-os/scripts/tree/master/shared
     # https://github.com/product-os/balena-concourse/blob/master/pipelines/github-events/template.yml
@@ -99,21 +100,12 @@ runs:
             CSC_LINK=${{ fromJSON(inputs.secrets).APPLE_SIGNING }}
 
         elif [[ $runner_os =~ windows|win ]]; then
-            SM_HOST=${{ fromJSON(inputs.secrets).SM_HOST }}
-            SM_API_KEY=${{ fromJSON(inputs.secrets).SM_API_KEY }}
-            SM_CLIENT_CERT_FILE='${{ runner.temp }}\Certificate_pkcs12.p12'
-            SM_CLIENT_CERT_PASSWORD=${{ fromJSON(inputs.secrets).SM_CLIENT_CERT_PASSWORD }}
-            SM_CODE_SIGNING_CERT_SHA1_HASH=${{ fromJSON(inputs.secrets).SM_CODE_SIGNING_CERT_SHA1_HASH }}
+            CSC_KEY_PASSWORD=${{ fromJSON(inputs.secrets).WINDOWS_SIGNING_PASSWORD }}
+            CSC_LINK='${{ runner.temp }}\certificate.pfx'
 
-            curl --silent --retry 3 --fail https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download \
-              -H "x-api-key:$SM_API_KEY" \
-              -o smtools-windows-x64.msi
-            msiexec -i smtools-windows-x64.msi -qn
-            PATH="/c/Program Files/DigiCert/DigiCert One Signing Manager Tools:${PATH}"
-            smksp_registrar.exe list
-            smctl.exe keypair ls
-            /c/Windows/System32/certutil.exe -csp "DigiCert Signing Manager KSP" -key -user
-            smksp_cert_sync.exe
+            # patches/all/oclif.patch
+            MSYSSHELLPATH="$(which bash)"
+            MSYSTEM=MSYS
 
             # (signtool.exe) https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md#installed-windows-sdks
             PATH="/c/Program Files (x86)/Windows Kits/10/bin/${runner_arch}:${PATH}"
@@ -127,15 +119,15 @@ runs:
         # https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/#improvements-for-public-repository-forks
         # https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks#about-workflow-runs-from-public-forks
         CSC_FOR_PULL_REQUEST: true
-        # https://docs.digicert.com/es/software-trust-manager/ci-cd-integrations/plugins/github-custom-action-for-keypair-signing.html
-        TIMESTAMP_SERVER: http://timestamp.digicert.com
+        # https://sectigo.com/resource-library/time-stamping-server
+        TIMESTAMP_SERVER: http://timestamp.sectigo.com
         # Apple notarization (automation/build-bin.ts)
         XCODE_APP_LOADER_EMAIL: ${{ inputs.XCODE_APP_LOADER_EMAIL }}
         XCODE_APP_LOADER_PASSWORD: ${{ fromJSON(inputs.secrets).XCODE_APP_LOADER_PASSWORD }}
         XCODE_APP_LOADER_TEAM_ID: ${{ inputs.XCODE_APP_LOADER_TEAM_ID }}
 
     - name: Upload artifacts
-      uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
+      uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392 # v4
       with:
         name: gh-release-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ strategy.job-index }}
         path: dist

.github/actions/test/action.yml

@@ -15,7 +15,7 @@ inputs:
   # --- custom environment
   NODE_VERSION:
     type: string
-    default: '20.x'
+    default: '18.x'
   VERBOSE:
     type: string
     default: "true"
@@ -26,14 +26,14 @@ runs:
   steps:
     # https://github.com/actions/setup-node#caching-global-packages-data
     - name: Setup Node.js
-      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ inputs.NODE_VERSION }}
         cache: npm
 
     - name: Set up Python 3.11
       if: runner.os == 'macOS'
-      uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4
+      uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4
       with:
         python-version: "3.11"
 
@@ -58,7 +58,7 @@ runs:
       run: tar --exclude-vcs -acf ${{ runner.temp }}/custom.tgz .
 
     - name: Upload custom artifact
-      uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
+      uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392 # v4
       with:
         name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
         path: ${{ runner.temp }}/custom.tgz

.github/renovate.json

@@ -1,4 +0,0 @@
-{
-	"extends": ["github>balena-io/renovate-config"],
-	"postUpdateOptions": ["npmDedupe"]
-}

.github/workflows/flowzone.yml

@@ -21,25 +21,6 @@ jobs:
       )
     secrets: inherit
     with:
-      custom_test_matrix: >
-        {
-          "os": [
-            ["self-hosted", "X64"],
-            ["self-hosted", "ARM64"],
-            ["macos-12"],
-            ["windows-2019"],
-            ["macos-latest-xlarge"]
-          ]
-        }
-      custom_publish_matrix: >
-        {
-          "os": [
-            ["self-hosted", "X64"],
-            ["self-hosted", "ARM64"],
-            ["macos-12"],
-            ["windows-2019"],
-            ["macos-latest-xlarge"]
-          ]
-        }
+      custom_runs_on: '[["self-hosted","Linux","distro:focal","X64"],["self-hosted","Linux","distro:focal","ARM64"],["macos-12"],["windows-2019"]]'
       github_prerelease: false
       restrict_custom_actions: false

CHANGELOG.md

@@ -4,515 +4,6 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 19.0.0 - 2024-08-22
-
-* Update all references of lib to src [Otavio Jacobi]
-* Rename the lib folder to src [Otavio Jacobi]
-* Update @balena/compose to 4.0.1 Update @balena/compose from 3.2.1 to 4.0.1 [Otavio Jacobi]
-* Use standard visuals table component for fleet/s [Otavio Jacobi]
-
-## 18.2.34 - 2024-07-29
-
-* Run npm dedupe commands [Kyle Harding]
-* Switch to self-hosted [Anton Belodedenko]
-
-## 18.2.33 - 2024-07-17
-
-* Improve discover balena os across different networks [Otavio Jacobi]
-
-## 18.2.32 - 2024-07-16
-
-* Remove unused code [Otavio Jacobi]
-
-## 18.2.31 - 2024-07-15
-
-* deploy: Use the sdk's pine instance with balena-compose [Thodoris Greasidis]
-
-<details>
-<summary> Update balena-sdk to 19.7.3 [Thodoris Greasidis] </summary>
-
-> ### balena-sdk-19.7.3 - 2024-07-12
-> 
-> * pinejs-client-core: Add some missing methods to the custom typings [Thodoris Greasidis]
-> 
-
-</details>
-
-## 18.2.30 - 2024-07-15
-
-* Omit unicode control character escapes from test logs [Thodoris Greasidis]
-
-## 18.2.29 - 2024-07-12
-
-* Update balena-preload from 15.0.5 to 15.0.6 [Otavio Jacobi]
-
-## 18.2.28 - 2024-07-12
-
-* Downgrade pinejs-client-request to 7.4.2 to unblock the sdk update [Thodoris Greasidis]
-
-<details>
-<summary> Update balena-sdk to 19.7.2 [Thodoris Greasidis] </summary>
-
-> ### balena-sdk-19.7.2 - 2024-07-12
-> 
-> 
-> <details>
-> <summary> Update balena-request from 13.3.1 to 13.3.2 [Thodoris Greasidis] </summary>
-> 
->> #### balena-request-13.3.2 - 2024-07-12
->> 
->> * Fix always following redirects when followRedirect = false [Thodoris Greasidis]
->> 
-> 
-> </details>
-> 
-> 
-> ### balena-sdk-19.7.1 - 2024-07-08
-> 
-> 
-> <details>
-> <summary> Limit pinejs-client-core to ~6.14.0, to fix errors in older TypeScript [Thodoris Greasidis] </summary>
-> 
->> #### pinejs-client-js-6.14.0 - 2023-12-05
->> 
->> * Respect the Retry-After header when clients define the getRetryAfterHeader option [Thodoris Greasidis]
->> 
->> #### pinejs-client-js-6.13.0 - 2023-07-11
->> 
->> * Add support for $duration [Thodoris Greasidis]
->> 
->> #### pinejs-client-js-6.12.4 - 2023-05-09
->> 
->> * Avoid an unnecessary function creation on each get() call [Thodoris Greasidis]
->> 
->> #### pinejs-client-js-6.12.3 - 2022-12-28
->> 
->> * CI: Convert tests to TypeScript [Josh Bowling]
->> 
->> #### pinejs-client-js-6.12.2 - 2022-11-18
->> 
->> * Fix `$orderby: { a: { $count: ... }, $dir: 'asc' }` typings [Thodoris Greasidis]
->> 
->> #### pinejs-client-js-6.12.1 - 2022-11-15
->> 
->> * Update TypeScript to 4.9.3 [Thodoris Greasidis]
->> 
-> 
-> </details>
-> 
-> * Fix the TypeScript incompatibility test [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.7.0 - 2024-07-05
-> 
-> * Add identity provider & saml account model typing [Otavio Jacobi]
-> 
-> ### balena-sdk-19.6.1 - 2024-06-20
-> 
-> * Update TypeScript to 5.5.2 [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.6.0 - 2024-06-20
-> 
-> * Add the application.getAllByOrganization() method [Thodoris Greasidis]
-> * Deprecate the application.getAppByOwner() method [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.5.11 - 2024-05-28
-> 
-> * tests: Make the cleanups more precise [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.5.10 - 2024-03-29
-> 
-> * Drop the toWritable helper in favor of TypeScript's satisfies [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.5.9 - 2024-03-29
-> 
-> * os: Update the comments on why we still need to be using the release_tags [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.5.8 - 2024-03-18
-> 
-> * Fix `application.create` method being wrongly marked as deprecated [myarmolinsky]
-> 
-> ### balena-sdk-19.5.7 - 2024-03-08
-> 
-> * Fix missing underscore to describes__device property [Andrea Rosci]
-> 
-> ### balena-sdk-19.5.6 - 2024-03-07
-> 
-> * Update TypeScript to 5.4.2 [Thodoris Greasidis]
-> * device-type.getInstructions: Convert etcher link to HTTPS [Vipul Gupta (@vipulgupta2048)]
-> 
-
-</details>
-
-## 18.2.27 - 2024-07-12
-
-
-<details>
-<summary> Update balena-sdk to 19.5.5 [Thodoris Greasidis] </summary>
-
-> ### balena-sdk-19.5.5 - 2024-02-26
-> 
-> 
-> <details>
-> <summary> Update balena-auth to 6.0.1 [Thodoris Greasidis] </summary>
-> 
->> #### balena-auth-6.0.1 - 2024-02-23
->> 
->> * Update jwt-decode to v3 [Thodoris Greasidis]
->> 
->> #### balena-auth-6.0.0 - 2024-02-23
->> 
->> * Update typescript to 5.3.3 [Thodoris Greasidis]
->> * Move the sources from lib to src [Thodoris Greasidis]
->> * Update @balena/lint to v7 [Thodoris Greasidis]
->> * Stop publishing the lib folder [Thodoris Greasidis]
->> * Drop support for nodejs < 18 [Thodoris Greasidis]
->> * Drop no longer used appveyor.yml [Thodoris Greasidis]
->> 
->> #### balena-register-device-9.0.2 - 2024-02-23
->> 
->> * Update @balena/lint to v7 [Thodoris Greasidis]
->> * Update balena-request to 13.3.0 [Thodoris Greasidis]
->> 
->> #### balena-request-13.3.1 - 2024-02-23
->> 
->> * Update balena-auth to 6.0.1 [Thodoris Greasidis]
->> 
-> 
-> </details>
-> 
-> 
-> ### balena-sdk-19.5.4 - 2024-02-14
-> 
-> * Bump balena-request Update balena-request from 13.2.0 to 13.3.0 [Otávio Jacobi]
-> 
-> ### balena-sdk-19.5.3 - 2024-02-14
-> 
-> * Replace deprecated flowzone input tests_run_on [Kyle Harding]
-> 
-> ### balena-sdk-19.5.2 - 2024-02-13
-> 
-> * tests: Reformat describe & it calls to have curly braces [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.5.1 - 2024-02-02
-> 
-> * Update @balena/lint to 7.3.0 [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.5.0 - 2024-01-26
-> 
-> * types: Add the `Organization.is_using__billing_version` property [Thodoris Greasidis]
-> 
-
-</details>
-
-## 18.2.26 - 2024-07-12
-
-* Drop unused dependencies [Otavio Jacobi]
-* Move dependencies that should be dev only as devDependencies [Otavio Jacobi]
-
-## 18.2.25 - 2024-07-11
-
-* Fix complete generation intermitency [Otavio Jacobi]
-* Bump oclif to v4 [Otavio Jacobi]
-
-## 18.2.24 - 2024-07-10
-
-* Update mocha from 8.4.0 to 10.6.0 [Otavio Jacobi]
-* Override inline-source-cli with non-vulnerable dependency [Otavio Jacobi]
-
-## 18.2.23 - 2024-07-10
-
-* Replace resin-discoverable-services with bonjour-service [Otavio Jacobi]
-
-## 18.2.22 - 2024-07-10
-
-* Remove unused dependency minimatch [Otavio Jacobi]
-
-## 18.2.21 - 2024-07-09
-
-* Bump resin-discoverable-services from 2.0.4 to 2.0.5 [Otavio Jacobi]
-
-## 18.2.20 - 2024-07-05
-
-* Audit fix dependencies [Otavio Jacobi]
-
-## 18.2.19 - 2024-07-05
-
-* Remove unused package `publish-release` [myarmolinsky]
-
-## 18.2.18 - 2024-07-04
-
-* Update actions/setup-node action to v4 [Self-hosted Renovate Bot]
-
-## 18.2.17 - 2024-07-02
-
-
-<details>
-<summary> Update dependency etcher-sdk to v9.1.0 [Self-hosted Renovate Bot] </summary>
-
-> ### etcher-sdk-9.1.0 - 2024-06-13
-> 
-> * patch: etcher-sdk is not yet compatible with node22 [JOASSART Edwin]
-> * minor: allow passing custom assets to start SB protected CM4 [Edwin Joassart]
-> 
-
-</details>
-
-## 18.2.16 - 2024-07-02
-
-
-<details>
-<summary> Update dependency etcher-sdk to v9.0.11 [Self-hosted Renovate Bot] </summary>
-
-> ### etcher-sdk-9.0.11 - 2024-04-26
-> 
-> * patch: use http2 to fix issues with url source [Edwin Joassart]
-> 
-> ### etcher-sdk-9.0.10 - 2024-04-26
-> 
-> * patch: remove CI workaround [Edwin Joassart]
-> 
-> ### etcher-sdk-9.0.9 - 2024-04-24
-> 
-> * patch: add option to allow listing virtual drive on Mac [JOASSART Edwin]
-> 
-
-</details>
-
-## 18.2.15 - 2024-07-02
-
-* Update dependency event-stream to v3.3.5 [Self-hosted Renovate Bot]
-
-## 18.2.14 - 2024-07-02
-
-* Update dependency jsonwebtoken to v9 [SECURITY] [Self-hosted Renovate Bot]
-
-## 18.2.13 - 2024-07-02
-
-* Update dependency @types/prettyjson to ^0.0.33 [Self-hosted Renovate Bot]
-
-## 18.2.12 - 2024-07-02
-
-* Deduplicate dependencies [Thodoris Greasidis]
-
-## 18.2.11 - 2024-07-01
-
-* Update dependency @types/fast-levenshtein to v0.0.4 [Self-hosted Renovate Bot]
-
-## 18.2.10 - 2024-06-21
-
-* Update actions/download-artifact action to v4.1.7 [Self-hosted Renovate Bot]
-
-## 18.2.9 - 2024-06-21
-
-* Update actions/setup-python digest to 65d7f2d [Self-hosted Renovate Bot]
-
-## 18.2.8 - 2024-06-21
-
-* Update actions/upload-artifact digest to 6546280 [Self-hosted Renovate Bot]
-
-## 18.2.7 - 2024-06-21
-
-* Pin dependencies [Self-hosted Renovate Bot]
-
-## 18.2.6 - 2024-06-21
-
-* Update @oclif/core from 3.26.9 to 3.27.0 [Otavio Jacobi]
-
-## 18.2.5 - 2024-06-21
-
-* Limit @oclif/core to ~3.26 so that npm dedupe doesn't auto-bump it [Thodoris Greasidis]
-* Update TypeScript to 5.5.2 [Thodoris Greasidis]
-
-## 18.2.4 - 2024-05-17
-
-* patch: fix outdated doc for "os configure" [Edwin Joassart]
-
-## 18.2.3 - 2024-05-15
-
-* Pluralize command categories in docs [dfunckt]
-
-## 18.2.2 - 2024-04-30
-
-* Upgrade dockerode and docker-modem dependencies [Ken Bannister]
-
-## 18.2.1 - 2024-04-23
-
-* Use Actuated runners for Linux test and publish [Kyle Harding]
-
-## 18.2.0 - 2024-04-17
-
-* build: Auto-resolve the cpu arch when the --deviceType is provided [Thodoris Greasidis]
-
-## 18.1.10 - 2024-04-16
-
-* Mark node 20.6.0 as the minimum working version [Thodoris Greasidis]
-
-## 18.1.9 - 2024-04-10
-
-* Enable npm dedupe as part of Renovate postUpdateOptions [Kyle Harding]
-
-## 18.1.8 - 2024-04-09
-
-* Bump patch-package to 6.5.1 [Thodoris Greasidis]
-* npm-shrinkwrap.json: Recreate with lockfileVersion 3 [Thodoris Greasidis]
-
-## 18.1.7 - 2024-04-09
-
-
-<details>
-<summary> Update balena-preload to 15.0.5 [Thodoris Greasidis] </summary>
-
-> ### balena-preload-15.0.5 - 2024-04-09
-> 
-> * Remove unused dependencies [Otavio Jacobi]
-> 
-
-</details>
-
-## 18.1.6 - 2024-04-09
-
-* Update @oclif/core to 3.26.2 [Thodoris Greasidis]
-* Drop the keep-alive package in favor of node's setKeepAlive defaults [Thodoris Greasidis]
-* Update balena-preload to v15.0.4 [Thodoris Greasidis]
-* Update resin-cli-form to v3 [Thodoris Greasidis]
-* Update resin-cli-visuals to v2 [Thodoris Greasidis]
-* Update balena-device-init to v7.0.1 [Thodoris Greasidis]
-* Update etcher-sdk to v9.0.8 [Thodoris Greasidis]
-* Mark bin/dev & bin/run as executable [Thodoris Greasidis]
-
-## 18.1.5 - 2024-03-14
-
-* Move klaw library to dev dependency [Otavio Jacobi]
-
-## 18.1.4 - 2024-03-14
-
-* Update @balena/lint to 8.0.0 [myarmolinsky]
-
-## 18.1.3 - 2024-03-14
-
-* Use standard oclif run.js & dev.js [Otavio Jacobi]
-
-## 18.1.2 - 2024-03-13
-
-* Move macos binary signing to oclif pretarball lifecycle [Otavio Jacobi]
-
-## 18.1.1 - 2024-03-12
-
-* Remove patching tmp for windows runners [Otavio Jacobi]
-
-## 18.1.0 - 2024-03-12
-
-* Add support for macos arm64 builds [Otavio Jacobi]
-
-## 18.0.4 - 2024-03-11
-
-* Update dependencies [Otavio Jacobi]
-
-## 18.0.3 - 2024-03-11
-
-* Removes signing patches [Otavio Jacobi]
-
-## 18.0.2 - 2024-03-07
-
-* Remove no longer needed windows oclif patches [Otavio Jacobi]
-
-## 18.0.1 - 2024-03-07
-
-* Fix windows signing [Otavio Jacobi]
-
-## 18.0.0 - 2024-02-06
-
-* Update to Node 20 [Otávio Jacobi]
-
-## 17.5.1 - 2024-01-31
-
-* Fix target state construction with livepush [Felipe Lalanne]
-
-## 17.5.0 - 2024-01-23
-
-* os versions: Add the --include-draft option [Thodoris Greasidis]
-* device os-update: Add option for including pre-release versions in the list [Thodoris Greasidis]
-* device os-update: Enable updates to pre-release versions of higher base semver [Thodoris Greasidis]
-
-<details>
-<summary> Update balena-sdk to 19.4.0 [Thodoris Greasidis] </summary>
-
-> ### balena-sdk-19.4.0 - 2024-01-23
-> 
-> * Update the deviceType.getInstructions tests [Thodoris Greasidis]
-> * os.getSupportedOsUpdateVersions: Add the option to include draft releases [Thodoris Greasidis]
-> 
-> <details>
-> <summary> Enable OS Updates to pre-release versions of higher base semver [Thodoris Greasidis] </summary>
-> 
->> #### balena-hup-action-utils-6.1.0 - 2024-01-04
->> 
->> * Enable OS Updates to pre-release versions of higher base semver [Thodoris Greasidis]
->> 
->> #### balena-hup-action-utils-6.0.0 - 2023-12-20
->> 
->> * Drop support for TypeScript < 5.3.3 [Thodoris Greasidis]
->> * Drop support for node < v18 [Thodoris Greasidis]
->> * Update dependencies [Thodoris Greasidis]
->> * Move the build step from prepare to prepack [Thodoris Greasidis]
->> 
->> #### balena-hup-action-utils-5.0.1 - 2023-07-13
->> 
->> * patch: Update flowzone.yml [Kyle Harding]
->> 
-> 
-> </details>
-> 
-> * os.getAvailableOsVersions: Add the option to include draft releases [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.3.5 - 2023-12-21
-> 
-> * Update date-fns to v3 [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.3.4 - 2023-12-15
-> 
-> * types/Device: Deprecate the non-existent vpn_address property [Otávio Jacobi]
-> 
-> ### balena-sdk-19.3.3 - 2023-12-15
-> 
-> * types/Device: Deprecate the non-existent state & status_sort_index properties [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.3.2 - 2023-12-08
-> 
-> * test:fast: Run the tests ignoring any linting errors [Thodoris Greasidis]
-> * tests: Re-enable the explicit error checks for non-tarball DWB requests [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.3.1 - Invalid date
-> 
-> * Update TypeScript to 5.3.2 [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.3.0 - Invalid date
-> 
-> * tests: Remove the explicit error checks for non-tarball DWB requests [Thodoris Greasidis]
-> * tests: Properly cleanup the test orgs [Thodoris Greasidis]
-> * tests: Reduce the request batching chunk size to speed up tests [Thodoris Greasidis]
-> * Add option for configuring the request batching chunk size [Thodoris Greasidis]
-> 
-> ### balena-sdk-19.2.0 - 2023-11-13
-> 
-> * Add organization logo to organization [Otávio Jacobi]
-> 
-> ### balena-sdk-19.1.0 - 2023-11-06
-> 
-> * Add the retryRateLimitedRequests sdk option for retrying after HTTP 429s [Thodoris Greasidis]
-> 
-
-</details>
-
-## 17.4.12 - 2024-01-18
-
-* Regression described in GitHub Issue 2715; balena push hangs in local mode. [Ken Bannister]
-
-## 17.4.11 - 2024-01-05
-
-* Exclude the oclif package patch from the published files [Thodoris Greasidis]
-* Update the @oclif/core patch [Thodoris Greasidis]
-
 ## 17.4.10 - 2024-01-02
 
 * Normalize v prefixes in the --version parameter of all commands [Thodoris Greasidis]

CONTRIBUTING.md

@@ -115,9 +115,9 @@ The content sources for the auto generation of `docs/balena-cli.md` are:
 * [Selected
   sections](https://github.com/balena-io/balena-cli/blob/v12.23.0/automation/capitanodoc/capitanodoc.ts#L199-L204)
   of the README file.
-* The CLI's command documentation in source code (`src/commands/` folder), for example:
-  * `src/commands/push.ts`
-  * `src/commands/env/add.ts`
+* The CLI's command documentation in source code (`lib/commands/` folder), for example:
+  * `lib/commands/push.ts`
+  * `lib/commands/env/add.ts`
 
 The README file is manually edited, but subsections are automatically extracted for inclusion in
 `docs/balena-cli.md` by the `getCapitanoDoc()` function in
@@ -224,7 +224,7 @@ command, or by manually editing or copying files to the `node_modules` folder.
 
 Unexpected behavior may then be observed because of the CLI's use of the
 [fast-boot2](https://www.npmjs.com/package/fast-boot2) package that caches module resolution.
-`fast-boot2` is configured in `src/fast-boot.ts` to automatically invalidate the cache if
+`fast-boot2` is configured in `lib/fast-boot.ts` to automatically invalidate the cache if
 changes are made to the `package.json` or `npm-shrinkwrap.json` files, but the cache won't
 be automatically invalidated if `npm link` is used or if manual modifications are made to the
 `node_modules` folder. In this situation:

INSTALL-ADVANCED.md

@@ -40,7 +40,7 @@ By default, the CLI is installed to the following folders:
 OS  | Folders
 --- | ---
 Windows: | `C:\Program Files\balena-cli\`
-macOS:   | `/usr/local/src/balena-cli/` <br> `/usr/local/bin/balena`
+macOS:   | `/usr/local/lib/balena-cli/` <br> `/usr/local/bin/balena`
 
 ## Standalone Zip Package
 
@@ -78,8 +78,8 @@ If you are a Node.js developer, you may wish to install the balena CLI via [npm]
 The npm installation involves building native (platform-specific) binary modules, which require
 some development tools to be installed first, as follows.
 
-> **The balena CLI currently requires Node.js version ^20.6.0**
-> **Versions 21 and later are not yet fully supported.**
+> **The balena CLI currently requires Node.js version 18.**  
+> **Versions 19 and later are not yet fully supported.**
 
 ### Install development tools
 
@@ -89,7 +89,7 @@ some development tools to be installed first, as follows.
 $ sudo apt-get update && sudo apt-get -y install curl python3 git make g++
 $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
 $ . ~/.bashrc
-$ nvm install 20
+$ nvm install 18
 ```
 
 The `curl` command line above uses
@@ -106,7 +106,7 @@ recommended.
 ```sh
 $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
 $ . ~/.bashrc
-$ nvm install 20
+$ nvm install 18
 ```
 
 #### **Windows** (not WSL)
@@ -114,7 +114,7 @@ $ nvm install 20
 Install:
 
   * If you'd like the ability to switch between Node.js versions, install
-- Node.js v20 from the [Nodejs.org releases page](https://nodejs.org/en/download/releases/).
+- Node.js v18 from the [Nodejs.org releases page](https://nodejs.org/en/download/releases/).
     [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows)
     instead.
 * The [MSYS2 shell](https://www.msys2.org/), which provides `git`, `make`, `g++` and more:
@@ -141,7 +141,8 @@ $ npm install balena-cli --global --production --unsafe-perm
 ```
 
 `--unsafe-perm` is needed when `npm install` is executed as the `root` user (e.g. in a Docker
-container) in order to allow npm scripts like `postinstall` to be executed.
+container) in order to allow npm scripts like `postinstall` to be executed. The `--global` flag is needed so
+the install uses the `npm-shrinkwrap.json` lockfile when [downloading dependencies](https://docs.npmjs.com/cli/v9/configuring-npm/npm-shrinkwrap-json#description).
 
 ## Additional Dependencies
 

INSTALL-MAC.md

@@ -27,7 +27,7 @@ To update the balena CLI, repeat the steps above for the new version.
 To uninstall it, run the following command on a terminal prompt:
 
 ```text
-sudo /usr/local/src/balena-cli/bin/uninstall
+sudo /usr/local/lib/balena-cli/bin/uninstall
 ```
 
 ## Additional Dependencies

automation/build-bin.ts

@@ -15,14 +15,14 @@
  * limitations under the License.
  */
 
-import type { JsonVersions } from '../src/commands/version/index';
+import type { JsonVersions } from '../lib/commands/version/index';
 
 import { run as oclifRun } from '@oclif/core';
 import * as archiver from 'archiver';
 import * as Bluebird from 'bluebird';
-import { exec, execFile } from 'child_process';
+import { execFile } from 'child_process';
 import * as filehound from 'filehound';
-import type { Stats } from 'fs';
+import { Stats } from 'fs';
 import * as fs from 'fs-extra';
 import * as klaw from 'klaw';
 import * as path from 'path';
@@ -41,7 +41,6 @@ import {
 } from './utils';
 
 const execFileAsync = promisify(execFile);
-const execAsync = promisify(exec);
 
 export const packageJSON = loadPackageJson();
 export const version = 'v' + packageJSON.version;
@@ -61,13 +60,9 @@ const standaloneZips: PathByPlatform = {
 	win32: dPath(`balena-cli-${version}-windows-${arch}-standalone.zip`),
 };
 
-const getOclifInstallersOriginalNames = async (): Promise<PathByPlatform> => {
-	const { stdout } = await execAsync('git rev-parse --short HEAD');
-	const sha = stdout.trim();
-	return {
-		darwin: dPath('macos', `balena-${version}-${sha}-${arch}.pkg`),
-		win32: dPath('win32', `balena-${version}-${sha}-${arch}.exe`),
-	};
+const oclifInstallers: PathByPlatform = {
+	darwin: dPath('macos', `balena-${version}.pkg`),
+	win32: dPath('win32', `balena-${version}-${arch}.exe`),
 };
 
 const renamedOclifInstallers: PathByPlatform = {
@@ -160,7 +155,7 @@ ${sep}
  * messages (stdout and stderr) in order to call diffPkgOutput().
  */
 async function execPkg(...args: any[]) {
-	const { exec: pkgExec } = await import('@yao-pkg/pkg');
+	const { exec: pkgExec } = await import('pkg');
 	const outTap = new StdOutTap(true);
 	try {
 		outTap.tap();
@@ -187,10 +182,10 @@ async function execPkg(...args: any[]) {
 async function buildPkg() {
 	// https://github.com/vercel/pkg#targets
 	let targets = `linux-${arch}`;
+	// TBC: not possible to build for macOS or Windows arm64 on x64 nodes
 	if (process.platform === 'darwin') {
-		targets = `macos-${arch}`;
+		targets = `macos-x64`;
 	}
-	// TBC: not yet possible to build for Windows arm64 on x64 nodes
 	if (process.platform === 'win32') {
 		targets = `win-x64`;
 	}
@@ -326,11 +321,7 @@ async function zipPkg() {
 	});
 }
 
-export async function signFilesForNotarization() {
-	console.log('Signing files for notarization');
-	if (process.platform !== 'darwin') {
-		return;
-	}
+async function signFilesForNotarization() {
 	console.log('Deleting unneeded zip files...');
 	await new Promise((resolve, reject) => {
 		klaw('node_modules/')
@@ -430,7 +421,6 @@ export async function buildStandaloneZip() {
 }
 
 async function renameInstallerFiles() {
-	const oclifInstallers = await getOclifInstallersOriginalNames();
 	if (await fs.pathExists(oclifInstallers[process.platform])) {
 		await fs.rename(
 			oclifInstallers[process.platform],
@@ -445,20 +435,18 @@ async function renameInstallerFiles() {
  * https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe
  */
 async function signWindowsInstaller() {
-	if (process.env.SM_CODE_SIGNING_CERT_SHA1_HASH) {
+	if (process.env.CSC_LINK && process.env.CSC_KEY_PASSWORD) {
 		const exeName = renamedOclifInstallers[process.platform];
 		console.log(`Signing installer "${exeName}"`);
 		// trust ...
 		await execFileAsync('signtool.exe', [
 			'sign',
-			'-sha1',
-			process.env.SM_CODE_SIGNING_CERT_SHA1_HASH,
-			'-tr',
+			'-t',
 			process.env.TIMESTAMP_SERVER || 'http://timestamp.comodoca.com',
-			'-td',
-			'SHA256',
-			'-fd',
-			'SHA256',
+			'-f',
+			process.env.CSC_LINK,
+			'-p',
+			process.env.CSC_KEY_PASSWORD,
 			'-d',
 			`balena-cli ${version}`,
 			exeName,
@@ -503,7 +491,7 @@ export async function buildOclifInstaller() {
 	let packOpts = ['-r', ROOT];
 	if (process.platform === 'darwin') {
 		packOS = 'macos';
-		packOpts = packOpts.concat('--targets', `darwin-${arch}`);
+		packOpts = packOpts.concat('--targets', 'darwin-x64');
 	} else if (process.platform === 'win32') {
 		packOS = 'win';
 		packOpts = packOpts.concat('--targets', 'win32-x64');
@@ -519,6 +507,10 @@ export async function buildOclifInstaller() {
 			console.log(`rimraf(${dir})`);
 			await Bluebird.fromCallback((cb) => rimraf(dir, cb));
 		}
+		if (process.platform === 'darwin') {
+			console.log('Signing files for notarization...');
+			await signFilesForNotarization();
+		}
 		console.log('=======================================================');
 		console.log(`oclif ${packCmd} ${packOpts.join(' ')}`);
 		console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);

automation/capitanodoc/capitanodoc.ts

@@ -28,7 +28,7 @@ import { GlobSync } from 'glob';
  *
  * IMPORTANT
  *
- * All commands need to be stored under a folder in src/commands to maintain uniformity
+ * All commands need to be stored under a folder in lib/commands to maintain uniformity
  * Generating docs will error out if directive not followed
  * To add a custom heading for command docs, add the heading next to the folder name
  * in the `commandHeadings` dictionary.
@@ -54,15 +54,15 @@ interface Documentation {
 
 // Mapping folders names to custom headings in the docs
 const commandHeadings: { [key: string]: string } = {
-	'api-key': 'API Keys',
+	'api-key': 'API Key',
 	'api-keys': 'API Keys',
 	login: 'Authentication',
 	whoami: 'Authentication',
 	logout: 'Authentication',
-	env: 'Environment Variables',
+	env: 'Environment Variable',
 	envs: 'Environment Variables',
 	help: 'Help and Version',
-	key: 'SSH Keys',
+	key: 'SSH Key',
 	keys: 'SSH Keys',
 	orgs: 'Organizations',
 	os: 'OS',
@@ -73,12 +73,6 @@ const commandHeadings: { [key: string]: string } = {
 	build: 'Deploy',
 	join: 'Platform',
 	leave: 'Platform',
-	app: 'Apps',
-	block: 'Blocks',
-	device: 'Devices',
-	fleet: 'Fleets',
-	release: 'Releases',
-	tag: 'Tags',
 };
 
 // Fetch all available commands

automation/capitanodoc/doc-types.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { Command as OclifCommandClass } from '@oclif/core';
+import { Command as OclifCommandClass } from '@oclif/core';
 
 type OclifCommand = typeof OclifCommandClass;
 

automation/capitanodoc/index.ts

@@ -16,9 +16,9 @@
  */
 import * as path from 'path';
 import { getCapitanoDoc } from './capitanodoc';
-import type { Category, Document, OclifCommand } from './doc-types';
+import { Category, Document, OclifCommand } from './doc-types';
 import * as markdown from './markdown';
-import { stripIndent } from '../../src/utils/lazy';
+import { stripIndent } from '../../lib/utils/lazy';
 
 /**
  * Generates the markdown document (as a string) for the CLI documentation

automation/capitanodoc/markdown.ts

@@ -18,9 +18,9 @@ import { Parser } from '@oclif/core';
 import * as ent from 'ent';
 import * as _ from 'lodash';
 
-import { getManualSortCompareFunction } from '../../src/utils/helpers';
-import { capitanoizeOclifUsage } from '../../src/utils/oclif-utils';
-import type { Category, Document, OclifCommand } from './doc-types';
+import { getManualSortCompareFunction } from '../../lib/utils/helpers';
+import { capitanoizeOclifUsage } from '../../lib/utils/oclif-utils';
+import { Category, Document, OclifCommand } from './doc-types';
 
 function renderOclifCommand(command: OclifCommand): string[] {
 	const result = [`## ${ent.encode(command.usage || '')}`];

automation/capitanodoc/utils.ts

@@ -15,9 +15,41 @@
  * limitations under the License.
  */
 
+import type { OptionDefinition } from 'capitano';
+import * as ent from 'ent';
 import * as fs from 'fs';
 import * as readline from 'readline';
 
+export function getOptionPrefix(signature: string) {
+	if (signature.length > 1) {
+		return '--';
+	} else {
+		return '-';
+	}
+}
+
+export function getOptionSignature(signature: string) {
+	return `${getOptionPrefix(signature)}${signature}`;
+}
+
+export function parseCapitanoOption(option: OptionDefinition): string {
+	let result = getOptionSignature(option.signature);
+
+	if (Array.isArray(option.alias)) {
+		for (const alias of option.alias) {
+			result += `, ${getOptionSignature(alias)}`;
+		}
+	} else if (typeof option.alias === 'string') {
+		result += `, ${getOptionSignature(option.alias)}`;
+	}
+
+	if (option.parameter) {
+		result += ` <${option.parameter}>`;
+	}
+
+	return ent.encode(result);
+}
+
 export class MarkdownFileParser {
 	constructor(public mdFilePath: string) {}
 

automation/check-doc.ts

@@ -43,8 +43,8 @@ async function checkBuildTimestamps() {
 		...gitStatus.staged,
 		...gitStatus.renamed.map((o) => o.to),
 	])
-		// select only staged files that start with src/ or typings/
-		.filter((f) => f.match(/^(src|typings)[/\\]/))
+		// select only staged files that start with lib/ or typings/
+		.filter((f) => f.match(/^(lib|typings)[/\\]/))
 		.map((f) => path.join(ROOT, f));
 
 	const fStats = await Promise.all(stagedFiles.map((f) => fs.stat(f)));

automation/deploy-bin.ts

@@ -15,11 +15,49 @@
  * limitations under the License.
  */
 
+import * as Bluebird from 'bluebird';
 import * as _ from 'lodash';
 import * as semver from 'semver';
 
+import { finalReleaseAssets, version } from './build-bin';
+
 const { GITHUB_TOKEN } = process.env;
 
+/**
+ * Create or update a release in GitHub's releases page, uploading the
+ * installer files (standalone zip + native oclif installers).
+ */
+export async function createGitHubRelease() {
+	console.log(`Publishing release ${version} to GitHub`);
+	const publishRelease = await import('publish-release');
+	const ghRelease = (await Bluebird.fromCallback(
+		publishRelease.bind(null, {
+			token: GITHUB_TOKEN || '',
+			owner: 'balena-io',
+			repo: 'balena-cli',
+			tag: version,
+			name: `balena-CLI ${version}`,
+			reuseRelease: true,
+			assets: finalReleaseAssets[process.platform],
+		}),
+	)) as { html_url: any };
+	console.log(`Release ${version} successful: ${ghRelease.html_url}`);
+}
+
+/**
+ * Top-level function to create a CLI release in GitHub's releases page:
+ * call zipStandaloneInstaller(), rename the files as we'd like them to
+ * display on the releases page, and call createGitHubRelease() to upload
+ * the files.
+ */
+export async function release() {
+	try {
+		await createGitHubRelease();
+	} catch (err) {
+		throw new Error(`Error creating GitHub release:\n${err}`);
+	}
+}
+
 /** Return a cached Octokit instance, creating a new one as needed. */
 const getOctokit = _.once(function () {
 	const Octokit = (

automation/run.ts

@@ -21,10 +21,12 @@ import {
 	buildOclifInstaller,
 	buildStandaloneZip,
 	catchUncommitted,
-	signFilesForNotarization,
 	testShrinkwrap,
 } from './build-bin';
-import { updateDescriptionOfReleasesAffectedByIssue1359 } from './deploy-bin';
+import {
+	release,
+	updateDescriptionOfReleasesAffectedByIssue1359,
+} from './deploy-bin';
 
 // DEBUG set to falsy for negative values else is truthy
 process.env.DEBUG = ['0', 'no', 'false', '', undefined].includes(
@@ -38,6 +40,7 @@ process.env.DEBUG = ['0', 'no', 'false', '', undefined].includes(
  * of the following strings, then call the appropriate functions:
  *     'build:installer'   (to build a native oclif installer)
  * 	   'build:standalone'  (to build a standalone pkg package)
+ *     'release'           (to create/update a GitHub release)
  *
  * @param args Arguments to parse (default is process.argv.slice(2))
  */
@@ -51,10 +54,10 @@ async function parse(args?: string[]) {
 	const commands: { [cmd: string]: () => void | Promise<void> } = {
 		'build:installer': buildOclifInstaller,
 		'build:standalone': buildStandaloneZip,
-		'sign:binaries': signFilesForNotarization,
 		'catch-uncommitted': catchUncommitted,
 		'test-shrinkwrap': testShrinkwrap,
 		fix1359: updateDescriptionOfReleasesAffectedByIssue1359,
+		release,
 	};
 	for (const arg of args) {
 		if (!Object.hasOwn(commands, arg)) {
@@ -62,6 +65,21 @@ async function parse(args?: string[]) {
 		}
 	}
 
+	// The BUILD_TMP env var is used as an alternative location for oclif
+	// (patched) to copy/extract the CLI files, run npm install and then
+	// create the NSIS executable installer for Windows. This was necessary
+	// to avoid issues with a 260-char limit on Windows paths (possibly a
+	// limitation of some library used by NSIS), as the "current working dir"
+	// provided by balena CI is a rather long path to start with.
+	if (process.platform === 'win32' && !process.env.BUILD_TMP) {
+		const randID = (await import('crypto'))
+			.randomBytes(6)
+			.toString('base64')
+			.replace(/\+/g, '-')
+			.replace(/\//g, '_'); // base64url (RFC 4648)
+		process.env.BUILD_TMP = `C:\\tmp\\${randID}`;
+	}
+
 	for (const arg of args) {
 		try {
 			const cmdFunc = commands[arg];

automation/update-module.ts

@@ -107,11 +107,11 @@ async function $main() {
 
 	const changeType = process.argv[4]
 		? // if the caller specified a change type, use that one
-			validateChangeType(process.argv[4])
+		  validateChangeType(process.argv[4])
 		: // use the same change type as in the dependency, but avoid major bumps
-			semverChangeType && semverChangeType !== 'major'
-			? semverChangeType
-			: 'minor';
+		semverChangeType && semverChangeType !== 'major'
+		? semverChangeType
+		: 'minor';
 	console.log(`Using Change-type: ${changeType}`);
 
 	let { stdout: currentBranch } = await run('git rev-parse --abbrev-ref HEAD');

automation/utils.ts

@@ -76,8 +76,8 @@ export function diffLines(str1: string, str2: string): string {
 			return part.added
 				? prefix(part.value, '+')
 				: part.removed
-					? prefix(part.value, '-')
-					: prefix(part.value, ' ');
+				? prefix(part.value, '-')
+				: prefix(part.value, ' ');
 		})
 		.join('\n');
 	return diffStr;

bin/balena

@@ -1 +0,0 @@
-run.js

bin/balena

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+// We boost the threadpool size as ext2fs can deadlock with some
+// operations otherwise, if the pool runs out.
+process.env.UV_THREADPOOL_SIZE = '64';
+
+// Disable oclif registering ts-node
+process.env.OCLIF_TS_NODE = 0;
+
+async function run() {
+	// Use fast-boot to cache require lookups, speeding up startup
+	await require('../build/fast-boot').start();
+
+	// Set the desired es version for downstream modules that support it
+	require('@balena/es-version').set('es2018');
+
+	// Run the CLI
+	await require('../build/app').run(undefined, { dir: __dirname });
+}
+
+run();

bin/balena-dev

@@ -1 +0,0 @@
-dev.js

bin/balena-dev

@@ -0,0 +1,87 @@
+#!/usr/bin/env node
+
+// ****************************************************************************
+// THIS IS FOR DEV PURPOSES ONLY AND WILL NOT BE PART OF THE PUBLISHED PACKAGE
+// Before opening a PR you should build and test your changes using bin/balena
+// ****************************************************************************
+
+// We boost the threadpool size as ext2fs can deadlock with some
+// operations otherwise, if the pool runs out.
+process.env.UV_THREADPOOL_SIZE = '64';
+
+// Note on `fast-boot2`: We do not use `fast-boot2` with `balena-dev` because:
+// * fast-boot2's cacheKiller option is configured to include the timestamps of
+//   the package.json and npm-shrinkwrap.json files, to avoid unexpected CLI
+//   behavior when changes are made to dependencies during development. This is
+//   generally a good thing, however, `balena-dev` (a few lines below) edits
+//   `package.json` to modify oclif paths, and this results in cache
+//   invalidation and a performance hit rather than speedup.
+// * Even if the timestamps are removed from cacheKiller, so that there is no
+//   cache invalidation, fast-boot's speedup is barely noticeable when ts-node
+//   is used, e.g. 1.43s vs 1.4s when running `balena version`.
+// * `fast-boot` causes unexpected behavior when used with `npm link` or
+//   when the `node_modules` folder is manually modified (affecting transitive
+//   dependencies) during development (e.g. bug investigations). A workaround
+//   is to use `balena-dev` without `fast-boot`. See also notes in
+//   `CONTRIBUTING.md`.
+
+const path = require('path');
+const rootDir = path.join(__dirname, '..');
+
+// Allow balena-dev to work with oclif by temporarily
+// pointing oclif config options to lib/ instead of build/
+modifyOclifPaths();
+// Undo changes on exit
+process.on('exit', function () {
+	modifyOclifPaths(true);
+});
+// Undo changes in case of ctrl-c
+process.on('SIGINT', function () {
+	modifyOclifPaths(true);
+	// Note process exit here will interfere with commands that do their own SIGINT handling,
+	// but without it commands can not be exited.
+	// So currently using balena-dev does not guarantee proper exit behaviour when using ctrl-c.
+	// Ideally a better solution is needed.
+	process.exit();
+});
+
+// Set the desired es version for downstream modules that support it
+require('@balena/es-version').set('es2018');
+
+// Note: before ts-node v6.0.0, 'transpile-only' (no type checking) was the
+// default option. We upgraded ts-node and found that adding 'transpile-only'
+// was necessary to avoid a mysterious 'null' error message. On the plus side,
+// it is supposed to run faster. We still benefit from type checking when
+// running 'npm run build'.
+require('ts-node').register({
+	project: path.join(rootDir, 'tsconfig.json'),
+	transpileOnly: true,
+});
+require('../lib/app').run(undefined, { dir: __dirname, development: true });
+
+// Modify package.json oclif paths from build/ -> lib/, or vice versa
+function modifyOclifPaths(revert) {
+	const fs = require('fs');
+	const packageJsonPath = path.join(rootDir, 'package.json');
+
+	const packageJson = fs.readFileSync(packageJsonPath, 'utf8');
+	const packageObj = JSON.parse(packageJson);
+
+	if (!packageObj.oclif) {
+		return;
+	}
+
+	let oclifSectionText = JSON.stringify(packageObj.oclif);
+	if (!revert) {
+		oclifSectionText = oclifSectionText.replace(/\/build\//g, '/lib/');
+	} else {
+		oclifSectionText = oclifSectionText.replace(/\/lib\//g, '/build/');
+	}
+
+	packageObj.oclif = JSON.parse(oclifSectionText);
+	fs.writeFileSync(
+		packageJsonPath,
+		`${JSON.stringify(packageObj, null, 2)}\n`,
+		'utf8',
+	);
+}

bin/dev.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*

bin/dev.js

@@ -1,87 +0,0 @@
-#!/usr/bin/env node
-
-// ****************************************************************************
-// THIS IS FOR DEV PURPOSES ONLY AND WILL NOT BE PART OF THE PUBLISHED PACKAGE
-// Before opening a PR you should build and test your changes using bin/balena
-// ****************************************************************************
-
-// We boost the threadpool size as ext2fs can deadlock with some
-// operations otherwise, if the pool runs out.
-process.env.UV_THREADPOOL_SIZE = '64';
-
-// Note on `fast-boot2`: We do not use `fast-boot2` with `balena-dev` because:
-// * fast-boot2's cacheKiller option is configured to include the timestamps of
-//   the package.json and npm-shrinkwrap.json files, to avoid unexpected CLI
-//   behavior when changes are made to dependencies during development. This is
-//   generally a good thing, however, `balena-dev` (a few lines below) edits
-//   `package.json` to modify oclif paths, and this results in cache
-//   invalidation and a performance hit rather than speedup.
-// * Even if the timestamps are removed from cacheKiller, so that there is no
-//   cache invalidation, fast-boot's speedup is barely noticeable when ts-node
-//   is used, e.g. 1.43s vs 1.4s when running `balena version`.
-// * `fast-boot` causes unexpected behavior when used with `npm link` or
-//   when the `node_modules` folder is manually modified (affecting transitive
-//   dependencies) during development (e.g. bug investigations). A workaround
-//   is to use `balena-dev` without `fast-boot`. See also notes in
-//   `CONTRIBUTING.md`.
-
-const path = require('path');
-const rootDir = path.join(__dirname, '..');
-
-// Allow balena-dev to work with oclif by temporarily
-// pointing oclif config options to src/ instead of build/
-modifyOclifPaths();
-// Undo changes on exit
-process.on('exit', function () {
-	modifyOclifPaths(true);
-});
-// Undo changes in case of ctrl-c
-process.on('SIGINT', function () {
-	modifyOclifPaths(true);
-	// Note process exit here will interfere with commands that do their own SIGINT handling,
-	// but without it commands can not be exited.
-	// So currently using balena-dev does not guarantee proper exit behaviour when using ctrl-c.
-	// Ideally a better solution is needed.
-	process.exit();
-});
-
-// Set the desired es version for downstream modules that support it
-require('@balena/es-version').set('es2018');
-
-// Note: before ts-node v6.0.0, 'transpile-only' (no type checking) was the
-// default option. We upgraded ts-node and found that adding 'transpile-only'
-// was necessary to avoid a mysterious 'null' error message. On the plus side,
-// it is supposed to run faster. We still benefit from type checking when
-// running 'npm run build'.
-require('ts-node').register({
-	project: path.join(rootDir, 'tsconfig.json'),
-	transpileOnly: true,
-});
-require('../src/app').run(undefined, { dir: __dirname, development: true });
-
-// Modify package.json oclif paths from build/ -> src/, or vice versa
-function modifyOclifPaths(revert) {
-	const fs = require('fs');
-	const packageJsonPath = path.join(rootDir, 'package.json');
-
-	const packageJson = fs.readFileSync(packageJsonPath, 'utf8');
-	const packageObj = JSON.parse(packageJson);
-
-	if (!packageObj.oclif) {
-		return;
-	}
-
-	let oclifSectionText = JSON.stringify(packageObj.oclif);
-	if (!revert) {
-		oclifSectionText = oclifSectionText.replace(/\/build\//g, '/src/');
-	} else {
-		oclifSectionText = oclifSectionText.replace(/\/src\//g, '/build/');
-	}
-
-	packageObj.oclif = JSON.parse(oclifSectionText);
-	fs.writeFileSync(
-		packageJsonPath,
-		`${JSON.stringify(packageObj, null, 2)}\n`,
-		'utf8',
-	);
-}

bin/run.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*

bin/run.js

@@ -1,21 +0,0 @@
-#!/usr/bin/env node
-
-// We boost the threadpool size as ext2fs can deadlock with some
-// operations otherwise, if the pool runs out.
-process.env.UV_THREADPOOL_SIZE = '64';
-
-// Disable oclif registering ts-node
-process.env.OCLIF_TS_NODE = 0;
-
-async function run() {
-	// Use fast-boot to cache require lookups, speeding up startup
-	await require('../build/fast-boot').start();
-
-	// Set the desired es version for downstream modules that support it
-	require('@balena/es-version').set('es2018');
-
-	// Run the CLI
-	await require('../build/app').run(undefined, { dir: __dirname });
-}
-
-run();

completion/_balena

@@ -8,7 +8,7 @@ _balena() {
   local context state line curcontext="$curcontext"
 
   # Valid top-level completions
-  main_commands=( api-key api-keys app block build config deploy device devices env envs fleet fleets internal join key keys leave local login logout logs notes orgs os preload push release releases scan settings ssh support tag tags tunnel util version whoami )
+  main_commands=( api-key api-keys app block build config deploy device device devices env envs fleet fleet fleets internal join key key keys leave local login logout logs notes orgs os preload push release release releases scan settings ssh support tag tags tunnel util version whoami )
   # Sub-completions
   api_key_cmds=( generate revoke )
   app_cmds=( create )

completion/balena-completion.bash

@@ -7,7 +7,7 @@ _balena_complete()
   local cur prev
 
   # Valid top-level completions
-  main_commands="api-key api-keys app block build config deploy device devices env envs fleet fleets internal join key keys leave local login logout logs notes orgs os preload push release releases scan settings ssh support tag tags tunnel util version whoami"
+  main_commands="api-key api-keys app block build config deploy device device devices env envs fleet fleet fleets internal join key key keys leave local login logout logs notes orgs os preload push release release releases scan settings ssh support tag tags tunnel util version whoami"
   # Sub-completions
   api_key_cmds="generate revoke"
   app_cmds="create"

completion/generate-completion.js

@@ -33,7 +33,7 @@ const commandsJson = JSON.parse(fs.readFileSync(commandsFilePath, 'utf8'));
 
 const mainCommands = [];
 const additionalCommands = [];
-for (const key of Object.keys(commandsJson.commands).sort()) {
+for (const key of Object.keys(commandsJson.commands)) {
 	const cmd = key.split(':');
 	if (cmd.length > 1) {
 		additionalCommands.push(cmd);

docs/balena-cli.md

@@ -160,13 +160,16 @@ are encouraged to regularly update the balena CLI to the latest version.
 
 # CLI Command Reference
 
-- API Keys
+- API Key
 
 	- [api-key generate <name>](#api-key-generate-name)
 	- [api-key revoke <ids>](#api-key-revoke-ids)
+
+- API Keys
+
 	- [api-keys](#api-keys)
 
-- Apps
+- App
 
 	- [app create <name>](#app-create-name)
 
@@ -176,7 +179,7 @@ are encouraged to regularly update the balena CLI to the latest version.
 	- [logout](#logout)
 	- [whoami](#whoami)
 
-- Blocks
+- Block
 
 	- [block create <name>](#block-create-name)
 
@@ -193,7 +196,7 @@ are encouraged to regularly update the balena CLI to the latest version.
 	- [build [source]](#build-source)
 	- [deploy <fleet> [image]](#deploy-fleet-image)
 
-- Devices
+- Device
 
 	- [device deactivate <uuid>](#device-deactivate-uuid)
 	- [device identify <uuid>](#device-identify-uuid)
@@ -214,17 +217,23 @@ are encouraged to regularly update the balena CLI to the latest version.
 	- [device start-service <uuid>](#device-start-service-uuid)
 	- [device stop-service <uuid>](#device-stop-service-uuid)
 	- [device track-fleet <uuid>](#device-track-fleet-uuid)
+
+- Devices
+
 	- [devices](#devices)
 	- [devices supported](#devices-supported)
 
+- Environment Variable
+
+	- [env add <name> [value]](#env-add-name-value)
+	- [env rename <id> <value>](#env-rename-id-value)
+	- [env rm <id>](#env-rm-id)
+
 - Environment Variables
 
 	- [envs](#envs)
-	- [env rm <id>](#env-rm-id)
-	- [env add <name> [value]](#env-add-name-value)
-	- [env rename <id> <value>](#env-rename-id-value)
 
-- Fleets
+- Fleet
 
 	- [fleet create <name>](#fleet-create-name)
 	- [fleet <fleet>](#fleet-fleet)
@@ -234,6 +243,9 @@ are encouraged to regularly update the balena CLI to the latest version.
 	- [fleet restart <fleet>](#fleet-restart-fleet)
 	- [fleet rm <fleet>](#fleet-rm-fleet)
 	- [fleet track-latest <slug>](#fleet-track-latest-slug)
+
+- Fleets
+
 	- [fleets](#fleets)
 
 - Local
@@ -280,33 +292,42 @@ are encouraged to regularly update the balena CLI to the latest version.
 
 	- [push <fleetordevice>](#push-fleetordevice)
 
-- Releases
+- Release
 
 	- [release finalize <commitorid>](#release-finalize-commitorid)
 	- [release <commitorid>](#release-commitorid)
 	- [release invalidate <commitorid>](#release-invalidate-commitorid)
 	- [release validate <commitorid>](#release-validate-commitorid)
+
+- Releases
+
 	- [releases <fleet>](#releases-fleet)
 
 - Settings
 
 	- [settings](#settings)
 
-- SSH Keys
+- SSH Key
 
 	- [key add <name> [path]](#key-add-name-path)
 	- [key <id>](#key-id)
 	- [key rm <id>](#key-rm-id)
+
+- SSH Keys
+
 	- [keys](#keys)
 
 - Support
 
 	- [support <action>](#support-action)
 
-- Tags
+- Tag
 
 	- [tag rm <tagkey>](#tag-rm-tagkey)
 	- [tag set <tagkey> [value]](#tag-set-tagkey-value)
+
+- Tags
+
 	- [tags](#tags)
 
 - Utilities
@@ -317,7 +338,7 @@ are encouraged to regularly update the balena CLI to the latest version.
 
 	- [version](#version)
 
-# API Keys
+# API Key
 
 ## api-key generate <name>
 
@@ -359,6 +380,8 @@ the API key ids
 
 ### Options
 
+# API Keys
+
 ## api-keys
 
 Print a list of balenaCloud API keys.
@@ -379,7 +402,7 @@ show API keys for your user
 
 fleet name or slug (preferred)
 
-# Apps
+# App
 
 ## app create <name>
 
@@ -501,7 +524,7 @@ Examples:
 
 	$ balena whoami
 
-# Blocks
+# Block
 
 ## block create <name>
 
@@ -859,7 +882,6 @@ Examples:
 
 	$ balena build --fleet myFleet
 	$ balena build ./source/ --fleet myorg/myfleet
-	$ balena build --deviceType raspberrypi3 --emulated
 	$ balena build --deviceType raspberrypi3 --arch armv7hf --emulated
 	$ balena build --docker /var/run/docker.sock --fleet myFleet   # Linux, Mac
 	$ balena build --docker //./pipe/docker_engine --fleet myFleet # Windows
@@ -1192,7 +1214,7 @@ Docker host TLS certificate file
 
 Docker host TLS key file
 
-# Devices
+# Device
 
 ## device deactivate <uuid>
 
@@ -1432,7 +1454,6 @@ Examples:
 	$ balena device os-update 23c73a1
 	$ balena device os-update 23c73a1 --version 2.101.7
 	$ balena device os-update 23c73a1 --version 2.31.0+rev1.prod
-	$ balena device os-update 23c73a1 --include-draft
 
 ### Arguments
 
@@ -1446,10 +1467,6 @@ the uuid of the device to update
 
 a balenaOS version
 
-#### --include-draft
-
-include pre-release balenaOS versions
-
 #### -y, --yes
 
 answer "yes" to all questions (non interactive use)
@@ -1752,6 +1769,8 @@ the uuid of the device to make track the fleet's release
 
 ### Options
 
+# Devices
+
 ## devices
 
 List all of your devices.
@@ -1811,149 +1830,7 @@ Examples:
 
 produce JSON output instead of tabular output
 
-# Environment Variables
-
-## envs
-
-List the environment or configuration variables of a fleet, device or
-service, as selected by the respective command-line options. (A service
-corresponds to a Docker image/container in a microservices fleet.)
-
-The results include fleet-wide (multiple devices), device-specific (multiple
-services on a specific device) and service-specific variables that apply to the
-selected fleet, device or service. It can be thought of as including inherited
-variables; for example, a service inherits device-wide variables, and a device
-inherits fleet-wide variables.
-
-The printed output may include DEVICE and/or SERVICE columns to distinguish
-between fleet-wide, device-specific and service-specific variables.
-An asterisk in these columns indicates that the variable applies to
-"all devices" or "all services".
-
-The --config option is used to list "configuration variables" that control
-balena platform features, as opposed to custom environment variables defined
-by the user. The --config and the --service options are mutually exclusive
-because configuration variables cannot be set for specific services.
-
-The --json option is recommended when scripting the output of this command,
-because the JSON format is less likely to change and it better represents data
-types like lists and empty strings. The 'jq' utility may be helpful in shell
-scripts (https://stedolan.github.io/jq/manual/). When --json is used, an empty
-JSON array ([]) is printed instead of an error message when no variables exist
-for the given query. When querying variables for a device, note that the fleet
-name may be null in JSON output (or 'N/A' in tabular output) if the fleet that
-the device belonged to is no longer accessible by the current user (for example,
-in case the current user was removed from the fleet by the fleet's owner).
-
-Fleets may be specified by fleet name or slug. Fleet slugs are
-the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
-fleet is renamed. Fleet names are not unique and may result in  "Fleet is
-ambiguous" errors at any time (even if it "used to work in the past"), for
-example if the name clashes with a newly created public fleet, or with fleets
-from other balena accounts that you may be invited to join under any role.
-For this reason, fleet names are especially discouraged in scripts (e.g. CI
-environments).
-
-Examples:
-
-	$ balena envs --fleet myorg/myfleet
-	$ balena envs --fleet MyFleet --json
-	$ balena envs --fleet MyFleet --service MyService
-	$ balena envs --fleet MyFleet --config
-	$ balena envs --device 7cf02a6
-	$ balena envs --device 7cf02a6 --json
-	$ balena envs --device 7cf02a6 --config --json
-	$ balena envs --device 7cf02a6 --service MyService
-
-### Options
-
-#### -f, --fleet FLEET
-
-fleet name or slug (preferred)
-
-#### -c, --config
-
-show configuration variables only
-
-#### -d, --device DEVICE
-
-device UUID
-
-#### -j, --json
-
-produce JSON output instead of tabular output
-
-#### -s, --service SERVICE
-
-service name
-
-## env rm <id>
-
-Remove a configuration or environment variable from a fleet, device
-or service, as selected by command-line options.
-
-Variables are selected by their database ID (as reported by the 'balena envs'
-command) and one of six database "resource types":
-
-- fleet environment variable
-- fleet configuration variable (--config)
-- fleet service variable (--service)
-- device environment variable (--device)
-- device configuration variable (--device --config)
-- device service variable (--device --service)
-
-The --device option selects a device-specific variable instead of a fleet
-variable.
-
-The --config option selects a configuration variable. Configuration variable
-names typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to
-configure balena platform features.
-
-The --service option selects a service variable, which is an environment variable
-that applies to a specifc service (container) in a microservices (multicontainer)
-fleet.
-
-The --service and --config options cannot be used together, but they can be
-used alongside the --device option to select a device-specific service or
-configuration variable.
-
-Interactive confirmation is normally asked before the variable is deleted.
-The --yes option disables this behavior.
-
-Examples:
-
-	$ balena env rm 123123
-	$ balena env rm 234234 --yes
-	$ balena env rm 345345 --config
-	$ balena env rm 456456 --service
-	$ balena env rm 567567 --device
-	$ balena env rm 678678 --device --config
-	$ balena env rm 789789 --device --service --yes
-
-### Arguments
-
-#### ID
-
-variable's numeric database ID
-
-### Options
-
-#### -c, --config
-
-select a configuration variable (may be used together with the --device option)
-
-#### -d, --device
-
-select a device-specific variable instead of a fleet variable
-
-#### -s, --service
-
-select a service variable (may be used together with the --device option)
-
-#### -y, --yes
-
-do not prompt for confirmation before deleting the variable
+# Environment Variable
 
 ## env add <name> [value]
 
@@ -2093,7 +1970,151 @@ select a device-specific variable instead of a fleet variable
 
 select a service variable (may be used together with the --device option)
 
-# Fleets
+## env rm <id>
+
+Remove a configuration or environment variable from a fleet, device
+or service, as selected by command-line options.
+
+Variables are selected by their database ID (as reported by the 'balena envs'
+command) and one of six database "resource types":
+
+- fleet environment variable
+- fleet configuration variable (--config)
+- fleet service variable (--service)
+- device environment variable (--device)
+- device configuration variable (--device --config)
+- device service variable (--device --service)
+
+The --device option selects a device-specific variable instead of a fleet
+variable.
+
+The --config option selects a configuration variable. Configuration variable
+names typically start with the 'BALENA_' or 'RESIN_' prefixes and are used to
+configure balena platform features.
+
+The --service option selects a service variable, which is an environment variable
+that applies to a specifc service (container) in a microservices (multicontainer)
+fleet.
+
+The --service and --config options cannot be used together, but they can be
+used alongside the --device option to select a device-specific service or
+configuration variable.
+
+Interactive confirmation is normally asked before the variable is deleted.
+The --yes option disables this behavior.
+
+Examples:
+
+	$ balena env rm 123123
+	$ balena env rm 234234 --yes
+	$ balena env rm 345345 --config
+	$ balena env rm 456456 --service
+	$ balena env rm 567567 --device
+	$ balena env rm 678678 --device --config
+	$ balena env rm 789789 --device --service --yes
+
+### Arguments
+
+#### ID
+
+variable's numeric database ID
+
+### Options
+
+#### -c, --config
+
+select a configuration variable (may be used together with the --device option)
+
+#### -d, --device
+
+select a device-specific variable instead of a fleet variable
+
+#### -s, --service
+
+select a service variable (may be used together with the --device option)
+
+#### -y, --yes
+
+do not prompt for confirmation before deleting the variable
+
+# Environment Variables
+
+## envs
+
+List the environment or configuration variables of a fleet, device or
+service, as selected by the respective command-line options. (A service
+corresponds to a Docker image/container in a microservices fleet.)
+
+The results include fleet-wide (multiple devices), device-specific (multiple
+services on a specific device) and service-specific variables that apply to the
+selected fleet, device or service. It can be thought of as including inherited
+variables; for example, a service inherits device-wide variables, and a device
+inherits fleet-wide variables.
+
+The printed output may include DEVICE and/or SERVICE columns to distinguish
+between fleet-wide, device-specific and service-specific variables.
+An asterisk in these columns indicates that the variable applies to
+"all devices" or "all services".
+
+The --config option is used to list "configuration variables" that control
+balena platform features, as opposed to custom environment variables defined
+by the user. The --config and the --service options are mutually exclusive
+because configuration variables cannot be set for specific services.
+
+The --json option is recommended when scripting the output of this command,
+because the JSON format is less likely to change and it better represents data
+types like lists and empty strings. The 'jq' utility may be helpful in shell
+scripts (https://stedolan.github.io/jq/manual/). When --json is used, an empty
+JSON array ([]) is printed instead of an error message when no variables exist
+for the given query. When querying variables for a device, note that the fleet
+name may be null in JSON output (or 'N/A' in tabular output) if the fleet that
+the device belonged to is no longer accessible by the current user (for example,
+in case the current user was removed from the fleet by the fleet's owner).
+
+Fleets may be specified by fleet name or slug. Fleet slugs are
+the recommended option, as they are unique and unambiguous. Slugs can be
+listed with the `balena fleets` command. Note that slugs may change if the
+fleet is renamed. Fleet names are not unique and may result in  "Fleet is
+ambiguous" errors at any time (even if it "used to work in the past"), for
+example if the name clashes with a newly created public fleet, or with fleets
+from other balena accounts that you may be invited to join under any role.
+For this reason, fleet names are especially discouraged in scripts (e.g. CI
+environments).
+
+Examples:
+
+	$ balena envs --fleet myorg/myfleet
+	$ balena envs --fleet MyFleet --json
+	$ balena envs --fleet MyFleet --service MyService
+	$ balena envs --fleet MyFleet --config
+	$ balena envs --device 7cf02a6
+	$ balena envs --device 7cf02a6 --json
+	$ balena envs --device 7cf02a6 --config --json
+	$ balena envs --device 7cf02a6 --service MyService
+
+### Options
+
+#### -f, --fleet FLEET
+
+fleet name or slug (preferred)
+
+#### -c, --config
+
+show configuration variables only
+
+#### -d, --device DEVICE
+
+device UUID
+
+#### -j, --json
+
+produce JSON output instead of tabular output
+
+#### -s, --service SERVICE
+
+service name
+
+# Fleet
 
 ## fleet create <name>
 
@@ -2168,9 +2189,13 @@ fleet name or slug (preferred)
 
 open fleet dashboard page
 
+#### --fields FIELDS
+
+only show provided fields (comma-separated)
+
 #### -j, --json
 
-produce JSON output instead of tabular output
+output in json format
 
 ## fleet pin <slug> [releaseToPinTo]
 
@@ -2336,6 +2361,8 @@ the slug of the fleet to make track the latest release
 
 ### Options
 
+# Fleets
+
 ## fleets
 
 List all your balena fleets.
@@ -2349,9 +2376,29 @@ Examples:
 
 ### Options
 
+#### --fields FIELDS
+
+only show provided fields (comma-separated)
+
 #### -j, --json
 
-produce JSON output instead of tabular output
+output in json format
+
+#### --filter FILTER
+
+filter results by substring matching of a given field, eg: --filter field=foo
+
+#### --no-header
+
+hide table header from output
+
+#### --no-truncate
+
+do not truncate output to fit screen
+
+#### --sort SORT
+
+field to sort by (prepend '-' for descending order)
 
 # Local
 
@@ -2676,10 +2723,6 @@ device type
 
 select balenaOS ESR versions
 
-#### --include-draft
-
-include pre-release balenaOS versions
-
 ## os download <type>
 
 Download an unconfigured OS image for the specified device type.
@@ -2810,6 +2853,11 @@ from other balena accounts that you may be invited to join under any role.
 For this reason, fleet names are especially discouraged in scripts (e.g. CI
 environments).
 
+Note: This command is currently not supported on Windows natively. Windows users
+are advised to install the Windows Subsystem for Linux (WSL) with Ubuntu, and use
+the Linux release of the balena CLI:
+https://docs.microsoft.com/en-us/windows/wsl/about
+
 Examples:
 
 	$ balena os configure ../path/rpi3.img --device 7cf02a6
@@ -3343,7 +3391,7 @@ as final by default unless this option is given.
 
 The notes for this release
 
-# Releases
+# Release
 
 ## release finalize <commitOrId>
 
@@ -3442,6 +3490,8 @@ the commit or ID of the release to validate
 
 ### Options
 
+# Releases
+
 ## releases <fleet>
 
 List all releases of the given fleet.
@@ -3490,7 +3540,7 @@ Examples:
 
 ### Options
 
-# SSH Keys
+# SSH Key
 
 ## key add <name> [path]
 
@@ -3570,6 +3620,8 @@ balenaCloud ID for the SSH key
 
 answer "yes" to all questions (non interactive use)
 
+# SSH Keys
+
 ## keys
 
 List all SSH keys registered in balenaCloud for the logged in user.
@@ -3630,7 +3682,7 @@ comma-separated list (no spaces) of fleet names or slugs (preferred)
 
 length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d
 
-# Tags
+# Tag
 
 ## tag rm <tagKey>
 
@@ -3727,6 +3779,8 @@ device UUID
 
 release id
 
+# Tags
+
 ## tags
 
 List all tags and their values for the specified fleet, device or release.

lib/app.ts

@@ -16,8 +16,8 @@
  */
 
 import * as packageJSON from '../package.json';
-import type { AppOptions } from './preparser';
 import {
+	AppOptions,
 	checkDeletedCommand,
 	preparseArgs,
 	unsupportedFlag,
@@ -157,7 +157,7 @@ async function oclifRun(command: string[], options: AppOptions) {
 	await Promise.all([trackPromise, deprecationPromise, runPromise]);
 }
 
-/** CLI entrypoint. Called by the `bin/run.js` and `bin/dev.js` scripts. */
+/** CLI entrypoint. Called by the `bin/balena` and `bin/balena-dev` scripts. */
 export async function run(cliArgs = process.argv, options: AppOptions) {
 	try {
 		const { setOfflineModeEnvVars, normalizeEnvVars, pkgExec } = await import(

lib/command.ts

@@ -21,6 +21,7 @@ import {
 	NotAvailableInOfflineModeError,
 } from './errors';
 import { stripIndent } from './utils/lazy';
+import * as output from './framework/output';
 
 export default abstract class BalenaCommand extends Command {
 	/**
@@ -167,4 +168,7 @@ export default abstract class BalenaCommand extends Command {
 			await this.getStdin();
 		}
 	}
+
+	protected outputMessage = output.outputMessage;
+	protected outputData = output.outputData;
 }

lib/commands/api-keys/index.ts

@@ -52,7 +52,7 @@ export default class ApiKeysCmd extends Command {
 					await getApplication(getBalenaSdk(), options.fleet, {
 						$select: 'actor',
 					})
-				).actor
+			  ).actor
 			: await getBalenaSdk().auth.getActorId();
 		const keys = await getBalenaSdk().pine.get({
 			resource: 'api_key',
@@ -65,7 +65,7 @@ export default class ApiKeysCmd extends Command {
 								name: {
 									$ne: null,
 								},
-							}
+						  }
 						: {}),
 				},
 				$orderby: 'name asc',

lib/commands/build/index.ts

@@ -20,13 +20,7 @@ import Command from '../../command';
 import { getBalenaSdk } from '../../utils/lazy';
 import * as cf from '../../utils/common-flags';
 import * as compose from '../../utils/compose';
-import type {
-	ApplicationType,
-	BalenaSDK,
-	DeviceType,
-	PineOptions,
-	PineTypedResult,
-} from 'balena-sdk';
+import type { ApplicationType, BalenaSDK } from 'balena-sdk';
 import {
 	buildArgDeprecation,
 	dockerignoreHelp,
@@ -73,7 +67,6 @@ ${dockerignoreHelp}
 	public static examples = [
 		'$ balena build --fleet myFleet',
 		'$ balena build ./source/ --fleet myorg/myfleet',
-		'$ balena build --deviceType raspberrypi3 --emulated',
 		'$ balena build --deviceType raspberrypi3 --arch armv7hf --emulated',
 		'$ balena build --docker /var/run/docker.sock --fleet myFleet   # Linux, Mac',
 		'$ balena build --docker //./pipe/docker_engine --fleet myFleet # Windows',
@@ -121,8 +114,6 @@ ${dockerignoreHelp}
 		options.source = params.source;
 		delete params.source;
 
-		await this.resolveArchFromDeviceType(sdk, options);
-
 		await this.validateOptions(options, sdk);
 
 		// Build args are under consideration for removal - warn user
@@ -136,7 +127,7 @@ ${dockerignoreHelp}
 
 		try {
 			await this.buildProject(docker, logger, composeOpts, {
-				appType: app?.application_type?.[0],
+				app,
 				arch: options.arch!,
 				deviceType: options.deviceType!,
 				buildEmulated: options.emulated,
@@ -159,7 +150,7 @@ ${dockerignoreHelp}
 		) {
 			const { ExpectedError } = await import('../../errors');
 			throw new ExpectedError(
-				'You must specify either a fleet (-f), or the device type (-d) and optionally the architecture (-A)',
+				'You must specify either a fleet (-f), or the device type (-d) and architecture (-A)',
 			);
 		}
 
@@ -179,39 +170,6 @@ ${dockerignoreHelp}
 		opts['registry-secrets'] = registrySecrets;
 	}
 
-	protected async resolveArchFromDeviceType(sdk: BalenaSDK, opts: FlagsDef) {
-		if (opts.deviceType != null && opts.arch == null) {
-			try {
-				const deviceTypeOpts = {
-					$select: 'is_of__cpu_architecture',
-					$expand: {
-						is_of__cpu_architecture: {
-							$select: 'slug',
-						},
-					},
-				} satisfies PineOptions<DeviceType>;
-				opts.arch = (
-					(await sdk.models.deviceType.get(
-						opts.deviceType,
-						deviceTypeOpts,
-					)) as PineTypedResult<DeviceType, typeof deviceTypeOpts>
-				).is_of__cpu_architecture[0].slug;
-			} catch (err) {
-				const { ExpectedError } = await import('../../errors');
-				if (err instanceof sdk.errors.BalenaInvalidDeviceType) {
-					let message = err.message;
-					if (!(await sdk.auth.isLoggedIn())) {
-						message = `${message}. In case you are trying to use a private device type, please try to log in first.`;
-					}
-					throw new ExpectedError(message);
-				}
-				throw new ExpectedError(
-					'Failed to resolve the architecture of the provided device type. If you are in an air-gapped environment please also define the architecture (-A) parameter.',
-				);
-			}
-		}
-	}
-
 	protected async getAppAndResolveArch(opts: FlagsDef) {
 		if (opts.fleet) {
 			const { getAppWithArch } = await import('../../utils/helpers');
@@ -254,7 +212,9 @@ ${dockerignoreHelp}
 		logger: import('../../utils/logger'),
 		composeOpts: ComposeOpts,
 		opts: {
-			appType?: Pick<ApplicationType, 'supports_multicontainer'>;
+			app?: {
+				application_type: [Pick<ApplicationType, 'supports_multicontainer'>];
+			};
 			arch: string;
 			deviceType: string;
 			buildEmulated: boolean;
@@ -270,10 +230,11 @@ ${dockerignoreHelp}
 			opts.buildOpts.t,
 		);
 
+		const appType = opts.app?.application_type?.[0];
 		if (
-			opts.appType != null &&
+			appType != null &&
 			project.descriptors.length > 1 &&
-			!opts.appType.supports_multicontainer
+			!appType.supports_multicontainer
 		) {
 			logger.logWarn(
 				'Target fleet does not support multiple containers.\n' +

lib/commands/deploy/index.ts

@@ -364,13 +364,20 @@ ${dockerignoreHelp}
 					$select: ['commit'],
 				});
 			} else {
+				const [{ id: userId }, auth, apiEndpoint] = await Promise.all([
+					sdk.auth.getUserInfo(),
+					sdk.auth.getToken(),
+					sdk.settings.get('apiUrl'),
+				]);
 				release = await $deployProject(
 					docker,
-					sdk,
 					logger,
 					project.composition,
 					images,
 					opts.app.id,
+					userId,
+					`Bearer ${auth}`,
+					apiEndpoint,
 					!opts.shouldUploadLogs,
 					composeOpts.projectPath,
 					opts.createAsDraft,

lib/commands/device/index.ts

@@ -91,7 +91,7 @@ export default class DeviceCmd extends Command {
 							},
 							...expandForAppName.$expand,
 						},
-					}
+				  }
 				: {
 						$select: [
 							'device_name',
@@ -118,7 +118,7 @@ export default class DeviceCmd extends Command {
 							'is_undervolted',
 						],
 						...expandForAppName,
-					},
+				  },
 		)) as ExtendedDevice;
 
 		if (options.view) {

lib/commands/device/init.ts

@@ -132,7 +132,7 @@ export default class DeviceInitCmd extends Command {
 							$select: 'slug',
 						},
 					},
-				})
+			  })
 			: await (await import('../../utils/patterns')).selectApplication();
 
 		// Register new device

lib/commands/device/os-update.ts

@@ -37,7 +37,6 @@ export default class DeviceOsUpdateCmd extends Command {
 		'$ balena device os-update 23c73a1',
 		'$ balena device os-update 23c73a1 --version 2.101.7',
 		'$ balena device os-update 23c73a1 --version 2.31.0+rev1.prod',
-		'$ balena device os-update 23c73a1 --include-draft',
 	];
 
 	public static args = {
@@ -52,12 +51,6 @@ export default class DeviceOsUpdateCmd extends Command {
 	public static flags = {
 		version: Flags.string({
 			description: 'a balenaOS version',
-			exclusive: ['include-draft'],
-		}),
-		'include-draft': Flags.boolean({
-			description: 'include pre-release balenaOS versions',
-			default: false,
-			exclusive: ['version'],
 		}),
 		yes: cf.yes,
 		help: cf.help,
@@ -93,25 +86,10 @@ export default class DeviceOsUpdateCmd extends Command {
 			);
 		}
 
-		let includeDraft = options['include-draft'];
-		if (!includeDraft && options.version != null) {
-			const bSemver = await import('balena-semver');
-			const parsedVersion = bSemver.parse(options.version);
-			// When the user provides a draft version, we need to pass `includeDraft`
-			// to the os.getSupportedOsUpdateVersions() since w/o it the results
-			// will for sure not include the user provided version and the command
-			// would return a "not in the Host OS update targets" error.
-			includeDraft =
-				parsedVersion != null && parsedVersion.prerelease.length > 0;
-		}
-
 		// Get supported OS update versions
 		const hupVersionInfo = await sdk.models.os.getSupportedOsUpdateVersions(
 			is_of__device_type[0].slug,
 			currentOsVersion,
-			{
-				includeDraft,
-			},
 		);
 		if (hupVersionInfo.versions.length === 0) {
 			throw new ExpectedError(

lib/commands/envs/index.ts

@@ -126,7 +126,7 @@ export default class EnvsCmd extends Command {
 		let fleetSlug: string | undefined = options.fleet
 			? await (
 					await import('../../utils/sdk')
-				).getFleetSlug(balena, options.fleet)
+			  ).getFleetSlug(balena, options.fleet)
 			: undefined;
 		let fullUUID: string | undefined; // as oppposed to the short, 7-char UUID
 

lib/commands/fleet/index.ts

@@ -20,7 +20,7 @@ import { Flags } from '@oclif/core';
 import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import * as ca from '../../utils/common-args';
-import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
 import { applicationIdInfo } from '../../utils/messages';
 
 export default class FleetCmd extends Command {
@@ -49,7 +49,7 @@ export default class FleetCmd extends Command {
 			default: false,
 			description: 'open fleet dashboard page',
 		}),
-		json: cf.json,
+		...cf.dataOutputFlags,
 	};
 
 	public static authenticated = true;
@@ -78,28 +78,16 @@ export default class FleetCmd extends Command {
 			return;
 		}
 
-		const applicationToDisplay = {
-			id: application.id,
-			app_name: application.app_name,
-			slug: application.slug,
+		const outputApplication = {
+			...application,
 			device_type: application.is_for__device_type[0].slug,
 			commit: application.should_be_running__release[0]?.commit,
 		};
 
-		if (options.json) {
-			console.log(JSON.stringify(applicationToDisplay, null, 4));
-			return;
-		}
-
-		// Emulate table.vertical title output, but avoid uppercasing and inserting spaces
-		console.log(`== ${applicationToDisplay.app_name}`);
-		console.log(
-			getVisuals().table.vertical(applicationToDisplay, [
-				'id',
-				'device_type',
-				'slug',
-				'commit',
-			]),
+		await this.outputData(
+			outputApplication,
+			['app_name', 'id', 'device_type', 'slug', 'commit'],
+			options,
 		);
 	}
 }

lib/commands/fleets/index.ts

@@ -19,7 +19,7 @@ import type * as BalenaSdk from 'balena-sdk';
 
 import Command from '../../command';
 import * as cf from '../../utils/common-flags';
-import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
 
 interface ExtendedApplication extends ApplicationWithDeviceTypeSlug {
 	device_count: number;
@@ -42,8 +42,8 @@ export default class FleetsCmd extends Command {
 	public static usage = 'fleets';
 
 	public static flags = {
+		...cf.dataSetOutputFlags,
 		help: cf.help,
-		json: cf.json,
 	};
 
 	public static authenticated = true;
@@ -77,29 +77,17 @@ export default class FleetsCmd extends Command {
 			application.device_type = application.is_for__device_type[0].slug;
 		});
 
-		const applicationsToDisplay = applications.map((application) => ({
-			id: application.id,
-			app_name: application.app_name,
-			slug: application.slug,
-			device_type: application.device_type,
-			online_devices: application.online_devices,
-			device_count: application.device_count,
-		}));
-
-		if (options.json) {
-			console.log(JSON.stringify(applicationsToDisplay, null, 4));
-			return;
-		}
-
-		console.log(
-			getVisuals().table.horizontal(applicationsToDisplay, [
+		await this.outputData(
+			applications,
+			[
 				'id',
-				'app_name => NAME',
+				'app_name',
 				'slug',
 				'device_type',
 				'device_count',
 				'online_devices',
-			]),
+			],
+			options,
 		);
 	}
 }

lib/commands/logs/index.ts

@@ -19,7 +19,7 @@ import { Flags, Args } from '@oclif/core';
 import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import type { LogMessage } from 'balena-sdk';
+import { LogMessage } from 'balena-sdk';
 
 const MAX_RETRY = 1000;